diff --git a/.github/workflows/ci.yml b/.github/workflows/ci.yml index 710826df..f73047bc 100644 --- a/.github/workflows/ci.yml +++ b/.github/workflows/ci.yml @@ -12,6 +12,10 @@ on: # assets: the PC-port tooling, the generated ROM-asset symbol files, and a # CMake configure of all three regions (which checks REGION_DEFS, the source # list, and that SDL2 / zlib / OpenGL are discoverable). +# +# This is a configure-only smoke test. It does NOT compile or run the port, and +# it running on ubuntu is NOT a statement that the port builds or works on +# Linux — it has only ever been built and tested on Windows (MSYS2). jobs: validate: diff --git a/README.md b/README.md index 7b319a90..b045262e 100644 --- a/README.md +++ b/README.md @@ -25,6 +25,13 @@ timers, save storage) is shimmed in a dedicated `port/` layer.
In-engine captures — Archives and Bunker 1 running in the port.

+> **Not playable yet.** This is a work-in-progress research port. The intro and +> menus render and all 21 solo levels load, but it is **not** a complete or +> reliably playable game: there is **no audio**, the front-end 3D models and +> some text are broken, input has known rough edges, and you should expect +> crashes and glitches once you are past the level intro. Treat it as a +> technical demo of the porting work, not a way to play GoldenEye. + ## Background This port is primarily a **research project on agentic software development** — @@ -106,8 +113,12 @@ the front end into the early game. It is not finished and it is not stable. conversions) are tracked in [`docs/dev/GRAPHICS-BACKLOG.md`](docs/dev/GRAPHICS-BACKLOG.md) and parked below crash/level work. -- Only `x86_64` Windows and Linux are exercised regularly. No macOS/ARM - testing yet; no controller rebinding UI; no widescreen. +- **Platform testing is Windows-only.** All development and playtesting has + been on `x86_64` Windows (MSYS2/MINGW64). The CMake build has Linux and macOS + paths and is *intended* to be portable, but the port has had **zero + functional testing on Linux or macOS** — the Linux build is provided as-is + and unverified at runtime. No ARM testing; no controller rebinding UI; no + widescreen. ## Requirements @@ -151,6 +162,9 @@ cd goldeneye-pc-port ### Linux +> **Untested.** No one has built or run the port on Linux. The steps below are +> the intended path, not a verified one — expect to fix build issues yourself. + ```sh sudo apt install build-essential cmake python3 libsdl2-dev zlib1g-dev libgl1-mesa-dev git clone https://github.com/jkdansereau/goldeneye-pc-port.git diff --git a/docs/building.md b/docs/building.md index 93d052d8..f72da027 100644 --- a/docs/building.md +++ b/docs/building.md @@ -18,6 +18,11 @@ versions and hashes. ### Port build +> **Only the Windows (MSYS2 MINGW64) path is tested.** The Debian/Ubuntu and +> macOS columns below are best-effort guidance — the port has never been built +> or run on Linux or macOS. Expect to fix build breaks yourself on those +> platforms. + | Need | Windows (MSYS2 MINGW64) | Debian/Ubuntu | macOS (Homebrew) | |------|------------------------|---------------|------------------| | toolchain | `mingw-w64-x86_64-toolchain` | `build-essential` | Xcode CLT / `gcc` |