Skip to main content

A Python-based tool for interacting with AzureMSv316-based databases.

Project description

Lazuli


Downloads Downloads Downloads HitCount
Stats courtesy of PePy and dwyl

Lazuli is a pip-compatible, Python-based package for interacting with AzureMSv316-based databases, such as ElectronMS.
Lazuli is inspired by and based on the SwordieDB project.

Lazuli allows access to character and inventory attributes in Odin-like databases.
This makes it possible to produce not only feature-rich Discord bots, but also integrated websites.

Perks:

  • Easy to set-up - simply install with pip!
  • Lovingly commented
  • API docs and example code provided
  • IDE hints available when importing after pip-installtion
  • Already used in Lapis

Current Status: Now Available on PyPi (See changelog)
Note: Lazuli v3 includes several dependency removals.
We suggest you delete your venv folder and re-creating the virtual environment when upgrading from v2 to v3.


Quick Start

Installation via PyPi/Pip:

  1. Run pip install lazuli inside of your venv (or global, if desired)
    • see wiki for how to generate venv
  2. Import the module in your project
    • from lazuli.database import Lazuli
  3. Create an Azure database object using the Lazuli class constructor
    • azure = Lazuli()
    • See the Wiki for full examples
    • See the API Docs for more in-depth technical documentation
  4. Query
    • E.g. number_of_players_online = azure.get_online_count()
      • gives number (int) of accounts currently connected to the server

Documentation:

Kindly refer to the Project Wiki and API Docs for detailed documentation.
The Discussions Page is currently open for any questions!
Please report any issues!

Acknowledgements:

  1. The SwordieDB project by Bratah123
    • This project is inspired by and based on SwordieDB
  2. MapleStory:IO by Senpai#1337
    • The character sprite generation makes use of MapleStory.IO APIs

Disclaimer:

Lazuli is an open-source third-party implementation of APIs for a particular MapleStory server emulation project (AzureMSv316). Lazuli is non-monetised, provided as is, and is unaffiliated with NEXON. Every effort has been taken to ensure correctness and reliability of Lazuli. We will not be liable for any special, direct, indirect, or consequential damages or any damages whatsoever resulting from loss of use, data or profits, whether in an action if contract, negligence or other tortious action, arising out of or in connection with the use of Lazuli (in part or in whole).

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

lazuli-3.0.2.tar.gz (37.8 kB view details)

Uploaded Source

Built Distribution

lazuli-3.0.2-py3-none-any.whl (39.8 kB view details)

Uploaded Python 3

File details

Details for the file lazuli-3.0.2.tar.gz.

File metadata

  • Download URL: lazuli-3.0.2.tar.gz
  • Upload date:
  • Size: 37.8 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/4.0.1 CPython/3.10.7

File hashes

Hashes for lazuli-3.0.2.tar.gz
Algorithm Hash digest
SHA256 6cda7ed74dbae77317597bbf92d1d41e421410236468bd01f49e9c759b25ef42
MD5 1cd2b8b037ba1895ec335d72ee16484e
BLAKE2b-256 625ef58e20444414c8a3ec8ba5c3103a9aef6968738151c3700b88cb1c944854

See more details on using hashes here.

File details

Details for the file lazuli-3.0.2-py3-none-any.whl.

File metadata

  • Download URL: lazuli-3.0.2-py3-none-any.whl
  • Upload date:
  • Size: 39.8 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/4.0.1 CPython/3.10.7

File hashes

Hashes for lazuli-3.0.2-py3-none-any.whl
Algorithm Hash digest
SHA256 d1ae0dc412676e12fe5aa1ae6642f2ce8f46bc52bb22bf3be7df1199c592a210
MD5 118f6f649be1cdd878314666d4fb09f4
BLAKE2b-256 fdcf3321539893d683559031cf5f692b77eae24fa6ac21694b8eacf7405fa8d8

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