bratah123 / swordiedb

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

SwordieDB

SwordieDB PyPi Page

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.

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!

swordiedb's Issues

Raise Minor version to 3

Suggestion:
Raise minor version to 3: v0.3.0

Rationale:
All core unit tests passed from Python 3.6.12 to Python 3.9.0

Python 3.6.12

Python 3.9.0

Missing Job IDs

Some classes (e.g. Shade) are missing from __init__

Equip tab handling missing from swordie_db.character

The Equipped window (column: equippedinventory) is handled by not the Equip tab in Inventory (cloumn: equipinventory).

Attributes currently handled (Extracted from API Docs):

Add support for NX Prepaid

User object has support for maplePoints, but not for nxPrepaid
Consider adding such functionality

Catch for non-existent jobs

Overview:

The following error was received when attempting to get job name of invalid ID:

Job ID is 0. Details extracted from DB for reference:

id	characterid	characteridforlog	worldidforlog	name	gender	skin	face	hair	mixbasehaircolor	mixaddhaircolor	mixhairbaseprob	level	job	str	dex	inte	luk	hp	maxhp	mp	maxmp	ap	sp	exp	pop	money	wp	extendsp	posmap	portal	subjob	deffaceacc	fatigue	lastfatigueupdatetime	charismaexp	insightexp	willexp	craftexp	senseexp	charmexp	noncombatstatdaylimit	pvpexp	pvpgrade	pvppoint	pvpmodelevel	pvpmodetype	eventpoint	albaactivityid	albastarttime	albaduration	albaspecialreward	burning	charactercard	accountlastlogout	lastlogout	gachexp	honorexp	nextavailablefametime
4	4	4	1	Kookiiee	0	0	23300	36786	0	0	0	1	0	12	5	4	4	50	50	0	0	0	0	0	0	0	0	4	4000011	0	0	0	0	0	0	0	0	0	0	0	4	0	0	0	0	0	0	0	1601-01-01 11:13:45.000	0	0	0	4	4	1601-01-01 11:13:45.000	0	0	1601-01-01 11:13:45.000

Suggested solutions

3 plausible solutions:

1. Use of try-except
   • To catch the error
2. Use of if-else
   • To handle job ID of 0 without raising error
3. Add 0 to jobs.json
   • Easiest circumvention
   • May cause further problems down the line

Raise Minor version to 2

Suggestion:
Raise Minor version to 2: v0.2.0

Rationale:
All known features (with the exception of the incomplete/insecure password change method) of User handler has been tested for correctness.