Desktop App

OpenRive ships a desktop build made with Electrobun: a small native window around the same editor, with the embedded PostgreSQL database in your user data folder. No browser tab, no server to start.

Download

Every release has installers attached, built on GitHub Actions:

Platform	File
macOS (Apple Silicon)	macos-arm64-OpenRive.dmg
Windows	win-x64-OpenRive-Setup.zip
Linux	linux-x64-OpenRive-Setup.tar.gz

Builds for a branch or pull request are available as workflow artifacts from the Desktop workflow run.

Releasing (maintainers)

Releases are made from the Desktop workflow — no version-bump commit needed:

1. Actions › Desktop › Run workflow.
2. Choose what to release: patch (default), minor, major, or none for artifacts only.
3. Optionally tick pre-release or draft, and pick the Electrobun channel.

The workflow takes the newest v* tag, increases it, stamps that version into electrobun.config.ts and the package manifests, builds on macOS, Windows and Linux, creates the tag, and publishes a GitHub release with all installers attached and generated release notes.

Pushing a tag by hand still works and releases exactly that version:

git tag v1.2.0 && git push origin v1.2.0

Version numbers therefore live in the tags; the version fields in the repository are only defaults for local builds.

How it works

• The main process (Bun, bundled) starts the Next.js standalone server on a free local port and opens a window on it.
• Projects live in the platform's user data folder (Utils.paths.userData/data), in the embedded database.
• Setting DATABASE_URL before launching points the app at a shared PostgreSQL instead, so a team can use the same projects from the desktop app and a self-hosted server.

Building it yourself

bun install
bun run --cwd apps/desktop build:server     # Next.js standalone bundle
bun run build:desktop                       # hutch/electrobun build --env=stable

Artifacts land in apps/desktop/artifacts/. Electrobun does not cross-compile: build each platform on that platform.

Requirements: Bun 1.4+, plus the platform toolchain Electrobun needs (Xcode command line tools and cmake on macOS; Visual Studio Build Tools and cmake on Windows; build-essential cmake pkg-config libgtk-3-dev libwebkit2gtk-4.1-dev libayatana-appindicator3-dev libpipewire-0.3-dev librsvg2-dev on Ubuntu). The first build downloads the Electrobun toolchain into ~/.hutch.

To run it in development:

bun run desktop        # builds the server bundle, then electrobun dev

App icon

The icon is the OpenRive logo (apps/web/public/logo.svg) on a white rounded square, the same badge the web app shows in its header:

Path	Used for
apps/desktop/assets/icon-win.png (256×256)	Windows: Hutch converts it to the .ico used by the installer, shortcuts and taskbar
apps/desktop/assets/icon.png (512×512)	Linux
apps/desktop/assets/icon.iconset/	macOS, converted to .icns by iconutil on the macOS runner

Windows must be 256×256 at most — that is the largest image an .ico can hold, and a bigger PNG fails the build with invalid Windows PNG icon: PngTooLarge.

To regenerate them after changing the logo, render logo.svg onto a white rounded square (corner radius 22% of the size, logo at 70%) and export PNGs at 16, 32, 48, 64, 128, 256, 512 and 1024 px. The .iconset folder needs icon_16x16.png, icon_16x16@2x.png, icon_32x32.png, icon_32x32@2x.png, icon_128x128.png, icon_128x128@2x.png, icon_256x256.png, icon_256x256@2x.png, icon_512x512.png and icon_512x512@2x.png, where each @2x file is the next size up.

Files

Path	What
apps/desktop/src/bun/index.ts	Main process: starts the server, opens the window
apps/desktop/assets/	Application icons
apps/desktop/src/mainview/	Fallback view shown if the server does not start
apps/desktop/electrobun.config.ts	App name, identifier, bundle contents
scripts/bundle-desktop-server.ts	Builds and stages the standalone server
.github/workflows/desktop.yml	Per-OS builds and artifact upload

---

_{This page is generated from docs/desktop.md. Suggest an edit.}