Adding dialogic from main

addons/dialogic/Dialog.tscn

@@ -0,0 +1,17 @@
+[gd_scene load_steps=3 format=2]
+
+[ext_resource path="res://addons/dialogic/Images/Plugin/placeholder.png" type="Texture" id=1]
+[ext_resource path="res://addons/dialogic/Nodes/DialogProxy.gd" type="Script" id=2]
+
+[node name="Dialog" type="Control"]
+anchor_right = 1.0
+anchor_bottom = 1.0
+script = ExtResource( 2 )
+__meta__ = {
+"_edit_use_anchors_": false
+}
+
+[node name="TextureRect" type="TextureRect" parent="."]
+margin_right = 40.0
+margin_bottom = 40.0
+texture = ExtResource( 1 )

addons/dialogic/Documentation/Content/Events/000.md

@@ -0,0 +1,42 @@
+# Text Event
+![image](./Images/text_event_1.png)
+
+The text event is one of the most important ones since this will be containing most of your text.
+
+## The header
+![image](./Images/text_event_2.png)
+
+You have up to tree different types of options here:
+- **Character** - This is who will be saying the text written inside the text editor. 
+- **Portrait** - If you picked a **Character** the different portraits will show up here. If that **Character** doesn't have any special portraits the default one will be used. If you pick the `(Don't change)` option, it will continue using the previous text event portrait set. If you pick the `[Definition]` option, a new picker will show up.
+- **Definition** - You can select any of your **Definitions** and it will try to match that string with available portraits. This can be used to dynamically show different portraits depending of previous player input.
+
+## The Text Editor
+
+Inside the text editor you have special features that might not be obvious to everyone:
+
+- Each line will create a new text message. This will help you to make longer monologues without having to add a new **Text Event** for each message. If you want to disable this, you can do so in the Dialogic settings pannel: `Settings -> Dialog -> New lines will create extra messages`.
+
+- When writing a **Character** name, Dialogic will automatically color the text of that **Character**
+
+- `[br]` This will add a line break in the position of the tag
+
+- `[nw] / [nw=2] / [nw=v]` The *no wait* command will tell Dialogic to automatically continue with the next event without any user input. The default time for skipping to the next text is 2 seconds (after all characters are displayed), but you can change how many seconds by setting a number to it (like `[nw=5]` for 5 seconds). You can use [nw=v] to continue after the audio (if any is used) finished.
+
+- `[speed=X]` You can use the *speed* tag to change the speed during a text event. Placed at the beginning of the event it will affect the whole text, but each following speed command will overwrite the previous. Higher numbers result in a slower and lower ones in a fast speed. If you want the text to be instant for one message you can do `[speed=0]` and it will show up automatically. 
+After the event containing the *speed* tag is over, it will go back to whatever value you have set on the current theme. 
+
+- `[definition]` If you have a **Definition** and you want to display its value on inside your text you can use the `[` and `]` characters and the name of your **Definition** to print it. Let's say we have a **Definition** called `Money` with the value of `5`. we can write: `You have [Money] left` and Dialogic will replace the `[Money]` tag with the value `You have 5 left`.
+
+- `[word1,word2,word3]` You can write a list of words like this: `[word1,word2,word3]` and the text event will pick a random word from the list. If the word is a Dialogic variable name and it gets picked it will show the value of that variable.
+
+- `[signal=argument]` will emit the dialogic signal with the given argument (as a string) when this place is reached.
+
+- `[pause=1]` will stop displaying new characters for 1 second and then continue.
+
+- `[play=click.wav]` will play an audio file with the given name. These files have to be located in `"res://dialogic/sounds/"`.
+
+- Beside these dialogic specific options, there are the default `BBCode` options that every `RichTextLabel` has like [b]bold[/b] or [i]italic[/i] text, [color=red]colored text[/color] and [wave]using effects[/wave]! More about that [here](https://docs.godotengine.org/en/stable/tutorials/gui/bbcode_in_richtextlabel.html).
+
+## Voice Line Support
+You can find a tutorial on how to use the voice line feature in the tutorials folder!

addons/dialogic/Documentation/Content/Events/001.md

@@ -0,0 +1,18 @@
+# Character Join
+
+![Event](./Images/Event_Character_Join.PNG)
+
+The character join event is used to make character portraits appear during a dialogue.
+
+Select the **character** to show on the screen.
+If that **character** has more than 1 **portrait** you can select one. You can change that character portrait using the portrait selector on the [Text event](./000) or by making the character join in the same position and selecting a new starting **portrait**.
+
+TODO: Positions image
+
+You can select one of the five positions. If you want to change the current position of a character you would need to add a new join event and pick a new position.
+
+The current 5 positions are the only ones available at the moment, but more customization will come in future versions.
+
+TODO: Mirror icon image and same portrait both regular and mirrored
+
+By clicking on this icon, you can mirror the current character's portrait.

addons/dialogic/Documentation/Content/Events/002.md

@@ -0,0 +1,6 @@
+# Character Leave
+![image](./Images/Event_Character_Leave.PNG)
+
+This events allows to make characters that previously joined with the [Character Join Event](./001.md) leave the screen.
+
+You can choose to make all joined characters leave or choose one. If that character isn't on screen, the event will be ignored.

addons/dialogic/Documentation/Content/Events/010.md

@@ -0,0 +1,14 @@
+# Question Event
+![image](./Images/Event_Question.PNG)
+
+The `Question Event` allows your story to branch and give the player options. 
+When you adding a `Question Event`, two [Choice Events](./011.md) and an [End Event](./013.md) will be added automatically.
+
+## The text editor
+The block itself works very similar to a [Text Event](./000.md) and has all the options of that event.
+
+## The choices
+To add choices to your question you can add [Choice Events](./011.md). 
+
+## Ending a question
+After all your choices, there also needs to be an [End Event](./013.md).

addons/dialogic/Documentation/Content/Events/011.md

@@ -0,0 +1,11 @@
+# Choice Event
+![image](./Images/Event_Choice.PNG)
+
+The `Choice Event` marks the start of a choice branch in a [question](./010.md).
+
+## How it works
+Choice Events only work if they are placed inside a "question" ([Question Event](./010.md)). Then you can place all kinds of events below that choice. These events (which will be indented) will be executed when the choice is selected in game.
+
+## Adding a condition
+By checking the `Has condition` check box and setting that condition, the player will only see that choice if the result is true.
+The condition is made up of three parts: The `Value Definition` that will be compared, the `type of comparison` and the `value` that it will be compared to.

addons/dialogic/Documentation/Content/Events/012.md

@@ -0,0 +1,22 @@
+# Condition Event
+![image](./Images/Event_Condition.PNG)
+
+The `Condition Event` allows you to have certain parts of your timelines only played under certain conditions.
+
+## What's a condition?
+In programming and games a condition is mostly described by variables (in dialogic called `definitions`).
+This means that you can check for a definition to have a certain `value` and only then play the following events.
+
+## The settings
+You can set your condition by first selecting the `value definition` that should be compared, then selecting the `type of comparison` and lastly the `value` that should be compared to.
+Only the comparison types `Equal to` and `Differnt from` work with strings, the rest is supposed to work with integers (whole numbers).
+You can also enter the name of a `value definition` in the input field. This it will compare to the current value of that `value definition`. 
+
+## Adding events
+You can then add new events below the Condition Event and they will be indented and only be played when the condition is true.
+
+## Ending a condition
+Every condition needs to have an [End Event](./013.md). After that event, all following events will ignore the condition again.
+When creating a Condition Event a End Event will be added too.
+
+*Note: You can of course have conditions inside conditions. Just make sure to have the same amount of End Events*

addons/dialogic/Documentation/Content/Events/013.md

@@ -0,0 +1,3 @@
+# End Event
+
+This event does by itself. Its only function is to mark the end of a [question](./010.md) or [condition](./012.md).

addons/dialogic/Documentation/Content/Events/014.md

@@ -0,0 +1,11 @@
+# Set Value
+![image](./Images/Event_Set_Value.PNG)
+The `Set Value` event can be used to change the value of `value definitions`. 
+
+## The options
+You can select the `value definition` to be changed, then the `type of change`. Lastly the new `value` to set.
++ `[to be]` will set the definition to EXACTLY the given value.
++ the others will use the existing value and change it in the given way. These only work with numbers.
+
+By toggling the little cube icon, you can use a random number instead of the fixed input field.
+![image](./Images/Event_Set_Value_random.PNG)

addons/dialogic/Documentation/Content/Events/030.md

@@ -0,0 +1,21 @@
+# Audio Events
+*The Audio Event and Background Music Event are very similar, so they are explained together*
+![image](./Images/audio_event.png)
+
+The `Audio Event` can be used to play sounds. In contrast, the `Background Music Event` is supposed to play long pieces. There can always be only one background music, but it can fade from one to the next. 
+
+## Options
+First of all you can select the audio file that should be played. You can clear this selection with the garbage icon.
+
+Then you can set a `AudioBus` to use and a preferred `volume`. More about AudioBus' [here](https://docs.godotengine.org/en/stable/tutorials/audio/audio_buses.html).
+
+The `Background Music Event` additionally has a option for the fade length. 
+
+## Looping Audio?
+Actually the `Audio Event` doesn't loop. In godot looping of audio is mostly due to how you imported it (default for .ogg files). 
+
+To solve this: 
+1. Select your audio file.
+2. Go to the import tab (it's next to the scene tree tab by default)
+3. Uncheck the loop checkbox.
+4. Hit re-import.

addons/dialogic/Documentation/Content/Events/040.md

@@ -0,0 +1,23 @@
+# Emit Signal
+![image](./Images/Event_Emit_Signal.PNG)
+
+The `Emit Signal` event will emit the signal `dialogic_signal` of the **current dialog node** and pass the given string as an **argument**.
+The event does NOT create a new signal!
+
+If you instance your dialog via script, use a code similar to this:
+```gd
+func start_dialog():
+	var dialog = Dialogic.start("my_timeline")
+	dialog.connect("dialogic_signal", self, "dialog_listener")
+	add_child(dialog)
+
+func dialog_listener(string):
+	match string:
+		"quest_point_two":
+			# do something
+			pass
+```
+
+If you instanced the scene using the editor you can connect the signal like you would always do in Godot from the `NODE TAB > Signals`.
+
+*If you don't know about signals you should definitely learn about them. For example [here](https://docs.godotengine.org/en/stable/getting_started/step_by_step/signals.html).*

addons/dialogic/Documentation/Content/Events/041.md

@@ -0,0 +1,5 @@
+# Change Scene
+
+The `Change Scene` event will stop the current scene and load the selected one. This means the dialog will be stopped too. 
+
+Be careful when using this while you your tree is set to paused! Consider adding an [Emit Signal event](./040.md) before and resuming the tree with `get_tree().paused = false`.

addons/dialogic/Documentation/Content/Events/042.md

@@ -0,0 +1,31 @@
+# Call Node
+![image](./Images/Call_Node.PNG)
+
+This event allows to call a function in a node or an autoload and pass an array to that function.
+
+Many people struggle with the first setting the node. You will have to either put in a full path (starting from root) or a relative path. 
+
+#### Using a relative path
+*You need to have a basic knowledge of relative paths. You can learn a bit about them [here](https://docs.godotengine.org/en/stable/classes/class_nodepath.html).*
+The path needs to be relative to your DialogNode. This means you need to consider where it will be added to. 
+Let's for now imagine an example scene tree like this:
+
+`- World
+-- Temple
+-- NPC`
+
+Now in the NPC's script the dialog node is added as a child of the NPC node. When getting instanced, there will be a canvas layer inbetween resulting in an actual tree like this:
+
+`- World
+-- Temple
+-- NPC
+--- CanvasLayer
+---- DialogNode`
+
+But we want to call a function in the Temple scene with our Call Node Event. From the structure above we can see that we need to go up three times and then down one time to get from the DialogNode to the temple, so this is the resulting path:
+`'../../../Temple'`
+
+*Of course if you have canvas_layer set to false in Dialogic.start() you need on '..' less.*
+
+#### Using the name of an autoload
+If you have instead an autoload it's wonderfully easy. You can just use the name of the autoload!

addons/dialogic/Documentation/Content/Events/CustomEvents/CreateCustomEvents.md

@@ -0,0 +1,122 @@
+# Creating custom events
+![HeaderImage](./Images/CustomEventsShowOff.PNG)
+
+
+# Introduction
+### What are Dialogic events?
+Events are visual representation of data. Whenever you create one event in your timeline, you are modifying a dictionary with a lot of keys and values. Each pair will contain all the information needed to perform an action during the game.
+
+### What makes a custom event?
+A custom event is made up of a two main parts: the **Event Block** and the **Event Handling Script**.
+
+The **Event Block** is the scene that will be shown in the timeline editor. It needs to inherit Dialogic's `EventTemplate.tscn` scene.
+
+In most cases you will additionally need scenes that have all the setting controls in them. These will be the "content" of your event block. This kind of scenes will have to extend the `EventPart.gd` script.
+
+Here is a very simple example of an `EventBlock`:
+![EventBlock](./Images/EventBlock.png)
+It contains two **EventParts**, a **header** and a **body**.
+
+The **Event Handling Script** is what contains the logic and what will happen when your event happens in the game. This script will need the `handle_event()` function that will be called if the event is reached.
+
+All of the files that are used for creating a custom Event Block and Handling Script should be in this directory: `res://dialogic/custom-events`. That way Dialogic can recognize it and show it in your timeline editor.
+
+
+
+
+# Making your first custom event in 6 steps
+Let's now create a simple event that will print some text to the Output panel in Godot.
+
+
+## Create the event
+Go to the `settings page` and in the `custom events section` hit the `New` button. 
+Fill in a name for your event, a folder name and an id. For the id's I recommend using your name or a string unique to you followed by a number. 
+**The id has to be different for every event!!!**
+This is why I recommend the unique string, because it will enable you to share the event with others without breaking their games.
+![Creating](./Images/CreationProcess.PNG)
+
+When you are ready, hit `Create`. You will see the folder appear in the `FileSystem` under `res://dialogic/custom-events/`. 
+
+If you go to the `timeline editor` now, you should already be able to see your event in the event list.
+
+### What happened
+This little menu already created a number of things for you:
+- The `EventBlock` (EventBlock.tscn)
+- An example `EventPart` (EventPart_Example.gd/.tscn)
+- The `event handling script` (event_+EVENTID+.gd)
+- A `stylebox` for your event (Stylebox.tres)
+
+
+
+## What next
+The automatic process already setup a lot. But it didn't know the purpose of our event.
+So we will have to add that.
+
+### | Adding the data
+First we want to open the `EventBlock.tscn` scene. (Do not rename this scene!)
+
+Select its root node and look at it's exported variables in the inspector.
+
+We will need to add all the data, that our event can have to the `event_data`.
+You can see, that it alread contains your event id. This needs to be there, do not delete it!
+
+I want to be able to set a text that will be printed, when my event is activated, so I'll add an information slot for that:
+![EventData](./Images/EventBlock_EventData.PNG)
+
+### | Icon and Stylebox
+You can also change your events icon in the inspector. Just drag an image into the `Event Icon`.
+
+Below that, you can open the Stylebox and change its background color, to give your event a unique look.
+
+
+### | The Event Blocks Content (EventParts)
+Right now your event block will be empty so let's change that (if you want to).
+
+The content of an EventBlock is separated as `EventParts`. This allows for some reuse.
+There are two places EventParts can be in an EventBlock: The Header (always visible) and the Body (can be hidden).
+
+*An EventBlock does not have to have a body nor a header EventPart. For example the End Branch event has none.*
+
+There is already a simple example `EventPart` (Script and Scene) included. You can change it as much as you want.
+
+#### | Loading the data
+In `load_data()` you will need to set the values of your control nodes. This function is called when the event is added to the timeline editor.
+
+#### | Saving changes to the data
+When the values get changed (listen to it via signals) set the according value in the `event_data` dictionary and call `data_changed()`.
+
+This is pretty much all you need to know.
+*If you want to find more examples you can go to `res://addons/dialogic/Editor/Events/Parts/` and look at the EventParts that shape Dialogic's default blocks.*
+
+### | Using the EventPart
+Once you finished everything in your EventPart(s) you need to go into the `EventBlock` scene and set the `header`/`body` variable in the inspector to the new scene(s).
+
+
+
+### | The event handler script (event_yourname_000.gd)
+Once you have your `EventBlock` finished, you need to add the event handling logic. 
+
+#### | The handle_event() function
+If you open the script you will see, that there is only one function by default, the `handle_event()` function.
+
+It comes with two usefull pieces of information: the `event_data` and a reference to the `dialog_node`.
+
+For me I'll just add
+`print(event_data['print_text']` 
+there. But of course you can do a lot more.
+
+
+Some more stuff is already explained in the script:
+##### Continue
+Use `dialog_node.load_next_event()` to continue with the next event.
+
+##### Waiting
+If you don't want the player to interrupt your event, set `dialog_node.waiting` to `true` while your event is handled.
+Don't forget to set it back to `false`.
+
+
+
+## And done!
+Great, you've created your first custom event for dialogic. 
+
+*Make sure to check Emilio's Discord server just in case someone has already created the custom event that you need. They are super easy to [import](./ImportCustomEvents.md)!*

addons/dialogic/Documentation/Content/Events/CustomEvents/ImportCustomEvents.md

@@ -0,0 +1,9 @@
+# Importing custom events
+
+It's very easy to share `custom events` because they are pretty much self-contained.
+You will just need to get the folder from someone. If you have it, move it into `res://dialogic/custom-events/`.
+
+Then enable custom events in Dialogic's settings menu (if you haven't already).
+You should now find the custom event in the bottom of the event button panel on the right in the timeline editor.
+
+*Vòila! Hope it works ;)*

addons/dialogic/Documentation/Content/FAQ/CSharp.md

@@ -0,0 +1,12 @@
+# Can I use C# with Dialogic?
+
+It is experimental! So if you want to try it out and you find issues, let us know. Usage:
+
+`public override void _Ready()
+	{
+		var dialog = DialogicSharp.Start("Greeting");
+		AddChild(dialog);
+	}
+`
+
+This is the PR that added this feature: [https://github.com/coppolaemilio/dialogic/pull/217](https://github.com/coppolaemilio/dialogic/pull/217)