1
0
mirror of synced 2024-11-27 22:40:49 +01:00

README.md: Add logo, divider, smaller headers

This commit is contained in:
Viv 2023-07-22 10:41:14 -04:00 committed by GitHub
parent 60a9e249cd
commit 56df81b59b
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23

View File

@ -1,22 +1,32 @@
# tja2fumen
<p align="center">
<img
width="400"
src="https://user-images.githubusercontent.com/76574898/255335031-5578a3c4-2e5b-4a94-85cb-b40693254801.png"
alt="tja2fumen TJA chart converter"
/>
</p>
`tja2fumen` is a tool for Taiko no Tatsujin that allows you to convert TJA charts (`.tja`) to fumen charts (`.bin`).
<p align="center">
<code>tja2fumen</code> is a tool for Taiko no Tatsujin that allows you to convert TJA charts (<code>.tja</code>) to fumen charts (<code>.bin</code>).
</p>
### Goals
----
## 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
## Usage
tja2fumen is included as part of several existing projects. So, you may be using tja2fumen already!
- **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)
### → Adding `tja2fumen.exe` to older TakoTako versions (3.2.0 and below)
> **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`.
@ -28,11 +38,11 @@ TakoTako's plugin folder is inside of the BepInEx folder, which will typically l
C:\XboxGames\T Tablet\Content\BepInEx\plugins\com.fluto.takotako
```
## → Using `tja2fumen` directly
### → 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`)
#### 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.
@ -42,7 +52,7 @@ Then, you can convert a TJA file on the command line by running:
tja2fumen.exe file.tja
```
### 2. Using the `tja2fumen` Python package
#### 2. Using the `tja2fumen` Python package
If you're familiar with Python, you can install `tja2fumen` by running:
@ -63,13 +73,13 @@ from tja2fumen import main
main(argv=["file.tja"])
```
# Reporting bugs
## 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.
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.
# Attribution
## 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).