4. Install the Logger

Add the Metalitix Logger to your Unity experience

Supported Unity Versions

2021.3.0 and higher, or editors with .netstandard 2.1 support ✅ Tested on 2021.x.x, 2022.x.x, 2023.x.x

Supported Platforms

Console, PC, Mobile, and VR

Render Pipelines

Universal, Built In, and HDRP

Scripting Backends

Mono, IL2CPP

Required Packages

When installing the Metalitix plugin, Unity will automatically prompt you to install Newtonsoft's Json.NET package if it does not already exist.

---

1. Import the Metalitix Unity Package into your Unity project. This can be done by navigating to Assets -> Import Package in the menu bar.

2. Reload the Unity project by closing it and opening it. This will update the package's references to internal libraries. You will see a Metalitix option in the menu bar with Logger and Dashboard options.

On some versions of Unity, the imported Metalitix package loses its asset references after restart. Right clicking the Metalitix folder in the asset directory and clicking Reimport fixes this issue.

3. Within your project settings in the online Metalitix dashboard you will find an API Key. Copy it then return to your Unity project. Navigate to Metalitix -> Logger in the menu bar and paste your API Key underneath API Key.

4. Navigate to your scene's camera and add a MetalitixCamera component.

5. Similarly, navigate to your scene model (or the parent of all your scene objects) and add a MetalitixScene component.

6. Next, from the asset directory drag the MetalitixLogger prefab into your scene. It is located in Metalitix/Prefabs/Logger. If you would like to immediately start recording Metalitix sessions when the project runs, check the box Automatically Start Logging. This will reveal Metalitix Camera and Metalitix Scene input fields, which are the components from steps 4 and 5. If you do not want to automatically start logging, then you will need to create your own script thats calls MetalitixLogger.Initialize() and MetalitixLogger.StartSession() at the desired moment.

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. If you do not pass a scene object, then recorded camera movement will be in world coordinates and manual calibration may be necessary.

The MetalitixLogger uses Object.DontDestroyOnLoad from game start.

7. Metalitix is now configured to gather analytics on your project! 🎉 To test, engage with your experience to create a session. Then, navigate to the Sessions tab within your project on the Metalitix dashboard. Within a few minutes, you will see your session appear at the top of the table. It will be marked as Active until the session ends. When a session no longer says Active, its data will appear on the Metrics tab. Heatmap data, on the other hand, is calculated in real-time for small projects and every 24 hours for large projects.