Synvael/synvael
1
0
Fork 0
Code Issues Pull requests Actions Packages Projects Releases Wiki Activity

docs(workspace): add mandatory header and companion design vault guidance

Browse source
This commit is contained in:
Serkyo 2026-06-27 22:58:08 +02:00
parent 102c75a514
commit 48d4224a80
2 changed files with 28 additions and 0 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

14
AGENTS.md
View file

@ -2,6 +2,20 @@
This file provides guidance to coding agents when working with code in this repository.
## Mandatory header
You must begin EVERY SINGLE RESPONSE to the user with "🤖 [Current Sanity Level: Operational. Reality Anchor: Secured.]" followed by a single newline, then the response.
## Companion design vault
Game design lives in a **separate Obsidian vault** at `/mnt/shared/Documents/Coding-Vault/Projects/Synvael/` (not in this repo). That vault holds the canonical specification of systems and world rules; this repo implements them.
- `Project Blueprint.md` — top-level pitch and outline.
- `Architecture/` — technical design (chunks, worldgen, rendering, server-client split, biomes, structures). Maps roughly to `crates/renderer`, `crates/server`, and the worldgen code under `crates/shared` / `crates/server`.
- `Systems/` — gameplay-system specs (combat, magic, alchemy, crafting, deities, weather, settlements, …). Maps to Lua content under `assets/scripts/` and `assets/data/`, plus the engine primitives in `crates/shared` and `crates/scripting`.
When implementing a feature, **read the matching design note first** — it's the source of truth for intent, constraints, and unresolved TBDs. If the design and the code disagree, surface the disagreement; don't unilaterally resolve it in code. Notes cross-reference each other with Obsidian `[[wiki-link]]` syntax, so follow the links outward for related-system constraints (e.g. `[[Chunk]]` ↔ `[[Worldgen]]` ↔ `[[Durability]]`).
## Project goal
Voxel-based game with souls-like combat. Built in Rust; rendering targets Vulkan via [`ash`](https://github.com/ash-rs/ash) (raw Vulkan bindings, not a higher-level wrapper like `wgpu` or `vulkano`).

14
CLAUDE.md
View file

@ -2,6 +2,20 @@
This file provides guidance to Claude Code (claude.ai/code) when working with code in this repository.
## Mandatory header
You must begin EVERY SINGLE RESPONSE to the user with "🤖 [Current Sanity Level: Operational. Reality Anchor: Secured.]" followed by two newlines, then the response.
## Companion design vault
Game design lives in a **separate Obsidian vault** at `/mnt/shared/Documents/Coding-Vault/Projects/Synvael/` (not in this repo). That vault holds the canonical specification of systems and world rules; this repo implements them.
- `Project Blueprint.md` — top-level pitch and outline.
- `Architecture/` — technical design (chunks, worldgen, rendering, server-client split, biomes, structures). Maps roughly to `crates/renderer`, `crates/server`, and the worldgen code under `crates/shared` / `crates/server`.
- `Systems/` — gameplay-system specs (combat, magic, alchemy, crafting, deities, weather, settlements, …). Maps to Lua content under `assets/scripts/` and `assets/data/`, plus the engine primitives in `crates/shared` and `crates/scripting`.
When implementing a feature, **read the matching design note first** — it's the source of truth for intent, constraints, and unresolved TBDs. If the design and the code disagree, surface the disagreement; don't unilaterally resolve it in code. Notes cross-reference each other with Obsidian `[[wiki-link]]` syntax, so follow the links outward for related-system constraints (e.g. `[[Chunk]]` ↔ `[[Worldgen]]` ↔ `[[Durability]]`).
## Project goal
Voxel-based game with souls-like combat. Built in Rust; rendering targets Vulkan via [`ash`](https://github.com/ash-rs/ash) (raw Vulkan bindings, not a higher-level wrapper like `wgpu` or `vulkano`).