mirror of
https://github.com/zkldi/Tachi.git
synced 2026-10-06 22:07:58 +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
33 lines
1.6 KiB
Markdown
33 lines
1.6 KiB
Markdown
# Versions
|
|
|
|
Versions are a method for us marking charts as being available in a certain "version" of the game.
|
|
|
|
The predominant use for this is for arcade games, where new versions of the game generally come out and add/remove charts.
|
|
|
|
It's useful for us to know what charts are available in what version for two purposes.
|
|
|
|
The first allows us to create folders - users playing on a certain version of a game don't want to see charts they can't play!
|
|
|
|
The second is more complex.
|
|
|
|
## Disambiguation and `isPrimary`
|
|
|
|
Sadly, the real world isn't easy to deal with. It's possible for a chart to exist in
|
|
version A of a game, get removed in version B, and then come back in version C with
|
|
new, completely different charts.
|
|
|
|
**Worse still**, it's possible for that song to use the *exact same* in game ID it used
|
|
before. If we use `inGameID` to identify things, now we've got a critical ambiguity!
|
|
|
|
Does `inGameID: 1, difficulty: ANOTHER` refer to the version A chart, or the version C one? For games where metrics are chart-dependent, this could be *lethal* to the leaderboards.
|
|
|
|
It's much easier to get a good score in IIDX if the chart thinks it has less notes than it actually has!
|
|
|
|
To fix this, we also use versions as an identifer for disambiguation. If a score comes
|
|
in, it **MAY** pass what version the score was attained on.
|
|
|
|
This allows us to immediately disambiguate the previous case.
|
|
|
|
If a version is **not** passed in, we assume that the score is for the chart marked as
|
|
`isPrimary: true`. Furthermore, seeds tests **enforce** that duplicates on certain IDs expected-to-be-unique cannot be true unless all-but-one-of-them is marked as `isPrimary: false`.
|