A Discord utility bot for mobile rhythm game D4DJ Groovy Mix. See the website for more information.
Miyu Bot depends on d4dj-utils,
which should be visible via the PYTHONPATH, or a .pth file in a venv.
Some functionality of d4dj-utils is not fully public, such as some chart related functions or asset downloading and decryption,
and is considered "extended" functionality.
A JSON file called config.json should be created in the working directory
containing a dict with a single key "token" corresponding to the bot token.
Edit the tortoise configuration file at miyu_bot/bot/tortoise_config.py
for whichever database is preferred.
SQLite suffices for development, but may have issues with migrations,
so PostgreSQL is recommended for general use.
Files in the migrations folder are used by aerich
and are meant for use with PostgreSQL.
Before running the bot for the first time, execute init_db.py to
initialize the database.
At a minimum, the bot requires decrypted and decompressed master files
in the working directory at assets/Master.
If extended functions of d4dj-utils are available, update_assets.py
may be used to download or update assets to the latest version and to
perform the necessary decryption and decompression.
export_assets.py is used to export assets to the export directory for
online hosting.
Miyu Bot may be added to a server using the invite link.
Questions may be asked in the bot server, or by contacting qwewqa#3948 on Discord.