The installation of this addon can be a bit tricky, and I highly suggest you use version control for it to work smoothly. After copying and pasting the plugin into your project, Godot might complain about missing classes. This happens because Godot is trying to load an uncompiled addon (since we're using C#, we need to compile it first!).
Make sure you don't open any addon-related scenes before compiling. Otherwise, scenes containing serialized exposed fields might lose their bindings. This is a known Godot bug that hopefully gets fixed. If you encounter missing classes, signal errors, or null references when loading the addon, check if any addon scene lost their bindings. If that's the case, try using version control to recover the addon's original state.
A plugin for creating and exporting dialogue trees from within the Godot Editor using C#.
Godot provides all the tools needed to create your dialogue system, however, for most game developers, this task is tedious and complex. This is where Dialogue Nodes come into the picture. The plugin extends your Godot editor to allow for creating, testing, and incorporating branching dialogues in your game.
The dialogue editor was created with the focus on keeping the workflow simple and easy to pick up. While the editor supports powerful features under the hood, it tries to stay out of the way of the user. A beginner can easily pick up the editor and start creating basic dialogues thanks to the intuitive design. If your focus is on creating simple dialogues for your game, you can get set up in no time. If you want to work with multiple dialogue files or put all the branching dialogues in one file, DialogueNodes has got you covered. Heck! Do both if you want!
The real power of the plugin lies in the tools it provides the user to utilize the full potential of the feature-rich dialogue editor. Be it using variable values in the dialogue, conditional dialogues or even conditional options, modifying variable values and even emitting signals which open up a world of possibilities when it comes to custom events during the dialogue.
The plugin allows for running any branching dialogue within the editor itself for quick testing and faster iteration times. No need to run your game every time you modify the dialogue. Under the hood, this uses the same DialogueBox node you'll use in your project. So, you'll know exactly how your dialogue will run in-game without even running the game!
Additionally, enable the debugging toggle to understand what events are occurring as the dialogue runs. Note: this feature only works in the editor, not the game.
Once you have your dialogue files and are ready to test them out in-game, the plugin provides a super simple way of creating dialogue boxes for your game.
- Add the
DialogueBoxnode to your scene and set its position and size as per your requirements. - Select the dialogue file from the inspector and run
$DialogueBox.start('<YOUR_START_ID>')in your code to start the dialogue.
The DialogueBox node provides several options to customize the look and layout to your liking. However, being derived from Control nodes, it is recommended to change the colors, font and borders using Godot's theme editor.
- speed
- pause
- colormod fx
- cuss
- ghost
- heart
- jump
- l33t
- nervous
- number
- rain
- sparkle
- uWu
- woo
130072369-90f99c72-358e-41fe-af4d-cfea32665741.mp4
Let the dialogue manager read your external class and learn about your public variables. You will be able to GET, SET and COMPARE your external variables within your dialogue!
Conditional Nodes support consulting against an external or internal variable.
I've ported, refactored, and optimized the original formula in a way that utilizes less horsepower and fixes some issues.
You can use the new "console" transition fx. Transitions detect punctuation, you can set up a small pause to play during punctuation, making dialogues a tiny bit juicer.
A Demo scene contains an example of how to play a type sound fx during the dialogue.
In opposite to GDScript, C# needs to know if you are working with a certain type of variable, variable types are now visible in the Dialogue Node's editor, similarly, you can define variable types for internal variables as part of your dialogue.
- Copy the addons/dlaogue_nodes and example folders and paste them into your project.
- This is a C# plugin and currently on 4.2.1; C# plugins have a tricky behavior, you must have created a C# solution to make this work as we need the editor to have compiled the plugin before we load it.
- In case you don't have a C# solution, go to Project > Tools > C# > Create C# Solution.
- Now you should be able to "Build a project" (Alt+B) so that the plugin compiles.
- I suggest you restart Godot at this point.
- Go to Project > Project Settings > Plugins and Enable Dialogue Nodes for C#.
- Done!
- .NET: Failed to unload assemblies: This bug is a Godot-related issue and it's a very ugly one. It seems to trigger whenever you work on an addon-related script while having the plugin enabled. In that case, Godot will not be able to unload the assemblies (probably because they are in use by the editor). This will cause the editor to be unable to compile the project and you will need to restart the editor. Be aware that, if you have any scene that makes use of an addon-related file with serialized references... those references might get lost and the plugin might break (I highly suggest using version control to recover these references after stepping into this issue, a workaround is to hardcode any reference until this bug gets fixed).
- When closing Godot you might get: "Attempt to disconnect a nonexistent connection from RichTextLabel". Although this is harmless.. this is another Godot-related bug caused by the [tool] keyword within C# scripts.
- DialogueNode in the workplace may have wrong colored slots on light themes
- Using return character in the dialogue results in options not showing up in certain cases
- Shifting focus to empty option from another empty option results in the option data moving around
- DialogNodes in the graph have options overflowing outside the edges. This seems to be a bug introduced in Godot 4.2
If you find any bugs or issues, report them in the issues page. Please ensure the same or similar issues aren't already present before creating your own.
Make sure you check the Wiki