GS2-Deploy/CDK Reference of GS2-MegaField

Template format used to create GS2-Deploy stacks and examples of template output implementation in various languages using CDK

Entities

Namespace

Namespace is a mechanism that allows multiple uses of the same service for different purposes within a single project. Basically, GS2 services have a layer called namespace, and different namespaces are treated as completely different data spaces, even for the same service.

Therefore, it is necessary to create a namespace before starting to use each service.

	Type	Require	Limitation	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

CurrentFieldMaster

Currently available master data

GS2 uses JSON format files for master data management. By uploading the file, you can actually reflect the settings on the server.

We provide a master data editor on the management console as a way to create JSON files, but you can also use the service by creating a tool that is more suitable for game operation and writing out a JSON file in the appropriate format.

Note

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

Type

Condition

Require

Default

Limitation

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 chars

Master Data
If mode is “direct”, then required

uploadToken

string

{mode} == “preUpload”

✓

~ 1024 chars

Token used to reflect results after upload
If mode is “preUpload”, then required

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: null
  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

Position

	Type	Require	Limitation	Description
x	float	✓	-1048574 ~ 1048574	X position
y	float	✓	-1048574 ~ 1048574	Y position
z	float	✓	-1048574 ~ 1048574	Z position

MyPosition

My Location

	Type	Require	Default	Limitation	Description
position	Position	✓			Position
vector	Vector	✓			Vector
r	float	✓	1	0 ~ 10000	Radius

Scope

Surroundings to be acquired

	Type	Require	Limitation	Description
layerName	string	✓	~ 128 chars	Layer Model Name
r	float	✓	1 ~ 16777214	Radius
limit	int	✓	1 ~ 100	Maximum number of result

Vector

Position

	Type	Require	Limitation	Description
x	float	✓	-1048574 ~ 1048574	X position
y	float	✓	-1048574 ~ 1048574	Y position
z	float	✓	-1048574 ~ 1048574	Z position

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	Require	Default	Limitation	Description
loggingNamespaceId	string		✓		~ 1024 chars	GS2-Log namespace GRN to output logs

GitHubCheckoutSetting

Setup to check out master data from GitHub

Type

Condition

Require

Default

Limitation

Description

apiKeyId

string

✓

~ 1024 chars

GitHub API key GRN

repositoryName

string

✓

~ 1024 chars

Repository Name

sourcePath

string

✓

~ 1024 chars

Source code file path

referenceType

String Enum
enum {
  “commit_hash”,
  “branch”,
  “tag”
}

✓

~ 128 chars

Source of code

Enumerator String Definition	Description
“commit_hash”	Commit hash
“branch”	Branch
“tag”	Tag

commitHash

string

{referenceType} == “commit_hash”

✓

~ 1024 chars

Commit hash
If referenceType is “commit_hash”, then required

branchName

string

{referenceType} == “branch”

✓

~ 1024 chars

Branch Name
If referenceType is “branch”, then required

tagName

string

{referenceType} == “tag”

✓

~ 1024 chars

Tag Name
If referenceType is “tag”, then required