Supertalk

KO | EN

gitlite — search

#python #hacktoberfest #react #go #golang #machine-learning #macos #java #windows #awesome #cli #pytorch #ios #open-source

(★ 54)

Dialogue scripting language for Unreal Engine

Supertalk Latest Version Download

Download Latest Version (.zip)

// repository documentation

Was this content helpful?

★ 0 (0 ratings)

# Supertalk

**[Sample Project](https://github.com/redxdev/SupertalkSample)**

Welcome to Supertalk! This is a simple dialogue scripting language for Unreal Engine created due to frustration with
visual dialogue tree workflows.

The plugin is made up of two parts: an editor module and a runtime module. The editor module handles importing supertalk
scripts (.sts files) into a form that the engine can use. The runtime module includes a supertalk "player" which handles
playback for imported scripts.

Supertalk is currently configured for Unreal Engine 5.1, but may work with earlier versions with some minor modifications.

**Supertalk is not a ready-to-use solution for dialogue systems!** It requires a good amount of integration work and comes
with no UI. While it does integrate well with blueprint, initial integration with a game requires knowledge of C++ and no
support will be offered beyond this documentation.

## Warning

Supertalk is still under development. While it works, syntax is subject to change.

## Known Issues / TODOs

* Issue: Recursive calls into `USupertalkPlayer::PlayScript` are not currently allowed, though they should technically be possible. This
  somewhat limits how dynamic scripts can be (you can't change what section is playing based on external data) but this will be
  fixed in the future.
* Issue: The way the supertalk parser/importer emits errors is a bit odd, haven't quite figured out how to deal with the message log the
  right way. It generally works fine but might not be implemented the "right" way.
* Issue: Localization support hasn't been very well tested.
* TODO: Tool to automatically insert localization markup in script files.
* TODO: Support for escape sequences in strings.
* TODO: More expression operators (basic math, less/greater than, etc)
  * Math operators will require explicit number type support
* TODO: Replace variable values with an expression type.
  * Requires expression support in more places before this change can be made.
  * Also requires replacing "member" values with an expression. Unsure how this will be implemented, will likely need to break backwards compatibility.
* TODO: Rework `USupertalkValue` to not require an entirely new object for every value being passed around.
  * Potentially support raw UObjects without a wrapper object.
  * Refactor things to support passing around basic types without a UObject allocation.
* TODO: track source file context at least in non-shipping builds to allow emitting better error messages at runtime.
* TODO: True function call parsing
  * Current method of calling functions relies on FText and CallFunctionByNameWithArguments, both of which are bad since we can't pass complex types around.
* TODO: Support for additional types
  * Integers, floats, etc.
  * Should be done as part of the new function call parsing system
* TODO: Editor improvements
  * General stability improvements for the script editor

## Scripting Syntax + Features

Scripts have the extension `.sts` and can be imported once this plugin is enabled simply by dragging one into the content browser.
Alternatively, you may turn on auto-import which is the more ideal workflow as it will automatically re-import changes made to the
script files.

```
-- Comments are preceded by two dashes

-- Very simple variables can be used. You can reference assets within a script which can be used
-- to define who is speaking a line of dialogue, or if they implement the ISupertalkDisplayInterface
-- they can be embedded within lines of dialogue themselves.
-- Supertalk will attempt to resolve the variable to an asset as long as the value starts with a slash.
-- For example, you could have a "character" asset that would be used here that contains references to
-- portrait images, the character's name, etc.
Person1 = /Game/MyGame/Characters/Person1
Person2 = /Game/MyGame/Characters/Person2

-- This will play a line of dialogue.
Person1: Hello, world!

-- You can use FString::Format syntax to reference variables.
Person2: Hello, {Person2}!

-- Data tables with a row type of FSupertalkTableRow can be used to share textual data across scripts.
-- Rows can be accessed via a "." - types other than data tables may also support this syntax, see the
-- integration guide for details.
MyDataTable = /Game/MyGame/Data/SomeDataTable

Person2: My datatable says {MyDataTable.Key1} and {MyDataTable.Key2}!

-- You can pass just a string as a speaker's name
"Some third person": I'm not predefined in a variable!

-- If you don't have any special characters, you don't need to quote the name (though you may still want to
-- in order to differentiate it from an actual variable).
Person3: I will appear as "Person3".

-- You can pass an alternate name for a predefined speaker
Person1,"An alternate name": I'm still {Person1} but with a different name.

-- You can pass along attributes with a line - each attribute, separated by a comma, is passed as an FName
-- as part of the line of dialogue. This can be used, for example, to define a position for character portraits to appear
-- or what emotion a character should be showing.
Person2 [Left, Sad]: I'm sad now :(

-- You can add linebreaks freely as long as they are indented. Line breaks will only be added to the final output if
-- you have an empty line (similar to markdown).
Person1: This sentence will span
         multiple lines in the script
         but will appear as a single
         one when played.

This will appear as a second
         line to go along with the first.

-- Supertalk supports calling events on blueprints and UFUNCTIONs on C++ UObjects. See the integration guide for an
-- example of how to do this. Supertalk even supports latent actions (events that take time) and will wait on them
-- if they have been configured appropriately.
-- You can use {Formatting} syntax to pass variables to functions (with some limitations).
> Wait 10
> DoSomethingCool
> DoSomethingElse {Variable1}

-- In some cases you may want to do multiple things at a time. For example, display a line of dialogue at the same time
-- that you have a character walk to a new position. You can do this with a "parallel" block. Note that this is not truly
-- parallel in the sense of threading - this simply runs all statements inside it in order *and then* waits for all of them
-- to complete if any are latent.
[
    > WalkToNewPosition
    Person2: I need to say something while someone walks to a new position.
]

-- Supertalk supports passing along a list of choices with a dialogue line. You can then define what happens with each choice.
-- By default you may only pass along a single statement to execute with a choice - if you want to pass multiple you can use
-- curly braces (*not* square brackets - that would be a parallel block instead) to group multiple statements together.
Person1: Do you like cake or pie?
* Cake
  Person1: You chose cake!
* Pie
  {
      Person1: You chose pie!
      > DoSomethingCool
  }

-- Depending on the game you might find it useful for emit "blank" lines to your integration. This syntax will cause
-- FSupertalkLine::bIsBlankLine to be set to true. The primary use-case is, for example, to setup multiple character portraits
-- without requiring them to actually speak.
Person1 [Sad];
Person2 [Happy];

-- Supertalk supports having multiple "sections" in a single script. Only the first section will execute by default, but you can
-- either include a jump (using an arrow ->) or from C++ tell the supertalk player to run an alternate section. Jumps are normal
-- statements like commands or dialogue lines and as such can be used pretty much anywhere.
-- Note that there is *not* any fall-through from one section to another. If you reach the end of a section and there is no jump then
-- the script will simply stop instead of falling through to the next section.
--
-- The first section - whether named or not - will play when "None" is passed as the initial section to play.

-> Section2

# Section2

Person2: Which section do you want to go to?
* 3
  -> Section3
* 4
  -> Section4

# Section3

Person2: I'm in section 3!
-> Section5

# Section4

Person2: I'm in section 4!
-> Conditionals

# Conditionals
-- Supertalk has very basic support for control flow/conditional execution. You can set a variable to true or false either in a script or from C++:
MyTrueValue = true
MyFalseValue = false

-- And then test the value using an if statement.
if MyTrueValue then Person1: I'll be executed because this conditional is true!

-- You can add an else clause as well:
if MyFalseValue then Person1: I won't be executed.
else Person1: I will be executed!

-- You can chain if/else statements together:
if MyFalseValue then Person1: I won't be executed.
else if MyTrueValue then Person1: I will be executed!
else Person1: I won't be executed.

-- You can run multiple statements at a time using the usual block syntax with curly braces.
-- Parallel blocks are also supported.
if MyTrueValue then
{
  Person1: I can do one thing.
  Person2: I can do another!
}
else
[
  Person1: If this were executed, it would be in parallel with the next command.
  > SomeCommand
]

-- Basic operators are supported, including tests for equality and unary not operations.
-- Note that the "not" syntax is similar to lua using ~ instead of !.
if ~FalseValue then Person1: I will be executed!
if FalseValue == FalseValue then Person1: I will also be executed!
if FalseValue ~= FalseValue then Person1: I won't be executed.

-> Localization

# Localization

-- Adding '@' after the list of attributes (if they exist) will be used as the key for the dialogue line, for use in i18n.
-- Keys are any arbitrary value that are used to lookup alternative translations - see
-- https://docs.unrealengine.com/4.26/en-US/ProductionPipelines/Localization/Formatting/ for more information.
-- If you don't specify a key then one will be automatically assigned. Unfortunately if the line changes so will the
-- automatically assigned id. As such you should always assign keys manually to any line that can be localized.
-- At some point a tool to auto-generate keys and insert them into supertalk scripts would be nice but it doesn't currently exist.
Person1 [Happy] @L01A: This line could be translated!

-- Choices are localized separately from their owning lines.
Person1 @L01B: Here are some choices that could be translated.
* @L01B_C1 I'm choice 1!
* @L01B_C2 I'm choice 2!

-- Namespaces can be specified by separating them from the key with '/'
-- If a namespace isn't specified, the default namespace "Supertalk.Script.Default" will be used.
Person1 [Sad] @Dialogue.Example/L01C: This line could also be translated!

-- String literals (which are stored internally as FText) can be given localization keys as well, with the same syntax.
MyLocalizedString = @Dialogue.Example/L01D "I'm a string literal that can be localized!"

-- You can apply a single namespace to everything below it with a "namespace directive".
-- This applies regardless of section due to namespace directives being resolved at the time of importing the script rather than
-- at runtime. Specifying a namespace directly (such as in the previous two examples) will override the namespace directive where
-- it is used.
!namespace Dialogue.Example

-- That's it for localization!
-> TheEnd

# TheEnd

Person1: That's the end of the supertalk script overview. Goodbye for now!

-- You can end a script's execution either by having no more statements in a section or by jumping to 'None'
-> None
```

## VSCode Syntax Highlighting

A basic syntax highlighting extension for Visual Studio Code can be found in the `Extras` directory.

![image](https://user-images.githubusercontent.com/472625/121821540-88d35a00-cc4e-11eb-9910-64d69edc6012.png)

## Experimental Editor

An experimental editor can be enabled by going to Project Settings > Editor > Supertalk Editor. Restart the engine after changing this option.
This also lets you create Supertalk scripts within the editor without having to import from an external file.

This editor is *super* experimental and you may lose data when using it!

![image](https://user-images.githubusercontent.com/472625/212571344-f7f56e0e-3f20-4758-ae14-95bf3ae393a8.png)

## Integration Guide

This is an overview of the work necessary to integrate Supertalk into a project.

### Major Types

All of these types are in the `Supertalk` module - generally you will not have to use anything in `SupertalkEditor` as it exists purely
to provide the editor with an importer for supertalk script files.

#### `USupertalkPlayer`

This is your primary interaction point with Supertalk and implements almost all of the major functionality. It is a very simple "VM" that
executes supertalk scripts.

Each Supertalk player contains its own state of execution and list of variables. You can get and set variables on it manually as well.

#### `USupertalkScript`

This is the main asset type for Supertalk.

#### `FSupertalkLine`

Dialogue lines are emitted via this struct. It contains a value representing who is speaking the line, a value for a name override for the
speaker, a list of attributes applied to the line, and the text itself.

Generally you'll want to call `FSupertalkLine::FormatText` to get the text for display, as this will replace any variable placeholders in the
line with data from the Supertalk player.

#### `USupertalkValue`

Base class for a "value" which can be anything - an object, text, datatable, etc.

#### `USupertalkExpression`

Base class for an evaluatable expression that results in a value.

#### `ISupertalkDisplayInterface`

Implement on custom UObjects to provide a way to override how Supertalk will display those objects in dialogue lines. You can also override
`ISupertalkDisplayInterface::GetSupertalkMember` in order to provide a way to get sub-values of an object.

#### `FSupertalkTableRow`

Any data table used within Supertalk should use this row type, which allows storing text that can be reused in multiple scripts.

#### `FSupertalkLatentFunctionFinalizer`

Supertalk uses this object as a way to tell when latent functions are being called. Calling `FSupertalkLatentFunctionFinalizer::Complete()` will tell
the Supertalk player that the action has completed and it may continue. These are also usable in blueprint (to allow for calling latent actions in
events) - a blueprint event being called from Supertalk should call `USupertalkPlayer::MakeLatentFunction` to receive a finalizer and then call
`USupertalkPlayer::CompleteFunction` when it has finished.

If an event is not latent (i.e. it doesn't take up any time) then it should not call `MakeLatentFunction` at all.

### Integrating the Supertalk Player

The Supertalk player is your primary entrypoint into Supertalk - it represents the "state" of a script. You can have any number of them at a time
and they can share scripts, but each one maintains its own state completely separate from the others.

You can create a Supertalk player with `NewObject<USupertalkPlayer>()`. Once created, you can bind events to handle when dialogue lines (or set of choices)
are played, and you can register handlers to receive

```cpp
// In some function somewhere - maybe the initialization for a cutscene class.
USupertalkPlayer* STPlayer = NewObject<USupertalkPlayer>(this);
STPlayer->OnPlayLineEvent.BindUObject(this, &ThisClass::OnPlayLine);
STPlayer->OnPlayChoiceEvent.BindUObject(this, &ThisClass::OnPlayChoice);

// If you want to be able to call functions on the current object (or some other object) from within a script, you need to add a function call receiver.
// Any public UFUNCTION (or blueprint event or function) will be callable, and the syntax for calling a command is the same as the "ke" console command.
STPlayer->AddFunctionCallReceiver(this);

// If you want to expose global variables to a script without having to set them manually, you can add a "variable provider" which is a function that is
// called when a variable isn't found in the player itself. For example, if a variable named `Actor_Something` is found you could parse out the "Something"
// and return a value pointing to the actor named "Something" in the current level.
// Providers are executed in order until one returns something other than null. If they all return null then the variable doesn't exist.
STPlayer->AddVariableProvider(FSupertalkProvideVariableDelegate::CreateUObject(this, &ThisClass::VarProvider_Actors));

// You can also expose all properties of an object to a script. The second argument is a "filter" - properties will only be exposed
// if they exist on child classes (*not including the class itself*)
STPlayer->AddVariableProvider(this, &ThisClass::StaticClass());
```

`OnPlayLineEvent` and `OnPlayChoiceEvent` are important to implement or else you will not find out when a dialogue line/choice has been played. When you are
done playing the dialogue line/choice (which generally entails showing it on-screen and then waiting for user input to continue) you should call the `Completed`
delegate.

For `OnPlayChoiceEvent` you must also pass an integer representing the index of the selected choice. If an invalid choice (or no choice, if that's allowed) is
selected then you should pass `INDEX_NONE` as the index. Note that this will result in no choice statements being executed - the Supertalk player will simply
continue to the next statement after the current set of choices.

After you've created the Supertalk player, you can run scripts with `USupertalkPlayer::RunScript(USupertalkScript* Script)`.

## VM Internals

The Supertalk parser is *only* used for asset importing and as such is editor-only. It is a very simple handwritten lexer and parser combo - The primary entrypoint
is `USupertalkParser::Parse` which calls into both the lexer (`USupertalkParser::RunLexer`) and the parser (`USupertalkParser::RunParser`). Lexer functions are prefixed
by `Lx` while parser functions are prefixed by `Pa`. The result of the parser is a `USupertalkScript` object which can be saved to disk as an asset.

The Supertalk VM/Player is incredibly simple - a script asset is effectively just the AST of the original supertalk script with a little bit of extra processing
done on it. The list of possible action types can be found in `ESupertalkOperation`, while actions themselves are implemented in `USupertalkPlayer`. Each action can
also have additional parameters, implemented by subclassing `USupertalkOperationParams`. Actions themselves are represented by `FSupertalkAction`.

The VM contains a list of stacks (`FSupertalkStack`). Each stack contains a list of actions to be executed and a single active action. Each stack is assigned an id,
as is each action. Ids are used throughout the VM to retrieve stacks and to validate that an operation is happening on the correct stack/action. When a script is
played the VM will start with a single stack and it will queue all the actions for the initial section of that script.

When a latent action is executed (either due to a dialogue line/choice executing or due to `MakeLatentFunction` being called) the current stack is paused. When the action is
completed (via a `Completed` delegate call or via `FSupertalkLatentFunctionFinalizer::Complete()`) the stack is notified and continues.

When a parallel block is encountered a set of new stacks is created - one for each action (or group of actions) inside the block. These stacks are assigned unique ids and the
original stack stores these ids in a waiting list (`FSupertalkStack::WaitingOn`) and pauses itself. When a stack completes (usually due to running out of actions to execute) it
removes itself from the original stack's waiting list. Once that waiting list is empty the original stack will resume execution.

Execution of queue blocks (lists of actions to be executed sequentially inside parenthesis) is not given any special handling - actions are simply added to the current stack
in the appropriate order.

Section jumps cause the current stack to be emptied and then refilled from the given section. The one case where this doesn't happen is upon a section jump to `None`, in which
case the stack is simply emptied - thus ending that stack's execution.

Supertalk

Supertalk Latest Version Download

Today's picks

Was this content helpful?

Recent Feedback

Supertalk

Supertalk Latest Version Download

Today's picks

Was this content helpful?

Recent Feedback

Download README