Warning

This repository is archived and no longer actively maintained.

Magic Leap Colocation With Photon Fusion

This repository contains an example project demonstrating how to use Photon Fusion to create a colocation application for the Magic Leap 2. This project provides a simple multiuser and colocation application using Photon Fusion. The example is designed to work with the Magic Leap 2 and demonstrates the basics of creating a shared AR experience.

Prerequisites

Before you start, please ensure that you have the following software and hardware:

1. Unity 2022.x
2. Magic Leap SDK and Unity Package
3. Photon Fusion SDK
4. A Photon Fusion account (for the AppID)

Installation

1. Clone this repository to your local machine:

git clone https://github.com/magicleap/MagicLeapPhotonFusionExample.git

3. Open the project in Unity.
4. Set up your Photon Fusion AppID in the Photon Fusion Hub.

How to build and run the example scene:

• Create a Magic Leap 2 Unity project
• Import the Universal Render Pipeline
• Download and import the Photon Fusion package
• Assign a Photon Fusion App ID
• Import the Magic Leap - Photon Fusion package
• Print out the AprilTag marker or export Magic Leap Map
• Build and Run the example scene

Colocation Methods

• Marker Tracking
  • To colocate using marker tracking, print out marker 0 from the tag family 36h11
• Magic Leap Anchors
  • To colocate using Magic Leap Anchors, localize into the same AR Cloud Space or share your Space manually

Project Structure

The project is organized as follows:

Assets/MagicLeap/PhotonFusionExample
├───DesktopARBackground/    # Contains materials for the 3D objects
├───Images/          		# Contains the April Tag marker
├───Materials/             	# Contains materials for the 3D objects
├───Models/             	# Contains the virtual avatar models used in the scene
├───Prefabs/            	# Contains prefabs for easy scene setup
├───Scenes/             	# Contains the example scenes for marker and anchor colocation
├───Scripts/            	# Contains custom C# scripts for the project
	├───Editor/					# Scripts installing the generic marker tracker
	├───MagicLeapSpaces/		# Scripts for localizing the Magic Leap into a device or AR Cloud Space
	├───MarkerTracking/			# Scripts for Magic Leap and generic marker tracking
	├───PhotonFusion/			# Scripts coupled to Photon Fusion
	├───Utilities/				# Scripts such as a ThreadDispatcher
└───Sprites/           		# Contains textures for UI
└───ThirdParty/           	# Contains a modified version of the April Tag for Unity
└───URP/           			# Contains the Universal Render Pipeline assets
└───Webcam/           		# Contains components to obtain a generic webcam stream

Disclaimers

• This project uses a modified version of the AprilTag package for Unity which is licensed under BSD 2-Clause
• This project uses the Keijiro Takahashi's TestTools Package which is licensed under The Unlicensed

License

This project is governed by the Magic Leap 2 License Agreement