Minestat Python edition hangs indefinitely if the remote server closes the connection while the script expects more data.
This issue is a regession, introduced by PR #78

Expected Behavior

• Minestat Python edition should not hang indefinitely, but instead error out or try other protocols

Actual Behavior/Symptoms

• Minestat Python hangs indefinitely

How to Reproduce Behavior/Symptoms

• Point minestat at mc.hypixel.net, port 25565
• Observe hanging (in while loop in _recv_exact)

MineStat Version

• Github master 2b77852

Programming Language and Compiler/Interpreter Version

• Python 3.7.7 (tags/v3.7.7:d7c567b08f, Mar 10 2020, 10:41:24) [MSC v.1900 64 bit (AMD64)] on win32

Operating System

• Windows 7 x64

Measure the time elapsed in milliseconds that it takes to open a TCP connection to the destination server. The C# implementation already contains a delay variable for this purpose. The number of milliseconds elapsed should be rounded to the nearest integer. Lastly, the language examples should be updated to show how this data may also be displayed in output.

I used it in python and my app stopped working because of a type error:
TypeError: a bytes-like object is required, not 'str'

But I found the bug:

Parse the received data

if raw_data is None or raw_data == '':
  self.online = False
else:
  data = raw_data.decode('cp437').split('\x00\x00\x00')
  if data and len(data) >= self.NUM_FIELDS:
    self.online = True
    self.version = data[2].replace("\x00", "")
    self.motd = data[3].encode('utf-8').replace("\x00", "")  #HERE!!
    self.current_players = data[4].replace("\x00", "")
    self.max_players = data[5].replace("\x00", "")
  else:
    self.online = False

I just had to swap them so it firstly replaces the "\x00" to "" than encodes it to utf-8, it fixed my issue.

Parse the received data

if raw_data is None or raw_data == '':
  self.online = False
else:
  data = raw_data.decode('cp437').split('\x00\x00\x00')
  if data and len(data) >= self.NUM_FIELDS:
    self.online = True
    self.version = data[2].replace("\x00", "")
    self.motd = data[3].replace("\x00", "").encode('utf-8')
    self.current_players = data[4].replace("\x00", "")
    self.max_players = data[5].replace("\x00", "")
  else:
    self.online = False

Add support for Bedrock edition, this is the only working one for java i've found so far sadly

Issues #20 (1.6), #21 (1.7), #22 (1.8b/1.3), and #45 (Bedrock/PE/RakNet) were for adding missing protocol support to the language implementations referenced in the table below.

Protocol Version Support

Leverage C#'s XML doc, Godoc, Javadoc, JSDoc, Perldoc, PHPDoc, Pydoc, and RDoc syntax to document MineStat code.

@isaackogan and @rey-dev reported yesterday via Discord that the MotD appears empty after pinging certain servers (such as Mineplex). After investigating, it was determined that some servers are making use of formatting in their MotDs and this data is being returned in an extra array inside the description object of JSON responses. An example is below:

{"version":{"name":"BungeeCord 1.8.x-1.17.x","protocol":756},"players":{"max":526,"online":525},"description":{"extra":[{"color":"white","text":"                "},{"bold":true,"strikethrough":true,"color":"aqua","text":"   "},{"bold":true,"strikethrough":true,"color":"dark_gray","text":"[ "},{"color":"white","text":" "},{"bold":true,"color":"blue","text":"Mineplex"},{"color":"white","text":" "},{"bold":true,"color":"white","text":"Games"},{"color":"white","text":" "},{"bold":true,"strikethrough":true,"color":"dark_gray","text":" ]"},{"bold":true,"strikethrough":true,"color":"aqua","text":"   "},{"color":"white","text":""}],"text":""}

Notice how the text field of the description object is actually empty. MineStat is working as intended in this regard. However, the extra data is not currently processed at all. @mindsolve proposed stripping the formatting characters out of the response and displaying the plain/unformatted text. Additionally, the extra data in JSON format can be provided so the end user would be able to process it however they choose. For more details regarding JSON and formatting in Minecraft, see the following links:
https://wiki.vg/Chat#Current_system_.28JSON_Chat.29
https://minecraft.fandom.com/wiki/Formatting_codes
https://pypi.org/project/jsontextmc/

Beginning at line

        // SLP 1.4/1.5
        Retval retval = legacyRequest(address, port, getTimeout());
        // SLP 1.8b/1.3
        if(retval != Retval.SUCCESS)
          retval = betaRequest(address, port, getTimeout());
        // SLP 1.6
        if(retval != Retval.SUCCESS)
          retval = extendedLegacyRequest(address, port, getTimeout());
        // SLP 1.7
        if(retval != Retval.SUCCESS)
          retval = jsonRequest(address, port, getTimeout())

Because if we keep the logic as it is, namely:

        // SLP 1.4/1.5
        Retval retval = legacyRequest(address, port, getTimeout());
        // SLP 1.8b/1.3
        if(retval != Retval.SUCCESS && retval != Retval.CONNFAIL)
          retval = betaRequest(address, port, getTimeout());
        // SLP 1.6
        if(retval != Retval.CONNFAIL)
          retval = extendedLegacyRequest(address, port, getTimeout());
        // SLP 1.7
        if(retval != Retval.CONNFAIL)
          retval = jsonRequest(address, port, getTimeout())

Then the other requests are done even though the request before already was successfull.

C#, Go, and Ruby were added to travis.yml. The Java build issue has been resolved. C# and Ruby builds are also passing. However, Go builds are still failing due to an issue with pathing.

First of all, you did and still do a great job maintaining this project!

I would really like to have an official package published to Maven Central, so that using this library in your application becomes as easy as adding the dependency to your build file.

This should be an easy win in theory, since no new code has to be written.
Here is an overview of what's necessary in order to tackle this: https://maven.apache.org/repository/guide-central-repository-upload.html

Hello!
Thanks for the code. But I have faced an issue, that one of the servers can not be queried with the code provided. The server version is 1.7.10. The IP address and the Port are 164.132.201.216:25560.
Meanwhile this service works nice https://mcsrvstat.us/server/164.132.201.216:25560 which means the server can be queried.
Please help me to understand what's wrong. Thanks

Actual behavior/symptoms

'Server if offline'

Steps to reproduce behavior/symptoms

Pass 164.132.201.216:25560 as server option

MineStat version

Latest JS and Go implementations

Operating system

Ubuntu 18.04

I found the minestat.js is behaving very weird, which when it try to query a server that is not opened (online), it will throw and error like the following (TCP connection refuse error) instead of filling online = false

{ Error: connect ECONNREFUSED 127.0.0.1:25566
    at Object.exports._errnoException (util.js:1026:11)
    at exports._exceptionWithHostPort (util.js:1049:20)
    at TCPConnectWrap.afterConnect [as oncomplete] (net.js:1136:14)
  code: 'ECONNREFUSED',
  errno: 'ECONNREFUSED',
  syscall: 'connect',
  address: '127.0.0.1',
  port: 25566 }

I still haven't figure out a fix to this, but maybe you should take a look of this problem

Question... How would I make this update every so often?

Expected Behavior

• Anticipated data should be returned by a running Minecraft server.

Actual Behavior/Symptoms

• The remote TCP port of the Minecraft server refuses communication for a duration of approximately 4 seconds under certain conditions.

How to Reproduce Behavior/Symptoms

• Attempt to request data from Minecraft 1.4 servers using SLP protocol v1.7 or Minecraft 1.3 servers using SLP protocol v1.6. The Minecraft server seems to block subsequent TCP connection attempts for approximately 4 seconds. This behavior was reported by @mindsolve.

MineStat Version

• Latest

Programming Language and Compiler/Interpreter Version

• All language implementations that support multiple SLP protocol versions

Operating System

• Any

Expected behavior

show the latency, motd, player amount

Actual behavior/symptoms

AttributeError: module 'minestat' has no attribute 'MineStat'

Steps to reproduce behavior/symptoms

1. go to your python version
2. go to site-packages folder
3. make a minestat.py and put the https://github.com/FragLand/minestat/blob/master/Python/minestat.py code in.
4. use the example
5. get the error

MineStat version

idk, this one: https://github.com/FragLand/minestat/blob/master/Python/minestat.py

Programming language and compiler/interpreter version

python (3.8.7)
VScode

Operating system

Windows 10 (20H2, build: 19042.804, experience: Windows Feature Experience Pack 120.2212.551.0)

Am I just doing something dumb?

Expected behavior

Since the Minecraft Server is online, the ping should work and it should be displayed as online.
It used to work perfectly before. Is it because of the 1.16.3 ?
I checked this with other APIs (like mcsrvstat.eu) and they do have it displayed as online.

Actual behavior/symptoms

#isServerUp() returns false

Steps to reproduce behavior/symptoms

MineStat ms = new MineStat("netheranarchy.org", 25565);
System.out.println(ms.isServerUp());

will return false.

MineStat version

Current Version (Latest commit 8 May)

Programming language and compiler/interpreter version

Java

Operating system

Running on Ubuntu

https://github.com/ldilley/minestat/blob/ea221ae6bcef6b2945564552755c8d5db8cdc37c/JavaScript/minestat.js#L75

process.exit() also stops my node.js script.
And if I comment it out, it posts the same message twice if the server is offline.

Maybe I'm doing something wrong here?

Add a NuGet package for the C# implementation.

Expected behavior

When convert integer number get all number

Actual behavior/symptoms

When convert integer only one numer. Ej -> String(18) -> int(1)

Steps to reproduce behavior/symptoms

Get current_players and put intval($current_players)

MineStat version

May 25, 2019

Programming language and compiler/interpreter version

PHP apache

Operating system

Ubuntu 18.4

The problem is the have one "invisible" character in middle the numbers.
For the posible solution i was thinking about a character path and then check if they are numbers

@nukka already added unit tests for Java. Unit tests can be written for the other languages as well.

Create appveyor.yml to build C# DLL on AppVeyor during pull requests.

Publish a Perl package for MineStat on CPAN.

Hello everbody!

The original developer and maintainer of MineStat, the dear @ldilley has informed me, that he is no longer able to maintain MineStat and whishes to step down from his position as maintainer. He offered me take over the project from him, as we both think that MineStat should not simply be archived, but instead get a new maintainer and a litte fresh wind in the sails.

I see the following points as to-dos in this regard:

• @mindsolve: Create new Github organisation minestat-org for MineStat
  • Done! https://github.com/minestat-org
• @ldilley: Move the repository minestat there
  • moving the repo keeps all issues, the history and links intact, see https://docs.github.com/en/github/administering-a-repository/managing-repository-settings/transferring-a-repository#about-repository-transfers

After this is done, we can talk about how the new repo should be handled, what changes should be done and how to do this together as a community.

Best regards,
~MindSolve

Python Module Name?
How to use python script

Behavior/Symptoms

Whenever you attempt to use require 'minestat' within a ruby program, and have the version 2.1.0 gem installed, you get the error 'require': cannot load such file -- minestat (LoadError)

It took me some time to diagnose this issue, however I believe it's because something is wrong with how the ruby gem is configured. Essentially the minestat.rb file that gets installed to your ruby gems directory does not have read permissions assigned to it for everyone, just the user that installed it. It's easy to miss this issue because it only impacts people who use system ruby installed as root, or instances where a gem was installed by a different user than the one trying to use the gem. You could chalk this up to an environment issue on my end, as installing gems as root is bad practice, however this is the only gem I've come across that displays this issue.

I found a similar issue on another project that describes the problem in more detail:
astroband/ruby-stellar-base#55

How to Reproduce Behavior/Symptoms

This issue is not present when you clone this repo, however it is present when you download the .gem file from rubygems.org and unpack it, or let bundler install the gem.

Compare these outputs:

Bundler Installed

swpolgla@Stevens-MBP lib % ls -l
total 32
-rw-r-----  1 root  wheel  12831 Sep 26 13:32 minestat.rb

Unpacked Gem File

swpolgla@Stevens-MBP lib % ls -l
total 32
-rw-r-----@ 1 swpolgla  staff  12831 Sep  7 22:24 minestat.rb

Github Repo Clone

swpolgla@Stevens-MBP lib % ls -l
total 32
-rw-r--r--@  1 swpolgla  staff  13353 Sep 26 15:02 minestat.rb

As you can see, the only version of the file that maintains read permissions for everyone is the github repo clone.
I've temporarily worked around this issue in my project by setting the BUNDLE_PATH environment variable to a folder adjacent to my project files, letting bundler install all the gem dependencies there, and then running chmod -R u+r .gems as a part of my project's startup script.

MineStat Version

• 2.0.0/2.1.0
  This issue only affects gem versions newer than 0.3.0, so something changed between 0.3.0 and 2.0.0

Programming Language and Compiler/Interpreter Version

• Ruby 2.6.3
• Ruby 3.0.2

Operating System

• MacOS
• Fedora Linux

#20 was created to add 1.6 SLP support. To become current, 1.7 should also be implemented. The handshake for 1.7 should be as follows:

1. Send 0x00 (handshake packet) with the following fields:
  1a. integer indicating protocol version (just send 1 for ping)
  1b. remote server address as a string
  1c. remote server port as an unsigned short
  1d. send integer 1 to request server status
2. Send 0x00 (request packet)
3. Server should respond with 0x00 and JSON data that must be parsed.

I hope you are still around, @unn4m3d. I recently created an account on rubygems.org to update the minestat Ruby gem. You are currently the only owner, so I do not have access unfortunately. Would it be possible to add me at your convenience please? I've also sent you an e-mail as another means of contacting you. My rubygems.org username is LDilley. Here are the instructions to add a gem co-owner: https://guides.rubygems.org/command-reference/#gem-owner

Thank you for any assistance that you can provide, sir.

Expected behavior

Default timeout of the Java version is 5 seconds (as defined in Minestat.java:33)

Actual behavior/symptoms

Default timeout is 5ms

Steps to reproduce behavior/symptoms

Run the example from the repo with a server that has more than 5ms latency to your machine.
Connection will time out and status will be reported as "offline".

MineStat version

latest

Programming language and compiler/interpreter version

Java

Operating system

Windows, Linux

Hey Dilley,

I started creating API with your js, and I want to have multiple servers in one function.

Example of API output.

{seperated_count:{"Skyblock":[355, 55], "Hubs":[588, 0, 45]}, "server_total": 1043}

I'm using nodeJS for the API. I cannot figure out how to put multiple servers in one function.
I tried everything but I didn't get any solution for it.

Woud you please help me with that?

I can figure everything about designing it and that stuff my self ofc, I just need you help with puttin multiple servers in the function.

Thank you for any kind of answer.

With regards,
Yuki Kobayashi.

Expected behavior

Actual behavior/symptoms

Steps to reproduce behavior/symptoms

MineStat version

Programming language and compiler/interpreter version

Operating system

I'm trying to make an Android app for checking a Minecraft server's status. Is it possible to run the Java code in the background?

Allow for legacy 1.8b/1.3 ping query support (just in case.) This requires simply sending 0xFE. The response is delimited by § and does not contain the version as in newer releases.

Expected behavior

The MOTD should reflect what is shown in the Minecraft multiplayer server list.

Actual behavior/symptoms

There is a space between each character of the MOTD, as well as between each character of the version and the player count strings.

Steps to reproduce behavior/symptoms

Ping a server (I used hivemc.eu) and check the aforementioned fields in the result.

MineStat version

Java implementation from d08ee46

Operating system

Windows

Add PHP package for use with composer.

Add npm package for the JavaScript implementation.

Add TCP connection timeout for supported languages lacking it. Currently, this includes C#, Go, JavaScript, and PHP. This feature has already been implemented for the Java, Perl, Python, and Ruby code.

Expected behavior

I expected it to say, "Online."

Actual behavior/symptoms

>> Server.first.query.online
=> false

Steps to reproduce behavior/symptoms

ms = MineStat.new("test.geysermc.org", 19132)
ms.online # => false

The server is online; see https://mcsrvstat.us/server/test.geysermc.org:19132

MineStat version

minestat (0.3.0)

Programming language and compiler/interpreter version

Ruby 2.7.2

Operating system

macOS Big Sur

I suppose it's Pinging, not Querying.
Going to https://mcsrvstat.us/server/test.geysermc.org:25565 says Ping: Yes and Query: No. (This works)
Going to https://mcsrvstat.us/server/test.geysermc.org:19132 says Ping: No and Query: Yes. (Says offline)

Is this not designed for queries? It would be mega useful if it could unless I am doing it wrong. If you have an alternative that I can use, please let me know :3

All 1.7.10 servers are showing an incorrect player and max player count

Top status is using your script
Bottom one is using this https://mcapi.us/

Picture http://imgur.com/a/sJZcP
Im using c#

Travis CI C# builds are failing due to MineStat.cs being moved for #53.

Expected behavior

the server information requested gets sent to discord via an embed

Actual behavior/symptoms

the message gets sent but with delete characters between each character

Steps to reproduce behavior/symptoms

using discord.py async branch sending to discord via an embed field

MineStat version

unsure - latest from github as of issue submission

Operating system

tried on linux and windows with same results

Expected behavior

Should be showing the number of players online.

Actual behavior/symptoms

It is showing "Server is Offline!"

Steps to reproduce behavior/symptoms

Not sure.

MineStat version

Latest.

Programming language and compiler/interpreter version

Java, Eclipse IDE

Operating system

Centos 7

`package com.venomsurge;

import com.venomsurge.handlers.CommandHandler;
import com.venomsurge.listeners.CommandListener;
import com.venomsurge.listeners.MyListener;
import com.venomsurge.minecraft.MineStatus;
import com.venomsurge.music.commands.MusicCommand;

import net.dv8tion.jda.api.JDA;
import net.dv8tion.jda.api.JDABuilder;
import net.dv8tion.jda.api.OnlineStatus;
import net.dv8tion.jda.api.entities.Activity;

public class VenomBOT implements Runnable {

public static JDA api;

public void run() {
	while (true) {
		String server = "";
		MineStatus ms = new MineStatus("play.venomsurge.net", 25565);
		if (ms.isServerUp()) {
			if (Integer.parseInt(ms.getCurrentPlayers()) == 1) {
				server = "VenomSurge with 1 player.";
			} else {
				server = "VenomSurge with " + ms.getCurrentPlayers() + " players.";
			}
		} else {
			server = "Server is offline!";
		}
		api.getPresence().setActivity(Activity.playing(server));
		try {
			Thread.sleep(30000);
		} catch (InterruptedException e) {
			e.printStackTrace();
		}
	}
}

public static void main(String[] args) throws Exception {
	String server = "";
	MineStatus ms = new MineStatus("play.venomsurge.net", 25565);
	if (ms.isServerUp()) {
		if (Integer.parseInt(ms.getCurrentPlayers()) == 1) {
			server = "VenomSurge with 1 player.";
		} else {
			server = "VenomSurge with " + ms.getCurrentPlayers() + " players.";
		}
	} else {
		server = "Server is offline!";
	}
	// Initialize the bot status
	api = JDABuilder.createDefault("MY KEY").setStatus(OnlineStatus.ONLINE).setActivity(Activity.playing(server))addEventListeners(new MyListener(), new CommandListener()).build();
	CommandHandler.commands.put("m", new MusicCommand());
	CommandHandler.commands.put("music", new MusicCommand());
	// Launch thread to periodically update the status
	new Thread(new VenomBOT()).start();

}

}`

i am referencing #50 here kinda.

I am trying to tinker around with this and was curious why mc.hypixel.net on port 25565 always gives back "Server ist offline" although the server is not offline. I have read in the bug report above, that the java implementation is not capable of using the correct slp protocol, but according to another bug report, the c# version should support all slp protocols and therefore should be able to retrieve the information, shouldnt it?

In the recent Java commit, caedbe6, the accessors and mutators for current and maximum players (getCurrentPlayers(), getMaximumPlayers(), setCurrentPlayers(), and setMaximumPlayers()) should be converted from String to int.

Add Java build files for Ant, Gradle, and Maven.

Add a Python package to PyPi.

Hey, I'm the dude from this pull request: #86
Minestat doesn't detect the versions properly.
See https://autoplug.online/servers and navigate to "new" to see what I mean. (I get this for all servers: >=1.8b/1.3)
When using newer request methods first (like in the PR), I don't get this problem and I'm able to retrieve the right versions, BUT retrieving the MOTD fails and waterfall/bungecoord servers get spammed like one of my users reported here: https://discord.com/channels/707539055448948808/709179613540122744/878806086927400971
Tell me if you need more info, I'm more than happy to provide it ^^

MineStat Version

2.0.0

Programming Language and Compiler/Interpreter Version

Java

Operating System

Windows 10 (latest)

MineStat was originally written to only support server list ping for versions 1.4 and 1.5. This query method continues to work on many servers, but some seem to be unresponsive. Implementing the 1.6 SLP protocol will allow MineStat to speak to newer servers. The appropriate data to send in this context would be:

1. 0xFE
2. 0x01
3. 0xFA
4. 0x00 0x4D 0x00 0x43 0x00 0x7C 0x00 0x50 0x00 0x69 0x00 0x6E 0x00 0x67 0x00 0x48 0x00 0x6F 0x00 0x73 0x00 0x74
5. 7 + length of remote hostname in UTF-16BE format as a short
6. 0x4A
7. Remote hostname as UTF-16BE encoded string
8. Remote port as an int

See issue #5 for more details. This may not be possible. It all depends on if BungeeCord is written to forward queries on to reverse-proxied servers and allow them to reply back to the requester. In the context of the aforementioned issue, there may be a mismatch in player capacity since BungeeCord listeners have their own capacity set in config.yml which may often differ from the max player value defined in server.properties for example.

More research and testing is needed.

HTTP ERROR 500 on php.
Hope you can fix it :)