The scriptr.markdown/1 format
For developers: the structure of Scriptr’s agent-ready Markdown, its stable IDs and its versioning rules.
scriptr.markdown/1 is a UTF-8 Markdown hand-off format. It is stable: consumers can rely on it.
Front matter
Each file starts with YAML front matter:
| Key | Meaning |
|---|---|
schema | Always scriptr.markdown/1. |
document_kind | script or story. |
title | The document title. |
snapshot_revision | The saved revision the file was taken from. |
snapshot_hash | A hash of that revision. |
round_trip | false: importing the file back is not promised to be lossless. |
author | Present only when an author is set and the export isn’t anonymous. |
rights_notice | The rights notice chosen in Export. |
Structure
- Scenes and chapters carry stable IDs in HTML comments:
<!-- scriptr:scene … -->and<!-- scriptr:chapter … -->. - In scripts, each element is marked with a
scriptr:elementcomment whose value isaction,character,parenthetical,dialogueortransition. - Order follows the document. IDs come from the document itself, never from display numbers, so they survive reordering.
What isn’t included
Act labels, comments, provenance, Co-writer conversations and notes. Characters and places aren’t expanded unless the writer includes them.
Rules for consumers
- Ignore keys you don’t recognise.
- Breaking changes will use a new schema name,
scriptr.markdown/2. - IDs are identifiers, not URLs or access tokens. They grant no access to anything.
Last updated