mirror of
https://github.com/jkdansereau/goldeneye-pc-port.git
synced 2026-10-23 15:52:42 +02:00
James Dansereau
dfab1876e4
The Windows bundle from bundle-win.sh / CI was unrunnable on its own (D179):
the port loads two ROM-derived directories (data/pcmodels-<region>/ and
data/pccg-<region>/) that are gitignored and cannot be shipped.
Add tools_pc/dist/prepare-assets/prepare-assets.py — a stdlib-only wrapper
(no compiler, no N64 toolchain, no network) that:
- auto-detects the ROM near the bundle, verifies SHA-1 -> region
(NTSC-U / PAL / NTSC-J), rejects unrecognised / byte-swapped dumps
- runs d43_emit.py + d69_emit.py against a vendored input tree
- writes data/pcmodels-<region>/ and data/pccg-<region>/ next to the exe
bundle-win.sh assembles prepare-assets/ fresh at package time (emit scripts
from tools_pc/, filelist.u.csv + file_resource_table.inc.c + the 512
modelFileHeader.inc.c files as vendored inputs) so it can never drift from
the scripts. Vendored inputs are decomp layout/symbol metadata, not game
assets. bundled README gets a one-time "prepare-assets" setup step.
Verified end-to-end: from a bundle containing only exe + DLLs + a US ROM,
prepare-assets.py produces all four output files byte-identical to
d43_emit.py / d69_emit.py run from the repo root. Bundle 14.1 MB (< 60 MB
guard). Error paths (no ROM / unknown SHA-1) tested.
Resolves BACKLOG "Alpha release — asset-prep tool" steps 1-3; step 4
(clean-machine smoke test with the game actually running) still owed.
121 lines
4.9 KiB
Bash
Executable File
121 lines
4.9 KiB
Bash
Executable File
#!/usr/bin/env bash
|
|
#
|
|
# Package a Windows GoldenEye 007 PC port build for distribution.
|
|
#
|
|
# Run from anywhere, inside the MSYS2 MINGW64 shell, AFTER ./build-pc.sh:
|
|
#
|
|
# tools_pc/bundle-win.sh [VERSION]
|
|
#
|
|
# Produces, under dist/ :
|
|
# goldeneye-pc-port-<VERSION>-win64/ the unpacked bundle
|
|
# goldeneye-pc-port-<VERSION>-win64.zip + .zip.sha256
|
|
#
|
|
# The bundle contains ONLY: the engine executable, its MinGW / SDL2 / zlib
|
|
# runtime DLLs, a README, and license texts. It contains NO ROM and NO game
|
|
# assets (textures, audio, models, levels, text) — the user supplies those at
|
|
# runtime from a ROM they own. The script hard-fails if a ROM image or an
|
|
# oversized blob ends up inside the bundle.
|
|
#
|
|
set -euo pipefail
|
|
|
|
REPO_ROOT="$(cd "$(dirname "${BASH_SOURCE[0]}")/.." && pwd)"
|
|
cd "$REPO_ROOT"
|
|
|
|
VERSION="${1:-$(git describe --tags --always --dirty 2>/dev/null || echo 0.0.0-dev)}"
|
|
VERSION="${VERSION#v}" # strip a leading "v"
|
|
NAME="goldeneye-pc-port-${VERSION}-win64"
|
|
OUT="dist/${NAME}"
|
|
MINGW="${MINGW_PREFIX:-/mingw64}"
|
|
|
|
EXE="$(ls build-pc/ge007*.exe 2>/dev/null | head -n1 || true)"
|
|
[ -n "$EXE" ] || { echo "error: no build-pc/ge007*.exe found — run ./build-pc.sh first" >&2; exit 1; }
|
|
|
|
echo "==> Bundling $EXE -> $NAME"
|
|
rm -rf "$OUT"
|
|
mkdir -p "$OUT/licenses"
|
|
cp "$EXE" "$OUT/"
|
|
|
|
# --- runtime DLLs ---------------------------------------------------------
|
|
# Explicit allowlist; the closure check below fails the build if the exe needs
|
|
# a MinGW DLL that is not on this list.
|
|
DLLS=(
|
|
SDL2.dll
|
|
zlib1.dll
|
|
libwinpthread-1.dll
|
|
libstdc++-6.dll
|
|
libgcc_s_seh-1.dll
|
|
libssp-0.dll
|
|
)
|
|
for d in "${DLLS[@]}"; do
|
|
if [ -f "$MINGW/bin/$d" ]; then
|
|
cp "$MINGW/bin/$d" "$OUT/"
|
|
echo " + $d"
|
|
else
|
|
echo " . $d (not in $MINGW/bin — skipped)"
|
|
fi
|
|
done
|
|
|
|
# --- verify the dependency closure --------------------------------------
|
|
missing=0
|
|
if command -v ldd >/dev/null 2>&1; then
|
|
while read -r name _ path _; do
|
|
case "$path" in
|
|
"$MINGW"/*|*/mingw64/*)
|
|
[ -f "$OUT/$name" ] || { echo " MISSING: $name ($path)" >&2; missing=1; } ;;
|
|
esac
|
|
done < <(ldd "$EXE")
|
|
else
|
|
echo " (ldd unavailable — skipping closure check)"
|
|
fi
|
|
[ "$missing" -eq 0 ] || { echo "error: exe needs MinGW DLLs that were not bundled (see above)" >&2; exit 1; }
|
|
|
|
# --- docs + licenses ---------------------------------------------------
|
|
sed "s/@VERSION@/${VERSION}/g" tools_pc/dist/README.md.in > "$OUT/README.md"
|
|
cp NOTICE "$OUT/licenses/NOTICE"
|
|
cp LICENSE "$OUT/licenses/LICENSE-port-MIT.txt"
|
|
[ -f port/fast3d/LICENSE.txt ] && cp port/fast3d/LICENSE.txt "$OUT/licenses/LICENSE-fast3d.txt"
|
|
for l in SDL2 zlib gcc-libs libwinpthread mingw-w64; do
|
|
[ -d "$MINGW/share/licenses/$l" ] && cp -r "$MINGW/share/licenses/$l" "$OUT/licenses/$l"
|
|
done
|
|
|
|
# --- asset-prep tool -------------------------------------------------
|
|
# The port needs two ROM-derived directories (data/pcmodels-<region>/ and
|
|
# data/pccg-<region>/) that we cannot ship. prepare-assets.py regenerates
|
|
# them from the user's own ROM using only the Python standard library. It is
|
|
# assembled fresh from the tree here so it can never drift from the emit
|
|
# scripts. The vendored inputs are decomp layout/symbol metadata (.inc.c /
|
|
# .csv), NOT game assets (no textures, audio, models, levels, or text).
|
|
PREP="$OUT/prepare-assets"
|
|
mkdir -p "$PREP/vendor/scripts" "$PREP/vendor/assets/obseg"
|
|
cp tools_pc/dist/prepare-assets/prepare-assets.py "$PREP/"
|
|
cp tools_pc/d43_emit.py tools_pc/d69_emit.py "$PREP/"
|
|
cp scripts/filelist.u.csv "$PREP/vendor/scripts/"
|
|
cp assets/obseg/file_resource_table.inc.c "$PREP/vendor/assets/obseg/"
|
|
# d43_emit.py os.walk()s assets/ for every *modelFileHeader.inc.c — preserve paths.
|
|
( cd . && find assets -iname 'modelfileheader.inc.c' -print0 \
|
|
| xargs -0 -I{} cp --parents {} "$PREP/vendor/" )
|
|
nmh="$(find "$PREP/vendor/assets" -iname 'modelfileheader.inc.c' | wc -l)"
|
|
echo " + prepare-assets/ (emit scripts + $nmh model headers)"
|
|
[ "$nmh" -gt 400 ] || { echo "error: prepare-assets vendored only $nmh model headers — expected ~512" >&2; exit 1; }
|
|
|
|
# --- guard: no ROM / game data snuck in --------------------------------
|
|
if find "$OUT" -type f \( -iname '*.z64' -o -iname '*.n64' -o -iname '*.v64' \) | grep -q .; then
|
|
echo "error: bundle contains a ROM image — aborting" >&2
|
|
exit 1
|
|
fi
|
|
BYTES="$(du -sb "$OUT" | cut -f1)"
|
|
LIMIT=$((60 * 1024 * 1024))
|
|
if [ "$BYTES" -gt "$LIMIT" ]; then
|
|
echo "error: bundle is $BYTES bytes (> 60 MB) — likely contains game data, aborting" >&2
|
|
exit 1
|
|
fi
|
|
|
|
# --- zip + checksum --------------------------------------------------
|
|
( cd dist && rm -f "${NAME}.zip" "${NAME}.zip.sha256" \
|
|
&& zip -qr "${NAME}.zip" "$NAME" \
|
|
&& sha256sum "${NAME}.zip" > "${NAME}.zip.sha256" )
|
|
|
|
echo "==> dist/${NAME}.zip ($(du -h "dist/${NAME}.zip" | cut -f1))"
|
|
cat "dist/${NAME}.zip.sha256"
|
|
( cd dist && unzip -l "${NAME}.zip" ) 2>/dev/null || find "$OUT" -type f | sed "s#^dist/##" | sort
|