ゲームとAPI
説明
ユーザーガイド
各ゲームのAPIをサーバーに接続できます。メンバーは自分のアカウントを連携し、統計を確認し、ゲームサーバーの稼働状況を追い、ランキングで競い合えます。23のゲームがすぐに使える状態で用意されており、自分で追加することもできます。
機能
- 各メンバーが自分のゲームアカウントを連携できます。
- 必要に応じてプレイヤーの統計を表示します。
- ゲームのサーバー稼働状況を、常に更新されるメッセージで投稿します。カウンター用のボイスチャンネル名を変更することもできます。
- ゲームのニュースをチャンネルに自動配信します。
- アカウントを連携したメンバーのランキングを生成します。
- 一部のゲームのデータベースを検索できます。
- コンストラクターを使えば、コードを書かずにJSONを返す任意のAPIを接続できます。
クイックスタート（管理者）
- ダッシュボードを開き、ゲームとAPIモジュールのカタログタブを選びます。
- 目的のゲームを見つけて有効化をクリックします。ゲームの設定画面がすぐに開きます。
- ゲームに「キーが必要」と表示されている場合は、APIキーのカードにご自分のキーを貼り付けます。「TennoCoreのキー」と表示されている場合は、すでにキーが用意されているため何もする必要はありません。
- 必要に応じて自動処理を有効にします：ニュース、稼働状況、ランキング。それぞれチャンネルと間隔の指定が必要です。
- テストボタンでAPIが応答することを確認し、保存します。
- メンバーに
/game listを案内してください。利用できるゲームを確認し、/game linkでアカウントを連携できます。
コマンド
すべてのコマンドは全メンバーが利用でき、アカウントの連携に関わるものは非公開で応答します。
| コマンド | 説明 |
|---|---|
/game list | サーバーで有効になっているゲームと、それぞれができることを一覧表示。 |
/game link | 選んだゲームにアカウントを連携するフォームを開く。 |
/game unlink | そのゲームにおける自分のアカウントの連携を解除。 |
/game stats | メンバーの統計を表示（初期値は自分自身）。 |
/game status | ゲームのサーバー稼働状況を表示。 |
/game lookup | ゲームのデータベース内の項目を検索。 |
/game leaderboard | アカウントを連携したサーバーメンバーをランキング表示。 |
Botに付属するゲーム
23のコネクターが用意されています。それぞれが1つ以上の機能を提供します：プレイヤー統計、サーバー稼働状況、ニュース、検索。
| ゲーム | 機能 | APIキー |
|---|---|---|
| Apex Legends | プレイヤー統計 | 必要 |
| Brawl Stars | プレイヤー統計 | 必要 |
| Chess.com | プレイヤー統計 | 不要 |
| Clash Royale | プレイヤー統計 | 必要 |
| Destiny 2 | プレイヤー統計 | 必要 |
| Epic Games – 無料ゲーム | ニュース | 不要 |
| Fortnite | プレイヤー統計 | 必要 |
| Free-To-Game – F2Pの新作 | ニュース、検索 | 不要 |
| Genshin Impact | プレイヤー統計 | 不要 |
| Hypixel (Minecraft) | プレイヤー統計 | 必要 |
| League of Legends | プレイヤー統計、サーバー稼働状況 | 必要 |
| Lichess | プレイヤー統計 | 不要 |
| Minecraft – プレイヤー | プレイヤー統計 | 不要 |
| Minecraft – サーバー | サーバー稼働状況 | 不要 |
| osu! | プレイヤー統計 | 必要 |
| Pokédex (PokéAPI) | 検索 | 不要 |
| RAWG – ゲームデータベース | 検索、ニュース | 必要 |
| Roblox | プレイヤー統計 | 不要 |
| Status（汎用Statuspage） | サーバー稼働状況 | 不要 |
| Steam – ゲームのニュース | ニュース | 不要 |
| Steam – プロフィール | プレイヤー統計 | 必要 |
| Valorant | プレイヤー統計 | 必要 |
| Warframe – ワールド | サーバー稼働状況、ニュース | 不要 |
ダッシュボードでの設定
このモジュールは5つのタブで構成されています。
- カタログ — 利用できるすべてのゲーム。カテゴリや名前で絞り込めます。各カードにはゲームの機能とキーの必要性が表示されます。有効化、複製（既存のコネクターをもとに作成）のボタンと、APIのドキュメントへのリンクがあります。
- マイゲーム — このサーバーで有効になっているゲーム：状態、有効な自動処理、連携アカウント数、キーの提供元、直近に発生した問題。設定ボタンから各項目を開けます。
- 一般：ゲームを有効にするか一時停止するか、およびアカウントを連携したメンバーに自動付与するロール。
- APIキー：あなたのキー。暗号化して保存され、再表示されることはありません。変更しない場合は空欄のままにしてください。
- コネクターの設定：ゲーム固有の設定項目（SteamのアプリケーションID、リージョンなど）。
- ニュース：チャンネル、間隔（5〜1440分、初期値は30）、必要に応じてメンションするロール。
- 稼働状況：パネルを投稿するチャンネル、間隔（初期値は10分）、カウンター用のボイスチャンネルと使用する名前のテンプレート。
- ランキング：チャンネル、間隔（初期値は60分）、基準となる統計項目の案内。
- 各自動処理には今すぐ投稿ボタンがあります。
- コンストラクター — 独自のコネクターの作成：基本情報、認証、メンバーに入力させる項目、呼び出しの手順、生成するメッセージの定義。テストベンチでは実際にAPIを呼び出し、応答のツリー構造を表示します。値をクリックするとそのパスをコピーでき、表示設定にそのまま利用できます。
- プレイヤー — サーバー内の連携済みアカウントの一覧。メンバーの連携を解除することもできます。
- ログ — APIへの直近50件の送信呼び出し。所要時間、結果、エラーの詳細が表示されます。
知っておきたいこと
- ゲームは有効化しなければ存在しません。 コマンドの自動補完に表示されるのは有効化されたゲームのみで、さらにそのコマンドに対応したゲームだけです。ニュースのみを提供するゲームは
/game statsには表示されません。 - 連携はその場で検証されます。
/game linkは実際にAPIを呼び出します。アカウントが見つからない場合は何も保存されず、メンバーにはゲーム側が返したエラーが表示されます。したがって、連携済みのアカウントは必ず有効なアカウントです。 - 連携フォームはDiscordの制約により5項目までに制限されています。
- APIキーはハイブリッド方式です。 常にあなたのキーが優先され、それがない場合はTennoCoreの共通キーが存在すれば使用されます。自分のキーを登録すると、専用の利用枠が得られます。登録したキーがインターフェイスに再表示されることはありません。
- 利用枠：コネクターごとに呼び出し上限が定められています（一般に1サーバーあたり毎分30回）。これを超えると、Botは1分待つよう応答します。応答は数分間キャッシュされるため、繰り返しのリクエストは吸収されます。
- ランキング：問い合わせ対象は最大40件の連携アカウントで、上位20件が表示されます。サーバーの利用枠を使い切らないよう、呼び出しは意図的に間隔を空けています。連携メンバーが多い場合は、広い間隔を設定してください。コネクターが基準となる統計項目を定義していない場合、ランキングは空のままになります。
- ニュースフィードの初回実行時は何も投稿されず、Botは既存の履歴を記録するだけです。これはチャンネルを大量の投稿で埋めないための仕様です。投稿は次回の実行から始まります。
- カウンター用のボイスチャンネル：Discordは10分あたり2回しか名前の変更を許可していません。間隔が短すぎる場合、Discord側で通知なく無視されます。
/game listは最大25件のゲームを表示し、自動補完は25件の候補を表示します。- ゲームを削除すると、その設定とニュースの履歴は消去されますが、メンバーの連携アカウントは保持されます。
- このモジュールのメッセージはDiscordの新しい表示形式を使用しています。各項目がそれぞれ1行を占め、列に並ぶことはありません。
- 独自のコネクター：呼び出すアドレスは公開されたAPIを指している必要があります。内部または非公開のアドレスは、セキュリティ上の理由で拒否されます。
- 呼び出しのログは7日間保持されます。
- このモジュールはダッシュボードの「開発中」カテゴリに含まれており、インターフェイスは今後変更される可能性があります。