Narrat Docs
Search…
Getting Started
This guide explains how to get started using the narrat game engine in a minute

Getting Started

Getting started with narrat is very quick. There is a ready-to-use template that can get you running your game in a minute

Video Guide

This one minute video shows the entire setup from start to having the game running
How to install narrat and create a game

Text Instructions

Prerequisites

  • Have node.js 16 or above installed (LTS version is fine)

Creating the game project

Open a terminal in a folder of your choice (on Windows, you can shift-right-click in your folder and choose "Open PowerShell window here")
Help with opening the terminal
Once opened, you can run the following command:
This will download narrat and ask you some questions to configure your project. You can choose between a few game templates to get started. You can now follow the instructions from the tool to run the game, or follow the "Running the game" guide below

Running the game

How it works

Install libraries (only the first time or when updating)

With the narrat game setup, open a terminal inside the folder
There is a first command to install the dependencies (libraries) on first use:
npm install
If you get warnings during npm install

Running the game

npm start
This should open a browser tab with the game running after a short build time. The game can be accessed at https://localhost:8080
The game is ready to edit!
Those npm commands come from node.js. If the commands aren't recognised, you probably didn't install node.js correctly. More about npm install

Editing the game

It is now easy to make a game by editing the narrat scripts and config files!

Building and exporting the game

Functions Documentation