NAV
GS2-Deploy

GS2-Version

GS2-Deploy のテンプレートで使用できるリソース定義のリファレンス

エンティティ

Namespace

Namespace

Type: GS2::Version::Namespace
Properties:
  Name: namespace1
  Description: null
  AssumeUserId: grn:gs2::YourOwnerId:identifier:user:user-0001
  AcceptVersionScript: null
  CheckVersionTriggerScriptId: null
  LogSetting: 
    LoggingNamespaceId: grn:gs2:ap-northeast-1:YourOwnerId:log:namespace1

ネームスペースは一つのプロジェクトで同じサービスを異なる用途で複数利用できるようにするための仕組みです。 GS2 のサービスは基本的にネームスペースというレイヤーがあり、ネームスペースが異なれば同じサービスでもまったく別のデータ空間として取り扱われます。

そのため、各サービスの利用を開始するにあたってネームスペースを作成する必要があります。

必須 デフォルト 値の制限 説明
name string ~ 32文字 ネームスペース名
description string ~ 1024文字 説明文
assumeUserId string ~ 1024文字 ユーザGRN
acceptVersionScript ScriptSetting バージョンを承認したときに実行するスクリプト
checkVersionTriggerScriptId string ~ 1024文字 バージョンチェック処理を実行する GS2-Script のスクリプト
logSetting LogSetting ログの出力設定

VersionModelMaster

VersionModelMaster

Type: GS2::Version::VersionModelMaster
Properties:
  NamespaceName: namespace1
  Name: version-0001
  Description: null
  Metadata: null
  WarningVersion: 
    Major: 2
    Minor: 2
    Micro: 2
  ErrorVersion: 
    Major: 1
    Minor: 1
    Micro: 1
  Scope: passive
  CurrentVersion: null
  NeedSignature: false
  SignatureKeyId: null

現在のバージョンを表現するエンティティです。

ログインを受け入れるが、バージョンアップ出来ることを通知する警告バージョンと、ログインを受け入れないエラーバージョンを設定できます。

現在のバージョンをクライアントに申告させるのに、署名の有無を指定できます。 署名付きを選択した場合、クライアントは嘘のバージョン申告を出来なくなります。

必須 デフォルト 値の制限 説明
namespaceName string ~ 32文字 ネームスペース名
name string ~ 128文字 バージョン名
description string ~ 1024文字 説明文
metadata string ~ 2048文字 メタデータ
warningVersion Version_ バージョンアップを促すバージョン
errorVersion Version_ バージョンチェックを蹴るバージョン
scope string ~ 128文字 判定に使用するバージョン値の種類
currentVersion Version_ {scope} == "active" 現在のバージョン
needSignature bool {scope} == "passive" 判定するバージョン値に署名検証を必要とするか
signatureKeyId string {needSignature} != none and {needSignature} ~ 1024文字 暗号鍵GRN

CurrentVersionMaster

CurrentVersionMaster

Type: GS2::Version::CurrentVersionMaster
Properties:
  NamespaceName: namespace1
  Settings: {\n  "version": "2019-10-09",\n  "versionModels": [\n    {\n      "name": "app",\n      "metadata": "APP",\n      "warningVersion": {\n        "major": 2,\n        "minor": 2,\n        "micro": 2\n      },\n      "errorVersion": {\n        "major": 1,\n        "minor": 1,\n        "micro": 1\n      },\n      "scope": "passive",\n      "needSignature": false\n    },\n    {\n      "name": "asset",\n      "metadata": "ASSET",\n      "warningVersion": {\n        "major": 3,\n        "minor": 3,\n        "micro": 3\n      },\n      "errorVersion": {\n        "major": 2,\n        "minor": 2,\n        "micro": 2\n      },\n      "scope": "passive",\n      "needSignature": true,\n      "signatureKeyId": "grn:gs2:ap-northeast-1:YourOwnerId:key:namespace-0001:key:key-0001"\n    },\n    {\n      "name": "eula",\n      "metadata": "EULA",\n      "warningVersion": {\n        "major": 4,\n        "minor": 4,\n        "micro": 4\n      },\n      "errorVersion": {\n        "major": 3,\n        "minor": 3,\n        "micro": 3\n      },\n      "scope": "active",\n      "currentVersion": {\n        "major": 2,\n        "minor": 2,\n        "micro": 2\n      }\n    }\n  ]\n}

GS2ではマスターデータの管理にJSON形式のファイルを使用します。 ファイルをアップロードすることで、実際にサーバーに設定を反映することができます。

JSONファイルを作成する方法として、マネージメントコンソール上でのマスターデータエディタを提供していますが よりゲームの運営に相応しいツールを作成し、適切なフォーマットのJSONファイルを書き出すことでもサービスを利用可能です。

JSONファイルの形式についてはドキュメントを参照ください。

必須 デフォルト 値の制限 説明
namespaceName string ~ 32文字 ネームスペース名
settings string ~ 5242880文字 マスターデータ