mcclient-lib 0.8.14

A lightweight Minecraft client to query the status of a Minecraft server

MCClient

A lightweight Minecraft client to query the status of a Minecraft server.

Supported Mincraft versions

• Minecraft Java (1.4.* -> 1.19.*)
• Minecraft Bedrock

Supported protocols

• ServerListPing for Minecraft java servers
• Legacy ServerListPing for Minecraft java servers before 1.4
• Query Protocol for Minecraft java servers (this needs to be enabled on the server)
• Bedrock ServerListPing for Bedrock servers

Installation

pypi

pip install mcclient-lib

Note: The pypi package isn't always up to date. If you want to use the latest version you will have to clone this repository and install the package locally.

Usage

ServerListPing

from mcclient import SLPClient

# for Minecraft Java servers from 1.7.*
slp_client = SLPClient("mc.example.com", port=12345)
res = slp_client.get_status()

Query

from mcclient import QueryClient

# for Minecraft Java servers (needs to be enabled on the server)
query_client = QueryClient("mc.example.com", port=12345)
res = query_client.get_status()

Bedrock ServerListPing

from mcclient import BedrockSLPClient

# for Minecraft Bedrock servers
bedrock_slp_client = BedrockSLPClient("mc.example.com", port=12345)
res = bedrock_slp_client.get_status()

Response

How to handle the returned response object

# The server address and port
host = res.host
port = host.port

motd = res.motd

online_players = res.players.online
max_players = res.players.max
player_list = res.players.list

version = res.version.name
protocol_version = res.version.protocol

# only for query responses
plugins = res.plugins

# only for basic ServerListPing
has_favicon = res.favicon

# only for query and Bedrock
gametype = res.gametype

# only for query and bedrock
map = res.map

# only for bedrock
server_id = res.server_id

# timestamp of the request
timestamp = res.timestamp

# the reponse as a dictonary with some further infomation
# the keys are named like the values in the response object
res_dict = res.res

Queryable data

• motd
• online player count
• max player count
• player list
• server version
• server protocol version
• mods and plugins
• has a favicon
• name of map
• hostport and hostip
• gametype
• server id

Note: not every field is queryable with every protocol

Documentation

You can find more documentation here, just look into the source if that isn't enough.