gitea/mcstatus
1
0
Fork 0
mirror of https://github.com/Dinnerbone/mcstatus.git synced 2026-04-06 03:51:23 +08:00
Code Issues Projects Releases Wiki Activity

Updated readme

Browse Source
This commit is contained in:
Nathan Adams
2014-09-07 02:35:02 +02:00
parent 9340ab47c1
commit 1b17c1f702
2 changed files with 28 additions and 15 deletions
Download Patch File Download Diff File Expand all files Collapse all files

42
README.md
View File

@@ -1,22 +1,34 @@
MinecraftQuery mcstatus
====== ========
With Minecraft (old-beta-release-)1.9 came a shiny new tool to allow native status querying in vanilla Minecraft servers. mcstatus provides an easy way to query Minecraft servers for any information they can expose. It provides two modes of access, 'query' and 'ping', the differences of which are listed below in usage.
This is a simple class designed to aid in retrieving any data from the servers.
See it in action: [http://dinnerbone.com/minecraft/tools/status/](http://dinnerbone.com/minecraft/tools/status/)
Protocol documention: [http://dinnerbone.com/blog/2011/10/14/minecraft-19-has-rcon-and-query/](http://dinnerbone.com/blog/2011/10/14/minecraft-19-has-rcon-and-query/)
Usage Usage
----------- -----
from minecraft_query import MinecraftQuery from mcstatus import MinecraftServer
query = MinecraftQuery("localhost", 25565) server = MinecraftServer("localhost", 25565)
basic_status = query.get_status() # 'ping' is supported by all Minecraft servers that are version 1.7 or higher.
print "The server has %d players" % (basic_status['numplayers']) status = server.ping_server()
print("The server has %d players" % (status.players.online))
full_info = query.get_rules() # 'query' has to be enabled in a servers' server.properties file.
print "The server is on the map '%s'" % (full_info['map']) # It may give more information than a ping, such as a full player list or mod information.
query = query.query_server()
print("The server has the following players online: " % (string.join(query.players.names, ", ")))
Installation
------------
mcstatus is available on pypi, and can be installed trivially with:
pip install mcstatus
Alternatively, just clone this repo!
License
-------
mcstatus is licensed under Apache 2.0.

1
mcstatus/__init__.py
View File

@@ -0,0 +1 @@
from mcstatus.server import MinecraftServer