mirror of
https://github.com/jkdansereau/goldeneye-pc-port.git
synced 2026-10-24 00:02:45 +02:00
James Dansereau
4ca11e4386
- 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
42 lines
1.5 KiB
Markdown
42 lines
1.5 KiB
Markdown
# Security Policy
|
|
|
|
This project is a non-commercial, fan-made research port. It has no server
|
|
component and ships no binaries. The realistic security surface is:
|
|
|
|
- the PC port executable parsing your own ROM and asset files at load time
|
|
(a malformed ROM/asset could in principle crash it or worse), and
|
|
- the build/extraction scripts and CI workflow.
|
|
|
|
## Reporting a vulnerability
|
|
|
|
Please **do not** open a public issue for a security problem.
|
|
|
|
Use GitHub's private vulnerability reporting:
|
|
**Security → Report a vulnerability** on this repository
|
|
(<https://github.com/jkdansereau/goldeneye-pc-port/security/advisories/new>).
|
|
|
|
If that is unavailable, email the maintainer at the address on their GitHub
|
|
profile with `SECURITY` in the subject.
|
|
|
|
Please include:
|
|
|
|
- affected version / commit hash (from `git rev-parse HEAD`),
|
|
- OS and how you built (region, `IDO_RECOMP`, MSYS2 vs WSL, …),
|
|
- a minimal reproduction, and
|
|
- the crash log (`ge007.crash.log`) or a stack trace if you have one.
|
|
|
|
## Scope
|
|
|
|
In scope: memory-safety bugs in the `port/` layer and PC-port tooling,
|
|
issues in the CI workflow or build scripts, and dependency problems we can
|
|
act on.
|
|
|
|
Out of scope: bugs inherited unchanged from the upstream
|
|
[GoldenEye 007 decompilation](https://github.com/n64decomp/007) that are not
|
|
made worse by the port (report those upstream), missing-asset or wrong-ROM
|
|
errors, and anything requiring a ROM or assets we do not distribute.
|
|
|
|
## Supported versions
|
|
|
|
Only the tip of the default branch is supported. There are no releases yet.
|