IGP Developer Docs の読み方

IGP Developer Docs は、ゲーム開発者向けの公式ドキュメント入口です。このページでは、推奨される読む順番と、各種ページが何を扱うかを説明します。

現在の最初の公開内容は、ゲームへ IGP プラットフォーム機能を導入することを中心にしています。ドキュメントは次の 3 層で構成されています。

機能別に使う: SDK が提供する機能、各機能をサポートするエンジン、同じ機能を各エンジンでどう導入するかを説明します。
エンジン別導入詳細: Unity、GameMaker、Godot のインストール、Quick Start、デバッグ、サンプルプロジェクトを補足します。
パッケージ別導入ガイド: 具体的な SDK パッケージについて、インストール組み合わせ、API の使い方、導入例、リクエスト / レスポンス項目、パラメータの意味、エラー処理、現在の制限を説明します。

このサイトの読み方

初めて導入する場合は、次の順番で読むことをおすすめします。

まず機能概要で、IGP SDK が現在提供する機能と、対象エンジンでの対応状況を確認します。
次に起動と接続で、appId、IGP デスクトップクライアント接続、初期化方法を確認します。
エンジン別導入詳細から、利用するエンジンのインストール、Quick Start、デバッグ手順を読みます。
Unity のオプションパッケージを使う場合は、対応するパッケージ別ガイドを読みます。たとえばランキングと共有機能は Unity 概要、Unity インストール、または左側サイドバーの GameKit / Leaderboard / Share から開けます。
導入後はテストに沿ってローカルフローを確認します。
パッケージを更新またはダウンロードする場合は、最後にリリースノートと Changelog を確認します。

パッケージ別ページは、各パッケージ内の Documentation~/DEVELOPER-GUIDE.zh-CN.md から同期生成されます。今後、公開される各パッケージには対応する Web ページを用意し、詳細な導入例、項目定義、パラメータ説明、インターフェイス制限を確認できるようにします。

これらのドキュメントが扱う IGP プラットフォーム機能は主に次のとおりです。

ゲーム認可: 起動時に、現在のプレイヤーが IGP 上でそのゲームを正しく所有しているか確認します。
ルーム: ルームの作成 / 参加 / 退出、および ready、start、finish のライフサイクルイベントを扱います。
リアルタイム通信: ルーム内プレイヤー間の信頼性付きメッセージ通信を提供し、大きなデータは自動分割されます。
状態と RPC: プレイヤー状態を端末間で同期し、ルーム内の他プレイヤーのロジックを呼び出します。
実績: 実績の解除と進捗報告を行います。
実名認証とアンチアディクション: 現在プレイ可能か、および状態変化の理由を読み取ります。「起動ブロック」と「ゲーム内実名認証」の 2 つの処理方式をサポートします。

エンジン	利用可否	説明
Unity	✅ Preview	現在の主要な提供エンジンです。機能カバーが最も広く、ドキュメントも最も充実しています。
GameMaker	⚠️ Preview	ゲーム認可、実名認証とアンチアディクション、実績の主要フローをサポートします。ルーム機能はまだ未対応です。
Godot	🚧 開発中	まだ公開パッケージはありません。
Unreal	⏳ 予定	まだ開始していません。

初めて読む場合は、まず機能別に SDK を使うで現在の機能範囲を確認してください。
対象機能が決まっている場合は、該当する機能ページで対応エンジン、前提条件、セルフテスト方法を確認してください。
インストール、Quick Start、デバッグ手順が必要な場合は、エンジン別導入詳細を参照してください。
Unity オプションパッケージの項目、パラメータ、完全な呼び出し例が必要な場合は、GameKit / Leaderboard / Share などの対応するパッケージ別ガイドを参照してください。
どの機能を導入する場合も、先に起動と接続を確認し、現在のビルドで IGP SDK を有効にするか決めてください。
導入後はテストの内容に沿って確認してください。
Unity の最小フローを検証する場合は、Unity Quick Start を参照してください。
GameMaker の最小フローを検証する場合は、GameMaker Quick Start を参照してください。
現在のバージョンとダウンロードを確認する場合は、リリースノートを参照してください。