110 lines
5.2 KiB
Text
110 lines
5.2 KiB
Text
Metadata-Version: 2.4
|
|
Name: mcstatus
|
|
Version: 12.0.6
|
|
Summary: A library to query Minecraft Servers for their status and capabilities.
|
|
Project-URL: Documentation, https://mcstatus.readthedocs.io
|
|
Project-URL: Source code, https://github.com/py-mine/mcstatus
|
|
Author-email: Nathan Adams <dinnerbone@dinnerbone.com>, ItsDrike <itsdrike@protonmail.com>, PerchunPak <perchunpak@gmail.com>
|
|
Maintainer-email: Kevin Tindall <kevinkjt2000@gmail.com>, ItsDrike <itsdrike@protonmail.com>, PerchunPak <perchunpak@gmail.com>
|
|
License-Expression: Apache-2.0
|
|
License-File: LICENSE
|
|
Keywords: minecraft,protocol
|
|
Classifier: Development Status :: 5 - Production/Stable
|
|
Classifier: Intended Audience :: Developers
|
|
Classifier: License :: OSI Approved :: Apache Software License
|
|
Classifier: Natural Language :: English
|
|
Classifier: Operating System :: OS Independent
|
|
Classifier: Programming Language :: Python
|
|
Classifier: Programming Language :: Python :: 3
|
|
Classifier: Programming Language :: Python :: 3.9
|
|
Classifier: Programming Language :: Python :: 3.10
|
|
Classifier: Programming Language :: Python :: 3.11
|
|
Classifier: Programming Language :: Python :: 3.12
|
|
Classifier: Programming Language :: Python :: 3.13
|
|
Classifier: Topic :: Games/Entertainment
|
|
Classifier: Topic :: Software Development :: Libraries :: Python Modules
|
|
Classifier: Topic :: System :: Monitoring
|
|
Classifier: Typing :: Typed
|
|
Requires-Python: >=3.9
|
|
Requires-Dist: asyncio-dgram>=2.1.2
|
|
Requires-Dist: dnspython>=2.4.2
|
|
Description-Content-Type: text/markdown
|
|
|
|
# <img src="https://i.imgur.com/nPCcxts.png" height="25" style="height: 25px"> MCStatus
|
|
|
|
[](https://discord.gg/C2wX7zduxC)
|
|
|
|
[](https://pypi.org/project/mcstatus/)
|
|
[](https://mcstatus.readthedocs.io/)
|
|
[](https://github.com/py-mine/mcstatus/actions/workflows/validation.yml)
|
|
[](https://github.com/py-mine/mcstatus/actions/workflows/unit-tests.yml)
|
|
|
|
Mcstatus provides an API and command line script to fetch publicly available data from Minecraft servers. Specifically, mcstatus retrieves data by using these protocols: [Server List Ping](https://minecraft.wiki/w/Java_Edition_protocol/Server_List_Ping) and [Query](https://minecraft.wiki/w/Query). Because of mcstatus, you do not need to fully understand those protocols and can instead skip straight to retrieving minecraft server data quickly in your own programs.
|
|
|
|
## Installation
|
|
|
|
Mcstatus is available on [PyPI](https://pypi.org/project/mcstatus/), and can be installed trivially with:
|
|
|
|
```bash
|
|
python3 -m pip install mcstatus
|
|
```
|
|
|
|
## Usage
|
|
|
|
### Python API
|
|
|
|
#### Java Edition
|
|
|
|
```python
|
|
from mcstatus import JavaServer
|
|
|
|
# You can pass the same address you'd enter into the address field in minecraft into the 'lookup' function
|
|
# If you know the host and port, you may skip this and use JavaServer("example.org", 1234)
|
|
server = JavaServer.lookup("example.org:1234")
|
|
|
|
# 'status' is supported by all Minecraft servers that are version 1.7 or higher.
|
|
# Don't expect the player list to always be complete, because many servers run
|
|
# plugins that hide this information or limit the number of players returned or even
|
|
# alter this list to contain fake players for purposes of having a custom message here.
|
|
status = server.status()
|
|
print(f"The server has {status.players.online} player(s) online and replied in {status.latency} ms")
|
|
|
|
# 'ping' is supported by all Minecraft servers that are version 1.7 or higher.
|
|
# It is included in a 'status' call, but is also exposed separate if you do not require the additional info.
|
|
latency = server.ping()
|
|
print(f"The server replied in {latency} ms")
|
|
|
|
# 'query' has to be enabled in a server's server.properties file!
|
|
# It may give more information than a ping, such as a full player list or mod information.
|
|
query = server.query()
|
|
print(f"The server has the following players online: {', '.join(query.players.names)}")
|
|
```
|
|
|
|
#### Bedrock Edition
|
|
|
|
```python
|
|
from mcstatus import BedrockServer
|
|
|
|
# You can pass the same address you'd enter into the address field in minecraft into the 'lookup' function
|
|
# If you know the host and port, you may skip this and use BedrockServer("example.org", 19132)
|
|
server = BedrockServer.lookup("example.org:19132")
|
|
|
|
# 'status' is the only feature that is supported by Bedrock at this time.
|
|
# In this case status includes players.online, latency, motd, map, gamemode, and players.max. (ex: status.gamemode)
|
|
status = server.status()
|
|
print(f"The server has {status.players.online} players online and replied in {status.latency} ms")
|
|
```
|
|
|
|
See the [documentation](https://mcstatus.readthedocs.io) to find what you can do with our library!
|
|
|
|
### Command Line Interface
|
|
|
|
The mcstatus library includes a simple CLI. Once installed, it can be used through:
|
|
|
|
```bash
|
|
python3 -m mcstatus --help
|
|
```
|
|
|
|
## License
|
|
|
|
Mcstatus is licensed under the Apache 2.0 license. See LICENSE for full text.
|