diff --git a/README.md b/README.md index fae958b..7b5e0b9 100644 --- a/README.md +++ b/README.md @@ -5,21 +5,19 @@ src="https://user-images.githubusercontent.com/76574898/255353006-6c4504d0-c9a4-40d1-961f-db4cef7add0d.png" alt="tja2fumen – TJA chart converter" /> +
+ tja2fumen is an open-source tool that allows you to convert TJA charts (.tja) to fumen charts (.bin).

- tja2fumen is a tool for Taiko no Tatsujin that allows you to convert TJA charts (.tja) to fumen charts (.bin). + Test status (main branch) + GitHub release (with filter) + MIT License

+ ---- -## Goals - -- Provide open source code to act as a reference for parsing and writing both the TJA and Fumen file formats. -- Fix the existing issues with `tja2bin.exe`: - - Desync due to `#BPMCHANGE` commands. (https://github.com/Fluto/TakoTako/issues/16) - - Crashes due to `#SECTION`, `#NEXTSONG`, `#LYRIC`, etc. commands. - ## Usage tja2fumen is included as part of several existing projects. So, you may be using tja2fumen already! @@ -27,62 +25,67 @@ tja2fumen is included as part of several existing projects. So, you may be using - **XB1/TDMX**: [TakoTako](https://github.com/fluto/takotako) converts both chart and audio files for XB1/TDMX. - **Nijiro**: [TaikoSoundEditor](https://github.com/NotImplementedLife/TaikoSoundEditor) converts both chart and audio files for NIjiro. -### → Adding `tja2fumen.exe` to older TakoTako versions (3.2.0 and below) +For older versions of TakoTako (3.2.0 and below), you can add tja2fumen by renaming `tja2fumen.exe` to `tja2bin.exe` and placing it inside TakoTako's plugin folder (`BepInEx/plugins/com.fluto.takotako/`). -> **Note**: Before adding `tja2fumen` to TakoTako, you may want to back up the original `tja2bin.exe` file, to make sure you can switch back to the old converter if necessary. The easiest way to do this is by renaming the existing file to `tja2bin.exe.bak`. +You can also use tja2fumen directly on a `.tja` file by downloading `tja2fumen.exe` from the [Releases](https://github.com/vivaria/tja2fumen/releases) page and running `tja2fumen.exe file.tja` in a command prompt. -To use this converter with TakoTako, head to the [Releases](https://github.com/vivaria/tja2fumen/releases) page and download the `tja2fumen.exe` file attached to the release. Then, rename `tja2fumen.exe` to `tja2bin.exe`, and place the file in the TakoTako plugin folder. +## Supported commands -TakoTako's plugin folder is inside of the BepInEx folder, which will typically look something like: +✅ = Fully supported, 🔘 = Ignored, ⚠️ = Incorrect behavior, ❌ = Crashes the converter, ❔ = Unknown -``` -C:\XboxGames\T Tablet\Content\BepInEx\plugins\com.fluto.takotako -``` +| Command | Description | tja2fumen | tja2bin| +| --- | --- | --- | --- | +| `BPM:` | Song's beats per minute. | ✅ | ✅ | +| `OFFSET:` | Song's offset in seconds. | ✅ | ✅ | +| `TITLE:`, `SUBTITLE:`,
`WAVE:`, `DEMOSTART:`, etc. | Other song metadata fields. | 🔘 | 🔘 | +| `COURSE:` | Chart's difficulty category. | ✅ | ✅ | +| `LEVEL:` | Chart's number of stars (between 1 and 10). | ✅ | ✅ | +| `BALLOON:` | List of hits for each balloon in chart. | ✅ | ✅ | +| `SCOREINIT:` | Sets INIT value for the scoring method. | ✅ | ✅ | +| `SCOREDIFF` | Sets DIFF value for the scoring method. | ✅ | ✅ | +| `STYLE: {Single,Double}` | Assign chart to single/multiplayer. | ✅ | ❌ | +| `EXAM1:`, `GAUGEINCR:`,
`TOTAL:`, etc. | Other chart metadata fields. | 🔘 | 🔘 | +| `0`, `1`, `2`, `3`, `4`,
`5`, `6`, `7`, `8`, `9` | Main notes. | ✅ | ✅ | +| `A`, `B` | Multiplayer note with hands. | ❔ | ❔ | +| `F` | Hidden ADLIB note.| ❔ | ❔ | +| `9000,`
`9008,` | Double Kusudama note. | 🔘 | ❔ | +| `#START`, `#END` | Marks the beginning and end of a chart's notation. | ✅ | ✅ | +| `#START {P1, P2}` | Marks the chart as first or second player. | ✅ | ❔ | +| `#MEASURE` | Changes the time signature. | ✅ | ✅ | +| `#BPMCHANGE` | Changes the beats per minute. | ✅ | ⚠️ | +| `#DELAY` | Add offset in seconds. | ✅ | ❌ | +| `#SCROLL` | Multiplies the default scrolling speed by this value. | ✅ | ✅ | +| `#GOGOSTART, #GOGOEND` | Activate or deactivate go-go time. | ✅ | ✅ | +| `#BARLINEOFF`, `#BARLINEON` | Turn off/on visual measure lines. | ✅ | ✅ | +| `#BRANCHSTART` | Add condition for branching (diverge) paths. | ✅ | ✅ | +| `#BRANCHEND` | Starts normal chart notation without branching. | ✅ | ✅ | +| `#N, #E, #M` | Starts chart notation for a specific path. | ✅ | ✅ | +| `#SECTION` | Reset accuracy values for notes and drumrolls on the next measure. | ✅ | ✅ | +| `#LYRIC` | Shows song lyrics at the bottom of the screen. | 🔘 | ❌ | +| `#LEVELHOLD` | The current branch is forced until the end of the song. | ❔ | ❔ | +| `#BMSCROLL`, `#HBSCROLL`,
`#DIRECTION`, etc. | Other chart commands. | 🔘 | ❌ | -### → Using `tja2fumen` directly - -If you'd like to build a project on top of `tja2fumen`, you have several options: - -#### 1. Using the executable file (`tja2fumen.exe`) - -Head to the [Releases](https://github.com/vivaria/tja2fumen/releases) page, and download the `tja2fumen.exe` file attached to the release. - -Then, you can convert a TJA file on the command line by running: - -``` -tja2fumen.exe file.tja -``` - -#### 2. Using the `tja2fumen` Python package - -If you're familiar with Python, you can install `tja2fumen` by running: - -``` -pip install tja2fumen -``` - -Then, you can convert a TJA file on the command line by running: - -``` -tja2fumen file.tja -``` - -Or, you can import the `main` function in your Python code, and convert TJA files this way instead: - -```python -from tja2fumen import main -main(argv=["file.tja"]) -``` +If a command is not listed, you can assume that it is unsupported. If you would like support for a missing command, please make a request by opening an issue. ## Reporting bugs -If you've found a .TJA file that `tja2fumen` converts incorrectly, please [open a new issue](https://github.com/vivaria/tja2fumen/issues/new) on the tja2fumen repo. +If you've found a `.tja` file that tja2fumen converts incorrectly, please [open a new issue](https://github.com/vivaria/tja2fumen/issues/new) on the tja2fumen repo. It is especially important that you attach the song files to the issue. You can do this by adding the song files to a `.zip` (Select files -> Right click -> "Send to" -> "Compressed (zipped) folder"), and then uploading the `.zip` to the issue. This greatly helps me to reproduce and fix any issues. +You can also message me directly on Discord (`_vivaria`) if you don't have a GitHub account, and I will take care of making an issue for you. :) + +## Building on top of tja2fumen + +If you are a developer looking to add tja2fumen to your project, you have two options: + +1. For non-Python projects, you can download `tja2fumen.exe` and call it via a system call. +2. For Python projects, you can install tja2fumen via `pip install tja2fumen`. + +tja2fumen uses a very permissable license ([MIT License](https://choosealicense.com/licenses/mit/)). You are free to distribute and modify tja2fumen, but please include a copy of the MIT License alongside the `tja2fumen.exe` executable if you copy it into your project. + ## Attribution - The fumen-parsing code in this project is based off of a modified copy of the [`readFumen()`](https://github.com/KatieFrogs/fumen-tools/blob/6ff3a2f7f53687f3dd49c5c57fcfc5ccbe3e5a10/fumen2osu/fumen2osu.py#L7-L152) function from the [`fumen2osu.py`](https://github.com/KatieFrogs/fumen-tools/blob/main/fumen2osu/fumen2osu.py) found in @KatieFrogs' [`fumen-tools`](https://github.com/KatieFrogs/fumen-tools) project. - The TJA-parsing code in this project is a Python translation of the [`parseTJA.js`](https://github.com/WHMHammer/tja-tools/blob/master/src/js/parseTJA.js) file from @WHMHammer's [`tja-tools`](https://github.com/WHMHammer/tja-tools). - -> **Note**: To be explicily clear, neither @KatieFrogs nor @WHMHammer have endorsed this project, are affiliated with this project, or have made any direct contributions to this project. I have just modified their existing work. +- sakurada0291, DDDDDD, U-ros, and others in the Discord for helping to test tja2fumen. :)