Sequential Training ToolKit, or STTK, is a software toolkit Plugin for the Unity Development
Platform so software developers can easily develop structured sequential training
applications for Gaming and Extended Reality (XR) environments based on Bloom's Learning Methodology.
STTK is architected for software developers to easily import the toolkit as a plugin for the Unity
Development Platform then simply interact with the Graphical User Interface (GUI) for functionality.
Functionality includes, but not limited to, the ability to drag and drop animations and models into a
developed Sequential Manager GameObject; easy add-on plugins for Prefabs; and auto builds a State
Machine.
STTK's architecture, GUI, and functionality are based on our paper Extended Reality for Enhanced
Training and Knowledge Capture, which additionally proposed sequential
learning should model Bloom's Learning Methodology.
- Centralized Sequential (Game) Manager - Will hold key information for the sequential training
- Person Name
- Build time
- Animations lists
- Wording for each animation list including visual as well as feedback
- Scene Control
- Sections within each scene
Note: this requires you to have your own model as well as animations associated with this model to create a training project with
STTK.
- Start New Unity Project
- Download the
STTK_V*.unitypackagefile- Note:
*indicates placeholder for version number
- Note:
- In your Unity Project
- In the tool bar located at the top select Assets -> Import Package -> Custom Package
- Wait for the package to open
- Select
Import(this will import in the entire package which is recommended)
- Import in your Model and Animations (the same way mentioned in the previous steps) or simply move your model and animations files in to the assets folder for the project
- At the top of the Unity Editor
- Select Assets -> Import Package -> Custom Package
- Select your Animations and Model Package
- Note: If you plan on changing your animations make sure to include your animation controller attached to your model.
- Click
Import
- With your project and scene open
- Go up to the tool bar and select STTK -> Add SequentialTrainingToolKit Components
- Note: This will add a
SequentialTrainingToolKitGameObject to your Hierarchy as well as a model object
- Note: This will add a
- Select the
SequentialTrainingToolKitObject in your Hierarchy - In the Inspector on the right
- Notice the
Demo,Teach, andTesttabs DemoandTeachhave the same list connection, anything changed in either will be the same list to keep the process the same for the learning.- There is an Overview textbox for each
Demo,Teach, andTestthat have textboxes to give a description for each training type. - In the
Teachtab there is a Finished textbox enter in a finishing phrase for your training here for when your animations finish.
- Notice the
- In
DemoandTeachtabs there are reordered lists that have a plus to add an item to the list and a minus to remove an item from the list- Each item in the list has three things
- Animation box - Animation for the model that is being shown
- Feedback Desc box this will be what is said out loud as audio for each step
- Visual Desc box this will be the text in the training description box for each step in the training
- Each item in the list has three things
Note: Requires Importing in the
STTK_V*.unitypackageand theSTTK_V*_with_Plugins.unitypackage*indicates placeholder for version number
- Now you need to open the SequentialTrainingFramework including the
STTKand theMenuFramework - This will be a scene located in AddOns -> Scenes -> SeqTrainingFramework
- Select the
SequentialTrainingToolKitObject in your Hierarchy - In the Inspector
- Notice the
Demo,Teach, andTesttabs DemoandTeachshould have the same list connection, anything changed in either will be the same list to keep the process the same for the learning processes.- There is an Overview textbox for each
Demo,Teach, andTestthat will be spoken out whenever going into one of the training's - In the
Teachtab there is a Finished textbox enter in a finishing phrase for your training here, which means at the end of all of the animations in your sequential training this phrase will go off
- Notice the
- In
DemoandTeachthere are reordered lists that have a plus to add an item to the list and a minus to remove an item from the list- Each item in the list has three things
- Animation box
- Feedback Desc box this will be what is said out loud as audio for each step
- Visual Desc box this will be the text in the training description box for each step in the training
- Each item in the list has three things
- Now go to your animations folder you imported in
- Select the
SequentialTrainingToolKitGameObject in the Hierarchy - In the inspector select the Teach tab
- Click the
+(Plus) button - Drag and drop your first animation in
- Type out a Feedback audio description of the animation training
- Type out a Visual description of the animation training
- Select the
- Repeat the step above until you have all of your animations set up in a sequence within the list (from top to bottom with descriptions)
- Then drag and drop your model in the the
STTKgenerated Models folder in your hierarchy. - Next drag and drop your model into the Training Model box in the
SequentialTrainingToolKitInspector. - Click the button labeled Create State Machine
- Note: this Animator Controller generates into the Resources folder
- Clicking this button will build a Runtime Animator Controller for your animations you just drag and dropped in to the
TeachList. This Controller is build for sequential training
- Select the animation speed you would like for the animations run at with the Animation Speed Slider in the
SequentialTrainingToolKitInspector
MenuFrameworkis framework to develop menu systems for Extended Reality Applications; for more information, please see ourMenuFrameworkGitHub repository here.- The added menu system can be used to control the
STTKanimations and the generated state machine- The menu system can be used within the
SeqTrainingFrameworkscene - The menu system is prefabed in STTK->AddPlugins->MenuFramework->Prefabs and can be drag and dropped into the hierarchy for use
- The menu system can be used within the
- The added menu system can be used to control the
- In order to use the menu system there is a default button that can be used to start your training or there is a prefabed button in STTK->AddPlugins->MenuFramework->Prefabs
- The main button to change is located in MenuFramework->MenuCanvas->Main Functionality->TrainingList->TrainingButton
- This button has an
Interactablescript which is used to control theonClick - Default calls are made on this
Interactablescript to control the animations and model fromSTTK
- Note: The animation method calls to start, pause, reset model, etc are listed below if you would like to control the animations
- This button has an
To run the animations that were just added to the sequence list (in the previous section). This requires method calls within the STTK main script SequentialTrainingToolKit
- Create a button (UI or 3D)
- Add Button script component
- Call
SequentialTrainingToolKitObject - Call the animation methods that you prefer
- Demo (
SequentialTrainingToolKitObject)BeginDemoAnimation()PauseDemoAnimation()PlayDemoAnimation()
- Teach (
SequentialTrainingToolKitObject)BeginTeachAnimation()PlayTeachAnimation()PauseTeachAnimation()NextTeachAnimation()PreviousTeachAnimation()PauseTeachAnimation()
- Test (
TimerObject)StartTimer()StopTimer()
- Demo (