Skip to main content

A lightweight Minecraft client

Project description

MCClient

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

Supported Mincraft versions

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

Supported protocols

  • Basic ServerListPing
  • Legacy ServerListPing
  • Query Protocol (Full stat)
  • Bedrock ServerListPing

Installation

local

git clone https://github.com/Sch8ill/MCClient
pip install .

pypi

pip install mcclient

IMPORTANT: There is no pypi package yet.

Usage

Basic ServerListPing

from mcclient import SLPClient

slp_client = SLPClient("mc.example.com", port=12345)
res = slp_client.get_status()
print(res.motd)

Query

from mcclient import QueryClient

query_client = QueryClient(mc.example.com, port=12345)
res = query_client.get_status()
print(res.motd)

Bedrock ServerListPing

from mcclient import BedrockSLPClient

bedrock_slp_client = BedrockSLPClient(mc.example.com, port=12345)
res = bedrock_slp_client.get_status()
print(res.motd)

Queryable data

  • motd (all)
  • online player count (all)
  • max player count (all)
  • player list (basic ServerListPing and query slp)
  • server version (all)
  • server protocol version (Basic Serverlistping, query slp and Bedrock slp)
  • mods and plugins (basic ServerListPing on Forge and query slp)
  • has a favicon (basic ServerListPing)
  • name of map (query slp)
  • hostport and hostip (query slp)
  • gametype (query slp and Bedrock slp)
  • server id (Bedrock slp)

Documentation

There is no real documentation, just look into the source.

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

mcclient-lib-0.8.6.tar.gz (8.4 kB view details)

Uploaded Source

Built Distribution

mcclient_lib-0.8.6-py3-none-any.whl (10.3 kB view details)

Uploaded Python 3

File details

Details for the file mcclient-lib-0.8.6.tar.gz.

File metadata

  • Download URL: mcclient-lib-0.8.6.tar.gz
  • Upload date:
  • Size: 8.4 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/4.0.2 CPython/3.11.0

File hashes

Hashes for mcclient-lib-0.8.6.tar.gz
Algorithm Hash digest
SHA256 2cd057ef662096e72d0e9121d5f05cfd5dff97a7e441db34f5df43cc39748796
MD5 894be95aadff6b63c8f77f4166696898
BLAKE2b-256 6a4809acfb0249bd53dbdbdd4a266bec1ba098a56ba1ae4ddd9c5fb59d24f4fc

See more details on using hashes here.

File details

Details for the file mcclient_lib-0.8.6-py3-none-any.whl.

File metadata

  • Download URL: mcclient_lib-0.8.6-py3-none-any.whl
  • Upload date:
  • Size: 10.3 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/4.0.2 CPython/3.11.0

File hashes

Hashes for mcclient_lib-0.8.6-py3-none-any.whl
Algorithm Hash digest
SHA256 57d013dfd87f95a700f9121db7cc45d11a26a5a701e6346ea4a39b00aff321e0
MD5 57f9400197d4b312d3ea6cdba9ce12b7
BLAKE2b-256 f43b1a749c4098fe5bdb89495c5d8d7bccfc6cf50095fa98441c5f21b4c12a20

See more details on using hashes here.

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page