divatool/README.md

36 lines
1.2 KiB
Markdown

# divatool
A tool for that one game everyone hates but works on anyway.
## Requirements
Divatool is written in and uses [Python 3](https://www.python.org/downloads/).
There are also several third party dependencies not provided as part of this repository,
mostly used for the `xdudata` command. You need to have the binaries of the following tools
either in your `$PATH` variable or in the [`tools`](./tools) folder. These tools are:
* [clHCA](https://github.com/KinoMyu/FastHCADecoder)
* acb_extract
* usm_extract
* [ffmpeg](https://www.ffmpeg.org/download.html)
* [mono](https://www.mono-project.com/download/stable/) (if using Linux)
Make sure these executables are called the same way on your machine.
## Usage
TODO: add detailed descriptions for all parameters.
Using the tool to update XDUData for the player:
```
divatool.py xdudata update [path to the 'files' folder from the game] [path to the XDUData folder for the player] [path to the 'xdutranslations' repo folder] [path to the temp files folder]
```
Example:
```
divatool.py xdudata update /home/user/gameapp/files /home/user/player/XDUData /home/user/git/xdutranslations /var/tmp
```
Note that the 'files' folder from the app must contain the db files for this to work.