Master Data Reference of GS2-Grade

Reference of the format of master data and various models to be imported

Master Data Format

{
  "version": "2023-12-25",
  "gradeModels": [
    {
      "name": "[string]Grade Model Name",
      "metadata": "[string?]Metadata",
      "defaultGrades": [
        {
          "propertyIdRegex": "[string]Regular expression for property ID to which default value is applied",
          "defaultGradeValue": "[long]Default grade value"
        }
      ],
      "experienceModelId": "[string]GS2-Experience Experience Model GRN to link grade and rank cap",
      "gradeEntries": [
        {
          "metadata": "[string?]Metadata",
          "rankCapValue": "[long]Rank cap value to be set in GS2-Experience",
          "propertyIdRegex": "[string]Regular expression for property ID that can be used for grade up",
          "gradeUpPropertyIdRegex": "[string]Regular expression for property ID that can be used for grade up"
        }
      ],
      "acquireActionRates": [
        {
          "name": "[string]Remuneration addition table name",
          "mode": "[string]Remuneration addition table type",
          "rates": [
            "[double]Addition amount (multiplier)"
          ],
          "bigRates": [
            "[string]Addition amount (multiplier)"
          ]
        }
      ]
    }
  ]
}

	Type	Condition	Required	Default	Value Limits	Description
version	string		✓	2023-12-25		Format version of master data
gradeModels	List<GradeModel>				~ 100 items	Grade Model A grade model is an entity that sets the threshold of grade required for rank advancement and for each default and maximum rank cap.

Model

GradeModel

Grade Model

A grade model is an entity that sets the threshold of grade required for rank advancement and for each default and maximum rank cap.

	Type	Required	Value Limits	Description
gradeModelId	string	✓*	~ 1024 chars	Grade Model GRN * Automatically configured on the server
name	string	✓	~ 128 chars	Grade Model Name Grade model-specific name. Specified using alphanumeric characters, hyphens (-), underscores (_), and periods (.).
metadata	string		~ 2048 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.
defaultGrades	List<DefaultGradeModel>		0 ~ 100 items	List of Default grade model
experienceModelId	string	✓	~ 1024 chars	GS2-Experience Experience Model GRN to link grade and rank cap
gradeEntries	List<GradeEntryModel>	✓	1 ~ 100 items	List of Grade Entry Models
acquireActionRates	List<AcquireActionRate>		0 ~ 100 items	List of Remuneration addition table

DefaultGradeModel

Default grade model

You can set the default grade value according to the match of the property ID regular expression when creating a new grade.

	Type	Condition	Required	Default	Value Limits	Description
propertyIdRegex	string		✓		~ 1024 chars	Regular expression for property ID to which default value is applied
defaultGradeValue	long		✓		0 ~ 9223372036854775805	Default grade value

GradeEntryModel

Grade Entry Model

	Type	Required	Value Limits	Description
metadata	string		~ 2048 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.
rankCapValue	long	✓	0 ~ 9223372036854775805	Rank cap value to be set in GS2-Experience
propertyIdRegex	string	✓	~ 1024 chars	Regular expression for property ID that can be used for grade up You can use the parts enclosed in parentheses in the pattern as $1/$2… in the regular expression of gradeUpPropertyIdRegex.
gradeUpPropertyIdRegex	string	✓	~ 1024 chars	Regular expression for property ID that can be used for grade up

AcquireActionRate

Remuneration addition table master

You can adjust the amount of rewards according to the rank.

Type

Condition

Required

Default

Value Limits

Description

name

string

✓

~ 128 chars

Remuneration addition table name

mode

String Enum
enum {
“double”,
“big”
}

✓

“double”

Remuneration addition table type

Enumerator String Definition	Description
“double”	Floating point number less than 2^48
“big”	Floating point number less than 1024 digits

rates

List<double>

{mode} == “double”

✓*

1 ~ 1000 items

Amount added per grade (multiplier)

* Required if mode is “double”

bigRates

List<string>

{mode} == “big”

✓*

1 ~ 1000 items

Amount added per grade (multiplier)

* Required if mode is “big”