https://github.com/sch8ill/mcclient-lib
A lightweight Minecraft client for querying the status data of a Minecraft server
https://github.com/sch8ill/mcclient-lib
client libary minecraft minecraft-ping minecraft-query minecraft-server minecraft-server-pinger minecraft-slp pip python python3 tcp tcp-client
Last synced: about 1 month ago
JSON representation
A lightweight Minecraft client for querying the status data of a Minecraft server
- Host: GitHub
- URL: https://github.com/sch8ill/mcclient-lib
- Owner: Sch8ill
- License: mit
- Created: 2022-10-16T17:11:58.000Z (over 2 years ago)
- Default Branch: master
- Last Pushed: 2024-08-30T23:25:56.000Z (9 months ago)
- Last Synced: 2025-04-13T00:08:26.935Z (about 1 month ago)
- Topics: client, libary, minecraft, minecraft-ping, minecraft-query, minecraft-server, minecraft-server-pinger, minecraft-slp, pip, python, python3, tcp, tcp-client
- Language: Python
- Homepage:
- Size: 161 KB
- Stars: 21
- Watchers: 1
- Forks: 2
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# mcclient-lib
[](https://pepy.tech/project/mcclient-lib)
[](https://pypi.org/project/mcclient-lib/)
A lightweight Minecraft client for querying the status data of a Minecraft server.
## Supported Minecraft versions
* Minecraft Java (v1.4.0 and later)
* Minecraft Bedrock
## Supported protocols
* [Server List Ping](https://wiki.vg/Server_List_Ping) for Minecraft Java servers
* [Legacy Server List Ping](https://wiki.vg/Server_List_Ping#1.4_to_1.5) for Minecraft Java servers before 1.4
* [Query Protocol](https://wiki.vg/Query) for Minecraft Java servers (needs to be enabled on the server)
* [Bedrock Server List Ping](https://wiki.vg/Raknet_Protocol#Unconnected_Ping) for Minecraft Bedrock servers
## Installation
```bash
pip install mcclient-lib
```
## Usage
### Server List Ping
```python
from mcclient import SLPClient
# for Minecraft Java servers from version 1.7 and later
slp_client = SLPClient("mc.example.com")
res = slp_client.get_status()
```
### Query
```python
from mcclient import QueryClient
# for Minecraft Java servers (needs to be enabled on the server)
query_client = QueryClient("mc.example.com")
res = query_client.get_status()
```
### Bedrock Server List Ping
```python
from mcclient import BedrockSLPClient
# for Minecraft Bedrock servers
bedrock_slp_client = BedrockSLPClient("mc.example.com")
res = bedrock_slp_client.get_status()
```
### Response
```python
print(f"motd: {res.motd}")
print(f"online players: {res.players.online}")
print(f"max players: {res.players.max}")
print(f"players list: {res.players.list}")
print(f"version: {res.version.name}")
print(f"protocol version: {res.version.protocol}")
print(f"host: {res.host}")
print(f"port: {res.port}")
print(f"timestamp: {res.timestamp}")
print(f"favicon: {res.favicon is not None}")
# only for query and Bedrock responses
print(f"gametype: {res.gametype}")
print(f"map: {res.map}")
# only for query responses
print(f"plugins: {res.plugins}")
print(f"host ip: {res.hostip}")
print(f"host port: {res.hostport}")
# only for bedrock responses
print(f"server id: {res.server_id}")
```
Note that not every field is queryable with every protocol.