Spirit Sling Tabletop

Spirit Sling is a social mixed reality (MR) app created to show developers how to build exciting tabletop games that give users a reason to be together in MR. With Meta's new and improved Avatars, and the power of mixed reality, users can now place a fun tabletop experience on a surface and invite a friend into their space to play with them.

The majority of Spirit Sling is licensed under MIT LICENSE, however files from Text Mesh Pro, and Photon SDK, are licensed under their respective licensing terms.

See the CONTRIBUTING file for how to help out.

This project was built using the Unity engine with Photon Fusion.

Test the game on Meta Quest Store - Spirit Sling Tabletop.

How to run the project in Unity

1. Configure the project with Meta Quest and Photon
2. Make sure you're using 2022.3.30.
3. Make sure you're using one of these devices: Meta Quest 3S, Meta Quest 3, Meta Quest Pro.
4. Locate the 'Assets/GameSettings.asset' file and populate all the empty fields with your own data.
   4.1. 'Application Identifier' is the unique string that identifies your app on Meta Quest Store.
   4.2. 'Meta Quest App ID' is the ID of your app on Meta Quest Store.
   4.3. Optional: populate Android Keystore name and password. Make sure not to store the 'Assets/GameSettings.asset' file in VCS in this case.
   4.4. 'Photon App Id Fusion / Voice': unique ids obtained in step 1 in the 'Photon Configuration' section.

Project Structure

The project is organically structured to distinguish the main components of the MR experience's logic. Main Spirit Sling components:

• ConnectionManager handles the Photon Fusion connection workflows for single and multiplayer sessions. The PhotonConnector logic showcases how a shared multiplayer session is handled via Photon Fusion, how the creation of shared rooms and lobbies work, and how the connection states can be handled accordingly.
• GameVolumeSpawner handles logic for placing the game board into physical environment. It also ensures that the game board is accessible by hands so the user can readjust the initial placement for a more comfortable experience.
• TabletopGameStateMachine controls the flow of the game between different gameplay states.
• Please visit the Meta Horizon Documentation page for more details on how the game uses Mixed Reality Utility Kit (MRUK), Platform SDK and Meta Interaction SDK (ISDK).

Dependencies

This project makes use of the following plugins and software:

• Mixed Reality Utility Kit v69
• Meta XR Core SDK v69
• Meta Interaction SDK v69
• Meta Avatars SDK v29.7.0