4. Install the Logger

Add the Metalitix Logger to your Unreal experience

The Metalitix Logger for Unreal Engine 5.0.3 or higher is currently only supported on Windows.

1. Download and unzip the Metalitix Unreal Engine Plugin. Navigate to the folder of your Unreal project. If within there a Plugins folder does not already exist, create it. Place the unzipped Metalitix folder into the Plugins folder.

2. Reload the project by closing it then opening it. You will see the Metalitix icon in the toolbar. If you see a notification Project file out of date, click Update. You may also see a notification New plugins are available. You can also optionally click Manage Plugins... to verify the Metalitix plugin appears.

Unreal toolbar with Metalitix icon

Unreal notifications after install the Metalitix plugin

3. Within your project settings in the Metalitix dashboard you will find an API Key. Copy it then return to your Unreal project. Click the Metalitix icon in the toolbar and select Logger Settings. Paste your API Key underneath API Key.

Adding your API key to the logger settings within Unreal

4. Next, from the actor panel place the MetalitixLogger actor into your game level. Afterwards, select the MetalitixLogger actor you just added and instead its Details set the LoggerSettings and SurveySettings. You can select the first suggestion in each dropdown unless you have created customized settings.

The MetalitixLogger actor in the actor dropdown

The MetalitixLogger settings in the details panel

5. Navigate to your level's camera or pawn and add a TrackingEntity component. This will track the user's movement and send it to Metalitix. In some cases, your pawn may be part of a Blueprint or your GameMode. You can find the Player Pawn by navigating to the World Settings and navigating to the asset in the GameMode field.

Adding a TrackingEntity component to your Unreal pawn

The camera and your scene object should not be parents or children of each other. 

Metalitix will record camera movement relative to your scene object's transformations. So, it is not necessary to manually calibrate the scene in the [Metalitix dashboard](https://app.metalitix.com/). If you do not pass a scene object, then recorded camera movement will be in world coordinates and manual calibration may be necessary.

6. Finally, initialize and start Metalitix tracking using either Blueprints or C++. Obtain the class from the MetalitixLogger actor and call Initialize and StartSession functions. The latter takes in a TrackingEntity parameter, but if none is specified it will use the first available in your project. To learn more about Metalitix functions, please see the API section below.

Starting a Metalitix session using blueprints

7. Metalitix is now configured to gather analytics on your project! 🎉

You can find example Blueprints for Metalitix by enabling the Show Plugin Content option in the Settings of the Content Browser. The Settings icon is found in the top-right. Then navigate to /Plugins/Metalitix Content/Metalitix/Example in the content drawer.