|
1 | 1 | # Dialogue Plugin for Godot Engine
|
| 2 | +[]() [](https://github.com/AnidemDex/Godot-DialogPlugin/blob/main/LICENSE) |
| 3 | +[](https://github.com/AnidemDex/Godot-DialogPlugin/issues) |
| 4 | +[]() |
| 5 | + |
| 6 | + |
| 7 | + |
| 8 | +An user-friendly dialog system for Godot Engine, with timelines, characters, text boxes, dialog bubbles and many more (planned) features for your games. |
2 | 9 |
|
3 |
| -A tool that will help you create dialogues and timelines with characters for your games. |
4 | 10 | > Be creative 💬
|
5 | 11 |
|
6 |
| -# ⚠Warning⚠ |
| 12 | +## ⚠Warning⚠ |
7 | 13 |
|
8 |
| -> This plugin is not yet ready for use. |
| 14 | +> This plugin is **not** ready for use, yet. |
9 | 15 |
|
10 | 16 | You can try it anyway, but be sure to make a copy of your dialog files. The format will not change, but, just in case.
|
11 | 17 |
|
| 18 | +# Installation |
| 19 | + |
| 20 | +Download the lastest release and extract the ZIP file. Move the `addons` folders to the root of your project. It's that easy! |
| 21 | + |
| 22 | +If you want more information about installing plugins in Godot, please refer to [official documentation page](https://docs.godotengine.org/en/stable/tutorials/plugins/editor/installing_plugins.html). |
| 23 | + |
| 24 | +# How to use it |
| 25 | + |
| 26 | +That's a good question. |
| 27 | + |
| 28 | +1. First, create a timeline, inside the Dialog Editor tab. |
| 29 | + |
| 30 | + After activating the plugin, go to Dialog Editor tab. It should be next to `AssetLib` tab. |
| 31 | +  |
| 32 | + |
| 33 | + Then, click on `Timelines` button and `New` button. |
| 34 | +  |
| 35 | + |
| 36 | +2. Add some events to that timeline. A timeline without events will not work, and will halt your game if you try to use it. |
| 37 | + |
| 38 | +  |
| 39 | +3. Create a new `Dialog` node, and `start` it with your recently created timeline. |
| 40 | + |
| 41 | + You had 2 options: |
| 42 | + 1. Create it from code: |
| 43 | +```gdscript |
| 44 | +# ... |
| 45 | +# inside any node in the scene |
| 46 | +# ... |
| 47 | +
|
| 48 | +# Create the node first and start it with your timeline |
| 49 | +var dialog_node = Dialog.start(<your_timeline>) |
| 50 | +
|
| 51 | +# Add that node to the scene |
| 52 | +add_child(dialog_node) |
| 53 | +``` |
| 54 | +`your_timeline` can be the name of your timeline (the name that you used when you created it), the absolute path to that timeline or a `DialogTimelineResource`. |
| 55 | + |
| 56 | + 2. or Instantiate it in the scene editor: |
| 57 | + |
| 58 | + |
| 59 | +Then, select the node: |
| 60 | + |
| 61 | + |
| 62 | +And, inside the Inspector tab, select the timeline: |
| 63 | + |
| 64 | + |
| 65 | +That's it, it's fair simple. |
| 66 | + |
| 67 | +> For now, there's only 3 events. They'll be more, and you can create your custom events if you want. |
| 68 | +
|
12 | 69 | # Documentation
|
13 | 70 |
|
14 | 71 | Please refer to [DOCS.md](/docs/DOCS.md) (WIP)
|
0 commit comments