Configure your Stream

This page will explain how to set up your game to work with the features present in the YOM UE5 SDK and assumes a new project. For existing projects, you may already have modified the GameMode and PlayerController classes. To retain compatibility follow the following guide

Step 1: Validate the SDK

YOM SDK should be enabled by default. Validate by checking if a new toolbar appeared in your navigation bar called 'YOM Toolbar'.

Follow these steps if the toolbar did not appear:

  • Click on "Edit" and select "Plugins" from the dropdown menu. This will open the Plugins window.

  • In the search bar within the Plugins window, type 'YOM' to search for the YOM Replicator SDK plugin.

  • Enable it. If the plugin does not appear, try restarting the editor and repeat this step.

  • Do the same for GltfRuntime and VaRest plugins in the same manner and enable them by clicking their respective checkboxes.

  • After enabling the plugins, it is recommended to restart the editor. This allows Unreal to load the plugins properly.

Step 2: Setting up the SDK

To configure the YOM Replicator SDK for your metaverse project, follow these steps:

  1. Open the setup screen by navigating to "Tools" in the top menu. Select "YOM" and then choose "Setup Project." This will open the setup window.

  1. In the setup window, you will find several settings that need to be configured. Here is an explanation of each setting:

  • World: This setting determines the persistent level that should be loaded as the world where players will spawn. Choose a level that remains loaded throughout the experience. In case of "Third Person" template, select "ThirdPersonMap".

  • Player Asset: This setting defines the asset that players will control within the world. It can be any character or object that allows player interaction. The default character provided by the Your Open Metaverse Plugin is the Yom_BP_ThirdPersonCharacter. Change it from "None" to "Yom_BP_ThirdPersonCharacter".

  • Voice Chat: If enabled, this setting allows players to communicate with each other through voice chat within the experience.

  • Player Inventory: Enabling this setting provides players with an inventory system in the game. The default inventory component provided by the Your Open Metaverse plugin is the YomDefaultInventoryComponent. You can also create your own inventory system using the Advanced Inventory Setup Guide. Change it from "None" to "YomDefaultInventoryComponent"

  • Control hints: If enabled, players will be presented with a control hint screen when they spawn into the game. The default control hints component provided by the Your Open Metaverse plugin is the YomDefaultControlHintsComponent. Change it from "None" to "YomDefaultControlHintsComponent".

  • Allow teleporting: If enabled, players can teleport to and from this metaspace using portals. Portals can be set up by placing a YomDefaultPortal in your scene.

Click "Begin Setup," and if the settings are correctly configured, a message will appear in the bottom right corner, instructing you to restart the editor. Click "Restart" to apply the changes.

In case you want to make any further adjustments or verify the setup, you can run the setup tool again or manually modify the settings.

Validate your configuration

After restarting, navigate to Content Drawer -> Content. You should now see a MetaspaceGameMode and a MetaspacePlayer. These assets can be used or extended to add further modifications and behavior to your experience. Then navigate to Settings -> World Settings, then validate the GameMode as shown in the provided screenshot.

Note that the Default Pawn Class in the MetaspaceGameMode is intentionally set to None, as the pawn will be loaded into the game via the MetaspacePlayer.

Last updated