GS2-Deploy/CDK Reference of GS2-MegaField

The template format used when creating stacks with GS2-Deploy, and implementation examples of template output in various languages using CDK

Entity

Resources operated in Deloy process

Namespace

A namespace is a mechanism that allows multiple uses of the same service for different purposes within a single project. 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.

	Type	Required	Value Limits	Description
name	string	✓	~ 128 chars	Namespace name
description	string		~ 1024 chars	Description
logSetting	LogSetting			Log output settings

GetAttr

Generation results of resources that can be obtained with the !GetAttr tag

	Type	Description
Item	Namespace	Namespace created

Implementation Example

Type: GS2::MegaField::Namespace
Properties:
  Name: namespace-0001
  Description: null
  LogSetting: 
    LoggingNamespaceId: grn:gs2:ap-northeast-1:YourOwnerId:log:namespace-0001

import (
    "github.com/gs2io/gs2-golang-cdk/core"
    "github.com/gs2io/gs2-golang-cdk/megaField"
    "github.com/openlyinc/pointy"
)

SampleStack := core.NewStack()
megaField.NewNamespace(
    &SampleStack,
    "namespace-0001",
    megaField.NamespaceOptions{
        LogSetting: &core.LogSetting{
            LoggingNamespaceId: "grn:gs2:ap-northeast-1:YourOwnerId:log:namespace-0001",
        },
    },
)

println(SampleStack.Yaml())  // Generate Template

class SampleStack extends \Gs2Cdk\Core\Model\Stack
{
    function __construct() {
        parent::__construct();
        new \Gs2Cdk\MegaField\Model\Namespace_(
            stack: $this,
            name: "namespace-0001",
            options: new \Gs2Cdk\MegaField\Model\Options\NamespaceOptions(
                logSetting: new \Gs2Cdk\Core\Model\LogSetting(
                    loggingNamespaceId: "grn:gs2:ap-northeast-1:YourOwnerId:log:namespace-0001"
                )
            )
        );
    }
}

print((new SampleStack())->yaml());  // Generate Template

class SampleStack extends io.gs2.cdk.core.model.Stack
{
    public SampleStack() {
        super();
        new io.gs2.cdk.megaField.model.Namespace(
                this,
                "namespace-0001",
                new io.gs2.cdk.megaField.model.options.NamespaceOptions()
                        .withLogSetting(new io.gs2.cdk.core.model.LogSetting(
                            "grn:gs2:ap-northeast-1:YourOwnerId:log:namespace-0001"
                        ))
        );
    }
}

System.out.println(new SampleStack().yaml());  // Generate Template

public class SampleStack : Gs2Cdk.Core.Model.Stack
{
    public SampleStack() {
        new Gs2Cdk.Gs2MegaField.Model.Namespace(
            stack: this,
            name: "namespace-0001",
            options: new Gs2Cdk.Gs2MegaField.Model.Options.NamespaceOptions
            {
                logSetting = new Gs2Cdk.Core.Model.LogSetting(
                    loggingNamespaceId: "grn:gs2:ap-northeast-1:YourOwnerId:log:namespace-0001"
                )
            }
        );
    }
}

Debug.Log(new SampleStack().Yaml());  // Generate Template

import core from "@/gs2cdk/core";
import megaField from "@/gs2cdk/megaField";

class SampleStack extends core.Stack
{
    public constructor() {
        super();
        new megaField.model.Namespace(
            this,
            "namespace-0001",
            {
                logSetting: new core.LogSetting(
                    "grn:gs2:ap-northeast-1:YourOwnerId:log:namespace-0001"
                )
            }
        );
    }
}

console.log(new SampleStack().yaml());  // Generate Template

from gs2_cdk import Stack, core, mega_field

class SampleStack(Stack):

    def __init__(self):
        super().__init__()
        mega_field.Namespace(
            stack=self,
            name='namespace-0001',
            options=mega_field.NamespaceOptions(
                log_setting=core.LogSetting(
                    logging_namespace_id='grn:gs2:ap-northeast-1:YourOwnerId:log:namespace-0001',
                ),
            ),
        )

print(SampleStack().yaml())  # Generate Template

LogSetting

Log setting

This type manages log output settings. This type holds the identifier of the log namespace used to output log data. The log namespace ID specifies the GS2-Log namespace to aggregate and store the log data. Through this setting, API request and response log data under this namespace will be output to the target GS2-Log. GS2-Log provides logs in real time, which can be used for system monitoring, analysis, debugging, etc.

	Type	Condition	Required	Default	Value Limits	Description
loggingNamespaceId	string		✓		~ 1024 chars	GS2-Log namespace GRN to output logs

CurrentFieldMaster

Currently Available Master Data

GS2 uses JSON format files for managing master data. By uploading these files, the settings are applied to the server.

To create JSON files, GS2 provides a master data editor within the management console. Additionally, you can create tools better suited for operating your game and export JSON files in the appropriate format.

Note

Please refer to Master Data Reference of GS2-MegaField for the JSON file format.

Type

Condition

Required

Default

Value Limits

Description

namespaceName

string

✓

~ 128 chars

Namespace name

mode

String Enum
enum {
“direct”,
“preUpload”
}

✓

“direct”

~ 128 chars

Update mode

Enumerator String Definition	Description
“direct”	Directly update the settings
“preUpload”	Upload the settings and then update

settings

string

{mode} == “direct”

✓*

~ 5242880 bytes (5MB)

Master Data

* Required if mode is “direct”

uploadToken

string

{mode} == “preUpload”

✓*

~ 1024 chars

Token used to reflect results after upload

* Required if mode is “preUpload”

GetAttr

Generation results of resources that can be obtained with the !GetAttr tag

	Type	Description
Item	CurrentFieldMaster	Updated and currently available possession master

Implementation Example

Type: GS2::MegaField::CurrentFieldMaster
Properties:
  NamespaceName: namespace-0001
  Mode: direct
  Settings: {
    "version": "2022-08-28",
    "areaModels": [
      {
        "name": "area-0001",
        "metadata": "AREA_0001",
        "layerModels": [
          {
            "name": "layer-0001",
            "metadata": "LAYER_0001"
          }
        ]
      }
    ]
  }
  UploadToken: null

import (
    "github.com/gs2io/gs2-golang-cdk/core"
    "github.com/gs2io/gs2-golang-cdk/megaField"
    "github.com/openlyinc/pointy"
)

SampleStack := core.NewStack()
megaField.NewNamespace(
    &SampleStack,
    "namespace-0001",
    megaField.NamespaceOptions{},
).MasterData(
    []megaField.AreaModel{
        megaField.NewAreaModel(
            "area-0001",
            megaField.AreaModelOptions{
                Metadata: pointy.String("AREA_0001"),
                LayerModels: []megaField.LayerModel{
                    megaField.NewLayerModel(
                        "layer-0001",
                        megaField.LayerModelOptions{
                            Metadata: pointy.String("LAYER_0001"),
                        },
                    ),
                },
            },
        ),
    },
)

println(SampleStack.Yaml())  // Generate Template

class SampleStack extends \Gs2Cdk\Core\Model\Stack
{
    function __construct() {
        parent::__construct();
        (new \Gs2Cdk\MegaField\Model\Namespace_(
            stack: $this,
            name: "namespace-0001"
        ))->masterData(
            [
                new \Gs2Cdk\MegaField\Model\AreaModel(
                    name:"area-0001",
                    options: new \Gs2Cdk\MegaField\Model\Options\AreaModelOptions(
                        metadata:"AREA_0001",
                        layerModels:[
                            new \Gs2Cdk\MegaField\Model\LayerModel(
                                name: "layer-0001",
                                options: new \Gs2Cdk\MegaField\Model\Options\LayerModelOptions(
                                    metadata: "LAYER_0001",
                                )
                            ),
                        ]
                    )
                )
            ]
        );
    }
}

print((new SampleStack())->yaml());  // Generate Template

class SampleStack extends io.gs2.cdk.core.model.Stack
{
    public SampleStack() {
        super();
        new io.gs2.cdk.megaField.model.Namespace(
            this,
            "namespace-0001"
        ).masterData(
            Arrays.asList(
                new io.gs2.cdk.megaField.model.AreaModel(
                    "area-0001",
                    new io.gs2.cdk.megaField.model.options.AreaModelOptions()
                        .withMetadata("AREA_0001")
                        .withLayerModels(Arrays.asList(
                            new io.gs2.cdk.megaField.model.LayerModel(
                                "layer-0001",
                                new io.gs2.cdk.megaField.model.options.LayerModelOptions()
                                    .withMetadata("LAYER_0001")
                            )
                        ))
                )
            )
        );
    }
}

System.out.println(new SampleStack().yaml());  // Generate Template

public class SampleStack : Gs2Cdk.Core.Model.Stack
{
    public SampleStack() {
        new Gs2Cdk.Gs2MegaField.Model.Namespace(
            stack: this,
            name: "namespace-0001"
        ).MasterData(
            new Gs2Cdk.Gs2MegaField.Model.AreaModel[] {
                new Gs2Cdk.Gs2MegaField.Model.AreaModel(
                    name: "area-0001",
                    options: new Gs2Cdk.Gs2MegaField.Model.Options.AreaModelOptions
                    {
                        metadata = "AREA_0001",
                        layerModels = new Gs2Cdk.Gs2MegaField.Model.LayerModel[]
                        {
                            new Gs2Cdk.Gs2MegaField.Model.LayerModel(
                                name: "layer-0001",
                                options: new Gs2Cdk.Gs2MegaField.Model.Options.LayerModelOptions
                                {
                                    metadata = "LAYER_0001"
                                }
                            )
                        }
                    }
                )
            }
        );
    }
}

Debug.Log(new SampleStack().Yaml());  // Generate Template

import core from "@/gs2cdk/core";
import megaField from "@/gs2cdk/megaField";

class SampleStack extends core.Stack
{
    public constructor() {
        super();
        new megaField.model.Namespace(
            this,
            "namespace-0001",
        ).masterData(
            [
                new megaField.model.AreaModel(
                    "area-0001",
                    {
                        metadata: "AREA_0001",
                        layerModels: [
                            new megaField.model.LayerModel(
                                "layer-0001",
                                {
                                    metadata: "LAYER_0001"
                                }
                            ),
                        ]
                    }
                )
            ]
        );
    }
}

console.log(new SampleStack().yaml());  // Generate Template

from gs2_cdk import Stack, core, mega_field

class SampleStack(Stack):

    def __init__(self):
        super().__init__()
        mega_field.Namespace(
            stack=self,
            name="namespace-0001",
        ).master_data(
            area_models=[
                mega_field.AreaModel(
                    name='area-0001',
                    options=mega_field.AreaModelOptions(
                        metadata = 'AREA_0001',
                        layer_models = [
                            mega_field.LayerModel(
                                name='layer-0001',
                                options=mega_field.LayerModelOptions(
                                    metadata='LAYER_0001',
                                ),
                            ),
                        ]
                    ),
                ),
            ],
        )

print(SampleStack().yaml())  # Generate Template

AreaModel

Area divides space, and different areas can be treated as different spaces even if they have the same coordinates.

	Type	Required	Default	Value Limits	Description
areaModelId	string	✓		~ 1024 chars	Area Model GRN
name	string	✓		~ 128 chars	Area Model Name
metadata	string			~ 2048 chars	Metadata
layerModels	List<LayerModel>		[]	0 ~ 1000 items	List of layer models

LayerModel

Layers allow for multiple logical hierarchies within a single space. For example, it solves the problem of an Enemy being invisible in a space with a large number of characters. Characters are placed on Layer 1. If Enemies are placed on Layer 2, there is no need to worry about them becoming invisible, since each layer can specify the quantity to be acquired within a specified distance.

	Type	Required	Value Limits	Description
layerModelId	string	✓	~ 1024 chars	Layer Model GRN
name	string	✓	~ 128 chars	Layer Model Name
metadata	string		~ 2048 chars	Metadata

LayerModel

	Type	Required	Value Limits	Description
layerModelId	string	✓	~ 1024 chars	Layer Model GRN
name	string	✓	~ 128 chars	Layer Model Name
metadata	string		~ 2048 chars	Metadata