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

Merge pull request #13 from urda/modernized-readme-fixup

Browse Source 
Fixup some README issues
This commit is contained in:
Dinner Bone
2014-09-17 11:25:57 +02:00
parent 4c4239e6f8 f07be86a20
commit bfe75cb290
1 changed files with 20 additions and 15 deletions
Download Patch File Download Diff File Expand all files Collapse all files

35
README.md
View File

@@ -1,34 +1,39 @@
mcstatus
========
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.
`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.
Usage
-----
from mcstatus import MinecraftServer
server = MinecraftServer("localhost", 25565)
# 'ping' is supported by all Minecraft servers that are version 1.7 or higher.
status = server.ping_server()
print("The server has %d players" % (status.players.online))
# 'query' has to be enabled in a servers' server.properties file.
# 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, ", ")))
```python
from mcstatus import MinecraftServer
server = MinecraftServer("localhost", 25565)
# 'ping' is supported by all Minecraft servers that are version 1.7 or higher.
status, ping = server.ping_server()
print("The server has {0} players".format(status.players.online))
# 'query' has to be enabled in a servers' server.properties file.
# It may give more information than a ping, such as a full player list or mod information.
query = server.query_server()
print("The server has the following players online: {0}".format(", ".join(query.players.names)))
```
Installation
------------
mcstatus is available on pypi, and can be installed trivially with:
pip install mcstatus
```bash
pip install mcstatus
```
Alternatively, just clone this repo!
License
-------
mcstatus is licensed under Apache 2.0.
mcstatus is licensed under Apache 2.0.