冒険ゲームで学ぶ GS2 on Game Server Services | Docs

開発環境を準備する

Mon, 01 Jan 0001 00:00:00 +0000

GS2 の学習用プロジェクトと、Unity の空のシーンを用意しましょう。ここで作る GS2 のアカウントは、ゲームの設定を管理する開発者用です。

1. GS2 に登録する

GS2 のサイト（別タブ）から開発者アカウントを登録します。届いたメールのリンクでメールアドレスを確認したら、マネージメントコンソール（別タブ）にログインしてください。

2. 学習用プロジェクトを作る

Project → プロジェクトリスト → プロジェクトを新規作成を開きます。
プロジェクト名に adventure、説明に「冒険ゲームの練習」と入力します。
最初に有効化するリージョンを東京にします。この教材のコードも東京（ap-northeast-1）へ接続します。
契約プランなどの内容を確認し、作成を押します。

プロジェクト名には英数字、ハイフン、アンダースコアを使います。すでに学習用プロジェクトがある場合は、東京リージョンが有効であることを確認して使えます。

3. Unity に設定する接続情報を確認する

作成したプロジェクトの東京リージョンで、Deploy → スタックリスト → Default → アウトプットリストを開きます。次の二つの値を、Unity の接続設定に使います。

アウトプット名	Unity で設定する項目
`ApplicationClientId`	Client ID
`ApplicationClientSecret`	Client Secret

4. Unity とツールを準備する

Unity で空のプロジェクトを作り、シーンを Adventure という名前で保存します。

Studio は、画面で機能を選び、表に設定を入力する方法です。SDK（Unity） は、GS2 の設定と C# コードを自分で書く方法です。下のタブを選ぶと、その方法での準備手順が表示されます。

GS2 Studio のダウンロードページ（別タブ）からデスクトップアプリを導入します。
起動画面の新規プロジェクトを作成から Adventure を作り、保存先のフォルダーを選びます。こちらはパソコン上の設計データを置くプロジェクトです。
右上でシンプルを選びます。左側にホーム・機能を追加・表・反映が表示されます。

1. アカウントを作成してログインする

Mon, 01 Jan 0001 00:00:00 +0000

まずはゲームにログインできるようにしましょう。ログインしたプレイヤーの ID を画面に表示し、Unity の再生を止めても、同じアカウントで戻ってこられるようにします。

初回はアカウントを作成して、プレイヤー ID とパスワードを保存します。2 回目からは保存した情報でログインします。ログイン後に受け取るアクセストークンには期限があるので、次に起動するときもログイン処理を通します。

1. プレイヤーを保存する場所を作る

GS2 の設定やデータを分けて置く場所を「ネームスペース」と呼びます。プレイヤーのアカウントを保存するために、GS2-Account のネームスペースを作りましょう。

「引き継ぎ設定」を追加する

Studio の Adventure プロジェクトを開きます。左側で機能を追加を押し、検索欄に 引き継ぎ と入力してください。メニューが見当たらない場合は、右上のシンプルを選びます。

引き継ぎ設定のカードで、追加を押します。このパッケージには、プレイヤーのアカウントを保存する Account の設定も入っています。

カードに追加済みと表示されたら、Studio への読み込みは完了です。

サーバーに反映する

追加した設定を GS2 に送って、実際にアカウントを保存できるようにします。この作業を「デプロイ」と呼びます。

左側で反映を押し、サーバに反映するの枠にあるサーバとの差分を確認を押してください。

GS2 ログインが表示されたら、準備で登録した開発者アカウントのメールアドレスとパスワードでログインします。

ログインできたら、デプロイ先と変更内容を確認します。

GS2プロジェクト選択で、学習用の adventure プロジェクトと 東京（ap-northeast-1） を選び、選択を押します。
GS2への変更を確認で、引き継ぎ設定のパッケージ foundation-core-identity の差分を確認します。新しいプロジェクトでは、Account というネームスペースが作られます。スタック名は Studio が用意した名前を使います。
1パッケージをデプロイを押し、処理が完了するまで待ちます。
反映に戻り、サーバに反映するの枠が最新の内容を反映済みになっていることを確認します。

これで、プレイヤーを保存する Account ネームスペースができました。

2. 冒険を登録して一覧に表示する

Mon, 01 Jan 0001 00:00:00 +0000

ログインできるようになったので、次は冒険の一覧を作りましょう。最初の冒険は「森の探索」です。冒険を GS2 ではクエストと呼び、クエストグループにまとめて管理します。今回はクエストグループ main に forest として登録し、画面に名前を表示してみます。

ゲームの設定を用意する

冒険の名前や報酬など、開発者が決めるゲームの設定を「マスターデータ」と呼びます。一方、プレイヤーが持っているコインや、どの冒険の途中かを表すものは「ユーザーデータ」です。まずは、一覧に表示するマスターデータを作ります。

forest はプログラムが冒険を指定するための識別子で、「森の探索」はプレイヤーに見せる名前です。二つを分けておくと、画面上の名前を変えても、プログラムでは同じ冒険として扱えます。

一覧を表示するための設定を作ります。開始時の消費と報酬の設定欄は、空にしておきます。

手順

クエストを追加する

第1章で使った Studio の Adventure プロジェクトを開きます。機能を追加で クエスト を検索し、カードの追加を押してください。

追加済みと表示されるまで待ちます。クエストが使う「スケジュール基盤」も一緒に追加されます。

クエストグループを作る

表 → クエスト → クエストグループ（QuestCollection） を開き、行を追加を押します。ID のセルを選んで Enter を押し、main と入力して Enter で確定します。開催スケジュールは空欄にします。

3. 冒険を開始し、報酬を受け取る

Mon, 01 Jan 0001 00:00:00 +0000

一覧に出てきた「森の探索」を、実際に遊べるようにしましょう。「開始」で冒険に出て、「クリア」で戻ってくると、10 コインがもらえるようにします。今回は何回クリアしても同じ報酬にし、初回ボーナスは付けません。

クリア報酬は GS2 側に設定する

報酬の枚数は、GS2 のクエスト設定で決めます。通常クリア報酬を「無償コイン 10 枚」にしておけば、Unity からクリアを報告したときに、GS2 がコインを加えてくれます。Unity 側では、残高の変更に合わせて画面の表示を更新します。

コインは GS2-Money2 の「ウォレット」に保存します。ウォレットを区別する番号を「スロット」と呼び、このゲームでは 0 を使います。この章で Money2 の設定を追加し、以降の章でも同じウォレットを読み書きします。

冒険の完了とコインの入金は、まとめて処理したい操作です。このような一連の処理をトランザクションと呼びます。クエストの通常クリア報酬に入金を設定すれば、Unity はクリアを報告するだけで済みます。

コインを増やすといった処理を、設定の中では「獲得アクション」と呼びます。次の手順では、通常クリア報酬にコインの獲得アクションを追加します。

手順

通貨と報酬を設定する

機能を追加 で「通貨」を追加します。
クエスト（Quest） で forest の 通常クリア報酬 のセルをダブルクリックします。右側の アイテムを追加 を押し、追加された 未設定 を開きます。
アクション で DepositByUserId を検索し、money2 の ウォレットの残高に加算 を選びます。ターゲットリソース はなしのまま、次の値を入力します。

4. 再起動して続きを遊ぶ

Mon, 01 Jan 0001 00:00:00 +0000

第3章までに作ったゲームを再起動して、集めたコインや進行中の冒険が残っているか試してみましょう。この章では、コードやサーバーの設定を変更せずに進めます。

コインが残っているか確かめる

冒険をクリアして、コインを 10 枚以上集めます。画面に報酬が反映されたら、プレイヤー ID とコイン残高を控えます。
Unity の Play を止め、もう一度再生します。Studio は自動でログインします。SDK は ログイン ボタンを押します。この章で再生し直すときは、毎回この方法でログインしてください。
プレイヤー ID と残高が、控えた値と同じか比べます。冒険は始める前の状態になっていれば成功です。

コインや冒険の進行状況は GS2 に保存されています。第1章では、同じアカウントでログインするための情報を端末に保存しました。再起動すると、そのアカウントでログインし、第3章の表示処理が GS2 からデータを取得します。

冒険の途中から再開する

森の探索の開始ボタンを押します。進行中の冒険が表示されたら、クリアせずに Play を止めます。
再生し直してログインします。同じプレイヤー ID で、進行中の冒険が表示されることを確かめます。
クリア を押します。コインが 10 枚増え、次の冒険を始められる状態になったら、残高を控えます。
もう一度 Play を止め、再生してログインします。控えた残高が表示され、進行中の冒険がなければ成功です。

Unity の Play の停止・再生に加えて、ビルドしたアプリでも終了・起動を試してみましょう。起動前後のプレイヤー ID と残高を比べます。

別のアカウントと切り替えて比べる

元のプレイヤー ID とコイン残高を控えます。
Studio は再生を止め、PlayerPrefs Account Store の Key Prefix を adventure.resume-test にして再生します。SDK は再生を止め、AdventureLogin の Account Slot を resume-test に変えて再生し、ログインします。
初めて使う保存先なら、新しいプレイヤー ID になり、コインは 0、進行中の冒険はなしになります。
Studio は再生を止めて Key Prefix を adventure.main に戻し、再生します。SDK は再生を止め、Account Slot を main に戻して再生し、ログインします。元のプレイヤー ID と残高が表示されることを確かめます。

次へ：冒険の開始時にスタミナを消費する

5. 冒険の開始時にスタミナを消費する

Mon, 01 Jan 0001 00:00:00 +0000

ここからは、冒険にスタミナを使うようにしていきます。森の探索を始めるのに必要なのは 5。足りないときは回復を待つ、というルールにしましょう。

始める前に

進行中の冒険があればクリアしてから、スタミナの設定を追加します。

追加する設定

スタミナの設定には stamina という名前を付けます。最初の値は 20、通常の回復上限も 20 です。冒険で使った分は、300 秒ごとに 1 ずつ自然に回復するようにします。

手順

スタミナの表を作る

機能を追加で「スタミナ」を追加し、表 → スタミナ（Energy） に次の行を作ります。

項目	値
ID	`stamina`
初期上限（defaultMaximum）	`20`
上限超過を許可（useOverflow）	オフ
超過時上限（overflowedMaximum）	`20`
回復間隔（recoveryIntervalMinutes）	`5`（分）
1回の回復量（recoveryValue）	`1`

回復間隔の入力単位は分です。300 秒にしたいので、入力するのは 5 です。

クエスト（Quest） の forest の 開始時消費 をダブルクリックします。アイテムを追加 → 未設定 を開き、アクションで ConsumeStaminaByUserId（スタミナを消費）を選びます。ターゲットリソースはなしのまま、次の値を入力します。

6. コインでスタミナを回復する

Mon, 01 Jan 0001 00:00:00 +0000

冒険で集めたコインを、今度は使ってみましょう。作るのは、20 コインでスタミナを 10 回復できる商品です。refill という名前で登録し、冒険の報酬でもらった無償コインで買えるようにします。

支払いと回復をまとめて処理する

商品を買うときは、コインの支払いとスタミナの回復をセットで行いたいので、二つの処理を一つのトランザクションにまとめます。コインが足りないときには、スタミナだけ回復することなく、購入が失敗するようにします。

手順

商品の表を作る

機能を追加で「スタミナショップ」を追加し、表 → スタミナ商品（EnergyProduct） に次の行を作ります。

項目	値
ID	`refill`
回復対象（energy）	`stamina` の行
回復量（recoveryValue）	`10`
購入コスト（consumeActions）	下記の消費アクションを1件

購入コスト のセルをダブルクリックし、アイテムを追加 → 未設定 を開きます。アクションで WithdrawByUserId（ウォレットから残高を消費）を選び、ターゲットリソースはなしのまま次の値を入力します。

項目	値
namespaceName	`Currency`
userId	`#{userId}`
slot	`0`
withdrawCount	`20`
paidOnly	`false`

paidOnly を false にすると、この教材で集めた無償コインを支払いに使えます。

7. 設定を変更してゲームへ反映する

Mon, 01 Jan 0001 00:00:00 +0000

基本の仕組みができたので、ゲームの内容を少し変えてみましょう。森の探索の報酬を 10 から 15 コインに増やし、新しい冒険「洞窟の探索」も追加します。設定を変えると、画面や実際の報酬がどう変わるかを見ていきます。

始める前に

進行中の冒険をクリアし、購入などの処理が完了してから、設定を変更します。

変更内容

冒険	消費スタミナ	通常報酬	初回報酬
`forest` 森の探索	5	15 コイン	なし
`cave` 洞窟の探索	8	20 コイン	なし

手順

既存の行を変更し、新しい行を追加する

表 → クエスト（Quest） を開き、次のように編集します。

ID	グループ	displayName	開始時消費の consumeValue	通常クリア報酬の count
`forest`	`main`	森の探索	`5`	`15`
`cave`	`main`	洞窟の探索	`8`	`20`

forest の通常クリア報酬を開き、depositTransactions → DepositTransaction → count を 15 に変更します。

8. 通信エラーとボタンの連打に対応する

Mon, 01 Jan 0001 00:00:00 +0000

作ったショップで、購入ボタンを続けて押したり、通信を切ったりしてみましょう。これまで使ってきたプレイヤーで進めます。

処理中にもう一度押してみる

コインを 20 枚以上用意します。足りない場合は冒険をクリアして集めます。
20 コインでスタミナを 10 回復 を押し、すぐにもう一度押してみます。
処理中はボタンが無効になり、次の購入を始められないことを確かめます。

コードでは、操作を始めるときに busy を true にし、finally で false に戻しています。ボタンの表示だけでなく、Studio の Run()、SDK の RunWrite() でも処理中の呼び出しを止めています。

購入が完了してボタンが有効になった後に押すと、それは新しい購入になります。

コインが足りないときの表示を確かめる

購入を繰り返し、コイン残高を 20 枚未満にします。
もう一度購入ボタンを押し、コイン不足のメッセージが表示されることを確かめます。
失敗した購入でコインが減らず、スタミナも回復していないことを確認します。自然回復で増えた分は除いて比べてください。
森の探索を始め、冒険の操作は続けられることを確かめます。確認できたらクリアします。

コインやスタミナの不足は、理由を表示して次の操作を受け付けます。

同じ購入を再試行できるようにする

通信が切れたとき、サーバーでは購入が終わっていて、返事だけが届いていないことがあります。そのまま新しい購入を送ると、もう一度コインを使ってしまいます。

そこで、1回の購入に一つのキーを付けます。duplicationAvoider に同じキーを渡して同じ内容を送り直すと、GS2 は完了済みの購入を繰り返さず、その結果を返します。

Unity の再生を止め、使っているコースのファイルで、同名のファイルを置き換えてください。Inspector の参照はそのまま使います。

AdventureStudioView.cs をダウンロードします。

購入を行う Buy() は、次のようになります。purchaseId はクラスのフィールドです。