Skip to main content

​
Prerequisites

Make sure you have Godot 4.2.1 or higher installed before proceeding.

​
Installation Methods

1

Download the Plugin

You have two options to obtain Dialogue Engine:Option 1: Download from GitHubDownload the latest release as a ZIP file from the GitHub repository.Option 2: Clone the Repository
git clone https://github.com/Rubonnek/dialogue-engine.git
If you want to explore the demo scenes, clone the entire repository. Otherwise, downloading just the addons folder is sufficient.
2

Copy to Your Project

Extract the downloaded file (if using ZIP) and locate the addons folder.Copy the entire addons/rubonnek.dialogue_engine directory to your Godot project’s addons folder.Your project structure should look like this:
YourProject/
├── addons/
│   └── rubonnek.dialogue_engine/
│       ├── plugin.cfg
│       ├── plugin.gd
│       └── runtime/
│           ├── dialogue_engine.gd
│           └── dialogue_entry.gd
├── scenes/
├── scripts/
└── project.godot
If your project doesn’t have an addons folder yet, create one in the root directory of your project.
3

Enable the Plugin

Open your project in Godot and navigate to:Project → Project Settings → PluginsYou should see “Dialogue Engine” in the list of available plugins.Check the “Enable” checkbox next to “Dialogue Engine”.Enable Dialogue Engine Plugin
The plugin will be enabled immediately. You don’t need to restart Godot.
4

Verify Installation

To verify that the plugin is installed correctly, create a new GDScript file and try this code:
extends Node

func _ready() -> void:
    var dialogue : DialogueEngine = DialogueEngine.new()
    print("Dialogue Engine installed successfully!")
    print("Dialogue Engine instance: ", dialogue)
Run the scene. If you see the success message in the console without errors, the installation is complete!

​
Plugin Configuration

The plugin configuration is stored in plugin.cfg: 
[plugin]

name="Dialogue Engine"
description="Dialogue Engine"
author="Wilson Enrique Alvarez Torres"
version="1.6.0"
script="plugin.gd"

​
What Gets Installed

When you install Dialogue Engine, the following classes become available in your project:

DialogueEngine

The main class for managing dialogue trees, advancing through conversations, and handling branching logic.

DialogueEntry

Represents individual nodes in your dialogue tree, containing text, options, conditions, and metadata.

​
Troubleshooting

Plugin not appearing in the list?Make sure the addons/rubonnek.dialogue_engine folder contains the plugin.cfg file. Godot uses this file to detect plugins.
“DialogueEngine” class not found error?Ensure the plugin is enabled in Project Settings → Plugins. If it’s enabled and you still get the error, try:
  1. Disabling and re-enabling the plugin
  2. Restarting Godot
  3. Running Project → Reload Current Project
Version compatibility issues?Dialogue Engine requires Godot 4.2.1+. If you’re using an older version of Godot 4.x, you may encounter errors. Upgrade to the latest Godot 4.x version.

​
Exploring the Demos

If you cloned the full repository, you can explore the demo scenes to see Dialogue Engine in action: 
demos/
├── 1. simple dialogue/
├── 2. same branch goto/
├── 3. different branch goto/
├── 4. branching condition/
├── 5. branching options dialogue/
├── 6. handling metadata/
├── 7. handling input/
├── 8. handling animations/
├── 9. characters dialogue/
├── 10. dynamic save and load/
└── 11. timed options/
Each demo showcases different features of the engine. They’re great learning resources!

​
Next Steps

Quickstart Guide

Now that you have Dialogue Engine installed, let’s create your first dialogue!

Build docs developers (and LLMs) love

Get started for freeTalk to us