mirror of
https://github.com/zkldi/Tachi.git
synced 2026-09-30 10:58:07 +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
69 lines
1.9 KiB
Markdown
69 lines
1.9 KiB
Markdown
# About
|
|
|
|
This part of the documentation is for end users, and can
|
|
be treated like a Wiki for Tachi information.
|
|
|
|
As such, nothing here will require programming knowledge,
|
|
but it might help.
|
|
|
|
---
|
|
|
|
## What is Tachi?
|
|
|
|
Tachi refers to the code that powers both Kamaitachi and
|
|
Bokutachi.
|
|
|
|
### What's Bokutachi?
|
|
|
|
Bokutachi is an instance of Tachi designed for Home simulators, such as BMS or USC.
|
|
|
|
### What's Kamaitachi?
|
|
|
|
Kamaitachi is an instance of Tachi designed for Arcade
|
|
games, such as beatmania IIDX or Sound Voltex.
|
|
|
|
### Why are they separate?
|
|
|
|
Kamaitachi is a private score tracker, and Bokutachi is not.
|
|
|
|
## What is the point of Tachi?
|
|
|
|
Tachi is a score tracker and analyser for various rhythm
|
|
games. It was designed out of a dislike for existing websites
|
|
that display your scores. I think that scores are integral
|
|
to the rhythm game experience, and that displaying them
|
|
properly is _just_ as important.
|
|
|
|
The benefits of Tachi include features like [Sessions](./features.md#sessions), which break your scores up into
|
|
groups of when they were played, and [Goals](./features.md#goals) which let you set automatically updating targets for yourself!
|
|
|
|
There are way more features that Tachi has, and you can
|
|
read about all of them [here](./features.md).
|
|
|
|
## Do I have to be good to use Tachi?
|
|
|
|
There's a prevailing notion that analysing scores in depth
|
|
is only for 'pro' players (or likewise).
|
|
|
|
In reality, it doesn't matter how good you are (or aren't),
|
|
being able to see your progress and analyse your scores
|
|
in more detail will help you pick out strengths and weaknesses in your skills as a player.
|
|
|
|
You do not need to be a 'pro' at all to benefit from
|
|
Tachi's analytics!
|
|
|
|
## Are there rules?
|
|
|
|
Yes.
|
|
|
|
You should familiarise yourself with the rules before
|
|
using any distribution of Tachi.
|
|
|
|
The rules can be found [here](./rules.md).
|
|
|
|
## I have a bug report or feature request.
|
|
|
|
Please reach out on discord or [GitHub Issues](https://github.com/zkldi/Tachi)!
|
|
|
|
--8<-- "includes/abbreviations.md"
|