GS2-Matchmaking
Reference to resource definitions available in GS2-Deploy templates
GS2-Deploy Reference
Entities
Namespace
Namespace
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
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='none',
complete_matchmaking_trigger_type='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: "none",
completeMatchmakingTriggerType: "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",
"none",
"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",
"none",
"none",
{
enableRating: true,
logSetting: new core.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.Gs2Matchmaking.Model.Namespace(
this,
"namespace-0001",
"none",
"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
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 | |||
logSetting | LogSetting | Log output settings |
CurrentRatingModelMaster
CurrentRatingModelMaster
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"
}
)
]
);
}
}
System.out.println(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
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 |