cuppar / dialogic

💬 Create Dialogs, Visual Novels, RPGs, and manage Characters with Godot to create your Game!

Dialogic

Create Dialogs, Visual Novels, RPGs, and manage Characters with Godot to create your Game!

Table of Contents

• Version
• Installation
• Documentation
• Testing
• Credits
• License

Version

Dialogic 2 requires at least Godot 4.2.

It's a major rewrite compared to the previous Dialogic 1.

If you are looking for the Godot 3.5 version you can find it here.

Installation

Follow the installation instructions on our Getting Started documentation.

Dialogic comes with an auto-updater so you can install future versions right from within the plugin.

Documentation

You can find the official documentation of Dialogic here: Dialogic Documentation

There is a Class Reference as well: Class Reference

Connect with us!

If you need help or want to share your Dialogic projects, take a look at the following options:

• Ask questions, or report bugs on our Discord
• Report bugs and issues on the GitHub Issues Page
• Ask questions on GitHub Discussions

Testing

Dialogic uses Unit Tests to ensure specific parts function as expected. These tests run on every git push and pull request. The framework to do these tests is called gdUnit4 and our tests reside in the /Tests/Unit path. We recommend installing the gdUnit4 add-on from the AssetLib, with this add-on, you can run tests locally.

To get started, take a look at the existing files in the path and read the documentation to create your first test.

Interacting with the Source Code

All methods and variables in the Dialogic 2 source code prefixed with an underscore (_) are considered private, for instance: _remove_character().

While you can use them, they may change in their behavior or change their signature, causing breakage in your code while moving between versions. Most private methods are used inside public ones; if you need help, check the documentation.

Public methods and variables can be found in our Class Reference.

During the Alpha and Beta version stages, code may change at any Dialogic Release to allow drafting a better design. Changelogs will accommodate for these changes and inform you on how to update your code.

Credits

Made by Emilio Coppola and Jowan-Spooner.

Contributors: zaknafean, thebardsrc, and more!.

Special thanks: Arnaud, AnidemDex, ellogwen, Tim Krief, Toen, Òscar, Francisco Presencia, M7mdKady14.

Thank you to all my Patreons and Github sponsors for making this possible!

License

This project is licensed under the terms of the MIT license.