Skip to content

A Maplestory Database API for SwordieMS-based sources written in Python

License

Notifications You must be signed in to change notification settings

Bratah123/SwordieDB

Repository files navigation

SwordieDB

Downloads Downloads Downloads

SwordieDB is a pip-compatible Python package designed for use in development of SwordieMS-based MapleStory private server tools (e.g. Discord bots).

The SwordieDB API allows access to character stats in the form of objects, for easy manipulation.

Current Status: Fully Released

Overall Developmental Progress:

Character Handling:
User Handling:
Inventory Handling:

Installation

Note: You are recommended to install to the project virtual environment.

  • In the terminal type the follow command: pip install swordiedb
    • Note: use system shell and not the Python REPL for pip!
    • To avoid any issues make sure to have these commands run prior to installing SwordieDB:
      • pip install -U setuptools
      • pip install -U wheel
  • Now to verify that you have access to the swordie_db module:
    • Try this import statement in the Python terminal: from swordie_db.database import SwordieDB
  • Then you are done! Refer to examples on how to use them. :octocat:

Examples

See the Code Examples page for sample code fragments.

Technical Details

Please refer to the Technical Details page for details, as well as detailed instructions for how to build this package for testing.

API Docs

The API Docs have been split out into a sister project here.

Suggestions

Suggestions for new features/functionality can be written as an issue from the "Issues" tab on github.

Credits

  • Credits to the original swordie devs!