Skip to content

Commit

Permalink
updated version to 1.4.8 and added support for Windows, iOS and Andro…
Browse files Browse the repository at this point in the history
…id (#3)

Co-authored-by: Vicodex <victorku@microsoft.com>
  • Loading branch information
Vicodex and Vicodex authored Jul 17, 2020
1 parent 26f1806 commit 2138274
Showing 1 changed file with 25 additions and 10 deletions.
35 changes: 25 additions & 10 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,18 +4,24 @@
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.4.7.0-main.0
|1.4.8.0-main.0

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

Platform|Version
|-|-|
Game Core|1.4.7
Windows|1.4.8
Game Core|1.4.8
iOS|1.4.8
Android|1.4.8

## Prerequisites
- PlayFab account ([www.playfab.com](https://www.playfab.com)) registered and set up:
Expand All @@ -24,13 +30,20 @@ Game Core|1.4.7
- 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 Game Core platform (Xbox One, Scarlett and/or PC):
- 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)](http://aka.ms/gdkdl)
- 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 Xbox or Game Core Scarlett:
- Unity Game Core Scarlett Add-on installed (download from Unity)
- Unity Game Core Xbox One Add-on installed (download from Unity)
- 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
Expand All @@ -42,7 +55,8 @@ 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.
- `/PlayFanPartySDK/Setup/GameCore` – This folder contains set up scripts that need to be used once to prepare the SDK to build for Game Core.
- `/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
Expand All @@ -58,13 +72,14 @@ The SDK contains the following:
- Follow [README guidelines from PlayFabSDK](https://github.com/PlayFab/UnitySDK) to test basic PlayFab functionality
- If you are targeting Game Core:
- Install GDK Unity plugin
- If you are targeting Game Core Xbox One or Game Core Scarlett:
- In Unity Project tree navigate to `Assets/XGamingRuntime` folder and enable "GameCoreScarlett" and "GameCoreXboxOne" platforms in Inspector panel for `XGamingRuntime.dll` and `XGamingRuntimeThunks.dll` files
- 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 please build for x64.
- Note: Party SDK is x64, so when you build Standalone (Windows) please build for x64.
- 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](https://docs.microsoft.com/en-us/gaming/playfab/features/multiplayer/networking/party-unity-plugin-quickstart)

0 comments on commit 2138274

Please sign in to comment.