RustPlusApi.Fcm 1.3.0

There is a newer version of this package available.
See the version list below for details.

dotnet add package RustPlusApi.Fcm --version 1.3.0

NuGet\Install-Package RustPlusApi.Fcm -Version 1.3.0

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.Fcm" Version="1.3.0" />

For projects that support PackageReference, copy this XML node into the project file to reference the package.

<PackageVersion Include="RustPlusApi.Fcm" Version="1.3.0" />
                    

                            Directory.Packages.props

<PackageReference Include="RustPlusApi.Fcm" />
                    

                            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.Fcm --version 1.3.0

The NuGet Team does not provide support for this client. Please contact its maintainers for support.

#r "nuget: RustPlusApi.Fcm, 1.3.0"

#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.Fcm@1.3.0

#: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.Fcm&version=1.3.0
                    

                            Install as a Cake Addin

#tool nuget:?package=RustPlusApi.Fcm&version=1.3.0
                    

                            Install as a Cake Tool

The NuGet Team does not provide support for this client. Please contact its maintainers for support.

RustPlusApi.Fcm

This is a C# client for the Rust+ websocket. It allows you to receive notification via FCM.

RustPlusFcm

First, instantiate the RustPlusFcm class with the necessary parameters:

var listener = new RustPlusFcm(credentials, notificationIds);

Parameters:

credentials: The FCM credentials*.
notificationIds: The notification ids to mark as read.

* See the Credentials section below for how to obtain these.

Then you can connect to the FCM server:

await listener.ConnectAsync();

You can subscribe to events to handle specific actions:

listener.OnServerPairing += (sender, e) =>
{
    Console.WriteLine($"Server pairing: {e.ServerPairing}");
};

listener.OnEntityParing += (sender, e) =>
{
    Console.WriteLine($"Entity pairing: {e.EntityPairing}");
};

listener.OnAlarmTriggered += (sender, e) =>
{
    Console.WriteLine($"Alarm triggered: {e.Alarm}");
};

Remember to disconnect from the FCM server when you're done:

listener.Disconnect();

Credentials

Currently, there is no simple way to get the FCM credentials using .NET.

To use this library, you need to get the FCM credentials manually. To do, so I recommend you to use this project to get the credentials.

Clone the repository.
Install the dependencies using npm install.
Run npm run cli/index.js fcm-register
Proceed to log in with your Steam account.
The credentials will be in a file named rustplus.config.json.

I'm sorry for the inconvenience, but since the API is not fully complete, it's the easiest way.

Product	Compatible and additional computed target framework versions.
.NET	net8.0 is compatible. 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 was computed. 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.

Product

.NET

Compatible target framework(s)

Included target framework(s) (in package)

Learn more about Target Frameworks and .NET Standard.

net8.0
- protobuf-net (>= 3.2.52)

NuGet packages

This package is not used by any NuGet packages.

GitHub repositories

This package is not used by any popular GitHub repositories.