This repository provides the official Godot plugin for interpreting and executing dialogue files exported from the Monologue dialogue editor. It is intended as a runtime companion for Monologue, allowing you to integrate authored dialogues into your Godot projects with minimal setup.
- Download or clone this repository.
- Copy the
addons/monologuefolder into your Godot 4 project. - In the Godot editor, go to Project > Project Settings > Plugins, and enable the plugin named Monologue.
You can now use Monologue nodes and scripts directly inside your game scenes.
Note: You can use the example project as a basis for your own project.
Begin by adding a MonologueProcess node to your main scene, then add a MonologueSettings node as a child of this node. Next, link your MonologueSettings node and the other layout elements to the MonologueProcess node by setting all the variables. Feel free to adjust the settings of the MonologueSettings node.
For the layout elements, use a MonologueTextBox for the text box, a VBoxContainer or HBoxContainer for the choice selector, a TextureRect or Sprite2D node for the background, and a MonologueCharacterDisplayer for the character displayer.
Finally, in your root node script, write something like:
extends Control
@onready var process: MonologueProcess = $MonologueProcess
func _ready() -> void:
var timeline: MonologueTimeline = process.preload_timeline("res://path/to/dialogue.json")
process.start_timeline(timeline)
Note: Look at the example for a better understanding.
This project is licensed under the terms of the MIT License.