Add readme

This commit is contained in:
Jáchym Toušek
2018-09-07 19:03:47 +02:00
parent c168e91dd4
commit f16b61a368

View File

@@ -1,2 +1,18 @@
# ui-editing-scripts UI Compiler
----
Scripts for easier editing of Unity assets for Higurashi. Scripts for easier editing of Unity assets for Higurashi.
To use this tool you will need to install both Rust and Python. Then simply run this:
```
cargo run <chapter> <platform>
```
`<chapter>` is simply `onikakushi`, `watanagashi` and so on.
`<platform>` is `win` or `mac`. For tatarigoroshi platform can also be `win-mg` and `mac-mg`.
The script will generate a new emip file in the output directory which you can apply to assets file using UABE as described in the docs for the python scripts.
If you want to use this tool to compile assets for a different language, you can change the files in the assets directory to your needs.