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.

# Store API key
dp2rathena config

# Convert items with ids 501 and 1101
dp2rathena item 501 1101

# Convert mob skills from mob ids in a newline separated file
dp2rathena mobskill -f my_mobs.txt

# Print out help text
dp2rathena -h

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

Not Mapped (insufficient data)

  • "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.3.tar.gz (81.8 kB view details)

Uploaded Source

Built Distribution

dp2rathena-0.3.3-py3-none-any.whl (86.3 kB view details)

Uploaded Python 3

File details

Details for the file dp2rathena-0.3.3.tar.gz.

File metadata

  • Download URL: dp2rathena-0.3.3.tar.gz
  • Upload date:
  • Size: 81.8 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: poetry/1.1.4 CPython/3.8.7 Linux/4.15.0-1077-gcp

File hashes

Hashes for dp2rathena-0.3.3.tar.gz
Algorithm Hash digest
SHA256 44bb4985651eebed71f861fbd15b057eac48149886cd828c7622372e3b2a2b4a
MD5 4def6e8edc1f3f8f51d57a3b35e6573f
BLAKE2b-256 2effda58db98cae91f931c67d378e78461f04178d34ee6907149a0765c7bc2ce

See more details on using hashes here.

File details

Details for the file dp2rathena-0.3.3-py3-none-any.whl.

File metadata

  • Download URL: dp2rathena-0.3.3-py3-none-any.whl
  • Upload date:
  • Size: 86.3 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: poetry/1.1.4 CPython/3.8.7 Linux/4.15.0-1077-gcp

File hashes

Hashes for dp2rathena-0.3.3-py3-none-any.whl
Algorithm Hash digest
SHA256 ab32eef6e4f459d620f2db4dbcd312416e0a095f6229a45e86c1f86c32371890
MD5 429b6786c3b7e9093c5dfec284186eac
BLAKE2b-256 152c756d1c893969858cc69cb75731749581acbc4ea966ad498c13a61c29ea21

See more details on using hashes here.

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