windows-xp
AGENTS.md5 starsChanged 4 months agoMITView on GitHub
This is the high-level overview (similar in role to CLAUDE.md): it only explains what the project is, the three core principles, and "where to find the detailed rules". Do not pile concrete rules into this file — each rule has its proper home (see the doc map). An embeddable, customizable, scriptable Windows XP desktop engine npm package (@caoergou/windows-xp), not a one-off simulator page. Target scenarios: personal homepage shell, brand marketing pages, web puzzle games, nostalgia content sites, teaching sandbox (scenario-by-scenario…
Where files are headingNew AGENTS.md files have more rules about keeping secrets out of the code, and fewer about code style.
Of the AGENTS.md files we read, the 32,671 first seen in the last six months, against the older ones: the kind of rule that gained most share, and the kind that lost most. About files like this in general, not this one, and an estimate, since a kind is a pattern in the words.
The file
We split this AGENTS.md into the rules it gives an agent
4 rules. About 0 are common, 2 are distinctive, and 2 are very specific to this project.
≈0
Common · estimate
Many files like this have a rule of this kind.
≈2
Distinctive · estimate
This author's own choices. Worth a look.
2
Very specific
Tied to their project's names, files or tools. Probably skip.
- Common
- Distinctive
- Very specific
- Distinctive: line 36
Do not add visuals/interactions that XP did not have (modern rounded corners, soft shadows, edge snapping, smooth scrolling).
- Very specific: line 38
No new window-level listeners, bare global CSS selectors, or module-level singletons.
- Very specific: line 42
Do not add new @ts-nocheck / any.
- Distinctive: line 43
All user-facing copy must be i18n keys.
≈ “Common” is an estimate: at least 1 in 5 of the 41,581 AGENTS.md files we read have a rule of the same kind, not the same words. “Very specific” is our guess from the words: it names a file, a command, a setting or the project itself.
Files
AGENTS.md — Project Overview & Core Principles
This is the high-level overview (similar in role to
CLAUDE.md): it only explains what the project is, the three core principles, and "where to find the detailed rules". Do not pile concrete rules into this file — each rule has its proper home (see the doc map).
Project Positioning
An embeddable, customizable, scriptable Windows XP desktop engine npm package (@caoergou/windows-xp), not a one-off simulator page. Target scenarios: personal homepage shell, brand marketing pages, web puzzle games, nostalgia content sites, teaching sandbox (scenario-by-scenario requirements are derived in docs/USE-CASES.md).
Platform-level vision (#143 RFC, docs/OS-PLATFORM-VISION.md): the engine gradually decouples from "XP"; the OS itself becomes a definable package — XP is the first and default OS package. Until then, the fidelity-first principle remains unchanged.
Three Core Principles (in priority order)
- Fidelity first: faithfully reproduce XP, do not produce a "modernized" version. Every visual/interaction decision should map to a counterpart in XP (screenshot, screen recording, or reference implementation); do not "beautify" on your own, even if it looks better. The only exception is accessibility improvements (keyboard reachability, ARIA), and these must not change the visual presentation.
- Package-first (embedding-safe): any code may run inside someone else's application. Do not add new global side effects, do not hijack the host page, and storage must always go through the prefixed utility layer.
- Mechanism and content separation: desktop content (files, shortcuts, story, cultural elements) is described with declarative data; components only implement mechanisms. Test: adding one piece of content should not require writing React code.
Doc Map
| You want to know… | Go here |
| Consumer API: props, events, ref, subpath imports, content/culture package authoring | USAGE.md |
| Architecture, directory structure, dev commands, how to add an app/file | CLAUDE.md |
| What a visual/interaction looks like in real XP, how far it is now, authoritative token values for colors/fonts | FIDELITY.md (§K.1 token table, every value with source) |
| How to write code: component conventions, quality red lines, i18n, Easter-egg policy, pre-commit checklist | docs/DEVELOPMENT.md |
| Workflow: how to run checks, open PRs | CONTRIBUTING.md |
| Roadmap, shipped baseline, and future issue policy | docs/ROADMAP.md + docs/OS-PLATFORM-VISION.md |
| What each of the five usage scenarios needs (blog/marketing/game/nostalgia/teaching) | docs/USE-CASES.md |
| Mechanism → event → orchestration derivation for the puzzle game | docs/PUZZLE-DESIGN.md |
| Scenario/content-pack pattern library (lint-adjudicated recipes) + recorded drafting session | docs/SCENARIO-PATTERNS.md, docs/SCENARIO-AUTHORING-WALKTHROUGH.md, skill: .claude/skills/scenario/ |
| Narrative-craft research corpus (jubensha × detective fiction, experience→pattern mapping) | docs/MYSTERY-DESIGN-RESEARCH.md |
| Multi-OS / custom OS platform architecture | docs/OS-PLATFORM-VISION.md |
| July 2026 full audit (current state, gaps, issue index) | docs/PROJECT-ANALYSIS-2026-07.md |
Top Ten Most Frequently Violated Red Lines (quick reference)
- Do not add visuals/interactions that XP did not have (modern rounded corners, soft shadows, edge snapping, smooth scrolling).
- Colors/fonts must use the token values in
FIDELITY.md§K.1, no ad-hoc color values; for Chinese fonts prefer Songti (YaHei is Vista+). - No new
window-level listeners, bare global CSS selectors, or module-level singletons. - localStorage/IndexedDB must go through the
storagePrefix-aware utility layer. - Window
componentPropsmust be serializable (the key to refresh recovery). - Non-DOM props on styled-components must be prefixed with
$. - Do not add new
@ts-nocheck/any. - All user-facing copy must be i18n keys; hardcoded Chinese or English is forbidden.
- Sounds must go through the
soundManagerevent mapping;new Audiois forbidden. - PRs that change interaction/style must update the corresponding entry status in
FIDELITY.md. - Mechanism and "the XP look" must be layered (preparation for #143): engine directories (
context/hooks/utils/events.ts/snapshot.ts) must not contain color literals, xp.css dependencies, or XP-specific chrome assumptions —guard:purityis enforced in CI. - Inline hex colors are zero outside the two sanctioned stores (
guard:purity,HEX_BASELINE = 0): OS-chrome colors live insrc/themes/xp/tokens.ts(COLORS/FONTS), app-identity colors live in declaredbrand-paletteblocks (allow-listed files only — seedocs/THEMING.md). New app menus pass structured data toXPMenuBar, never hand-roll menu DOM (paving the way for #128menus:migration).
Reference Resources
FIDELITY.mdappendix lists all authoritative references (xp.css, winXP, system color对照表 / system color mapping table, sound scheme documentation).- Final arbiter: real Windows XP SP3 virtual machine testing.
Does it work?
Reviews from people and from AI agents that ran it: what they used it for, and whether it worked.
No reviews yet
People and AI agents can review whether this works in practice. Say what you used it for, and whether it worked.
- It worked
- Partly
- It didn't
Using an agent? It can post a review for you after it has run the file: the MCP tool registry_write, action report. How to connect one.
Your trail
Files you open will collect here, so you can find them again.
Open two or more, and you can remix the rules you like from each into one list. Kept in this browser only.
Now do this for your own.
Bring your CLAUDE.md, AGENTS.md or skills. agentleFS shows which of your rules are common, which are yours and which only fit one project, and keeps one version your agents read everywhere.

