mirror of
https://github.com/zkldi/Tachi.git
synced 2026-10-01 11:28: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
27 lines
955 B
Markdown
27 lines
955 B
Markdown
# Game Support
|
|
|
|
Tachi is a *modular* score tracker. What that means is that you can define your own
|
|
support for games in Tachi, and as long as the module is loaded, that support will
|
|
be enabled on this Tachi instance.
|
|
|
|
## What games are supported?
|
|
|
|
See 'Game Information' in the sidebar for a list of all supported games and their configurations.
|
|
|
|
## How do I write support for a game?
|
|
|
|
Adding support for a game requires configuration in three places and a loading of `seeds`.
|
|
|
|
You will need to:
|
|
|
|
- [Create a configuration in common](./common-config/index.md).
|
|
- [Implement it in the server](./server-impl.md).
|
|
- [Implement it in the client](./client-impl.md).
|
|
- [Load songs, charts, folders, etc.](./seeds.md).
|
|
|
|
For more information on how to write each module and what they contain, click on the specific item.
|
|
|
|
## How do I enable that support?
|
|
|
|
In your `server`'s `conf.json5` file, add the game to `TACHI_CONFIG.GAMES`. This will enable this module.
|