> For the complete documentation index, see [llms.txt](/llms.txt)

# GS2-Matchmaking Master Data Reference

Reference for the master data format and the models to be imported




## Master Data Format


**JSON**
```json
{
  "version": "2020-06-24",
  "ratingModels": [
    {
      "name": "[string]Rating Model name",
      "metadata": "[string?]Metadata",
      "initialValue": "[int]Initial Rating Value",
      "volatility": "[int]Rating Volatility"
    }
  ],
  "seasonModels": [
    {
      "name": "[string]Season Model name",
      "metadata": "[string?]Metadata",
      "maximumParticipants": "[int]Maximum Number of Participants",
      "experienceModelId": "[string?]Experience Model GRN for Tier Management",
      "challengePeriodEventId": "[string]Challenge Period Event GRN"
    }
  ]
}
```


|  | Type | Condition | Required | Default | Value Limits | Description |
| --- | --- | --- | --- | --- | --- | --- |
| version | string | | ✓ | 2020-06-24 | | Master data format version |
| ratingModels | [List&lt;RatingModel&gt;](#ratingmodel) |  |  |  |  ~ 50 items | Rating Model<br>GS2 uses Glicko-2 as its rating algorithm.<br>Glicko-2 has several parameters, but GS2-Matchmaking aggregates them into a single parameter, volatility, which represents the totality of the parameters.<br>Volatility is a parameter that expresses the magnitude of change; the larger the value, the greater the change in the rating value. |
| seasonModels | [List&lt;SeasonModel&gt;](#seasonmodel) |  |  |  |  ~ 50 items | Season Model<br>Defines the season-specific settings for Season Matchmaking, including the period of persistent gatherings, maximum participant count, and tier integration settings.<br>Managed by GS2-Schedule for period control, and can be linked with GS2-Experience for persistent gathering within the same tier as needed. |

## Models

### RatingModel

Rating Model

GS2 uses Glicko-2 as its rating algorithm.
Glicko-2 has several parameters, but GS2-Matchmaking aggregates them into a single parameter, volatility, which represents the totality of the parameters.
Volatility is a parameter that expresses the magnitude of change; the larger the value, the greater the change in the rating value.

|  | Type | Condition | Required | Default | Value Limits | Description |
| --- | --- | --- | --- | --- | --- | --- |
| ratingModelId | string |  | * |  |  ~ 1024 chars | Rating Model GRN<br>* Set automatically by the server |
| name | string |  | ✓ |  |  ~ 128 chars | Rating Model name<br>Unique Rating Model name. Specified using alphanumeric characters, hyphens (-), underscores (_), and periods (.). |
| metadata | string |  |  |  |  ~ 128 chars | Metadata<br>Arbitrary values can be set in the metadata.<br>Since they do not affect GS2’s behavior, they can be used to store information used in the game. |
| initialValue | int |  |  | 1500 | 100 ~ 10000 | Initial Rating Value<br>The starting rate value assigned to new players when they first participate in rated matchmaking.<br>Defaults to 1500. All players begin at the same rating and it adjusts based on match results. |
| volatility | int |  |  | 100 | 1 ~ 20000 | Rating Volatility<br>A Glicko-2 parameter that controls how much the rating value changes after each match.<br>Higher values cause larger rating fluctuations, making ratings adjust more quickly.<br>Lower values result in more stable ratings that change gradually. Defaults to 100. |

---

### SeasonModel

Season Model

Defines the season-specific settings for Season Matchmaking, including the period of persistent gatherings, maximum participant count, and tier integration settings.
Managed by GS2-Schedule for period control, and can be linked with GS2-Experience for persistent gathering within the same tier as needed.

|  | Type | Condition | Required | Default | Value Limits | Description |
| --- | --- | --- | --- | --- | --- | --- |
| seasonModelId | string |  | * |  |  ~ 1024 chars | Season Model GRN<br>* Set automatically by the server |
| name | string |  | ✓ |  |  ~ 128 chars | Season Model name<br>Unique Season Model name. Specified using alphanumeric characters, hyphens (-), underscores (_), and periods (.). |
| metadata | string |  |  |  |  ~ 128 chars | Metadata<br>Arbitrary values can be set in the metadata.<br>Since they do not affect GS2’s behavior, they can be used to store information used in the game. |
| maximumParticipants | int |  | ✓ |  | 2 ~ 1000 | Maximum Number of Participants<br>The maximum number of players that can join a single Season Gathering.<br>Once this limit is reached, the Season Gathering is considered full and no more players can join.<br>Must be between 2 and 1000. |
| experienceModelId | string |  |  |  |  ~ 1024 chars | Experience Model GRN for Tier Management<br>The GRN of the GS2-Experience experience model used to determine player tiers.<br>The player's rank within this experience model is used as their tier for matchmaking, ensuring players are grouped with others at a similar level.<br>If not specified, tier-based grouping is disabled and all players are matched together regardless of level. |
| challengePeriodEventId | string |  | ✓ |  |  ~ 1024 chars | Challenge Period Event GRN<br>The GRN of the GS2-Schedule event that defines the active period for this season.<br>Season Gatherings can only be created and joined while this event is active.<br>When the event period ends, the season closes and new matchmaking is no longer possible. |

---