GS2-Deploy/CDK Reference of GS2-SeasonRating

Entities

Namespace

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.

TypeRequireDefaultLimitationDescription
namestring~ 32 charsNamespace name
descriptionstring~ 1024 charsDescription
transactionSettingTransactionSettingTransaction settings
logSettingLogSettingLog output settings

GetAttr

TypeDescription
ItemNamespaceNamespace created

Implementation Example

Type: GS2::SeasonRating::Namespace
Properties:
  Name: namespace1
  Description: null
  TransactionSetting: null
  LogSetting: 
    LoggingNamespaceId: grn:gs2:ap-northeast-1:YourOwnerId:log:namespace-0001
from gs2_cdk import Stack, core, season_rating

class SampleStack(Stack):

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

print(SampleStack().yaml())  # Generate Template
class SampleStack extends \Gs2Cdk\Core\Model\Stack
{
    function __construct() {
        parent::__construct();
        new \Gs2Cdk\SeasonRating\Model\Namespace_(
            stack: $this,
            name: "namespace-0001",
            options: new \Gs2Cdk\SeasonRating\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.seasonRating.model.Namespace(
            this,
            "namespace-0001",
            new io.gs2.cdk.seasonRating.model.options.NamespaceOptions() {
                {
                    logSetting = new io.gs2.cdk.core.model.LogSetting(
                        "grn:gs2:ap-northeast-1:YourOwnerId:log:namespace-0001"
                    );
                }
            }
        );
    }
}

System.out.println(new SampleStack().yaml());  // Generate Template
import core from "@/gs2cdk/core";
import seasonRating from "@/gs2cdk/seasonRating";

class SampleStack extends core.Stack
{
    public constructor() {
        super();
        new seasonRating.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
public class SampleStack : Gs2Cdk.Core.Model.Stack
{
    public SampleStack() {
        new Gs2Cdk.Gs2SeasonRating.Model.Namespace(
            this,
            "namespace-0001",
            new Gs2Cdk.Gs2SeasonRating.Model.Options.NamespaceOptions {
                logSetting = new Gs2Cdk.Core.Model.LogSetting(
                    "grn:gs2:ap-northeast-1:YourOwnerId:log:namespace-0001"
                ),
            }
        );
    }
}

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

MatchSession

Session

TypeRequireDefaultLimitationDescription
namespaceNamestring~ 32 charsNamespace name
sessionNamestringUUID~ 128 charsSession Name
ttlSecondsint6060 ~ 7200MatchSession expiration time (seconds)

GetAttr

TypeDescription
ItemMatchSessionCreated MatchSession

Implementation Example

Type: GS2::SeasonRating::MatchSession
Properties:
  NamespaceName: namespace1
  SessionName: $matchSession1.name
  TtlSeconds: null
from gs2_cdk import Stack, core, season_rating

class SampleStack(Stack):

    def __init__(self):
        super().__init__()
        season_rating.MatchSession(
            stack=self,
            namespace_name="namespace-0001",
            options=season_rating.MatchSessionOptions(
                session_name=self.match_session1.name,
            ),
        )

print(SampleStack().yaml())  # Generate Template
class SampleStack extends \Gs2Cdk\Core\Model\Stack
{
    function __construct() {
        parent::__construct();
        new \Gs2Cdk\SeasonRating\Model\MatchSession(
            stack: $this,
            namespaceName: "namespace-0001",
            options: new \Gs2Cdk\SeasonRating\Model\Options\MatchSessionOptions(
                sessionName: self::$matchSession1.name,
            ),
        );
    }
}

print((new SampleStack())->yaml());  // Generate Template
class SampleStack extends io.gs2.cdk.core.model.Stack
{
    public SampleStack() {
        super();
        new io.gs2.cdk.seasonRating.model.MatchSession(
            this,
            "namespace-0001",
            new io.gs2.cdk.seasonRating.model.options.MatchSessionOptions() {
                {
                    sessionName = "$matchSession1.name";
                }
            }
        );
    }
}

System.out.println(new SampleStack().yaml());  // Generate Template
import core from "@/gs2cdk/core";
import seasonRating from "@/gs2cdk/seasonRating";

class SampleStack extends core.Stack
{
    public constructor() {
        super();
        new seasonRating.model.MatchSession(
            this,
            "namespace-0001",
            {
                sessionName: "$matchSession1.name"
            }
        );
    }
}

console.log(new SampleStack().yaml());  // Generate Template
public class SampleStack : Gs2Cdk.Core.Model.Stack
{
    public SampleStack() {
        new Gs2Cdk.Gs2SeasonRating.Model.MatchSession(
            this,
            "namespace-0001",
            new Gs2Cdk.Gs2SeasonRating.Model.Options.MatchSessionOptions {
                sessionName = "$matchSession1.name",
            }
        );
    }
}

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

CurrentSeasonModelMaster

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 create JSON files using the The service can also be used by creating a tool more appropriate for game management and exporting a JSON file in the appropriate format.

Please refer to the documentation for the format of the JSON file.

TypeRequireDefaultLimitationDescription
namespaceNamestring~ 32 charsNamespace name
settingsstring~ 5242880 charsMaster data

GetAttr

TypeDescription
ItemCurrentSeasonModelMasterUpdated and currently available rating master

Implementation Example

Type: GS2::SeasonRating::CurrentSeasonModelMaster
Properties:
  NamespaceName: namespace1
  Settings: {"version": "2024-02-23", "seasonModels": [{"name": "season1", "tiers": [{"raiseRankBonus": 0, "entryFee": 0, "minimumChangePoint": -10, "maximumChangePoint": 20}, {"raiseRankBonus": 30, "entryFee": 10, "minimumChangePoint": -10, "maximumChangePoint": 30}, {"raiseRankBonus": 60, "entryFee": 20, "minimumChangePoint": -20, "maximumChangePoint": 50}, {"raiseRankBonus": 60, "entryFee": 30, "minimumChangePoint": -30, "maximumChangePoint": 60}], "experienceModelId": "grn:experience:level"}]}
from gs2_cdk import Stack, core, season_rating

class SampleStack(Stack):

    def __init__(self):
        super().__init__()
        season_rating.Namespace(
            stack=self,
            # omission
        ).master_data(
            [
                season_rating.SeasonModel(
                    name='season1',
                    tiers=[    {'raiseRankBonus': 0, 'entryFee': 0, 'minimumChangePoint': -10, 'maximumChangePoint': 20},
                        {'raiseRankBonus': 30, 'entryFee': 10, 'minimumChangePoint': -10, 'maximumChangePoint': 30},
                        {'raiseRankBonus': 60, 'entryFee': 20, 'minimumChangePoint': -20, 'maximumChangePoint': 50},
                        {'raiseRankBonus': 60, 'entryFee': 30, 'minimumChangePoint': -30, 'maximumChangePoint': 60},
                        ],
                    experience_model_id='grn:experience:level',
                ),
            ],
        )

print(SampleStack().yaml())  # Generate Template
class SampleStack extends \Gs2Cdk\Core\Model\Stack
{
    function __construct() {
        parent::__construct();
        (new \Gs2Cdk\SeasonRating\Model\Namespace_(
            stack: $this,
            // omission
        ))->masterData(
            [
                new \Gs2Cdk\SeasonRating\Model\SeasonModel(
                    name:"season1",
                    tiers:[    {'raiseRankBonus': 0, 'entryFee': 0, 'minimumChangePoint': -10, 'maximumChangePoint': 20},
                    {'raiseRankBonus': 30, 'entryFee': 10, 'minimumChangePoint': -10, 'maximumChangePoint': 30},
                    {'raiseRankBonus': 60, 'entryFee': 20, 'minimumChangePoint': -20, 'maximumChangePoint': 50},
                    {'raiseRankBonus': 60, 'entryFee': 30, 'minimumChangePoint': -30, 'maximumChangePoint': 60},
                    ],
                    experienceModelId:"grn:experience:level",
                ),
            ],
        );
    }
}

print((new SampleStack())->yaml());  // Generate Template
class SampleStack extends io.gs2.cdk.core.model.Stack
{
    public SampleStack() {
        super();
        new io.gs2.cdk.seasonRating.model.Namespace(
            this,
            // omission
        ).masterData(
            Arrays.asList(
                new io.gs2.cdk.seasonRating.model.SeasonModel(
                    "season1",
                    Arrays.asList(
                        {'raiseRankBonus': 0, 'entryFee': 0, 'minimumChangePoint': -10, 'maximumChangePoint': 20},
                    {'raiseRankBonus': 30, 'entryFee': 10, 'minimumChangePoint': -10, 'maximumChangePoint': 30},
                    {'raiseRankBonus': 60, 'entryFee': 20, 'minimumChangePoint': -20, 'maximumChangePoint': 50},
                    {'raiseRankBonus': 60, 'entryFee': 30, 'minimumChangePoint': -30, 'maximumChangePoint': 60}
                    ),
                    "grn:experience:level"
                )
            )
        );
    }
}

System.out.println(new SampleStack().yaml());  // Generate Template
import core from "@/gs2cdk/core";
import seasonRating from "@/gs2cdk/seasonRating";

class SampleStack extends core.Stack
{
    public constructor() {
        super();
        new seasonRating.model.Namespace(
            this,
            // omission
        ).masterData(
            [
                new seasonRating.model.SeasonModel(
                    "season1",
                    [
                        {'raiseRankBonus': 0, 'entryFee': 0, 'minimumChangePoint': -10, 'maximumChangePoint': 20},
                    {'raiseRankBonus': 30, 'entryFee': 10, 'minimumChangePoint': -10, 'maximumChangePoint': 30},
                    {'raiseRankBonus': 60, 'entryFee': 20, 'minimumChangePoint': -20, 'maximumChangePoint': 50},
                    {'raiseRankBonus': 60, 'entryFee': 30, 'minimumChangePoint': -30, 'maximumChangePoint': 60}
                    ],
                    "grn:experience:level"
                )
            ]
        );
    }
}

console.log(new SampleStack().yaml());  // Generate Template
public class SampleStack : Gs2Cdk.Core.Model.Stack
{
    public SampleStack() {
        new Gs2Cdk.Gs2SeasonRating.Model.Namespace(
            this,
            // omission
        ).MasterData(
            new [] {
                new Gs2Cdk.Gs2SeasonRating.Model.SeasonModel(
                    "season1",
                    new Gs2Cdk.Gs2SeasonRating.Model.TierModel[] {
                        {'raiseRankBonus': 0, 'entryFee': 0, 'minimumChangePoint': -10, 'maximumChangePoint': 20},
                    {'raiseRankBonus': 30, 'entryFee': 10, 'minimumChangePoint': -10, 'maximumChangePoint': 30},
                    {'raiseRankBonus': 60, 'entryFee': 20, 'minimumChangePoint': -20, 'maximumChangePoint': 50},
                    {'raiseRankBonus': 60, 'entryFee': 30, 'minimumChangePoint': -30, 'maximumChangePoint': 60}
                    },
                    "grn:experience:level"
                )
            }
        );
    }
}

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

TierModel

TypeRequireDefaultLimitationDescription
metadatastring~ 128 charsmetadata
raiseRankBonusint~ 10000The bonus points added to prevent immediate rank demotion when the rank is promoted.
entryFeeint~ 10000Points to be subtracted as an entry fee to start the game.
minimumChangePointint~ -1Change point minimum value when losing
maximumChangePointint1 ~ 99999999Change point maximum value when winning

TransactionSetting

Transaction settings

TypeRequireDefaultLimitationDescription
distributorNamespaceIdstring“grn:gs2:{region}:{ownerId}:distributor:default”~ 1024 charsGS2-Distributor namespace used for stamp sheet execution
queueNamespaceIdstring“grn:gs2:{region}:{ownerId}:queue:default”~ 1024 charsNamespace in GS2-JobQueue used to run the stamp sheet

ScriptSetting

Script settings

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 execution result to stop the execution of the API or to tamper with the result of the API.

On the other hand, asynchronous execution does not block processing until the script has finished executing. Instead, you can use the script execution result to stop the execution of the API or to tamper with the result of the API. However, asynchronous execution does not block processing until the script has finished executing, so it is generally recommended to use asynchronous execution.

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.

TypeRequireDefaultLimitationDescription
triggerScriptIdstring~ 1024 charsScript GRN
doneTriggerTargetTypeenum [
“none”,
“gs2_script”,
“aws”
]
“none”~ 128 charsNotification of Completion
doneTriggerScriptIdstring{doneTriggerTargetType} == “gs2_script”~ 1024 charsScript GRN
doneTriggerQueueNamespaceIdstring{doneTriggerTargetType} == “gs2_script”~ 1024 charsNamespace GRN

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.

TypeRequireDefaultLimitationDescription
loggingNamespaceIdstring~ 1024 charsNamespace GRN

GitHubCheckoutSetting

Setup to check out master data from GitHub

TypeRequireDefaultLimitationDescription
apiKeyIdstring~ 1024 charsGitHub API key GRN
repositoryNamestring~ 1024 charsRepository Name
sourcePathstring~ 1024 charsSource code file path
referenceTypeenum [
“commit_hash”,
“branch”,
“tag”
]
~ 128 charsSource of code
commitHashstring{referenceType} == “commit_hash”~ 1024 charsCommit hash
branchNamestring{referenceType} == “branch”~ 1024 charsBranch Name
tagNamestring{referenceType} == “tag”~ 1024 charsTag Name

GameResult

TypeRequireDefaultLimitationDescription
rankint~ 2147483646Rank
userIdstring~ 128 charsUser Id

Ballot

TypeRequireDefaultLimitationDescription
userIdstring~ 128 charsUser Id
seasonNamestring~ 128 charsRating name used for rating calculations
sessionNamestring~ 128 charsName of MatchSession to be voted
numberOfPlayerint2 ~ 10Number of participants

SignedBallot

TypeRequireDefaultLimitationDescription
bodystring~ 1024 charsData for ballot signature targets
signaturestring~ 256 charsSignature

WrittenBallot

TypeRequireDefaultLimitationDescription
ballotBallotBallot
gameResultsList<GameResult>~ 10 itemsList of Results