Project

General

Profile

STE SE Sandbox Exemplar Courses

This page is intended to serve as a supporting document for the STE SE Sandbox Exemplar Courses.

These courses:
  • Set Up Your Machine for SE Sandbox
  • STE SE Sandbox Individual Exemplar course
  • STE SE Sandbox Team Exemplar Course

can be downloaded from the GIFT Downloads page.

Importing GIFT Courses

Once you log into GIFT, you can import a downloaded course with the following steps:

  1. Navigate to the "Take a Course" page if you are not already there, by clicking "Take a Course" in the upper navigation bar.
  2. In the bar below that, at the right side of the screen, left-click "Import".
  3. By left-clicking "Browse" and using the file interface, choose the zip file that contains your course.
  4. Left-click "Select File".
  5. GIFT will import your course, and it will appear on the list of courses that can be taken.

It is highly recommended that this page is open and accessible to the user at all times while running the course(s). The purpose of these course(s) are to exercise the use of the SE Sandbox, a readily available environment used to develop and test ongoing research across game engines. In this instance the SE Sandbox is built upon the Unity game engine.

Information on Courses

Three courses are provided for use with SE Sandbox.

  1. The Set Up Your Machine for SE Sandbox course gives instructions for initial setup.
    • The instructions in this course must be completed before SE Sandbox and GIFT can properly connect.
  2. The STE SE Sandbox Individual Exemplar course showcases a number of ways in which GIFT can work with SE Sandbox to assess the performance of learners, as well as logging the learner's actions for later playback.
  3. The STE SE Sandbox Team Exemplar course showcases the ability of SE Sandbox to allow multiple users to join the simulation together, and of GIFT to assess and log the actions of a team of users.

Set Up Your Machine for SE Sandbox

This course should be run before either of the exemplar courses if you have not yet set up your machine for SE Sandbox.

  • This course is a step-by-step walkthrough on setting your computer up so that it can run SE Sandbox and connect to GIFT.
  • If you start that course and perform the steps as they appear, you will be able to run the STE SE Sandbox Exemplar courses afterward.
  • Much of the information from that course is also included in the Quick Start Guide on this page.
  • NOTE: The Set Up Your Machine for SE Sandbox course never connects to SE Sandbox directly. It lists the steps necessary to do so when running other courses.

STE SE Sandbox Individual Exemplar Course

The STE SE Sandbox Individual Exemplar course showcases several features of GIFT while interfacing with SE Sandbox.

You will be presented with information as text when you first run the course, instructing you on how to begin.

Once you connect to SE Sandbox, you will also see Feedback messages in the GIFT webpage window while you run the course. These will tell you the specifics of what to do, and how you are being assessed. They represent feedback messages which GIFT can provide to learners while they interact with SE Sandbox. Feedback will be presented while you navigate through the five stations and complete actions that cause changes in your performance state.

You will be assessed with the seven following condition classes, which activate individually when you reach the designated stations as instructed in the SE Sandbox simulation.

  • Assigned Sector
  • Avoid/Reach Location
  • Detect Objects
  • Eliminate Hostiles
  • Engage Targets
  • Fire Team Rate of Fire
  • Muzzle Flagging
  • Observed Assessment

When the course is finished, GIFT will display a slide show with more information on each of these conditions.

STE SE Sandbox Team Exemplar Course

The STE SE Sandbox Team Exemplar course showcases the ability to run networked SE Sandbox sessions and train as a team.

As with the Individual course, it contains information as text to instruct you on how to begin, and Feedback messages which give you instructions while you run the course. You will receive feedback only on the "Fire Team Rate of Fire" and "Eliminate Hostiles" conditions, but will be assessed on others as well, which can be viewed in real-time or as recorded logs using the GIFT Game Master.

Quick Start Guide

SE Sandbox can be used by a single player or multiple players. When there are multiple players each player will have their own instance of SE Sandbox. In either case there will always be a single SE Sandbox that manages the world; this is called the Host. A Host SE Sandbox instance can have many other SE Sandbox instances connect to it; these are called Clients.


This diagram shows how a four-player setup would look with GIFT and SE Sandbox. You can choose to run with less players. When there is only one player, only the Host exists in this diagram.

Downloading and extracting SE Sandbox

  1. Download the latest version of SE Sandbox from the GIFT Downloads page.
  2. Right-click the downloaded zip file, and then left-click the menu option "Extract All..."
  3. Type the location of the extracted folder, and left-click "Extract" to extract the files. This will move the extracted files to the location you specify, so they can be accessed later.

To enable communication between SE Sandbox and GIFT during a GIFT Course, GIFT needs to be configured with the network IP address of the SE Sandbox Host (e.g. 10.3.82.1). If you do not know the computer's network IP address please follow the following steps:

Determining SE Sandbox computer network IP

Determine which computer will run SE Sandbox as a Host. This can be any computer. You may need to open certain network ports in order for GIFT and SE Sandbox to work properly. Refer to GIFT network ports for more information, or use the GIFT forums.

  1. On the Host computer, open a command prompt. This can be done by typing "Command Prompt" into the Windows search bar.
  2. In the command prompt, type ipconfig and press Enter.
  3. Information about your Windows IP Configuration will be displayed. Find the line labeled "IPv4 Address" and write that down. That is your Host IP Address.
    • NOTE: Even if you are running SE Sandbox on the same computer as GIFT, do not use an IPv4 "loopback address". This will cause issues connecting to SE Sandbox.
  4. In the default configuration, your Host computer will also run GIFT. However, it is possible to run GIFT and the Host instance of SE Sandbox on separate computers. If you are doing that, repeat steps 2-4 on the computer running GIFT to obtain that computer's IP address as well.

Configure GIFT with SE Sandbox computer network IP address

Follow these steps to set the GIFT Gateway interop configuration value for SE Sandbox:

  1. On the computer running GIFT, navigate to GIFT/config/gateway/configurations/default.interopConfig.xml and open the file in a text editor.
  2. Search for the tag called <SESandbox>. Inside that tag will be another tag called <networkAddress>, which contain the value SESandboxHostIpAddress (unless you have already set it to a different value).
  3. Replace SESandboxHostIpAddress with the Host IP Address you wrote down in an earlier step.
  4. Inside the <SESandbox> tag is another tag called <networkPort>.
  5. Ensure that the value of <networkPort> is 11000. If not, set it to 11000.
  6. Inside the <SESandbox> tag is another tag called <grpcNetworkPort>.
  7. Ensure that the value of <grpcNetworkPort> is 5001. If not, set it to 5001.
  8. Save the change to default.interopConfig.xml.
  9. Close default.interopConfig.xml.
  10. If GIFT is running, exit GIFT before continuing to apply any configuration changes.

Configure GIFT for multiple players

Follow these steps to configure the GIFT properties when you want to run with multiple learners in the same SE Sandbox scenario:

  1. On the computer running GIFT, navigate to GIFT/config/common.properties and open the file in a text editor.
  2. Search for the property called TutorURL
  3. In the TutorURL's value, replace localHost with the IP address of the computer running GIFT.
  4. Search the file for a property called GiftAdminServerUrl.
  5. In the GiftAdminServerUrl's value, replace localHost with the IP address of the computer running GIFT.
  6. Save the changes to common.properties.
  7. Close common.properties.
  8. If GIFT is running, exit GIFT before continuing to apply any configuration changes.

Exiting GIFT

These steps show how to gracefully shutdown GIFT:

  1. Right-click the GIFT icon in the Windows system tray.
  2. In the pop-up menu, left-click "Exit".
  3. A dialog will appear asking if you want to close GIFT. Left-click "Yes".
  4. You may now restart GIFT and any configuration changes will be applied.

Setting up SE Sandbox for Team Training

If you are using multiple instances of SE Sandbox, you will need to perform some setup on each computer that is running SE Sandbox.

Copy or download the SE Sandbox folder to each computer which will run the software.

Each computer which is running SE Sandbox will also need to log into GIFT.

If you are running only one instance of SE Sandbox, and it is on the same computer that is running GIFT, then you do not need to perform these steps.

However, if any instance of SE Sandbox is on a computer other than the one running GIFT, perform the following steps:

  1. On the computer that is currently running GIFT, open a Command Prompt.
  2. Type ipconfig and write down the address on the line labeled IPv4 Address. This is GIFT's network IP address.
  3. On each computer with SE Sandbox, if GIFT is not already installed, open a web browser.
  4. In the web browser, navigate to the address <GIFT network IP>:8080/dashboard where <GIFT network IP> is replaced with the GIFT IP address you wrote down earlier.
  5. Log into GIFT from this computer
    • NOTE: When logging into a GIFT computer, no two computers should use the same login. Use a different account on each computer.

You will need to perform the login steps (3-5) any time you run SE Sandbox from another computer. Once you verify that you are using the correct IP address, you can reuse that later, as long as your IP address does not change. If it does, you will need to perform all of the above steps to determine the new IP address and use that to log in.

To host a session in the SE Sandbox

Follow these steps to host a single or multiple player scenario in SE Sandbox:

  1. Double-click the SE Sandbox executable at <SE Sandbox Install Location>/windows/SE_Sandbox.exe
    • NOTE: <SE Sandbox Install Location> is the location that you extracted SE Sandbox to in the "Downloading and extracting SE Sandbox" instructions above.
  2. A menu will appear with the header "Welcome to the SE Sandbox Demo Application".
  3. In the main menu, select "React to Fire (Forest)" and click Play.
  4. A grassy landscape will appear, with a menu in the top left of the window.
  5. The top text box contains a user name. If the default name is not the one you used to log into GIFT, replace that user name with your GIFT user name.
  6. In SE Sandbox, click "Start Host".
  7. Choose a role from the "Role" drop-down.
    • NOTE: Your role must match the role you are assigned in the GIFT course. In the STE SE Sandbox Individual Exemplar course, this is always "Team Leader". In the STE SE Sandbox Team Exemplar course, you select a role in GIFT, and it must match what you chose. If the role in SE Sandbox does not match the role in GIFT, evaluations may not properly run.
  8. Click "Spawn" under the "Role" drop-down to spawn an entity with that role.
  9. Ensure that all learners are connected and have spawned their entity before continuing.
  10. Once the GIFT session begins, all learners are connected and have spawned entities, and you are ready to start evaluations: left-click "Begin" in the upper right menu of SE Sandbox.
    • NOTE: If a learner spawns an entity after 'Begin' is pressed, its data will not be sent to GIFT. Press 'Begin' again to fix this.

If a session is not being hosted in the SE Sandbox, you will receive an error in GIFT after attempting to start the GIFT networked session. If an error occurs, please click Disconnect in the SE Sandbox application and retake this course.

NOTE: After each GIFT course execution with SE Sandbox, the SE Sandbox application needs to be disconnected with the "Disconnect" button before attempting to run a course that uses this training application again.

Instructions to connect SE Sandbox Client to an SE Sandbox Host

When running multiple instances of SE sandbox, all instances except for the host will be clients, which involve a slightly different startup process.

  1. The SE Sandbox host must already be running for these steps to work. See the above instructions ("To host a session in the SE Sandbox, follow these steps") to start an SE Sandbox host.
  2. Launch the SE Sandbox application. These instructions will refer to the window that appears as the SE Sandbox client window.
  3. NOTE: If you have already launched the SE Sandbox application to start the host, launch it again. The client runs in its own window.
  4. NOTE: You can run this on a separate computer from the SE Sandbox host, as long as it is able to connect.
  5. In the SE Sandbox client window, click "React to Fire (Forest)".
  6. In the SE Sandbox client window, under the word "Client", change the IP address to match the IP address of the SE Sandbox host.
  7. Do not change the port number from 7777. That number is correct.
  8. In the SE Sandbox client window, click "Connect Client".
  9. In the SE Sandbox client window, the UI will show a "Role" drop-down and a "Spawn" button.
  10. Choose your role from the "Role" drop-down.
    • NOTE: Your role must match the role you are assigned in the GIFT course. In the STE SE Sandbox Team Exemplar course, you select a role in GIFT, and it must match what you chose. If the role in SE Sandbox does not match the role in GIFT, evaluations may not properly run.
  11. Click "Spawn" under the "Role" drop-down to spawn an entity with that role.
  12. You now have control of an entity in the SE Sandbox client window. Before running the course, though, you should wait for the SE Sandbox host to finish its setup and for the operator of the SE Sandbox host to click "Begin".


An image of the SE Sandbox and GIFT course running

Using Game Master

The Game Master tab will allow you to view assessment data and a map of entities while the scenario progresses.

To access the Game Master tab while a session is actively running:

  1. Open the system tray in the corner of the Windows Start menu.
  2. Right-click the GIFT icon.
  3. Left-click the "Open GIFT Webpage" option. A new tab will appear with the GIFT login screen.
  4. Log into that tab with the same credentials you used to log into GIFT.
  5. Left-click "Game Master" on the GIFT page. A dropdown menu will appear.
  6. Left-click "Active Session" from the Game Master dropdown menu.
  7. A screen will appear which says that "There are no sessions currently active."
  8. When the SE Sandbox course object begins, the Game Master screen will show a new session called "STE SE Sandbox Team Exemplar". Left-click that to open and display the Game Master map.
    • NOTE: You will know that the SE Sandbox course object begins when the GIFT webpage window shows two mostly empty green panes, with the leftmost pane displaying textual feedback.

The Game Master can also view playback of past sessions that are no longer running.

To view the previous session in Game Master:

  1. Left-click "Game Master" on the GIFT page. A dropdown menu will appear.
  2. From the dropdown menu, left-click "Past Sessions".
  3. Any sessions you have run in GIFT should be listed. Certain selected sessions may be marked as favorites with a highlighted star. These will be at the top of the list.
    • You can click an un-highlighted star to mark its course as a favorite for later reference.
  4. Left-click the session that you want to play back.
  5. Left-click the Play button to begin playback of the recording.

SE Sandbox

Developer Info

  • The SE Sandbox application is built upon the Call-To-Action (CTA) API codebase.
  • The CTA API source code is publicly accessible, and can be viewed at the following links. This can be used to create functionality similar to the SE Sandbox application, or to add new functionality.
  • This can also be used to create new scenarios; the CTA API has the same underlying codebase as SE Sandbox, and thus can communicate with GIFT's SE Sandbox plugin.
  • NOTE: The SE Sandbox release is based on the CTA API's Unity version, and will require a Unity license in order to compile and use the source code.

GitHub Repo: https://github.com/areilly711/CtaApi

API Documentation: https://calltoaction-docs.s3-us-west-1.amazonaws.com/cta/_site/index.html

In-game Controls

To access these controls while running SE Sandbox, press the Esc key.

Keyboard Key Result
WASD or arrow keys control movement in first person mode
Left mouse button shoot
Right mouse button use weapon scope
Esc access menu options and display controls
Tab toggle HUD visibility (in HUD: weapon safety on/off, weapon up/down state, and ammo count)
e toggle weapon safety on/off (change shown on UI)
q toggle the weapon up/down (change shown on UI)
r reload
c prone
i activate night vision
F11 view player names

SE_Sandbox_Network_Diagram.PNG View (39.6 KB) Cambata, Michael, 10/29/2021 02:03 PM

tuiAndSESandboxScreenshot_small.PNG View (474 KB) Cambata, Michael, 11/02/2021 06:21 PM

giftRoleSelector.png View (155 KB) Cambata, Michael, 11/03/2021 09:48 AM

seSandboxRoleSelector.png View (273 KB) Cambata, Michael, 11/03/2021 09:48 AM

seSandboxForestOpfor.png View (254 KB) Cambata, Michael, 11/03/2021 10:22 AM

giftIconExitMenuOption.png View (3.66 KB) Cambata, Michael, 11/08/2021 02:19 PM

giftIconInWindowsSystemTray.png View (18.7 KB) Cambata, Michael, 11/08/2021 02:19 PM

importedCoursesButton_small.png View (54.1 KB) Cambata, Michael, 11/08/2021 02:25 PM

seSandboxMenuScreen_small.png View (24 KB) Cambata, Michael, 11/08/2021 02:28 PM

seSandboxBeginButton_small.png View (250 KB) Cambata, Michael, 11/08/2021 02:35 PM

seSandboxConnectScreen_small.png View (336 KB) Cambata, Michael, 11/08/2021 02:36 PM

seSandboxUserNameEditor_small.png View (260 KB) Cambata, Michael, 11/08/2021 02:38 PM

importButton_small.png View (5.82 KB) Cambata, Michael, 11/08/2021 02:44 PM

seSandboxIPAddressEditor_small.png View (309 KB) Cambata, Michael, 11/08/2021 02:47 PM

pastSessionFavorites_small.png View (75.7 KB) Cambata, Michael, 11/10/2021 04:45 PM