From 7d1ffd453369330ffc7e9125c9615502103f5018 Mon Sep 17 00:00:00 2001 From: Cursor Agent Date: Wed, 1 Apr 2026 14:35:31 +0000 Subject: [PATCH] Add AGENTS.md with Cursor Cloud development instructions Co-authored-by: wannerdev --- AGENTS.md | 34 ++++++++++++++++++++++++++++++++++ 1 file changed, 34 insertions(+) create mode 100644 AGENTS.md diff --git a/AGENTS.md b/AGENTS.md new file mode 100644 index 0000000..03bcfb5 --- /dev/null +++ b/AGENTS.md @@ -0,0 +1,34 @@ +# AGENTS.md + +## Cursor Cloud specific instructions + +### Project overview + +Too Fishy is a Godot 4.4 game (GDScript). See `CLAUDE.md` for architecture details and `README.md` for basic setup. + +### Running the game + +- **Editor/GUI mode:** `DISPLAY=:1 godot --path .` (launches the editor with the project loaded; press F5 to play) +- **Direct play:** `DISPLAY=:1 godot --path . --run` (runs the main scene directly) +- The VM uses software rendering (`llvmpipe`); expect lower performance than a real GPU. The game runs fine for development/testing. + +### Headless operations + +- **Import/reimport assets:** `godot --headless --import` (run from `/workspace`) +- ALSA audio errors in logs are expected (no sound card in the VM) and do not affect gameplay. + +### Lint / testing + +- No automated test framework is configured. Validation is manual: run the game and verify behavior. +- `godot --headless --import` serves as a basic project integrity check — it will report GDScript parse errors and missing resources. +- There is a pre-existing warning-as-error in `scripts/destroyable_barier.gd` (Variant type inference); this does not block the game from running. + +### Build (export) + +- Web export: `godot --headless --export-release "Web" build/web/index.html` (requires export templates installed) +- Export templates are **not** installed in the VM by default. CI uses `barichello/godot-ci:4.4.1` Docker image which bundles them. + +### Gotchas + +- The `--check-only` flag may hang indefinitely in headless mode; avoid using it. Use `--import` for validation instead. +- GDScript files that reference autoload singletons (e.g., `GameState`) cannot be loaded in isolation via `--script`; they require the full engine context.