AR Magic Lantern SDK

GitHub · Documentation · Project Home · Discord

---

---

This repository contains a Software Development Kit (SDK) for creating augmented reality (AR) experiences for the AR Magic Lantern (ARML), an ongoing research project led by the Full-Body Interaction Lab at Universitat Pompeu Fabra.

• Project Home
  Background information about the project and its history.

• SDK Documentation
  Start here if you want to develop with the SDK.

• ARML Hardware
  Learn how to build or obtain the AR Magic Lantern hardware.

Quick start

To start building software for the ARML:

1. Create a new Unity project from Unity Hub
   • Version 6000.0.23 or later
   • Use the "Universal 3D" template
2. Change the .NET API settings
   • Go to Edit -> Project Settings...
   • Open the Player section
   • Under Other Settings > Configuration, find Api Compatibility Level
   • Change the value to: .NET Framework
3. Download the ARML SDK Unity Package
4. Double-click the downloaded arml-sdk.unitypackage file to open it in the Unity project.
5. In the Import window that opens, leave all items selected and click Import
6. Once the package has loaded, a window should pop up with instructions and tutorial content.

If you encounter any problems, please get in touch with us on the ARML Discord.

Under the hood

Not necessary for building experiences with the SDK, but useful if you want to go deeper and contribute to the project or experiment with its internals.

• Unity template project
  Modify the ARML Unity project and export a package that can be used in other projects.

• Generate Documentation
  Learn how to edit and build the SDK documentation website.

• Arduino Control
  Learn how to edit, build and deploy the code that runs on the ARML's Arduino module.

Visual Positioning System [experimental]

The ARML project is developing a Visual Positioning System (VPS) that allows the device to locate itself within a known, pre-mapped area. The VPS is still in the experimental stage and has not yet been integrated into the SDK.

• Mapping Utilities
  Scripts for recording video from the ARML cameras, which can then be used to create 3D models and train localization AI models.

• VPS Training
  Scripts and documentation for training the VPS of the ARML.

• VPS Inference
  C++ implementation of the VPS inference runtime.

---

     

---