See also: Documentation Hub, Build, Deployment, and Release, Type Catalog
Everything you need to author content in assets/content/ — without reading the
compiler.
A content note is a markdown file with YAML frontmatter. The build turns it into a Foundry document: an Item, an Actor, a Scene, a Macro, or a JournalEntry. Nothing about that document is authored as Foundry data — the note carries the essence of the thing, and the compiler supplies the rest.
This section is for the person writing those notes. It is not about the system’s runtime; if you are changing how a document behaves, you want System Development instead.
Start here
- The Authoring Workflow — where content lives, the frontmatter every note carries whatever its type, and how a note becomes a compendium document. Read this first.
You do not declare a note’s package. It is the repository’s configured
contentPackage, and every note in this tree belongs to it. The field a note used to carry was a selector, and a value matching nothing skipped the note in silence; it is retired, and declaring it is now a build error. See The package is the repository’s, not the note’s.
Per-type references
What frontmatter each kind of note accepts.
- Item Note Frontmatter — the generated per-type field
reference for all 13 item types: every
sohl:field, its shape, whether it is required, and what it defaults to. - Actor Notes — authoring a
being, and the(type, shortcode)address space its embedded items are resolved through. - Map Notes — authoring a Foundry Scene as a markdown note: the
battlemap/localmap/regionalmapschema, the two unit conventions, regions and their behaviours, and how a map is packaged. - Authoring a Macro Content Note — how a
type: macronote compiles into a Foundry Macro plus its documentation, and what the{#script}anchor does.
Conventions
Rules that apply across every note type.
- Linking Between Content Notes — wikilinks: the four forms, and why an item and its documentation need two different addresses.
- Asset Conventions — where art files live, how
img:resolves to a shipped path, image formats, and what makes an SVG themeable. - Generated Content Tables — Dataview
TABLEqueries that tabulate content notes from their frontmatter.
Also relevant, filed elsewhere
These are system-facing references rather than authoring guides, but a content author reaches for them often enough to be worth naming here.
- Shortcode Integrity — a type and a shortcode together are a logical identity, not a lookup convenience. The uniqueness rule, the shape rule, and why renaming a shortcode is expensive.
- The Link Manifest — how one package’s notes address another package’s documents.
- Type Catalog — the generated list of every Actor and Item type the system defines, with one line each.