xAPI And Unity Project

Example of embedding xAPI in a Unity Project

This is an example of sending and querying xAPI statements in a Unity 3D project. The game is based on Roll A Ball example from Learn.Unity.com. The project uses the GBLXAPI.org library for unity. The required files for GBLXAPI are included in the package, but you may wish to get the latest version from GBLXAPI.org. This project was created for demonstration purposes and is not intended for production use. For more information, see https://learningsolutionsmag.com/articles/use-the-gblxapi-library-to-send-xapi-statements-from-unity

This project was developed in Unity Version 2019.4.28f1. Other versions of Unity may require changes to the code or project. Update: This project has been converted to work in 2020.3.25f1. This required a change to my copy of GBLxAPI that is described here. Other versions of Unity may require additional changes to the code or project.

To see this project in action, you must first get a license for Unity from Unity.com. Once done and you have installed Unity, follow these steps.

1. Create a new Unity Universal Render Pipeline project.
2. Delete the Sample Scene from your project.
3. From the Unity Asset Store, download and import the following free assets:
   • Free Fantasy Adventure Music Pack from "Craze Music Productions"
   • Free Casual Game SFX from "Dustyroom"
   • Night Without Moon from "Stinky Toilet" (Sorry, I did not make up the name)
4. In the Unity editor, go to Assets/Import Package/Custom Packager and import the RISC Roll A Ball.unitypackage.
5. Once imported, open "Start" scene. You will be prompted import TMP Essentials and it is required.
6. Go to Window/Package Manager. Install the "Input System" package from the Unity Registry. Answer Yes to the prompt. This will cause the Editor to restart.
7. Go to File/Build Settings. Add scenes Start, Level 1, Level 2, Leaderboard to "Scenes In Build".
8. Set Architecture to x86_64.
9. Also in Build Settings, open Player Settings. In Other Settings, set Active Input Handing to "Both". The editor will again restart.
10. Right click on the Assets/Scripts folder in the project and choose Open c# project.
11. Open Assets/GBLXAPI/Scripts/GBLConfig.cs. Provide your LRS Endpoint in LrsURL.
12. Open Assets/Scripts/GBL_Interface.cs.
    • Provide your lrs User value in lrsUser
    • Provide the lrs Password value in lrsPassword.
13. Back in the Unity Editor, with the "Start" scene still open, hit play!