Getting started with Azure PlayFab Party

This topic describes how to set up the development environment for Azure PlayFab Party and start using it.


You need a PlayFab account, and you must enable the Party feature to start using Party.

  1. Create/sign in to your PlayFab account. For instructions, see Quickstart: Game Manager.
  2. Enable Party feature via Game Manager from your PlayFab account.

Download and set up Party SDK

Like the PlayFab SDKs, we have Party SDKs for different platforms and game engines. Select and download the one that you need. For download links, see Party SDKs.

After installing the SDK, you might want to run a sample to see how Party works before you start writing code. For more information, see the Run a sample section.

If you're using Party in Xbox and PC titles, we recommend that you use the Party Xbox Live Helper Library to ensure consistent functionality and behavior. This library helps your title meet Xbox Live requirements. To learn more, see Xbox requirements.

Start using Party

Now that you've finished the setup, you're ready to make your first API call and use more Party features.

To start making Party API calls, you also need the PlayFab Entity Token. Get it via REST calls (GetEntityToken) or by using the PlayFab SDK. For instructions about how to install the PlayFab SDK, see the Install PlayFab SDK section. If you're using Xbox Live, you can also get this token from the Party Xbox Live Helper Library.

Here are some quickstart guides to help you make your first API call.

For a high-level, general overview of all the core features in Party, see Party SDK quickstart.

Useful resources

Run a sample

Running a sample is a helpful way to learn how Party works. To download a sample, go to Party samples. If you have questions or need help, go to PlayFab forums.

Install the PlayFab SDK

You can use the PlayFab SDK to get the PlayFab Entity Token. The PlayFab SDK is needed when you want to use other PlayFab functionalities such as economy and leaderboards.

  1. Install the version of the PlayFab SDK that you need—select by languages, game engines, or frameworks.
  2. Associate your game's PlayFab title ID with the PlayFab SDK. If you need to find out what title IDs are or where to find them, see Your studios and titles.

Key concepts

To help you design and harness the full power of Party, following are some concepts that cover different key areas.

  • Party objects and their relationships

    Know what the key objects are and how they relate to each another. This information provides you with a basic understanding of the overall data communication architecture.

  • Party chat basics

    Understand how chat works. Learn which key objects need to be created and defined to implement chat.

  • Party invitations and the security model

    Learn how to limit access to a network as a way to protect the integrity of your own network. Understand how you can effectively use invites as part of your security design.

  • Party interacts with your discovery flows

    Party can be used with other PlayFab multiplayer features. These features enable players to find other players so that they can play together. Learn how matchmaking, lobby, and other features can help in this discovery process.

  • Party API reference documentation

    Get more details about parameters, return values, and behaviors when invoking the C/C++ libraries.

  • Party UX guidelines for Text-to-speech and Speech-to-text

    Understand the best practices for designing user experiences. Be informed about our recommendations around chat and data communication user interfaces.

See also