0 Fork 0

Files

T

James Dansereau 8c3ce1c688 Build provenance: origin URL + codename in --version and startup log; fork policy in CONTRIBUTING (#82 )

- versioninfo gains GE007_VERSION_CODENAME (larkspur) and GE007_ORIGIN_URL,
  printed by --version (new 'origin' line) and the startup log. A build keeps
  pointing at this repository no matter who compiles or renames it.
- CONTRIBUTING: new 'Forks and derivative works' section — rebranding,
  localizing and extending are welcome without permission; attribution (with
  a link) and preserving/linking the docs/dev engineering record are the ask;
  stripping the attribution is what disqualifies a fork as a descendant.

2026-09-13 22:14:41 -04:00

2.6 KiB

Raw Blame History

Contributing

Thanks for your interest. This is a small hobby project; issues and pull requests are welcome, but please read the ground rules first — they are what keep the port faithful to the original game.

Ground rules

The decompilation is not modified for the port. Everything under src/ and include/ is compiled unmodified. Makefile, tools/, rsp/, ld/ belong to the N64 build and are never touched for PC work. If PC code seems to need a behavioural change in the game, the fix belongs in port/.
Narrow ABI exception. The 32→64-bit transition forces a small class of mechanical, semantics-preserving edits to ROM-serialized structs (storing an embedded 32-bit pointer as u32 and casting at the use site). These are allowed, must be guarded with #ifdef PORT, must change no behaviour, and must be documented. See docs/porting-notes.md for the catalogue of patterns.
Region macros mirror the Makefile. CMakeLists.txt REGION_DEFS must match the N64 Makefile's per-region macro set exactly.
Verify before you push. A build-affecting change needs, at minimum, a clean configure + build for ntsc-final and a crash-free run of one level (./build-pc/ge007.x86_64 -level_09).

Style

C/C++ formatting follows .clang-format and .editorconfig in the repo root. Match the surrounding code.
Port-layer code is plain C11 / C++17, SDL2 + OpenGL, no extra dependencies.
Keep commits focused and describe why, not just what.

Forks and derivative works

Fork away — the code is MIT and the port/ layer exists to be extended. Rebranding, localizing and extending are all welcome, and none of them need permission. If you carry the work forward under your own name, please keep two things:

Attribution. A clear statement, in your README and about page, that the project derives from this one — with a link. The engine prints its origin at startup and in its --version output; keeping that intact is part of the ask.
The record. docs/dev/ (the finding log, porting notes, per-level status) is the engineering record behind every fix. Derivative projects are asked to preserve or link to it rather than fork-and-forget.

Stripping the attribution is the one thing that turns a fork into something we no longer recognize as a descendant of this project.

Where to look

docs/internals.md — how the port is structured.
docs/porting-notes.md — the recurring bug classes. Check here before debugging a crash; you are likely looking at a known pattern.
docs/dev/ — the full finding log and per-level status.