Tutorial System

The tutorial system is designed to be fairly flexible, allowing tutorial steps to be played during loading screens or on scene load. Future versions (or current if this doc hasn't been updated see https://github.com/TheWizardsCode/RogueWave/issues/110). This document describes how to create and manage tutorial steps.

• Tutorial Manager - This class is responsible for managing all tutorial steps and recording where in the tutorial a player is.
• Tutorial Step - This is a Scriptable Object that defines an individual tutorial step. What happens within that step and when it should be presented to the player.

Tutorial Manager

Create a new game object in your main scene and add the Tutorial Manager. Setup the few parameters it needs and check the Audio Source, which will be added automatically, if necessary, is also setup how you want it. That's it, you are done with this step.

Tutorial Steps

Creating tutorial steps is where the real work happens. Create steps in a Resources/Tutorial folder using Create -> Rogue Wave -> Tutorial Step. As long as you put them in a Resources/Tutorial folder these will be discovered by the tutorial manager when it starts up. Once discovered they will be executed based on their configuration as follows.

Meta Data

The mete-data describes the tutorial.

• Display Name - if a name needs to be shown to the player this will be used.
• Description - Usually this description will not be shown to the player. It is useful, however, during development.
• Duration - This is how long the tutorial step should pause for before moving on to the next part of the game. Usually this will be the length of the longest audio clips or animations that are playing.

Triggers

The triggers section defines when the tutorial step will fire. Once a step has been triggered it won't be triggered again.

• Is Loading Scene - is used to tell the manager if this step should be displayed on the loading screen while the target scene is being loaded (set to true), or whether it should be triggered when the scene has fully loaded.
• Scene Name - This is the scene that will trigger the tutorial. If Is Loading Scene is set to true this step will be displayed during the loading screen of the named scene. If set to false it will be played when the scene has fully loaded.
• Scene Load Count - this is how many times the scene should be loaded before the tutorial step is triggered. Very often this will be set to 1 but in some specific circumstances you will set it higher.

Visuals

• Hero Image - if this step is to be displayed on the loading screen this is the image that will be displayed
• Script - this is the text that will be displayed and/or read to the player. It contains the information that the tutorial is seeking to impart

Audio

• Actor - If the script is read by an AI this is the voice to use. However, we've found that this doesn't land well with players, so it will likely be removed in the future.
• Audio Clips - One of these clips will be played when the tutorial plays. Normally there will only be one clip here.