MrServer 1.0.0

MrServer - Minecraft Server Pinging Library

A C# .NET 8 library for pinging Minecraft servers and retrieving server information.

Features

• Async/Sync Support: Both asynchronous and synchronous methods available
• Comprehensive Server Info: Retrieve version, player count, description, latency, and more
• Player Sampling: Get a list of online players (when available)
• Timeout Configuration: Configurable connection timeout
• Error Handling: Robust error handling with detailed error messages
• Cross-Platform: Works on Windows, Linux, and macOS

Installation

Add this NuGet package to your project:

dotnet add package Newtonsoft.Json

Usage

Basic Usage

using Mr_Server;

// Create an instance of MrServer
var mrServer = new MrServer();

// Ping a server asynchronously
var serverInfo = await mrServer.PingServerAsync("mc.hypixel.net", 25565);

if (serverInfo.IsOnline)
{
    Console.WriteLine($"Server is online!");
    Console.WriteLine($"Version: {serverInfo.Version}");
    Console.WriteLine($"Players: {serverInfo.OnlinePlayers}/{serverInfo.MaxPlayers}");
    Console.WriteLine($"Description: {serverInfo.Description}");
    Console.WriteLine($"Latency: {serverInfo.Latency}ms");
}
else
{
    Console.WriteLine($"Server is offline: {serverInfo.Description}");
}

Synchronous Usage

var mrServer = new MrServer();
var serverInfo = mrServer.PingServer("localhost", 25565);

Custom Timeout

// Set a 3-second timeout
var mrServer = new MrServer(timeoutMs: 3000);

Multiple Servers

var mrServer = new MrServer();
var servers = new[] { "mc.hypixel.net", "play.cubecraft.net", "mineverse.com" };

var tasks = servers.Select(server => mrServer.PingServerAsync(server));
var results = await Task.WhenAll(tasks);

foreach (var result in results)
{
    Console.WriteLine($"Server: {result.IsOnline ? "Online" : "Offline"}");
}

API Reference

MrServer Class

Constructors

• MrServer() - Creates an instance with default 5-second timeout
• MrServer(int timeoutMs) - Creates an instance with custom timeout

Methods

• Task<MinecraftServerInfo> PingServerAsync(string hostname, int port = 25565)
• MinecraftServerInfo PingServer(string hostname, int port = 25565)

MinecraftServerInfo Class

Properties

• string? Version - Server version (e.g., "1.19.2")
• string? Protocol - Protocol version number
• int MaxPlayers - Maximum number of players
• int OnlinePlayers - Current number of online players
• string? Description - Server description/MOTD
• string? Favicon - Base64 encoded server icon
• List<PlayerInfo>? Players - Sample of online players
• long Latency - Response time in milliseconds
• bool IsOnline - Whether the server is reachable

PlayerInfo Class

Properties

• string? Name - Player username
• string? Id - Player UUID

Error Handling

The library handles various error conditions:

• Connection Timeout: When the server doesn't respond within the timeout period
• Connection Refused: When the server is not running or port is closed
• Invalid Response: When the server sends malformed data
• Network Errors: General network connectivity issues

When an error occurs, IsOnline will be false and Description will contain the error message.

Protocol Support

This library implements the Minecraft Server List Ping protocol used by modern Minecraft servers (1.7+). It supports:

• Server status requests
• Ping/pong for latency measurement
• JSON response parsing
• Protocol version 760 (1.19.2) by default

Requirements

• .NET 8.0 or later
• Newtonsoft.Json package

License

This project is open source. Feel free to use and modify as needed.