F1: Project skeleton and pinned engine
Add the Godot 4.7.2 project, src/ module layout, LFS rules, licences, CLAUDE.md and the devlog. tools/godot.sh runs the repo-local engine, headless by default, and keeps engine data inside the repo. The engine version and SHA-512 sums are recorded in tools/. make check verifies the engine, checks binaries and parses every script. Closes #1 Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
This commit is contained in:
@@ -0,0 +1,46 @@
|
||||
# Tidewall: working notes
|
||||
|
||||
Tidewall is a free and open-source third-person build-and-survive battle royale for
|
||||
Linux, made with Godot 4.7.2 and GDScript. Each development session starts with no
|
||||
memory, so this file, [docs/DEVLOG.md](docs/DEVLOG.md) and the Gitea issues are the
|
||||
continuity.
|
||||
|
||||
## Read these first
|
||||
|
||||
- [docs/DEVLOG.md](docs/DEVLOG.md): what happened, newest entries at the bottom.
|
||||
- [docs/GDD.md](docs/GDD.md): the game design.
|
||||
- [docs/ORIGINALITY.md](docs/ORIGINALITY.md): binding rules for everything we make.
|
||||
- [docs/ARCHITECTURE.md](docs/ARCHITECTURE.md): server-authoritative design and module map.
|
||||
- [src/sim/tuning.gd](src/sim/tuning.gd): the one table of gameplay numbers.
|
||||
|
||||
## Commands
|
||||
|
||||
| Command | What it does |
|
||||
|---|---|
|
||||
| `make check` | Verifies the engine, checks binaries, parses all scripts, runs all tests. Must pass before every push. |
|
||||
| `make test` | Runs `test/**/test_*.gd` headless. |
|
||||
| `make test-selfcheck` | Proves the runner catches each kind of failure, using `test/fixtures/`. |
|
||||
| `tools/godot.sh ...` | Runs the pinned engine. Headless by default. |
|
||||
|
||||
Run one group of tests with `tools/run_tests.sh --root=res://test/sim` or
|
||||
`tools/run_tests.sh --filter=name`.
|
||||
|
||||
## Rules
|
||||
|
||||
- The engine lives in `tools/godot/`, is git-ignored, and is pinned by
|
||||
`tools/engine.version` and `tools/engine.sha512`. Never download or replace it casually.
|
||||
- Never open a window on the host desktop. `tools/godot.sh` forces `--headless`.
|
||||
Don't use the host's display, GPU, webcams or audio devices.
|
||||
- GDScript is typed everywhere practical. Untyped declarations are errors.
|
||||
- Simulation code in `src/sim/` must not depend on rendering, audio or UI. A test enforces this.
|
||||
- Gameplay numbers go in `src/sim/tuning.gd`, nowhere else.
|
||||
- All randomness in the simulation comes from the seeded streams described in the
|
||||
architecture document.
|
||||
- Tests: extend `TestCase` in a file named `test_*.gd` under `test/`. Any engine or
|
||||
script error during a test fails it, unless the test calls `expect_error()`.
|
||||
- The repo is public. Never commit secrets, internal hostnames, private network details
|
||||
or personal data.
|
||||
- Commit as `Claude <claude@eom.dev>`, one commit per issue, with `Closes #N`. Scheduled
|
||||
runs use `git -c commit.gpgsign=false commit`.
|
||||
- Software rendering can't show real GPU frame rates or how the game feels. Never claim
|
||||
those were verified. Say what was actually tested.
|
||||
Reference in New Issue
Block a user