In-game overlay

Install & pair

Download the overlay, launch it, and complete Steam OpenID pairing in two minutes.

1. Download

From your dashboard's Setup → Overlay tab, download the installer for your OS:

  • Windows: .msi installer.
  • macOS: .dmg (Universal: Intel + Apple Silicon).
  • Linux: .AppImage (or .deb for Debian/Ubuntu).

Unsigned beta builds will trigger SmartScreen (Windows) or Gatekeeper (macOS). Right-click → Open on macOS, More info → Run anyway on Windows. The retail builds are signed and won't show those warnings.

2. Launch

A small chromeless window appears in the top-left of your primary monitor with the Rust Pulse logo and a Sign in with Steam button.

3. Pair with Steam

Click Sign in with Steam. Your default browser opens Steam's OpenID confirmation page. After you confirm, the overlay polls the API and finishes pairing automatically — the device token is stored in your local OS keychain via @tauri-apps/plugin-store.

4. Pick a paired server

Once paired, the overlay shows your paired-server list. Pick one. The overlay subscribes to that server's relay socket and starts rendering markers.

5. Enter the game

  • Run Rust in Fullscreen Borderless or Windowed. Exclusive fullscreen blocks all overlays.
  • Press F8 in-game to toggle visibility.
  • Press F9 to toggle click-through.

Deploy ordering matters (developers)

The overlay's bundled API base points at the production Rust Pulse API. The Steam-OpenID device-pairing endpoints only exist on freshly-deployed API revisions. When cutting a new overlay release that touches the pairing flow, deploy the API first, then ship the overlay — otherwise users hit a 404 on the pairing call.