Table of Contents

Getting Started

Prerequisites

  • .NET SDK — any target the library supports: .NET Framework 4.6.2 or later, .NET 6–10, Mono, or Unity. The netstandard2.0 build covers everything; the net10.0 build uses modern BCL fast-paths on .NET 10.
  • A Rust server with Rust+ enabled — you need access to the in-game Rust+ menu so you can choose Pair with Server to complete the pairing flow.

Install

dotnet add package RustPlusApi
dotnet add package RustPlusApi.Fcm
dotnet add package RustPlusApi.Fcm.Registration   # native credentials (optional)
dotnet add package RustPlusApi.Camera             # camera rendering (optional)
dotnet add package RustPlusApi.Extensions.DependencyInjection       # DI registration (optional)
dotnet add package RustPlusApi.Fcm.Extensions.DependencyInjection   # DI registration for FCM (optional)

1. Get your credentials

You need credentials to connect. The quickest way — no .NET SDK required — is the Rust+ credentials website: a browser flow that logs you into Steam and hands back the four pairing values plus a downloadable rustplus.config.json.

Run it yourself — it needs no configuration:

docker run -p 127.0.0.1:8080:8080 ghcr.io/handys11/rustplusapi-credentials

Browse to it from that same machine and Steam signs you in automatically. Reached from anywhere else — a LAN address, or a hosted instance if one is ever stood up and its address added to the website's README — it walks you through pasting one address back instead. See that README for both modes and the full command.

If you'd rather stay entirely in .NET, the native RustPlusApi.Fcm.Registration package does the same thing from your own code — no Node.js required. The quickest path is the RustPlus.Register.ConsoleApp sample:

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

It writes rustplus.config.json (the FCM credentials) and, after you choose Pair with Server in game, prints the four values for the RustPlus constructor.

What the four values are

All four arrive together in the server-pairing push notification.

Value Meaning Source
server Server IP address Pairing notification (ServerPairing.Ip)
port Rust+ companion port — not the game join port Pairing notification (ServerPairing.Port)
playerId Your SteamID64 Pairing notification (ServerPairing.PlayerId)
playerToken Per-server auth token issued at pairing time Pairing notification (ServerPairing.PlayerToken)

2. Connect and query the server

using RustPlusApi;

using var rustPlus = new RustPlus(new RustPlusConnection(server, port, playerId, playerToken));
await rustPlus.ConnectAsync();

var info = await rustPlus.GetInfoAsync();
if (info.IsSuccess)
    Console.WriteLine($"{info.Data!.Name} — {info.Data.PlayerCount}/{info.Data.MaxPlayerCount} players");

Every request returns a Response<T> — see the RustPlus Client guide for the full surface.

3. Listen for notifications

using RustPlusApi.Fcm;
using RustPlusApi.Fcm.Registration;

var credentials = CredentialsStore.Load("rustplus.config.json");
var listener = new RustPlusFcm(credentials);
listener.OnAlarmTriggered += (_, alarm) => Console.WriteLine("Alarm!");
await listener.ConnectAsync();

See FCM Notifications for the full event list.

Next steps

  • Credentials — how the native registration flow works end to end.
  • RustPlus Client — info/time/map, entities, team, events.
  • Cameras — subscribe to and render server cameras.

If something doesn't work

See Troubleshooting.

Edit this page