BrickVerse Installer

A single Electron/TypeScript application that installs, updates, repairs, launches, or removes the BrickVerse Game Client, BrickVerse Creator, and BrickVerse Guild Chat. Electron bundles the required runtime; users do not need Node.js.

The installer is also the installed brickverse:// protocol handler and file handler for BrickVerse projects, worlds, models, animations, and addons. Product shortcuts route through it so an enabled product update is applied before launch. Guild Chat can also be launched through brickverse://guild-chat.

Install directories

• Windows: %LOCALAPPDATA%\Programs\BrickVerse and %LOCALAPPDATA%\Programs\BrickVerse Creator; Guild Chat uses %LOCALAPPDATA%\Programs\BrickVerseGuildChannels
• macOS: ~/Applications/BrickVerse.app and ~/Applications/BrickVerse Creator.app
• Linux: ~/.local/share/brickverse/client and ~/.local/share/brickverse/creator

Guild Chat is installed from the newest usable cross-platform ZIP release in BrickVerse-co/guild-channel-binaries. Empty releases are skipped automatically; the older Windows NSIS artifact remains supported for migration.

These locations are writable without administrator access. The setup UI can select a different location for either product. That location is stored with the product metadata and is used by launching, updating, and removal.

Product updates

Updates are installed as a complete staged replacement. The replacement is downloaded, extracted, and validated before the current directory is renamed. If activation fails, the previous directory is restored. Reinstalling first is not required, and uninstalling before an update is no longer supported or necessary.

Development

npm install
npm run dev

Preview the launch-time update UI without downloading or changing an installed product:

npm run demo:update
npm run demo:update:creator
npm run demo:update:guild-chat

Run protocol regression checks with npm run test:protocol.

Build only the Windows installer:

npm run dist:win

Build all packages supported by the current operating system:

npm run dist

Output is written to release/.

GitHub Releases / auto-update

The electron-builder publish target currently points to:

BrickVerse-co/installer

Change build.publish.repo in package.json if the Electron installer is kept in another repository.

Push a version tag to publish:

npm version patch
git push
git push --tags

The packaged application checks GitHub Releases shortly after startup. Windows and macOS update metadata is generated by electron-builder.

macOS automatic updates require a signed application. Configure the signing and notarization secrets used by .github/workflows/release.yml.

Linux does not have the same native updater mechanism as Windows/macOS. The AppImage build can download updates through electron-updater when GitHub release metadata is available, while DEB installations should generally be updated by installing the next DEB package.

Build artifact names

The installer matches the current game workflows:

App	Windows	Linux	macOS package
Client	BrickVerse.exe	BrickVerse.x86_64	BrickVerse-macOS.zip
Creator	BrickVerseCreator.exe	BrickVerseCreator.x86_64	BrickVerseCreator-macOS.zip
Guild Chat	BrickVerseGuildChannels-win-x64.zip	BrickVerseGuildChannels-linux-{arch}.zip	BrickVerseGuildChannels-mac-universal.zip