Imported from xenotaur/Velumin (
AGENTS.md). Install upstream withnpx skills add xenotaur/Velumin. Copyright stays with the author.
AGENTS.md
Guidance for AI coding agents working on Velumin.
Mission
- Help develop Velumin as a Rust/WASM/WebGPU retro vector-graphics library for games.
- Preserve the evidence-backed project direction captured in the LRH-style
project/control plane. - Keep changes narrow, reviewable, and grounded in project evidence.
Source of Truth
- Authoritative project intent and status live under
project/. - Read these first when orienting:
project/principles/principles.mdproject/goal/project_goal.mdproject/roadmap/roadmap.mdproject/focus/current_focus.mdproject/guardrails/project/evidence/project/status/current_status.mdproject/memory/decision_log.md
- Treat
project/context/as derived summary, not as independent authority. - Keep design proposal metadata and directory buckets aligned.
Validation
- Canonical local validation from the repository root:
scripts/validate
- For ordinary task-phase validation, prefer:
scripts/version
scripts/format --check
scripts/lint
scripts/test
- Run
scripts/baselinewhen Rust/WASM/Vite browser build behavior may be affected. - Do not routinely run
scripts/developduring ordinary validation. Use it for setup/bootstrap or when explicitly debugging setup. - If validation fails because required tools are missing, report a setup/bootstrap mismatch rather than treating it as a code regression.
Development Rules
- Follow
STYLE.mdfor style guidance. - Follow
REVIEWS.mdwhen addressing PR review comments. - Do not invent roadmap commitments, API design, browser support, or release maturity.
- Preserve uncertainty markers until maintainers resolve them.
- Keep scripts thin; prefer standard Rust, wasm-pack, npm, and Vite behavior over custom logic.
- Do not add browser visual smoke, cargo-deny, dependency review, Dependabot, or supply-chain policy unless there is an explicit work item.
Current Technical Shape
- Rust crate:
webgpu_vector_lib/ - Browser harness:
webgpu_vector_lib/web/ - Canonical validation scripts:
scripts/ - Current baseline: modern
wgpu, browser WebGPU, thick vector primitives, and a prototype glow path.
