tja2fumen is a tool that allows you to convert TJA charts (
.tja) to fumen charts (.bin).
tja2fumen is a tool that allows you to convert TJA charts (.tja) to fumen charts (.bin).
---- > [!IMPORTANT] > tja2fumen is a tool designed for mod developers. It allows modders to load TJA charts into official games by converting them into Taiko's official binary fumen file format (`.bin`). > > If you are not a mod developer, and you just want to play TJAs on Taiko no Tatsujin PC, please install and run [TakoTako](https://github.com/fluto/takotako). (Alternatively, you can also run TakoTako's `TJAConvert.exe` [directly on your TJA files](#tja--audio-conversion).) > [!NOTE] > #### Replacing tja2bin (TakoTako 3.2.0 and below) > TakoTako 3.2.0 includes an older, flawed tool called `tja2bin.exe`. If you have downloaded TakoTako 3.2.0, you should replace the old `tja2bin.exe` with the latest version of `tja2fumen.exe`. This will ensure that your TJAs get converted accurately. > > You can do this by: > - Downloading `tja2fumen.exe` from the [releases page](https://github.com/vivaria/tja2fumen/releases). > - Renaming the file to `tja2bin.exe`. > - Copying and pasting it into the `{TDMX_INSTALLATION_DIR}/BepInEx/plugins/com.fluto.takotako/` directory, replacing the old `tja2bin.exe`. ## Features tja2fumen is designed to be an open source alternative to the closed source tja2bin tool that has been floating around various Discord servers. tja2fumen fixes several outstanding tja2bin issues, while providing an open source codebase to modify and learn from. - Command line tool to convert `.tja` chart files to official fumen `.bin` files. - Decodes official fumen `.bin` files (to inspect metadata and note data). - Fix `.bin` files that were previously converted by `tja2bin` (WIP, see [#65](https://github.com/vivaria/tja2fumen/issues/65)). - Uses strong development practices (thorough test suite with example charts, type checking). - Provides an open source resource for the Taiko no Tatsujin fumen file format. ## Usage ### TJA conversion To convert a `.tja` file to `.bin` files, simply download `tja2fumen.exe` and run: ```bash tja2fumen.exe "file.tja" ``` ### TJA + Audio conversion `tja2fumen.exe` only converts TJA files. If you want to convert both TJAs _and_ audio (.OGG or .WAV files) to `.bin` files, you can use the TakoTako plugin for the PC version of Taiko no Tatsujin. However, if you don't want to install and run Taiko no Tatsujin on PC, then you can use this simpler method instead: 1. Download the [latest release of TakoTako](https://github.com/Fluto/TakoTako/releases). 2. Extract the `TJAConvert.exe` program into a separate folder. 3. Download the newest version of `tja2fumen.exe`. Rename it `tja2bin.exe`, then place it in the same folder as `TJAConvert.exe`. 4. Run the following command: ```bash TJAConvert.exe "path_to_folder_containing_both_tja_and_audio/" ``` `TJAConvert.exe` will convert the audio to CRIWARE HCA packed into ACB container, and then it will call `tja2fumen.exe` to convert the chart files. (This is the exact same conversion you would get by running TakoTako as a BepInEx plugin -- you just have more control.) Note that the output audio is unencrypted, and that ACB audio files are incompatible with any NUS3BANK-based games. ### Decoding fumen charts in Python scripts If you want to explore the song structure of existing `.bin` files or `.tja` files using Python scripts, run: ``` pip install tja2fumen ``` Then, you can use tja2fumen's Python API as follows: ```python # parse song files from tja2fumen.parsers import parse_fumen, parse_tja fumen = parse_fumen("path/to/fumen_file.bin") tja = parse_tja("path/to/tja_file.tja") # convert tja data to fumen data from tja2fumen.converters import convert_tja_to_fumen fumen_converted = convert_tja_to_fumen(tja) # modify the FumenCourse object # - e.g.1: change the timing window header metadata from tja2fumen.constants import TIMING_WINDOWS fumen.header.b000_b431_timing_windows = TIMING_WINDOWS['Easy']*36 # - e.g.2: change the note offset values for measure in fumen.measures: measure.offset_start += 1_000 # 1000ms == 1s measure.offset_end += 1_000 # write the modified fumen back to a .bin file from tja2fumen.writers import write_fumen write_fumen("path/to/file.bin", fumen) ``` Please refer to `src/__init__.py` for further example usage of the Python API. ## TJA Support If there is an unsupported feature that you would like support for, please make a request by [opening a new issue](https://github.com/vivaria/tja2fumen/issues/new). ### Supported file formats > **Legend**: `✅` = Fully supported, `❌` = Not supported | | tja 2 fumen | tja 2 bin | Comment | |---------------------|-------------|-----------|----------| | UTF-8 (with BOM) | `✅` | `❌` | | | UTF-8 (without BOM) | `✅️` | `✅` | | | Shift-JIS | `✅` | `✅` | | ### Supported metadata > **Legend**: `✅` = Fully supported, `⚪️` = Ignored, `⚠️` = Incorrect behavior, `❌` = Not supported | | tja 2 fumen | tja 2 bin | Comment | |-----------------------------------------------------------------|-------------|-----------|-------------------------------------------------------------------------| | `BPM:`, `OFFSET:` | `✅` | `✅` | | | `TITLE:`, `SUBTITLE:`, `WAVE:`,