Table of Contents

Samples

The repository ships four runnable console apps under samples/ that fit together as one flow:

flowchart LR
    Reg["RustPlus.Register.ConsoleApp<br/>(one-time setup)"] --> Cfg["rustplus.config.json<br/>+ RustPlus(...) args"]
    Cfg --> Fcm["RustPlus.Fcm.ConsoleApp<br/>(listen for pairing / alarms)"]
    Cfg --> App["RustPlus.ConsoleApp<br/>(query / control the server)"]
    Cfg --> Cam["RustPlus.Camera.ConsoleApp<br/>(watch & control cameras)"]
Important

Credentials are never committed. The query, camera and listener apps ship a placeholder template (credentials.sample.json / RustPlus.Fcm.ConsoleApp/sample-config.json); you create the real credentials.json / rustplus.config.json locally — both are gitignored. The Register app needs no template, it generates rustplus.config.json for you.

RustPlus.Register.ConsoleApp — get your credentials (start here)

The native, C#-only replacement for npx @liamcottle/rustplus.js fcm-register. It performs the GCM/Firebase/FCM/Expo registration, opens Chrome/Chromium for the Steam login, registers with Rust Companion, writes rustplus.config.json, then waits for you to pair in game.

dotnet run --project samples/RustPlus.Register.ConsoleApp
  • Requires Chrome or Chromium (native or Flatpak; CHROME_PATH overrides discovery). Firefox/Safari won't work.
  • After the Steam login, open Rust → join your server → Pair with Server.
  • It prints the absolute path of the saved rustplus.config.json and the new RustPlus(new RustPlusConnection(ip, port, playerId, playerToken)) line to use with the other samples.

RustPlus.Fcm.ConsoleApp — listen for notifications

Listens for pairing/alarm notifications using the credentials from the register app.

# Copy the config produced by the Register app next to this project, then:
dotnet run --project samples/RustPlus.Fcm.ConsoleApp
# or pass the path explicitly:
dotnet run --project samples/RustPlus.Fcm.ConsoleApp -- /path/to/rustplus.config.json

It reads rustplus.config.json (the native format) and also accepts the legacy rustplus.js config layout as a fallback — see Troubleshooting if notifications don't arrive.

RustPlus.ConsoleApp — query and control a server

Interactive menu covering the full IRustPlus surface:

Menu What it exercises
Common Server info, map (saved to map.jpg), map markers, time, Nexus auth.
Team Team info, team chat, promote to leader, send message.
Clan Clan info, clan chat, send message, set MOTD.
Electricity Alarms, subscriptions, storage monitors, smart switches (get/set/strobe/toggle).
Live Events Stream smart-switch, storage-monitor, team/clan chat and clan-change events live.

Entity ids (alarm / smart switch / storage monitor) are remembered for the session — press Enter at a prompt to reuse the last value.

# Copy credentials.sample.json to credentials.json and fill in the values
# printed by the Register app (ip / port / playerId / playerToken), then:
dotnet run --project samples/RustPlus.ConsoleApp
# or pass the path explicitly:
dotnet run --project samples/RustPlus.ConsoleApp -- /path/to/credentials.json

RustPlus.Camera.ConsoleApp — watch and control cameras

Dedicated camera sample built on the RustPlusApi.Camera package. The interactive mode prompts for a camera identifier and opens a managed CameraController session: live ASCII preview, PNG save, movement & mouse look, PTZ zoom, turret shoot/reload (press+release) — with the device kind detected and shown (static / PTZ / turret / drone). Render fidelity is validated against real captured frames.

dotnet run --project samples/RustPlus.Camera.ConsoleApp

It also has a headless capture mode for generating render fixtures from a live camera (writes a JSON frame dump plus the rendered PNG — this is how the golden-test fixtures were made):

dotnet run --project samples/RustPlus.Camera.ConsoleApp -- [credentialsPath] capture <cameraId> <durationSeconds> [outputDir]

Where the apps look for config

By default each app reads its config from its build output directory; the .csproj copies a credentials.json / rustplus.config.json placed next to the project into the output on build. The simplest workflow is: put the file in the project folder and dotnet run. You can always override the location by passing the path as the first argument.

Edit this page