Files

T

Lilia_Chenandautofix-ci[bot] c6c0494998 feat(stage-tamagotchi-godot): add Godot stage G0 sidecar preview (#1724 )

## Summary

Add the G0 Godot Stage sidecar preview for `stage-tamagotchi`.

## Design

- Keep Electron as the desktop host and run Godot as a separate sidecar
window by design.
- Use the settings window as the entry point for starting/stopping the
experimental Godot Stage.
- Require explicit `GODOT4` in development mode instead of
auto-discovering local Godot installs.
- Use the packaged sidecar under `process.resourcesPath/godot-stage` in
the packaged runtime.
- Close the Godot WebSocket lifecycle channel on startup failure and
stage shutdown.

## Changes

- Add the Electron main-side Godot Stage lifecycle service.
- Add renderer/settings wiring for switching to the experimental Godot
Stage.
- Add the minimal Godot stage runtime skeleton and WebSocket handshake
path.
- Add Godot export presets for sidecar builds.
- Add sidecar path verification for the Godot export preset and
`electron-builder` resource contract.
- Document the development runtime setup and packaging expectations.

## CI/CD

- Align Godot CI to `4.6.2`.
- Add Linux Godot export smoke coverage as the fastest CI export path.
- Add sidecar contract verification to CI.
- Run packaged sidecar verification after `electron-builder --dir`.

CD is intentionally deferred in this PR. The release workflow still
needs a later step to export the Godot sidecar before packaging release
artefacts.

---------

Co-authored-by: autofix-ci[bot] <114827586+autofix-ci[bot]@users.noreply.github.com>

2026-04-25 00:56:03 +08:00

3.9 KiB

Raw Blame History

`@proj-airi/stage-tamagotchi-godot`

Godot-native desktop stage runtime project for stage-tamagotchi.

What It Does

Hosts the Godot project used as the desktop-only stage runtime baseline.
Provides the minimal scene, script, and .NET project structure for G0 stage work.
Keeps Godot-owned assets, scenes, scripts, and future add-ons local to one workspace engine.

What It Is Not

It is not the Electron host app.
It does not own AIRI agent logic or adaptation-layer IPC contracts.
It is not a web or mobile renderer package.

Current Scope

Desktop-only Godot sidecar runtime exploration for stage-tamagotchi.
Godot C# project structure and minimal runtime skeleton.
Early-stage scene and runtime validation work.

Directory Layout

scenes/: Godot scene files such as the current stage root.
scripts/: C# runtime scripts attached to Godot nodes.
assets/: Imported models, textures, materials, and other runtime assets.
addons/: Godot plugins, editor/runtime add-ons, or vendored third-party Godot extensions.

When To Use It

Use it when working on the Godot-backed desktop stage runtime.
Use it for Godot scene, asset, rendering, and character-runtime work.
Use it as the engine boundary for the desktop Godot stage project itself.

When Not To Use It

Do not put Electron main/renderer host logic here.
Do not put AIRI agent orchestration or cross-process protocol definitions here.
Do not use it as a generic cross-platform stage abstraction package.

Build

pnpm -F @proj-airi/stage-tamagotchi-godot build
pnpm -F @proj-airi/stage-tamagotchi-godot typecheck

Both commands currently run dotnet build against the Godot-generated C# project file.

Development Runtime

The Electron development app does not export this project on every dev run. When Godot Stage is started from the Tamagotchi settings page, Electron main starts a local WebSocket bridge and launches a local Godot engine against this project:

godot --path ./engines/stage-tamagotchi-godot -- --airi-ws-url=<runtime-url>

Set GODOT4 before starting the Electron development app. Dev mode requires an explicit Godot executable path and does not auto-discover local installations.

PowerShell:

$env:GODOT4 = "C:\Path\To\Godot_v4.x-stable_mono_win64.exe"
pnpm dev:tamagotchi

macOS / Linux:

GODOT4="/path/to/godot" pnpm dev:tamagotchi

With GodotEnv:

GODOT4="$(godotenv godot env path)" pnpm dev:tamagotchi

Keep machine-specific Godot paths outside the repository. The current Electron main service reads process.env.GODOT4, so the shell or local development environment must provide it before starting pnpm dev:tamagotchi.

Exporting

Export presets produce the sidecar runtime that Electron packages for release:

godot --headless --export-release "Windows Desktop" build/win/godot-stage.exe
godot --headless --export-release "Linux" build/linux/godot-stage
godot --headless --export-release "macOS" build/mac/godot-stage.app

The output directories intentionally match electron-builder's ${os} names:

Windows: build/win
Linux: build/linux
macOS: build/mac

apps/stage-tamagotchi/electron-builder.config.ts copies the matching directory into resources/godot-stage via extraResources. To inspect an unpacked Electron build locally, run:

pnpm -F @proj-airi/stage-tamagotchi run build:unpack

Notes

Environment Management

Recommended to use GodotEnv to manage Godot versions.

You can use the command below to set current Godot version for this project:

godotenv godot use 4.6.2

Then run the Godot editor with the current project:

"$(godotenv godot env path)" ./engines/stage-tamagotchi-godot/project.godot

You can also run the game directly from the command line:

"$(godotenv godot env path)" --path ./engines/stage-tamagotchi-godot

3.9 KiB Raw Blame History

@proj-airi/stage-tamagotchi-godot