The name "ABXR" stands for "Analytics Backbone for XR"—a flexible, open-source foundation for capturing and transmitting spatial, interaction, and performance data in XR. When combined with ArborXR Insights, ABXR transforms from a lightweight instrumentation layer into a full-scale enterprise analytics solution—unlocking powerful dashboards, LMS/BI integrations, and AI-enhanced insights.
The ABXRLib SDK for Unity is an open-source analytics and data collection library that provides developers with the tools to collect and send XR data to any service of their choice. This library enables scalable event tracking, telemetry, and session-based storage—essential for enterprise and education XR environments.
Quick Start: Most developers can integrate ABXRLib SDK and log their first event in under 15 minutes.
Why Use ABXRLib SDK?
- Open-Source & portable to any backend—no vendor lock-in
- Quick integration—track user interactions in minutes
- Secure & scalable—ready for enterprise use cases
- Pluggable with ArborXR Insights—seamless access to LMS/BI integrations, session replays, AI diagnostics, and more
The ABXRLib SDK provides:
- Event Tracking: Monitor user behaviors, interactions, and system events.
- Spatial & Hardware Telemetry: Capture headset/controller movement and hardware metrics.
- Object & System Info: Track XR objects and environmental state.
- Storage & Session Management: Support resumable training and long-form experiences.
- Logs: Developer and system-level logs available across sessions.
The ABXRLib SDK is designed to work with any backend service that implements the ABXR protocol. Currently supported services include:
When paired with ArborXR Insights, ABXR becomes a full-service platform offering:
- Seamless data pipeline from headset to dashboard
- End-to-end session tracking, analysis, and replay
- AI-driven insights for content quality, learner performance, and device usage
- One-click LMS and BI integrations for scalable deployments
Developers can implement their own backend services by following the ABXR protocol specification. This allows for complete control over data storage, processing, and visualization.
- Open Unity and go to
Window > Package Manager. - Select the '+' dropdown and choose 'Add package from git URL'.
- Use the GitHub repo URL:
https://github.com/ArborXR/abxrlib-for-unity.git - Once imported, you will see
Analytics for XRin your Unity toolbar.
To use the ABXRLib SDK with ArborXR Insights, configure app token and org token (recommended). The same model applies to the Unreal and WebXR SDKs.
- Open
Analytics for XR > Configurationin the Unity Editor. - Use App Tokens is on by default for new configuration; keep it enabled for JWT authentication.
- Set App Token (required): JWT for your app, from your distribution channel or ArborXR portal (Content Library → Managed app → Insights Hub).
- Org Token: Leave empty to use the dynamic org token (derived from device/org context when available). For single-customer builds (e.g. production_custom), set the org token as required. For local testing in the Editor, you can paste your App Token into the Org Token field when you need both fields populated.
Development / testing: Set App Token; on ArborXR-managed devices, org context can be supplied at runtime (dynamic org token).
Production builds: Set App Token; use dynamic org token (empty org token in config) where the device or runtime provides org context.
⚠️ Security Note: Avoid compiling org tokens or long-lived secrets into builds distributed to third parties. For general distribution, use ArborXR-managed devices or dynamic org token. For single-customer deployments, follow your security guidelines.
If your project still uses the legacy scheme: in Configuration, leave Use App Tokens off and set App ID, Org ID, and Auth Secret from the app’s credential or details views in the portal where your organization still exposes them. On ArborXR-managed devices, only App ID may be required; Org ID and Auth Secret can auto-fill. New integrations should use app token and org token.
For information on implementing your own backend service or using other compatible services, please refer to the ABXR protocol specification.
Assessment events are required to activate grading dashboards and LMS integration. Send these events to track training completion, scores, and pass/fail status.
// When training starts
Abxr.EventAssessmentStart("safety_training");
// When training completes
Abxr.EventAssessmentComplete("safety_training", 92, EventStatus.Pass);
// or
Abxr.EventAssessmentComplete("safety_training", 25, EventStatus.Fail);Assessment Complete Parameters:
Score(second parameter) takes a 0-100 value- The
EventStatusenum hasPass,Fail,Complete,Incomplete,Browsed,NotAttemptedoptions
For more detailed tracking, you can also track specific objectives within your training:
// To mark a specific objective start
Abxr.EventObjectiveStart("open_valve");
// When the objective is complete
Abxr.EventObjectiveComplete("open_valve", 100, EventStatus.Complete);- INTEGRATION_INSTRUCTIONS.md – Step-by-step integration guide for adopting AbxrLib in your project; also written for AI assistants to implement or review an integration consistently.
For comprehensive documentation covering all features, advanced topics, and detailed examples, visit:
- ArborXR Insights Documentation - Main documentation hub
- Complete SDK Documentation - Full API reference and feature documentation
The full documentation includes:
- Complete event tracking API (Events, Analytics Event Wrappers, Timed Events)
- Advanced features (Module Targets, Authentication, Session Management)
- Storage, Telemetry, Logging, and AI Integration
- Mixpanel and Cognitive3D compatibility guides
- Troubleshooting and best practices
- Platform-specific examples and code samples
Use App Token and Org Token (recommended). Copy them from Content Library → Managed app → Insights Hub in the portal, or use values from your distribution channel. Leave Org Token empty to use the dynamic org token when the device or runtime provides org context; for Editor testing you can paste App Token into Org Token if needed. For legacy setups, Application ID and Authorization Secret are still available under application details and Settings > Organization Codes.
Object tracking can be enabled by adding the Track Object component to any GameObject in your scene via the Unity Inspector.
For more troubleshooting help and detailed FAQs, see the full documentation.