1.6 KiB
Tachi Documentation
This site serves as the documentation for Tachi.
Tachi is a rhythm game score tracking engine, and is the name of the codebase that powers both Bokutachi and Kamaitachi.
About This Documentation
So that we don't have to write and maintain three separate sets of documentation, this site works like a Monorepo for Tachi's documentation.
API Reference
This is for people who want to make things with Tachi's API, and assumes basic knowledge of APIs and how they work.
View it here.
Codebase Reference
This is for people who want to work on Tachi's codebase. This contains things like the tools we use and the infrastructure that powers Tachi.
This also contains contribution information.
View it here.
User Reference
This is for end user reference, such as score importing tutorials, documentation on tachi's statistics. It requires no programming knowledge, and is mostly used as a wiki-like reference.
View it here.
Contributing
If you want to contribute to this documentation, you can find the repository here!
If you want to contribute to the Tachi backend code, you can find the repository here! !!! note You should read the Contributing To Tachi-Server page beforehand.
Acknowledgements
This documentation is built ontop of the beautiful Material MKDocs theme.
--8<-- "includes/abbreviations.md"