Narrat Docs
Search…
Narrat Docs
Narrat
Functions Documentation
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
Installing Narrat in a web app

Install on a project

npm install narrat
For narrat to run, it needs two pieces of data:
  • The config file which contains the path of your script files and other info
  • The characters file which contains the list of characters in the game
Copy the content of one of the example games and the content of the assets folder somewhere in your app that can be served statically, and have an #app div in your page's html including your javascript (you can copy public/index.html) .
Then in your javascript code to launch narrat, use:
import { startApp } from 'narrat';
// Call `startApp` to run the game, passing the path to your config file and characters file.
startApp({
charactersPath: 'data/characters.json', // Replace with whatever path you have
configPath: 'data/config.json',
});

Customising your game

See the Customising your Narrat game page for more info on how to edit the game

Building and exporting your game

See the Building and exporting your game page
Guides - Previous
Theming the game and UI
Next - Guides
Editing a narrat game
Last modified 15d ago
Copy link
Outline
Install on a project
Customising your game
Building and exporting your game