Skip to content

Commit

Permalink
Update README to v0.2
Browse files Browse the repository at this point in the history
  • Loading branch information
AnidemDex committed Jul 3, 2021
1 parent 46595f0 commit ac1fbf6
Showing 1 changed file with 7 additions and 72 deletions.
79 changes: 7 additions & 72 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
# Dialogue Plugin for Godot Engine
[![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)
[![GitHub issues](https://img.shields.io/github/issues/AnidemDex/Godot-DialogPlugin?style=flat-square)](https://github.com/AnidemDex/Godot-DialogPlugin/issues)
[![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)
[![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)

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

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

> Be creative 💬
> **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)._
## ⚠Warning⚠
Expand All @@ -26,79 +24,16 @@ Download the lastest release and extract the ZIP file. Move the `addons` folders

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

If you're downloading the repository instead, make sure to move only `dialog_plugin` to you `addons` folder. Extra folders are for debug purposes.

# What is new on this version? [0.1.4]
- **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.

Want to see the whole changelog? Take a look on [CHANGELOG.md](/docs/CHANGELOG.md)
# How to use it

This can be separated as 2 different things:
## Create your timeline

1. First, create a timeline, inside the Dialog Editor tab.

After activating the plugin, go to Dialog Editor tab. It should be next to `AssetLib` tab.

![Godot View Tabs](.images/godot_view_tabs.png)

Then, click on `Timelines` button and `New` button.

![New Timeline](.images/godot_new_timeline.png)

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.

![New event](.images/godot_new_event.png)

> **Note**: you can also can create timelines and events through code if you preffer.
## Instantiate your Dialog node with your timeline

Now you need to create a new `Dialog` node, and `start` it with your recently created timeline.

You had 2 options:
### 🔵 Create it from code:

```gdscript
# ...
# inside any node in the scene
# ...
# Create the node first and start it with your timeline
var dialog_node = Dialog.start(<your_timeline>)
# Add that node to the scene
add_child(dialog_node)
```
`<your_timeline>` can be:

- The name of your timeline (the name that you used when you created it),
- The absolute path (something like `res://dialog_files/timelines/<your_timeline>.tres`) to that timeline,
- A `DialogTimelineResource`.

### 🔵 Instantiate it in the scene through the editor:

![Instance dialog](.images/godot_instance_dialog_node.png)

Then, select the node:

![Dialog Node](.images/godot_scene_tree.png)

And, inside the Inspector tab, select the timeline:
If you're downloading the repository instead, make sure to move only `dialog_plugin` to your `addons` folder. Extra folders are for debug purposes.

![Inspector](.images/godot_inspector_tab.png)
# What is new on this version? [0.2.0]
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.

That's it, it's fair simple.
**There is A LOT of changes.**

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

# Documentation

Please refer to [DOCS.md](/docs/DOCS.md) (WIP)
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.

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

0 comments on commit ac1fbf6

Please sign in to comment.