{"id":13339736,"url":"https://github.com/hfjooste/UT-Dialogue","last_synced_at":"2025-03-11T14:32:23.642Z","repository":{"id":143013895,"uuid":"489761649","full_name":"hfjooste/UT-Dialogue","owner":"hfjooste","description":"A system used to manage interact widgets, dialogues and voice files","archived":true,"fork":false,"pushed_at":"2022-05-08T14:33:07.000Z","size":184,"stargazers_count":12,"open_issues_count":0,"forks_count":2,"subscribers_count":2,"default_branch":"main","last_synced_at":"2024-10-24T02:32:51.471Z","etag":null,"topics":["dialogue","dialogue-system","ue5","ue5-plugin","unreal-engine"],"latest_commit_sha":null,"homepage":"","language":"C++","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"unlicense","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/hfjooste.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":"2022-05-07T19:15:36.000Z","updated_at":"2024-07-09T20:55:09.000Z","dependencies_parsed_at":"2023-05-06T19:49:22.531Z","dependency_job_id":null,"html_url":"https://github.com/hfjooste/UT-Dialogue","commit_stats":null,"previous_names":[],"tags_count":1,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/hfjooste%2FUT-Dialogue","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/hfjooste%2FUT-Dialogue/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/hfjooste%2FUT-Dialogue/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/hfjooste%2FUT-Dialogue/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/hfjooste","download_url":"https://codeload.github.com/hfjooste/UT-Dialogue/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":243052067,"owners_count":20228329,"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":["dialogue","dialogue-system","ue5","ue5-plugin","unreal-engine"],"created_at":"2024-07-29T19:21:15.681Z","updated_at":"2025-03-11T14:32:23.631Z","avatar_url":"https://github.com/hfjooste.png","language":"C++","funding_links":[],"categories":[],"sub_categories":[],"readme":"# Dialogue Plugin\nA system used to manage interact widgets, dialogues and voice files\n\n## Installation\n1. Download the latest release from GitHub\n2. Navigate to `C:\\Program Files\\Epic Games\\UE_{VERSION}\\Engine\\Plugins\\`\n3. Create a `Marketplace` folder if needed\n4. Extract the release and copy to the `Marketplace` folder\n5. Open Unreal Engine\n6. Click on `Edit \u003e Plugins`\n7. Enable the plugin under the `Installed \u003e Unreal Toolbox` category\n8. Restart Unreal Engine\n\n## Dialogue Voice List\nThe `Dialogue Voice List` contains a list of audio files that is played when a dialogue is shown. A random audio file is selected whenever needed. The following properties and functions can be used:\n1. `Voices` - An array of audio files that can be played\n2. `Get Random Voice` - Return a random audio file from the array of available audio files\n\n## Dialogue Interact Widget\nThe `Dialogue Interact Widget` is a simple UI widget that displays some text and an `Input Indicator Widget`. This widget is used when the player enters the `Dialogue Trigger`. The following UI elements are required when creating a `Dialogue Interact Widget`:\n1. `Container` - A `Horizontal Box` that contains all the elements of the widget\n2. `Before Text` - A `Text Block` that is used to display the start of the interact text\n3. `After Text` - A `Text Block` that is used to display the end of the interact text\n\nYou also need to set up the following animations:\n1. `Show Animation` - An animation that is played when the `Dialogue Interact Widget` is shown\n2. `Hide Animation` - An animation that is played when the `Dialogue Interact Widget` is dismissed\n\nThe following functions can be used to interact with the `Dialogue Interact Widget`:\n1. `Show Widget` - Show the `Dialogue Interact Widget` by using the specified information\n2. `Hide Widget` - Hide the `Dialogue Interact Widget` by either playing the hide animation or by just setting the visibility\n\n## Dialogue Widget\nThe `Dialogue Widget` is a simple UI widget that displays a title and message text. The following UI elements are required when creating a `Dialogue Widget`:\n1. `Title Text` - A `Text Block` that is used to display the title of the dialogue\n2. `Message Text` - A `Text Block` that is used to display the message of the dialogue\n\nYou should also set the following properties before using the `Dialogue Widget`:\n1. `Interact Sound` - A `Sound Base` that is played when showing the widget or when skipping a message\n\nYou can interact with the `Dialogue Widget` by using the following functions:\n1. `Show` - Show the `Dialogue Widget` by using the specified information\n2. `Skip Message` - Skip the type animation or continue to the next message in the list\n\n## Dialogue Trigger\nA `Dialogue Trigger` can be added to any actor that the player can interact with. The `Dialogue Trigger` contains all the information for the interaction. Before you can use the `Dialogue Trigger`, you need to set the following properties:\n1. `Player Class` - A reference to the player class. This is used to check if the player is entering the trigger\n2. `Input Indicator Class` - A reference to the `Input Indicator Widget` class that will be used whn entering this trigger\n3. `Interact Before Text` - The text displayed at the start of the `Dialogue Interact Widget`\n4. `Interact After Text` - The text displayed at the end of the `Dialogue Interact Widget`\n5. `Dialogue Titles` - An array of titles displayed in the `Dialogue Widget` after interacting with this trigger\n6. `Dialogue Messages` - An array of messages displayed in the `Dialogue Widget` after interacting with this trigger\n7. `Dialogue Voices` - An array of `Dialogue Voice List` items used by the `Dialogue Widget` after interacting with this trigger\n\nAfter setting up the trigger, you can use the following functions:\n1. `Show Dialogue` - Show the `Dialogue Widget` using the provided information\n2. `Show Interact Widget` - Show the `Dialogue Interact Widget` using the provided information\n3. `Hide Interact Widget` - Hide the `Dialogue Interact Widget`\n\n## Dialogue Manager\nThe `Dialogue Manager` is used to manage all the triggers and widgets. This actor needs to be placed in every map where you use the dialogue system. The following functions is available:\n1. `Is Dialogue Shown` - Return a boolean value indicating if the `Dialogue Widget` is currently shown\n2. `Set Current Dialogue Trigger` - Set the `Dialogue Trigger` that the player is currently inside\n3. `Reset Dialogue Trigger` - Reset the `Dialogue Trigger` after the player leaves the trigger\n4. `Show Interact Widget` - Show the `Dialogue Interact Widget` using the information specified by the current `Dialogue Trigger`\n5. `Show Dialogue` - Show the `Dialogue Widget` using the information specified by the current `Dialogue Trigger`\n6. `Skip Dialogue Message` - Skip the current message in the `Dialogue Widget`\n7. `On Dialogue Dismissed` - Clean up the UI after the `Dialogue Widget` is dismissed","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fhfjooste%2FUT-Dialogue","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fhfjooste%2FUT-Dialogue","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fhfjooste%2FUT-Dialogue/lists"}