Limited Access Mode #

Limited access mode allows operators to schedule time windows that open the platform for specified Player Groups. It can be used to create specific testing windows throughout development, including publisher demos, friends & family events, and closed/open betas. Limited access mode can be managed through the Web Portal.

Quick Guides #

Creating a Limited Access Event #

Send CreateLimitedAccessEventOperatorV1 with event details:

{
  "requestId": 1,
  "type": "GameManagementRpc.CreateLimitedAccessEventOperatorV1Request",
  "payload": {
    "limitedAccessEventDetails": {
      "gameShardId": "00000000-0000-0000-0000-000000000001",
      "name": "BetaTest",
      "description": "Come play our game!",
      "playerGroupIds": [
        "ffee5b6f-0b98-49ba-ad48-30aa2ff9df1d"
      ],
      "startUnixTimeMs": 1647561600000,
      "endUnixTimeMs": 1650240000000,
      "timeZone": "America/Los_Angeles"
    }
  }
}

Sample response with created event:

{
  "sequenceNumber": 0,
  "response": {
    "requestId": 1,
    "type": "GameManagementRpc.CreateLimitedAccessEventOperatorV1Response",
    "payload": {
      "limitedAccessEvent": {
        "limitedAccessEventId": "8115e320-ab23-4c0e-9f2d-429c06fe2db1",
        "limitedAccessEventDetails": {
          "gameShardId": "00000000-0000-0000-0000-000000000001",
          "name": "BetaTest",
          "description": "Come play our game!",
          "playerGroupIds": [
            "ffee5b6f-0b98-49ba-ad48-30aa2ff9df1d"
          ],
          "startUnixTimeMs": "1647561600000",
          "endUnixTimeMs": "1650240000000",
          "timeZone": "America/Los_Angeles"
        }
      }
    }
  }
}

Changing a Limited Access Event #

Update existing Limited Access Event with UpdateLimitedAccessEventOperatorV1Request:

{
  "requestId": 1,
  "type": "GameManagementRpc.UpdateLimitedAccessEventOperatorV1Request",
  "payload": {
    "limitedAccessEventId": "8115e320-ab23-4c0e-9f2d-429c06fe2db1",
    "limitedAccessEventDetails": {
      "gameShardId": "00000000-0000-0000-0000-000000000001",
      "name": "Early Beta Access",
      "description": "We decided to move the beta forward a month!",
      "playerGroupIds": [
        "ffee5b6f-0b98-49ba-ad48-30aa2ff9df1d"
      ],
      "startUnixTimeMs": 1645142400000,
      "endUnixTimeMs": 1647561600000,
      "timeZone": "America/Los_Angeles"
    }
  }
}

Sample response with updated information:

{
  "sequenceNumber": 0,
  "response": {
    "requestId": 1,
    "type": "GameManagementRpc.UpdateLimitedAccessEventOperatorV1Response",
    "payload": {
      "limitedAccessEvent": {
        "limitedAccessEventId": "8115e320-ab23-4c0e-9f2d-429c06fe2db1",
        "limitedAccessEventDetails": {
          "gameShardId": "00000000-0000-0000-0000-000000000001",
          "name": "Early Beta Access",
          "description": "We decided to move the beta forward a month!",
          "playerGroupIds": [
            "ffee5b6f-0b98-49ba-ad48-30aa2ff9df1d"
          ],
          "startUnixTimeMs": "1645142400000",
          "endUnixTimeMs": "1647561600000",
          "timeZone": "America/Los_Angeles"
        }
      }
    }
  }
}

Creating a Limited Access Event in Portal #

  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 Game Title Management by clicking the Services menu at the top, then clicking Game Title Management.

Navigate to Game Title Management

  1. In the Game Title Management view, click on testGame.

Game Title Management

  1. Click on testGameShard.

Game Title Management

  1. Click the Add Event button.

Add Event

  1. Set up your event by naming it, adding an optional description, adding the player group, and scheduling starting and ending dates/times. Click the Add Event button.

Scheduling a Limited Access Event

  1. Under Access Mode, click the Limited button, then confirm that you wish to set the shard to Limited Access mode.

Confirm shard Limited Access mode