Skip to content

Commit

Permalink
Fix outdated Getting Started content.
Browse files Browse the repository at this point in the history
The content of this file contained an older state.
  • Loading branch information
CakeVR authored Dec 3, 2023
1 parent 76bacf2 commit 9490044
Showing 1 changed file with 18 additions and 10 deletions.
28 changes: 18 additions & 10 deletions documentation/getting-started.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,3 @@
# Getting Started

![header_getting_started](/media/headers/getting_started.png)

## 📜 Content
Expand All @@ -12,14 +10,24 @@

## 1. Installation & Activation

First of all, you should install dialogic. This can be done by downloading the latest [release](https://github.com/coppolaemilio/dialogic/releases) zip-file from github, extracting it and moving the addons/dialogic folder to your projects `res://addons/dialogic` (you might have to create the addons folder).
Dialogic 2 requires Godot 4.1 or higher. If you don't know what version you have installed, take a look at the bottom of your Godot Editor.

Let's install Dialogic 2:
- Download the ZIP file here from your wanted Dialogic version: [GitHub Dialogic Releases](https://github.com/coppolaemilio/dialogic/releases).
- Extract the `addons` folder from this ZIP-file, it contains Dialogic.
- Move the `addons` folder to your Dialogic project folder.

Now, let's verify you have correctly installed Dialogic:
- You have this folder path `res://addons/dialogic`
- Head to `Project > Project Settings`
- Click the `Plugins` tab.
- Tick the `enabled` button next to Dialogic.
- Restart Godot

## 🚧How to install the latest WIP version🚧

> *Dialogic is constantly evolving. Oftentimes fixes for bugs or new features might only be available on the main branch. This is especially true during the alpha and beta phase. If you are interested in using the main branch it's easy to do so.*
> *Go to [the main page of the repository](https://github.com/coppolaemilio/dialogic) and click on the green `Code` button then presse the `Download ZIP` button. From there you can install that zip's content like a release.*
Once all the files are where they should be, you can open your project. You will see some errors in the output, but ignore them and enable the plugin under `Project > Project Settings` in the *Plugin* tab. Check the `enabled` button. Then restart your project. If everything went right, you should not see any more errors.
> *Go to [the main page of the repository](https://github.com/coppolaemilio/dialogic) and click on the green `Code` button then presse the `Download ZIP` button. From there you can install that ZIP's content like a release.*
## 2. Meeting the editor

Expand Down Expand Up @@ -54,9 +62,9 @@ You can test the timeline by clicking the `Play Timeline` button at the top righ

## 4. Creating a character

To create a new character press the `Add Character` button on the top right.
To create a new character press the `Add Character` button on the top right.

As for timelines, you need to select the place to save to and a name.
As for timelines, you need to select the place to save to and a name.

⚠️*Important: This name (without .dch) is what will be saved whenever you use that character in a timeline and what you will have to write when referencing the character (e.g. `Emilio: This is a text event.`, if the file is named Emilio.dch). So make sure to give it a good name. You can change the name that will actually be displayed in game as the `display_name` property.*

Expand All @@ -69,9 +77,9 @@ You can learn more about portraits, custom portraits and the character settings

The last important step is to actually have this dialog show up in your game.

For that we need two things to happen:
For that we need two things to happen:

- A) having nodes that can display our timeline and
- A) having nodes that can display our timeline and
- B) start the execution of the timeline.

Luckily for us, Dialogic provides a method that does both of those: `Dialogic.start(@timeline_name_or_path)`
Expand Down

0 comments on commit 9490044

Please sign in to comment.