Talon/alchemist-accessibility
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

docs: how to set up, run and publish this tree

Browse Source 
The setup is unusual enough to need its own page, and the facts were
scattered across scratch.md, CLAUDE.md and publish.sh: the mod is developed
inside a copy of a commercial game, so the dev tree deliberately has no
remote and publishing means rebuilding a filtered repo and force-pushing
that instead.

docs/00-dev-setup.md covers the two-tree arrangement and which one you are
in, prerequisites and why the game must be an extracted folder rather than
a .love (ffi.load goes through the OS loader), building a dev tree from
scratch including the vanilla-0.4.2 baseline tag and the one main.lua line,
the everyday commands, the save location, reading the [speech] console and
the startup self-test, and the publish flow with its leak check.

Linked from CLAUDE.md and the docs index. No code change.

Co-Authored-By: Claude Opus 5 <noreply@anthropic.com>
This commit is contained in:
Accessibility Mod
2026-08-02 02:16:21 +02:00
co-authored by Claude Opus 5
parent 973e62c8fe
commit 7ce429c2fb
4 changed files with 234 additions and 1 deletions
Download Patch File Download Diff File Expand all files Collapse all files
CLAUDE.md
+5
View File
@@ -30,6 +30,11 @@ current state of play, confirmed decisions that should not be relitigated, the
traps that have already cost real debugging time, and what is verified versus
merely written. **Read it first, and update it before you finish.**
`accessibility/docs/00-dev-setup.md` — how this tree is put together and why:
the two-tree arrangement, prerequisites, building a dev tree from scratch, the
everyday commands, and how publishing strips the game out. Read it if anything
about the setup surprises you.
Then `accessibility/docs/README.md` maps the rest: architecture, hooking
strategy, the phased plan, open questions, decisions.