UI Compiler

Scripts for easier editing of Unity assets for Higurashi.

The main rust script will generate a new emip file, apply it to the assets and pack the assets into 7zip archive we need for a release.

Documentation Notes

Please note that documentation is in two places:

This Readme.md file (for basic usage information)
Detailed documentation with images etc. on the higurashi-dev-guides Wiki.
- You don't need to read all of this to use the tool!

Usage instructions for translators and dev team

Prerequisites

Install Python 3
Run pip install numpy Pillow unitypack to install the required Python packages
Install Rust
Download exactly this version of UABE https://github.com/SeriousCache/UABE/releases/tag/2.2stabled
Download 7zip (standalone console version) from here https://www.7-zip.org/download.html
Extract UABE and 7z and make sure both are on your PATH
- On Windows, you need to restart your terminal window to update your PATH.
  - Try caling AssetBundleExtractor.exe
  - Try caling 7za.exe
Download the vanilla UIs for Higurashi games and unpack them into assets/vanilla.

Using the tool to generate sharedassets0.assets

To build all chapters:

On Linux open a terminal and run the below command
On Windows with "Git for Windows" installed, right click the folder and click "Git Bash Here", then use that terminal

./compileall.sh

To build a particular chapter/version run the following command

cargo run <chapter> <unityversion> <system>

<chapter> is simply onikakushi, watanagashi and so on.

<unityversion> is the unity version, like 5.5.3p3 or 2017.2.5. Note that for version 2017.2.5f1, you just enter 2017.2.5 (currently only support the first 8 characters of the unity version)

<system> is win or unix.

Usage instructions when preparing for a new episode

The following information is only used when generating a new episode.

Please look through the detailed documentation, especially if you're working on a new chapter, new language, or using UABE - this file does not contain information on those topics.

Preparing font files

You'll need to extract the 'msgothic' font files from the stock .assets file before starting:

Open one of the sharedassets0.assets from the new episode in UABE
Find two font files (search for *msgothic* and hit F3 a couple times). Note there are other files with msgothic in the name, you're looking for ~100kb files with the exact names below:
- MonoBehaviour msgothic_0 SDF
- MonoBehaviour msgothic_2 SDF
Click "Export Raw" and save the files to disk
Rename them as msgothic_0.dat and msgothic_2.dat
Move them to assets/vanilla/<chapter>/msgothic_0.dat & assets/vanilla/<chapter>/msgothic_2.dat

Extra Notes

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.

Developer Notes

Documentation for the underlying python scripts can be found here.

3.2 KiB Raw Blame History