Format reference

Character

A speaker in dialogues, or any person the story refers to. Nodes reference characters as speaker, and text can show a character’s name with {{ Character.<id> }}.

Schema

OSF.osf source

characters/oliver.osf

Character oliver {
  name = "Oliver Vertran"
}

compiled by osf build

characters/oliver.yaml

apiVersion: story/v1
kind: Character
data:
  id: oliver
  name: Oliver Vertran

Schema: with description

One .osf file can hold several characters. Each compiles to its own resource:

OSF.osf source

characters/characters.osf

Character protagonist {
  name        = "You"
  description = "The player character. Wakes up in the dark with no memory of how they got there."
}

Character stranger {
  name        = "Stranger"
  description = "A voice in the dark. Nobody knows who it belongs to yet."
}

compiled by osf build

characters/protagonist.yaml

apiVersion: story/v1
kind: Character
data:
  id: protagonist
  name: You
  description: The player character. Wakes up in the dark with no memory of how they got there.

characters/stranger.yaml

apiVersion: story/v1
kind: Character
data:
  id: stranger
  name: Stranger
  description: A voice in the dark. Nobody knows who it belongs to yet.

Fields

Field	Value	Required
id	After `Character` in `.osf`.	yes
`name`	Text. Translatable.	yes
`description`	Text. Translatable.	no