9fbb352ef0
Merges the Godot port into the reverse-engineering repository, preserving both
histories -- 1019 commits of corpus plus the port's 31, brought in by subtree
merge and then moved into place so git can follow each file across the rename.
The reason is not tidiness. The two-repo split forced the exporter to depend on
the decoders by pinned revision, and that created a whole class of failure that
now disappears: a sha reachable only from a topic branch, orphaned by a
squash-merge, breaking a fresh checkout silently at build time. It also forced a
live read-only mount of one agent's working tree into another's container, which
is why a contract file could move mid-iteration. With a path dependency, a
decoder change and the exporter change it requires land in the same commit or
not at all.
Canary stays separate: it is a fork tracking upstream.
New structure for the long term:
docs/game/ how the game is NAVIGATED -- menus, modals, prompts, alerts,
and in-game flight. Written so nobody rediscovers it. Mostly
open questions on purpose; the in-game tutorials are the
resource for the flight half.
docs/port/MODDING.md
modding as a constraint on the exporter TODAY, not a later
feature: one logical asset in one file (the disc splits nearly
everything, and resolving that is the exporter's job), names a
person recognises, PNG/OGG/OGV/JSON only, base-and-overrides so
re-exporting is always safe, provenance in every file.
data/base + data/mods
generated tree and drop-in overrides, both gitignored
exchange/ transient inter-agent files, deliberately outside history
docs/agents/ the team protocol
Both the README and the navigation doc lead with the correction that cost the
most: the oracle is the real game under Xenia Canary. Reborn's renderer is a
hypothesis under test, it has been wrong, and treating it as ground truth
propagated into three documents and both agents before a human caught it.
Scripted modding stays possible without being built: no screen name is hardcoded
in GDScript and there is no native code in port/, which is what Godot Mod Loader
needs to be able to substitute behaviour later.
67 lines
2.9 KiB
Markdown
67 lines
2.9 KiB
Markdown
# Sylpheed
|
|
|
|
A clean-room reverse engineering and port project for **Project Sylpheed: Arc of
|
|
Deception** (Xbox 360, 2007).
|
|
|
|
Three things live here, in one repository so that a change spanning them lands as
|
|
one commit:
|
|
|
|
| | |
|
|
|---|---|
|
|
| **The decoders** | `crates/sylpheed-formats` — the disc's formats, read and verified disc-wide |
|
|
| **The port** | `port/` — a Godot 4 project, plus `crates/sylpheed-export` which converts a disc into the open asset tree it reads |
|
|
| **The corpus** | `docs/re/` — what has been reverse engineered, with its evidence, its retractions and its dead ends |
|
|
|
|
**You need your own copy of the game.** No game content is in this repository and
|
|
none ever will be. The exporter reads the disc you supply.
|
|
|
|
## The oracle is the real game
|
|
|
|
> `sylpheed-cli` and the Explorer are **tools for verifying our decoding**. They
|
|
> are hypotheses under test and they have been wrong. When something must be
|
|
> checked against the truth, the truth is **the game running in Xenia Canary**,
|
|
> captured — not any renderer of ours.
|
|
|
|
This is stated first because getting it backwards is the most expensive mistake
|
|
this project has made.
|
|
|
|
## Layout
|
|
|
|
```
|
|
crates/
|
|
sylpheed-formats/ the decoders. Disc-wide verified; the corpus is its spec
|
|
sylpheed-cli/ headless tools -- render a screen, dump a table, probe audio
|
|
sylpheed-viewer/ the Explorer: a human's window onto the disc. STATIC data only
|
|
sylpheed-export/ disc -> the open, moddable asset tree
|
|
port/ the Godot 4 project. Reads open formats ONLY
|
|
authored/ decisions that are NOT on the disc, each with its reason
|
|
data/
|
|
base/ generated by the exporter. Gitignored, never hand-edited
|
|
mods/ drop-in overrides. Yours
|
|
docs/
|
|
re/ the corpus: findings, refutations, method traps
|
|
game/ how the game is navigated -- menus, modals, flight
|
|
port/ the port's mission, its handoff contract, modding rules
|
|
agents/ how the agent team works together
|
|
tools/ capture harnesses, probes, the share tool
|
|
exchange/ transient inter-agent files. NOT in git
|
|
docker/ the agent containers
|
|
```
|
|
|
|
## Where to start
|
|
|
|
* [`docs/re/INDEX.md`](docs/re/INDEX.md) — what is decoded
|
|
* [`docs/re/REFUTED.md`](docs/re/REFUTED.md) — what has been tested and died
|
|
* [`docs/re/METHOD.md`](docs/re/METHOD.md) — traps this project has already paid for
|
|
* [`docs/game/navigation.md`](docs/game/navigation.md) — how the game is navigated
|
|
* [`docs/port/MODDING.md`](docs/port/MODDING.md) — why the asset tree looks the way it does
|
|
|
|
Xenia Canary is a **separate** repository: it is a fork tracking upstream, and it
|
|
carries our instrumentation.
|
|
|
|
## Conventions
|
|
|
|
Confidence is per claim, never per document: ✅ `CONFIRMED` · 🟡 `PROBABLE` ·
|
|
❔ `HYPOTHESIS` · ❌ `REFUTED`. A withdrawn result is kept with its reasoning
|
|
rather than deleted — that is why the numbers here can be trusted.
|