Update Readme.md

README.md

@@ -50,7 +50,9 @@ You may encounter the following problems:
 - Windows Defender may block/delete our precompiled `ui-compiler.exe`. In this case, you can either try to unblock it, or install Rust to make the script compile it on your own computer. Contact us if you have this issue.
 - For any other error, likely we just need to update the build script, so please contact us.
 
-### Modifying Assets
+----
+
+## Modifying Assets
 
 Assets are located in the `assets` folder. Replace any file in the `assets` folder, then run the script again, and it should be included in the generated assets files.
 
@@ -60,7 +62,11 @@ Assets are located in the `assets` folder. Replace any file in the `assets` fold
 
 Github actions might be disabled for your forks. Clicking on the 'Actions' tab should allow you to enable it. Please do this before proceeding.
 
-#### Building a release
+----
+
+## Triggering Github Actions Builds
+
+### Building a release
 
 To use Github Actions to build a release, create a tag like `v1.0.6_onikakushi` which contains the chapter name (separated by an underscore) you want to build (or 'all' for all chapters).
 
@@ -68,11 +74,15 @@ Click on the 'Actions' tab to observe the build process.
 
 Once the build is complete, go to the 'Releases' page, and a new draft release should appear. You can check everything is OK before publishing the release, or just download the files without publishing the release.
 
+### Building `ui-compiler.exe` using Github Actions
+
+To build just the `ui-compiler.exe` using Github Actions (on Github's server), push any tag to the repository.
+
 ----
 
-## Usage instructions when preparing for a new episode
+## New Episode Preperation Instructions
 
-The following information is only used when generating a new episode.
+The following information is only used when adding support for 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.
 
@@ -88,9 +98,7 @@ You'll need to extract the 'msgothic' font files from the stock `.assets` file b
 2. Rename them as `msgothic_0.dat` and `msgothic_2.dat`
 3. Move them to `assets/vanilla/<chapter>/msgothic_0.dat` & `assets/vanilla/<chapter>/msgothic_2.dat`
 
-## Building `ui-compiler.exe`
+----
-
-To build just the `ui-compiler.exe`, push any tag to the repository.
 
 ## Extra Notes
 
@@ -99,3 +107,40 @@ If you want to use this tool to compile assets for a different language, you can
 ## Developer Notes
 
 Documentation for the underlying python scripts can be found [here](https://github.com/07th-mod/higurashi-dev-guides/wiki/UI-editing-scripts).
+
+----
+
+## Manual Setup and Running Instructions (Windows Only)
+
+We suggest using the above `python` script intead to setup everything, but these instructions remain here for reference.
+
+These instructions do not rely on the `build.py` script, and are roughly how we ran the `ui-editing-scripts` before the `build.py` was created.
+
+Note: these are rough instructions only, and may need updating.
+
+1. Install Python 3
+2. Run `python -m pip install -r requirements.txt` (or `python3` instead of `python`), to install the python dependencies
+3. Download [the vanilla assets from our website](http://07th-mod.com/archive/vanilla.7z), then extract them to the root of the repository (the `assets` folder in the archive will merge with the `assets` file in the repository)
+4. Download and extract UABE somewhere, then make sure `AssetBundleExtractor.exe` is on your path
+5. Decide whether you want to get the pre-compiled executable, or compile the executable yourself (see below):
+
+### Option 1: Getting the pre-compiled executable
+
+1. Download the [pre-compiled `ui-compiler.exe`](https://github.com/07th-mod/ui-editing-scripts/releases/latest/download/ui-compiler.exe)
+2. Make sure it is on your path, or in the root of the repository
+
+### Option 2: Compiling the exe yourself
+
+1. [Follow this guide to install Rust on Windows](https://docs.microsoft.com/en-us/windows/dev-environment/rust/setup) There are some gotchas for Windows (like you need to install Visual Studio before installing rust).
+2. In the root of the repository, run `cargo build` to check everything works correctly.
+
+## Running ui-editor-scripts
+
+- To compile a particular chapter/variant, open `build.py` and look at the valid chapters, for example:
+    - `onikakushi 5.2.2f1`
+    - `matsuribayashi 2017.2.5 unix 51100D6D`
+- Run `cargo run` (compile yourself) or `ui-compiler` (pre-compiled) with the command you chose earlier. Following the previous example:
+    - `cargo run onikakushi 5.2.2f1`
+    - `cargo run matsuribayashi 2017.2.5 unix 51100D6D`
+
+If you compiled the exe yourself, you can run the `./compileall.sh` under windows by using `git bash` which comes with Git for Windows.