Contribute on GitHub

# Creating New Levels

# What are levels?

A level in TwilioQuest is an explorable area in the game that can contain objectives, game objects, and characters for the player to interact with. There are two types of levels that you can create:

  • A VR training mission accessible through the Fog Owl's training simulator room
  • A location within The Cloud that the player can navigate to using the Fog Owl's navigation map interface

At the time of this writing, the best way to create a new level is to copy the level folder of an existing level. This will copy all the map and tileset configuration you will need to effectively create a new level. The example level folder in the template repo (opens new window) is a good one to use. It contains all the necessary files you will need to create a level. After doing this, your new level folder should look similar to what's shown below:

└── levels/
    ├── the_level_you_copied/
    └── your_new_level_folder/
        ├── conversations/
        ├── maps/
        ├── objectives/
        │   └── example_objective/
        ├── events.js
        └── level.json

Levels are broken up into several sub-directories and files:

Check out how the Fog Owl level (opens new window) for a great example on how levels are structured and configured!

# Conversations

You can write dynamic non-player character (NPC) dialogue for the characters the player will encounter in the level.

# Maps

These files specify the visual layout and game objects present within the level. A level may have multiple maps.

# Objectives

Objectives are where you will deliver most of the educational content for your level. You will describe your objective using Markdown (opens new window) and write validation code for your objective using Node.js (opens new window).

# Events.js

The events file enables you to write code that can respond to level lifecycle events, and add dynamic behavior to your level. For example, starting a conversation with an npc once your level had loaded.

# Level.json

The level file contains the metadata for your new level, such as: the title, description, background music, etc.