echo-nebula Alpha 概要

対象読者：Godot ゲームにプレイヤー主導フィードバックを導入または評価する開発者。

echo-nebula は Godot 優先のフィードバック収集システムです。プレイヤーはボタン、F8、メニュー、またはコードからフィードバックパネルを開き、説明を入力し、スクリーンショット、最近のログ、連絡先を含めるかどうかを明示的に選択します。Alpha ドキュメントは contracts version 0.4.0-alpha.1 に合わせています。

P0 の流れは、開発者登録、組織とプロジェクト作成、project key 発行、Godot SDK 初期化、プレイヤーのプライバシー確認、public API への書き込み、同意がある場合の添付アップロード、admin API での確認です。

ローカルスタックから最初のフィードバックまで

ローカル開発に従って PostgreSQL、MinIO、public API、admin API、Developer Console、docs site を起動し、./scripts/e2e-all.sh でスタックが使えることを確認します。
開発者コンソールを開き、開発者登録、組織作成、プロジェクト作成、Project Key 発行を行います。Project Key は Public API の GET /v1/sdk/config、POST /v1/feedback/reports、consent で制限された attachment route だけに使います。Console の /admin/v1/* 管理操作には developer session を使います。
Godot クイックスタートに従って addon をインストールし、public_api_base_url と project key を設定し、ボタン、メニュー、F8、またはコードの trigger を接続します。
最初のフィードバック送信に従ってゲーム内パネルを開き、説明を入力し、スクリーンショット、最近のログ、連絡先アップロードをプレイヤーが明示的に選択します。
Developer Console のフィードバック詳細ページに戻り、status、attachments、contact data、comments、audit records を確認します。生の request を調べる場合は Admin API を参照します。

最小例

EchoNebulaFeedback.configure({
  "project_key": "enb_pk_xxx",
  "public_api_base_url": "http://localhost:4000",
  "locale": "auto"
})
EchoNebulaFeedback.open_feedback_panel({ "trigger_source": "button" })

X-Project-Key は public API 専用です。管理側の読み取りや操作には admin API から取得した開発者 JWT を使います。

よくある間違い

スクリーンショットをデフォルトでアップロードしないでください。プレイヤーの手動選択が必要です。
連絡先を静かにアップロードしないでください。プレイヤーが入力または確認する必要があります。
echo-nebula をクラッシュ監視基盤として扱わないでください。P0 の中心オブジェクトは feedback_report です。
Project Key で Admin API のデータ読み取りや管理操作を行わないでください。認証できるのは公開済みの Public API SDK-config / feedback-ingestion route だけです。

次のステップ

ローカル開発から始め、続いて Godot クイックスタートを読んでください。