docs.bokutachi.xyz Open in urlscan Pro
2a06:98c1:3120::3  Public Scan

Form analysis
2 forms found in the DOM

<form class="md-header__option" data-md-component="palette">
  <input class="md-option" data-md-color-media="" data-md-color-scheme="slate" data-md-color-primary="deep-purple" data-md-color-accent="deep-purple" aria-label="Switch to light mode" type="radio" name="__palette" id="__palette_1">
  <label class="md-header__button md-icon" title="Switch to light mode" for="__palette_2">
    <svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24">
      <path
        d="M12 7a5 5 0 0 1 5 5 5 5 0 0 1-5 5 5 5 0 0 1-5-5 5 5 0 0 1 5-5m0 2a3 3 0 0 0-3 3 3 3 0 0 0 3 3 3 3 0 0 0 3-3 3 3 0 0 0-3-3m0-7 2.39 3.42C13.65 5.15 12.84 5 12 5c-.84 0-1.65.15-2.39.42L12 2M3.34 7l4.16-.35A7.2 7.2 0 0 0 5.94 8.5c-.44.74-.69 1.5-.83 2.29L3.34 7m.02 10 1.76-3.77a7.131 7.131 0 0 0 2.38 4.14L3.36 17M20.65 7l-1.77 3.79a7.023 7.023 0 0 0-2.38-4.15l4.15.36m-.01 10-4.14.36c.59-.51 1.12-1.14 1.54-1.86.42-.73.69-1.5.83-2.29L20.64 17M12 22l-2.41-3.44c.74.27 1.55.44 2.41.44.82 0 1.63-.17 2.37-.44L12 22Z">
      </path>
    </svg>
  </label>
  <input class="md-option" data-md-color-media="" data-md-color-scheme="default" data-md-color-primary="deep-purple" data-md-color-accent="deep-purple" aria-label="Switch to dark mode" type="radio" name="__palette" id="__palette_2">
  <label class="md-header__button md-icon" title="Switch to dark mode" for="__palette_1" hidden="">
    <svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24">
      <path
        d="m17.75 4.09-2.53 1.94.91 3.06-2.63-1.81-2.63 1.81.91-3.06-2.53-1.94L12.44 4l1.06-3 1.06 3 3.19.09m3.5 6.91-1.64 1.25.59 1.98-1.7-1.17-1.7 1.17.59-1.98L15.75 11l2.06-.05L18.5 9l.69 1.95 2.06.05m-2.28 4.95c.83-.08 1.72 1.1 1.19 1.85-.32.45-.66.87-1.08 1.27C15.17 23 8.84 23 4.94 19.07c-3.91-3.9-3.91-10.24 0-14.14.4-.4.82-.76 1.27-1.08.75-.53 1.93.36 1.85 1.19-.27 2.86.69 5.83 2.89 8.02a9.96 9.96 0 0 0 8.02 2.89m-1.64 2.02a12.08 12.08 0 0 1-7.8-3.47c-2.17-2.19-3.33-5-3.49-7.82-2.81 3.14-2.7 7.96.31 10.98 3.02 3.01 7.84 3.12 10.98.31Z">
      </path>
    </svg>
  </label>
</form>

Name: search —

<form class="md-search__form" name="search">
  <input type="text" class="md-search__input" name="query" aria-label="Search" placeholder="Search" autocapitalize="off" autocorrect="off" autocomplete="off" spellcheck="false" data-md-component="search-query" required="">
  <label class="md-search__icon md-icon" for="__search">
    <svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24">
      <path d="M9.5 3A6.5 6.5 0 0 1 16 9.5c0 1.61-.59 3.09-1.56 4.23l.27.27h.79l5 5-1.5 1.5-5-5v-.79l-.27-.27A6.516 6.516 0 0 1 9.5 16 6.5 6.5 0 0 1 3 9.5 6.5 6.5 0 0 1 9.5 3m0 2C7 5 5 7 5 9.5S7 14 9.5 14 14 12 14 9.5 12 5 9.5 5Z"></path>
    </svg>
    <svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24">
      <path d="M20 11v2H8l5.5 5.5-1.42 1.42L4.16 12l7.92-7.92L13.5 5.5 8 11h12Z"></path>
    </svg>
  </label>
  <nav class="md-search__options" aria-label="Search">
    <button type="reset" class="md-search__icon md-icon" aria-label="Clear" tabindex="-1">
      <svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24">
        <path d="M19 6.41 17.59 5 12 10.59 6.41 5 5 6.41 10.59 12 5 17.59 6.41 19 12 13.41 17.59 19 19 17.59 13.41 12 19 6.41Z"></path>
      </svg>
    </button>
  </nav>
</form>

Text Content

Skip to content

Tachi Documentation
Tachi Documentation

Initializing search
 * Getting Started
 * Wiki
 * API Reference
 * Codebase Reference

Tachi Documentation
 * Getting Started
   Getting Started
    * Tachi Documentation Tachi Documentation
      Table of contents
       * About This Documentation
       * User Wiki
       * Programmer References
       * Acknowledgements
   
    * Contributing
      Contributing
       * Contributing Overview
       * Setting up a Local Development Environment
       * Contribution Guides
       * Component-Specific Guides
         Component-Specific Guides
          * GitHub Issues Guide
          * Documentation Guide
          * Database Seeds Guide
      
       * Cookbook
         Cookbook
          * Merging IIDX Data into seeds
          * Merging a SDVX music_db.xml into seeds
          * Adding New BMS Tables
   
    * Supporting New Games
      Supporting New Games
       * Game Support
       * Common Config
         Common Config
          * Common Configuration
          * Metrics
          * Metric Groups
          * Match Types
          * Versions
      
       * Implementing on the Server
       * Client Implementation
       * Game Information
         Game Information
          * beatmania IIDX (SP) Support
          * beatmania IIDX (DP) Support
          * MÚSECA Support
          * CHUNITHM Support
          * BMS (7K) Support
          * BMS (14K) Support
          * GITADORA (Gita) Support
          * GITADORA (Dora) Support
          * jubeat Support
          * maimai DX Support
          * pop'n music Support
          * SOUND VOLTEX Support
          * USC (Controller) Support
          * USC (Keyboard) Support
          * WACCA Support
          * PMS (Controller) Support
          * PMS (Keyboard) Support
          * ITG Support

 * Wiki
   Wiki
    * About
    * Tachi Rules
    * Games
    * Feature List
    * What's the difference between a PB and a Score?
    * What Are Filter Directives?
    * What are Lamps?
    * Score Oddities

 * API Reference
   API Reference
    * API Overview
    * API Authorisation
    * Notable Terminology
    * Endpoints
      Endpoints
       * Example Endpoint
       * Status Checks
       * Import Scores
       * Internal Authentication
       * Users
       * Individual User on Specific Game
       * User Integrations
       * Session Endpoints
       * Score Endpoints
       * Search Endpoints
       * Game Endpoints
       * Game:Playtype Endpoints
       * Admin Endpoints
       * UGPT Stat Showcase
       * API Token Management
       * OAuth2 Integration
       * API Client Management
       * Config Endpoints
       * Import Document Endpoints
       * GPT-Target Endpoints
       * UGPT-Target Endpoints
   
    * Webhooks
      Webhooks
       * About Webhooks
       * Event: class-update/v1

 * Codebase Reference
   Codebase Reference
    * Codebase Overview
    * Setup
      Setup
       * Configuration Info
   
    * Infrastructure
      Infrastructure
       * Logging
       * Branching Model
       * Database Seeds
   
    * OAuth2
      OAuth2
       * Tachi API Clients
       * OAuth2 Flow
       * Client File Flow
   
    * Structure
      Structure
       * Style
       * File/Folder Organisation
       * Tests
   
    * BATCH-MANUAL
      BATCH-MANUAL
       * What is BATCH-MANUAL?
       * Direct Manual
   
    * Score Importing
      Score Importing
       * Score Import Main
       * Import Types
       * Parsing and Converting
       * Converter Failures
       * Importing DryScores
       * Orphan Scores
       * Parsing Import Processing Info
       * Sessions
       * Personal Bests
       * User Game Stats
       * Updating Goals
       * Updating Quests
       * Import Documents and Import Timings
   
    * Implementation Details
      Implementation Details
       * About
       * Search Implementation
       * Songs And Charts
       * Game Configuration
       * Score ID implementation
       * Goal ID implementation
       * Goals, Quests, Questlines

Table of contents
 * About This Documentation
 * User Wiki
 * Programmer References
 * Acknowledgements


TACHI DOCUMENTATION¶

This site serves as the documentation for Tachi.

Tachi is a fully-open rhythm game score tracking engine, and is the name of the
codebase that powers both Bokutachi and Kamaitachi.

Help

Tachi is fully open. The core is almost exclusively maintained by one person.
However, we support nearly twenty games and playtypes now. Said one person
cannot reasonably keep up with all the new things coming out in those games.

If you care about a game you play a lot, and want to help out Tachi, there are
loads of ways you can contribute and ease the load on the primary maintainer!

Because Tachi is fully open source, if you want a feature, bug-fix, or new
content added to your game, you can become a contributor or report to someone
who will contribute!

We maintain a comprehensive contribution guide, which is accessible to even
people who have never wrote a line of code in their life. If you want to improve
Tachi, and maybe even nab some development skills yourself (or look good on a
CV!), check it out. I've put a lot of effort into it.


ABOUT THIS DOCUMENTATION¶

This is the documentation for all of Tachi. It - like Tachi - is primarily
maintained by one person, and as such, some things may be slightly outdated,
wrong, or generally just ill-maintained.

Info

If you're confused about anything, ask in your Tachi instance's discord! We have
a remarkably helpful community of developers and contributors, who should be
able to help you out.

Apologies in advance! If you find a problem in the documentation, you can freely
contribute a fix to it. See the Contribution Guide!


USER WIKI¶

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.

--------------------------------------------------------------------------------


PROGRAMMER REFERENCES¶

These sections are for experienced programmers who want to see documentation on
how Tachi's components work internally and externally.


CONTRIBUTOR REFERENCE¶

If you're looking to contribute to Tachi, check out the Contribution Guide.


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 further documentation for Tachi's codebase. This is
mainly full of high-level architectural documentation.

View it here.


ACKNOWLEDGEMENTS¶

This documentation is built ontop of the beautiful Material MKDocs theme.

Next Contributing Overview

Made with Material for MkDocs