A graph-based visual dialogue system plugin for Godot, to create dialogues in your games incredibly easy!
## Contents
- [About](#about)
- [Installation](#installation)
- [Features](#features)
- [Documentation](#documentation)
- [Roadmap](#roadmap)
- [Contribute](#contribute)
- [Credits](#credits)
- [License](#license)
## About
The goal of this plugin is to provide an **easy-to-use, customizable and extensible** way to create dialogues without having to build your own system, because depending on the game, it can be a huge and complex task.
I started making this dialogue system for my game [One Cake Day](https://kazymila.itch.io/one-cake-day), and future projects, but then it became an entire editor (...and a year of work!), so I decided to make it a full plugin! I hope it helps you build your narrative more easily and improve your workflow!
_Follow my game on Itch.io! (It's on early stages yet)_
## Installation
> [!NOTE]
> Sprouty Dialogs requires **Godot 4.5 or higher!**
You can follow the installation instructions from the [installation guide](https://SproutyLabs.github.io/SproutyDialogsDocs/docs/getting-started/installation) in the documentation.
## Features
- **Graph-based visual interface** to create your dialogues in an easy and intuitive way
- **Text editor** to write and format your dialogues easily using BBCode in a user-friendly way
- **Character editor** to create and manage characters and portraits to use in your dialogues!
- **Variables support** for conditional branching, parse variables and more!
- **Signals support** to trigger events from your dialogues
- **Custom event nodes support** to create your own events for your game
- **Translations support** using `.tres` files or CSV files
- **Edit translations in the editor** without leaving the engine
- **Preview your dialogues** directly in the editor!
- **_And more!_**
## Documentation
You can see the [documentation](https://SproutyLabs.github.io/SproutyDialogsDocs) to learn more about Sprouty Dialogs and all its features!
There is a [getting started](https://SproutyLabs.github.io/SproutyDialogsDocs/docs/category/getting-started) section, where you can learn how to start making your dialogues!
Also, you have a [class reference](https://SproutyLabs.github.io/SproutyDialogsDocs/docs/category/class-reference) if you need it.
## Roadmap
These are some features that are planned to implement in the future:
- [x] Text effect tags (e.g. to change the typing speed in between dialogues)
- [x] Add more event nodes:
- [x] Call method node
- [x] Jump to node
- [ ] Character node
- [ ] Randomize node
- [ ] Play sound node
- [ ] Switch case node
- [ ] Grouping nodes support
- [ ] Typing sounds support
- [ ] A new class to handle the dialogue headlessly
*And more to come!*
## Contribute
You can also contribute to the project and add your own features, so please feel free to do so!
You can report any bugs or issues and request features in the [Github issues page](https://github.com/SproutyLabs/SproutyDialogs/issues/):
- If you find any bugs or issues, report them as an issue [here](https://github.com/SproutyLabs/SproutyDialogs/issues/new?template=bug_report.md).
- You can request any feature idea by opening a new issue [here](https://github.com/SproutyLabs/SproutyDialogs/issues/new?template=feature_request.md).
*Please check that the same or a similar issue doesn't already exist before creating your own.*
Also, you can ask anything in [Github discussions](https://github.com/SproutyLabs/SproutyDialogs/discussions)!
> [!NOTE]
> The plugin is written and tested using GDScript and has not been tested for C#.
## Credits
Made by [Kazy](https://github.com/Kazymila) 🌱
With help of these [cool contributors](https://github.com/SproutyLabs/SproutyDialogs/graphs/contributors) 😎
Logo design and vector graphics by [Maty](https://es.fiverr.com/matias_donaire) 🖋️
Special thanks to [Vicho](https://github.com/Vicente-G)!
## License
This project is licensed under the terms of the [MIT license](https://github.com/SproutyLabs/SproutyDialogs/blob/main/LICENSE). _It's completely free forever!_
If you want to support my work, and future plugins, you can support me on ko-fi! ♡
