mc_server_info 1.0.0 mc_server_info: ^1.0.0 copied to clipboard
A Dart package for retrieving information about Minecraft servers.
Minecraft Server Info #
A Dart package for retrieving information about Minecraft servers.
Usage #
import 'package:mc_server_info/mc_server_info.dart';
void main() async {
try {
var serverInfo = await MinecraftServerInfo.get(
host: 'bedrock.jartex.fun',
port: 19132,
timeout: const Duration(seconds: 10),
);
print('Server is online: ${serverInfo.isOnline}');
if (serverInfo.isOnline) {
print('Current players: ${serverInfo.players}');
print('Max players: ${serverInfo.maxPlayers}');
print('gameType: ${serverInfo.gameType}');
print('ServerId: ${serverInfo.serverId}');
print('version: ${serverInfo.version}');
print('software: ${serverInfo.software}');
}
} on ServerTimeOutException catch (e) {
print('Server did not respond within the specified timeout period: $e');
} on HostException catch (e) {
print('Invalid host: $e');
} catch (e) {
print('An error occurred: $e');
}
}
Features #
- Retrieve information about Minecraft servers, including whether the server is online or offline, the current number of players, the maximum number of players, the version of server, software, serverId, gameType,
- Built-in timeout handling in case the server does not respond within the specified period.
- Lightweight and easy to use.
Methods #
get
#
Sends a ping packet to the specified server and returns information about the server.
Throws a ServerTimeOutException
if the server does not respond within the specified timeout
period.
static Future<ServerModel> get({
required String host,
required int port,
Duration timeout = const Duration(seconds: 10),
})
getUrl
#
Get information about the server by url "
static Future<ServerModel> getUrl(String url)
Installation #
To use this package, add mc_server_info
as a dependency in your pubspec.yaml
file.