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

pypi

pip install mcclient-lib

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.7.tar.gz (8.3 kB view details)

Uploaded Source

Built Distribution

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

Uploaded Python 3

File details

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

File metadata

  • Download URL: mcclient-lib-0.8.7.tar.gz
  • Upload date:
  • Size: 8.3 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.7.tar.gz
Algorithm Hash digest
SHA256 79ebe0c8fd64e80fb732d16aaea9261a7f26c1f8b694302911a6746880c12432
MD5 81d36c6ddd281cbec5cf54179c71b1ae
BLAKE2b-256 13619305b69ceb4b76ad28ab24e644891d8a0abd56259bb341e7de5a3306aa9b

See more details on using hashes here.

File details

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

File metadata

  • Download URL: mcclient_lib-0.8.7-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.7-py3-none-any.whl
Algorithm Hash digest
SHA256 f0b01eaabdc27b299e0b4949ee1afc55e2e5cc43eef37ad4c1d18ae0a72bafd2
MD5 9217205c45375ff450a45fffad17c566
BLAKE2b-256 511967a0e97d03722e85f8569953a96531d963e63a0990650f2cc08e21ff7a5f

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