GS2-Enhance Master Data Reference

Master Data Format

{
  "version": "2020-08-22",
  "rateModels": [
    {
      "name": "[string]Enhancement Rate Model name",
      "description": "[string?]Description",
      "metadata": "[string?]Metadata",
      "targetInventoryModelId": "[string]GS2-Inventory Inventory Model GRN usable for enhancement targets",
      "acquireExperienceSuffix": "[string]Suffix to be assigned to the property ID that stores the experience value obtained from GS2-Experience",
      "materialInventoryModelId": "[string]GS2-Inventory Inventory Model GRN usable as enhancement material",
      "acquireExperienceHierarchy": [
        "[string]Hierarchical structure of JSON data defining acquisition experience values to be stored in ItemModel metadata"
      ],
      "experienceModelId": "[string]GS2-Experience Experience Model GRN gained as a result of enhancement",
      "bonusRates": [
        {
          "rate": "[float]Experience bonus multiplier (1.0 = no bonus)",
          "weight": "[int]Lottery weight"
        }
      ]
    }
  ],
  "unleashRateModels": [
    {
      "name": "[string]Unleash Rate Model name",
      "description": "[string?]Description",
      "metadata": "[string?]Metadata",
      "targetInventoryModelId": "[string]GS2-Inventory Inventory Model GRN usable for unleash targets",
      "gradeModelId": "[string]Grade Model GRN",
      "gradeEntries": [
        {
          "gradeValue": "[long]Target grade",
          "needCount": "[int]How many items of the same type to consume"
        }
      ]
    }
  ]
}

Model

RateModel

Enhancement Rate Model

The enhancement rate is data that defines the materials used for enhancement and the target of enhancement.

Both material data and enhancement target data must be managed in GS2-Inventory. The experience value obtained from the enhancement is recorded in GS2-Inventory metadata in JSON format. Here, it is necessary to describe at which level of the metadata the experience value is stored.

A correction value can be applied to the amount of experience value that can be obtained with a certain probability of great success during enhancement. The probability of that draw is also defined in this entity.

BonusRate

Experience Gain Bonus

Defines a single entry in the weighted lottery for determining the experience bonus multiplier during enhancement. By configuring multiple entries with different rates and weights, you can implement “great success” or “super success” mechanics with controlled probabilities.

UnleashRateModel

Unleash Rate Model

Defines the conditions for limit breaking (unleashing) items. Associates an item managed in GS2-Inventory with a GS2-Grade grade model to enable grade progression. Each grade level can require consuming a different number of duplicate items, allowing fine-grained control over the cost of each limit break step.

UnleashRateEntryModel

Unleash Rate Entry Model

Defines the material cost for a single grade level in a limit break progression. Each entry specifies which grade value it applies to and how many duplicate items of the same type must be consumed to achieve that grade.