echo-nebula Alpha Overview

Target reader: developers evaluating or integrating player-initiated feedback in a Godot game.

echo-nebula is a Godot-first feedback collector. Players open a feedback panel from a button, F8, a menu, or code, write a description, and explicitly choose whether to include a screenshot, recent logs, or contact information. The Alpha docs track contracts version 0.4.0-alpha.1.

The P0 path is developer registration, organization and project setup, project key creation, Godot SDK initialization, player confirmation, public API write, attachment upload when consent allows it, and admin API review.

From local stack to first feedback

1. Follow Local development to start PostgreSQL, MinIO, the public API, admin API, Developer Console, and docs site, then run ./scripts/e2e-all.sh to prove the stack is usable.
2. Open the Developer Console, register a developer, create an organization and project, then create a Project Key. Use the Project Key only with Public API GET /v1/sdk/config, POST /v1/feedback/reports, and the consent-gated attachment route; Console management uses the developer session and /admin/v1/*.
3. Follow the Godot quickstart to install the addon, set public_api_base_url and the project key, and wire a button, menu, F8, or code trigger.
4. Follow Send the first feedback to open the in-game panel, write a description, and let the player explicitly choose screenshot, recent logs, and contact upload.
5. Return to the Developer Console feedback detail page to review status, attachments, contact data, comments, and audit records; use the Admin API page when debugging raw requests.

Minimal example

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

Use X-Project-Key only with the public API. Admin reads and management actions use a developer JWT from the admin API.

Common mistakes

• Do not upload screenshots by default. The player must manually opt in.
• Do not silently upload contact information. The player must enter or confirm it.
• Do not treat echo-nebula as a crash monitoring platform. The P0 object is feedback_report.
• Do not use a Project Key for Admin API reads or management. It authenticates only the published Public API SDK-config and feedback-ingestion routes.

Next step

Start with Local development, then continue with the Godot quickstart.