owlandfox/unreal-sharedspaces-quest

Oculus multiplayer showcase demonstrating basic multiplayer functionality in Unreal. Including Oculus Social APIs, Oculus Platform authentication, and Photon NetDriver

Shared Spaces

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.

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

2. Clone this repo using the "Code" button above, or this command:

git clone https://github.com/oculus-samples/Unreal-SharedSpaces.git

3. This project requires the Oculus fork of the UE4.27 game engine that you can find here.
   NOTE: access to the Oculus fork requires access to Epic's GitHub.
4. You need Visual Studio installed to build the engine and the project plugins.
5. 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

6. Open the SharedSpaces.sln file that has been generated in the Unreal-SharedSpaces directory.
7. Set SharedSpaces as the start-up project and Development Editor as the configuration.
8. Hit F5 to build and debug the project (and the engine).

License

Unreal-SharedSpaces is under the license found here.
We distribute the Photon SDK under agreement with Photon. You will find their license here.

■