GS2-Quest Master Data Reference
Reference for the master data format and the models to be imported
Master Data Format
{
"version": "2019-05-14",
"groups": [
{
"name": "[string]Quest Group Model name",
"metadata": "[string?]Metadata",
"quests": [
{
"questModelId": "[string]Quest Model GRN",
"name": "[string]Quest Model name",
"metadata": "[string?]Metadata",
"contents": [
{
"metadata": "[string?]Metadata",
"completeAcquireActions": [
{
"action": "[string]Type of Acquire Action",
"request": "[string]JSON string of the request used when executing the action"
}
],
"weight": "[int]Draw Weight"
}
],
"challengePeriodEventId": "[string?]Challenge Period Event GRN",
"firstCompleteAcquireActions": [
{
"action": "[string]Type of Acquire Action",
"request": "[string]JSON string of the request used when executing the action"
}
],
"verifyActions": [
{
"action": "[string]Type of Verify Action",
"request": "[string]JSON string of the request used when executing the action"
}
],
"consumeActions": [
{
"action": "[string]Type of Consume Action",
"request": "[string]JSON string of the request used when executing the action"
}
],
"failedAcquireActions": [
{
"action": "[string]Type of Acquire Action",
"request": "[string]JSON string of the request used when executing the action"
}
],
"premiseQuestNames": [
"[string]Quest Model name"
]
}
],
"challengePeriodEventId": "[string?]Challenge Period Event GRN"
}
]
}| Type | Condition | Required | Default | Value Limits | Description | |
|---|---|---|---|---|---|---|
| version | string | ✓ |
2019-05-14 | Format version of master data | ||
| groups | List<QuestGroupModel> | ~ 10 items | Quest Group Model A Quest Group is an entity for grouping multiple quests, and only one quest progression can be executed simultaneously within the group. This means that if you need to be able to progress quests in parallel, you must separate the groups. |
Models
QuestGroupModel
Quest Group Model
A Quest Group is an entity for grouping multiple quests, and only one quest progression can be executed simultaneously within the group. This means that if you need to be able to progress quests in parallel, you must separate the groups.
| Type | Condition | Required | Default | Value Limits | Description | |
|---|---|---|---|---|---|---|
| questGroupModelId | string | * |
~ 1024 chars | Quest Group
GRN
* Set automatically by the server |
||
| name | string | ✓ |
~ 128 chars | Quest Group Model name Quest Group Model-specific name. Specified using alphanumeric characters, hyphens (-), underscores (_), and periods (.). |
||
| metadata | string | ~ 1024 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. |
|||
| quests | List<QuestModel> | [] | 0 ~ 1000 items | Quests belonging to the group List of quest models that belong to this quest group. Only one quest within the group can be in progress at a time. |
||
| challengePeriodEventId | string | ~ 1024 chars | Challenge Period Event
GRN
GS2-Schedule event GRN that sets the time period during which quests in this group can be attempted. When specified, quests in this group can only be started while the event is active. |
QuestModel
Quest Model
A Quest Model is an entity that defines the cost required to start a quest and the rewards obtained upon completion.
The reward obtained upon completion of the quest can have multiple variations and can be drawn at the start of the quest. For example, the same content can be used to manage the clear flag of a quest, but two types of content can be prepared based on whether or not a rare monster appears.
| Type | Condition | Required | Default | Value Limits | Description | |
|---|---|---|---|---|---|---|
| questModelId | string | * |
~ 1024 chars | Quest Model
GRN
* Set automatically by the server |
||
| name | string | ✓ |
~ 128 chars | Quest Model name Quest Model-specific name. Specified using alphanumeric characters, hyphens (-), underscores (_), and periods (.). |
||
| metadata | string | ~ 1024 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. |
|||
| contents | List<Contents> | [] | 1 ~ 10 items | Quest content variations List of content variations for this quest. When the quest starts, one variation is selected by weighted random draw. Each variation can define different completion rewards, allowing different outcomes (e.g., rare monster appearances) for the same quest. |
||
| challengePeriodEventId | string | ~ 1024 chars | Challenge Period Event
GRN
GS2-Schedule event GRN that sets the time period during which this quest can be attempted. When specified, the quest can only be started while the event is active. This setting takes precedence over the quest group’s challenge period. |
|||
| firstCompleteAcquireActions | List<AcquireAction> | [] | 0 ~ 10 items | First Completion Acquire Actions List of acquire actions executed only on the first completion of this quest. These are bonus rewards granted in addition to the normal completion rewards, useful for first-clear bonuses. |
||
| verifyActions | List<VerifyAction> | [] | 0 ~ 10 items | List of Verify Actions List of verify actions that serve as preconditions for starting this quest. All verify actions must pass before the quest can begin. Used to enforce requirements such as level checks or item possession. |
||
| consumeActions | List<ConsumeAction> | [] | 0 ~ 10 items | List of Acquire Actions Consume actions executed as the cost of starting this quest. These are consumed when the quest begins, such as stamina or currency costs. |
||
| failedAcquireActions | List<AcquireAction> | [] | 0 ~ 100 items | Failed Acquire Actions Acquire actions executed when the quest fails. Used to provide consolation rewards or partial refunds of the quest participation cost upon failure. |
||
| premiseQuestNames | List<string> | [] | 0 ~ 10 items | Prerequisite Quest Names List of quest names within the same group that must be completed before this quest can be attempted. Used to create sequential quest chains or branching quest paths. |
Contents
Contents
Represents one variation of quest content. Each quest can have multiple content variations with different rewards, and one is selected by weighted random draw at quest start. The metadata supports template variable substitution with user ID and config values.
| Type | Condition | Required | Default | Value Limits | Description | |
|---|---|---|---|---|---|---|
| metadata | string | ~ 256 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. |
|||
| completeAcquireActions | List<AcquireAction> | [] | 0 ~ 10 items | Complete Acquire Actions Acquire actions executed as rewards when the quest is completed with this content variation. These define the actual rewards the player receives upon clearing the quest. |
||
| weight | int | 1 | 1 ~ 2147483646 | Draw Weight The relative weight used in the random selection of this content variation at quest start. Higher values increase the probability of this variation being selected. For example, a variation with weight 9 is 9 times more likely to be selected than one with weight 1. |
AcquireAction
Acquire Action
ConsumeAction
Consume Action
VerifyAction
Verify Action