Narrat Documentation

Appearance

On this page

Example Config ​

Those example config files are the ones used in the narrat demo. For the most up to date versions, visit the GitHub links.

TIP

This folder on GitHub contains all the config files used in the narrat demo and can serve as a good up to date example of every possible config file.

Game Config ​

INFO

See the most up to date config directly on GitHub

Example game config.yaml
yaml
---
gameTitle: Narrat Default
saveFileName: Narrat Default
images:
  narrat: img/backgrounds/narrat.webp
  map: img/backgrounds/map.webp
  shopButton: img/ui/shop-button.webp
  parkButton: img/ui/park-button.webp
dialoguePanel:
  textSpeed: 30
  animateText: true
  timeBetweenLines: 100
layout:
  dialogPanel:
    overlayMode: true
    rightOffset: 100
    bottomOffset: 50
    width: 475
    height: 680
  backgrounds:
    # Default was 880 x 720
    width: 1280
    height: 720
  dialogBottomPadding: '2rem'
  mobileDialogHeightPercentage: 60
  verticalLayoutThreshold: 600
  portraits:
    width: 150
    height: 225
    offset:
      landscape:
        right: 10
        bottom: 0
      portrait:
        right: 10
        bottom: 0
saves:
  mode: manual
  slots: 10
screens: data/screens.yaml
buttons: data/buttons.yaml
skills: data/skills.yaml
scripts: data/scripts.yaml
audio: data/audio.yaml
tooltips: data/tooltips.yaml
characters: data/characters.yaml
hudStats:
  money:
    icon: img/ui/money.webp
    name: Money
    startingValue: 10
    minValue: 0
    maxValue: 99999
  energy:
    icon: img/ui/energy.webp
    name: Energy
    startingValue: 10
    minValue: 0
    maxValue: 10
items: data/items.yaml
achievements: data/achievements.yaml
interactionTags:
  default:
    onlyInteractOutsideOfScripts: true
quests: data/quests.yaml
menuButtons:
  menu:
    text: Menu
    cssId: my-custom-id

Characters Config ​

INFO

See the most up to date config directly on GitHub

yaml
---
config:
  imagesPath: './img/characters/'
characters:
  game:
    name: ''
    color: white
  player:
    style:
      color: orange
    sprites:
      idle: player.webp
    name: You
  cat:
    sprites:
      idle: cat_idle.webp
    style:
      color: white
    name: Generic Cat
  shopkeeper:
    sprites:
      idle: shop_cat.webp
    style:
      color: white
    name: Shopkeeper
  helper:
    sprites:
      idle: helper_cat.webp
    style:
      color: green
    name: Helper Cat
  music_cat:
    sprites:
      idle: music_cat.webp
    style:
      color: '#7f06e2'
      boxCss:
        background-color: red
      textCss:
        color: white
        font-family: Comic Sans MS
    name: Music Cat
  inner:
    sprites:
      idle: inner_voice.webp
    style:
      color: red
    name: Inner Voice