Written by @enumag.
Main process¶
This section covers the main process of creating a patch for each new chapter.
Step 1: Voices¶
- Run voice insertion script.
- Fix the rest manually (link).
- Release a voices-only patch.
Step 2: Graphics patch¶
It is recommended to have at least the automatic voice insertion completed first to avoid conflicts.
TODO: We need to make a new workflow for this based on our recent rework of the graphics patches.
Step 3: ADV-mode¶
Steps 1 and 2 are required for this. The game should still run with vanilla DLL after this step.
Run ADV-mode update script (link).
TODO: First release should probably happen either after this step or after DLL updates.
Step 4: DLL update¶
- DLL hacking (link). Note: This can be started right away when a new chapter comes out. No need to wait for the previous steps to be completed.
- Run update script. This requires all previous steps to be completed first.
Step 5: Installer update¶
This step mainly involves updating the installData.json
and versionData.json
.
NOTE: When the installer is run, it automatically does various checks to make sure you've correctly filled in the installedData.json
and versionData.json
, and also re-generates the cachedDownloadSizes.json
. For this reason, it is not recommended to edit the installData.json
without running the installer afterwards to check (with python main.py
).
- In the
versionData.json
, make copy the previous chapter's information below it - Look through all values the values and update the chapter number to match the new chapter
- Update the files to be downloaded for the patch
- Update identifiers field for MacOS - detailed explanation here.
- Download the MacOS game from MangaGamer (download link #2). You can do this on any OS.
- Extract the game somewhere, producing a
.app
folder - Open the file at
Contents\Info.plist
, anxml
file - Look for the
key
calledCFBundleExecutable
, then directly afterwards copy thestring
. For chapters 1-8 this was something likeHigurashiEp01
, but for Rei this was something likeHigurashi When They Cry Rei
- Currently, you need to append
_Data
to the end of the identifier, to produce something likeHigurashiEp01_Data
orHigurashi When They Cry Rei_Data
. However, this requirement may be removed in the future. - Update the
identifiers
ininstallData.json
with this new identifier.- This identifier is used by the installer to make sure the right game has been selected.
- Update the
versionData.json
file, one per every file which has aurl
. Forfiles
, use thename
, and forfileOverrides
use theid
- Run the installer to verify that everything was updated correctly.
- NOTE: This will also generate an updated
cachedDownloadSize.json
on the first run, which will take a long time (it will quickly get the download size of every file), please be patient.
- NOTE: This will also generate an updated
Other tasks¶
These tasks can generally be done at any time during the process.
MG patch¶
The first 2 steps need to be completed first, then this can be done at any time and doesn't block anything.
(link)
PS3 poems¶
TODO (Applies for question arcs only.)
Moving backgrounds¶
TODO
New UI¶
TODO
New scenes and translations improvements¶
TODO
Sui Soundtrack¶
TODO
Patch installers¶
TODO