ui-editing-scripts/README.md

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:

1. This Readme.md file
2. Detailed documentation with images etc. on this repository's Wiki.

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.

Prerequisites

To use this tool you will need these prerequisites:

• Install Python 3
• Install the Python package unitypack (do pip install unitypack)
• Install Rust
• Download the vanilla UIs for Higurashi games and unpack them into assets/vanilla.
• You'll also need UABE 2.2 stable or newer (or 2.2 beta4 with this patch applied)
  • Make sure AssetBundleExtractor.exe is on your PATH
• You'll need the 7zip command line executable
  • Make sure 7za.exe is available in your system PATH.

Usage

Preparation for a new episode

Preparing font files

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

1. Open one of the sharedassets0.assets from the new episode in UABE
2. 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
3. Click "Export Raw" and save the files to disk
4. Rename them as msgothic_0.dat and msgothic_2.dat
5. Move them to assets/vanilla/<chapter>/msgothic_0.dat & assets/vanilla/<chapter>/msgothic_2.dat

Generating sharedassets0.assets

Then simply run this:

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.

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.