GS2-Formation Deploy/CDK Reference
The template format used when creating stacks with GS2-Deploy, and implementation examples of template output in various languages using CDK
Entities
Resources targeted by the Deploy operation
Namespace
Namespace
A Namespace allows multiple independent instances of the same service within a single project by separating data spaces and usage contexts. Each GS2 service is managed on a per-namespace basis. Even when using the same service, if the namespace differs, the data is treated as a completely independent data space.
Therefore, you must create a namespace before you can start using each service.
Request
Resource creation and update requests
| Type | Condition | Required | Default | Value Limits | Description | |
|---|---|---|---|---|---|---|
| name | string | ✓ | ~ 128 chars | Namespace name Namespace-specific name. Specified using alphanumeric characters, hyphens (-), underscores (_), and periods (.). | ||
| description | string | ~ 1024 chars | Description | |||
| transactionSetting | TransactionSetting | Transaction Setting Configuration for controlling how transactions are processed when executing formation operations. | ||||
| updateMoldScript | ScriptSetting | Script to run when updating Mold capacity Script Trigger Reference - updateMold | ||||
| updateFormScript | ScriptSetting | Script to run when updating a form Script Trigger Reference - updateForm | ||||
| updatePropertyFormScript | ScriptSetting | Script to run when updating a property form Script Trigger Reference - updatePropertyForm | ||||
| logSetting | LogSetting | Log Output Settings Configuration for outputting log data of formation operations to GS2-Log. By specifying a GS2-Log namespace, API request and response logs for form updates, mold capacity changes, and property form modifications can be collected. |
GetAttr
Resource creation results that can be retrieved using the !GetAttr tag
| Type | Description | |
|---|---|---|
| Item | Namespace | Namespace created |
Implementation Example
Type: GS2::Formation::Namespace
Properties:
Name: namespace-0001
Description: null
TransactionSetting:
EnableAutoRun: true
QueueNamespaceId: grn:gs2:ap-northeast-1:YourOwnerId:queue:queue-0001
UpdateMoldScript: null
UpdateFormScript: null
UpdatePropertyFormScript: null
LogSetting:
LoggingNamespaceId: grn:gs2:ap-northeast-1:YourOwnerId:log:namespace-0001import (
"github.com/gs2io/gs2-golang-cdk/core"
"github.com/gs2io/gs2-golang-cdk/formation"
"github.com/openlyinc/pointy"
)
SampleStack := core.NewStack()
formation.NewNamespace(
&SampleStack,
"namespace-0001",
formation.NamespaceOptions{
TransactionSetting: &core.TransactionSetting{
QueueNamespaceId: pointy.String("grn:gs2:ap-northeast-1:YourOwnerId:queue:queue-0001"),
},
LogSetting: &core.LogSetting{
LoggingNamespaceId: "grn:gs2:ap-northeast-1:YourOwnerId:log:namespace-0001",
},
},
)
println(SampleStack.Yaml()) // Generate Templateclass SampleStack extends \Gs2Cdk\Core\Model\Stack
{
function __construct() {
parent::__construct();
new \Gs2Cdk\Formation\Model\Namespace_(
stack: $this,
name: "namespace-0001",
options: new \Gs2Cdk\Formation\Model\Options\NamespaceOptions(
transactionSetting: new \Gs2Cdk\Core\Model\TransactionSetting(
new \Gs2Cdk\Core\Model\TransactionSettingOptions(
queueNamespaceId: "grn:gs2:ap-northeast-1:YourOwnerId:queue:queue-0001"
)
),
logSetting: new \Gs2Cdk\Core\Model\LogSetting(
loggingNamespaceId: "grn:gs2:ap-northeast-1:YourOwnerId:log:namespace-0001"
)
)
);
}
}
print((new SampleStack())->yaml()); // Generate Templateclass SampleStack extends io.gs2.cdk.core.model.Stack
{
public SampleStack() {
super();
new io.gs2.cdk.formation.model.Namespace(
this,
"namespace-0001",
new io.gs2.cdk.formation.model.options.NamespaceOptions()
.withTransactionSetting(new io.gs2.cdk.core.model.TransactionSetting(
new io.gs2.cdk.core.model.options.TransactionSettingOptions()
.withQueueNamespaceId("grn:gs2:ap-northeast-1:YourOwnerId:queue:queue-0001")
))
.withLogSetting(new io.gs2.cdk.core.model.LogSetting(
"grn:gs2:ap-northeast-1:YourOwnerId:log:namespace-0001"
))
);
}
}
System.out.println(new SampleStack().yaml()); // Generate Templatepublic class SampleStack : Gs2Cdk.Core.Model.Stack
{
public SampleStack() {
new Gs2Cdk.Gs2Formation.Model.Namespace(
stack: this,
name: "namespace-0001",
options: new Gs2Cdk.Gs2Formation.Model.Options.NamespaceOptions
{
transactionSetting = new Gs2Cdk.Core.Model.TransactionSetting(
options: new Gs2Cdk.Core.Model.TransactionSettingOptions
{
queueNamespaceId = "grn:gs2:ap-northeast-1:YourOwnerId:queue:queue-0001"
}
),
logSetting = new Gs2Cdk.Core.Model.LogSetting(
loggingNamespaceId: "grn:gs2:ap-northeast-1:YourOwnerId:log:namespace-0001"
)
}
);
}
}
Debug.Log(new SampleStack().Yaml()); // Generate Templateimport core from "@/gs2cdk/core";
import formation from "@/gs2cdk/formation";
class SampleStack extends core.Stack
{
public constructor() {
super();
new formation.model.Namespace(
this,
"namespace-0001",
{
transactionSetting: new core.TransactionSetting(
{
queueNamespaceId: "grn:gs2:ap-northeast-1:YourOwnerId:queue:queue-0001"
}
),
logSetting: new core.LogSetting(
"grn:gs2:ap-northeast-1:YourOwnerId:log:namespace-0001"
)
}
);
}
}
console.log(new SampleStack().yaml()); // Generate Templatefrom gs2_cdk import Stack, core, formation
class SampleStack(Stack):
def __init__(self):
super().__init__()
formation.Namespace(
stack=self,
name='namespace-0001',
options=formation.NamespaceOptions(
transaction_setting=core.TransactionSetting(
options=core.TransactionSettingOptions(
queue_namespace_id='grn:gs2:ap-northeast-1:YourOwnerId:queue:queue-0001',
)
),
log_setting=core.LogSetting(
logging_namespace_id='grn:gs2:ap-northeast-1:YourOwnerId:log:namespace-0001',
),
),
)
print(SampleStack().yaml()) # Generate TemplateTransactionSetting
Transaction Setting
Transaction Setting controls how transactions are executed, including their consistency, asynchronous processing, and conflict avoidance mechanisms. Combining features like AutoRun, AtomicCommit, asynchronous execution using GS2-Distributor, batch application of script results, and asynchronous Acquire Actions via GS2-JobQueue enables robust transaction management tailored to game logic.
| Type | Condition | Required | Default | Value Limits | Description | |
|---|---|---|---|---|---|---|
| enableAutoRun | bool | false | Whether to automatically execute issued transactions on the server side | |||
| enableAtomicCommit | bool | {enableAutoRun} == true | false | Whether to commit the execution of transactions atomically * Applicable only if enableAutoRun is true | ||
| transactionUseDistributor | bool | {enableAtomicCommit} == true | false | Whether to execute transactions asynchronously * Applicable only if enableAtomicCommit is true | ||
| commitScriptResultInUseDistributor | bool | {transactionUseDistributor} == true | false | Whether to execute the commit processing of the script result asynchronously * Applicable only if transactionUseDistributor is true | ||
| acquireActionUseJobQueue | bool | {enableAtomicCommit} == true | false | Whether to use GS2-JobQueue to execute the acquire action * Applicable only if enableAtomicCommit is true | ||
| distributorNamespaceId | string | “grn:gs2:{region}:{ownerId}:distributor:default” | ~ 1024 chars | GS2-Distributor Namespace GRN used to execute transactions | ||
| queueNamespaceId | string | “grn:gs2:{region}:{ownerId}:queue:default” | ~ 1024 chars | GS2-JobQueue Namespace GRN used to execute transactions |
ScriptSetting
Script Setting
In GS2, you can associate custom scripts with microservice events and execute them. This model holds the settings for triggering script execution.
There are two main ways to execute a script: synchronous execution and asynchronous execution. Synchronous execution blocks processing until the script has finished executing. Instead, you can use the script’s execution results to halt API execution or control the API’s response content.
In contrast, asynchronous execution does not block processing until the script has finished executing. However, because the script result cannot be used to stop the API execution or modify the API response, asynchronous execution does not affect the API response flow and is generally recommended.
There are two types of asynchronous execution methods: GS2-Script and Amazon EventBridge. By using Amazon EventBridge, you can write processing in languages other than Lua.
| Type | Condition | Required | Default | Value Limits | Description | |||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| triggerScriptId | string | ~ 1024 chars | GS2-Script script GRN
executed synchronously when the API is executed Must be specified in GRN format starting with “grn:gs2:”. | |||||||||||
| doneTriggerTargetType | String Enum enum { “none”, “gs2_script”, “aws” } | “none” | How to execute asynchronous scripts Specifies the type of script to use for asynchronous execution. You can choose from “Do not use asynchronous execution (none)”, “Use GS2-Script (gs2_script)”, and “Use Amazon EventBridge (aws)”.
| |||||||||||
| doneTriggerScriptId | string | {doneTriggerTargetType} == “gs2_script” | ~ 1024 chars | GS2-Script script GRN
for asynchronous execution Must be specified in GRN format starting with “grn:gs2:”. * Applicable only if doneTriggerTargetType is “gs2_script” | ||||||||||
| doneTriggerQueueNamespaceId | string | {doneTriggerTargetType} == “gs2_script” | ~ 1024 chars | GS2-JobQueue namespace GRN
to execute asynchronous execution scripts If you want to execute asynchronous execution scripts via GS2-JobQueue instead of executing them directly, specify the GS2-JobQueue namespace GRN. There are not many cases where GS2-JobQueue is required, so you generally do not need to specify it unless you have a specific reason. * Applicable only if doneTriggerTargetType is “gs2_script” |
LogSetting
Log Output Setting
Log Output Setting defines how log data is exported. This type holds the GS2-Log namespace identifier (Namespace ID) used to export log data. Specify the GS2-Log namespace where log data is collected and stored in the GRN format for the Log Namespace ID (loggingNamespaceId). Configuring this setting ensures that log data for API requests and responses occurring within the specified namespace is output to the target GS2-Log namespace. GS2-Log provides real-time logs that can be used for system monitoring, analysis, debugging, and other operational purposes.
| Type | Condition | Required | Default | Value Limits | Description | |
|---|---|---|---|---|---|---|
| loggingNamespaceId | string | ✓ | ~ 1024 chars | GS2-Log namespace GRN
to output logs Must be specified in GRN format starting with “grn:gs2:”. |
CurrentFormMaster
Currently active Form Model master data
This master data describes the definitions of Form Model currently active within the namespace. GS2 uses JSON format files for managing master data. By uploading these files, the master data settings are updated on the server.
To create JSON files, GS2 provides a master data editor within the management console. Additionally, you can create tools better suited for game operations and export JSON files in the appropriate format.
Note
Please refer to Master Data Reference of GS2-Formation for the JSON file format.Request
Resource creation and update requests
| Type | Condition | Required | Default | Value Limits | Description | |||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|
| namespaceName | string | ✓ | ~ 128 chars | Namespace name Namespace-specific name. Specified using alphanumeric characters, hyphens (-), underscores (_), and periods (.). | ||||||||
| mode | String Enum enum { “direct”, “preUpload” } | “direct” | Update mode
| |||||||||
| settings | string | {mode} == “direct” | ✓* | ~ 5242880 chars | Master Data * Required if mode is “direct” | |||||||
| uploadToken | string | {mode} == “preUpload” | ✓* | ~ 1024 chars | Token obtained by pre-upload Used to apply the uploaded master data. * Required if mode is “preUpload” |
GetAttr
Resource creation results that can be retrieved using the !GetAttr tag
| Type | Description | |
|---|---|---|
| Item | CurrentFormMaster | Updated master data of the currently active Form Models |
Implementation Example
Type: GS2::Formation::CurrentFormMaster
Properties:
NamespaceName: namespace-0001
Mode: direct
Settings: {
"version": "2019-09-09",
"moldModels": [
{
"name": "party",
"initialMaxCapacity": 10,
"maxCapacity": 20,
"formModel":
{
"name": "party",
"metadata": "PARTY",
"slots": [
{
"name": "tank",
"metadata": "TANK",
"propertyRegex": "grn:.*"
},
{
"name": "healer",
"metadata": "HEALER",
"propertyRegex": "grn:.*"
},
{
"name": "dps_1",
"metadata": "DPS",
"propertyRegex": "grn:.*"
},
{
"name": "dps_2",
"metadata": "DPS",
"propertyRegex": "grn:.*"
}
]
},
"metadata": "PARTY"
},
{
"name": "equipment",
"initialMaxCapacity": 20,
"maxCapacity": 30,
"formModel":
{
"name": "equipment",
"metadata": "EQUIPMENT",
"slots": [
{
"name": "head",
"metadata": "HEAD",
"propertyRegex": "grn:.*"
},
{
"name": "body",
"metadata": "BODY",
"propertyRegex": "grn:.*"
},
{
"name": "leg",
"metadata": "LEG",
"propertyRegex": "grn:.*"
}
]
},
"metadata": "EQUIPMENT"
}
],
"propertyFormModels": []
}
UploadToken: nullimport (
"github.com/gs2io/gs2-golang-cdk/core"
"github.com/gs2io/gs2-golang-cdk/formation"
"github.com/openlyinc/pointy"
)
SampleStack := core.NewStack()
formation.NewNamespace(
&SampleStack,
"namespace-0001",
formation.NamespaceOptions{},
).MasterData(
[]formation.MoldModel{
formation.NewMoldModel(
"party",
10,
20,
formation.NewFormModel(
"party",
[]formation.SlotModel{
formation.NewSlotModel(
"tank",
"grn:.*",
formation.SlotModelOptions{
Metadata: pointy.String("TANK"),
},
),
formation.NewSlotModel(
"healer",
"grn:.*",
formation.SlotModelOptions{
Metadata: pointy.String("HEALER"),
},
),
formation.NewSlotModel(
"dps_1",
"grn:.*",
formation.SlotModelOptions{
Metadata: pointy.String("DPS"),
},
),
formation.NewSlotModel(
"dps_2",
"grn:.*",
formation.SlotModelOptions{
Metadata: pointy.String("DPS"),
},
),
},
formation.FormModelOptions{
Metadata: pointy.String("PARTY"),
},
),
formation.MoldModelOptions{
Metadata: pointy.String("PARTY"),
},
),
formation.NewMoldModel(
"equipment",
20,
30,
formation.NewFormModel(
"equipment",
[]formation.SlotModel{
formation.NewSlotModel(
"head",
"grn:.*",
formation.SlotModelOptions{
Metadata: pointy.String("HEAD"),
},
),
formation.NewSlotModel(
"body",
"grn:.*",
formation.SlotModelOptions{
Metadata: pointy.String("BODY"),
},
),
formation.NewSlotModel(
"leg",
"grn:.*",
formation.SlotModelOptions{
Metadata: pointy.String("LEG"),
},
),
},
formation.FormModelOptions{
Metadata: pointy.String("EQUIPMENT"),
},
),
formation.MoldModelOptions{
Metadata: pointy.String("EQUIPMENT"),
},
),
},
[]formation.PropertyFormModel{
},
)
println(SampleStack.Yaml()) // Generate Templateclass SampleStack extends \Gs2Cdk\Core\Model\Stack
{
function __construct() {
parent::__construct();
(new \Gs2Cdk\Formation\Model\Namespace_(
stack: $this,
name: "namespace-0001"
))->masterData(
[
new \Gs2Cdk\Formation\Model\MoldModel(
name:"party",
initialMaxCapacity:10,
maxCapacity:20,
formModel:new \Gs2Cdk\Formation\Model\FormModel(
name: "party",
slots: [
new \Gs2Cdk\Formation\Model\SlotModel(
name: "tank",
propertyRegex: "grn:.*",
options: new \Gs2Cdk\Formation\Model\Options\SlotModelOptions(
metadata: "TANK",
)
),
new \Gs2Cdk\Formation\Model\SlotModel(
name: "healer",
propertyRegex: "grn:.*",
options: new \Gs2Cdk\Formation\Model\Options\SlotModelOptions(
metadata: "HEALER",
)
),
new \Gs2Cdk\Formation\Model\SlotModel(
name: "dps_1",
propertyRegex: "grn:.*",
options: new \Gs2Cdk\Formation\Model\Options\SlotModelOptions(
metadata: "DPS",
)
),
new \Gs2Cdk\Formation\Model\SlotModel(
name: "dps_2",
propertyRegex: "grn:.*",
options: new \Gs2Cdk\Formation\Model\Options\SlotModelOptions(
metadata: "DPS",
)
),
],
options: new \Gs2Cdk\Formation\Model\Options\FormModelOptions(
metadata: "PARTY",
)
),
options: new \Gs2Cdk\Formation\Model\Options\MoldModelOptions(
metadata:"PARTY"
)
),
new \Gs2Cdk\Formation\Model\MoldModel(
name:"equipment",
initialMaxCapacity:20,
maxCapacity:30,
formModel:new \Gs2Cdk\Formation\Model\FormModel(
name: "equipment",
slots: [
new \Gs2Cdk\Formation\Model\SlotModel(
name: "head",
propertyRegex: "grn:.*",
options: new \Gs2Cdk\Formation\Model\Options\SlotModelOptions(
metadata: "HEAD",
)
),
new \Gs2Cdk\Formation\Model\SlotModel(
name: "body",
propertyRegex: "grn:.*",
options: new \Gs2Cdk\Formation\Model\Options\SlotModelOptions(
metadata: "BODY",
)
),
new \Gs2Cdk\Formation\Model\SlotModel(
name: "leg",
propertyRegex: "grn:.*",
options: new \Gs2Cdk\Formation\Model\Options\SlotModelOptions(
metadata: "LEG",
)
),
],
options: new \Gs2Cdk\Formation\Model\Options\FormModelOptions(
metadata: "EQUIPMENT",
)
),
options: new \Gs2Cdk\Formation\Model\Options\MoldModelOptions(
metadata:"EQUIPMENT"
)
)
],
[
]
);
}
}
print((new SampleStack())->yaml()); // Generate Templateclass SampleStack extends io.gs2.cdk.core.model.Stack
{
public SampleStack() {
super();
new io.gs2.cdk.formation.model.Namespace(
this,
"namespace-0001"
).masterData(
Arrays.asList(
new io.gs2.cdk.formation.model.MoldModel(
"party",
10,
20,
new io.gs2.cdk.formation.model.FormModel(
"party",
Arrays.asList(
new io.gs2.cdk.formation.model.SlotModel(
"tank",
"grn:.*",
new io.gs2.cdk.formation.model.options.SlotModelOptions()
.withMetadata("TANK")
),
new io.gs2.cdk.formation.model.SlotModel(
"healer",
"grn:.*",
new io.gs2.cdk.formation.model.options.SlotModelOptions()
.withMetadata("HEALER")
),
new io.gs2.cdk.formation.model.SlotModel(
"dps_1",
"grn:.*",
new io.gs2.cdk.formation.model.options.SlotModelOptions()
.withMetadata("DPS")
),
new io.gs2.cdk.formation.model.SlotModel(
"dps_2",
"grn:.*",
new io.gs2.cdk.formation.model.options.SlotModelOptions()
.withMetadata("DPS")
)
),
new io.gs2.cdk.formation.model.options.FormModelOptions()
.withMetadata("PARTY")
),
new io.gs2.cdk.formation.model.options.MoldModelOptions()
.withMetadata("PARTY")
),
new io.gs2.cdk.formation.model.MoldModel(
"equipment",
20,
30,
new io.gs2.cdk.formation.model.FormModel(
"equipment",
Arrays.asList(
new io.gs2.cdk.formation.model.SlotModel(
"head",
"grn:.*",
new io.gs2.cdk.formation.model.options.SlotModelOptions()
.withMetadata("HEAD")
),
new io.gs2.cdk.formation.model.SlotModel(
"body",
"grn:.*",
new io.gs2.cdk.formation.model.options.SlotModelOptions()
.withMetadata("BODY")
),
new io.gs2.cdk.formation.model.SlotModel(
"leg",
"grn:.*",
new io.gs2.cdk.formation.model.options.SlotModelOptions()
.withMetadata("LEG")
)
),
new io.gs2.cdk.formation.model.options.FormModelOptions()
.withMetadata("EQUIPMENT")
),
new io.gs2.cdk.formation.model.options.MoldModelOptions()
.withMetadata("EQUIPMENT")
)
),
Arrays.asList(
)
);
}
}
System.out.println(new SampleStack().yaml()); // Generate Templatepublic class SampleStack : Gs2Cdk.Core.Model.Stack
{
public SampleStack() {
new Gs2Cdk.Gs2Formation.Model.Namespace(
stack: this,
name: "namespace-0001"
).MasterData(
new Gs2Cdk.Gs2Formation.Model.MoldModel[] {
new Gs2Cdk.Gs2Formation.Model.MoldModel(
name: "party",
initialMaxCapacity: 10,
maxCapacity: 20,
formModel: new Gs2Cdk.Gs2Formation.Model.FormModel(
name: "party",
slots: new Gs2Cdk.Gs2Formation.Model.SlotModel[]
{
new Gs2Cdk.Gs2Formation.Model.SlotModel(
name: "tank",
propertyRegex: "grn:.*",
options: new Gs2Cdk.Gs2Formation.Model.Options.SlotModelOptions
{
metadata = "TANK"
}
),
new Gs2Cdk.Gs2Formation.Model.SlotModel(
name: "healer",
propertyRegex: "grn:.*",
options: new Gs2Cdk.Gs2Formation.Model.Options.SlotModelOptions
{
metadata = "HEALER"
}
),
new Gs2Cdk.Gs2Formation.Model.SlotModel(
name: "dps_1",
propertyRegex: "grn:.*",
options: new Gs2Cdk.Gs2Formation.Model.Options.SlotModelOptions
{
metadata = "DPS"
}
),
new Gs2Cdk.Gs2Formation.Model.SlotModel(
name: "dps_2",
propertyRegex: "grn:.*",
options: new Gs2Cdk.Gs2Formation.Model.Options.SlotModelOptions
{
metadata = "DPS"
}
)
},
options: new Gs2Cdk.Gs2Formation.Model.Options.FormModelOptions
{
metadata = "PARTY"
}
),
options: new Gs2Cdk.Gs2Formation.Model.Options.MoldModelOptions
{
metadata = "PARTY"
}
),
new Gs2Cdk.Gs2Formation.Model.MoldModel(
name: "equipment",
initialMaxCapacity: 20,
maxCapacity: 30,
formModel: new Gs2Cdk.Gs2Formation.Model.FormModel(
name: "equipment",
slots: new Gs2Cdk.Gs2Formation.Model.SlotModel[]
{
new Gs2Cdk.Gs2Formation.Model.SlotModel(
name: "head",
propertyRegex: "grn:.*",
options: new Gs2Cdk.Gs2Formation.Model.Options.SlotModelOptions
{
metadata = "HEAD"
}
),
new Gs2Cdk.Gs2Formation.Model.SlotModel(
name: "body",
propertyRegex: "grn:.*",
options: new Gs2Cdk.Gs2Formation.Model.Options.SlotModelOptions
{
metadata = "BODY"
}
),
new Gs2Cdk.Gs2Formation.Model.SlotModel(
name: "leg",
propertyRegex: "grn:.*",
options: new Gs2Cdk.Gs2Formation.Model.Options.SlotModelOptions
{
metadata = "LEG"
}
)
},
options: new Gs2Cdk.Gs2Formation.Model.Options.FormModelOptions
{
metadata = "EQUIPMENT"
}
),
options: new Gs2Cdk.Gs2Formation.Model.Options.MoldModelOptions
{
metadata = "EQUIPMENT"
}
)
},
new Gs2Cdk.Gs2Formation.Model.PropertyFormModel[] {
}
);
}
}
Debug.Log(new SampleStack().Yaml()); // Generate Templateimport core from "@/gs2cdk/core";
import formation from "@/gs2cdk/formation";
class SampleStack extends core.Stack
{
public constructor() {
super();
new formation.model.Namespace(
this,
"namespace-0001",
).masterData(
[
new formation.model.MoldModel(
"party",
10,
20,
new formation.model.FormModel(
"party",
[
new formation.model.SlotModel(
"tank",
"grn:.*",
{
metadata: "TANK"
}
),
new formation.model.SlotModel(
"healer",
"grn:.*",
{
metadata: "HEALER"
}
),
new formation.model.SlotModel(
"dps_1",
"grn:.*",
{
metadata: "DPS"
}
),
new formation.model.SlotModel(
"dps_2",
"grn:.*",
{
metadata: "DPS"
}
),
],
{
metadata: "PARTY"
}
),
{
metadata: "PARTY"
}
),
new formation.model.MoldModel(
"equipment",
20,
30,
new formation.model.FormModel(
"equipment",
[
new formation.model.SlotModel(
"head",
"grn:.*",
{
metadata: "HEAD"
}
),
new formation.model.SlotModel(
"body",
"grn:.*",
{
metadata: "BODY"
}
),
new formation.model.SlotModel(
"leg",
"grn:.*",
{
metadata: "LEG"
}
),
],
{
metadata: "EQUIPMENT"
}
),
{
metadata: "EQUIPMENT"
}
)
],
[
]
);
}
}
console.log(new SampleStack().yaml()); // Generate Templatefrom gs2_cdk import Stack, core, formation
class SampleStack(Stack):
def __init__(self):
super().__init__()
formation.Namespace(
stack=self,
name="namespace-0001",
).master_data(
mold_models=[
formation.MoldModel(
name='party',
initial_max_capacity=10,
max_capacity=20,
form_model=formation.FormModel(
name='party',
slots=[
formation.SlotModel(
name='tank',
property_regex='grn:.*',
options=formation.SlotModelOptions(
metadata='TANK',
),
),
formation.SlotModel(
name='healer',
property_regex='grn:.*',
options=formation.SlotModelOptions(
metadata='HEALER',
),
),
formation.SlotModel(
name='dps_1',
property_regex='grn:.*',
options=formation.SlotModelOptions(
metadata='DPS',
),
),
formation.SlotModel(
name='dps_2',
property_regex='grn:.*',
options=formation.SlotModelOptions(
metadata='DPS',
),
),
],
options=formation.FormModelOptions(
metadata='PARTY',
),
),
options=formation.MoldModelOptions(
metadata = 'PARTY'
),
),
formation.MoldModel(
name='equipment',
initial_max_capacity=20,
max_capacity=30,
form_model=formation.FormModel(
name='equipment',
slots=[
formation.SlotModel(
name='head',
property_regex='grn:.*',
options=formation.SlotModelOptions(
metadata='HEAD',
),
),
formation.SlotModel(
name='body',
property_regex='grn:.*',
options=formation.SlotModelOptions(
metadata='BODY',
),
),
formation.SlotModel(
name='leg',
property_regex='grn:.*',
options=formation.SlotModelOptions(
metadata='LEG',
),
),
],
options=formation.FormModelOptions(
metadata='EQUIPMENT',
),
),
options=formation.MoldModelOptions(
metadata = 'EQUIPMENT'
),
),
],
property_form_models=[
],
)
print(SampleStack().yaml()) # Generate TemplateFormModel
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.
| Type | Condition | Required | Default | Value Limits | Description | |
|---|---|---|---|---|---|---|
| formModelId | string | * | ~ 1024 chars | Form Model GRN * Set automatically by the server | ||
| name | string | ✓ | ~ 128 chars | Form Model name Form 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. | |||
| slots | List<SlotModel> | ✓ | 1 ~ 10 items | List 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.
| Type | Condition | Required | Default | Value Limits | Description | |
|---|---|---|---|---|---|---|
| name | string | ✓ | ~ 128 chars | Slot 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. | ||
| propertyRegex | string | “.*” | ~ 512 chars | Regular 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. | ||
| metadata | string | ~ 512 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. |
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.
| Type | Condition | Required | Default | Value Limits | Description | |
|---|---|---|---|---|---|---|
| moldModelId | string | * | ~ 1024 chars | Form Storage Area GRN * Set automatically by the server | ||
| name | string | ✓ | ~ 128 chars | Form Storage Area Model name Form Storage Area 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. | |||
| initialMaxCapacity | int | ✓ | 1 ~ 2147483646 | Initial 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. | ||
| maxCapacity | int | ✓ | 1 ~ 2147483646 | Maximum 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. | ||
| formModel | FormModel | ✓ | 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.
| Type | Condition | Required | Default | Value Limits | Description | |
|---|---|---|---|---|---|---|
| propertyFormModelId | string | * | ~ 1024 chars | Property Form Model GRN * Set automatically by the server | ||
| name | string | ✓ | ~ 128 chars | Property Form Model name Property Form 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. | |||
| slots | List<SlotModel> | ✓ | 1 ~ 10 items | List 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. |