4. Install the Logger

Add the Metalitix Logger to your Three.js experience

  1. Add the Metalitix Logger to your experience using HTML or NPM.

Run the below command if you have npm installed.

npm install @metalitix/metalitix-threejs
  1. Instantiate the MetalitixLogger by passing in the apiKey from your project settings found in the Metalitix dashboard. Then, start the logger session by calling startSession() and passing in your camera (PerspectiveCamera) and your scene (Object3D). Your own scene is the 3D model of the experience or the parent for your scene's models.

    const apiKey = 'xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx';
    const logger = new MetalitixLogger(apiKey);
    ...
    const camera = new THREE.PerspectiveCamera();
    const mySceneModel = new THREE.Mesh(new THREE.BoxGeometry(), new THREE.MeshBasicMaterial());
    logger.startSession(camera, mySceneModel);
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.
  1. 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.

Last updated