https://github.com/sinbad/suds

Steve's Unreal Dialogue System
https://github.com/sinbad/suds

Last synced: 4 days ago
JSON representation

Steve's Unreal Dialogue System

• Host: GitHub
• URL: https://github.com/sinbad/suds
• Owner: sinbad
• License: mit
• Created: 2022-10-18T16:24:46.000Z (about 2 years ago)
• Default Branch: master
• Last Pushed: 2024-10-24T11:15:26.000Z (2 months ago)
• Last Synced: 2024-10-25T10:19:01.525Z (2 months ago)
• Language: C++
• Size: 21 MB
• Stars: 98
• Watchers: 4
• Forks: 18
• Open Issues: 0
• Metadata Files:
  • Readme: Readme.md
  • License: License.txt

Awesome Lists containing this project

README

        
# Steve's Unreal Dialogue System (SUDS)

![SUDS Logo](Resources/Icon128.png)

## What Is It?

SUDS is a plugin for [Unreal Engine 5](https://unrealengine.com/) which allows you

to run dialogues in your game based on a script that you write in a text 

file.

Scripts look something like this:

![Sample SUDS Script](docs/img/samplescript.png)

> Note: this is an image so that you can see the nice syntax highlighting provided by the

> [SUDS VSCode plugin](https://marketplace.visualstudio.com/items?itemName=sstreeting.suds-code).

SUDS has many features, including:

* Dialogue flow is expressed in a text file for a focussed writing experience

* Multi-line [speech](docs/SpeakerLines.md) support

* Player [choices](docs/ChoiceLines.md) with unlimited embedded responses

* Flow control: [goto](docs/GotoLines.md), [gosub](docs/GosubLines.md), [conditional branching](docs/ConditionalLines), [random lines](docs/RandomLines.md)

* Persistent [variable state](docs/Variables.md)

* Send [events](docs/EventLines.md) back to code/blueprints with any number of arguments

* Supports all the [variable substitution and formatting features](docs/TextMarkup.md) in the same way Unreal does

* A convenient [in-editor testing tool](docs/Testing.md)

* [Localisation](docs/Localisation.md) support, including adding [translator comments](docs/LocalisationTranslatorComments.md)

* Easy integration with save games ([SPUD](https://github.com/sinbad/SPUD) or otherwise)

> SUDS was inspired by [Ink](https://www.inklestudios.com/ink/) and

> [YarnSpinner](https://yarnspinner.dev/), but I started from scratch and 

> designed it specifically to integrate well with Unreal Engine. It also has a 

> number of differences to those systems, based on my own preferences and the 

> needs of my own project.

## Getting Started

* [Installation](docs/Installation.md)

* [Your First SUD Script](docs/MyFirstSUDScript.md)

## SUDS Pro

SUDS is very focussed on providing just a dialogue engine; integrating it with

your other game systems is an exercise for the reader; there are multiple ways

to do it. 

However, if you'd like more of the integration done for you, including supporting

making camera cuts, playing cutscenes, and animating characters, I also publish

[SUDS Pro on Fab](https://fab.com/s/c80e7c961216).

It's pre-built for the engine so you don't need a C++ project, which is also

convenient for people who just want to use Blueprints.

You don't *need* [SUDS Pro](https://fab.com/s/c80e7c961216); 

core SUDS is a perfectly capable dialogue engine on its own

and you can integrate it with the rest of your code how you like. But, if you'd like a little extra 

functionality pre-integrated, and also to help fund development, please consider

buying [SUDS Pro](https://fab.com/s/c80e7c961216).

> ### See Also

> * [Testing Scripts](docs/Testing.md)

> * [Running Dialogue in Game](docs/RunningDialogue.md)

> * [Script reference](docs/ScriptReference.md)

> * [Full Documentation Index](Index.md)

> * [Frequently Asked Questions](docs/FAQ.md)