From 7fa4a5979662823310454371975ed6f8b7840f4c Mon Sep 17 00:00:00 2001 From: nmlgc Date: Wed, 18 Jan 2023 11:19:17 +0100 Subject: [PATCH] [Readme] Recommend the new `debloated` branch for nontrivial work Part of P0229, funded by Ember2528. --- Makefile.mak | 30 ++++++++++++++++++++++++++++-- README.md | 10 ++++++++-- Tupfile | 31 +++++++++++++++++++++++++++++++ 3 files changed, 67 insertions(+), 4 deletions(-) diff --git a/Makefile.mak b/Makefile.mak index 29ce9b7e..7962aa33 100644 --- a/Makefile.mak +++ b/Makefile.mak @@ -1,6 +1,32 @@ -# ReC98 -# ----- # Makefile for the 16-bit part of the build process +# ------------------------------------------------- + + + + + + + + +# ⚠️ CAUTION! ⚠️ + +# You are on the `master` branch, which builds PC-98 DOS binaries that are +# identical to ZUN's originally released binaries. If you want to port the game +# to other architectures or develop a mod that doesn't need to be byte-for-byte +# comparable to the original binary, start from the cleaned-up `debloated` +# branch instead. That branch is easier to read and modify, and builds smaller +# and faster PC-98 binaries while leaving all bugs and quirks from ZUN's +# original code in place. +# Seriously, you'd just be torturing yourself if you do anything nontrivial +# based on this branch. + +# ⚠️ CAUTION! ⚠️ + + + + + + CFLAGS = -ls -I. -Lbin\ -O -b- AFLAGS = /m /ml diff --git a/README.md b/README.md index faf788b9..0d3b708f 100644 --- a/README.md +++ b/README.md @@ -70,7 +70,9 @@ Crossed-out files are identical to their version in the previous game. ONGCHK.CO ## Branches -* **[`master`]: ZUN's original code, without mods or bugfixes** +* ▶ **`master`: ZUN's original code, without mods or bugfixes** (You are here!) +* [`debloated`]: Rearchitected version of ZUN's code that is easier to read and modify, and builds smaller and faster PC-98 binaries. Only removes [bloat]; all [bugs] and [quirks] from ZUN's original code are left in place. **Ports should start from that branch**, and it's also the recommended base for mods that don't care about similarity to the original binary. +* [`anniversary`]: Takes `debloated` and additionally fixes [bugs], achieving a smoother and flicker-free gameplay experience on the PC-98 platform while still leaving [quirks] in place. Might be an even better starting port for mods and ports. * [`BossRush`] * [`th03_no_gdc_frequency_check`]: Allows TH03 to be run with the GDC clock set to 5 MHz. The original game enforces 2.5 MHz, but doesn't functionally require it, even on real hardware. * [`xJeePx`]: Code changes for xJeePx's 2014 English translation patch. @@ -226,6 +228,9 @@ See [`CONTRIBUTING.md`](CONTRIBUTING.md). [project blog]: https://rec98.nmlgc.net/blog [converter for hardcoded sprites]: https://github.com/nmlgc/ReC98/issues/8 [Borland/Embarcadero's own C++ 7.30]: https://www.embarcadero.com/de/free-tools/ccompiler/free-download +[bloat]: https://rec98.nmlgc.net/blog/2022-08-15#zun-bloat +[bugs]: https://rec98.nmlgc.net/blog/2022-08-15#zun-bug +[quirks]: https://rec98.nmlgc.net/blog/2022-08-15#zun-quirk [TH04 Stage 5 Yuuka No-EMS crash]: https://rec98.nmlgc.net/blog/2021-11-29 [TH01 Sariel fight]: https://rec98.nmlgc.net/blog/2022-01-31 @@ -234,7 +239,8 @@ See [`CONTRIBUTING.md`](CONTRIBUTING.md). [TH04 Stage 4 Marisa Divide Error crash]: https://rec98.nmlgc.net/blog/2022-04-18 [two critical bugs in TH01]: https://rec98.nmlgc.net/blog/2022-05-31 -[`master`]: https://github.com/nmlgc/ReC98/tree/master +[`anniversary`]: https://github.com/nmlgc/ReC98/tree/anniversary +[`debloated`]: https://github.com/nmlgc/ReC98/tree/debloated [`BossRush`]: https://github.com/nmlgc/ReC98/tree/BossRush [`community_choice_fixes`]: https://github.com/nmlgc/ReC98/tree/community_choice_fixes [`mem_assign_all`]: https://github.com/nmlgc/ReC98/tree/mem_assign_all diff --git a/Tupfile b/Tupfile index da2fd16f..3a3e8826 100644 --- a/Tupfile +++ b/Tupfile @@ -1,3 +1,34 @@ +# Tupfile for the 32-part of the build process +# -------------------------------------------- + + + + + + + + +# ⚠️ CAUTION! ⚠️ + +# You are on the `master` branch, which builds PC-98 DOS binaries that are +# identical to ZUN's originally released binaries. If you want to port the game +# to other architectures or develop a mod that doesn't need to be byte-for-byte +# comparable to the original binary, start from the cleaned-up `debloated` +# branch instead. That branch is easier to read and modify, and builds smaller +# and slightly faster PC-98 binaries while leaving all bugs and quirks from +# ZUN's original code in place. +# Seriously, you'd just be torturing yourself if you do anything nontrivial +# based on this branch. + +# ⚠️ CAUTION! ⚠️ + + + + + + + + AS = tasm32 /m /mx /kh32768 /t CXX32 = bcc32