{"id":17721801,"url":"https://github.com/sinbad/suds","last_synced_at":"2025-04-05T22:09:58.378Z","repository":{"id":63778122,"uuid":"553704891","full_name":"sinbad/SUDS","owner":"sinbad","description":"Steve's Unreal Dialogue System","archived":false,"fork":false,"pushed_at":"2024-10-24T11:15:26.000Z","size":21990,"stargazers_count":98,"open_issues_count":0,"forks_count":18,"subscribers_count":4,"default_branch":"master","last_synced_at":"2024-10-25T10:19:01.525Z","etag":null,"topics":[],"latest_commit_sha":null,"homepage":null,"language":"C++","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/sinbad.png","metadata":{"files":{"readme":"Readme.md","changelog":null,"contributing":null,"funding":null,"license":"License.txt","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-10-18T16:24:46.000Z","updated_at":"2024-10-24T11:15:29.000Z","dependencies_parsed_at":"2023-02-19T09:16:13.344Z","dependency_job_id":"5af13ff1-a321-4294-9c39-2aaa6197a39d","html_url":"https://github.com/sinbad/SUDS","commit_stats":null,"previous_names":[],"tags_count":0,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/sinbad%2FSUDS","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/sinbad%2FSUDS/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/sinbad%2FSUDS/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/sinbad%2FSUDS/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/sinbad","download_url":"https://codeload.github.com/sinbad/SUDS/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":247406111,"owners_count":20933806,"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":[],"created_at":"2024-10-25T15:36:17.890Z","updated_at":"2025-04-05T22:09:58.349Z","avatar_url":"https://github.com/sinbad.png","language":"C++","funding_links":[],"categories":[],"sub_categories":[],"readme":"# Steve's Unreal Dialogue System (SUDS)\n\n![SUDS Logo](Resources/Icon128.png)\n\n## What Is It?\n\nSUDS is a plugin for [Unreal Engine 5](https://unrealengine.com/) which allows you\nto run dialogues in your game based on a script that you write in a text \nfile.\n\nScripts look something like this:\n\n![Sample SUDS Script](docs/img/samplescript.png)\n\n\u003e Note: this is an image so that you can see the nice syntax highlighting provided by the\n\u003e [SUDS VSCode plugin](https://marketplace.visualstudio.com/items?itemName=sstreeting.suds-code).\n\nSUDS has many features, including:\n\n* Dialogue flow is expressed in a text file for a focussed writing experience\n* Multi-line [speech](docs/SpeakerLines.md) support\n* Player [choices](docs/ChoiceLines.md) with unlimited embedded responses\n* Flow control: [goto](docs/GotoLines.md), [gosub](docs/GosubLines.md), [conditional branching](docs/ConditionalLines), [random lines](docs/RandomLines.md)\n* Persistent [variable state](docs/Variables.md)\n* Send [events](docs/EventLines.md) back to code/blueprints with any number of arguments\n* Supports all the [variable substitution and formatting features](docs/TextMarkup.md) in the same way Unreal does\n* A convenient [in-editor testing tool](docs/Testing.md)\n* [Localisation](docs/Localisation.md) support, including adding [translator comments](docs/LocalisationTranslatorComments.md)\n* Easy integration with save games ([SPUD](https://github.com/sinbad/SPUD) or otherwise)\n\n\u003e SUDS was inspired by [Ink](https://www.inklestudios.com/ink/) and\n\u003e [YarnSpinner](https://yarnspinner.dev/), but I started from scratch and \n\u003e designed it specifically to integrate well with Unreal Engine. It also has a \n\u003e number of differences to those systems, based on my own preferences and the \n\u003e needs of my own project.\n\n## Getting Started\n\n* [Installation](docs/Installation.md)\n* [Your First SUD Script](docs/MyFirstSUDScript.md)\n\n## SUDS Pro\n\nSUDS is very focussed on providing just a dialogue engine; integrating it with\nyour other game systems is an exercise for the reader; there are multiple ways\nto do it. \n\nHowever, if you'd like more of the integration done for you, including supporting\nmaking camera cuts, playing cutscenes, and animating characters, I also publish\n[SUDS Pro on Fab](https://fab.com/s/c80e7c961216).\nIt's pre-built for the engine so you don't need a C++ project, which is also\nconvenient for people who just want to use Blueprints.\n\nYou don't *need* [SUDS Pro](https://fab.com/s/c80e7c961216); \ncore SUDS is a perfectly capable dialogue engine on its own\nand you can integrate it with the rest of your code how you like. But, if you'd like a little extra \nfunctionality pre-integrated, and also to help fund development, please consider\nbuying [SUDS Pro](https://fab.com/s/c80e7c961216).\n\n\u003e ### See Also\n\u003e * [Testing Scripts](docs/Testing.md)\n\u003e * [Running Dialogue in Game](docs/RunningDialogue.md)\n\u003e * [Script reference](docs/ScriptReference.md)\n\u003e * [Full Documentation Index](Index.md)\n\u003e * [Frequently Asked Questions](docs/FAQ.md)\n\n\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fsinbad%2Fsuds","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fsinbad%2Fsuds","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fsinbad%2Fsuds/lists"}