Skip to content

ELECTROBUN-SHOWCASE.md

Latest commit

 

History

History
79 lines (52 loc) · 2.5 KB

ELECTROBUN-SHOWCASE.md

File metadata and controls

79 lines (52 loc) · 2.5 KB

Electrobun x gametau Showcase

This is the quickest way to try gametau running in Electrobun after the upstream WGPU release.

What this covers

gametau now supports two Electrobun shell shapes:

  • BrowserWindow + embedded <electrobun-wgpu> for the hybrid path
  • GpuWindow for a native WGPU shell that still reuses the shared Rust/WASM backend loop

The fastest reference example is examples/electrobun-counter.

Try it in 2 minutes

From repo root:

bun install
bun run --cwd packages/webtau build
bun run --cwd packages/webtau-vite build

Launch the hybrid BrowserWindow path:

bun run --cwd examples/electrobun-counter dev:electrobun:hybrid

Launch the GPUWindow path:

bun run --cwd examples/electrobun-counter dev:electrobun:gpu

What you should see:

  • Hybrid mode: a native Electrobun window loads the Vite app, the counter UI works normally, and an embedded native WGPU surface runs inside the same BrowserWindow.
  • GPU mode: a native GpuWindow opens and the shared counter state advances through the WASM-backed game loop.

Why hybrid first

This path is sequenced before pure GpuWindow because it proves the render/UI split with lower risk:

  • existing DOM HUD and controls stay intact
  • native WGPU rendering is exercised in the same app shell
  • resize, masking, passthrough, and overlay behavior can be validated before broader renderer refactors

Scaffold a project

bunx create-gametau my-game --desktop-shell electrobun
bunx create-gametau my-game --desktop-shell electrobun --electrobun-mode dual

The generated scaffold keeps the web/Tauri path intact and adds:

  • electrobun.config.ts
  • src/bun/browser.ts
  • src/bun/gpu.ts
  • dev:electrobun / build:electrobun scripts

Build desktop packages

bun run --cwd examples/electrobun-counter build:electrobun:hybrid
bun run --cwd examples/electrobun-counter build:electrobun:gpu

Shared state note

Chrome, Tauri, BrowserWindow Electrobun, and GPUWindow Electrobun are separate runtimes. They do not share in-memory state automatically. If you need continuity across runtimes, use a shared backend or persistence layer.

Useful links