Skip to content

Commit 16819ef

Browse files
committed
Updating readme, still WIP
1 parent b359f05 commit 16819ef

File tree

1 file changed

+16
-4
lines changed

1 file changed

+16
-4
lines changed

README.md

Lines changed: 16 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -4,11 +4,22 @@ A simple Godot dialog addon to use in any kind of project.
44
![Screenshot](https://coppolaemilio.com/godot/github-portrait.png?v1)
55

66
## How to use:
7+
8+
### 1) Creating Characters:
9+
_If you don't plan on using character portraits you can skip this step._
10+
711
You first need to create a `DialogCharacterResource` for each character you wish to have in your dialog.
812
To do this, right click in your FileSystem and choose `New Resource`, search for `DialogCharacterResource` and create it.
913
It's good practice to put these inside a `Resources/Characters` folder.
1014
You can assign each character a Name, Image and Color.
1115

16+
There are 3 characters used for the example located at `addons\dialogs\Resources\Characters`.
17+
18+
![Screenshot](https://coppolaemilio.com/godot/character-resource-inspector.PNG?v1)
19+
20+
21+
22+
### 2) Creating dialogs
1223
Once you have created your characters it's time to create a `DialogResource` for your dialog.
1324
Note you can create a separate dialog resource for each of your dialogs if you wish to keep things logically separate, or you can create a master `DialogResource` if you prefer.
1425
To create a `DialogResource`, right click in your FileSystem and choose `New Resource`, search for `DialogResource` and create it.
@@ -20,11 +31,11 @@ You can set the dialog script (.json) on the inspector variable "Dialog Json" or
2031
Now you can add the node `addons/dialogs/Dialog.tscn` to your scenes, assign the desired `DialogResource` file and use it on your projects.
2132

2233
## Changelog
23-
v0.3
34+
v0.3 - Using Resources
2435
- Removed requirement for `global.gd` and `characters.gd` autoload scripts.
2536
- Added `DialogResource` and `DialogCharacterResource` resources to create a cleaner way of specifying dialog content
2637

27-
v0.2:
38+
v0.2 - Adding Characters:
2839
- Changed text speed to fixed per character instead of total time span
2940
- New character support
3041
- Added portrait to characters
@@ -37,13 +48,14 @@ v0.1 - Release
3748

3849
## Credits
3950
Code made by [Emilio Coppola](https://github.com/coppolaemilio).
51+
4052
Contributors: [Tom Glenn](https://github.com/tomglenn)
4153

4254
Placeholder images are from Toen's YouTube DF series:
4355
- https://toen.world/
4456
- https://www.youtube.com/watch?v=B1ggwiat7PM
4557

46-
Thank you to all my Patreons for making this possible!
58+
### Thank you to all my Patreons for making this possible!
4759
- Mike King
4860
- Allyson Ota
4961
- Buskmann12
@@ -53,6 +65,6 @@ Thank you to all my Patreons for making this possible!
5365
- Rienk Kroese
5466
- Tyler Dean Osborne
5567

56-
Support me at [Patreon https://www.patreon.com/coppolaemilio](https://www.patreon.com/coppolaemilio)
68+
Support me on [Patreon https://www.patreon.com/coppolaemilio](https://www.patreon.com/coppolaemilio)
5769

5870
MIT License

0 commit comments

Comments
 (0)