Rooba
/
ReC98
mirror of https://github.com/nmlgc/ReC98.git
1
1
Fork 0
Code Issues Packages Projects Releases Wiki Activity

[Readme] Describe this branch and its purpose 

Part of P0229, funded by Ember2528.
This commit is contained in:
nmlgc 2023-01-18 11:22:29 +01:00
parent 6370f96d9a
commit 4d6a5df0b9
3 changed files with 14 additions and 20 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

15
Makefile.mak
View File

@ -10,15 +10,12 @@
# ⚠️ 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.
# You are on the `debloated` branch, which contains a simplified and optimized
# version of ZUN's original code. This branch is the ideal starting point for
# ports and nontrivial mods that don't care about similarity to the original
# binary, as the binaries built from this branch are *different* from ZUN's
# original ones and cannot be easily compared to them. If you do care about
# comparability, check out `master` instead.
# ⚠️ CAUTION! ⚠️

4
README.md
View File

@ -70,8 +70,8 @@ Crossed-out files are identical to their version in the previous game. ONGCHK.CO
## Branches
* ▶ **`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] and [landmines]; 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.
* [`master`]: ZUN's original code, without mods or bugfixes
* ▶ **`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] and [landmines]; all [bugs] and [quirks] from ZUN's original code are left in place. Ports should start from this branch, and it's also the recommended base for mods that don't care about similarity to the original binary.** (You are here!)
* [`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.

15
Tupfile
View File

@ -10,15 +10,12 @@
# ⚠️ 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.
# You are on the `debloated` branch, which contains a simplified and optimized
# version of ZUN's original code. This branch is the ideal starting point for
# ports and nontrivial mods that don't care about similarity to the original
# binary, as the binaries built from this branch are *different* from ZUN's
# original ones and cannot be easily compared to them. If you do care about
# comparability, check out `master` instead.
# ⚠️ CAUTION! ⚠️