GS2-Lottery Master Data Reference

Master Data Format

{
  "version": "2019-02-21",
  "lotteryModels": [
    {
      "name": "[string]Lottery Model name",
      "metadata": "[string?]Metadata",
      "mode": "[string (enum)]Drawing Mode",
      "method": "[string (enum)]Prize Table Selection Method",
      "prizeTableName": "[string]Prize Table Name",
      "choicePrizeTableScriptId": "[string]GS2-Script script GRN to determine the Prize Table"
    }
  ],
  "prizeTables": [
    {
      "name": "[string]Prize Table name",
      "metadata": "[string?]Metadata",
      "prizes": [
        {
          "prizeId": "[string]Prize ID",
          "type": "[string]Prize Type",
          "acquireActions": [
            {
              "action": "[string]Type of Acquire Action",
              "request": "[string]JSON string of the request used when executing the action"
            }
          ],
          "drawnLimit": "[int?]Maximum Number of Draws",
          "limitFailOverPrizeId": "[string]Limit Failover Prize ID",
          "prizeTableName": "[string]Prize Table Name",
          "weight": "[int]Draw Weight"
        }
      ]
    }
  ]
}

Models

PrizeTable

Prize Table

A prize can either specify an acquire action directly or reference another Prize Table. By nesting Prize Tables, you can configure a two-step drawing process—for example, the first step determines the rarity such as SSR, SR, or R, and the second step selects a specific item corresponding to that rarity. This structure makes it easier to manage and adjust the overall distribution rates for each rarity in the game.

Prize

Prize

A single prize entry within a Prize Table. A prize can either directly specify acquire actions (granting items, currency, etc.) or reference another Prize Table to perform a nested draw. Each prize has a draw weight that determines its relative probability of being drawn.

AcquireAction

Acquire Action

LotteryModel

Lottery Model

Lottery Model is an entity that defines the draw method and how to reference the draw table.

Two draw methods are available: Normal Draw, which performs draws with a fixed probability each time, and Box Draw, where a predetermined number of prizes are placed in a box, and prizes are drawn from the box one by one with each draw.

The lottery process uses a Prize Table. GS2-Script can be used to dynamically select the Prize Table with a different table when multiple drawings are performed. By using this mechanism, it is possible to apply a different Prize Table only once in a 10-round gacha.