RustPlusApi 2.0.0-beta.2

.NET 10.0 This package targets .NET 10.0. The package is compatible with this framework or higher. .NET Standard 2.0 This package targets .NET Standard 2.0. The package is compatible with this framework or higher.
This is a prerelease version of RustPlusApi.
There is a newer prerelease version of this package available.
See the version list below for details. 
dotnet add package RustPlusApi --version 2.0.0-beta.2
                    


                    

                
NuGet\Install-Package RustPlusApi -Version 2.0.0-beta.2
This command is intended to be used within the Package Manager Console in Visual Studio, as it uses the NuGet module's version of Install-Package. 
<PackageReference Include="RustPlusApi" Version="2.0.0-beta.2" />
For projects that support PackageReference, copy this XML node into the project file to reference the package. 
<PackageVersion Include="RustPlusApi" Version="2.0.0-beta.2" />
                    


                            Directory.Packages.props
                        

                    

                
<PackageReference Include="RustPlusApi" />
                    


                            Project file
For projects that support Central Package Management (CPM), copy this XML node into the solution Directory.Packages.props file to version the package. 
paket add RustPlusApi --version 2.0.0-beta.2
                    


                    

                
#r "nuget: RustPlusApi, 2.0.0-beta.2"
#r directive can be used in F# Interactive and Polyglot Notebooks. Copy this into the interactive tool or source code of the script to reference the package. 
#:package RustPlusApi@2.0.0-beta.2
#:package directive can be used in C# file-based apps starting in .NET 10 preview 4. Copy this into a .cs file before any lines of code to reference the package. 
#addin nuget:?package=RustPlusApi&version=2.0.0-beta.2&prerelease
                    


                            Install as a Cake Addin
                        

                    

                
#tool nuget:?package=RustPlusApi&version=2.0.0-beta.2&prerelease
                    


                            Install as a Cake Tool

RustPlusApi

The core Rust+ companion client. Connect to a server and use a typed Response<T> API for server info, time, map and markers, team & clan chat, nexus auth, entities (smart switch / alarm / storage monitor) and the camera protocol.

Part of RustPlusApi · Documentation · Samples

Targets .NET Standard 2.0 and .NET 10.

Install

dotnet add package RustPlusApi

Usage

using RustPlusApi;

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

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

rustPlus.OnSmartSwitchTriggered += (_, e) => { /* react to a smart switch */ };

Every request returns a Response<T> (IsSuccess / Error / Data). Need credentials? Use the RustPlusApi.Fcm.Registration package.

Logging

Pass an ILoggerFactory to the constructor to route the client's diagnostics into your logging stack:

using Microsoft.Extensions.Logging;

using var loggerFactory = LoggerFactory.Create(b => b.AddConsole());

using var rustPlus = new RustPlus(
    new RustPlusConnection("127.0.0.1", 28082, 76561198000000000, 123456789),
    loggerFactory: loggerFactory);

Documentation

Product Compatible and additional computed target framework versions.
.NET net5.0 was computed.  net5.0-windows was computed.  net6.0 was computed.  net6.0-android was computed.  net6.0-ios was computed.  net6.0-maccatalyst was computed.  net6.0-macos was computed.  net6.0-tvos was computed.  net6.0-windows was computed.  net7.0 was computed.  net7.0-android was computed.  net7.0-ios was computed.  net7.0-maccatalyst was computed.  net7.0-macos was computed.  net7.0-tvos was computed.  net7.0-windows was computed.  net8.0 was computed.  net8.0-android was computed.  net8.0-browser was computed.  net8.0-ios was computed.  net8.0-maccatalyst was computed.  net8.0-macos was computed.  net8.0-tvos was computed.  net8.0-windows was computed.  net9.0 was computed.  net9.0-android was computed.  net9.0-browser was computed.  net9.0-ios was computed.  net9.0-maccatalyst was computed.  net9.0-macos was computed.  net9.0-tvos was computed.  net9.0-windows was computed.  net10.0 is compatible.  net10.0-android was computed.  net10.0-browser was computed.  net10.0-ios was computed.  net10.0-maccatalyst was computed.  net10.0-macos was computed.  net10.0-tvos was computed.  net10.0-windows was computed. 
.NET Core netcoreapp2.0 was computed.  netcoreapp2.1 was computed.  netcoreapp2.2 was computed.  netcoreapp3.0 was computed.  netcoreapp3.1 was computed. 
.NET Standard netstandard2.0 is compatible.  netstandard2.1 was computed. 
.NET Framework net461 was computed.  net462 was computed.  net463 was computed.  net47 was computed.  net471 was computed.  net472 was computed.  net48 was computed.  net481 was computed. 
MonoAndroid monoandroid was computed. 
MonoMac monomac was computed. 
MonoTouch monotouch was computed. 
Tizen tizen40 was computed.  tizen60 was computed. 
Xamarin.iOS xamarinios was computed. 
Xamarin.Mac xamarinmac was computed. 
Xamarin.TVOS xamarintvos was computed. 
Xamarin.WatchOS xamarinwatchos was computed. 
Compatible target framework(s)
Included target framework(s) (in package)
Learn more about Target Frameworks and .NET Standard.

NuGet packages (2)

Showing the top 2 NuGet packages that depend on RustPlusApi:

Package Downloads
RustPlusApi.Camera

Camera session control (keep-alive, turret/PTZ helpers) and frame rendering for Rust+. Renders AppCameraRays into images via SixLabors.ImageSharp; keep it out of the core if you only need the raw camera protocol.
RustPlusApi.Extensions.DependencyInjection

Microsoft.Extensions.DependencyInjection registration extensions for the RustPlusApi Rust+ client.

GitHub repositories (1)

Showing the top 1 popular GitHub repositories that depend on RustPlusApi:

Repository Stars
Pronwan/rustplus-desktop
Rust+ Desktop App (unofficial)