Get started

iUsing a coding agent? Start here

Canwu ships two skills for coding agents. Ask your agent to load them before it writes code:canwu-engine-docs and canwu-engine-usage. Then start with the Get started and the relevant runnable example, and use the guides as needed.

Starter prompt

Load the canwu-engine-docs and canwu-engine-usage skills. Read the Canwu tutorial, guide page, and example that match this task. Use only canwu-api, state the rule you must preserve before you edit, and run the example or a focused check when you are done.

Start with Move an army. It takes a few minutes, runs on any machine with Rust 1.88 or newer, and shows the whole cycle: submit a command, advance time, then save, fork, and replay the run. Come back to the other tutorials when you need the feature they cover.

How these docs are organized

Section	Use it when	Start with
Get started	You are new to Canwu and want to run something first	Move an army
Tutorials	You want to learn the engine’s core features one at a time	Continuous-time game loop
Guides	You are adding Canwu to your own application and have a specific task	Integrate and drive the simulation
Engine architecture	You want to know how commands are settled, recorded, and replayed	Architecture overview
Domain systems	You need rules for knowledge, resources, movement, war, technology, taxes, or society	Domain systems
Case studies	You want to see several systems work together in one scenario	Case studies
Reference	You need the standard English or Chinese term for a concept	Canwu terminology

Tutorials

These tutorials use only canwu-api; Move an army also uses the reference world. Your application still chooses its renderer, window, input, and game framework.

Move an army: reference integration starterQueue a movement command, advance time, then save, load, fork, and replay the run.

Continuous-time game loopDrive the engine from a real-time game loop and get the same results at any frame rate.

Command pluginAdd your own command: validate its payload, check who may issue it, and declare the state it reads and writes.

Phased boundary and allocationOne plugin offers grain, another requests it in the same boundary, and a later phase reads the settled allocation.

Domain systems

Domain systems supply concrete rules for knowledge, resources, war, taxes, and more; most are optional crates you register as needed. Three of them also have a walkthrough, and their design pages are Routing, transport, and movement, Military, and Technology.

Domain systemsDesign pages for the eight domain systems and the crates that provide them.

Route planning and delivery executionFollow a letter from Wuxi to Beijing: plan the fastest route from what one observer knows, then record each leg, handoff, and reroute.

Run the military extension: from contact to occupationCreate forces, march into contact, resolve a battle, and establish an occupation with the optional military extension.

Invention, use, and technology diffusionFollow one technique from a workshop trial to installation, adoption for one use, and an apprenticeship that can spread it.

Case studies

Case studies combine several systems into one runnable historical scenario.

Grain, production, and military supplyRun a synthetic grain loop, then look at source-cited Songjiang and Hanyeping examples of production, resources, and military logistics.

A warlord asks a neighbor for military aidA warlord decides whether to send troops. Shows decision tickets, options, a utility policy, and exact replay of the choice.

Local community diffusion and institutional responseAn idea spreads through a local community and a council responds through a decision ticket. Shows population cohorts, social influence, and an observer's estimate.

Confidential copy and targeted releaseA relay copies a document in transit, releases the copy to two readers, then withdraws it: later reads are refused and earlier reads stay on record.

Encoded transfer and in-path interceptionA relay copies a coded message but cannot decode it; the recipient has a delegate decode it. Keeps holding, reading, and understanding apart.

Routed correspondence from WuxiSend one letter from Wuxi to a local address and to Beijing, with each route planned from what the sender knows and each leg recorded.

All case studiesBrowse every scenario.

More resources

GuidesTask-by-task guidance for integrating, reading state, saving, and writing plugins.

Example source on GitHubThe Rust source of every example, in the crates that provide them.