GS2-Formation Master Data Reference

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

Master Data Format

{
  "version": "2019-09-09",
  "moldModels": [
    {
      "name": "[string]Form Storage Area Model name",
      "metadata": "[string?]Metadata",
      "initialMaxCapacity": "[int]Initial capacity to store forms",
      "maxCapacity": "[int]Maximum capacity to store forms",
      "formModel": {
        "formModelId": "[string]Form Model GRN",
        "name": "[string]Form Model name",
        "metadata": "[string?]Metadata",
        "slots": [
          {
            "name": "[string]Slot Model name",
            "propertyRegex": "[string]Regular expressions for values that can be set as properties",
            "metadata": "[string?]Metadata"
          }
        ]
      }
    }
  ],
  "propertyFormModels": [
    {
      "name": "[string]Property Form Model name",
      "metadata": "[string?]Metadata",
      "slots": [
        {
          "name": "[string]Slot Model name",
          "propertyRegex": "[string]Regular expressions for values that can be set as properties",
          "metadata": "[string?]Metadata"
        }
      ]
    }
  ]
}
TypeConditionRequiredDefaultValue LimitsDescription
versionstring
2019-09-09Format version of master data
moldModelsList<MoldModel>~ 100 itemsForm Storage Area Model
If it is a party composition, it is intended to be saved in the form of “fire attribute party” or “water attribute party”.
The number of areas that can be saved can be limited or expanded individually.
propertyFormModelsList<PropertyFormModel>~ 100 itemsProperty Form Model
An entity that represents the composition status.
The difference between Mold / Form is that Mold / Form defines the number of slots and records the composition in each slot,
and Property Form is used to represent compositions that are difficult to determine the number of slots in advance, such as setting skills for owned equipment.

Model

FormModel

Form Model

Form Model is an entity representing the configuration status. You can define slots as areas that can be formed.

For weapons and armor, parts such as “right hand”, “left hand”, “body”, and “arm” can be used as slots, and for parties, positions such as “vanguard”, “midfield”, and “rear guard” can be expressed as slots.

TypeConditionRequiredDefaultValue LimitsDescription
formModelIdstring
*
~ 1024 charsForm Model GRN
* Set automatically by the server
namestring
~ 128 charsForm Model name
Form Model-specific name. Specified using alphanumeric characters, hyphens (-), underscores (_), and periods (.).
metadatastring~ 2048 charsMetadata
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.
slotsList<SlotModel>
1 ~ 10 itemsList of Slot Model
The ordered list of slot definitions that make up this form. Each slot represents an assignable position, and the slot names must be unique within the form. For equipment, this might include slots like “weapon”, “armor”, “accessory”. For parties, slots like “position_1”, “position_2”, etc.

SlotModel

Slot Model

Defines a single slot within a form model. A slot represents an assignable position where a game resource (such as an item, character, or equipment) can be placed. The property regex validates what values can be assigned to the slot.

TypeConditionRequiredDefaultValue LimitsDescription
namestring
~ 128 charsSlot Model name
A unique identifier for this slot within the form model. For equipment forms, names like “right_hand” or “body” are typical. For party forms, names like “vanguard” or “rear_guard” are used.
propertyRegexstring“.*”~ 512 charsRegular expressions for values that can be set as properties
A regex pattern that validates the property ID values assignable to this slot. For example, restricting to specific GS2-Inventory item GRNs or GS2-Dictionary entry GRNs. Defaults to “.*” which allows any value.
metadatastring~ 512 charsMetadata
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.

MoldModel

Form Storage Area Model

If it is a party composition, it is intended to be saved in the form of “fire attribute party” or “water attribute party”. The number of areas that can be saved can be limited or expanded individually.

TypeConditionRequiredDefaultValue LimitsDescription
moldModelIdstring
*
~ 1024 charsForm Storage Area GRN
* Set automatically by the server
namestring
~ 128 charsForm Storage Area Model name
Form Storage Area Model-specific name. Specified using alphanumeric characters, hyphens (-), underscores (_), and periods (.).
metadatastring~ 2048 charsMetadata
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.
initialMaxCapacityint
1 ~ 2147483646Initial capacity to store forms
The default number of form save slots available to each player for this mold. For example, if set to 3, the player can initially save up to 3 different formations (e.g., “fire party”, “water party”, “wind party”). Can be expanded per-player up to maxCapacity.
maxCapacityint
1 ~ 2147483646Maximum capacity to store forms
The absolute upper limit for the number of form save slots per player for this mold. Even through capacity expansion operations, the capacity cannot exceed this value. Must be greater than or equal to initialMaxCapacity.
formModelFormModel
Form Model

PropertyFormModel

Property Form Model

An entity that represents the composition status. The difference between Mold / Form is that Mold / Form defines the number of slots and records the composition in each slot, and Property Form is used to represent compositions that are difficult to determine the number of slots in advance, such as setting skills for owned equipment.

TypeConditionRequiredDefaultValue LimitsDescription
propertyFormModelIdstring
*
~ 1024 charsProperty Form Model GRN
* Set automatically by the server
namestring
~ 128 charsProperty Form Model name
Property Form Model-specific name. Specified using alphanumeric characters, hyphens (-), underscores (_), and periods (.).
metadatastring~ 2048 charsMetadata
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.
slotsList<SlotModel>
1 ~ 10 itemsList of Slot Model
The ordered list of slot definitions for this property form. Unlike Mold/Form where the number of forms is limited by capacity, property forms are identified by a property ID and can exist for any owned resource. Slot names must be unique within the form.