yume: Instructions file for Claude Code

CLAUDE.md

yume CLAUDE.md is an instructions file for Claude Code from kamwoh/yume. It costs 4,552 tokens per session, scanned A, original, MIT.

Project instructions for Yume, a Godot game framework where game content and rules are defined in JSON instead of custom GDScript for each game. Godot is a game engine.

In plain words
What is it for?
Use them to turn a game idea into a design and JSON data, generate a local demo, run it, and capture it for visual checks.
Why use it?
They explain the framework's structure, how its fixed game actions and update cycle work, and how to generate and run games.

Instructions file for Claude Code

Written for Claude Code: the file is CLAUDE.md. Also seen: reads .claude/ paths; mentions CLAUDE.md; mentions Claude Code.

This is kamwoh/yume's own configuration. It tells Claude Code how to work on yume itself, so it is not a mod to install elsewhere. Copy it as a starting point and replace the rules that are about this project. Everything yume configures →

View source ↗ kamwoh/yume
Reuse

Borrowing it

Nothing to install: this file belongs to kamwoh/yume. Take a copy, put it at the same path in your own repository, and replace the rules that are about this project with yours.

Copy the file
curl -O https://raw.githubusercontent.com/kamwoh/yume/dev/CLAUDE.md
Clone the repo
git clone --depth 1 https://github.com/kamwoh/yume

Made for: Claude Code.

Wrote this? Show the measurements

A badge with what this costs and how it scanned, read live from this page, so it follows the numbers instead of freezing them. Markdown for a README, HTML for a documentation site or a project page.

agentmods badge for yume CLAUDE.md

README.md
[![agentmods](https://agentmods.dev/badge/instructions/kamwoh/yume/claude-md/github.svg)](https://agentmods.dev/instructions/kamwoh/yume/claude-md)
Your own site
<a href="https://agentmods.dev/instructions/kamwoh/yume/claude-md"><img src="https://agentmods.dev/badge/instructions/kamwoh/yume/claude-md/github.svg" alt="Measured on agentmods" height="20"></a>

Or the 80×15 button, for a site that already has a row of RSS and ATOM ones. Only the verdict fits; the numbers stay here.

agentmods 80×15 button for yume CLAUDE.md

Your own site · 80×15
<a href="https://agentmods.dev/instructions/kamwoh/yume/claude-md"><img src="https://agentmods.dev/badge/instructions/kamwoh/yume/claude-md.svg" alt="Reviewed on agentmods" width="80" height="20"></a>
Per session 4,552 This file is loaded in full into every session.
When invoked 4,552 The same file — it is already loaded in full.
Security scan A 0 findings. A grade says what 26 rules found in the file — not that it is safe.
Origin original No closer match found in the catalogue.
Token cost

What it costs to keep this loaded

Counted locally with the o200k_base tokenizer, which is exact for GPT models; Claude uses its own tokenizer and its counts differ. Treat this as one consistent yardstick across the catalogue rather than a bill. Prices are per million input tokens.

ModelPer sessionOnce invoked
Fable 5.1 $0.04552 $0.04552
Opus 5.5 $0.01821 $0.01821
Sonnet 5.5 $0.00910 $0.00910
Haiku 4.5 $0.00455 $0.00455

Measured 9d ago against content hash 365895b61cd8, method: parsed. Prices are Anthropic first-party input rates as of 2026-10-07, from the pricing page.

Security

Grade A, and why

yume CLAUDE.md scanned grade A with 0 findings against 26 rules in 11 categories — prompt injection, anti-refusal, data exfiltration, privilege escalation, supply chain, agent snooping, system-prompt leakage, SSRF and excessive agency — measured 9d ago.

A static scan of the body, not an audit. Every finding is printed with the line that produced it so you can judge whether it matters here. A mod is markdown that instructs an agent; that is exactly why what it instructs is worth reading.

Nothing flagged

None of the 26 patterns this scan looks for appear in this file: no shell pipes, no recursive deletes, no credential paths, no hidden text, no instruction-override or anti-refusal phrasing, no agent-config snooping. That is not a guarantee, it is the absence of the things that are checkable.

CLAUDE.md · 321 lines

How it starts

The opening of the file, as written. The whole thing — 321 lines — stays where its author put it; the contents beside it link to each section on GitHub.

Yume (夢) — JSON-driven game framework on Godot

You are working on Yume: a JSON-declarative content layer over Godot 4.6.1 that lets non-programmers (and LLMs) generate working games without writing GDScript per-game. Per ADR 0021, the engine ships a fixed verb set (the "seven primitives" + a small interpreter); each game's mechanics are pure JSON.

Quick Start

This repo ships the framework (engine, skills, scaffolding scenes, shared engine libraries). It does NOT ship game demos. Demos live at godot/data/demo_<name>/ and are gitignored.

/yume-design "<prose pitch>" [--scene] [--with-assets] [--style=] [--name=<slug>] [--autonomous]
./scripts/play.sh <name>            # run a demo (falls back to scenes/play.tscn --game=<name>)
./scripts/play.sh <name> --capture  # auto-capture for visual QA

/yume-design is the single entry point (ADR 0067). It composes a game from three layers with disjoint file ownership: World (--scene, compose_world), Game (always, the game skills), and Assets (--with-assets, yume_assetgen). A flag whose API key is missing degrades to the key-free code-drawn game. The layer/file ownership table lives in the yume-design skill.

Do NOT run /yume-create-scene on a /yume-design game folder. Its shell overwrites the game's mechanics. Use /yume-design --scene to get a world for a game.

Framework structure

yume/
├── .claude/                            ← Skills + rules + settings
│   ├── skills/yume-*/SKILL.md          (40 specialist skills, Tier 2.6)
│   └── rules/                          (path-scoped invariants)
├── godot/    ← Godot project (engine + scaffolding; demos gitignored)
│   ├── data/                           ← shared engine libraries (TRACKED)
│   │   ├── shapes.json                 (code-draw shape library)
│   │   ├── meshes.json                 (3D mesh library)
│   │   └── sounds.json                 (procedural SFX library)
│   ├── data/demo_<name>/               (per-game content — NOT TRACKED, gitignored)
│   │   ├── entities/                   (definitions + initial instances)
│   │   ├── world/rules/*.json          (ALL rules — globbed + merged; ADR 0009 rev 2026-05-16)
│   │   │                               (legacy single-file `world/rules.json` +
│   │   │                                `game/goals.json` still load — 2 demos use them —
│   │   │                                but the directory form is canonical for new games)
│   │   ├── game/flow.json              (multi-level progression — ADR 0006)
│   │   ├── levels/<n>/                 (per-level entities + rules)
│   │   ├── world/state.json            (initial _engine entity state — ADR 0047)
│   │   ├── world/zones.json            (zone-state primitive — ADR 0031, optional)
│   │   ├── audio/cues.json             (semantic-event → SFX mapping)
│   │   ├── ui/strings.json             (localizable text)
│   │   ├── scene.json                  (camera + lighting + ground + tick_seconds)
│   │   ├── screens.json                (title/pause/etc. — ADR 0011, optional)
│   │   ├── save_policy.json            (what persists — ADR 0010, optional)
│   │   ├── settings_schema.json        (settings — ADR 0013, optional)
│   │   └── tutorial.json               (overlay sequencing — ADR 0012, optional)
│   ├── scripts/engine/                 (engine: rule, query, effect, scheduler, etc.)
│   ├── scenes/                         (TRACKED scaffolding only)
│   │   ├── play.tscn                   (universal launcher — `--game=<name>`)
│   │   ├── test_main.tscn              (engine unit tests)
│   │   └── scenario_test.tscn          (per-game scenario test runner)
│   └── project.godot
├── docs/                               ← Documentation (active)
│   ├── guideline/                      (30 contract · 31 pipeline plan · 32 MDA · 33 architecture)
│   ├── adr/NNNN-*.md                   (architecture decisions)
│   ├── engine-reference/               (api manifest, Godot pinning)
│   ├── games/<name>/                   (per-game GDDs, plans, reviews)
│   └── timeline/                       (decision diary)
├── scripts/play.sh                     ← Run a demo (sync + launch)
├── tools/gen_api_manifest.py           ← Regenerate engine API manifest
└── CLAUDE.md (this file)

(Planning workspace — `task_plan.md`, `.claude/plan/{backlog,archive}.md`,
`docs/`-bound design notes — is the author's LOCAL, gitignored scratch; not
in a fresh clone. The framework's shared config lives in CLAUDE.md +
`.claude/rules/` + `.claude/skills/`.)

Read the full file on GitHub · 321 lines

Changes

What this file has done since we first saw it

Hashed on every crawl. A supply-chain change to an agent config is a question of when, not whether, so the history is kept rather than the latest state alone.

  1. 9d ago Changed · +7 tokens per session 365895b61cd8
  2. 10d ago Changed · +16 lines · +234 tokens per session a89b87ea1d4f
  3. 12d ago Changed · -105 lines · -1,206 tokens per session 1d589487eeb0
  4. 1mo ago First seen · 410 lines · 5,517 tokens per session scan A f638832c484e

Subscribe to this mod's changes

yume CLAUDE.md is an instructions file published in the GitHub repository kamwoh/yume (25 stars, last pushed 10d ago), licensed MIT. It adds 4,552 tokens to every session, about $0.0182 per session on Opus 5.5. A static security scan graded it A with 0 findings. No closer match exists in the catalogue, so it is treated as the original; first seen 2026-08-30.

Related

Other instructions, from other repositories

vscode buildNext.instructions.md

Working notes and architecture documentation for the new esbuild-based build system in build/next. Use when making changes to the new build pipeline (transpile/bundle commands, NLS plugin, source-map handling, resource copying, or self-hosting watch tasks).

microsoft/vscode · 9,715 tokens

next.js AGENTS.md

AGENTS.md instructions for vercel/next.js, covering next.js development guide, codebase structure, monorepo overview, core package: packages/next and other important packages.

vercel/next.js · 7,461 tokens

vscode oss-third-party-notices.instructions.md

Instructions for microsoft/vscode, covering vs code oss third-party-notices pipeline, architecture, pipeline flow in ci, cache eligibility and rollout and applying the notice (cutover).

microsoft/vscode · 5,262 tokens

langchain AGENTS.md

AGENTS.md instructions for langchain-ai/langchain, covering global development guidelines for the langchain monorepo, corridor security analysis, project architecture and context, monorepo structure and development tools & commands.

langchain-ai/langchain · 4,680 tokens

vscode copilot-instructions.md

Copilot instructions for microsoft/vscode, covering vs code copilot instructions, project overview, root folders, core architecture (src/ folder) and built-in extensions (extensions/ folder).

microsoft/vscode · 2,731 tokens

deepseek-harness AGENTS.md

AGENTS.md instructions for deepseek-ai/deepseek-harness, covering agents.md, pre-stable apis and released session data, repository layout, commands and host sandbox failures.

deepseek-ai/deepseek-harness · 4,261 tokens