Skip to content

Oculus multiplayer showcase demonstrating basic multiplayer functionality in Unreal, including Oculus Platform Social APIs, Photon as the transport layer and UE replication. The Oculus SDK and other supporting material is subject to the Oculus proprietary license.

License

Notifications You must be signed in to change notification settings

oculus-samples/Unreal-SharedSpaces

Repository files navigation

Shared Spaces

Shared Spaces video

SharedSpaces was built by the VR Developer Tools team to demonstrate how you can quickly get people together in VR using the Oculus Social Platform APIs. This version was built for the Unreal Engine using the Photon SDK as the transport layer. Check out this YouTube video showing the demo.

06 December 2023 Update

We updated the project to UE5.3.

We updated the MetaXRPlatform plugin to SDK v59.

30 August 2023 Update

We updated the settings for UE5.2.

We updated the OVRPlatform plugin to use the new MetaXRPlatform plugin found here. We updated to SDK v56.

We have added the the ability to handle User Reporting. This allow users to notify the developer about conduct within the application that does not adhere to the Code of Conduct in Virtual Experiences.

08 March 2023 Update

We have added a demo for the App to App Travel platform feature.

For that purpose we added a door that will launch another of our showcase Ultimate Glove Ball joining directly in an arena of the same session, making it so that every user in the same lobby can join the same arena. Implementation details can be found here.

20 October 2022 Update

We have added a demo of the new Blocked Users flows presented at Connect 2022.

For that purpose, pulling the controller trigger no longer changes your robot color, but instead starts the block/unblock flow with the character in front of you (if any). You can still change your robot color by stepping on the paint shop plate in the lobby.

18 May 2022 Update

For the original SharedSpaces for UE4, we created a new plugin, Plugin/OculusPlatform, to expose the new OVR Platform APIs that we needed, in particular the group presence ones. Instead of using both the old Oculus OSS and the new plugin, we just moved everything that we needed into the new plugin.

In this update, the plugin has been renamed Plugin/OVRPlatform and now covers all OVR Platform APIs. A key feature of this plugin is that it is codegened, which means that it will be kept in sync with the OVR Platform. That was not possible with the older Oculus OSS, has it required manual adaptation of UE4 OSS to Oculus VR Platform services. We are planning on releasing it as an engine level plugin in the near future.

SharedSpaces is available on the Quest AppLab.

Documentation

To visualize markdown files in Visual Studio, we recommend installing a markdown extension.

  1. SharedSpaces project
  2. OVRPlatform plugin
  3. Photon plugin

Details on how to setup the project can be found under Oculus Application Configuration.

Build Instructions

  1. Git LFS is required to access the assets of the project, such as blueprints and materials. Make sure that you have Git LFS installed using the following command.
git lfs install
  1. Clone this repo using the "Code" button above, or this command:
git clone https://github.com/oculus-samples/Unreal-SharedSpaces.git
  1. This project requires the Oculus fork of the UE5.3 game engine that you can find here.
    NOTE: access to the Oculus fork requires access to Epic's GitHub.
  2. You need Visual Studio installed to build the engine and the project plugins.
  3. Open a command prompt, change directory to your Unreal root (see step 3), then run this command:
.\GenerateProjectFiles.bat -Game SharedSpaces -Engine <full path to Unreal-SharedSpaces directory>\SharedSpaces.uproject
  1. Open the SharedSpaces.sln file that has been generated in the Unreal-SharedSpaces directory.
  2. Set SharedSpaces as the start-up project and Development Editor as the configuration.
  3. Hit F5 to build and debug the project (and the engine).

License

Unreal-SharedSpaces is under the license found here.
The Oculus License applies to the SDK and supporting material.
The MIT license applies to only certain, clearly marked documents. If an individual file does not indicate which license it is subject to, then the Oculus License applies.
We distribute the Photon SDK under agreement with Photon. You will find their license here.

About

Oculus multiplayer showcase demonstrating basic multiplayer functionality in Unreal, including Oculus Platform Social APIs, Photon as the transport layer and UE replication. The Oculus SDK and other supporting material is subject to the Oculus proprietary license.

Resources

License

Code of conduct

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published