Skip to content

Commit ac1fbf6

Browse files
committed
Update README to v0.2
1 parent 46595f0 commit ac1fbf6

File tree

1 file changed

+7
-72
lines changed

1 file changed

+7
-72
lines changed

README.md

Lines changed: 7 additions & 72 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
# Dialogue Plugin for Godot Engine
22
[![Godot Engine](https://img.shields.io/badge/Godot%20Engine-Plugin-blue?style=flat-square&logo=godot-engine&logoColor=white&logoWidth=20)]() [![GitHub license](https://img.shields.io/github/license/AnidemDex/Godot-DialogPlugin?style=flat-square)](https://github.com/AnidemDex/Godot-DialogPlugin/blob/main/LICENSE)
33
[![GitHub issues](https://img.shields.io/github/issues/AnidemDex/Godot-DialogPlugin?style=flat-square)](https://github.com/AnidemDex/Godot-DialogPlugin/issues)
4-
[![Godot Engine](https://img.shields.io/badge/Version-0.1.4-red?style=flat-square)](https://github.com/AnidemDex/Godot-DialogPlugin/releases/tag/v0.1.4)
4+
[![Godot Engine](https://img.shields.io/badge/Version-0.2.0-red?style=flat-square)](https://github.com/AnidemDex/Godot-DialogPlugin/releases/tag/v0.2.0)
55

66
<p align="center">
77
<a href="https://twitter.com/anidemdex" target="_blank"><img src="https://raw.githubusercontent.com/AnidemDex/Godot-DialogPlugin/main/.images/banner_animation.gif"></a><br/>
@@ -10,8 +10,6 @@
1010

1111
An user-friendly dialog system for Godot Engine, with timelines, characters, text boxes, dialog bubbles and many more (planned) features for your games.
1212

13-
> Be creative 💬
14-
1513
> **Note:** _If you find a bug, or want a feature to be included, feel free to [open a new issue](https://github.com/AnidemDex/Godot-DialogPlugin/issues/new). You can also send me a message on [twitter](https://twitter.com/anidemdex) or Discord (AnidemDex#6740)._
1614
1715
## ⚠Warning⚠
@@ -26,79 +24,16 @@ Download the lastest release and extract the ZIP file. Move the `addons` folders
2624

2725
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).
2826

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)
35-
# How to use it
36-
37-
This can be separated as 2 different things:
38-
## Create your timeline
39-
40-
1. First, create a timeline, inside the Dialog Editor tab.
41-
42-
After activating the plugin, go to Dialog Editor tab. It should be next to `AssetLib` tab.
43-
44-
![Godot View Tabs](.images/godot_view_tabs.png)
45-
46-
Then, click on `Timelines` button and `New` button.
47-
48-
![New Timeline](.images/godot_new_timeline.png)
49-
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.
51-
52-
![New event](.images/godot_new_event.png)
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-
63-
```gdscript
64-
# ...
65-
# inside any node in the scene
66-
# ...
67-
68-
# Create the node first and start it with your timeline
69-
var dialog_node = Dialog.start(<your_timeline>)
70-
71-
# Add that node to the scene
72-
add_child(dialog_node)
73-
```
74-
`<your_timeline>` can be:
75-
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:
81-
82-
![Instance dialog](.images/godot_instance_dialog_node.png)
83-
84-
Then, select the node:
85-
86-
![Dialog Node](.images/godot_scene_tree.png)
87-
88-
And, inside the Inspector tab, select the timeline:
27+
If you're downloading the repository instead, make sure to move only `dialog_plugin` to your `addons` folder. Extra folders are for debug purposes.
8928

90-
![Inspector](.images/godot_inspector_tab.png)
29+
# What is new on this version? [0.2.0]
30+
We are close to launching version 1.0, and this would not be possible without the help of those who have been reviewing the content of what I was creating.
9131

92-
That's it, it's fair simple.
32+
**There is A LOT of changes.**
9333

94-
> For now, there's only 3 events. They'll be more, and you can create your custom events if you want.
34+
Want to see the whole changelog? Take a look on the documentation, the [Changelog](https://anidemdex.gitbook.io/godot-dialog-plugin/changelog) section.
9535

9636
# Documentation
9737

98-
Please refer to [DOCS.md](/docs/DOCS.md) (WIP)
38+
Now we have an official documentation! All the information about the plugin you will find it organized in the [documentation page](https://anidemdex.gitbook.io/godot-dialog-plugin/). Tutorials, class information, FAQ and more will be added there, eventually.
9939

100-
# More information
101-
1. This started as a fork of [Dialogic](https://github.com/coppolaemilio/dialogic).
102-
2. You can extend the functionality of the plugin
103-
3. I need to add more information and modify this file to explan those points better.
104-
4. You're awesome, don't let anyone said awful things about you.

0 commit comments

Comments
 (0)