mirror of
https://github.com/bryanthaboi/gen1recomp.git
synced 2026-08-25 06:55:29 +02:00
bryanthaboi
ca4d3d283c
Crystal boots from a user-supplied ROM, imports a full cache and is playable: copyright, the Crystal intro movie, the animated title, gender select, Oak, and out into Johto. 122 of the cart's 169 script specials are implemented. Import and data - tools/make_crystal_manifest.py derives the manifest by importing make_gold_manifest as a library, with three additive keyword seams. Gold and Silver still regenerate byte-identical, which is the standing requirement for touching that generator. - crystal_symbol_deltas.py and crystal_movie_symbols.py carry the symbol delta: Crystal renames the credits mons, splits the trainer card, Pokegear and pack-pal blocks by gender, and replaces the intro and title outright. - Crystal-only manifest keys: engineFlagOrder (162 flags to Gold's 93, so the badge block sits one higher) and unownCharmap (the main charmap parser stops at the first newcharmap so the two cannot contaminate each other). Extractor - RomExtractorGen2 becomes three-edition. Crystal corrections: PAL_MAP_BANK 0x13, a flat PICS_FIX pic bank, audio bank 0x5e, the mapSongs id-100 hole, seven NPC trades, a TradeTexts stride of 8, the five Crystal tileset anim steps with per-row degrade, and the column-major trainer card portraits. - New: animated front sprites (frames, bitmasks, play and idle scripts), the Battle Tower roster, Kris assets, Mobile System GB art, and the Crystal intro and title via src/import/CrystalMovie.lua. Engine - GameVersion gains engine(id) and fixes(id). Gold and Silver keep their original bugs where the bug is not hardware dependent; Crystal gets the fixes Crystal shipped: Lucky Number boxes 10-14, surfing onto an NPC, and the Reflect and Light Screen defence overflow. - Crystal story: Suicune and Eusine, Celebi behind the GS Ball flag, the Ruins of Alph chambers, Buena, the Move Tutor, the Poke Seer, and the Battle Tower including the wInBattleTowerBattle badge-boost guard. - Kris and the gender flag, animated fronts in battle and the summary screen, and mon caught data. Verification - Every extracted asset is pixel-compared against pret's own source PNGs. - Gold caches are byte-identical before and after, file for file. - New Crystal suites plus a T2 Gen 2 tier; the full suite passes.
168 lines
7.2 KiB
Bash
Executable File
168 lines
7.2 KiB
Bash
Executable File
#!/usr/bin/env bash
|
|
# Pack a Switch SD-ready zip: extract at microSD root (merge-safe update).
|
|
#
|
|
# Usage:
|
|
# scripts/switch/pack_sd_zip.sh GAME_NRO VERSION OUT_ZIP [LAUNCHER_NRO]
|
|
#
|
|
# Layout inside the zip (SD root):
|
|
# switch/gen1recomp/gen1recomp.nro (launcher if LAUNCHER_NRO set, else game)
|
|
# switch/gen1recomp/gen1recomp-game.nro (only when LAUNCHER_NRO set)
|
|
# switch/gen1recomp/version.txt
|
|
# switch/gen1recomp/INSTALL.txt
|
|
# switch/gen1recomp/pokemon-love2d/imports/.../README.txt
|
|
# switch/gen1recomp/pokemon-love2d/exports/.../README.txt
|
|
#
|
|
# Does not ship ROMs, saves, or mods. Re-extracting merges over an existing
|
|
# install and only overwrites the NRO(s) + these text placeholders — keep
|
|
# pokemon-love2d/ to preserve progress.
|
|
|
|
set -euo pipefail
|
|
|
|
SCRIPT_DIR="$(cd "$(dirname "$0")" && pwd)"
|
|
# shellcheck source=common.sh
|
|
. "$SCRIPT_DIR/common.sh"
|
|
|
|
NRO_PATH="${1:-}"
|
|
VERSION="${2:-}"
|
|
OUT_ZIP="${3:-}"
|
|
LAUNCHER_NRO="${4:-}"
|
|
|
|
[ -n "$NRO_PATH" ] && [ -n "$VERSION" ] && [ -n "$OUT_ZIP" ] \
|
|
|| fail "usage: scripts/switch/pack_sd_zip.sh GAME_NRO VERSION OUT_ZIP [LAUNCHER_NRO]"
|
|
|
|
[ -f "$NRO_PATH" ] || fail "missing game NRO at $NRO_PATH"
|
|
if [ -n "$LAUNCHER_NRO" ]; then
|
|
[ -f "$LAUNCHER_NRO" ] || fail "missing launcher NRO at $LAUNCHER_NRO"
|
|
fi
|
|
|
|
command -v zip >/dev/null 2>&1 || fail "need zip on PATH"
|
|
|
|
# Absolutize before any cd — relative OUT_ZIP would otherwise land inside the
|
|
# staging dir and vanish when the EXIT trap cleans up.
|
|
NRO_PATH="$(cd "$(dirname "$NRO_PATH")" && pwd)/$(basename "$NRO_PATH")"
|
|
OUT_DIR="$(dirname "$OUT_ZIP")"
|
|
mkdir -p "$OUT_DIR"
|
|
OUT_ZIP="$(cd "$OUT_DIR" && pwd)/$(basename "$OUT_ZIP")"
|
|
|
|
STAGE="$(mktemp -d "${TMPDIR:-/tmp}/gen1recomp-sd-zip.XXXXXX")"
|
|
cleanup() { rm -rf "$STAGE"; }
|
|
trap cleanup EXIT
|
|
|
|
APP_DIR="$STAGE/switch/gen1recomp"
|
|
SAVE_ROOT="$APP_DIR/pokemon-love2d"
|
|
mkdir -p "$APP_DIR"
|
|
|
|
if [ -n "$LAUNCHER_NRO" ]; then
|
|
LAUNCHER_NRO="$(cd "$(dirname "$LAUNCHER_NRO")" && pwd)/$(basename "$LAUNCHER_NRO")"
|
|
cp "$LAUNCHER_NRO" "$APP_DIR/gen1recomp.nro"
|
|
cp "$NRO_PATH" "$APP_DIR/gen1recomp-game.nro"
|
|
else
|
|
cp "$NRO_PATH" "$APP_DIR/gen1recomp.nro"
|
|
fi
|
|
printf '%s\n' "$VERSION" > "$APP_DIR/version.txt"
|
|
|
|
cat > "$APP_DIR/INSTALL.txt" <<EOF
|
|
gen1recomp Switch (v${VERSION})
|
|
===============================
|
|
|
|
First install or update (same steps):
|
|
1. Extract this zip at the root of your microSD (merge folders if asked).
|
|
2. Do NOT delete switch/gen1recomp/pokemon-love2d/ — that folder holds
|
|
your saves, imported ROMs, mods, and options. Re-extracting only
|
|
replaces the NRO(s) and these help files.
|
|
3. Launch with title override (hold R on HOME, open any title → hbmenu).
|
|
4. Copy a legal Pokemon Red/Blue .gb or Yellow/Gold/Silver/Crystal .gbc into:
|
|
switch/gen1recomp/pokemon-love2d/imports/
|
|
then use Scan again in the launcher if needed.
|
|
|
|
Inboxes (drop files here via MTP / SD / FTP):
|
|
imports/ — ROM .gb / .gbc
|
|
imports/mods/ — community mod .zip
|
|
imports/saves/red|blue|yellow|gold|silver|crystal/ - raw .sav import (Gen 2 cart .sav not yet)
|
|
exports/red|blue|yellow|gold|silver|crystal/ - pull after Export save (Gen 2 not yet)
|
|
|
|
Full guide: https://github.com/bryanthaboi/gen1recomp/blob/main/docs/switch-install.md
|
|
EOF
|
|
|
|
write_readme() {
|
|
local path="$1"
|
|
local body="$2"
|
|
mkdir -p "$(dirname "$path")"
|
|
printf '%s\n' "$body" > "$path"
|
|
}
|
|
|
|
write_readme "$SAVE_ROOT/imports/README.txt" \
|
|
"Put a legal Pokemon Red/Blue .gb or Yellow/Gold/Silver/Crystal .gbc here, then Scan again in the launcher."
|
|
write_readme "$SAVE_ROOT/imports/mods/README.txt" \
|
|
"Put community mod .zip files here, then MODS → Scan again."
|
|
write_readme "$SAVE_ROOT/imports/saves/red/README.txt" \
|
|
"Put a Red .sav (32 KB) here, then Red tab → SAVE FILES → Import save."
|
|
write_readme "$SAVE_ROOT/imports/saves/blue/README.txt" \
|
|
"Put a Blue .sav (32 KB) here, then Blue tab → SAVE FILES → Import save."
|
|
write_readme "$SAVE_ROOT/imports/saves/yellow/README.txt" \
|
|
"Put a Yellow .sav (32 KB) here, then Yellow tab → SAVE FILES → Import save."
|
|
write_readme "$SAVE_ROOT/imports/saves/gold/README.txt" \
|
|
"Gold cart .sav import is not supported yet. Folder reserved so MTP matches the other games."
|
|
write_readme "$SAVE_ROOT/imports/saves/silver/README.txt" \
|
|
"Silver cart .sav import is not supported yet. Folder reserved so MTP matches the other games."
|
|
write_readme "$SAVE_ROOT/imports/saves/crystal/README.txt" \
|
|
"Crystal cart .sav import is not supported yet. Folder reserved so MTP matches the other games."
|
|
write_readme "$SAVE_ROOT/exports/red/README.txt" \
|
|
"After Export save (Red), copy the .sav out of this folder via MTP / SD / FTP."
|
|
write_readme "$SAVE_ROOT/exports/blue/README.txt" \
|
|
"After Export save (Blue), copy the .sav out of this folder via MTP / SD / FTP."
|
|
write_readme "$SAVE_ROOT/exports/yellow/README.txt" \
|
|
"After Export save (Yellow), copy the .sav out of this folder via MTP / SD / FTP."
|
|
write_readme "$SAVE_ROOT/exports/gold/README.txt" \
|
|
"Gold cart .sav export is not supported yet. Folder reserved so MTP matches the other games."
|
|
write_readme "$SAVE_ROOT/exports/silver/README.txt" \
|
|
"Silver cart .sav export is not supported yet. Folder reserved so MTP matches the other games."
|
|
write_readme "$SAVE_ROOT/exports/crystal/README.txt" \
|
|
"Crystal cart .sav export is not supported yet. Folder reserved so MTP matches the other games."
|
|
|
|
rm -f "$OUT_ZIP"
|
|
(
|
|
cd "$STAGE"
|
|
zip -q -r "$OUT_ZIP" switch
|
|
)
|
|
|
|
[ -f "$OUT_ZIP" ] || fail "zip was not created at $OUT_ZIP"
|
|
[ -s "$OUT_ZIP" ] || fail "zip is empty: $OUT_ZIP"
|
|
|
|
LISTING="$(unzip -Z1 "$OUT_ZIP" 2>/dev/null || unzip -l "$OUT_ZIP")"
|
|
printf '%s\n' "$LISTING" | grep -q 'switch/gen1recomp/gen1recomp.nro' \
|
|
|| fail "zip missing switch/gen1recomp/gen1recomp.nro"
|
|
printf '%s\n' "$LISTING" | grep -Fq 'switch/gen1recomp/version.txt' \
|
|
|| fail "zip missing switch/gen1recomp/version.txt"
|
|
if [ -n "$LAUNCHER_NRO" ]; then
|
|
printf '%s\n' "$LISTING" | grep -Fq 'switch/gen1recomp/gen1recomp-game.nro' \
|
|
|| fail "zip missing switch/gen1recomp/gen1recomp-game.nro (OTA dual-NRO layout)"
|
|
fi
|
|
|
|
REQUIRED=(
|
|
"switch/gen1recomp/INSTALL.txt"
|
|
"switch/gen1recomp/version.txt"
|
|
"switch/gen1recomp/pokemon-love2d/imports/README.txt"
|
|
"switch/gen1recomp/pokemon-love2d/imports/mods/README.txt"
|
|
"switch/gen1recomp/pokemon-love2d/imports/saves/red/README.txt"
|
|
"switch/gen1recomp/pokemon-love2d/imports/saves/blue/README.txt"
|
|
"switch/gen1recomp/pokemon-love2d/imports/saves/yellow/README.txt"
|
|
"switch/gen1recomp/pokemon-love2d/imports/saves/gold/README.txt"
|
|
"switch/gen1recomp/pokemon-love2d/imports/saves/silver/README.txt"
|
|
"switch/gen1recomp/pokemon-love2d/imports/saves/crystal/README.txt"
|
|
"switch/gen1recomp/pokemon-love2d/exports/red/README.txt"
|
|
"switch/gen1recomp/pokemon-love2d/exports/blue/README.txt"
|
|
"switch/gen1recomp/pokemon-love2d/exports/yellow/README.txt"
|
|
"switch/gen1recomp/pokemon-love2d/exports/gold/README.txt"
|
|
"switch/gen1recomp/pokemon-love2d/exports/silver/README.txt"
|
|
"switch/gen1recomp/pokemon-love2d/exports/crystal/README.txt"
|
|
)
|
|
for rel in "${REQUIRED[@]}"; do
|
|
printf '%s\n' "$LISTING" | grep -Fq "$rel" || fail "zip missing $rel"
|
|
done
|
|
|
|
ZIP_SHA="$(sha256_file "$OUT_ZIP")"
|
|
printf '%s %s\n' "$ZIP_SHA" "$OUT_ZIP" > "${OUT_ZIP}.sha256"
|
|
say "SD-ready zip: $OUT_ZIP"
|
|
printf '%s %s\n' "$ZIP_SHA" "$OUT_ZIP"
|