From 490560d15b805c8dbb3587b90bceb96367c65861 Mon Sep 17 00:00:00 2001 From: drojf Date: Fri, 22 Jul 2022 12:58:28 +1000 Subject: [PATCH] Update Readme.md --- README.md | 72 +++++++++++++++++++++++++++++++++---------------------- 1 file changed, 44 insertions(+), 28 deletions(-) diff --git a/README.md b/README.md index 40ecaf0..a7542fe 100644 --- a/README.md +++ b/README.md @@ -8,43 +8,38 @@ The main rust script will generate a new emip file, apply it to the assets and p Please note that documentation is in two places: -1. This Readme.md file +1. This Readme.md file (for basic usage information) 2. [Detailed documentation with images etc. on the `higurashi-dev-guides` Wiki](https://github.com/07th-mod/higurashi-dev-guides/wiki/UI-editing-scripts). + - You don't need to read all of this to use the tool! -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 +## Usage instructions for translators and dev team -To use this tool you will need these prerequisites: +### Prerequisites -- Install Python 3 -- Install the Python package `unitypack` (do `pip install unitypack`) -- Install Rust -- Download the [vanilla UIs](http://07th-mod.com/archive/vanilla.7z) 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](https://github.com/DerPopo/UABE/files/2408196/AssetsBundleExtractor_2.2beta4_applyemip.zip)) - - 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`. +1. Install Python 3 +2. Run `pip install numpy Pillow unitypack` to install the required Python packages +3. Install Rust +4. Download exactly this version of UABE https://github.com/SeriousCache/UABE/releases/tag/2.2stabled +5. Download 7zip (standalone console version) from here https://www.7-zip.org/download.html +6. 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` +7. Download the [vanilla UIs](http://07th-mod.com/archive/vanilla.7z) for Higurashi games and unpack them into `assets/vanilla`. -## Usage +### Using the tool to generate sharedassets0.assets -### Preparation for a new episode +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 -#### Preparing font files +``` +./compileall.sh +``` -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` -1. Click "Export Raw" and save the files to disk -2. Rename them as `msgothic_0.dat` and `msgothic_2.dat` -3. Move them to `assets/vanilla//msgothic_0.dat` & `assets/vanilla//msgothic_2.dat` - -### Generating sharedassets0.assets - -Then simply run this: +To build a particular chapter/version run the following command ``` cargo run @@ -56,6 +51,27 @@ cargo run `` 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: + +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` +1. Click "Export Raw" and save the files to disk +2. Rename them as `msgothic_0.dat` and `msgothic_2.dat` +3. Move them to `assets/vanilla//msgothic_0.dat` & `assets/vanilla//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.