The blocks come from craft-contrib at dde09ea31e2e457f5b4653a6e76f7cdf55944bdf. CLAUDE.md imports AGENTS.md. The house-rules workflow checks the copy.
17 KiB
House rules
These apply in every Craft repository. A later rule may be stricter, not weaker. The source is standards/house-rules-core.md in storytold/craft-contrib. Propose changes there, not in a copy.
- A person is accountable. Whoever runs an agent answers for what it opens and for its review comments.
- Check, then claim. Before writing code, read the issue comments, search pull requests for
#Nand the keywords, and check recent commits onmain. Comment on the issue first. Release a claim you will not finish. - Verify, don't guess. Open a definition before using it. Confirm the cause in the code, even when someone names a location.
- Keep fixes narrow and tested. Fix what the issue describes, where the bug is. Add a test that fails without the fix.
- Review the diff before opening a pull request. Identifiers exist as used, the test fails without the fix, nothing unrelated changed, and the description is true.
- Look for a better pull request. If another fixes the same thing, close yours when it is better or equal, and say why.
- Report only what ran. Say what you tested and what you could not run. Without a local build or test, say so and rely on CI before marking ready.
mainchanges through a pull request. Do not push to it. Branch protection enforces this. There is no exception.- Stop and ask only about licensing outside the allowlist, publishing, releases, a new remote, secrets, spending money, destructive git, and anything else hard to undo. Otherwise keep working.
plan/is a gitignored notebook, not rules. Without it, do not ask for it and do not stop. - Keep secrets and personal details out of the repository, logs and requests.
- CI stays shared. Workflows call
storytold/craft-common-actions. Do not change CI in a feature or fix pull request. If CI cannot cover a change, open an issue there. - Guards say why. A check that looks removable says what it prevents. Read that before changing it.
- Instructions must be readable by everyone. No notes about one machine, and no links to files a reader cannot open.
craftrulesis retired. Do not link to it. - Keep pull requests moving. Concurrent pull requests are fine; unanswered actionable feedback is not. Respond in 7 days, a reminder at 14, closure eligible at 30, from when an actionable request waits on the author. Suggestions and unconfirmed bot findings do not start the clock. A fix, explanation or agreed plan resets it; unrelated activity does not. Waiting on a reviewer or maintainer pauses it and does not count against the author. A maintainer decides closure; it is never automatic. Reuse search results, do not poll, and stop at a rate limit.
- No agent attribution. A pull request does not say an agent wrote it. A repository rule may not require that.
Rust Craft repositories
These apply to native Craft apps and to shared Rust libraries. Select them by repository type. A repository that merely contains some Rust does not take this block. Rules later in a repository's file may be stricter, but not weaker. The source is standards/house-rules-rust.md in storytold/craft-contrib.
- Never crash. Non-test code does not panic and has no
unsafe, except where the repository file names an exception. Return errors, treat input as hostile, and bound recursion and allocations. New production crate roots copy thedenyattribute from an existing crate:clippy::unwrap_used,clippy::expect_used,clippy::panic,clippy::unimplemented,clippy::todo,clippy::unreachable. Every crash fix comes with a test that panicked before the fix. - Clean room. Learn from observed behaviour and public specifications. Do not copy another product's code, assets, strings or artwork. Check a dependency's licence before adding it.
- Assets and fonts. Every asset is original or suitably licensed, and is recorded in
ATTRIBUTION.mdin the same change. Font files live in storytold/craft-fonts, not in the app repository. - Rust only for native Craft apps. No handwritten JavaScript or TypeScript, and no Tauri, Electron or webview shell, in those apps. Shared tooling follows its documented technical scope and maintainer-approved exceptions. Craft PR Review's existing Tauri and TypeScript UI is one such exception. It does not relax this rule for native apps. Preserve any existing web build.
- Time goes through
chrono. Do not hand-roll calendar conversion. For dates beyond whatchronocan represent, follow standards/time.md. - Contributor credits. Add or edit only your own person's entry in
contributors/people.toml, and only after asking them. Never guess a name or hand-editcontributors.json.
Licence allowlist
Dependencies and assets use SPDX identifiers. An expression is allowed when every identifier is in this list. A repository may name a shorter list. It may not add an identifier here by editing its own copy of these rules.
ISCMITBSD-2-ClauseBSD-3-ClauseApache-2.0OFL-1.1Ubuntu-font-1.0Bitstream-VeraCC0-1.0CC-BY-4.0CC-BY-SA-4.0LicenseRef-Public-Domain
LicenseRef-Storyteller-Trademark is not in this list. It covers Storyteller brand marks only, where a repository already says so.
AGENTS.md: guide for AI agents and contributors
MaterialCraft is an open-source, native node-based procedural material designer: a clean-room implementation of the workflow professional material artists know from industry-standard node graph tools, written in Rust only (no JavaScript or TypeScript). No Tauri, Electron or webview shells: the desktop app is native egui/eframe on wgpu, and the web build is the same Rust compiled to WebAssembly (trunk + wasm-bindgen). Never add Tauri (or any webview/JS UI framework) as a dependency, build step or packaging target.
The product name is always written MaterialCraft ({Function}Craft in PascalCase, like its
siblings PhotoCraft, VectorCraft, FilmCraft, LightCraft, PdfCraft, EffectCraft, DesignCraft,
TextureCraft) in user-facing text: UI, window titles, About, installers, release names, docs prose.
Machine names stay lowercase: crates (materialcraft-*), binaries, file names, ids
(ai.storyteller.materialcraft). The project format is SBS (.sbs). Legacy package compatibility is not required.
Shared code goes only in craft-libs; otherwise copy, don't depend. TextureCraft is the sibling this repository's infrastructure (xtask, automation, packaging, docking, theme) was copied from.
The goal is full parity with the professional node-based material workflow (the same panels,
menus, node library, parameters, shortcuts and file conventions) with better performance, every
feature drivable by agents, and builds for Windows, macOS, Linux, FreeBSD and the web. Read this
file first, then docs/.
1. Orientation (5 minutes)
| Read | Why |
|---|---|
docs/architecture.md |
Crate map, layers, the CPU cook engine and cache, data flow |
docs/control-protocol.md |
The JSON control channel, synthetic input and MCP: how agents drive the app |
ROADMAP.md |
Honest parity estimate, milestones, current focus |
docs/target-app-parity.md |
The parity assessment by area |
docs/gaps.md |
Every known shortfall, ranked: the work list |
ATTRIBUTION.md |
Every bundled asset with author, source, license |
2. Workspace map
crates/
core image geom L0 document model (package, graphs, nodes, values, function graphs); float images; meshes, BVH, camera
nodes L1 the node library: native primitive definitions + CPU cooks, function evaluator and pattern graphs
eval formats L2 graph cooking (topological order, sizes, content-addressed cache, sub-graphs); native .sbs packages, bitmaps, texture export
engine render L3 Session + command registry (every action is a command), inspect, samples; the 3D preview renderer (CPU PBR + IBL)
automation L4 MCP server + headless JSON-lines RPC + bridge to the running app
ui-egui L5 egui shell (thin: every edit goes through engine commands)
apps/
materialcraft desktop app (eframe/wgpu), `--control <port>` loopback control server
materialcraft-cli headless CLI (info, run, batch, new, cook, export, render, nodes, commands, mcp, serve)
materialcraft-web the same app in the browser (trunk + wasm-bindgen)
xtask/ cargo xtask layers | wasm | ci | version | ico | icns
Layering is enforced by cargo xtask layers: a crate may depend only on lower layers. Nothing
below ui-egui may use egui, eframe, winit or rfd; only render, ui-egui and the apps may use
wgpu. A new crate must be registered in xtask/src/layers.rs.
The UI crate is swappable. materialcraft-ui-egui holds no document logic: it calls engine
commands (materialcraft_engine::execute). Another front end could replace it without touching
the engine.
3. Golden rules
Never name the reference product (absolutely essential)
- The repository never names the commercial product MaterialCraft is modeled on, nor its vendor, in code, comments, docs, commit messages, test names, file names or UI text. Say "the reference app", "the professional node-based material workflow" or describe the feature itself.
- Notes that name it may live only in the gitignored
plan/folder.
Assets, icons and images (absolutely essential)
- Never use any icon, image, logo, texture, material, sample graph, preset, environment, font or other asset from Adobe, Avid, Figma, Autodesk or any other commercial product, and never copy files from an installed commercial application (its package files, compiled material archives, presets, sample graphs, HDR environments, UI icons). Not as reference files in the repo either.
- Every image or icon must be open source, public domain, Creative Commons (CC0/CC-BY), or original (made by a contributor who has the right to license it). Prefer generating content in code: MaterialCraft's noises, patterns, sample materials, environments, library previews and template thumbnails are all procedural.
- Every bundled asset gets a row in
ATTRIBUTION.md(path, title, author, source, license) in the same change that adds it, plus its license file next to it when the license requires one. Assets compiled in through dependencies (icon fonts, default fonts) get a row too. No row, no merge. - Demo images and README screenshots show MaterialCraft rendering original procedural content only. Never personal photos.
- The ArtCraft logos in
docs/brand/are not open source (docs/brand/LICENSE-brand.txt). - Fonts live in storytold/craft-fonts; never commit font files here.
Clean room
MaterialCraft is an independent, clean-room implementation of a node-based procedural material
workflow. Work from public documentation, general domain knowledge and public algorithms (Perlin
and simplex gradient noise, Worley/cellular noise, fractal sums, Gaussian and box blurs,
Felzenszwalb–Huttenlocher distance transforms, Sobel/central-difference normals, reoriented normal
mapping, HSL, levels, monotone cubic curves, W3C blend modes, GGX/Smith/Schlick PBR, split-sum IBL,
ACES fitted tone mapping). Never copy proprietary code, shaders, node implementations or presets.
SBS packages are the main project format (issue #49): crates/formats/src/sbs/ reads and writes
them with MaterialCraft's own code, written from the format's public documentation and sample
files, never from another implementation. Always describe MaterialCraft as a clean-room
implementation, in code, docs and commits.
Never crash (outranks feature work)
People trust MaterialCraft with hours of work. A malformed package, a hostile command or MCP parameter, an odd keystroke or a full disk must produce an error the user or agent can act on, never a panic.
- Non-test code never panics: no
unwrap(),expect(),panic!,unreachable!,todo!orunimplemented!. Every production crate root carries#![deny(clippy::unwrap_used, clippy::expect_used, clippy::panic, clippy::unimplemented, clippy::todo, clippy::unreachable)]. - No
unsafe(unsafe_code = "forbid"for the workspace). - Input-derived numbers are hostile:
get()instead of[i], checked/saturating arithmetic, caps on allocations (image sizes are clamped to 8192, zip entries capped), NaN guards. - Every crash fix comes with a regression test. The engine's
panic_hunttest runs every command with hostile params, and the node library'severy_node_cookstest cooks every node with no inputs and with odd-sized inputs; keep both green.
Architecture rules
- Everything is a command. New user-visible behaviour = a command in the engine
(
crates/engine/src/*_cmds.rs, registered incommands.rs) with id, label, menu path, shortcut, params doc,enabledandrun, plus tests. The menus, shortcuts, CLI, control channel and MCP all dispatch commands by id. Menu items come from the catalog incrates/ui-egui/src/menus.rs. - Every node is a catalog entry. A new node is a
NodeDef(ports, parameters with defaults and ranges, library category, description) and a pure cook function incrates/nodes. It tiles (whole-number lattice scales), works at any size, scales pixel-based parameters byw / 256, and needs no new UI code: the library, the properties panel and the search pick it up. - Programmatic calls never open dialogs. A command run through the control channel or MCP runs
with defaults; only
ui.menu.invokebehaves like a menu click. - Inspect shows the agent's work.
session.inspectmust reveal every node, parameter, wire, cook error, size and mean value an agent changed. - CPU oracle first. Nodes cook on the CPU (rayon) through a content-addressed cache, so every node is testable and identical in the app, the CLI, MCP and the browser. Any GPU acceleration must match the CPU cook in parity tests.
- Undo is snapshots.
Session::editclones the package and restores it on error, so every command is atomic;edit_mergedfolds a slider drag into one step. - Never break wasm. L0–L5 must
cargo check --target wasm32-unknown-unknown(cargo xtask wasm). File-system code iscfg(not(target_arch = "wasm32"))with byte-based alternatives. - Performance is a feature. Edits re-cook only what lies downstream (the cache). Cooking runs on a worker thread; the UI never blocks on it. Benchmark heavy nodes in release.
- Cross-app formats are shared conventions.
.mcmatportable materials are read by TextureCraft with its own code: keepdocs/control-protocol.md§ Portable materials, the usage ids and the mesh-map input identifiers in step with TextureCraft, bump the manifestversionfor incompatible changes, and never make one app depend on the other's crates. - Verify UI changes visually.
MC_SNAPSHOT_DIR=<dir> cargo test -p materialcraft-ui-egui --release --test snapshot -- --ignoredrenders the real UI offscreen; look at the PNGs.
4. Picking work
ROADMAP.md→ Current focus and the parity table.docs/gaps.md→ the ranked list of shortfalls.- Render snapshots of MaterialCraft and fix the biggest visible gaps in the workflow.
log/devlog.md(local) → the "Still open" bullets of recent entries.
5. Before you finish a task
cargo fmt --all
cargo test -p <crates you touched> --release
cargo clippy --workspace --all-targets -- -D warnings
cargo xtask layers
cargo xtask wasm # if you touched L0–L5
cargo test -p materialcraft-engine --release --test session panic_hunt # if you added/changed commands
Then append a terse entry to log/devlog.md (what landed, numbers, what's still open). Commit
after every arc of work that builds and passes.
6. Parallel agents
- Use your own target dir (
CARGO_TARGET_DIR=target/agent-<name>) and edit only the files you own. Shared files (engine/src/commands.rs,nodes/src/catalog.rs,ui-egui/src/menus.rs,ui-egui/src/lib.rs, the rootCargo.toml) get small, surgical edits; re-read before editing. - Put new commands in a new module with its own
specs()registered by one line, and new nodes in the module of their library category. - Delete your
target/agent-*dir when done.
7. Where things are tracked
ROADMAP.md: milestones, parity estimate and remaining effort.docs/target-app-parity.mdanddocs/gaps.md: the assessment and the work list.docs/releasing.md: release builds and signing.plan/is an optional gitignored notebook (execution notes). Do not ask for it and do not stop when it is absent.log/(local, gitignored): the dev log.