mirror of
https://github.com/RetroPortingToolKit/psxrecomp
synced 2026-10-28 10:59:16 -04:00
Alex Vanderveen
f180a32ec1
Decision (Alex, 2026-09-30): the recompiled BIOS carries the same risk as
the recompiled game, which titles already commit, so the retail backend is
compiled in rather than built on the player's machine. The retail image is
still never shipped: the runtime needs its data at run time and accepts only
the exact image the backend was built from, so the player supplies their
own dump as before.
- generated/{OpenBIOS,SCPH1001}_{full,dispatch}.c and their .emitter.sha
stamps are tracked (.gitignore un-ignores exactly those); regenerated with
the current emitter.
- bios_emitter_fingerprint.sh no longer hashes the ROM image: the profile's
SHA-256 pin stands for it and the emitter refuses any other image, and CI
has no dump, so hashing it made every CI configure read "stale".
- runtime.cmake: the staleness check covers every LINKED stem and
-DPSXRECOMP_BIOS_STALE_FATAL=ON makes a stale stamp fail configure.
- game-release.yml: no CI-side OpenBIOS emission (generate_openbios.sh is
gone); configure with BIOS_STALE_FATAL and assert both backends linked.
check_generated.sh asserts the submodule carries both backends tracked
and no dump is tracked anywhere.
- The player-side module build stays for a known image a build does not
link (SCPH-5552).
Co-Authored-By: Claude Fable 5.1 <noreply@anthropic.com>
154 lines
4.7 KiB
Plaintext
154 lines
4.7 KiB
Plaintext
# BIOS ROM (copyrighted, not distributable)
|
|
bios/*
|
|
!bios/*.toml
|
|
# OpenBIOS is MIT — the one BIOS image that is legal to track (see
|
|
# THIRD_PARTY_ATTRIBUTION.md; pin recorded in bios/OpenBIOS.toml; notice
|
|
# shipped alongside as bios/OpenBIOS.LICENSE).
|
|
!bios/openbios.bin
|
|
!bios/*.LICENSE
|
|
|
|
# DuckStation — upstream source is a git submodule pointing at stenzek/duckstation.
|
|
# Our custom changes live in tools/duckstation/psxrecomp_oracle.patch (committed).
|
|
# Only the build artefacts and prebuilt binary deps are untracked at the parent level;
|
|
# the submodule's own .gitignore handles in-tree ignores.
|
|
duckstation/build/
|
|
duckstation/dep/prebuilt/
|
|
|
|
# Ghidra project files (large, regenerable)
|
|
ghidra/
|
|
|
|
# Backup of the working state — see CURRENT_STATE.md for what this contains.
|
|
.happypath/
|
|
|
|
# Build artifacts
|
|
recompiler/build/
|
|
recompiler/build-asan/
|
|
recompiler/build-asan2/
|
|
recompiler/build-checked/
|
|
recompiler/build-cli/
|
|
recompiler/build-t2/
|
|
runtime/build/
|
|
runtime/build-msvc/
|
|
runtime/build-*/
|
|
runtime/build-*.exe
|
|
test_msvc/
|
|
|
|
# Recompiler output. The two BIOS backends every release links are COMMITTED
|
|
# (decision 2026-09-30: the recompiled BIOS carries the same risk as the
|
|
# recompiled game, which titles already commit); CI builds them and the
|
|
# runtime.cmake fingerprint check fails a release whose stamp predates the
|
|
# emitter. Everything else under generated/ (scratch stems, skipped-function
|
|
# reports, per-dump work) stays local. Regenerate with:
|
|
# tools/regen_bios.sh --config bios/OpenBIOS.toml
|
|
# tools/regen_bios.sh --config bios/SCPH1001.toml (needs your own dump)
|
|
generated/*
|
|
!generated/OpenBIOS_full.c
|
|
!generated/OpenBIOS_dispatch.c
|
|
!generated/OpenBIOS.emitter.sha
|
|
!generated/SCPH1001_full.c
|
|
!generated/SCPH1001_dispatch.c
|
|
!generated/SCPH1001.emitter.sha
|
|
|
|
# Release packaging artifacts
|
|
release-stage/
|
|
*.zip
|
|
|
|
# Vendored upstream sources (cloned locally, not checked in)
|
|
beetle-psx
|
|
|
|
# Explicit-fallback SDL2 / dep zips (large, regenerable)
|
|
sdl2-dev.zip
|
|
sdl2-msvc/
|
|
|
|
# Diagnostic dumps & smoke logs (transient)
|
|
*.log
|
|
*.jsonl
|
|
/.aot_capture_history/
|
|
|
|
# Local additive overlay-capture store configuration and game-derived data.
|
|
.psxrecomp.env
|
|
.env
|
|
.local/
|
|
|
|
# Build-generated codegen-hash header (hash_codegen.cmake): folds an emitter
|
|
# content hash into the overlay cache path; regenerated each build, never committed.
|
|
runtime/include/overlay_codegen_hash.h
|
|
|
|
# Runtime diagnostic/crash files
|
|
psx_crash.txt
|
|
psx_diag.txt
|
|
psx_dispatch_misses.txt
|
|
psx_err.txt
|
|
psx_out.txt
|
|
|
|
# Probe / scratch artifacts
|
|
# All ad-hoc diagnostic dumps land under probes/ so the repo root stays clean.
|
|
# Runtime memcards are not covered here either — see the *.mcr / /*.mcd rules
|
|
# below; the tracked fixtures live in runtime/tests/fixtures/memcards/.
|
|
probes/
|
|
|
|
# Ad-hoc scratch tools (underscore prefix convention).
|
|
# Real tools have no leading underscore (e.g. tools/codegen_audit.py).
|
|
tools/_*.py
|
|
/*.json
|
|
/*.png
|
|
/*.bmp
|
|
/*.txt
|
|
|
|
# OS / editor junk
|
|
.DS_Store
|
|
Thumbs.db
|
|
*.swp
|
|
*.swo
|
|
*~
|
|
|
|
# Python caches
|
|
__pycache__/
|
|
|
|
# DuckStation oracle (local-only; private fork at git@github.com:mstan/duckstation.git)
|
|
/duckstation/
|
|
_wip/
|
|
|
|
# Game discs/EXEs and recompiler output (copyrighted, not distributable).
|
|
# Only the per-game config (game.toml) is tracked.
|
|
games/*/*
|
|
!games/*/game.toml
|
|
!games/*/seeds.txt
|
|
|
|
# Memcards. Cards a run creates are scratch: *.mcr anywhere, and any .mcd
|
|
# dropped at the repo root (the runtime writes card1.mcd/card2.mcd next to the
|
|
# project root when no explicit path is configured). The only tracked cards are
|
|
# test fixtures: runtime/tests/fixtures/memcards/ (see the README there) plus
|
|
# the runtime/tests/test_* fixtures re-included further down.
|
|
*.mcr
|
|
/*.mcd
|
|
!runtime/tests/fixtures/memcards/*
|
|
|
|
# macOS .app bundle (contains recompiled BIOS-derived binary — not distributable)
|
|
/dist/
|
|
|
|
# Session-scratch debug scripts (hardcoded local paths; kept on disk, not tracked)
|
|
tools/_options_session/
|
|
|
|
# Compiled test binaries (build artifacts; the runtime/tests/*.c sources are tracked).
|
|
# The *.exe rule alone missed extension-less Linux binaries, and three of them
|
|
# (test_netplay_snap_ring, test_netplay_hash_confirm, test_netplay_input_hist)
|
|
# were committed as a result — the snap-ring one from before boot_state grew its
|
|
# VRAM-incremental queries, so it could no longer be rebuilt from the tree it sat
|
|
# in. Ignore everything matching test_* here except the tracked sources/fixtures.
|
|
runtime/tests/*.exe
|
|
runtime/tests/test_*
|
|
!runtime/tests/test_*.c
|
|
!runtime/tests/test_*.cpp
|
|
!runtime/tests/test_*.py
|
|
!runtime/tests/test_*.mcd
|
|
!runtime/tests/test_dir/
|
|
|
|
# transient split-gen build dirs
|
|
recompiler/build-splitgen/
|
|
recompiler/build-*/
|
|
|
|
# Project Studio GUI venv (customtkinter)
|
|
tools/new_project_layout/.venv/
|
|
tools/new_project_layout/project_studio_repos.json
|