From b646335055f74a78056fa888f58c6435399ad24d Mon Sep 17 00:00:00 2001 From: Pinapelz Date: Tue, 18 Nov 2025 21:59:48 -0800 Subject: initial docs --- docs/index.md | 27 +++++++++++++++++++++++++-- 1 file changed, 25 insertions(+), 2 deletions(-) (limited to 'docs/index.md') diff --git a/docs/index.md b/docs/index.md index a4727e3..2a4b45d 100644 --- a/docs/index.md +++ b/docs/index.md @@ -1,2 +1,25 @@ -# Mirage Documentation -**Mirage** is a "rhythm" game score tracker that doesn’t rely on predefined seeds or chart metadata. It preseves your scores across games — even niche ones. +**Mirage** is a "rhythm" game score tracker that doesn’t rely on predefined seeds or chart metadata. It preserves your scores across games, even niche ones. + +This means that Mirage starts out with *zero* information about what charts belong to what games. You, as the user tell it what charts exist in a game when you upload scores. + +It's self-hostable and supports multiple users, so you can compare results across the same charts. + +# Supported games + +Mirage comes with built-in support for a few games. These games already have customized displays, theming, and methods to import scores. + +- DANCERUSH +- DANCE aROUND +- Project DIVA Arcade: Future Tone +- MUSIC DIVER +- Nostalgia +- REFLEC BEAT +- Taiko no Tatsujin Arcade + +You can also add non-default as a "Generic" using the Admin UI. Mirage will attempt to generate a decent looking UI for displaying that game's score as they come in (until you manually write in full support). However, at a bare minimum it will serve its purpose as a place to keep that score file safe. + +## Other Notes +The focus of the tracker is "Arcade Rhythm" games, however technically speaking it works for any game you want. Mirage makes it easy to add tracking for not-so popular games, [Tachi](https://github.com/zkldi/Tachi) is the better more robust score tracking solution. In fact, its highly suggested you use that when possible to track games that have well-documented databases of charts (seeds). + +# Documentation +- [Score File Format](./score) -- cgit v1.2.3