65cefa74c3
Some checks failed
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.
65 lines
3.8 KiB
TOML
65 lines
3.8 KiB
TOML
[package]
|
|
name = "sylpheed-export"
|
|
description = "Convert a Project Sylpheed disc into the open asset tree the Godot port reads"
|
|
version.workspace = true
|
|
edition.workspace = true
|
|
license.workspace = true
|
|
|
|
[dependencies]
|
|
# The decoders, PINNED BY REVISION. Not vendored and not reimplemented: they are
|
|
# disc-wide verified in their own repository, and floating the pin would let a
|
|
# decoder change land mid-milestone -- exactly the confusion this prevents.
|
|
#
|
|
# `sylpheed_formats::media` in particular owns the cases where one playable thing
|
|
# is not one archive entry (segment-spanning reads, multi-sub-wave banks, and the
|
|
# continuous cutscene-voice stream). Do not re-derive those here.
|
|
#
|
|
# Pin moved f817dd5 -> 7eeae30 on 2026-08-29. WHAT I WANTED FROM IT: `UiBuild`
|
|
# gained a public `records` map (record name -> the nested `.rat` leaf's byte
|
|
# range). Without it a consumer could not locate a leaf at all: `parse_build`
|
|
# sorted T8aD children into `sprites` and `.rat` children into a PRIVATE map, so
|
|
# the focus ring -- which lives inside `ptbtn0Nf.rat`, a record the parent
|
|
# bundle declares no element for -- was unreachable through the public API.
|
|
# Also brings `Keyframe::rotation_deg`, which the game does render.
|
|
#
|
|
# PINNED BY TAG, not by sha, and MISSION §2 now requires it. The reachability
|
|
# risk this comment used to warn about is closed: a sha reachable only from an
|
|
# `auto/*` branch is orphaned when that branch is deleted or -- worse --
|
|
# SQUASH-MERGED, because squash creates new commits, so `main` would look like
|
|
# it contained the work while this pin became unreachable. A tag is a permanent
|
|
# ref, it says what it is here in the file, and it fails loudly at FETCH rather
|
|
# than silently at build. `formats-pin-2026-08-29` is 7eeae30.
|
|
#
|
|
# Previous pin note, kept because the reasoning still holds:
|
|
# Pin moved 5414db3 -> f817dd5 on 2026-08-29. WHAT I WANTED FROM IT: `56cc7ac`,
|
|
# "a RATC child's name is stated, not inferred". A child was named by scanning
|
|
# backwards for the last printable run before its magic; for `pteff05.t32` the
|
|
# three trailing payload bytes are `38 41 58` = `8AX` and beat the real name, so
|
|
# the FULL-RESOLUTION BACKGROUND OF ALL FIVE MENU SCREENS registered under a
|
|
# name no element declares and resolved to no sprite. This port exported those
|
|
# screens without their background and said so in every render as "pteff05 (no
|
|
# sprite in the export)" -- which docs/DECISIONS.md then wrote up as correct.
|
|
# It was not. f817dd5 is the last commit touching `crates/` on that branch.
|
|
#
|
|
# Previous pin note, kept because the reasoning still holds:
|
|
# Pin moved 8b6dbcf -> 5414db3 on 2026-08-28. WHAT I WANTED FROM IT: the fix to
|
|
# `ui_layout::rest()`. At 8b6dbcf a trailing run of identical keyframes was
|
|
# always treated as the exit, so an element with no exit animation rested at its
|
|
# invisible pre-roll -- `ptframe1`/`ptframe2`, the main menu's circuit bracket,
|
|
# which a capture of the running game plainly shows. 5414db3 is the revision at
|
|
# which that fix carries its disc-wide check (30 of 13 991 elements move, 4
|
|
# become visible, 0 become invisible), not merely the one where it was written.
|
|
# A PATH dependency now that the decoders and the exporter live in one
|
|
# repository. This deletes a whole class of failure that the two-repo split
|
|
# created: no pinned revision to go stale, no tag to keep alive, no commit that
|
|
# a squash-merge can orphan, and no way for the exporter to be built against a
|
|
# decoder it was never tested with. A decoder change and the exporter change it
|
|
# requires now land in the same commit or not at all.
|
|
sylpheed-formats = { path = "../sylpheed-formats" }
|
|
|
|
serde = { version = "1", features = ["derive"] }
|
|
serde_json = "1"
|
|
anyhow = "1"
|
|
clap = { version = "4", features = ["derive", "env"] }
|
|
image = { version = "0.25", default-features = false, features = ["png"] }
|