You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: README.md
+52-7Lines changed: 52 additions & 7 deletions
Original file line number
Diff line number
Diff line change
@@ -50,7 +50,9 @@ You may encounter the following problems:
50
50
- 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.
51
51
- For any other error, likely we just need to update the build script, so please contact us.
52
52
53
-
### Modifying Assets
53
+
----
54
+
55
+
## Modifying Assets
54
56
55
57
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.
56
58
@@ -60,19 +62,27 @@ Assets are located in the `assets` folder. Replace any file in the `assets` fold
60
62
61
63
Github actions might be disabled for your forks. Clicking on the 'Actions' tab should allow you to enable it. Please do this before proceeding.
62
64
63
-
#### Building a release
65
+
----
66
+
67
+
## Triggering Github Actions Builds
68
+
69
+
### Building a release
64
70
65
71
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).
66
72
67
73
Click on the 'Actions' tab to observe the build process.
68
74
69
75
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.
70
76
77
+
### Building `ui-compiler.exe` using Github Actions
78
+
79
+
To build just the `ui-compiler.exe` using Github Actions (on Github's server), push any tag to the repository.
80
+
71
81
----
72
82
73
-
## Usage instructions when preparing for a new episode
83
+
## New Episode Preperation Instructions
74
84
75
-
The following information is only used when generating a new episode.
85
+
The following information is only used when adding support for a new episode.
76
86
77
87
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.
78
88
@@ -88,9 +98,7 @@ You'll need to extract the 'msgothic' font files from the stock `.assets` file b
88
98
2. Rename them as `msgothic_0.dat` and `msgothic_2.dat`
89
99
3. Move them to `assets/vanilla/<chapter>/msgothic_0.dat` & `assets/vanilla/<chapter>/msgothic_2.dat`
90
100
91
-
## Building `ui-compiler.exe`
92
-
93
-
To build just the `ui-compiler.exe`, push any tag to the repository.
101
+
----
94
102
95
103
## Extra Notes
96
104
@@ -99,3 +107,40 @@ If you want to use this tool to compile assets for a different language, you can
99
107
## Developer Notes
100
108
101
109
Documentation for the underlying python scripts can be found [here](https://github.com/07th-mod/higurashi-dev-guides/wiki/UI-editing-scripts).
110
+
111
+
----
112
+
113
+
## Manual Setup and Running Instructions (Windows Only)
114
+
115
+
We suggest using the above `python` script intead to setup everything, but these instructions remain here for reference.
116
+
117
+
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.
118
+
119
+
Note: these are rough instructions only, and may need updating.
120
+
121
+
1. Install Python 3
122
+
2. Run `python -m pip install -r requirements.txt` (or `python3` instead of `python`), to install the python dependencies
123
+
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)
124
+
4. Download and extract UABE somewhere, then make sure `AssetBundleExtractor.exe` is on your path
125
+
5. Decide whether you want to get the pre-compiled executable, or compile the executable yourself (see below):
126
+
127
+
### Option 1: Getting the pre-compiled executable
128
+
129
+
1. Download the [pre-compiled `ui-compiler.exe`](https://github.com/07th-mod/ui-editing-scripts/releases/latest/download/ui-compiler.exe)
130
+
2. Make sure it is on your path, or in the root of the repository
131
+
132
+
### Option 2: Compiling the exe yourself
133
+
134
+
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).
135
+
2. In the root of the repository, run `cargo build` to check everything works correctly.
136
+
137
+
## Running ui-editor-scripts
138
+
139
+
- To compile a particular chapter/variant, open `build.py` and look at the valid chapters, for example:
140
+
-`onikakushi 5.2.2f1`
141
+
-`matsuribayashi 2017.2.5 unix 51100D6D`
142
+
- Run `cargo run` (compile yourself) or `ui-compiler` (pre-compiled) with the command you chose earlier. Following the previous example:
143
+
-`cargo run onikakushi 5.2.2f1`
144
+
-`cargo run matsuribayashi 2017.2.5 unix 51100D6D`
145
+
146
+
If you compiled the exe yourself, you can run the `./compileall.sh` under windows by using `git bash` which comes with Git for Windows.
0 commit comments