About the project · Who is it for? · Requirements · Installation · Docs · Discord
This repository contains a Software Development Kit (SDK) for creating augmented reality (AR) experiences for the AR Magic Lantern (ARML), a novel AR device that has the form-factor of a flashlight and projects AR content onto physical surfaces around the user.
The AR Magic Lantern is part of an ongoing research project led by the Full-Body Interaction Lab at Universitat Pompeu Fabra. In 2022, it received funding as part of EU Horizon 2020 to be developed into a market-ready prototype. It is also the Lighthouse Project of the UPF Node of the European Media and Immersion Laboratory (EMIL).
This SDK is intended for use by a wide range of users, including educators, researchers, independent game developers, content producers, and creative professionals. While it is meant to accommodate users of many different levels of technical expertise, it assumes a basic understanding of the Unity game engine.
In order to create and edit applications for the ARML using the SDK, you will need:
- A computer that can run Unity (Windows, Mac or Linux)
- An installation of Unity version 2022.3.8 or higher
In order to run and test applications, you will need to obtain an ARML-1 hardware developer kit. Please contact us on our Discord for more information about ARML hardware.
The SDK is released as a 2022.3.8 Unity project that can be used as a template for other projects. To get started, download the Unity project from the latest release and open it in Unity. Then it is recommended to follow the walkthroughs for the WallGame and GarumGame sample scenes in the SDK Docs.
