Player Groups #

Player groups support live ops and shard management features.

Groups can be created and managed through the Operator Portal, either by selecting individual players or through various filter and random selection options.

The following are examples of use cases for player groups:

• add players to groups to allow them to access restricted game shard
• use membership in a player group to apply custom behavior in your game client (store A-B testing, balancing)

Create a player group #

1. Log into Pragma Engine’s Social Operator Portal. If you are running Pragma locally, you can access the Social Operator Portal at http://localhost:11200.
2. Click Groups in the Accounts menu on the left, then click the Add group button.

If you don’t see the Accounts menu, click the Services menu at the top, then click Accounts.

3. Enter a name and optional description for the Player Group, then click Create Group.
4. View the newly created Player Group in Pragma Portal. Click Add Players.
5. Add the test01 account to the group by clicking the Add button.
6. Click Groups in the Accounts menu on the left-hand side and verify that your group now has one player added.

In addition, the CreatePlayerGroupOperatorV1 endpoint is available to create player groups. Send CreatePlayerGroupOperatorV1 with a name and description:

{
  "requestId": 1,
  "type": "AccountRpc.CreatePlayerGroupOperatorV1Request",
  "payload": {
    "name": "group-name-1",
    "description": "some description about the group"
  }
}

Sample response with Player Group data including a group ID and player count.

{
  "sequenceNumber": 0,
  "response": {
    "requestId": 1,
    "type": "AccountRpc.CreatePlayerGroupOperatorV1Response",
    "payload": {
      "playerGroup": {
        "playerGroupId": "3eed7645-8a46-497f-a60f-611df63cd4dd",
        "name": "group-name-1",
        "description": "some description about the group",
        "playerCount": "0"
      }
    }
  }
}

View existing player groups #

1. Log into Pragma Engine’s Social Operator Portal. If you are running Pragma locally, you can access the Social Operator Portal at http://localhost:11200.
2. Navigate to the Accounts service if necessary, then click on Groups in the left sidebar to view the existing player groups.

In addition, the ViewPlayerGroupsOperatorV1 endpoint can be used to view existing player groups and their respective playerGroupIds. Send ViewPlayerGroupsOperatorV1 with the following payload:

{
  "requestId": 1,
  "type": "AccountRpc.ViewPlayerGroupsOperatorV1Request",
  "payload": {}
}

Remove existing player groups #

1. Log into Pragma Engine’s Social Portal. If you are running Pragma locally, you can access the Social Portal at http://localhost:11200.
2. Navigate to the Accounts service if necessary, then click on Groups in the left sidebar to view the existing player groups.
3. Click on the player group you’d like to remove.
4. Click the Delete Group button.

In addition, the RemovePlayerGroupOperatorV1 endpoint can be used to remove existing player groups. Send RemovePlayerGroupOperatorV1 with the following payload:

{
    "requestId": 1,
    "type": "AccountRpc.RemovePlayerGroupOperatorV1Request",
    "payload": {
        "playerGroupId": "PLAYER_GROUP_ID"
    }
}

Add an account to a group #

1. From the Social Pragma Portal, click Services, then click Accounts.
2. Click on the relevant player name to view individual account information.
3. Under Groups click Add To Group.
4. Select the player group you’d like to add in the dropdown.
5. Confirm you would like to add the selected group.

In addition, the following Partner, Service, and Operator endpoints are available to add accounts to a group:

• AccountRpc.AddAccountToPlayerGroupPartnerV1Request
• AccountRpc.AddAccountToPlayerGroupServiceV1Request
• AccountRpc.AddAccountToPlayerGroupOperatorV1Request

Add multiple accounts to a group #

1. From the Social Pragma Portal, click Services, then click Groups.
2. Select a group.
3. Click Add Players.
4. Filter the players you would like to add to the group.
5. Click Add All.

In addition, the following Operator endpoint is available to add multiple accounts to a group: AccountRPC.AddAccountsToPlayerGroupOperatorV1Request.

Remove an account from a group #

1. From the Social Pragma Portal, click Services, then click Accounts.
2. Click on the relevant player name to view individual account information.
3. Under Groups, hover over the group you would like to remove.
4. Click Remove.
5. Confirm you would like to remove the selected group.

In addition, the following Partner, Service, and Operator endpoints are available to remove accounts from a group:

• AccountRpc.RemoveAccountFromPlayerGroupPartnerV1Request
• AccountRpc.RemoveAccountFromPlayerGroupServiceV1Request
• AccountRpc.RemoveAccountFromPlayerGroupOperatorV1Request