Skip to main content

Convert Divine-Pride API data to rAthena YAML

Project description

dp2rathena: Divine-Pride API to rAthena

PyPI - Version PyPI - Python Version TravisCI Status codecov

Convert Divine-Pride API data to rAthena DB formats.

Currently supported formats are:

  • item_db.yml
  • mob_skill_db.txt
  • (future) mob_db.txt

Requirements

  • Python 3.6+

Installation

pip install dp2rathena

Usage

A divine-pride.net API key is required, create an account and generate a key if you don't have one yet.

dp2rathena config
dp2rathena item 501 1101

Limitations

All fields are mapped except the ones listed below:

item_db.yml

Partially Mapped

  • "Type" - when the item type is "Consumable" on DP and subtype "Special", we output a few possible options for user to choose the correct one (Healing, Usable, DelayConsume or Cash)
  • "SubType" - when the item type is "Ammo" on DP, we output all rathena ammo subtypes for user to choose correct option as DP doesn't map all rathena ammo subtypes

Excluded (not enough data to map)

  • "Script" / "EquipScript" / "UnEquipScript" - script to execute when some action is performed with the item
  • "Class" - upper class types that can equip item
  • "Flags" - item flags such as "BuyingStore", "DeadBranch", "BindOnEquip", etc...
  • "Delay" - item use delay
  • "Stack" - item stack amount
  • "NoUse" - conditions when the item is unusable
  • "AliasName" - another item's AegisName to be sent to client instead of this AegisName

Contributing

This project uses poetry to manage the development environment.

  • Setup a local development environment with poetry install
  • Run tests with poetry run tox (or pytest for current python version)
  • Execute script with poetry run dp2rathena

Changelog

See CHANGELOG.md

License

See LICENSE

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

dp2rathena-0.3.1.tar.gz (81.6 kB view hashes)

Uploaded Source

Built Distribution

dp2rathena-0.3.1-py3-none-any.whl (86.2 kB view hashes)

Uploaded Python 3

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page