> ## Documentation Index > Fetch the complete documentation index at: https://devdocs.xbox.com/llms.txt > Use this file to discover all available pages before exploring further. # PlayFab Online Subsystem (OSS) Quickstart > Quickstart for the PlayFab Online Subsystem in Unreal Engine, covering setup for Party voice chat, lobbies, and matchmaking with the Multiplayer SDK. # QuickStart: PlayFab Online Subsystem This article helps you set up and use PlayFab Multiplayer features like Lobby, Matchmaking, and Party for games built with Unreal Engine 4 or Unreal Engine 5. For the full list of supported platforms and versions in Unreal Engine 4 or Unreal Engine 5, see [Supported platforms](/services/playfab/multiplayer/networking/party-unreal-engine-oss-overview). After following the relevant steps that are outlined in this page for your target platforms, you'll be ready to start using the PlayFab Online Subsystem (PF OSS). Authentication, networking, VOIP, grouping into lobbies, and matchmaking is handled on your behalf with no other changes required. ## Download and install PlayFab Online Subsystem Go to [PlayFab Online Subsystem](https://github.com/PlayFab/PlayFabMultiplayerUnreal) to download or clone the PF OSS source. The downloaded or cloned repository name is PlayFabMultiplayerUnreal. The repository has to be renamed to OnlineSubsystemPlayFab. ## What you need * **PlayFab TitleID:** If you don't have a TitleID configured for PlayFab Party and Multiplayer Software Development Kits (SDKs), see [Enabling PlayFab Party](/services/playfab/multiplayer/networking/enable-party). ### Microsoft Game Development Kit (GDK), PC, Switch, PlayStation®5, and PlayStation®4 * **Specific platform PlayFab Party and Lobby and Matchmaking libraries:** See [Obtaining PlayFab Party and Multiplayer libraries](/services/playfab/multiplayer/networking/party-unreal-engine-oss-obtaining-playfab-party-libraries). ## Initial setup ### Unreal Engine code base * Copy the OnlineSubsystemPlayFab folder and its contents to your Unreal Engine directory under **Engine\Plugins\Online**. * Run `GenerateProjectFiles.bat` to create project files for the engine. * Load the project into Visual Studio by selecting the new `UE5.sln` file. * Set your solution configuration to **Development Editor** and your solution platform to **Win64**. Select the **Unreal Engine 5** target, and then select **Build**. ### Game code base * To add OnlineSubsystemPlayFab to your plugin list, apply the following changes to the Plugins section of the project file. * Remove any platforms that you're not shipping on * Use XboxOneGDK instead of XB1 if you're using Unreal Engine 4. Unreal Engine 5 deprecates XboxOneGDK ```json theme={null} { "Name": "OnlineSubsystemPlayFab", "Enabled": true, "PlatformAllowList": [ "XB1", "WinGDK", "XSX", "Win64", "Switch", "PS4", "PS5" ], "SupportedTargetPlatforms": [ "XB1", "WinGDK", "XSX", "Win64", "Switch", "PS4", "PS5" ] } ``` * Generate the game solution file by selecting the `{ProjectName}.uproject` file and then select **Switch Unreal Engine Version** to the Unreal Engine code path. ## Game Configuration * No matter which platform you're targeting, your game needs to configure certain PlayFab specific values in your intended platform target's INI file (located at \[yourGameDirectory]/Platforms/\[yourPlatform]/Config). * **XBOX Series X GDK:** XSXEngine.ini * **PC GDK:** WinGDKEngine.ini * **XBOX One GDK:** XB1Engine.ini (or XboxOneGDKEngine.ini if you're using Unreal Engine 4) * **PC Steam:** WindowsEngine.ini (or find it in \[yourGameDirectory]/Config/Windows) * **Nintendo Switch** SwitchEngine.ini * **PS4™** PS4Engine.ini * **PS5™** PS5Engine.ini * Replace the INI sections in the config if they already exist (for example, Engine.GameEngine) with the ones presented in the following sections. * Ensure you replace all the *\* fields with your data: * On UE 5.6 and later the `DriverClassName` parameter requires the "/Script/" prefix. For example, use `"/Script/OnlineSubsystemPlayFab.PlayFabNetDriver"` instead of `"OnlineSubsystemPlayFab.PlayFabNetDriver"`. ```ini theme={null} [OnlineSubsystemPlayFab] bEnabled=true PlayFabTitleID= MaxDeviceCount= MaxDevicesPerUserCount= MaxEndpointsPerDeviceCount= MaxUserCount= MaxUsersPerDeviceCount= DirectPeerConnectivityOptions= bHasPlayFabVoiceEnabled= [/Script/OnlineSubsystemPlayFab.PlayFabNetDriver] NetConnectionClassName="OnlineSubsystemPlayFab.PlayFabNetConnection" ReplicationDriverClassName="" . Skip if the game doesn't have a replication driver class (https://docs.unrealengine.com/5.2/en-US/replication-graph-in-unreal-engine/). ConnectionTimeout=15.0 InitialConnectTimeout=30.0 [/Script/Engine.GameEngine] !NetDriverDefinitions=ClearArray +NetDriverDefinitions=(DefName="GameNetDriver",DriverClassName="/Script/OnlineSubsystemPlayFab.PlayFabNetDriver",DriverClassNameFallback="OnlineSubsystemUtils.IpNetDriver") ``` ## Platform Specific Considerations With all that done, we're nearly finished. There are only a few key platform-specific parameters left that must be set. ### GDK When developing games with the GDK, set up the platform services. ```ini theme={null} [OnlineSubsystem] DefaultPlatformService=PlayFab NativePlatformService=GDK ``` ### Steam If you're developing games for Win64 with Steam, define your platform services. ```ini theme={null} [OnlineSubsystem] DefaultPlatformService=PlayFab NativePlatformService=Steam ``` ### Switch For more information about Switch, see the [ReadMe.md](https://dev.azure.com/PlayFabPrivate/Switch/_git/PlayFabMultiplayerUnrealSwitch?path=/README.md) file that comes with the Switch PlayFab OSS. If you don't have access, you can [request access](/services/playfab/sdks/request-access-for-sdks-samples) to our private repositories. ### PS5™ and PS4™ For more information about PS5™ and PS4™, see the [ReadMe.md](https://dev.azure.com/PlayFabPrivate/PS5/_git/PlayFabMultiplayerUnrealPlayStation?path=/README.md) file that comes with the PS5™ and PS4™ PlayFab OSS. If you don't have access, you can [request access](/services/playfab/sdks/request-access-for-sdks-samples) to our private repositories. ### Cross-platform If your game uses PlayFab's cross-platform networking support, define which platforms you permit to connect. ```ini theme={null} [/Script/OnlineSubsystemUtils.OnlineEngineInterfaceImpl] !CompatibleUniqueNetIdTypes=ClearArray +CompatibleUniqueNetIdTypes=STEAM +CompatibleUniqueNetIdTypes=GDK +CompatibleUniqueNetIdTypes=SWITCH +CompatibleUniqueNetIdTypes=PS4 +CompatibleUniqueNetIdTypes=PS5 ``` All platforms allow VoIP by default. To disable VoIP for a specific platform, add the platform model name to your Unreal Engine configuration file as shown in the following example. ```ini theme={null} [OnlineSubsystemPlayFabVoiceChatDisabledPlatforms] !Platforms=ClearArray +Platforms=WIN64 +Platforms=STEAM +Platforms=SWITCH +Platforms=PS4 +Platforms=PS5 ``` These steps complete the setup of OSS required to be used in your game. ## Use in Game Code PlayFab Online Subsystem only supports Game Session naming as `NAME_GameSession` Similar to using other Online Subsystem plugins: Add `PublicDependencyModuleNames.AddRange(new string[] { "OnlineSubsystem", "OnlineSubsystemUtils" });` in Game.Build.cs, then use it the same way as other game plugins. Example code in GameSession.cpp: ```cpp theme={null} #include "OnlineSubsystem.h" #include "OnlineSubsystemUtils.h" ... bool Game::JoinSession(const FUniqueNetIdPtr UserId, FName SessionName, const FOnlineSessionSearchResult& SearchResult) { IOnlineSubsystem* OnlineSub = Online::GetSubsystem(GetWorld()); // Using OnlineSubsystemPlayFab plugin if (OnlineSub) { IOnlineSessionPtr Sessions = OnlineSub->GetSessionInterface(); // Using OnlineSessionInterfacePlayFab.h if (Sessions.IsValid() && UserId.IsValid()) { // ... } } // ... } ``` Example code in GameFriends.cpp: ```cpp theme={null} #include "OnlineSubsystem.h" #include "OnlineSubsystemUtils.h" ... void Game::ViewFriendProfile() { IOnlineSubsystem* OnlineSub = Online::GetSubsystem(GetWorld()); // Using OnlineSubsystemPlayFab plugin if (OnlineSub) { IOnlineIdentityPtr Identity = OnlineSub->GetIdentityInterface(); // Using OnlineIdentityInterfacePlayFab.h if (Identity.IsValid() && Friends.IsValidIndex(FriendIndex)) { // .... } } } ``` ## Troubleshoot Ways to help you troubleshoot issues. ### Unreal Engine Installed Builds Users might face issues when trying to create an Unreal Engine Installed Build with the OnlineSubsystemPlayFab on GDK build flavors. We provide the following guidance to successfully overcome this issue until there's a more complete solution. **If you're using Unreal Engine 5.4, 5.5, 5.6 or 5.7:** * You might encounter the following runtime error: `Runtime dependency Party.dll is configured to be staged from C:\Program Files (x86)\Microsoft GDK\\Party.dll and Engine\Plugins\Online\OnlineSubsystemPlayFab\Platforms\GDK\Redist\Party.dll` * Navigate to Engine\Platforms\GDK\Plugins\Online\OnlineSubsystemGDK\\ * Open OnlineSubsystemGDK.uplugin and set `PlayFabParty` to disabled: ```json theme={null} { "Name": "PlayFabParty", "Enabled": false } ``` * Navigate to Engine\Platforms\GDK\Plugins\Online\OnlineSubsystemGDK\Source\\ * Open OnlineSubsystemGDK.Build.cs and comment out the inclusion of `PlayFabParty`: ```csharp theme={null} if (Target.bCompileAgainstEngine) { //PublicDependencyModuleNames.Add("PlayFabParty"); } ``` **If you're using Unreal Engine 5.0 - 5.3:** * Locate the directory where Unreal Engine is installed on the machine. * Navigate to Engine\Platforms\GDK\Plugins\Online\PlayFabParty * Open PlayFabParty.uplugin, and update Modules config with **PlatformDenyList**: ```ini theme={null} "Modules": [ { "Name": "PlayFabParty", "Type": "Runtime", "LoadingPhase": "Default", "HasExplicitPlatforms": true, "PlatformDenyList": [ "WinGDK", "Win64" ] } ], ``` * Repeat this process for XB1 (PlayFabParty\_XB1.uplugin) and XSX (PlayFabParty\_XSX.uplugin) if these platforms are required for the Installed Build. If Win64 is also a required platform for the installed build, add Win64 in the array of **PlatformDenyList**. **If you're using Unreal Engine 4.27+:** * Locate the directory where Unreal Engine is installed on the machine. * Navigate to Engine\Platforms\GDK\Plugins\Online\PlayFabParty * Open PlayFabParty.uplugin * Replace the key **WhitelistPlatforms** with **BlacklistPlatforms** * Repeat the process for XboxOneGDK (PlayFabParty\_XboxOneGDK.uplugin) and XSX (PlayFabParty\_XSX.uplugin) if these platforms are required for the Installed Build. If Win64 is also a required platform for the installed build, add Win64 in the array of **BlacklistPlatforms**. Modules config example in PlayFabParty.uplugin for Unreal Engine 4.27+: ```ini theme={null} "Modules": [ { "Name": "PlayFabParty", "Type": "Runtime", "LoadingPhase": "Default", "BlacklistPlatforms": ["WinGDK", "Win64"] } ], ``` ### HandShake failure on Steam If you're seeing handshake failure (such as `LogHandshake: IncomingConnectionless: Error reading handshake packet`), refer to this [Unreal Engine Forum post](https://forums.unrealengine.com/t/ue-5-1-steam-sockets-problem/696726) to check the settings. ## Workflow for OnlineSubsystemPlayFab The steps outlined in the [Platform Specific Considerations](#platform-specific-considerations) section ask you to include: ```ini theme={null} [OnlineSubsystem] DefaultPlatformService=PlayFab ``` Unreal Engine OnlineSubsystemModule creates an online subsystem instance for PlayFab and starts creating ⁠the PlayFabSingleton. At this point, the SDK is initialized in⁠ `FOnlineSubsystemPlayFab::Init()`, where it initializes both Party and Multiplayer SDKs with PlayFab TitleID (this titleID is defined inside the [Game Configuration](#game-configuration) file. During initialization, we'll `⁠CreatePlayFabSocketSubsystem()` as the main online subsystem. Workflow of Multiplayer SDK: `FOnlineSubsystemPlayFab::Init()` initializes the `InitializeMultiplayer()` multiplayer SDK singleton for your title. In the `PlayFabLobby.cpp`, `FPlayFabLobby::DoWork()` processes the state changes triggered by Multiplayer APIs (view `Platforms/GDK/Include/PFLobby.h` for APIs). Workflow of Party SDK: `FOnlineSubsystemPlayFab::Init()` initializes the `InitializeParty()` multiplayer SDK singleton for your title. In the `OnlineSubsystemPlayFab.cpp`, `FOnlineSubsystemPlayFab::DoWork()` processes the state changes triggered by Party APIs (view `Platforms/GDK/Include/Party.h` for APIs). "PlayStation" is a registered trademark or trademark of Sony Interactive Entertainment Inc. "PS4" is a registered trademark or trademark of Sony Interactive Entertainment Inc. "PS5" is a registered trademark or trademark of Sony Interactive Entertainment Inc. ## Related topics - [PlayFab Online Subsystem (OSS) Dedicated Server Setup](/services/playfab/multiplayer/networking/party-unreal-engine-oss-dedicated-servers.md) - [PlayFab OnlineSubsystem for Unreal Engine release notes](/services/playfab/multiplayer/networking/unreal-release-notes.md) - [Azure PlayFab Party Online Subsystem for Unreal](/build/console-features/networking/game-mesh/party-unreal-online-subsystem.md) - [PlayFab Online Subsystem (OSS)](/services/playfab/multiplayer/networking/party-unreal-engine-oss-overview.md) - [Integrate the PlayFab Unreal Engine Marketplace plugin](/services/playfab/multiplayer/networking/party-unreal-engine-oss-playfab-plugin-integration.md)