Quick Start Instructions

Table of Contents

This page contains general quick start instructions that you can follow to set up the Dialogue System in your own project.

(Click Here for Setup Wizard Video Tutorial)

Create a Dialogue Database

  1. Right-click in the Project view and select Create > Dialogue System > Dialogue Database.
  2. Double-click the dialogue database.
  3. On the Actors tab, select Menu > New Actor to add your actors.
  4. On the Conversations tab, click the "+" button in the upper left to create a new conversation.

More information: Dialogue Editor

Create a Dialogue Manager

The absolute fastest way to add a Dialogue Manager to your scene is to add the prefab Assets/Dialogue System/Prefabs/Dialogue Manager and then select menu item Component > UI > EventSystem. The Dialogue Manager prefab is preconfigured with generic Unity UIs. You can still run it through the Dialogue Manager Wizard to customize it further.

To customize your Dialogue Manager or create a new Dialogue Manager if one doesn't exist in your scene yet, run the Dialogue Manager Wizard:

Select Window > Dialogue System > Wizards > Dialogue Manager and go through the wizard. Configure each page as appropriate for your project. Here are some notes:

  • Assign the dialogue database you just created.
  • For the dialogue UI, use one of the prefabs provided in Prefabs/Unity Dialogue UIs.
  • If your PC doesn't have a body (which is common in first-person shooters), change Default Sequence to Wait for Subtitle. Otherwise conversations will try to focus the camera on the PC's (non-existent) body.

More information: How to Set Up the Dialogue Manager

Configure the PC

The Player Setup Wizard will automatically add the appropriate Dialogue System components to your PC to give it the behavior that you specify. You can also manually add components using the Component > Dialogue System menu.

Select Window > Dialogue System > Wizards > Player Setup and go through the wizard. Configure each page as appropriate for your project. Here are some notes:

  • If your player doesn't already have a control system, choose one of the sample control systems.
  • If your player doesn't already have a camera system, tick Use Smooth Follow Camera.
  • Choose a targeting method. This specifies how the player will send "OnUse" messages to usable targets such as NPCs.
  • You will usually want to disable player movement and camera control during conversations. The wizard can only detect Dialogue System-provided sample control components. You will have to manually add other components by clicking Select Player and editing the Set Enabled On Dialogue Event component.

More information: How to Set Up the Player (PC)

Configure NPCs

The NPC Setup Wizard will automatically add the appropriate Dialogue System components to your NPC or interactive object to give it the behavior that you specify. You can also manually add components using the Component > Dialogue System menu.

Use these steps for each NPC or interactive object.

Select Window > Dialogue System > Wizards > NPC Setup and go through the wizard. Configure each page as appropriate for your project. Here are some notes:

  • Assign the dialogue database that contains the NPC's content.
  • If the NPC has a conversation, set the trigger mode to specify when the conversation will fire.
  • If the NPC has a bark, make sure to add a bark UI.
  • If prompted, click Add Collider and/or Add Usable.

More information: How to Set Up NPCs

<< Quick Start Tutorial | How To Get Help >>