mirror
/
ddr-tools
mirror of https://github.com/987123879113/ddr-tools.git
1
0
Fork 0
Code Issues Projects Releases Wiki Activity

Update README.md

This commit is contained in:
Wesley Castro 2018-08-12 18:15:46 -07:00
parent 72bbac6cce
commit 1bcf922dd5
1 changed files with 24 additions and 6 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

30
README.md
View File

@ -1,7 +1,10 @@
# TCB Tools
Tools for extracting TCB image files from Dance Dance Revolution CS games.
# DDR Tools
Tools for extracting and modifying files from Dance Dance Revolution CS games.
## Building
## TCB Tools
Tools for extracting and converting TCB image files.
### Building
```
mkdir build
cd build
@ -9,9 +12,9 @@ cmake ..
make
```
## Usage
### Usage
### tcb-extract
#### tcb-extract
Search for and extract compressed and uncompressed TCB files within a file.
```
@ -22,7 +25,7 @@ Modes:
* 2 - Extract TCBs from file beginning with table (compressed entries).
* 3 - Extract TCBs from file beginning with table (uncompressed entries).
### tcb-convert
#### tcb-convert
Convert TCB files to PNG images or inject PNG images back into TCB files. The extracted image will be a standard RGBA PNG image converted from either a 16 or 256 color palletized source. When injecting a PNG back into a TCB, the image data will be updated and a new pallete will be generated to match the TCB's original format. The PNG you inject must be the same resolution as the TCB.
```
@ -31,3 +34,18 @@ Convert TCB files to PNG images or inject PNG images back into TCB files. The ex
Modes:
* e - Convert TCB to PNG.
* i - Inject PNG into TCB.
## filedata-tool.py
Extract and create filedata.bin files.
```
python3 filedata-tool.py <mode> <elf file> <filedata.bin> <directory>
```
Modes:
* extract - Extract the contents of `filedata.bin` to `directory`. All files referenced in the file table located in the game's `elf file` will be extracted in addition to "hidden" data missing from the file table. A CSV file will be created named `directory\fieldata.csv` containing IDs, offsets, and lengths found in the game's ELF, hidden file offsets and lengths, the exported filename, and a guessed description of the file contents to aid in modification.
* create - Create `filedata.bin` using files in `directory`. The CSV created by the extraction mode is used to assemble a new file in the correct order and to update the file table in `elf file`.
## Tips
* Don't modify the ids, offsets, or lengths in the CSV file created by the extraction mode. The filenames can be changed if desired.
* Don't change the order of the rows in the CSV file. It matches the order of the file table found in the game's ELF.
* New entries can't be added to the filetable, although this wouldn't be useful anyway. Instead, existing entries can be modified.