Guide API Documentation
Welcome to the Guide API Documentation. Below you will find detailed descriptions of each structure along with examples for better understanding.
Options
Structure: [Text of the option]
Example:
1.Introduction
Description:
You should think of the options as intentions rather than the whole text that is going to be said. For example: Introduction = "Hello, My name is John, I am happy to be here." While the option is Introduction, the whole text will be "Hello..."
Lock With Score
Structure: [Key Name] + < or > or = + Score
Example:
Cres < 0
Description:
This is to reduce what dialogs are visible. For example, if the Cres is less than 0, make it appear. The '=' sign should be used if the score is equal. You may choose some scores to be visible.
Give Score
Structure: [Key Name] + '+' + Value
Example:
Intro + 1
Description:
Use this to add to a score
Give Score
Structure: [Key Name] + '-' + Value
Example:
Mark - 1
Description:
Use this to reduce from a score
Give Score
Structure: [Key Name] + '=' + Value
Example:
Intro = 100
Description:
Use this to set a score to a number
Give Score
Structure: &
Example:
Intro = 1 & Mark - 1
Description:
Use this to do more than one in the same option
Commands and Move Tree Orders
Structure: GoTo + : + The Number of the Tree you Want To Go + _ + Optional Comments for you
Example:
GoTo:1_This is the talking Tree
Description:
Use this to switch trees when you are ready
Commands and Move Tree Orders
Structure: &
Example:
GoTo:1_This is the talking Tree & $OnlyOnce
Description:
Use this to add more than one command
Commands and Move Tree Orders
Structure: Open + : + Number Of the Object you want to open + _ + Optional Comment
Example:
Open:1_Case Notes
Description:
Use this to open case notes
Notes
Structure: Student + _ + Notes
Example:
Student_I think that I made him angry, I should remember to check back on the issue later
Description:
Notes that appear to the student's notepad as personal notes
Notes
Structure: Tutor + _ + Notes
Example:
Tutor_The student made them angry
Description:
Notes that appear to the student as Tutor Notes
Notes
Structure: Legal + _ + Notes
Example:
Legal_On 11 of October, it was agreed that...
Description:
Notes that appear to the student as Legal notes
Notes
Structure: ;
Example:
Tutor_The student made them angry; Legal_On 11 of October, it was agreed that the student made them angry
Description:
Use this to add more than one note in the same option
Interaction
Structure: Actor + _ + Text
Example:
Tutor_you are late
Description:
This text usually contains dialog and sound clip
Interaction
Structure: Actor + _ + Text + ; + Actor2 + _ + Text2
Example:
Tutor_you are late & Student_Yes, but I got you a coffee
Description:
For more than one dialog in the same interaction. You may choose different actors at the start
Interaction
Structure: Actor + _ + Expression + - + Text
Example:
Tutor_Angry - You are late & Student_Happy - Yes, but I got a coffee
Description:
You may add some basic facial expressions using this format
Interaction
Structure: Actor + _ + [Inner Thought] + Text
Example:
Student_[Inner Thought] oh no... I forgot my notes
Description:
This designates the color of the subtitles; additionally, the sound will be heard using an echo as well.