Narrat Config Files

Narrat uses various .yaml config files to customise the game and engine. To learn more about config files, visit the config files guide.

Available config files

Here is a list of all the currently available config files in narrat:

• common.yaml: General options
• achievements.yaml: Achievements
• animations.yaml: Animations
• audio.yaml: Audio
• buttons.yaml: Screen buttons
• characters.yaml: Characters and portraits
• choices.yaml: Choices
• items.yaml: Items
• macros.yaml: Macros
• preload.yaml: Assets preloading
• screens.yaml: Screens
• scripts.yaml: Scripts list
• skills.yaml: Skills
• skillChecks.yaml: Skill checks
• quests.yaml: Quests
• tooltips.yaml: Tooltips

Config file	Description	Example file	Type definition
common.yaml	General options	common.yaml	CommonConfigSchema
animations.yaml	Animations	animations.yaml	AnimationsConfigSchema
audio.yaml	Audio	audio.yaml	AudioConfigSchema
buttons.yaml	Screen buttons	buttons.yaml	ButtonsConfigSchema
characters.yaml	Characters and portraits	characters.yaml	CharactersConfigSchema
choices.yaml	Choices	choices.yaml	ChoicesConfigSchema
items.yaml	Items	items.yaml	ItemsConfigSchema
macros.yaml	Macros	macros.yaml	MacrosConfigSchema
preload.yaml	Assets preloading	preload.yaml	PreloadConfigSchema
screens.yaml	Screens	screens.yaml	ScreensConfigSchema
scripts.yaml	Scripts list	scripts.yaml	ScriptsConfigSchema
skills.yaml	Skills	skills.yaml	SkillsConfigSchema
skillChecks.yaml	Skill checks	skillChecks.yaml	SkillChecksConfigSchema
quests.yaml	Quests	quests.yaml	QuestsConfigSchema
tooltips.yaml	Tooltips	tooltips.yaml	TooltipsConfigSchema

common.yaml

TODO: Fill the rest of those docs with more info on each config file