MineStat 📈

MineStat is a Minecraft server status checker.

You can use these classes/modules in a monitoring script to poll multiple Minecraft servers, include similar functionality in a Discord bot, or to let visitors see the status of your server from their browser. MineStat has been ported to multiple languages for use with ASP.NET, FastCGI, mod_perl, mod_php, mod_python, Node.js, Rails, Tomcat, and more.

If you are planning to host MineStat on a shared webhost, make sure that the provider allows outbound sockets.

Protocol Support 📞

Note: The Go, JavaScript, and Perl implementations are currently under development.

Examples 📝

C# example

using System;
using MineStatLib;

class Example
{
  public static void Main()
  {
    MineStat ms = new MineStat("minecraft.frag.land", 25565);
    Console.WriteLine("Minecraft server status of {0} on port {1}:", ms.Address, ms.Port);
    if(ms.ServerUp)
    {
      Console.WriteLine("Server is online running version {0} with {1} out of {2} players.", ms.Version, ms.CurrentPlayers, ms.MaximumPlayers);
      if(ms.Gamemode != null)
        Console.WriteLine("Game mode: {0}", ms.Gamemode);
      Console.WriteLine("Message of the day: {0}", ms.Stripped_Motd);
      Console.WriteLine("Latency: {0}ms", ms.Latency);
      Console.WriteLine("Connected using protocol: {0}", ms.Protocol);
    }
    else
      Console.WriteLine("Server is offline!");
  }
}

Go example

To use the Go package: go get github.com/FragLand/minestat/Go/minestat

package main

import "fmt"
import "github.com/FragLand/minestat/Go/minestat"

func main() {
  minestat.Init("minecraft.frag.land")
  fmt.Printf("Minecraft server status of %s on port %d:\n", minestat.Address, minestat.Port)
  if minestat.Online {
    fmt.Printf("Server is online running version %s with %d out of %d players.\n", minestat.Version, minestat.Current_players, minestat.Max_players)
    fmt.Printf("Message of the day: %s\n", minestat.Motd)
    fmt.Printf("Latency: %dms\n", minestat.Latency)
    fmt.Printf("Connected using protocol: %s\n", minestat.Protocol)
  } else {
    fmt.Println("Server is offline!")
  }
}

Java example

import land.Frag.MineStat;

class Example
{
  public static void main(String[] args)
  {
    MineStat ms = new MineStat("minecraft.frag.land", 25565);
    System.out.println("Minecraft server status of " + ms.getAddress() + " on port " + ms.getPort() + ":");
    if(ms.isServerUp())
    {
     System.out.println("Server is online running version " + ms.getVersion() + " with " + ms.getCurrentPlayers() + " out of " + ms.getMaximumPlayers() + " players.");
     System.out.println("Message of the day: " + ms.getMotd());
     System.out.println("Message of the day without formatting: " + ms.getStrippedMotd());
     System.out.println("Latency: " + ms.getLatency() + "ms");
     System.out.println("Connected using protocol: " + ms.getRequestType());
    }
    else
      System.out.println("Server is offline!");
  }
}

JavaScript example

To use the npm package: npm install minestat

var ms = require('minestat');
ms.initSync({address: 'minecraft.frag.land', port: 25565}, function(error, result)
{
  if(error)
  {
    console.log('Error encountered during connection attempt.');
    throw error;
  }
  console.log("Minecraft server status of " + result.address + " on port " + result.port + ":");
  if(result.online)
  {
    console.log("Server is online running version " + result.version + " with " + result.current_players + " out of " + result.max_players + " players.");
    console.log("Message of the day: " + result.motd);
    console.log("Latency: " + result.latency + "ms");
  }
  else
  {
    console.log("Server is offline!");
  }
});

Perl example

To use the CPAN module: cpan Minecraft::ServerStatus

use Minecraft::ServerStatus;

$ms = Minecraft::ServerStatus::init("minecraft.frag.land", 25565);

print "Minecraft server status of $ms->{address} on port $ms->{port}:\n";
if($ms->{online})
{
  print "Server is online running version $ms->{version} with $ms->{current_players} out of $ms->{max_players} players.\n";
  print "Message of the day: $ms->{motd}\n";
  print "Latency: $ms->{latency}ms\n";
}
else
{
  print "Server is offline!\n";
}

PHP example

Note: MineStat for PHP requires multi-byte string support to handle character encoding conversion. Enabling mbstring support can be as simple as installing the php-mbstring package for your platform. If building PHP from source, see https://www.php.net/manual/en/mbstring.installation.php. To validate, phpinfo() output will reference mbstring if the feature is enabled.

<?php
require_once('minestat.php');

$ms = new MineStat("minecraft.frag.land", 25565);
printf("Minecraft server status of %s on port %s:<br>", $ms->get_address(), $ms->get_port());
if($ms->is_online())
{
  printf("Server is online running version %s with %s out of %s players.<br>", $ms->get_version(), $ms->get_current_players(), $ms->get_max_players());
  if($ms->get_request_type() == "Bedrock/Pocket Edition")
    printf("Game mode: %s<br>", $ms->get_mode());
  printf("Message of the day: %s<br>", $ms->get_motd());
  printf("Message of the day without formatting: %s<br>", $ms->get_stripped_motd());
  printf("Latency: %sms<br>", $ms->get_latency());
  printf("Connected using protocol: %s<br>", $ms->get_request_type());
}
else
{
  printf("Server is offline!<br>");
}
?>

PowerShell example

To install the module: Install-Module -Name MineStat

Import-Module MineStat
$ms = MineStat -Address "minecraft.frag.land" -port 25565
"Minecraft server status of '{0}' on port {1}:" -f $ms.Address, $ms.Port

if ($ms.Online) {
  "Server is online running version {0} with {1} out of {2} players." -f $ms.Version, $ms.Current_Players, $ms.Max_Players
  "Message of the day: {0}" -f $ms.Stripped_Motd
  "Latency: {0}ms" -f $ms.Latency
  "Connected using SLP protocol '{0}'" -f $ms.Slp_Protocol
}else {
  "Server is offline!"
}

Python example

To use the PyPI package: pip install minestat

import minestat

ms = minestat.MineStat('minecraft.frag.land', 25565)
print('Minecraft server status of %s on port %d:' % (ms.address, ms.port))
if ms.online:
  print('Server is online running version %s with %s out of %s players.' % (ms.version, ms.current_players, ms.max_players))
  # Bedrock specific attribute:
  if ms.gamemode:
    print('Game mode: %s' % ms.gamemode)
  print('Message of the day: %s' % ms.motd)
  print('Message of the day without formatting: %s' % ms.stripped_motd)
  print('Latency: %sms' % ms.latency)
  print('Connected using protocol: %s' % ms.slp_protocol)
else:
  print('Server is offline!')

See the Python specific readme (Python/README.md) for a full list of all supported attributes.

Ruby example

To use the gem: gem install minestat

require 'minestat'

ms = MineStat.new("minecraft.frag.land", 25565)
puts "Minecraft server status of #{ms.address} on port #{ms.port}:"
if ms.online
  puts "Server is online running version #{ms.version} with #{ms.current_players} out of #{ms.max_players} players."
  puts "Game mode: #{ms.mode}" if ms.mode
  puts "Message of the day: #{ms.motd}"
  puts "Message of the day without formatting: #{ms.stripped_motd}"
  puts "Latency: #{ms.latency}ms"
  puts "Connected using protocol: #{ms.request_type}"
else
  puts "Server is offline!"
end

Contributing and Support :octocat:

Feel free to submit an issue if you require assistance or would like to make a feature request. You are also welcome to join us on Matrix. Any contributions such as build testing, creating bug reports or feature requests, and submitting pull requests are appreciated. Our code style guidelines can be found in the "Coding Convention" section of CONTRIBUTING.md. Please see the fork and pull guide if you are not certain how to submit a pull request.

Contributors

• @Ajoro: C#, PowerShell, and GitHub Actions/automation [2020 - present]
• Annukka Törmälä (@nukka): Java [2017]
• Arne Sacnussem (@arnesacnussem): Java [2018]
• @BlueTree242: Java issue report [2021]
• @braulio-dev: Feature request [2021]
• @c0m4r: PHP [2020]
• @Chew: Ruby issue report [2020]
• @Conanap: JavaScript issue report [2022]
• @DeadlineEm: PHP and PowerShell [2023]
• Felix Ern (@MindSolve): C#, Java, PHP, Python, and GitHub Actions/automation [2019 - present]
• @grimsi: Java issue report [2020, 2021]
• Hojeong Go (@seia-soto): JavaScript [2018]
• Isaac Kogan (@isaackogan): Feature request [2021]
• @ItsVinnyX: Java issue report [2018, 2020]
• @Jcodeerd: Python issue report [2021]
• @Joly0: Java issue report [2021]
• @Jordan9232: Feature request [2023]
• @jrdiver: C# [2022]
• @Junai22: Python issue report [2021]
• Kolya Venturi (@kolyaventuri): JavaScript [2023]
• @KyleighD: Ideas and code review [2014 - 2020]
• Lewis L. Foster (@sniff122): Python issue report [2018]
• Lloyd Dilley (@ldilley): Lead developer [2014 - present]
• Lukas Kolletzki (@kolletzki): C# [2017]
• Marko Pilipovicc (@marko-pilipovicc): Java issue report [2020]
• @matahombres: PHP issue report [2019]
• @MegaNarwhal: Java issue report [2017]
• @mio9: JavaScript issue report [2017]
• @molanp: PHP and Python [2023 - present]
• Nate Bendall (@nbendall34): Java issue report [2021]
• @Nortank12: Python issue report [2019]
• @Norway174: JavaScript issue report [2017]
• @Osiris-Team: Java issue report [2021]
• Ozan Kurt (@OzanKurt): PHP issue report [2019]
• Pavel Fedin (@amorphine): Go and JavaScript issue report [2018]
• Phil Rimer: IRC server hosting [2014 - 2020]
• @Pronner: C# issue report [2022]
• @Raideerke: Go and JavaScript issue report [2019]
• Rawora Ramin (@rawora-rg): Java issue report [2020]
• @RealDrPuc: Python issue report [2020]
• @rey-dev: Feature request [2021]
• @RunTheBot: JavaScript [2023]
• @samdotnet: Java issue report [2020]
• @Sch8ill: Go and Python [2022 - present]
• SeongHoon Ryu (@ryush00): Ruby [2024]
• @sinhpn92: Go and JavaScript issue report [2020]
• @skybird23333: Java issue report [2020]
• Sondre Batalden (@Pomdre): PHP issue report [2019]
• @Spongecade: Python documentation [2023]
• Stepan Melnikov (@unn4m3d): Ruby [2016]
• Steven Polglase (@swpolgla): Ruby [2021]
• @TENIOS: Java [2024]
• ThisTNTSquid: JavaScript [2017]
• Tony Publiski (@Tonster): Minecraft and IRC server hosting [2014 - present]
• Vikas Dongre (@zvikasdongre): Java issue report [2022]
• wangyw15: C# [2017]
• @xXBuilderBXx: C# issue report [2017]