com.rwth.unity.omilaxr.xapi

OmiLAXR.xAPI (v2)

This package implemented Data Provider components of the OmiLAXR framework supporting xAPI data format. It delivers a set of Composers, Hooks and Endpoints supporting a wide set of tracking behaviours.

Just drag and drop the prefab Resources/Prefab/OmiLAXR.xAPI into your scene.

Compatibility

Because of the less dependencies and modular design of OmiLAXRv2 this framework is compatible with all XR frameworks. It doesnt matter if you use MRTK, VRTK, SteamVR, UnityXR, ... and it doesnt matter what equipment you use.

You can look for existing modules tracking the behaviour you need. The rest can be easily implemented by you own - and we hope you will share it with the community!

The only thing we need to consider are the Unity version. We try to support as much as possible upwards of Unity 2019.4.40f1. You are invited to contribute!

The compatibility was tested on

• Unity 2019.4.40f1 (LTS)
• Unity 2020.3.48f1 (LTS)
• Unity 2021.3.15f1 (LTS)
• Unity 2021.3.45f1 (LTS)
• Unity 2022.3.52f1 (LTS)
• Unity 2023.2.20f1 (no LTS)
• Unity 6000.0.25f1 (LTS)

Please contact us on https://discord.gg/yJgk4ATg if it is not running on your Unity version. We will try to make it possible.

Module dependencies

The adapter has following third-party dependencies attached:

• Newtonsoft.JSON: Is used for (de-)serialize JSON files.

Install by using scoped registry

1. Ensure in "Project settings" > "Package Manager" that you have the scoped registry with following settings:

• Name: npmjs
• URL: http://registry.npmjs.com
• Scope(s): com.rwth.unity.omilaxr.xapi

1. Go to Package Manager.
2. Click on the (+) button.
3. Select 'Add package by name'.
4. Place in 'Name' field: com.rwth.unity.omilaxr.xapi.

Adding scoped registry by using manifest.json (also recommended - quick way)

1. Alternatively, instead of adding the scoped registry inside Unity editor you can do it by using manifest.json file.
2. Go to you project root and then open Packages/manifest.json.
3. Ensure following entries in your file: "scopedRegistries": [ { "name": "npmjs", "url": "http://registry.npmjs.com/", "scopes": [ "com.rwth.unity.omilaxr", "com.rwth.unity.omilaxr.xapi" ] }].
4. Go to the Unity Package Manager to My registries and install the package com.rwth.unity.omilaxr.xapi.

Install by using Git url

1. Go to Package Manager.
2. Click on the (+) button.
3. Select 'Add package from git URL'.
4. Paste https://gitlab.com/learntech-rwth/omilaxr-ecosystem/v2/heart-rate/omilaxr.hyperate.git and confirm.

For Developers

To work with this package we recommend to place it somewhere outside your Unity project (if the package gets an own git repository) or in root of your project. Than, you can include the package into your project by going to Window > Package Manager, click on (+) button and finally import the package.json of this project by clicking on Add package from disk.

For production use we recommend to use Add package form git URL or using scoped registries (see below).

Default Folder Structure

Here you can see the default structure of the adapter unity packages. The folders surrounding with (FOLDER) are not delivered by default.

• root
  • (Editor)
  • Plugins
  • Resources
    • Prefabs
    • StreamingAssets
    • ...
  • Runtime
    • Actors
    • Composers
      • HigherComposers
    • Endpoints
    • Extensions
    • Filters
    • Hooks
    • Listeners
    • Pipelines
    • TrackingBehaviours
  • Tests
    • Runtime
    • (Editor)

Publication

You can publish your package at any npm registry. It makes sense to publish packages for easier distribution in other projects. But we recommend to use npmjs.com. Here you can get more details. But the steps are very easy.

1. Create an account on npmjs.com.
2. On demand increase your version number in package.json.
3. Commit and push your changes.
4. Open a terminal.
5. Go to the root of your project.
6. Run npm login and login via browser (or what else you like).
7. Run npm publish --access public.
8. Wait until publication is ready.