higurashi-cs/ui-editing-scripts
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

Update docs to match new translation output behavior - See #12

Browse Source
This commit is contained in:
Daniel Wong
2023-03-18 12:24:09 +11:00
parent f6d4e2e0b3
commit e774623eb7
1 changed files with 6 additions and 8 deletions
Download Patch File Download Diff File Expand all files Collapse all files

14
README.md
View File

@@ -83,11 +83,11 @@ which should show an error message and list available chapters
Then run Then run
```python build.py onikakushi --translation``` ```python build.py onikakushi```
Then the output files will be located in the `output/translation` folder. You can then merge the `HigurashiEp0X_Data` folder with the one in your release. **Please include all the files (not just the `sharedassets0.assets` file), so the installer can select the correct file at install time.** Then the output files will be located in the `output/translation` folder. You can then merge the `HigurashiEp0X_Data` folder with the one in your release. **Please include all the files (not just the `sharedassets0.assets` file), so the installer can select the correct file at install time.**
If you want to rebuild all chapters, run `python build.py all --translation` to build all chapters. If you want to rebuild all chapters, run `python build.py all` to build all chapters.
### Common Problems ### Common Problems
@@ -99,15 +99,11 @@ You may encounter the following problems:
**NOTE: The script should automatically detect if the vanilla assets or UABE has changed, and re-download them. But if that doesn't work, use the '--force-download' option like so:** **NOTE: The script should automatically detect if the vanilla assets or UABE has changed, and re-download them. But if that doesn't work, use the '--force-download' option like so:**
```python build.py rei --translation --force-download``` ```python build.py rei --force-download```
## Instructions for Dev Team ## Instructions for Dev Team
For our dev team, the instructions are nearly the same, just remove the `--translation` argument. Instructions are the same as for translators, but archive files will be automatically created in the `output` folder
```python build.py onikakushi```
Archive files will be automatically created in the `output` folder
---- ----
@@ -133,6 +129,8 @@ 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. 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.
Note that doing this will build both the `translation.7z` file for translators to use, and also the individual archives for the 07th-mod developers to use.
### Building `ui-compiler.exe` using Github Actions ### 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. To build just the `ui-compiler.exe` using Github Actions (on Github's server), push any tag to the repository.