Russlyman.Rcon
2.0.1
dotnet add package Russlyman.Rcon --version 2.0.1
NuGet\Install-Package Russlyman.Rcon -Version 2.0.1
<PackageReference Include="Russlyman.Rcon" Version="2.0.1" />
paket add Russlyman.Rcon --version 2.0.1
#r "nuget: Russlyman.Rcon, 2.0.1"
// Install Russlyman.Rcon as a Cake Addin
#addin nuget:?package=Russlyman.Rcon&version=2.0.1
// Install Russlyman.Rcon as a Cake Tool
#tool nuget:?package=Russlyman.Rcon&version=2.0.1
Russlyman.Rcon
Russlyman.Rcon is a C# .NET library for sending RCon messages to game servers that implement the Quake III Arena RCon protocol.
While this library should be compatible with any game server that implements the Quake III Arena RCon protocol, it has only been tested and confirmed working with FiveM.
Compatibility
- Quake III Arena
- FiveM (Confirmed)
Basic Usage
Sends RCon command to server and writes response to console.
using Russlyman.Rcon;
using System;
var rcon = new RconClient();
rcon.Connect("127.0.0.1", 30120, "fivem");
var reply = rcon.Send("restart Vita");
rcon.Dispose();
Console.WriteLine(reply);
Download
Documentation
RconClient Class
RconClient(int replyTimeoutMs = 3000)
Description
The RCon client.
Parameters
replyTimeoutMs - The timeout in milliseconds for how long the client should wait for a reply from the server after a command has been sent.
Connect Method
void Connect(string ip, int port, string password)
Description
Connects to a server.
This method can be used multiple times to connect to other servers without creating a new object.
Parameters
ip - The IP Address for the server.
port - The RCon port for the server.
password - The RCon password for the server.
Send Method
string Send(string command)
Description
Sends a command to the server.
Parameters
command - The command to send to the connected server.
Returns
The servers response to the sent command.
SendAsync Method
async Task<string> SendAsync(string command)
Description
Asynchronously sends a command to the connected server.
Parameters
command - The command to send to the server.
Returns
A task containing the servers response to the sent command.
Dispose Method
void Dispose()
Description
Disposes the class.
Should be called when you don't want to send anymore commands and connect to other servers.
License
This project is licensed under MIT which can be viewed from the LICENSE
file.
Product | Versions |
---|---|
.NET | net5.0 net5.0-windows net6.0 net6.0-android net6.0-ios net6.0-maccatalyst net6.0-macos net6.0-tvos net6.0-windows net7.0 net7.0-android net7.0-ios net7.0-maccatalyst net7.0-macos net7.0-tvos net7.0-windows |
.NET Core | netcoreapp2.0 netcoreapp2.1 netcoreapp2.2 netcoreapp3.0 netcoreapp3.1 |
.NET Standard | netstandard2.0 netstandard2.1 |
.NET Framework | net461 net462 net463 net47 net471 net472 net48 net481 |
MonoAndroid | monoandroid |
MonoMac | monomac |
MonoTouch | monotouch |
Tizen | tizen40 tizen60 |
Xamarin.iOS | xamarinios |
Xamarin.Mac | xamarinmac |
Xamarin.TVOS | xamarintvos |
Xamarin.WatchOS | xamarinwatchos |
-
.NETStandard 2.0
- No dependencies.
NuGet packages
This package is not used by any NuGet packages.
GitHub repositories
This package is not used by any popular GitHub repositories.