mirror of
https://github.com/zkldi/Tachi.git
synced 2026-10-01 19:38:13 +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
98 lines
3.4 KiB
Markdown
98 lines
3.4 KiB
Markdown
# PMS (Controller) Support
|
|
|
|
This game has the internal GPTString of `pms:Controller`.
|
|
|
|
!!! 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 |
|
|
| :: | :: | :: |
|
|
| `score` | Integer | EX Score. This should be between 0 and the maximum possible EX on this chart. |
|
|
| `lamp` | "NO PLAY", "FAILED", "ASSIST CLEAR", "EASY CLEAR", "CLEAR", "HARD CLEAR", "EX HARD CLEAR", "FULL COMBO" | The type of clear this was. |
|
|
|
|
### Derived Metrics
|
|
|
|
| Metric Name | Type | Description |
|
|
| :: | :: | :: |
|
|
| `grade` | "F", "E", "D", "C", "B", "A", "AA", "AAA", "MAX-", "MAX" | Grades as they are in IIDX. We also add MAX- (94.44...%) and MAX (100%) as their own grades for convenience. |
|
|
| `percent` | Decimal | EX Score divided by the maximum possible EX Score on this chart. |
|
|
|
|
### 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. |
|
|
| `bp` | Integer | The total bads + poors in this score. |
|
|
| `gauge` | Decimal | The life in percent (between 0 and 100) that was on the gauge at the end of the chart. |
|
|
| `gaugeHistory` | Array<Decimal> | A snapshot of the gauge percent throughout the chart. The values should be null from the point the user dies until the end of the chart. |
|
|
| `gaugeHistoryEasy` | Array<Decimal> | The easy gauge history. |
|
|
| `gaugeHistoryGroove` | Array<Decimal> | The groove gauge history. |
|
|
| `gaugeHistoryHard` | Array<Decimal> | The hard gauge history. |
|
|
| `epg` | Integer | The amount of early PGreats in this score. |
|
|
| `egr` | Integer | The amount of early greats in this score. |
|
|
| `egd` | Integer | The amount of early goods in this score. |
|
|
| `ebd` | Integer | The amount of early bads in this score. |
|
|
| `epr` | Integer | The amount of early poors in this score. |
|
|
| `lpg` | Integer | The amount of late PGreats in this score. |
|
|
| `lgr` | Integer | The amount of late greats in this score. |
|
|
| `lgd` | Integer | The amount of late goods in this score. |
|
|
| `lbd` | Integer | The amount of late bads in this score. |
|
|
| `lpr` | Integer | The amount of late poors in this score. |
|
|
|
|
## Judgements
|
|
|
|
The following judgements are defined:
|
|
|
|
- `cool`
|
|
- `great`
|
|
- `good`
|
|
- `bad`
|
|
- `poor`
|
|
|
|
## Rating Algorithms
|
|
|
|
### Score Rating Algorithms
|
|
|
|
| Name | Description |
|
|
| :: | :: |
|
|
| `sieglinde` | A clearing algorithm that rewards you points based on how difficult an easy clear or hard clear was. |
|
|
|
|
### Session Rating Algorithms
|
|
|
|
| Name | Description |
|
|
| :: | :: |
|
|
| `sieglinde` | The average of your best 10 sieglinde ratings this session. |
|
|
|
|
### Profile Rating Algorithms
|
|
|
|
| Name | Description |
|
|
| :: | :: |
|
|
| `sieglinde` | The average of your best 20 sieglinde ratings. |
|
|
|
|
## Difficulties
|
|
|
|
- `CHART`
|
|
|
|
## Classes
|
|
|
|
| Name | Type | Values |
|
|
| :: | :: | :: |
|
|
| `dan` | PROVIDED | INSANE_1, INSANE_2, INSANE_3, INSANE_4, INSANE_5, INSANE_6, INSANE_7, INSANE_8, INSANE_9, INSANE_10, INSANE_KAIDEN, OVERJOY, UNDEFINED
|
|
|
|
## Versions
|
|
|
|
This game has no versions, and presumably doesn't need to disambiguate its IDs.
|
|
|
|
## Supported Match Types
|
|
|
|
- `bmsChartHash`
|
|
- `tachiSongID`
|