Skip to content

iequalshane/PlayFabPartyUnity

 
 

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

7 Commits
 
 
 
 
 
 
 
 

Repository files navigation

PlayFab Party SDK for Unity

Overview

This is a PlayFab Party plugin for game development on Unity.

Supported platforms:

  • Windows
  • Microsoft Game Core (just "Game Core" below)
  • iOS
  • Android

Version

Party Unity SDK (main)
1.5.0.1-main.0

Officially supported versions of PlayFab Party binaries with this release, by platform:

Platform Version
Windows 1.5.0
Game Core 1.5.* (GDK)
iOS 1.5.0
Android 1.5.0

Prerequisites

  • PlayFab account (www.playfab.com) registered and set up:
    • Studio and App configured, TitleID exists
    • Party feature enabled
    • Highly recommended: PlayFab Unity test app tried to ensure seamless PlayFab integration
  • PlayFab Unity Editor Extensions plugin
  • PlayFab (Core) SDK (installed via PlayFab Unity Editor extensions)
  • If you are targeting iOS:
    • Unity iOS Build Support Add-on installed
  • If you are targeting Android:
    • Unity Android Build Support Add-on installed with additional components:
      • Android SDK and NDK tools
      • OpenJDK
  • If you are targeting Windows:
    • Unity Windows Build Support (IL2CPP) Add-on installed
  • If you are targeting Game Core platform (consoles and/or PC):
    • Have access to the Microsoft Game Development Kit (GDK)
    • GDK installed (with all optional components)
    • GDK Unity plugin installed (available in Add-ins download section on GDK portal)
    • If you are targeting Game Core on Xbox consoles:
      • Unity Game Core Add-on for a necessary console installed (download from Unity)
      • Party on Xbox consoles requires Xbox Live authentication, and therefore make sure that:
        • Your Xbox app title is registered in Xbox Partner Center
        • Necessary SandboxID and developer Xbox Live account are created, and configured to work with the registered Xbox app title
    • If you are targeting Game Core PC:
      • Party Unity SDK is "Game Core PC ready", as soon as Unity build tools for Game Core PC are available

What's inside

The SDK contains the following:

  • /PlayFabPartySDK – This folder contains APIs that you will call from your game to take advantage of networking, in-game chat and other functionality offered by PlayFab Party.
  • /PlayFabPartySDK/Examples – This folder contains a simple demo scene with a script that shows how to call the Party APIs.
  • /PlayFabPartySDK/Prefabs – This folder contains the PlayFabMultiplayerManager prefab.
  • /PlayFabPartySDK/Setup/GameCore – This folder contains set up scripts that need to be used once to prepare the SDK to build for Game Core.
  • /PlayFabPartySDK/Source/DLLs – This folder contains the underlying Party C++ library binaries for each supported platform.

Getting Started

Setting up your environment

  • Create a new Unity project
  • Open player settings from the Unity main menu: Edit > Project Settings...
  • Next, select the 'Player' tab
  • Scroll down and check the box: Allow 'unsafe' Code
  • Close the Project Settings window
  • Link your Unity project with PlayFab by installing the editor extensions: https://github.com/PlayFab/UnityEditorExtensions/releases
  • Import this plugin
  • Install latest version of PlayFabSDK plugin using PlayFab Unity Editor Extensions UI
  • Log in to your PlayFab title using PlayFab Unity Editor Extensions UI
  • Follow README guidelines from PlayFabSDK to test basic PlayFab functionality
  • If you are targeting Game Core:
    • Install GDK Unity plugin
    • If you are targeting Game Core on Xbox consoles:
      • In Unity Project tree navigate to Assets/XGamingRuntime folder and enable all platforms in Inspector panel for XGamingRuntime.dll and XGamingRuntimeThunks.dll files
  • Create a new, empty scene
  • Import PlayFab Party Unity SDK plugin (unity package)
  • If you are targeting Game Core:
    • Go to /Assets/PlayFabPartySDK/Setup/GameCore folder in File Explorer and run install-party-game-core-libs.ps1 script, it will copy Party binaries installed with GDK to PlayFabPartySDK assets
  • Go to the /Assets/PlayFabPartySDK/Prefabs folder and drag and drop the PlayFabMultiplayerManager prefab into your scene
  • Note: Party SDK is x64, so when you build Standalone (Windows) please build for x64.
  • If you are targeting iOS:
    • Enable 'Prepare iOS for Recording' (set checkbox) in iOS Player Settings
    • Two PlayFabParty.framework libraries are provided: one for real iOS devices and another one for iOS Simulator (x64). Make sure to enable only one of them for iOS platform before building. The framework for a device is enabled by default (see Inspector settings for PlayFabParty.framework folders)
  • If you are targeting Android: please make sure to allow your app to use microphone on the device.

For a detailed guide please check out Quickstart: PlayFab Party Unity Plugin

About

No description, website, or topics provided.

Resources

Stars

Watchers

Forks

Packages

No packages published

Languages

  • C# 100.0%