Narrat Docs
Search…
Narrat Docs
Narrat
Functions Documentation
All commands list
Save Commands
String commands
Text Commands
Random Generation
Logical Operators
Math commands
Jump
Choice
Modifying variables
If
Left-side Viewport commands
Clear Dialog
Audio commands (music and sounds)
Wait
Skills Commands
Notify
Stats Commands
Text Field
Features
Quests
Transitions
Inventory
HUD Stats
Screens
Skills System
Saving and Reloading
Playing Audio
Functions
Guides
Getting Help
Language syntax and expressions
Using items
Updating narrat
Getting Started
Old Template method
Config files
Useful Links
Theming the game and UI
Installing Narrat in a web app
Editing a narrat game
Building and exporting your game
Publishing on Steam (Steamworks integration)
Examples
Example Config
Example narrat script
Powered By GitBook
HUD Stats
HUD Stats are number values that automatically appear in the HUD at the top right of the screen and can be controlled via game scripts.
HUD Stats are number values that automatically appear in the HUD at the top right of the screen and can be controlled via game scripts.

HUD Stats config

config.yaml
hudStats:
money:
icon: img/ui/money.webp
name: Money
startingValue: 10
minValue: 0
energy:
icon: img/ui/energy.webp
name: Energy
startingValue: 10
minValue: 0
maxValue: 10
Stats are defined in the hudStats part of the config.
  • icon: path to an image to use as the icon for the stat
  • name: The name of the stat for display in the HUD
  • startingValue: The default value for the stat on a new save
  • minValue: How low this stat can go
  • maxValue: How high this stat can go

Functions

Features - Previous
Inventory
Next - Features
Screens
Last modified 1d ago
Copy link
On this page
HUD Stats config
Functions