mirror of
https://github.com/jkdansereau/goldeneye-pc-port.git
synced 2026-10-23 15:52:42 +02:00
James Dansereau
cdf43d0140
- The Windows and Linux bundles shipped without the GCC runtime and SDL2 license texts when the build machine lacked them (CI's MSYS2 has no share/licenses/gcc-libs; CI's Linux image has no dpkg). bundle-win.sh, bundle-linux.sh and package-macos.sh now fall back to in-tree copies: tools_pc/dist/GPL-3.0.txt, GCC-RUNTIME-EXCEPTION.txt, SDL2-LICENSE.txt. - NOTICE / README: say the repository and downloads carry no ROM data or original assets and that the C source is a reconstruction (not "no Nintendo code"); describe the license-text sources. - README: "What this port offers"; split-screen for up to 4 players; the few game-code changes keep N64 behavior or are opt-in; neutral wording for the comparison with the XBLA recompilation projects (rows about their status and motives removed); verification approach stated; release notes drop the 165/240 testing caveat.
181 lines
7.8 KiB
Bash
Executable File
181 lines
7.8 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}"
|
|
|
|
# Prefer the real build output; a local build-pc/ can also hold renamed A/B or
|
|
# probe copies (ge007.abpad.exe, ...) that sort first (CI's fresh tree has one).
|
|
EXE=""
|
|
for cand in build-pc/ge007.x86_64.exe build-pc/ge007*.exe; do
|
|
if [ -f "$cand" ]; then EXE="$cand"; break; fi
|
|
done
|
|
[ -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 ---------------------------------------------------
|
|
EXE_NAME="$(basename "$EXE")"
|
|
sed -e "s|@VERSION@|${VERSION}|g" \
|
|
-e "s|@PLATFORM@|Windows x86-64|g" \
|
|
-e "s|@EXE@|${EXE_NAME}|g" \
|
|
-e "s|@DEPS@||g" \
|
|
-e "s|@DECK@||g" \
|
|
-e "s|@LICENSE_EXTRA@|, the MinGW runtime|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
|
|
# Some MSYS2 installs (CI's) have no share/licenses dir for gcc-libs or SDL2;
|
|
# the bundled libstdc++/libgcc_s (GPL-3.0 + GCC Runtime Library Exception) and
|
|
# SDL2 (zlib) still carry their texts, from the tree.
|
|
if [ ! -d "$OUT/licenses/gcc-libs" ]; then
|
|
mkdir -p "$OUT/licenses/gcc-libs"
|
|
cp tools_pc/dist/GPL-3.0.txt "$OUT/licenses/gcc-libs/COPYING3"
|
|
cp tools_pc/dist/GCC-RUNTIME-EXCEPTION.txt "$OUT/licenses/gcc-libs/COPYING.RUNTIME"
|
|
fi
|
|
if [ ! -d "$OUT/licenses/SDL2" ]; then
|
|
mkdir -p "$OUT/licenses/SDL2"
|
|
cp tools_pc/dist/SDL2-LICENSE.txt "$OUT/licenses/SDL2/LICENSE.txt"
|
|
fi
|
|
|
|
# --- save converter (D492): emulator .eep <-> port .eep, stdlib-only -----
|
|
mkdir -p "$OUT/tools"
|
|
cp tools_pc/eep_convert.py "$OUT/tools/"
|
|
|
|
# --- 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 tools_pc/d88_emit.py tools_pc/d88_propdefs.py "$PREP/" # d88 = per-level stage setup (+ its only local import)
|
|
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; }
|
|
|
|
# Frozen first-run converter (drop-in ROM support): the engine spawns this
|
|
# when data/pcmodels-* / data/pccg-* are missing (port/src/romconvert.c).
|
|
# CI builds it with PyInstaller before bundling; a local bundle needs the
|
|
# same step: python -m PyInstaller --onefile --name ge007-convert \
|
|
# --distpath tools_pc/dist/prepare-assets \
|
|
# tools_pc/dist/prepare-assets/prepare-assets.py
|
|
CV="$REPO_ROOT/tools_pc/dist/prepare-assets/ge007-convert.exe"
|
|
[ -f "$CV" ] || { echo "error: $CV not found — freeze it with PyInstaller first (see above)" >&2; exit 1; }
|
|
cp "$CV" "$PREP/"
|
|
echo " + prepare-assets/ge007-convert.exe ($(du -h "$CV" | cut -f1))"
|
|
|
|
# --- 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
|
|
# 120 MB: engine + DLLs are a few MB; the frozen ge007-convert (PyInstaller
|
|
# --onefile CPython) adds ~15 MB. Anything far beyond that is game data.
|
|
BYTES="$(du -sb "$OUT" | cut -f1)"
|
|
LIMIT=$((120 * 1024 * 1024))
|
|
if [ "$BYTES" -gt "$LIMIT" ]; then
|
|
echo "error: bundle is $BYTES bytes (> 120 MB) — likely contains game data, aborting" >&2
|
|
exit 1
|
|
fi
|
|
|
|
# --- zip + checksum --------------------------------------------------
|
|
# Prefer InfoZIP `zip`; fall back to 7-Zip or PowerShell Compress-Archive so a
|
|
# stock MSYS2 MINGW64 shell (which ships neither `zip` nor `unzip`) still works.
|
|
zip_dir() { # $1 = archive name, $2 = dir to add (both relative to dist/)
|
|
if command -v zip >/dev/null 2>&1; then
|
|
( cd dist && zip -qr "$1" "$2" )
|
|
elif command -v 7z >/dev/null 2>&1; then
|
|
( cd dist && 7z a -tzip -bso0 -bsp0 "$1" "$2" >/dev/null )
|
|
elif [ -x "/c/Program Files/7-Zip/7z.exe" ]; then
|
|
( cd dist && "/c/Program Files/7-Zip/7z.exe" a -tzip -bso0 -bsp0 "$1" "$2" >/dev/null )
|
|
elif command -v powershell >/dev/null 2>&1; then
|
|
( cd dist && powershell -NoProfile -Command \
|
|
"Compress-Archive -Force -Path '$2' -DestinationPath '$1'" )
|
|
else
|
|
echo "error: need one of: zip, 7z, or powershell to package the bundle" >&2
|
|
exit 1
|
|
fi
|
|
}
|
|
( cd dist && rm -f "${NAME}.zip" "${NAME}.zip.sha256" )
|
|
zip_dir "${NAME}.zip" "$NAME"
|
|
( cd dist && 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
|