Skip to main content

Running the Model / Game

Prerequisites​

Before starting, ensure you have:

  1. A GAMA model adapted for VR.
  2. A Unity project with a scene containing the necessary prefabs to connect to GAMA.
tip

See the Tutorial: From GAMA to Virtual Universe for details on designing the GAMA model and Unity project.

Middleware Setup (Required)​

Regardless of whether you run the game in the Editor or on a Headset, the middleware must be running before you start the Unity application.

  1. Download: Get the middleware here.
  2. Configuration Files: The SIMPLE tool generates two files when creating a VR Gaml file:
  • settings.json: Model execution conditions.
  • .env: Configuration for the modeler's workspace.
  1. Installation:
  • Copy the generated .env file (located in your project folder) into the root folder of the middleware.
  • For detailed installation instructions, refer to the Middleware Wiki.

Option A: Running from Unity (Play Mode)​

This method is best for development and testing.

Step 1: Start the Environment​

  1. Run GAMA.
  2. Run the Middleware. (See Getting Started).
Middleware Terminal
  1. Open your browser and go to: http://localhost:8000/.
  2. Select the Game: Click on your project name in the web interface (e.g., traffic_model_VR).
Middleware Interface
note

Ensure your .env file is correctly configured (either automatically via the generated file or manually using the EXTRA_LEARNING_PACKAGE_PATH variable).

Step 2: Play in Unity​

  1. Open the relevant Scene in Unity (it must contain a Connection Manager and a Game Manager).
  • Example: Scenes/Code Examples/Receive Static Data.
  1. Click the ▶ Play button.

Unity Play Button

Using the XR Device Simulator​

If you do not have a headset connected to the PC, you can simulate VR inputs using the keyboard and mouse.

1. Setup​

  1. In the Project Explorer, search for simulator.
Search Simulator
  1. Drag and drop the XR Device Simulator prefab into your hierarchy.
Drag Simulator

2. Configuration​

To move faster in the scene, adjust the sensitivity in the Inspector:

  • Look for Keyboard X / Y / Z Translate Speed.
  • Set values to 20 for faster navigation.
Simulator Settings

3. Controls​

Once inside Play Mode, use the following controls:

ActionControls
Move HorizontalW/A/S/D (or Z/Q/S/D depending on layout)
Move VerticalE (Up) / Q or A (Down)
Look AroundHold Right Mouse Button + Move Mouse
Toggle ControllerPress Y to toggle the Right Controller
Trigger ActionPress G (while controller is active)
warning

Remove the Simulator before Building! The XR Device Simulator is for editor testing only. You must delete it from the scene before building the application for a real headset.

Option B: Running from a Headset (Standalone)​

To run the simulation directly on a standalone headset (like a Meta Quest), follow these steps.

Step 1: Network Configuration​

  1. Ensure your PC (running the WebPlatform) and your Headset are connected to the same Wi-Fi network.
  2. The WebPlatform IP is entered at runtime via the IP Menu that appears when the app launches on the headset — no build-time configuration is needed.
tip

The IP Menu remembers the last address you entered. You only need to re-enter it if the WebPlatform moves to a different machine.

Step 2: Build and Export​

  1. Go to File > Build Profiles.
Build Profiles
  1. Select Android and click Switch Platform (this may take a few minutes).
Switch Platform
  1. Click Open Scene List and ensure your main scene is checked. If missing, open the scene and click Add Open Scenes.
Scene List

Step 3: Deploy to Headset​

  1. Connect your headset to the PC via USB-C.
  2. Accept any USB debugging authorizations inside the headset.
  1. In Unity, click Build and Run.
  2. Select a folder to save the .apk file.

Step 4: Launching on Headset​

  • If the app doesn't launch automatically:
  1. Put on the headset.
  2. Go to your App Library.
  3. Select the filter dropdown (usually says "All").
  4. Select Unknown Sources.
  5. Click on your application name.