Shimmeringmoon

Arcaea screenshot analyzer!

This bot analyzes your Arcaea screenshots (both of your scores, and taken in the song-select menu), extracts score data from them, and keeps track of such score data in a database. This bot is still in development. Contact @prescientmoon on discord if you want to help out in any way.

Features

song/chart info queries
score queries (eg: listing your best score for a given chart)
B30 (heck, even B300, if you so desire) rendering
Multiple scoring systems to choose from (including sdvx like EX-scoring)
Achievements (work in progress)
Graph plotting (work in progress)

How does it work

The bot uses poise in order to communicate with discord
The bot renders images using my own custom bitmap renderer & layout system
The bot recognises images using my own jacket recognition algorithm
The bot reads text using my own OCR algorithm. The project started off by using Tesseract, although it was unreliable, and had big issues reading fonts with a lot of kerning (like Arcaea's song font for the bigrams 74 and 24). My implementation is much more accurate because it's much less general purpose, and uses knowledge of the font to achieve better results.

No neural-networks/machine-learning is used by this project. All image analysis is done using classical algorithms I came up with by glueing basic concepts together.

Running locally

The programs need (sometimes a subset of) the following environment variables in order to run:

SHIMMERING_DISCORD_TOKEN=yourtoken
SHIMMERING_DATA_DIR=shimmering/data
SHIMMERING_ASSET_DIR=shimmering/assets
SHIMMERING_CONFIG_DIR=shimmering/config
SHIMMERING_LOG_DIR=shimmering/logs

Binaries

The project currently exposes two binaries:

shimmering-discord-bot provides the discord bot for shimmeringmoon
shimmering-cli provides the command line interface for shimmeringmoon:
- The prepare-jackets prepares the provided jackets for running the bot (see the section below for more details)
- The analyse <...paths> command is a command-line version of the score magic discord command. This is useful for debugging things like the OCR implementation, without having to transmit files over the network.

Future binaries

shimmering-server will be a server which provides scoring data over HTTP.
shimmering-discord-presence will be a client application that talks to shimmeringmoon-server in order to update your discord "currently playing" status in order to reflect the charts you are currently playing.

Fonts

The following fonts must be present in $SHIMMERING_ASSET_DIR/fonts:

arial.ttf
exo-variable.ttf
geosans-light.ttf
kazesawa-bold.ttf
kazesawa-regular.ttf
noto-sans.ttf
saira-variable.ttf
unifont.otf

Assets

Most of the assets in this repo have been drawn by me. You need to bring in your own song jackets and place them at $SHIMMERING_ASSET_DIR/songs. This directory must contain a subdirectory for each song in the game, with each subdirectory containing a default jacket at base_256.jpg. Different files can be created to override the jacket for each difficulty. For more details, check out the implementation in ./src/arcaea/jacket.rs.

Additionally, you must place a custom b30 background at $SHIMMERING_ASSET_DIR/b30_background.jpg.

Caution

As far as I am concerned, the code in this repository does not violate the Arcaea terms of service in any way. Importing jackets that have been datamined/ripped out of the game is against the aforementioned TOS, and is highly discouraged.

After everything has been placed in the right directory, run shimmeringmoon-cli prepare-jackets to prepare everything. This will:

Associate each asset with it's database ID
Build out a recognition matrix for image recognition purposes (this matrix more or less contains a 64x64 downscaled version of each provided asset, stored in bitmap format together with the associated database ID)

Importing charts

The charts are stored in $SHIMMERING_CONFIG_DIR/charts.csv. This is a csv-version of Lumine's Arcaea song table (with permission). Importing song-data from any other source (such as datamined database files) will not only be more difficult for you (all the scripts I have written are built around the aforementioned spreadsheet), but is also against the Arcaea terms of service.

To add charts that have just been added to the CSV file into the database, run import-charts.py.

Testing

Thanks

Many thanks go to:

@.luminexus for providing the amazing Arcaea song table
@siloricity for helping with development assets
@black._heart_.sl for being the first person I discussed this idea extensively with
@dyuan01 for discussing different scoring system ideas with me
George Dragomir for, at my request, writing a new set of Tesseract bindings for the Rust programming language. The popular rust bindings for Tesseract are incomplete, unidiomatic, painful to use, easy to misuse, and leak copious amounts of memory. Please avoid them at all cost.
The members of a certain small-scale Arcaea server for enduring my shimmeringmoon-related rambles :3

5.6 KiB Raw Blame History