GS2-Enhance Master Data Reference

Master Data Format

• JSON

{
  "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",
      "groupKeyHierarchy": [
        "[string]Hierarchy of the JSON data that stores the group key in the ItemModel metadata"
      ],
      "gradeEntries": [
        {
          "gradeValue": "[long]Target grade",
          "type": "[string]Type of material condition",
          "needCount": "[int]How many items of the same type to consume",
          "recipes": [
            {
              "name": "[string]Recipe name",
              "metadata": "[string?]Metadata",
              "targetGroupKeys": [
                "[string]Group key"
              ],
              "materials": [
                {
                  "name": "[string]Material name",
                  "materialType": "[string]Type of material",
                  "individualSetting": {
                    "matchType": "[string]How the material is matched against the target",
                    "gradeCondition": "[string]Grade condition of the material",
                    "gradeValue": "[long]Grade the material must have",
                    "count": "[int]Number of item sets to consume"
                  },
                  "quantitySetting": {
                    "matchType": "[string]How the item model to consume is decided",
                    "materialInventoryModelId": "[string]GS2-Inventory inventory model GRN to search for the material",
                    "itemModelId": "[string]GS2-Inventory item model GRN to consume",
                    "count": "[int]Quantity to consume"
                  }
                }
              ]
            }
          ]
        }
      ]
    }
  ]
}

Models

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.

targetInventoryModelId specifies the inventory model that holds the items to be enhanced, and materialInventoryModelId the inventory model that holds the items usable as material. These can be separate inventory models, so an arrangement in which characters are the target and enhancement-only items are the material is possible.

The experience each material grants is written in the metadata of its item model, and acquireExperienceHierarchy tells GS2-Enhance where in that JSON it is stored. For a structure such as { "aaa": { "bbb": { "experienceValue": 100 } } }, specify [ "aaa", "bbb", "experienceValue" ]. Up to 10 levels can be specified.

The gained experience is added to GS2-Experience, on the experience model specified by experienceModelId. The property ID it is added to is the property ID of the target item with acquireExperienceSuffix appended, so a single item can hold several kinds of experience, such as level for the character level and like for affection.

bonusRates defines a weighted draw over the bonus multipliers applied to the gained experience. Each entry holds a multiplier (1.5 meaning 150%) and a draw weight, one entry is chosen by weighted draw on each enhancement, and up to 1,000 entries can be registered.

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.

A limit break here is an enhancement that raises the grade managed by GS2-Grade by consuming duplicates of the same item as material. Raising the grade raises the rank cap on the GS2-Experience side, which lets the target be grown to a higher level.

targetInventoryModelId specifies the GS2-Inventory inventory model that holds the items eligible for a limit break. Both the item being unleashed and the duplicates consumed as material must belong to this inventory model. gradeModelId specifies the GS2-Grade grade model that tracks the grade of the target item; the grade is raised by 1 on a successful limit break.

gradeEntries defines, for each grade, how many duplicates must be consumed to reach it, and between 1 and 1,000 entries can be registered. Setting, for example, 1 duplicate for grade 1 and 3 duplicates for grade 2 lets you control the cost of each limit break step individually.

A resource consumed as material is discarded together with whatever it held. Even when the material holds experience or other resources, they are not carried over to the target, so convert them into a resource for handover beforehand if that is required.

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.

UnleashRecipe

Unleash Recipe

One way to raise the grade by one step. When a grade entry has several recipes, the player chooses one of them, and all the materials of the chosen recipe are required.

UnleashMaterial

Unleash Material

Defines one kind of material required by a recipe. “Individual (individual)” consumes item sets chosen by the player, such as duplicate equipment. “Quantity (quantity)” consumes a quantity of an item decided by the setting, such as a general-purpose enhancement material.

UnleashIndividualMaterialSetting

Individual Material Setting

Defines a material that is consumed as individual item sets, such as a duplicate piece of equipment. The player chooses which item sets to consume, and each chosen item set must belong to the same inventory model as the item being unleashed. Because each individual can have its own grade in GS2-Grade, the grade of the material can also be made a condition.

UnleashQuantityMaterialSetting

Quantity Material Setting

Defines a material that is consumed by quantity, such as a general-purpose enhancement material. The player does not choose the item; the item model to consume is decided by this setting, and the specified quantity is consumed. Both GS2-Inventory standard inventories and simple inventories can be used.