Godot クイックスタート

対象読者：Godot 4.x プロジェクトにフィードバックパネルを組み込む開発者。

このクイックスタートは、addon が res://addons/echo_nebula_feedback/ にコピーされ、Godot のプラグイン画面で有効化済みであることを前提にしています。プラグインは EchoNebulaFeedback autoload singleton を登録します。

プラグインを有効にしてから、ゲームのルートで quickstart.gd.txt を quickstart.gd としてコピーし、設定・アタッチします。テキストテンプレートは autoload 登録前に解析されません。

拡張例

安定した最小例は canonical core だけを含みます。以下の拡張例では、任意の runtime context と feature control も追加します。

以下の拡張呼び出しは既存のゲーム関数内に置きます。新しい Node に直接アタッチできる完全なスクリプトは、固定 ZIP の quickstart.gd と主 Quickstartを利用してください。

EchoNebulaFeedback.configure({
  "project_key": "enb_pk_xxx",
  "public_api_base_url": "http://localhost:4000",
  "environment": "local",
  "release": "0.1.0",
  "build_id": "dev-build-001",
  "locale": "auto",
  "enable_screenshot": true,
  "enable_recent_logs": true,
  "enable_breadcrumbs": true,
  "offline_queue": true,
  "hotkey": KEY_F8
})

EchoNebulaFeedback.set_player({
  "player_id_hash": "sha256:337180dda29405211bf7a37ea531367110370dc54db2298fcf4450f1749badb3"
})

EchoNebulaFeedback.set_context({
  "scene": "res://scenes/main.tscn",
  "level": "demo"
})

EchoNebulaFeedback.open_feedback_panel({ "trigger_source": "button" })

enable_screenshot と enable_recent_logs はパネルで選択肢を表示するための機能フラグです。デフォルトで同意チェックを入れるものではありません。プレイヤーが手動で選択した場合だけ、SDK はスクリーンショットまたは最近のログをアップロードします。

SDK は configure() の後に Project Key で GET /v1/sdk/config から SDK config を読み取ります。必要に応じて refresh_sdk_config() で明示的に更新できます。プレイヤーが送信すると、SDK は feedback_report payload を作成して Public API の POST /v1/feedback/reports に送信します。プレイヤーが明示的に選択した添付は、返却された feedback_id を使って /v1/feedback/reports/{feedback_id}/attachments にアップロードされます。API を利用できない場合、offline_queue が後続 flush のために payload を保持します。管理操作は /admin/v1/* にあり、developer session が必要です。

よくある間違い

Project Key は Public API の SDK config を読み取り、feedback または consent で許可された attachment を送信できます。Admin API の feedback data を読んだり管理操作を行ったりしてはいけません。
プレイヤーがスクリーンショットを選択していない場合、SDK はスクリーンショット添付をアップロードしてはいけません。
プレイヤーが連絡先を空にした場合、payload に連絡先を含めないでください。
feedback_payload_ready イベントだけを配信完了の証拠にしないでください。Admin API または Developer Console で report と添付の到着を確認してください。

次のステップ

Godot addon のインストールを読んでください。