Skip to content

Commit a0e717d

Browse files
committed
Update Readme.md
1 parent 46e911e commit a0e717d

File tree

1 file changed

+66
-7
lines changed

1 file changed

+66
-7
lines changed

README.md

Lines changed: 66 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -14,7 +14,15 @@ Please note that documentation is in two places:
1414

1515
----
1616

17-
## Usage instructions for translators and dev team
17+
## Instructions for Translators
18+
19+
Overall, the workflow for translators is:
20+
21+
1. Setup your computer to run our tool, including cloning or forking this repo
22+
2. Modify/replace the files in the repo with your translated versions
23+
3. Run our tool to generate the `.assets` and `.languageSpecificAssets` files you can include in your release
24+
25+
Please continue with detailed instructions below.
1826

1927
### Setup (Windows Only)
2028

@@ -28,28 +36,79 @@ The below instructions only work on Windows!
2836
- A fork is recommended for translators as you can check in your changes to github. It also allows you to use Github for building and hosting assets
2937
3. Clone the repository (either this repository, or the one you forked) to your computer
3038

31-
### Using the tool to generate sharedassets0.assets (Windows Only)
39+
### Modifying images, text, and fonts
40+
41+
#### To modify images
42+
43+
To modify images, replace the image files in the `assets/images` folder.
44+
45+
Folder info:
46+
47+
- `images/shared`: images common to all chapters
48+
- `images/question_arcs`: images specific to chapters 1-4
49+
- `images/answer_arcs`: images specific to chapters 5-8
50+
- `images/specific/[CHAPTER_NAME]`: images specific to a particular chapter
51+
- `images/version-specific/[CHAPTER_NAME]`: images specific to a particular chapter + unity version combo
52+
53+
Make sure have a quick look at all the folders before starting work, so you don't miss any images by accident.
54+
55+
#### To modify text
56+
57+
The game contains various text which is not contained in the game script or the DLL (it is stored directly in the .assets file). This text is also not stored as image files, so you can't edit an image to change it.
58+
59+
To edit these text files, edit the `assets/text-edits.json` file. **Please read <https://07th-mod.com/wiki/developer/sharedassets/ui-editing-scripts/#unitytextmodifier> for more details on how to edit this file.**
60+
61+
#### To modify fonts
62+
63+
To modify fonts, see
64+
- For Chapters 1-8: <https://07th-mod.com/wiki/developer/sharedassets/ui-editing-scripts/#adding-font-support-for-a-new-language-chapters-1-8-only>
65+
- Note: Due to some Unity plugins being no longer supported, you may have trouble following these instructions. Please let us know if you have problems and we'll try to sort it out.
66+
- For Chapter 9 <https://07th-mod.com/wiki/developer/sharedassets/ui-editing-scripts/#adding-font-support-for-a-new-language-higurashi-rei-onwards-only>
67+
68+
Fonts are stored in the `assets/fonts` folder as `*.dat` files, with the exception of Rei where fonts are stored in the `assets/files-2019.4` folder.
69+
70+
#### To modify other files
71+
72+
The `assets/files-[UNITY_VERSION]` folders contain files applied to a particular Unity version, regardless of chapter. You normally don't need to modify these files.
73+
74+
Currently these folders contain higher quality caret sprites (the little cursor/triangle displayed at the end of a text line), with the exception of the `assets/files-2019.4` folder which also contains fonts for Higurashi Rei.
75+
76+
### Generating .assets and .languageSpecificAssets files (Windows Only)
3277

3378
To list the supported Higurashi chapters for this tool, run
3479

3580
```python build.py```
3681

37-
which should show an error message complaining about a missing `chapter` argument
82+
which should show an error message and list available chapters
3883

3984
Then run
4085

41-
```python build.py onikakushi```
86+
```python build.py onikakushi --translation```
4287

43-
for example, to build the sharedassets required for onikakushi. You can also run `python build.py all` to build all chapters.
88+
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.**
4489

45-
**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:**
90+
If you want to rebuild all chapters, run `python build.py all --translation` to build all chapters.
4691

47-
```python build.py rei --force-download```
92+
### Common Problems
4893

4994
You may encounter the following problems:
5095
- 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.
5196
- For any other error, likely we just need to update the build script, so please contact us.
5297

98+
### Updating dependencies
99+
100+
**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:**
101+
102+
```python build.py rei --translation --force-download```
103+
104+
## Instructions for Dev Team
105+
106+
For our dev team, the instructions are nearly the same, just remove the `--translation` argument.
107+
108+
```python build.py onikakushi```
109+
110+
Archive files will be automatically created in the `output` folder
111+
53112
----
54113

55114
## Modifying Assets

0 commit comments

Comments
 (0)