0 Fork 1

mirror of https://github.com/jkdansereau/goldeneye-pc-port.git synced 2026-10-23 15:52:42 +02:00

Files

T

James Dansereau 4ca11e4386 Prepare repository for public release

- README: attract-mode stills + demo GIF as the hero row, status/warning
  callouts, metrics table, "Contents" index, doc-index table; simplified
  the two-agent workflow diagram (LR -> TD, fewer edges) for GitHub web
- Table-of-contents indexes added to internals.md, porting-notes.md,
  agentic-development.md, AUDIO-PLAN.md
- CI: add Windows/MSYS2 build job, minimal token (contents: read),
  persist-credentials: false, concurrency group; run on main + master.
  validate job regenerates the US ROM-asset symbol file only and configures
  ntsc-final (PAL/JP need a region ROM; no ROM is used in CI)
- .github: SECURITY.md, issue forms + chooser config, PR template,
  labels.yml, dependabot (Actions, monthly)
- Do not track the proprietary SGI IRIX IDO toolchain or SGIImageViewer.exe;
  document in SetupGuide.md / building.md how to obtain IDO for N64 ROM
  builds (the PC port does not need it)
- Stop tracking two committed *.pyc files; drop stale screenshots and a
  redundant .gitignore line; misc doc cross-reference fixes

Claude-Session: https://claude.ai/code/session_01GULf6knbsqfsnW39tMr9WT

2026-09-01 22:42:52 -04:00

3.3 KiB

Raw Blame History

CLAUDE.md — GoldenEye 007 PC port

This file auto-loads every session. It is the operating manual. The full rules are in AGENTS.md (imported below); this file adds the two checklists that were being skipped.

@AGENTS.md

Doc load order — read deliberately, not everything

Context is scarce. Load by tier; do not blind-read whole files.

Tier 0 — always (auto-loaded): CLAUDE.md, AGENTS.md. Nothing else auto-loads.
Tier 1 — every session start: docs/HANDOFF.md (current state + next task + environment — a rolling local working file; may be absent in a fresh clone, in which case read the README "Status" section instead) — read fully; docs/porting-notes.md (recurring bug classes) — skim the section headers, read the classes relevant to the task.
Tier 2 — on demand only, do NOT read start-to-finish:
- docs/internals.md — architecture / RSP deltas / phased plan (§1–§10). Read the section you need.
- docs/dev/findings.md — the Dxx finding log (§F + §H). Jump to a specific Dxx via the index at the top of §F. Never linear-read.
- docs/dev/HANDOFF-ARCHIVE.md — prior-session narrative (M-2…). Only when tracing the history of one fix.
- docs/dev-process.md — before dispatching a subagent (also Tier 1 if you may dispatch this session).

Session preflight — do this in your FIRST few tool calls, before acting

Having a concrete "next step" from the handoff is NOT license to skip this.

Read the Tier 1 docs: docs/HANDOFF.md (immediate task, standing procedure, environment gotchas — or the README "Status" section if it is absent) and docs/porting-notes.md (recurring bug classes — you will re-derive catalogued bugs if you don't).
Skim the README "Status" section for where the project stands.
If you may dispatch a subagent this session, read docs/dev-process.md NOW — not at dispatch time.

Dispatch preflight — EVERY Agent/Task spawn, no exceptions

A subagent brief is INVALID and must not be sent unless it contains all of:

FILES YOU MAY TOUCH — disjoint from every other running agent.
BUDGET — <= N build->run->inspect cycles or ~M min. Tight for cheap-class bugs (truncations, off-by-ones); more room for structural ones (matrix handedness, format specs). Escalate the default as the project hardens.
ON EXPIRY — stop, revert temp probes, write up what you have in docs/dev/findings.md §F with an explicit confidence rating. A good write-up of a half-solved bug is a deliverable, not a failure.
KNOWN-GOOD / RULED OUT, CONSTRAINTS (no game-logic changes; ABI/layout/format only; #ifdef PORT; documented in §F), REPORT shape.
Instruction to read docs/porting-notes.md first and append any generalisable quirk to it.

Full template: docs/dev-process.md -> "Investigation-brief template".

Verification cadence (integrator / overseer)

Per merged patch: single-frame GE_PCDUMP capture diffed against the committed golden baseline. Cheap. Do NOT gate every patch on a long soak.
Per batch / integration checkpoint: one 60s -level_09 crash-free run.
Subagents on small disjoint subsystems (input, audio, saves, converters) don't run the game — the overseer verifies.