ルートボックスロールのカスタマイゼーションを開始する
注釈:本資料はAI技術を用いて翻訳されています。
概要
AccelByte Gaming Services(AGS)では、プレイヤーがルートボックスを開く際に、さまざまな要件に応じたカスタムロジックを実装できます。
この記事では、Extend Overrideアプリテンプレートを例として、カスタムルートボックスロールロジックをセットアップするプロセスを説明します。
前提条件
- C#
- Go
- Java
- Python
-
以下のツールがインストールされたWindows 11 WSL2/Linux Ubuntu 22.04またはmacOS 14+:
a. Bash
-
Windows WSL2またはLinux Ubuntuの場合:
bash --version
GNU bash, version 5.1.16(1)-release (x86_64-pc-linux-gnu)
... -
macOSの場合:
bash --version
GNU bash, version 3.2.57(1)-release (arm64-apple-darwin23)
...
b. Make
-
Windows WSL2またはLinux Ubuntuの場合:
Ubuntuリポジトリからインストールするには、
sudo apt update && sudo apt install makeを実行します。make --version
GNU Make 4.3
... -
macOSの場合:
make --version
GNU Make 3.81
...
c. Docker (Docker Desktop 4.30+/Docker Engine v23.0+)
-
Linux Ubuntuの場合:
- Ubuntuリポジトリからインストールするには、
sudo apt update && sudo apt install docker.io docker-buildx docker-compose-v2を実行します。 - ユーザーを
dockerグループに追加します:sudo usermod -aG docker $USER。 - ログアウトして再度ログインし、変更を有効にします。
- Ubuntuリポジトリからインストールするには、
-
WindowsまたはmacOSの場合:
WindowsまたはmacOSへのDocker Desktopのインストールに関するDockerのドキュメントに従ってください。
docker version
...
Server: Docker Desktop
Engine:
Version: 24.0.5
...
d. .NET 8 SDK
-
Linux Ubuntuの場合:
Ubuntuリポジトリからインストールするには、
sudo apt-get update && sudo apt-get install -y dotnet-sdk-8.0を実行します。 -
WindowsまたはmacOSの場合:
WindowsまたはmacOSへの.NETのインストールに関するMicrosoftのドキュメントに従ってください。
dotnet --version
8.0.119
e. Postman
- Postmanから利用可能なバイナリを使用します。
- extend-helper-cliから利用可能なバイナリを使用します。
g. TCP転送機能を持つローカルトンネルサービス(以下など):
-
無料プランには登録が必要です。クイックスタートについては、ngrokドキュメントを参照してください。
-
登録なしで無料で試すことができます。クイックスタートについては、pinggyドキュメントを参照してください。
-
-
以下のツールがインストールされたWindows 11 WSL2/Linux Ubuntu 22.04またはmacOS 14+:
a. Bash
-
Windows WSL2またはLinux Ubuntuの場合:
bash --version
GNU bash, version 5.1.16(1)-release (x86_64-pc-linux-gnu)
... -
macOSの場合:
bash --version
GNU bash, version 3.2.57(1)-release (arm64-apple-darwin23)
...
b. Make
-
Windows WSL2またはLinux Ubuntuの場合:
Ubuntuリポジトリからインストールするには、
sudo apt update && sudo apt install makeを実行します。make --version
GNU Make 4.3
... -
macOSの場合:
make --version
GNU Make 3.81
...
c. Docker (Docker Desktop 4.30+/Docker Engine v23.0+)
-
Linux Ubuntuの場合:
- Ubuntuリポジトリからインストールするには、
sudo apt update && sudo apt install docker.io docker-buildx docker-compose-v2を実行します。 - ユーザーを
dockerグループに追加します:sudo usermod -aG docker $USER。 - ログアウトして再度ログインし、変更を有効にします。
- Ubuntuリポジトリからインストールするには、
-
WindowsまたはmacOSの場合:
WindowsまたはmacOSへのDocker Desktopのインストールに関するDockerのドキュメントに従ってください。
docker version
...
Server: Docker Desktop
Engine:
Version: 24.0.5
...
d. Go v1.24
- Goのインストールガイドに従ってください。
go version
go version go1.24.0 ...e. Postman
- Postmanから利用可能なバイナリを使用します。
- extend-helper-cliから利用可能なバイナリを使用します。
g. TCP転送機能を持つローカルトンネルサービス(以下など):
-
無料プランには登録が必要です。クイックスタートについては、ngrokドキュメントを参照してください。
-
登録なしで無料で試すことができます。クイックスタートについては、pinggyドキュメントを参照してください。
-
-
以下のツールがインストールされたWindows 11 WSL2/Linux Ubuntu 22.04またはmacOS 14+:
a. Bash
-
Windows WSL2またはLinux Ubuntuの場合:
bash --version
GNU bash, version 5.1.16(1)-release (x86_64-pc-linux-gnu)
... -
macOSの場合:
bash --version
GNU bash, version 3.2.57(1)-release (arm64-apple-darwin23)
...
b. Make
-
Windows WSL2またはLinux Ubuntuの場合:
Ubuntuリポジトリからインストールするには、
sudo apt update && sudo apt install makeを実行します。make --version
GNU Make 4.3
... -
macOSの場合:
make --version
GNU Make 3.81
...
c. Docker (Docker Desktop 4.30+/Docker Engine v23.0+)
-
Linux Ubuntuの場合:
- Ubuntuリポジトリからインストールするには、
sudo apt update && sudo apt install docker.io docker-buildx docker-compose-v2を実行します。 - ユーザーを
dockerグループに追加します:sudo usermod -aG docker $USER。 - ログアウトして再度ログインし、変更を有効にします。
- Ubuntuリポジトリからインストールするには、
-
WindowsまたはmacOSの場合:
WindowsまたはmacOSへのDocker Desktopのインストールに関するDockerのドキュメントに従ってください。
docker version
...
Server: Docker Desktop
Engine:
Version: 24.0.5
...
d. JDK 17
-
Linux Ubuntuの場合:
Ubuntuリポジトリからインストールするには、
sudo apt update && sudo apt install openjdk-17-jdkを実行します。 -
WindowsまたはmacOSの場合:
Microsoft Build of OpenJDKのインストールに関するMicrosoftのドキュメントに従ってください。
java --version
openjdk 17.0.10 2024-01-16
...
e. Postman
- Postmanから利用可能なバイナリを使用します。
- extend-helper-cliから利用可能なバイナリを使用します。
g. TCP転送機能を持つローカルトンネルサービス(以下など):
-
無料プランには登録が必要です。クイックスタートについては、ngrokドキュメントを参照してください。
-
登録なしで無料で試すことができます。クイックスタートについては、pinggyドキュメントを参照してください。
-
-
以下のツールがインストールされたWindows 11 WSL2/Linux Ubuntu 22.04またはmacOS 14+:
a. Bash
-
Windows WSL2またはLinux Ubuntuの場合:
bash --version
GNU bash, version 5.1.16(1)-release (x86_64-pc-linux-gnu)
... -
macOSの場合:
bash --version
GNU bash, version 3.2.57(1)-release (arm64-apple-darwin23)
...
b. Make
-
Windows WSL2またはLinux Ubuntuの場合:
Ubuntuリポジトリからインストールするには、
sudo apt update && sudo apt install makeを実行します。make --version
GNU Make 4.3
... -
macOSの場合:
make --version
GNU Make 3.81
...
c. Docker (Docker Desktop 4.30+/Docker Engine v23.0+)
-
Linux Ubuntuの場合:
- Ubuntuリポジトリからインストールするには、
sudo apt update && sudo apt install docker.io docker-buildx docker-compose-v2を実行します。 - ユーザーを
dockerグループに追加します:sudo usermod -aG docker $USER。 - ログアウトして再度ログインし、変更を有効にします。
- Ubuntuリポジトリからインストールするには、
-
WindowsまたはmacOSの場合:
WindowsまたはmacOSへのDocker Desktopのインストールに関するDockerのドキュメントに従ってください。
docker version
...
Server: Docker Desktop
Engine:
Version: 24.0.5
...
d. Python 3.10
-
Linux Ubuntuの場合:
Ubuntuリポジトリからインストールするには、
sudo apt update && sudo apt install python3 python3-venvを実行します。 -
WindowsまたはmacOSの場合:
こちらから利用可能なインストーラーを使用します。
python3 --version
Python 3.10.12
e. Postman
- Postmanから利用可能なバイナリを使用します。
- extend-helper-cliから利用可能なバイナリを使用します。
g. TCP転送機能を持つローカルトンネルサービス(以下など):
-
無料プランには登録が必要です。クイックスタートについては、ngrokドキュメントを参照してください。
-
登録なしで無料で試すことができます。クイックスタートについては、pinggyドキュメントを参照してください。
-
- AGS Admin Portal環境へのアクセス。
- ベースURL:
<環境のドメインURL>- AGS Shared Cloudのお客様の例:
https://spaceshooter.prod.gamingservices.accelbyte.io - AGS Private Cloudのお客様の例:
https://dev.customer.accelbyte.io
- AGS Shared Cloudのお客様の例:
- まだない場合は、ゲームネームスペースを作成してください。ネームスペースIDをメモしてください。
confidentialクライアントタイプでOAuthクライアントを作成します。Client IDとClient Secretを保管してください。
- ベースURL:
アプリテンプレートのクローン
- C#
- Go
- Java
- Python
git clone https://github.com/AccelByte/lootbox-roll-function-grpc-plugin-server-csharp.git
git clone https://github.com/AccelByte/lootbox-roll-function-grpc-plugin-server-go.git
git clone https://github.com/AccelByte/lootbox-roll-function-grpc-plugin-server-java.git
git clone https://github.com/AccelByte/lootbox-roll-function-grpc-plugin-server-python.git
Extendアプリのセットアップ、実行、テスト
このセクションでは、Extendアプリのセットアップ、ビルド、実行、テストの方法について説明します。
Extendアプリのセットアップ
このアプリを実行するには、以下のセットアップ手順に従ってください:
-
.env.templateファイルの内容をコピーして、docker composeの.envファイルを作成します。注記ホストOSの環境変数は
.envファイルの変数よりも優先されます。.envファイルの変数が正しく反映されない場合は、同じ名前のホストOS環境変数が存在するか確認してください。詳細については、docker composeの環境変数の優先順位に関するDockerのドキュメントを参照してください。 -
以下のように、
.envファイルに必要な環境変数を入力します。AB_BASE_URL=https://test.accelbyte.io # AGS環境のベースURL
AB_CLIENT_ID='xxxxxxxxxx' # 前提条件セクションのクライアントID
AB_CLIENT_SECRET='xxxxxxxxxx' # 前提条件セクションのクライアントシークレット
AB_NAMESPACE='xxxxxxxxxx' # 前提条件セクションのネームスペースID
PLUGIN_GRPC_SERVER_AUTH_ENABLED=true # アクセストークン検証の有効化または無効化注記このアプリでは、
PLUGIN_GRPC_SERVER_AUTH_ENABLEDはデフォルトでtrueに設定されています。falseに設定すると、AccelByte Gaming ServicesのアクセストークンなしでgRPCサーバーを呼び出すことができます。このオプションは開発目的でのみ提供されています。本番環境ではgRPCサーバーのアクセストークン検証を有効にすることを推奨します。
Extendアプリのビルド
このアプリをビルドするには、以下のコマンドを実行します:
make build
Extendアプリの実行
このアプリをコンテナ内で(ビルドして)実行するには、以下のコマンドを実行します:
docker compose up --build
Extendアプリのテスト
Extendアプリは、ローカル開発環境またはAGSでテストできます。
ローカル開発環境でのテスト
テストの前に、PLUGIN_GRPC_SERVER_AUTH_ENABLEDがfalseに設定されていることを確認してください。そうでない場合、gRPCリクエストはgRPCサーバーによって拒否されます。
このアプリのカスタム関数は、Postmanを使用してローカルでテストできます。Postmanを使用してExtendアプリをテストするには、以下の手順に従ってください:
-
以下のコマンドを使用してこのアプリを実行します:
docker compose up --build -
Postmanで新しいgRPCリクエストを作成し、サーバーURLとして
localhost:6565を入力します。詳細については、gRPCのサポートに関するPostmanのガイドを参照してください。 -
LootBox/RollLootBoxRewardsメソッドを選択し、以下のサンプルメッセージで呼び出します:{
"userId": "b52a2364226d436285c1b8786bc9cbd1",
"namespace": "accelbyte",
"quantity": 10,
"itemInfo": {
"itemId": "8a0b8bda28c845f6938cc57540af452e",
"itemSku": "SKU3170",
"rewardCount": 2,
"lootBoxRewards": [
{
"name": "Foods",
"type": "REWARD",
"weight": 5,
"odds": 0,
"items": [
{
"itemId": "8b6016d243264c0f90031600313b8a37",
"itemSku": "SKU4650",
"count": 5
}
]
},
{
"name": "Beverages",
"type": "REWARD",
"weight": 4,
"odds": 0,
"items": [
{
"itemId": "dd81bbc3d9fd413daecfd0d0e53fc095",
"itemSku": "SKU1939",
"count": 13
}
]
},
{
"name": "Specials",
"type": "REWARD",
"weight": 1,
"odds": 0,
"items": [
{
"itemId": "3318d5fe505a4891b6b5a70586b294ca",
"itemSku": "SKU1739",
"count": 21
}
]
}
]
}
}成功すると、レスポンスにロールされた報酬が表示されます。
{
"rewards": [
{
"itemId": "8b6016d243264c0f90031600313b8a37",
"itemSku": "SKU4650",
"count": 5
},
...
]
}
AGSでのテスト
ローカルで実行されているアプリをAGSでテストするには、gRPCサーバーをインターネットに接続する必要があります。パブリックIPを必要とせずにこれを行うには、ローカルトンネルサービスを使用できます。
-
以下のコマンドを使用してこのアプリを実行します:
docker compose up --build -
ローカル開発環境の
gRPCサーバーのTCPポート6565をインターネットに公開します。最も簡単な方法は、ローカルトンネルサービスプロバイダーを使用することです。-
ngrokにサインインし、ngrokダッシュボードから
authtokenを取得してローカル環境に設定します。 そして、gRPCサーバーを公開するには以下のコマンドを使用します:ngrok tcp 6565 -
または、pinggyを使用して
sshコマンドラインのみで簡単なトンネルをセットアップすることもできます。gRPCサーバーを公開するには以下のコマンドを使用します:ssh -p 443 -o StrictHostKeyChecking=no -o ServerAliveInterval=30 -R0:127.0.0.1:6565 tcp@a.pinggy.io
トンネル転送URL(例:
http://0.tcp.ap.ngrok.io:xxxxxまたはtcp://xxxxx-xxx-xxx-xxx-xxx.a.free.pinggy.link:xxxxx)をメモしてください。備考他のローカルトンネルサービスや異なる方法を使用して、gRPCサーバーポート(TCP)をインターネットに公開することもできます。
-
-
Admin Portalで、この設定の正しいネームスペースに移動し、以下を実行します:
- サイドバーメニューで、Commerce > Customization > Loot Box Rollに移動します。
- 表示されるCustomizationページで、Add Configurationボタンをクリックします。
- Add Configurationポップアップで、**Locally hosted (for testing purpose)**オプションを選択し、ステップ3のトンネル転送URLを入力します。次に、Createをクリックします。
-
confidentialクライアントタイプでOAuthクライアントを作成し、以下の権限を含めます:- AGS Private Cloudのお客様の場合:
ADMIN:NAMESPACE:{namespace}:PLUGIN:CATALOG [READ,UPDATE,DELETE]ADMIN:NAMESPACE:{namespace}:STORE [CREATE,READ,UPDATE,DELETE]ADMIN:NAMESPACE:{namespace}:CATEGORY [CREATE]ADMIN:NAMESPACE:{namespace}:CURRENCY [READ,CREATE,DELETE]ADMIN:NAMESPACE:{namespace}:ITEM [READ,CREATE,DELETE]ADMIN:NAMESPACE:{namespace}:USER:*:ENTITLEMENT [READ,CREATE,UPDATE,DELETE]
- AGS Shared Cloudのお客様の場合:
- Platform Store > Service Plugin Config (Read, Update, Delete)
- Platform Store > Store (Read, Create, Update, Delete)
- Platform Store > Category (Create)
- Platform Store > Currency (Read, Create, Delete)
- Platform Store > Item (Read, Create, Delete)
- Platform Store > Entitlement (Read, Create, Update, Delete)
importantClient IDとClient Secretのコピーを保管してください。- このステップで作成されたOAuthクライアントは、前提条件セクションで言及されているものとは異なります。これは、次のステップのPostmanコレクションで
gRPCサーバーURLを登録し、テストユーザーを作成および削除するために必要です。
- AGS Private Cloudのお客様の場合:
-
Postmanコレクション(
demo/lootbox-roll-function-demo.postman_collection.json)の概要の指示に従って、前のステップのClient IDとClient Secretを使用して環境をセットアップします。Extendアプリフローが実行されているときは、このアプリのコンソールログに注意してください。コレクション内のすべてのリクエストを実行すると、少なくとも1つのgRPCサーバーメソッドが呼び出されるはずです。
AGSへのデプロイ
AGSでExtendアプリをデプロイするには、Admin Portalで以下の手順を実行します:
Extendアプリの作成
- AGS Admin Portalで、Extend Overrideアプリを作成するネームスペースに移動します。
- サイドバーメニューのADD-ONSの下で、Extend > Overrideに移動します。
- Overridable Featureページで、+ Create Newボタンをクリックします。
- Create Appフォームで、Extendアプリの名前と説明(オプション)を入力します。
- Createをクリックします。新しいExtendアプリがOverridable Featureアプリリストに追加されます。
Extendアプリのアップロード
-
extend-helper-cli用のIAMクライアントをセットアップします。クライアントタイプ
confidentialでIAMクライアントを作成し、以下にリストされている必要な権限を割り当てます。Client IDとClient Secretのコピーを保管してください。- AGS Private Cloudのお客様の場合:
ADMIN:NAMESPACE:{namespace}:EXTEND:REPOCREDENTIALS[READ]ADMIN:NAMESPACE:{namespace}:EXTEND:APP[READ]
- AGS Shared Cloudのお客様の場合:
- Extend > Extend app image repository access (Read)
- Extend > App (Read)
- AGS Private Cloudのお客様の場合:
-
必要な環境変数をエクスポートし、extend-helper-cliを使用してExtendアプリコンテナイメージをビルドしてAGSにアップロードします。
<project-dir>がExtendアプリプロジェクトディレクトリを指していることを確認してください<namespace>と<app-name>の値は、ExtendアプリのApp Detailページで確認できます- 適切なイメージタグ(例:
v0.0.1)を使用してください
- Linux
- Windows (WSL2)
- macOS
# AGS環境のベースURL(例:https://spaceshooter.prod.gamingservices.accelbyte.io、https://dev.accelbyte.ioなど)
export AB_BASE_URL='https://xxxxxxxxxx'
# extend-helper-cli用のOAuthクライアントのクライアントID(ステップ1から)
export AB_CLIENT_ID='xxxxxxxxxx'
# extend-helper-cli用のOAuthクライアントのクライアントシークレット(ステップ1から)
export AB_CLIENT_SECRET='xxxxxxxxxx'
./extend-helper-cli-linux_amd64 image-upload --login --work-dir <project-dir> --namespace <namespace> --app <app-name> --image-tag v0.0.1# AGS環境のベースURL(例:https://spaceshooter.prod.gamingservices.accelbyte.io、https://dev.accelbyte.ioなど)
export AB_BASE_URL='https://xxxxxxxxxx'
# extend-helper-cli用のOAuthクライアントのクライアントID(ステップ1から)
export AB_CLIENT_ID='xxxxxxxxxx'
# extend-helper-cli用のOAuthクライアントのクライアントシークレット(ステップ1から)
export AB_CLIENT_SECRET='xxxxxxxxxx'
./extend-helper-cli-linux_amd64 image-upload --login --work-dir <project-dir> --namespace <namespace> --app <app-name> --image-tag v0.0.1# AGS環境のベースURL(例:https://spaceshooter.prod.gamingservices.accelbyte.io、https://dev.accelbyte.ioなど)
export AB_BASE_URL='https://xxxxxxxxxx'
# extend-helper-cli用のOAuthクライアントのクライアントID(ステップ1から)
export AB_CLIENT_ID='xxxxxxxxxx'
# extend-helper-cli用のOAuthクライアントのクライアントシークレット(ステップ1から)
export AB_CLIENT_SECRET='xxxxxxxxxx'
./extend-helper-cli-darwin_amd64 image-upload --login --work-dir <project-dir> --namespace <namespace> --app <app-name> --image-tag v0.0.1important- 上記のコマンドは、Extendアプリプロジェクトとは異なる作業ディレクトリから、別のターミナルで実行することをお勧めします。これにより、extend-helper-cliがExtendアプリ用の環境変数を誤って使用することを防ぎます。
- 以下のエラーが発生した場合は、解決手順についてトラブルシューティング:Dockerログインの失敗を参照してください。
Error saving credentials: error storing credentials - err: exit status 1, out: `error storing credentials - err: exit status 1, out: `The stub received bad data.`
イメージが正常にアップロードされると、Image Version Historyページにバージョンv0.0.1のイメージが表示されます。

Extendアプリの設定
アップロードしたExtendアプリをデプロイする前に、Extendアプリに必要な環境変数を設定する必要があります。アプリの詳細ページで、ローカルでExtendアプリを実行およびテストするために使用したのと同じ値で、以下の環境変数を設定します。
AB_CLIENT_IDAB_CLIENT_SECRET
Extend Overrideアプリがリリースv2024.02.13以前のテンプレートに基づいている場合は、PLUGIN_GRPC_SERVER_AUTH_ENABLED環境変数をtrueに設定してください。そうでない場合、Extendアプリのアクセストークン検証が無効になり、有効なアクセストークンなしでExtendアプリにアクセスされる可能性があります。
リリースv2024.02.13以降、Extend OverrideアプリテンプレートのPLUGIN_GRPC_SERVER_AUTH_ENABLEDはデフォルトでtrueに設定されています。アクセストークン検証は、PLUGIN_GRPC_SERVER_AUTH_ENABLEDが明示的にfalseに設定されている場合にのみ無効にできます。これに合わせて、Admin Portalを通じて作成されたすべての新しいExtendアプリには、デフォルトでPLUGIN_GRPC_SERVER_AUTH_ENABLED環境変数が設定されません。以前は、Admin Portalを通じて作成されたすべての新しいExtendアプリにPLUGIN_GRPC_SERVER_AUTH_ENABLED=falseが追加されていました。
Extendアプリのデプロイ
Extendアプリをデプロイするには、Deploy Latest Imageをクリックします。アプリのステータスがRUNNINGに更新されるまで待ちます。これは、Extendアプリが正常にデプロイされたことを示します。
AGSでExtendアプリを使用するように設定
Admin Portalで、Commerce > Customization > Loot Box Rollに移動します。Overridden byセクションの編集(鉛筆)ボタンをクリックして、既存の設定を編集します。

AccelByte hostedオプションを選択し、デプロイしたばかりのExtendアプリを選択します。Saveをクリックして完了します。

次のステップ
Extend Overrideアプリテンプレートを変更して、独自のカスタムロジックを実装してください。詳細については、こちらを参照してください。