Skip to content

Latest commit

 

History

History
84 lines (69 loc) · 4.85 KB

desktop.md

File metadata and controls

84 lines (69 loc) · 4.85 KB

Desktop installation and updates

Documentation · Developer README

Install a packaged release

Download the installer or AppImage from Releases. Workflow artifacts are also available on the run's summary page for 14 days. On Linux, keep the AppImage in a user-writable location, run chmod +x on it, and launch it. AppImage mounting may require your distro's FUSE 2 compatibility package; the GPU/display runtime requirements in the developer README still apply. Do not extract the AppImage or run a bare executable if you want automatic updates.

Automatic desktop updates

The packaged app checks public GitHub Releases in the background at most once every 24 hours, including during long editor sessions. It downloads newer versions for its own OS/architecture and verifies package size and checksums. Full packages are published initially; delta packages are not required. No update server, end-user GitHub login, or embedded GitHub token is needed.

Help → Check for updates… bypasses the daily limit and opens the update window. That window also controls automatic checking/downloading. Disabling it stops future automatic checks; a check already in progress may finish, and an already downloaded update will still install on the next launch. Failed checks leave the app usable and can be retried manually. The Update ready button appears after a download completes. Installation happens on the next launch, or through Restart now. BenchUp does not force a restart during editing.

Restart now offers to save modified work as a project file (.bup by default; .ketchup is also supported), or keep it in local recovery. It saves the model and its project-file association before closing; a save failure prevents restart. Finish drawing/modeling previews before restarting. Autosave, update preferences, and restart information stay in the existing application data directory outside the installed application. BENCHUP_DATA_DIR redirects them for testing. Browser builds do not include Velopack; development builds and unpackaged executables do not contact the update service.

Users of older bare executables must manually install one updater-enabled release. Subsequent releases update through Velopack. GitHub's unauthenticated API limits apply, so networks with many users behind one IP may need retries; the update source can later move to a static HTTPS feed.

Release notes

Open Help → Release notes to browse the release history. The modal works offline, opens on the latest release, and lets you browse every release using the version picker or Newer / Older buttons. On the first launch of a new version, the release notes open automatically if you haven't viewed them yet. The last viewed release version is saved immediately across app restarts and browser reloads, so the modal appears automatically only once per release. You can reopen it at any time from Help → Release notes.

Project files and thumbnails

Launch BenchUp once after installing so Linux and Windows can register .bup with the desktop. Choose BenchUp in Open with if another app owns the extension. macOS registers the document type from the installed application bundle. Opening a project uses the existing save/discard/cancel prompt when local recovery contains unsaved work.

Desktop and browser saves embed a viewport preview when GPU capture is available. Save older projects once to add it. The browser cannot install desktop file associations or thumbnail handlers; launch the installed desktop app once to register them, even if you normally edit in the browser. Explorer uses the system image thumbnail provider; Finder uses PNG type conformance; Linux desktops use the installed freedesktop thumbnailer. Linux registration prefers the system Glycin or GdkPixbuf image thumbnailer so GNOME's sandbox can access it even when BenchUp runs from your home directory or an AppImage. Thumbnail display must be enabled in the file manager. Linux desktops without freedesktop thumbnailer support may need their own thumbnail plugin.

The preview container is a valid PNG with gzip JSON in the private buPd ancillary chunk (CRC checked on opening). Do not edit or optimize project files with an image editor: it may discard project data. Previous BenchUp versions cannot open this format. Existing gzip and plain JSON projects remain readable. benchup-app --thumbnail input.bup output.png extracts the image without launching the editor or initializing a GPU.

benchup-app --convert input.skp output.bup converts a SketchUp file to a project without a window or GPU. The result matches File → Import SketchUp into an empty model followed by Save, except that it has no viewport preview. The project is named after the output file, and the SketchUp group after the input file. Use a .bup output path.