You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
@@ -26,25 +26,40 @@ Download the lastest release and extract the ZIP file. Move the `addons` folders
26
26
27
27
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).
28
28
29
+
If you're downloading the repository instead, make sure to move only `dialog_plugin` to you `addons` folder. Extra folders are for debug purposes.
30
+
31
+
# What is new on this version? [0.1.4]
32
+
-**Say "¡Hola!" to internationalization.** Now you can use translations in your dialogs, and export or import those _(as .csv)_ aswell. Don't worry, you can use your own translations before using the plugin.
33
+
34
+
Want to see the whole changelog? Take a look on [CHANGELOG.md](/docs/CHANGELOG.md)
29
35
# How to use it
30
36
31
-
That's a good question.
37
+
This can be separated as 2 different things:
38
+
## Create your timeline
32
39
33
40
1. First, create a timeline, inside the Dialog Editor tab.
34
41
35
42
After activating the plugin, go to Dialog Editor tab. It should be next to `AssetLib` tab.
43
+
36
44
37
45
38
46
Then, click on `Timelines` button and `New` button.
47
+
39
48
40
49
41
50
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.
42
51
43
52
44
-
3. Create a new `Dialog` node, and `start` it with your recently created timeline.
45
-
46
-
You had 2 options:
47
-
1. Create it from code:
53
+
54
+
> **Note**: you can also can create timelines and events through code if you preffer.
55
+
56
+
## Instantiate your Dialog node with your timeline
57
+
58
+
Now you need to create a new `Dialog` node, and `start` it with your recently created timeline.
59
+
60
+
You had 2 options:
61
+
### 🔵 Create it from code:
62
+
48
63
```gdscript
49
64
# ...
50
65
# inside any node in the scene
@@ -56,15 +71,22 @@ var dialog_node = Dialog.start(<your_timeline>)
56
71
# Add that node to the scene
57
72
add_child(dialog_node)
58
73
```
59
-
`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`.
74
+
`<your_timeline>` can be:
60
75
61
-
2. or Instantiate it in the scene editor:
76
+
- The name of your timeline (the name that you used when you created it),
77
+
- The absolute path (something like `res://dialog_files/timelines/<your_timeline>.tres`) to that timeline,
78
+
- A `DialogTimelineResource`.
79
+
80
+
### 🔵 Instantiate it in the scene through the editor:
All notable changes to this project will be documented in this file.
3
+
4
+
The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),
5
+
and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
6
+
7
+
## [UNRELEASED]
8
+
Ignore this section until someone decide to add information, please.
9
+
### Added
10
+
### Changed
11
+
### Deprecated
12
+
### Removed
13
+
### Fixed
14
+
15
+
16
+
## [0.1.4] - 2021-05-09
17
+
### Added
18
+
-**Translation system** based on Godot i18n using a [modified version of this repository](https://github.com/AnidemDex/Godot-TranslationService)
19
+
-**Translations to text events and timeline editor**. You can use .csv files or use the Dialog editor to create translations.
20
+
-**Translations to the plugin itself**. There's more languages than english.
21
+
-**CHANGELOG.md file.** Who said that keep the things in order is easy?
22
+
23
+
### Changed
24
+
-**Timeline editor view.**
25
+
-**Main screen behaviour.** The editor now instances itself only when you select the editor, and free itself if you change the main screen. Keeping free RAM is never easy.
26
+
27
+
### Fixed
28
+
-[Leaked instances on exit.](https://github.com/AnidemDex/Godot-DialogPlugin/issues/1)
29
+
-**Translations bug.** For some reason, Godot doesn't brings all properties on a clean project. This tries to workaround that.
30
+
31
+
32
+
## [0.1.3] - 2021-05-03
33
+
### Fixed
34
+
-**Draggable events fixed**. There was a bug related the drag 'n' drop system
35
+
36
+
37
+
## [0.1.2] - 2021-05-03
38
+
### Added
39
+
-**Drag 'n' drop system.** You can drag and drop events from the event container, or reorganize your timelines.
40
+
-**Test suit added.** Because making mistakes is a human thing, this can prevent making many mistakes verifying the source files. The power of Unit Testing (provided by [WAT plugin](https://github.com/AlexDarigan/WAT-GDScript)) and Github Actions in one place.
41
+
-**DialogBaseNode icon.** Because beeing unique is a hard task to do in the actual era.
42
+
43
+
### Changed
44
+
-**Databases now must keep it default values.** Nobody wants to know that i use timelines like "food" or "test".
45
+
-**Banner image.** A little witch that gives the welcome is always better.
46
+
-**Timeline preview.** With a new theme and behaviour.
47
+
48
+
49
+
## [0.1.1] - 2021-05-01
50
+
### Added
51
+
-**Documentation about any class that plugin uses.** Have you any idea how many time this took me to do? My soul was drained while I was doing documentation, and it's incomplete.
52
+
53
+
### Changed
54
+
-**Dialog bubble.** Now it looks more like a bubble than a little square.
0 commit comments