{"id":16217948,"url":"https://github.com/theludovyc/godot_dialog","last_synced_at":"2025-03-19T10:30:50.998Z","repository":{"id":80821875,"uuid":"393621868","full_name":"theludovyc/Godot_Dialog","owner":"theludovyc","description":"💬 A powerful plugin to easily create interactive dialogs, for your visual novels, rpgs, or other game in Godot-Engine.","archived":false,"fork":false,"pushed_at":"2021-10-10T10:36:51.000Z","size":17690,"stargazers_count":13,"open_issues_count":1,"forks_count":1,"subscribers_count":1,"default_branch":"master","last_synced_at":"2025-03-11T16:41:06.451Z","etag":null,"topics":["godot","plugin","visual-novel","visualnovel"],"latest_commit_sha":null,"homepage":"","language":"GDScript","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/theludovyc.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null}},"created_at":"2021-08-07T08:10:30.000Z","updated_at":"2024-06-18T15:25:13.000Z","dependencies_parsed_at":null,"dependency_job_id":"ad4b1875-89d1-4379-a369-0300875244a9","html_url":"https://github.com/theludovyc/Godot_Dialog","commit_stats":null,"previous_names":[],"tags_count":6,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/theludovyc%2FGodot_Dialog","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/theludovyc%2FGodot_Dialog/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/theludovyc%2FGodot_Dialog/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/theludovyc%2FGodot_Dialog/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/theludovyc","download_url":"https://codeload.github.com/theludovyc/Godot_Dialog/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":243982182,"owners_count":20378605,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["godot","plugin","visual-novel","visualnovel"],"created_at":"2024-10-10T11:47:50.830Z","updated_at":"2025-03-19T10:30:50.265Z","avatar_url":"https://github.com/theludovyc.png","language":"GDScript","funding_links":[],"categories":[],"sub_categories":[],"readme":"# Godot_Dialog\r\n![Godot v3.3](https://img.shields.io/badge/Godot-3.3-blue?logo=godotengine)\r\n![Version](https://img.shields.io/badge/version-0.7-orange)\r\n![License](https://img.shields.io/badge/license-MIT-green)\r\n\r\nA powerful plugin to easily create interactive dialogs, for your visual novels, rpgs, or other game in Godot-Engine.\r\n\r\nWorks in 2D and 3D.\r\n\r\nComplete solution with visual editor to edit dialog's themes, timelines, characters, and saved values.\r\n\r\n[Installation](#installation) —\r\n[FAQ](#faq) — \r\n[Credits](#credits)\r\n\r\n---\r\n\r\n## Features\r\n* Timeline Editor\r\n  * Easily create new timeline and edit it\r\n  * Lots of event-nodes (Text, If/Else, Character Join, Set Background... see wiki)\r\n  * Change timeline to another with an event\r\n* Character Editor\r\n  * Easily create new character and edit it\r\n  * Load portraits/moods and scale it\r\n  * Names are automatically colored in dialogs\r\n* Value Editor\r\n  * Easily create new values and edit it\r\n  * Use them with timeline events or in your code\r\n* Theme Editor\r\n  * Easily customize your dialog's look\r\n  * See what can be look during edition\r\n* Branching dialog\r\n  * Show dialog depending on previous choices\r\n* Conditional dialog\r\n  * Show dialog and choices depending on in-game values\r\n  * Display custom values in dialog\r\n* Execute actions with dialog\r\n  * Emit/Receive signals as needed to connect on your logic\r\n* Json\r\n  * All files are saved in json format\r\n\r\n## Installation\r\n\r\nTo install Godot_Dialog plugin, download it as a [ZIP archive](https://github.com/theludovyc/Godot_Dialogic/releases). Then extract the `addons/GDialog` folder into your project folder. Then, enable the plugin in project settings and restart Godot-Engine.\r\n\r\nIf you want to know more about installing plugins you can read the [official documentation page](https://docs.godotengine.org/en/stable/tutorials/plugins/editor/installing_plugins.html).\r\n\r\n## ⚠ IMPORTANT\r\nThe Godot editor needs a reboot after enabling GDialog for the first time. So make sure to reboot after activating it for the first time before submitting an issue.\r\n\r\n\r\n## 📦 Export\r\n\r\nWhen you export a project using GDialog, you need to add `*.json, *.cfg` on the Resources tab `Filters to export...` input field. This allows Godot to pack the files from the `/GDialog` folder.\r\n\r\n## Get Started\r\nThere are two ways of doing this; using gdscript or the scene editor.\r\n\r\nUsing the `GDialog` singleton you can add dialogs from code easily:\r\n\r\n```gdscript\r\nvar new_dialog = GDialog.start(\"Your Timeline Name Here\")\r\n\r\nadd_child(new_dialog)\r\n```\r\n\r\nAnd using the editor, you can drag and drop the scene located at `/addons/GDialog/Dialog.tscn` and set the current timeline via the inspector.\r\n\r\nFor further informations see this [wiki](https://github.com/theludovyc/Godot_Dialog/wiki).\r\n\r\n---\r\n\r\n## FAQ\r\n### 🔷 Can I use GDialog in one of my projects?\r\nYes, you can use GDialog to make any kind of game (even commercial ones). The project is developed under the [MIT License](https://github.com/theludovyc/Godot_Dialogic/blob/master/LICENSE). Please remember to credit!\r\n\r\n### 🔷 My resolution is too small and the dialog is too big. Help!\r\nIf you are setting the resolution of your game to a very small value, you will have to create a theme in GDialog and pick a smaller font and make the box size of the Dialog Box smaller as well.\r\n\r\n### 🔷 How do I connect signals?\r\nSignals work the same way as in any Godot node. If you are new to gdscript you should watch this video which cover how Godot signals work: [How to Use Godot's Signals](https://www.youtube.com/watch?v=NK_SYVO7lMA).\r\n\r\nEvery event emits a signal called `event_start` when GDialog starts that event's actions, but there are also two other named signals called `timeline_start(timeline_name)` and `timeline_end(timeline_name)` which are called at the start and at the end respectively.\r\n\r\nHere you have a small snippet of how to connect a GDialog signal:\r\n```gdscript\r\n# Example for timeline_end\r\nfunc _ready():\r\n\tvar new_dialog = GDialog.start('Your Timeline Name Here')\r\n\t\r\n\tadd_child(new_dialog)\r\n\t\r\n\tnew_dialog.connect('timeline_end', self, 'after_dialog')\r\n\r\nfunc after_dialog(timeline_name):\r\n\tprint('Now you can resume with the game :)')\r\n```\r\n\r\n### 🔷 Can I create a dialog using GDScript?\r\nYes! it is a bit harder since you will have to create each event yourself, and to do that they have to be valid. You can check already created timelines with a text editor and see how an event should look like. A better tutorial and improvements will come soon.\r\n\r\nA simple example:\r\n```gdscript\r\nfunc _ready():\r\n\tvar gdscript_dialog = GDialog.start(\"\")\r\n\t\r\n\tgdscript_dialog.set_dialog_script( {\r\n\t\t\"events\":[\r\n\t\t\t{ \"type\":GDialog.Event_Type.Text, \"text\": \"This dialog was created using GDScript!\"}\r\n\t\t]\r\n\t})\r\n\t\r\n\tadd_child(gdscript_dialog)\r\n```\r\n\r\n---\r\n\r\n## Credits\r\nInitial project [dialogic](https://github.com/coppolaemilio/dialogic) made by [Emilio Coppola](https://github.com/coppolaemilio)\r\n\r\nMy incredible tester https://github.com/LauraCrossheart\r\n\r\nArt sutemo https://sutemo.itch.io/\r\n\r\nMusic Joseph Gilbert / Kistol\r\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Ftheludovyc%2Fgodot_dialog","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Ftheludovyc%2Fgodot_dialog","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Ftheludovyc%2Fgodot_dialog/lists"}