Dialogue System is a (yet-to-be-named!) flexible and customizable graph-based Dialogue System for Unity. The dialogue graph and graph editor is built upon the fantastic Xnode package.
The recommended (and easiest) way to install is through the Unity Package Manager (UPM). Simply open the Package Manager and click "Add package from GIT Url" in the upper left corner, and add the URL:
https://github.com/LarsEllefsen/DialogueSystem.git
The Unity Package Manager is as of this writing not able to handle dependencies outside of the unity registry, so for the time being you will have to manually install Xnode. Through the Package Manager, click "Add package from GIT Url" and add:
https://github.com/Siccity/xNode.git
In order to get started you need to create a Dialogue Graph asset. Simply right click anywhere in your project explorer and click "Dialogue Graph" from the Create menu. Clicking the asset will open the Dialogue Node Editor. Start by adding a Branch Node (Right click -> Dialogue System -> Branch Node), which will serve as en entry point in our graph.
From here you can add nodes either by dragging the output connection out and releasing it somewhere, or by right clicking and adding manually. Try connecting the Branch Node to a Text Node with some text.
Once you have a graph ready, simply add the Dialogue component to any gameObject and add your Dialogue Graph asset, your Dialogue Pane UI and the TextMeshPro component dispalyign the text.
The Dialogue component acts as an API you use to hook into the dialogue handler, so you will need to create a Dialogue Manager type class to interact with the Dialogue component:
Get a reference to the Dialogue component and call the StartDialogue function to start the dialogue.
//DialogueManager.cs
public class DialogueManager : MonoBehaviour
{
void Start()
{
//the instance variable will return a singleton instance of the dialogue component.
Dialogue dialogueManager = Dialogue.instance;
dialogueManager.StartDialogue();
}
}By looking at the state of the Dialogue we can choose to advance the dialogue if the user presses Space and the Dialogue is running:
//DialogueManager.cs
public class DialogueManager : MonoBehaviour
{
void Start()
{
Dialogue dialogue = Dialogue.instance;
dialogue.StartDialogue();
}
void Update()
{
if (Input.GetKeyDown("space"))
{
if (dialogue.IsRunning)
{
dialogue.AdvanceDialogue();
}
}
}
}