Unreal Engine
=============

This guide provides detailed instructions to download, set up, and run the AMFITRACK SteamVR driver in Unreal Engine 5.5.

Prerequisites
-------------

Before you begin, ensure the following prerequisites are met:

- **Unreal Engine**: Install `Unreal Engine <https://www.unrealengine.com/en-US>`_.
- **AMFITRACK SteamVR driver**: Install :doc:`AMFITRACK SteamVR driver <SteamVR>`


Unreal Engine Setup
-------------------

Follow these steps to set up Unreal Engine, install the required plugins, and add controller pose tracking to an object. These instructions have been tested on Unreal Engine 5.5.

Create a New Unreal Engine Project
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~

1. Open **Unreal Engine**.
2. Create a new project:

   - Select **Blank Project**.
   - Choose the following options:
     
     - **Project Type**: Game.
     - **Programming Language**: Blueprint.

3. Click **Create** to set up the project.

Install Required Plugins
~~~~~~~~~~~~~~~~~~~~~~~~~

1. Open the **Plugins** menu:

   - Navigate to **Edit** > **Plugins**.

2. Search for the following plugins and enable them:

   - **LiveLink**
   - **LiveLinkOpenVR**
   - **LiveLinkXR**

3. When prompted, restart Unreal Engine to apply the changes.

Verify LiveLink Installation
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~

1. Open the **Live Link** window:
   
   - Navigate to **Window** > **Virtual Production** > **Live Link**.

2. Add a new source:
   
   - Click **Add Source** and select **LiveLinkOpenVR Source**.
   - Choose the necessary trackers from the list under **Track Controllers**.
  
3. Verify that four devices are listed. The two main controllers should appear as:
   
   - **Controller_Amfitrack_Controller_Left**
   - **Controller_Amfitrack_Controller_Right**


Set Up an Object with LiveLink Tracking
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~

1. Locate the required Blueprint:
   
   - Navigate to **Project** > **Engine** > **Plugins** > **LiveLinkXR Content** > **Blueprints**.
   - Drag and drop **BP_LiveLinkXE_DataHandler** into the viewport.
  
2. Create a 3D object to track (e.g., a **Cube**).
3. Select **BP_LiveLinkXE_DataHandler** in the **Outliner**.
4. Configure the tracking:

   - Under **Subject Name to Attached Actor**, click the **+** sign to add a new entry.
   - Open **Live Link** and identify the controller name (e.g., **Controller_Amfitrack_Controller_Left**).
   - Enter the controller name in the **Subject Name to Attached Actor** field.
   - Use the dropdown next to the field to select the 3D object for tracking.
  
5. Verify the setup:

   - The 3D object’s location should update based on the AMFITRACK device's movements.


Troubleshooting
---------------

- **Plugins not appearing**: Ensure you’ve installed the correct plugins and restarted Unreal Engine after enabling them.
- **Devices not listed in Live Link**: Verify that the AMFITRACK SteamVR driver is installed and running correctly.


Additional Notes
----------------

- These instructions are specific to Unreal Engine 5.5. For earlier versions, some steps or UI elements may differ.
- For more details, refer to the `official Unreal Engine documentation <https://docs.unrealengine.com/en-US>`_.