As a game developer, I want to be able to specify character options in the script file, so that I can more clearly differentiate characters.

Acceptance Criteria

• It's done when there is a way to specify character options in the script
• It's done when you can specify a color for the character's name in the script
• It's done when you can use the character options when writing a line in the script

As a user, I want to be able to show the UI as it was before a script command was executed, so that I can have a rollback feature in my game.

Acceptance Criteria

• It's done when scrolling the mouse up to undo a text command shows the previous text message or nothing depending on the previous state
• It's done when scrolling the mouse up to undo a display background command shows the previous background or no background depending on previous state

Technical Details

It would be better at this point if commands, tokens, and parsing are split into their own domain module and they are interfaced through a trait. Also, the events should be replaced with a global state event that is parsed by all plugins (background and text at this point). This will help implement this feature but also later features that combine a set of commands into a single state change.

As a user, I want to be able to display backgrounds in my visual novel, to better tell the game's story.

Acceptance Criteria

• It's done when there is a script command that allows for the loading of a background image.

As a user, I want to have the ability to optionally show the name of the speaker, so that I can better display the story

Acceptance Criteria

• It's done when the parser can create text commands with an optional speaker
• It's done when the speaker is displayed during play if they exist

Technical Info

The structure for a speaker in script.vn will be:

"Speaker" "Text the speaker says"

In order to differentiate between text with and without speaker, the end of line symbol \n will be used as a separator between text commands. This ticket will for this case introduce the syntax and token parsers on top of the simple parser that now exists.

As a developer, I want to parse the file script.vn in the assets folder, so that I can display its contents in the game.

Acceptance criteria

• It's done when the file script.vn in the assets folder is loaded into memory.
• It's done when the in-memory contents loaded from script.vn are translated into an appropriate command struct that can later be used by the engine.

As a maintainer, I want to show/hide the UI for the text interface, so that I can implement these features in the scripting language.

Acceptance Criteria

It's done when the text in the screen structure is an optional struct that contains all information about speaker and text.

• It's done when the Text UI Plugin shows/hides the text, speaker, and text_background based on the optional struct in the Screen struct.

As a maintainer, I want to pass the whole screen struct to UI plugins so that I have more flexibility on displaying UI components based on the screen.

Acceptance Criteria

• It's done when there is a single message send from the director that sends the current screen to all UI components.

As a game developer, I want to be able to see where the syntax errors happen, so I can more effectively fix errors in my scripts.

Acceptance Criteria

• It's done when parsing errors display the location of the error as the beginning of the corresponding token.
• It's done when the error is displayed clearly before exiting the system and without the need for panics.

Technical Details

As of now the location associated with a token is the location where the parsing of the token ends. It is better to store the location at the point that we push the first item in the stack so that it is easier for the user to understand the error.