///////////////////////////////
//Shizuku Translation Project
//2024 - 2026
////////////////////////////////

Discord: https://discord.gg/G9nd22F

This is an English translation
patch for Shizuku for the PC-98.

PATCHING INSTRUCTIONS:

1) Copy your HDI to the patch folder and rename it "Shizuku.HDI".
Then, choose one of the following:
2_a) Click "patch regular" for the vanilla patch.
2_b) Click "patch real hard" for the real hardware compatible patch.
2_c) Click "patch non ero" for the patch with blacked out CGs.
Your patched HDI will be output as "Shizuku_eng.HDI".

-If the vanilla patch doesn't boot after patching try again with
"patch real hard" version. If it still doesn't work report it in
the discord server.

RECOMMENDED HDIs:
-Neo Kobe's collection dump (use "real_hard" patch option)
-Dated: 24/12/1996
-Hashes:
CRC32: 9ca547f4
MD5: dd98868b600a316cadb703d78a9c6ff8
SHA-1: 47b5997559ae19023dfceaf569a089f9c3b6f9b8

-10/07/2001's dump
-Dated: 10/07/2001
-Hashes
CRC32: f2282037
MD5: 1565983b594bc20d00d5c51aa86cbee8
SHA-1: 58c518ae6c1b13ead0409217551c61a00fb1017d

NOT RECOMMENDED HDIs:
-Denpa's archive rom (doesn't boot on the fly /
bad directory)
-Dated: 23/08/2001
-Hashes:
CRC32: 7cb2e2eb
MD5: b3940802c07015bee2c3d0fd9d8bdf4c
SHA-1: 17cd1787d8f2a7b00be825b89f243815ebf8398c

Check the hashes here (drag and drop the HDI):
https://www.marcrobledo.com/RomPatcher.js/

KEEP SAVE WHILE UPDATING:
-If you're updating from an older version and would like to keep
your save file do this:
1) Open editdisk (included in the patch)
2) Open your HDI file with Anex86 mode (default).
3) Open SIZUKU folder, drag and drop MAX_00.SAV to a folder
to extract it.
3_a) If you saved to slot 2 in the game the file you need
to extract MAX_01.SAV, if you saved to slot 3 MAX_02.SAV.
You'll be able to tell by looking at the "modified date"
column on the right.
4) Patch a new clean HDI following PATCHING INSTRUCTIONS.
5) Open the patched HDI, open SIZUKU folder, drag and drop
the extracted MAX_00.SAV to the game folder. Click yes if asked.

-If you're using Steam Deck use HDIutil instead:
https://codeberg.org/yanchan09/hdiutil

ALTERNATIVE VERSIONS:
-Non-ero patch: in this version of the patch
every HCG is blacked out.

-Real hardware compatibility patch: this
allows the patch to run in a 9821 machine.

COMPILING FROM SOURCE:
-Download the "Phyton script" plugin
for Notepad++.
-Copy "CompileScript.py" to
"Notepad++\plugins\PythonScript\scripts".
-Replace every %PATH% variable in the source
code with your own paths.
-In Notepad++ go to:
Plugins > Python Script > Scripts
and then click "compile script".

KNOWN ISSUES:
-Emulators meant for PC9821 such as
Neko Project 21 and variants will not
display the warp effect properly.
This does not happen in emulators
meant for PC9801 such as Neko Project II.
A real hardware PC9821 will not feature
this bug either.

-The vanilla patch features a hack that aligns
the music selection menu depending if it's inside
the main menu or in-game menu. However for unknown
reasons sometimes it might appear lower instead of
centered and vice versa (might fix later).

-Going into an option, going back to the
menu using ESC and then hovering to any
other option will erase a small part of
the first letter of the option beneath
the previously selected option.

-Some Neko Project versions disable MIDI
output by default, so the game will be
silent when selecting "MIDI" as sound
output inside the game. To fix this, go to:
Device > MIDI option
Then tick "enable" and set MIDI_OUT to:
Microsoft Wavetable Synth.

-The text previous to the choice in
Ruriko's route where she asks if
Yuusuke received her message displays
twice briefly.
-The warped text after Oribass' fight
displays twice as well.
It is unknown what causes these.

RECOMMENDED PLATFORMS:
-Neko Project II/W v0.86 rev 99 << Most recommended
Download here:
https://simk98.github.io/np21w/download.html
(it's the very very first download link)

-Neko Project Debug 2015
https://github.com/nmlgc/np2debug

-Real hardware

RECOMMENDED SETTINGS:
Set your 16:9 monitor to 1280x800
resolution and then, in Neko Project,
go to:
Screen > Screen option > Fullscreen
and set "zoom > integer multiple" for
perfect scaling.

Tested platforms:
Neko Project Debug 2015		
Neko Project II/W v0.86 rev 91
Neko Project 21/W v0.86 rev 91
Neko Project II/W v0.86 rev 99
Neko Project 21/W v0.86 rev 99
Neko Project II v.086 2016
Neko Project Kai rev.22
Real hardware PC-9821

Tools used to make this patch:
Atlas
CrystalTile2
Disk Explorer
Eclipse C IDE
HxD hex editor
NDC
Notepad++
Paint.net

Credits:
TeamSM, J, Aebe09	Text insertion tools
Rei					Script editor
FCC					Script editor, automation help
_GR1NDSLVT_			Tester
Albertix			Tester
Clownery_morton		Tester
Eughlius			Tester
HiroX				Tester
Kursea				Tester
Luci Necos			Tester
M_					Tester
Mark				Tester
Mellon Collie		Tester
Morning				Tester
Nixy2315			Tester
Runescape gold farm	Tester
John Burst Error	Real hardware tester
Mizuwari			Real hardware test help
Saki				Coding / misc tools / translation