- Multiplayer networking
- Chat messages and data exchange
- Cross-talk and cross-play
- Accessibility features like real-time text chat translation and voice transcription
- Microsoft Game Core (GDK)*, Windows, iOS, Android: https://github.com/playfab/PlayFabPartyUnity (public access)
- Sony PlayStation®:
- PS4™: https://dev.azure.com/PlayFabPrivate/PS4/_git/PlayFabPartyUnityPS4 (restricted access by request to Microsoft Representative)
- PS5™: https://dev.azure.com/PlayFabPrivate/PS5/_git/PlayFabPartyUnityPS5 (restricted access by request to Microsoft Representative)
- Nintendo Switch™: https://dev.azure.com/PlayFabPrivate/Switch/_git/PlayFabPartyUnitySwitch (restricted access by request to Microsoft Representative)
What API features are provided by Party Unity plugin?
- Game networking
- VoIP
- Support for the following platforms:
- GDK:
- XBOX Series X|S
- XBOX One
- PC
- Windows
- iOS
- Android
- PS4™
- PS5™
- Switch
- GDK:
- Support for cross-play & cross-talk across the above platforms
- Party Cognitive Services
- Real-time text chat translation
- Real-time voice chat transcription
- Real-time voice chat translation
- Text-to-speech synthesis
What is included in Party Unity plugin?
- Simplified top-level Party API written in Unity C# provided by
PlayFabMultiplayerManagerclass and prefab for easier integration of user’s Unity game with the core features of Party library - C# interop layer providing managed-code interface to the underlying native (C++) Party library API. It’s used by the top-level C# API.
- Underlying native (C++) Party binaries for each supported platform:
- Party DLL libraries for Windows
- Party iOS Framework libraries for iOS (device and simulator)
- Party AAR library archive for Android
- Party DLL libraries for Microsoft Game Core are NOT included. They’re distributed with GDK and must be copied to the plugin before building your Unity project (see details in the README file included with the plugin)
- Party dynamic libraries for PS4, PS5
- Party static libraries for Switch
- PlayFab “core” Unity SDK plugin (can be updated independently if needed)
- XBOX Live authentication and policy provider API, currently supported on GDK platform only
Party Unity plugin versions and compatibility between platforms
Party Unity plugin is published and available for download at several distribution points (Git repos), depending on the platform. Access to some distribution points is restricted and requires a request to your Microsoft Representative. The Party Unity plugin uses a custom versioning scheme to clarify compatibility between versions downloaded from different distribution points and to reference a specific version of the underlying native library.Party Unity plugin versioning scheme
1.5.0.3-main.0 (a version downloaded from the main public GitHub repo) or 1.5.0.3-ps5.0 (a version with Party binaries only for PS5, downloaded from a repo with restricted access).
Version components:
X.X.X- the lowest version of the underlying Party library across all supported platforms. This value provides reference consistency with the underlying C++ library version. In the example above, the included Party library for each platform is version1.5.0or higher.Y- an incremental index of any modifications in the Party Unity C# layer, for any given X.X.X part of the version.(distribution-point-indicator)- a mnemonic code for tracking which distribution point a particular Party Unity plugin package was downloaded from. It differs by distribution point, for example,main(main public distribution GitHub repo),ps5(Microsoft Azure DevOps repo with restricted access for PS5 developers), and so on.Z- an incremental index of any modifications unique to the distribution point (for example, Party binaries updated or patched for a specific platform only).
Compatibility between versions from different distribution points
Regardless of the distribution point, a Party Unity plugin is guaranteed to be fully compatible with a Party Unity plugin from any other distribution point if the first four numbers (X.X.X.Y) of their version are the same. You can import compatible versions into your Unity project in any order without overwriting or breaking one another, as their shared code is identical. Each version may have extra platform-specific files that don’t overlap.
For example, you can import all the following versions of Party Unity plugin in your Unity project, in any sequential order, if you are targeting iOS, PS5 and Switch:
1.5.0.3-main.0(imports Party binaries for iOS, among other files)1.5.0.3-ps5.0(imports Party binaries for PS5, among other files)1.5.0.3-sw.0(imports Party binaries for Switch, among other files)
