haylan/tpf3-overtake
1
0 Fork 0
Code Issues 3 Pull Requests Actions Packages Projects Releases Wiki Activity

chore: add Teal/VS Code config, tl check workflow and modding notes

Browse Source 
Co-Authored-By: Claude Sonnet 5.5 <noreply@anthropic.com>
This commit is contained in:
haylanandClaude Bot committed 2026-10-04 22:32:59 +02:00
1 parent 86a48e75c9
commit 0ef87ebab7
5 files changed
+30
Download Patch File Download Diff File Expand all files Collapse all files

No files matched your search

CLAUDE.md
+7
View File
@@ -11,3 +11,10 @@ Default five-role vocabulary (`needs-triage`, `needs-info`, `ready-for-agent`, `
### Domain docs
Single-context: one `CONTEXT.md` + `docs/adr/` at the repo root. See `docs/agents/domain.md`.
## Modding
- The mod is `mod/` (junctioned into the game's `staging_area` as `haylan_tf3_overtake`). Scripts are Teal (`.tl`, typed Lua); `mod.json` goes at the root of `mod/`.
- Type-check with `tl check mod/<file>.tl` (run from the repo root; it reads `tlconfig.lua`). `tl` is type-check only; whether the game compiles `.tl` itself is undocumented.
- `tlconfig.lua` and `.claude/settings.local.json` are machine-local and gitignored. Copy `tlconfig.template.lua` to `tlconfig.lua` and replace `<tf3_install_folder>` with the game's install path (here `D:/SteamLibrary/steamapps/common/Transport Fever 3/`).
- Authoritative API types: `<install>/api/tealdef` and `<install>/base/tealdef`. Read them, and the offline docs in `docs/reference/`, before guessing an API. Research notes are in `docs/research/`; vocabulary in `CONTEXT.md`.