GS2-Matchmaking Master Data Reference

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

Master Data Format

{
  "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	Required	Default	Value Limits	Description
version	string	✓	2020-06-24		Format version of master data
ratingModels	List<RatingModel>			~ 50 items	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.
seasonModels	List<SeasonModel>			~ 50 items	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.

Model

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	Required	Default	Value Limits	Description
ratingModelId	string	*		~ 1024 chars	Rating Model GRN * Set automatically by the server
name	string	✓		~ 128 chars	Rating Model name Rating Model-specific name. Specified using alphanumeric characters, hyphens (-), underscores (_), and periods (.).
metadata	string			~ 128 chars	Metadata Arbitrary values can be set in the metadata. 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 The starting rate value assigned to new players when they first participate in rated matchmaking. Defaults to 1500. All players begin at the same rating and it adjusts based on match results.
volatility	int		100	1 ~ 20000	Rating Volatility A Glicko-2 parameter that controls how much the rating value changes after each match. Higher values cause larger rating fluctuations, making ratings adjust more quickly. 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	Required	Value Limits	Description
seasonModelId	string	*	~ 1024 chars	Season Model GRN * Set automatically by the server
name	string	✓	~ 128 chars	Season Model name Season Model-specific name. Specified using alphanumeric characters, hyphens (-), underscores (_), and periods (.).
metadata	string		~ 128 chars	Metadata Arbitrary values can be set in the metadata. 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 The maximum number of players that can join a single Season Gathering. Once this limit is reached, the Season Gathering is considered full and no more players can join. Must be between 2 and 1000.
experienceModelId	string		~ 1024 chars	Experience Model GRN for Tier Management The GRN of the GS2-Experience experience model used to determine player tiers. 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. 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 The GRN of the GS2-Schedule event that defines the active period for this season. Season Gatherings can only be created and joined while this event is active. When the event period ends, the season closes and new matchmaking is no longer possible.