GS2-Deploy/CDK Reference of GS2-Matchmaking

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	Default	Limitation	Description
name	string	✓		~ 32 chars	Namespace name
description	string			~ 1024 chars	description of Namespace
enableRating	bool	✓	false		Use the rating calculation function
createGatheringTriggerType	string	✓		~ 128 chars	Action when creating a new gathering
createGatheringTriggerRealtimeNamespaceId	string	{createGatheringTriggerType} == “gs2_realtime”		~ 1024 chars	GS2-Realtime namespace to create rooms when creating a gathering
createGatheringTriggerScriptId	string	{createGatheringTriggerType} == “gs2_script”		~ 1024 chars	GS2-Script script to be executed when creating a gathering
completeMatchmakingTriggerType	string	✓		~ 128 chars	Action upon completion of matchmaking
completeMatchmakingTriggerRealtimeNamespaceId	string	{completeMatchmakingTriggerType} == “gs2_realtime”		~ 1024 chars	GS2-Realtime namespace to create rooms when matchmaking is complete
completeMatchmakingTriggerScriptId	string	{completeMatchmakingTriggerType} == “gs2_script”		~ 1024 chars	GS2-Script script to be executed when matchmaking is complete
changeRatingScript	ScriptSetting				Script to be executed when the rating value changes
joinNotification	NotificationSetting				Push notifications when new players join the Gathering
leaveNotification	NotificationSetting				Push notification when a player leaves the Gathering
completeNotification	NotificationSetting				Push notification when matchmaking is completed
changeRatingNotification	NotificationSetting				Push notifications when rating values change
logSetting	LogSetting				Log output settings

GetAttr

	Type	Description
Item	Namespace	Namespace created

Implementation Example

Type: GS2::Matchmaking::Namespace
Properties:
  Name: namespace1
  Description: null
  EnableRating: true
  CreateGatheringTriggerType: none
  CreateGatheringTriggerRealtimeNamespaceId: null
  CreateGatheringTriggerScriptId: null
  CompleteMatchmakingTriggerType: none
  CompleteMatchmakingTriggerRealtimeNamespaceId: null
  CompleteMatchmakingTriggerScriptId: null
  ChangeRatingScript: null
  JoinNotification: null
  LeaveNotification: null
  CompleteNotification: null
  ChangeRatingNotification: null
  LogSetting: 
    LoggingNamespaceId: grn:gs2:ap-northeast-1:YourOwnerId:log:namespace-0001

from gs2_cdk import Stack, core, matchmaking

class SampleStack(Stack):

    def __init__(self):
        super().__init__()
        matchmaking.Namespace(
            stack=self,
            name="namespace-0001",
            create_gathering_trigger_type=matchmaking.NamespaceCreateGatheringTriggerType.NONE,
            complete_matchmaking_trigger_type=matchmaking.NamespaceCompleteMatchmakingTriggerType.NONE,
            options=matchmaking.NamespaceOptions(
                enable_rating=True,
                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\Matchmaking\Model\Namespace_(
            stack: $this,
            name: "namespace-0001",
            createGatheringTriggerType: \Gs2Cdk\Matchmaking\Model\Enum\NamespaceCreateGatheringTriggerType::NONE,
            completeMatchmakingTriggerType: \Gs2Cdk\Matchmaking\Model\Enum\NamespaceCompleteMatchmakingTriggerType::NONE,
            options: new \Gs2Cdk\Matchmaking\Model\Options\NamespaceOptions(
                enableRating: True,
                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.matchmaking.model.Namespace(
            this,
            "namespace-0001",
            io.gs2.cdk.matchmaking.model.enums.NamespaceCreateGatheringTriggerType.NONE,
            io.gs2.cdk.matchmaking.model.enums.NamespaceCompleteMatchmakingTriggerType.NONE,
            new io.gs2.cdk.matchmaking.model.options.NamespaceOptions() {
                {
                    enableRating = true;
                    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 matchmaking from "@/gs2cdk/matchmaking";

class SampleStack extends core.Stack
{
    public constructor() {
        super();
        new matchmaking.model.Namespace(
            this,
            "namespace-0001",
            matchmaking.model.NamespaceCreateGatheringTriggerType.NONE,
            matchmaking.model.NamespaceCompleteMatchmakingTriggerType.NONE,
            {
                enableRating: true,
                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.Gs2Matchmaking.Model.Namespace(
            this,
            "namespace-0001",
            Gs2Cdk.Gs2Matchmaking.Model.Enums.NamespaceCreateGatheringTriggerType.None,
            Gs2Cdk.Gs2Matchmaking.Model.Enums.NamespaceCompleteMatchmakingTriggerType.None,
            new Gs2Cdk.Gs2Matchmaking.Model.Options.NamespaceOptions {
                enableRating = true,
                logSetting = new Gs2Cdk.Core.Model.LogSetting(
                    "grn:gs2:ap-northeast-1:YourOwnerId:log:namespace-0001"
                ),
            }
        );
    }
}

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

CurrentRatingModelMaster

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.

	Type	Require	Default	Limitation	Description
namespaceName	string	✓		~ 32 chars	Namespace name
settings	string	✓		~ 5242880 chars	Master data

GetAttr

	Type	Description
Item	CurrentRatingModelMaster	Updated and currently available rating master

Implementation Example

Type: GS2::Matchmaking::CurrentRatingModelMaster
Properties:
  NamespaceName: namespace1
  Settings: {
    "version": "2020-06-24",
    "ratingModels": [
      {
        "name": "mode1",
        "metadata": "MODE1",
        "volatility": 100
      },
      {
        "name": "mode2",
        "metadata": "MODE2",
        "volatility": 150
      }
    ]
  }

from gs2_cdk import Stack, core, matchmaking

class SampleStack(Stack):

    def __init__(self):
        super().__init__()
        matchmaking.Namespace(
            stack=self,
            # omission
        ).master_data(
            [
                matchmaking.RatingModel(
                    name='mode1',
                    volatility=100,
                    options=matchmaking.RatingModelOptions(
                        metadata='MODE1',
                    ),
                ),
                matchmaking.RatingModel(
                    name='mode2',
                    volatility=150,
                    options=matchmaking.RatingModelOptions(
                        metadata='MODE2',
                    ),
                ),
            ],
        )

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

class SampleStack extends \Gs2Cdk\Core\Model\Stack
{
    function __construct() {
        parent::__construct();
        (new \Gs2Cdk\Matchmaking\Model\Namespace_(
            stack: $this,
            // omission
        ))->masterData(
            [
                new \Gs2Cdk\Matchmaking\Model\RatingModel(
                    name:"mode1",
                    volatility:100,
                    options: new \Gs2Cdk\Matchmaking\Model\Options\RatingModelOptions(
                        metadata:"MODE1",
                    ),
                ),
                new \Gs2Cdk\Matchmaking\Model\RatingModel(
                    name:"mode2",
                    volatility:150,
                    options: new \Gs2Cdk\Matchmaking\Model\Options\RatingModelOptions(
                        metadata:"MODE2",
                    ),
                ),
            ],
        );
    }
}

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

class SampleStack extends io.gs2.cdk.core.model.Stack
{
    public SampleStack() {
        super();
        new io.gs2.cdk.matchmaking.model.Namespace(
            this,
            // omission
        ).masterData(
            Arrays.asList(
                new io.gs2.cdk.matchmaking.model.RatingModel(
                    "mode1",
                    100,
                    new io.gs2.cdk.matchmaking.model.options.RatingModelOptions() {
                        {
                            metadata: "MODE1";
                        }
                    }
                ),
                new io.gs2.cdk.matchmaking.model.RatingModel(
                    "mode2",
                    150,
                    new io.gs2.cdk.matchmaking.model.options.RatingModelOptions() {
                        {
                            metadata: "MODE2";
                        }
                    }
                )
            )
        );
    }
}

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

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

class SampleStack extends core.Stack
{
    public constructor() {
        super();
        new matchmaking.model.Namespace(
            this,
            // omission
        ).masterData(
            [
                new matchmaking.model.RatingModel(
                    "mode1",
                    100,
                    {
                        metadata: "MODE1"
                    }
                ),
                new matchmaking.model.RatingModel(
                    "mode2",
                    150,
                    {
                        metadata: "MODE2"
                    }
                )
            ]
        );
    }
}

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

public class SampleStack : Gs2Cdk.Core.Model.Stack
{
    public SampleStack() {
        new Gs2Cdk.Gs2Matchmaking.Model.Namespace(
            this,
            // omission
        ).MasterData(
            new [] {
                new Gs2Cdk.Gs2Matchmaking.Model.RatingModel(
                    "mode1",
                    100,
                    new Gs2Cdk.Gs2Matchmaking.Model.Options.RatingModelOptions {
                        metadata = "MODE1",
                    }
                ),
                new Gs2Cdk.Gs2Matchmaking.Model.RatingModel(
                    "mode2",
                    150,
                    new Gs2Cdk.Gs2Matchmaking.Model.Options.RatingModelOptions {
                        metadata = "MODE2",
                    }
                )
            }
        );
    }
}

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

ScriptSetting

	Type	Require	Default	Limitation	Description
triggerScriptId	string			~ 1024 chars	Script GRN
doneTriggerTargetType	enum [’none’, ‘gs2_script’, ‘aws’]	✓	“none”	~ 128 chars	Notification of Completion
doneTriggerScriptId	string	{doneTriggerTargetType} == “gs2_script”		~ 1024 chars	Script GRN
doneTriggerQueueNamespaceId	string	{doneTriggerTargetType} == “gs2_script”		~ 1024 chars	Namespace GRN

NotificationSetting

	Type	Require	Limitation	Description
gatewayNamespaceId	string	✓	~ 1024 chars	Namespace GRN
enableTransferMobileNotification	bool?			Forwarding to mobile push notification
sound	string		~ 1024 chars	Sound file name to be used for mobile push notifications

LogSetting

	Type	Require	Default	Limitation	Description
loggingNamespaceId	string	✓		~ 1024 chars	Namespace GRN

GitHubCheckoutSetting

	Type	Require	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	enum [‘commit_hash’, ‘branch’, ’tag’]	✓	~ 128 chars	Source of code
commitHash	string	{referenceType} == “commit_hash”	~ 1024 chars	Commit hash
branchName	string	{referenceType} == “branch”	~ 1024 chars	Branch Name
tagName	string	{referenceType} == “tag”	~ 1024 chars	Tag Name

AttributeRange

	Type	Require	Default	Limitation	Description
name	string	✓		~ 128 chars	Attribute Name
min	int	✓	0	~ 2147483646	Minimum attribute values that can participate in the Gathering
max	int	✓	0	~ 2147483646	Maximum value of attributes that can participate in the Gathering

CapacityOfRole

	Type	Require	Default	Limitation	Description
roleName	string	✓	“default”	~ 128 chars	Role Name
roleAliases	List<string>		[]	~ 9 items	List of Role Name Aliases
capacity	int	✓		1 ~ 256	Number of applicants
participants	List<Player>		[]	~ 1000 items	List of Participant Players

Attribute

	Type	Require	Default	Limitation	Description
name	string	✓		~ 128 chars	Attribute Name
value	int	✓	0	~ 2147483646	Attribute value

Player

	Type	Require	Default	Limitation	Description
userId	string	✓		~ 128 chars	User Id
attributes	List<Attribute>		[]	~ 5 items	List of Attributes
roleName	string	✓	“default”	~ 128 chars	Role Name
denyUserIds	List<string>		[]	~ 100 items	List of user IDs that are denied participation

GameResult

	Type	Require	Default	Limitation	Description
rank	int	✓		~ 2147483646	Rank
userId	string	✓		~ 128 chars	User Id

Ballot

	Type	Require	Limitation	Description
userId	string	✓	~ 128 chars	User Id
ratingName	string	✓	~ 128 chars	Rating name used for rating calculations
gatheringName	string	✓	~ 128 chars	Name of Gathering to be voted
numberOfPlayer	int	✓	2 ~ 10	Number of participants

SignedBallot

	Type	Require	Default	Limitation	Description
body	string	✓		~ 1024 chars	Data for ballot signature targets
signature	string	✓		~ 256 chars	Signature

WrittenBallot

	Type	Require	Default	Limitation	Description
ballot	Ballot	✓			Ballot
gameResults	List<GameResult>			~ 10 items	List of Results

TimeSpan

	Type	Require	Limitation	Description
days	int	✓	~ 365	Number of days from current time
hours	int	✓	~ 24	Hours from current time
minutes	int	✓	~ 60	Minutes from current time