https://github.com/bratah123/swordiedb

A Maplestory Database API for SwordieMS-based sources written in Python
https://github.com/bratah123/swordiedb

database maplestory pip spiritms

Last synced: 11 months ago
JSON representation

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

• Host: GitHub
• URL: https://github.com/bratah123/swordiedb
• Owner: Bratah123
• License: mit
• Created: 2020-11-10T04:24:32.000Z (over 5 years ago)
• Default Branch: main
• Last Pushed: 2021-01-21T14:28:51.000Z (over 5 years ago)
• Last Synced: 2025-04-08T04:13:56.984Z (about 1 year ago)
• Topics: database, maplestory, pip, spiritms
• Language: Python
• Homepage:
• Size: 87.9 KB
• Stars: 8
• Watchers: 1
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • Changelog: CHANGELOG.txt
  • License: LICENSE.txt

Awesome Lists containing this project

README

          
# SwordieDB

### [SwordieDB PyPi Page](https://pypi.org/project/swordiedb/)

[![Downloads](https://static.pepy.tech/personalized-badge/swordiedb?period=total&units=international_system&left_color=black&right_color=blue&left_text=Total%20Downloads)](https://pepy.tech/project/swordiedb) [![Downloads](https://static.pepy.tech/personalized-badge/swordiedb?period=month&units=international_system&left_color=black&right_color=blue&left_text=Monthly%20Downloads)](https://pepy.tech/project/swordiedb) [![Downloads](https://static.pepy.tech/personalized-badge/lazuli?period=week&units=international_system&left_color=black&right_color=blue&left_text=Weekly%20Downloads)](https://pepy.tech/project/swordiedb)  

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:** ![](https://progress-bar.dev/100) 

  

**Character Handling:** ![](https://progress-bar.dev/100)    

**User Handling:** ![](https://progress-bar.dev/100)    

**Inventory Handling:** ![](https://progress-bar.dev/100)    

## 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](https://github.com/Bratah123/SwordieDB/wiki/Sample-Code-Fragments) on how to use them. :octocat:

## Examples

See the [Code Examples page](https://github.com/Bratah123/SwordieDB/wiki/Sample-Code-Fragments) for sample code fragments.

## Technical Details

Please refer to the [Technical Details page](https://github.com/Bratah123/SwordieDB/wiki/Technical-Details) 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](https://kookiiestudios.github.io/ProjectShieldieDB/).

## Suggestions

Suggestions for new features/functionality can be written as an issue from the ["Issues"](https://github.com/Bratah123/SwordieDB/issues) tab on github.

## Credits

- Credits to the original swordie devs!