From f43fe497095dd0207bdabd3bace2e657278f8547 Mon Sep 17 00:00:00 2001 From: BuffJesus <69093219+BuffJesus@users.noreply.github.com> Date: Sat, 24 Oct 2026 10:16:09 -0600 Subject: [PATCH 1/3] hygiene: Organize public handoffs and preserve active workspace evidence --- .gitignore | 12 ++ CONTRIBUTING.md | 6 + README.md | 5 +- docs/HANDOFF.md | 84 ++++----- docs/INDEX.md | 8 +- docs/NATIVE_STATUS.md | 30 +++- docs/PROJECT_LAYOUT.md | 66 ++++++++ docs/ROADMAP.md | 160 +++--------------- .../2026-10/2026-10-10-public-handoff.md | 49 ++++++ .../2026-10/2026-10-10-public-roadmap.md | 145 ++++++++++++++++ 10 files changed, 375 insertions(+), 190 deletions(-) create mode 100644 docs/PROJECT_LAYOUT.md create mode 100644 docs/journal/2026-10/2026-10-10-public-handoff.md create mode 100644 docs/journal/2026-10/2026-10-10-public-roadmap.md diff --git a/.gitignore b/.gitignore index e1dfb70fef..9473645779 100644 --- a/.gitignore +++ b/.gitignore @@ -4,6 +4,9 @@ imgui.ini *.user *.suo +.junie/ +/.claude/worktrees/ +/.agents/CLEANUP_COORDINATION.md # Proprietary/local binary inputs and analysis databases /debug_build/ @@ -14,6 +17,10 @@ imgui.ini /work/ /dist/ /tmp/ +/build/ +/.scratch_tmp/ +/scratchpad/ +/runtime_dumps/ /snapshots/ /FSE/ /FableTLC_RE_docs.zip @@ -87,4 +94,9 @@ imgui.ini /CON /imgui.ini /out_dat.txt +/tmp_* +/work_*.txt +/*_native.txt +/*.log +/0x* /[0-9a-f][0-9a-f][0-9a-f][0-9a-f][0-9a-f][0-9a-f]* diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 96c98fb475..e0da178b19 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -57,3 +57,9 @@ comparison. Root-level scratch (`*.obj`, `*.bin`) is ignored; keep working files Open an issue with the function address, the verifier output, and the compiler flags used. For readability complaints about landed code, name the file; a retype pass exists exactly for that. + +## Working alongside other sessions + +See [project layout and workspace care](docs/PROJECT_LAYOUT.md) for source and +local-output locations, exact path ownership, and isolated publication. Preserve +active builds and evidence even when ignored by Git. diff --git a/README.md b/README.md index ac565e298a..cc2c597e42 100644 --- a/README.md +++ b/README.md @@ -4,7 +4,7 @@ An evidence-gated reconstruction of the native 32-bit Windows `Fable.exe`, targeting readable, buildable C/C++ source and a durable native modding platform. -> **Actively developed — October 10, 2026.** Native C/C++ reconstruction is +> **Actively developed — October 24, 2026.** Native C/C++ reconstruction is > continuing. Recent local tests render a retail title sprite through recovered > drawing routines and validate connected texture-loading and lifetime paths. > The existing interactive frontend is an authored integration checkpoint, @@ -14,7 +14,8 @@ modding platform. [Run the checkpoint](#run-the-checkpoint) · [See current progress](#current-progress) · [Read the roadmap](#roadmap) · -[Browse the documentation](#documentation) +[Browse the documentation](#documentation) · +[Project layout and workspace care](docs/PROJECT_LAYOUT.md) ## Contents diff --git a/docs/HANDOFF.md b/docs/HANDOFF.md index 81f1bb3735..977e625f3d 100644 --- a/docs/HANDOFF.md +++ b/docs/HANDOFF.md @@ -1,49 +1,35 @@ -# Public handoff — updated 2026-10-10 - -## Current public checkpoint - -Native recreation is active. Read [NATIVE_STATUS.md](NATIVE_STATUS.md) for the -October 10 local verification results, current boundaries and publication scope. -This update publishes status only; the newer local source/test checkpoint is -not merged into `main`. The generated dashboard remains the September snapshot. -The published frontend is authored integration, not a playable native engine. - -The resume instructions below are historical September notes. Their branch, -head, clean-tree and `main` equality claims are not current instructions. -Do not blindly merge the development branch: unrelated Lua work must stay out -of a native-only publishing checkpoint. - -## Historical September 7 handoff - -## State -- Branch: `feat/script-recovery-marathon` (head `2e038aa`, clean tree, `main` == this head); `main` was fast-forwarded (519 commits) and pushed to `BuffJesus/FableDecomp` on 2026-09-07 — fast-forward it again after each checkpoint. Note: `git add` on this tree takes 1–6 minutes and HANGS if another process is writing under `rebuild/` (or a reserved-name file like `CON` exists); never run it concurrently with the header generator or retype. -- 22 old agent branches are now `archive/*` tags. Root scratch + `CON` removed. `LICENSE`, `CONTRIBUTING.md`, CI `docs-consistency` added. -- Coverage (2026-08-28 dashboard): 8,082 byte-identical (16.3%), 18,579 functional-or-matching (37.5%) of 49,568; catalog is now 18,631 landed. Regenerate `rebuild/COVERAGE.md` before quoting numbers. - -## Open these five first -1. `docs/ROADMAP.md` — what is done / in flight / next (the only task list) -2. `docs/ARCHITECTURE.md` — the three source layers (lift intake / parity `rebuild/src/compiled` / modern) -3. `docs/BUILDING.md` — Ghidra, VC7.1, GhidraMCP, FSE tooling commands -4. `CONTRIBUTING.md` — landing rules, header contract, purity policy -5. `rebuild/COVERAGE.md` — the numbers - -## Active lanes and their resume commands -- Typed headers: `python tools/decomp_pipeline/gen_class_headers.py --all-trusted` (add `--compile-check`), then `python tools/decomp_pipeline/retype_landed.py --class CGameScriptInterface` (dry run; `--apply` only rewrites files that stay byte-exact). Log: `rebuild/backlog/retype_log.tsv`; headers: `rebuild/include/engine/` (`INDEX.tsv`, `RECONCILE.tsv`, `_quarantine/`). -- Parity crawl: resume from `work/crawl_batch155` — `next_smallest.py` -> `trim_overcapture.py` -> `trim_tailjmp.py` -> author -> `verify_and_land.py`; iterate a DIFFER with `work/crawl_batch154/probe.py`. Ledger `tools/decomp_pipeline/crawl/gen_tried.txt`. -- De-bake: `python tools/decomp_pipeline/crawl/bake_families.py` for the live family table; `debake_family.py