mirror of
https://github.com/zkldi/Tachi.git
synced 2026-10-12 01:08:29 +03:00
zk
e363bd2532
* docs: migrate from mkdocs to mdbook - Rename old mkdocs docs/ to old-docs/ for reference - Set up new docs/ with mdbook (book.toml + src/ tree) - Mirror full nav structure from mkdocs.yml into SUMMARY.md - Add Justfile-docs with docs-serve, docs-build, docs-check, docs-install recipes - Import Justfile-docs from root Justfile - Rewrite .github/workflows/docs.yml: build step uses taiki-e/install-action to install mdbook, split into separate build + deploy jobs, PR builds run the check step too * ci(docs): pin actions to SHAs, install mdbook via release binary * ci(docs): install mdbook from apt instead of curling a release binary * dev: replace mkdocs python stack with mdbook in dev image * ci(docs): apt only works on Debian; restore release binary install for Ubuntu CI * docs: fix duplicate file entries in SUMMARY.md * docs: remove docs-install recipe * docs: remove site-url from book.toml to fix asset loading * dev: install mdbook from upstream release binary, not Debian apt The Debian package (0.4.x+ds) strips bundled font assets, leaving the built site without fonts/fonts.css. Use the upstream tarball (same as CI) so the theme is complete. Handles x86_64 and aarch64. * docs: vendor mdbook tarballs in dev/mdbook/, install from there Dockerfile.dev uses COPY + tar to install the right arch at build time. CI extracts the x86_64 tarball directly from the checkout. No network access required for either — and no stripped-fonts Debian package. * fix: unwritten
108 lines
3.0 KiB
Markdown
108 lines
3.0 KiB
Markdown
# maimai DX Support
|
|
|
|
This game has the internal GPTString of `maimaidx:Single`.
|
|
|
|
!!! note
|
|
For information on what each section means, please see [Common Config](../common-config/index.md).
|
|
|
|
## Metrics
|
|
|
|
For more information on what metrics are and how they work, see [TODO]!
|
|
|
|
### Provided Metrics
|
|
|
|
| Metric Name | Type | Description |
|
|
| :: | :: | :: |
|
|
| `percent` | Decimal | The percent this score was worth. Sometimes called 'rate' in game. This is between 0 and 101. |
|
|
| `lamp` | "FAILED", "CLEAR", "FULL COMBO", "FULL COMBO+", "ALL PERFECT", "ALL PERFECT+" | The type of clear this score was. |
|
|
|
|
### Derived Metrics
|
|
|
|
| Metric Name | Type | Description |
|
|
| :: | :: | :: |
|
|
| `grade` | "D", "C", "B", "BB", "BBB", "A", "AA", "AAA", "S", "S+", "SS", "SS+", "SSS", "SSS+" | The grade this score was. |
|
|
|
|
### Optional Metrics
|
|
|
|
| Metric Name | Type | Description |
|
|
| :: | :: | :: |
|
|
| `fast` | Integer | The amount of mistakes in this score that were a result of hitting early. |
|
|
| `slow` | Integer | The amount of mistakes in this score that were a result of hitting late. |
|
|
| `maxCombo` | Integer | The largest combo in this score. |
|
|
| `percentGraph` | Array<Decimal \| null > | The history of the projected achievement, queried in one-second intervals. |
|
|
| `lifeGraph` | Array<Decimal \| null > | Life count history, queried in one-second intervals. |
|
|
|
|
## Judgements
|
|
|
|
The following judgements are defined:
|
|
|
|
- `pcrit`
|
|
- `perfect`
|
|
- `great`
|
|
- `good`
|
|
- `miss`
|
|
|
|
## Rating Algorithms
|
|
|
|
### Score Rating Algorithms
|
|
|
|
| Name | Description |
|
|
| :: | :: |
|
|
| `rate` | Rating as it's implemented in game. |
|
|
|
|
### Session Rating Algorithms
|
|
|
|
| Name | Description |
|
|
| :: | :: |
|
|
| `rate` | The average of your best 10 ratings this session. |
|
|
|
|
### Profile Rating Algorithms
|
|
|
|
| Name | Description |
|
|
| :: | :: |
|
|
| `naiveRate` | A naive rating algorithm that just sums your 50 best scores. |
|
|
|
|
## Difficulties
|
|
|
|
- `Basic`
|
|
- `Advanced`
|
|
- `Expert`
|
|
- `Master`
|
|
- `Re:Master`
|
|
- `DX Basic`
|
|
- `DX Advanced`
|
|
- `DX Expert`
|
|
- `DX Master`
|
|
- `DX Re:Master`
|
|
|
|
## Classes
|
|
|
|
| Name | Type | Values |
|
|
| :: | :: | :: |
|
|
| `colour` | DERIVED | WHITE, BLUE, GREEN, YELLOW, RED, PURPLE, BRONZE, SILVER, GOLD, PLATINUM, RAINBOW
|
|
| `dan` | PROVIDED | DAN_1, DAN_2, DAN_3, DAN_4, DAN_5, DAN_6, DAN_7, DAN_8, DAN_9, DAN_10, SHINDAN_1, SHINDAN_2, SHINDAN_3, SHINDAN_4, SHINDAN_5, SHINDAN_6, SHINDAN_7, SHINDAN_8, SHINDAN_9, SHINDAN_10, SHINKAIDEN, URAKAIDEN
|
|
| `matchingClass` | PROVIDED | B5, B4, B3, B2, B1, A5, A5, A4, A3, A2, A1, S5, S4, S3, S2, S1, SS5, SS4, SS3, SS2, SS1, SSS5, SSS4, SSS3, SSS2, SSS1, LEGEND
|
|
|
|
## Versions
|
|
|
|
| ID | Pretty Name |
|
|
| :: | :: |
|
|
| `universeplus` | UNiVERSE PLUS |
|
|
| `festival` | FESTiVAL |
|
|
| `festivalplus` | FESTiVAL PLUS |
|
|
| `buddies` | BUDDiES |
|
|
| `buddies-omni` | BUDDiES Omnimix |
|
|
| `buddiesplus` | BUDDiES PLUS |
|
|
| `buddiesplus-omni` | BUDDiES PLUS Omnimix |
|
|
| `prism` | PRiSM |
|
|
| `prism-omni` | PRiSM Omnimix |
|
|
| `prismplus` | PRiSM PLUS |
|
|
| `prismplus-omni` | PRiSM PLUS Omnimix |
|
|
| `circle` | CiRCLE |
|
|
|
|
## Supported Match Types
|
|
|
|
- `songTitle`
|
|
- `tachiSongID`
|
|
- `inGameID`
|