Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/tosox/minecraft-server-status
A well commented, simple server status checker for Minecraft, written in Python
https://github.com/tosox/minecraft-server-status
check minecraft python script server status tosox windows
Last synced: 9 days ago
JSON representation
A well commented, simple server status checker for Minecraft, written in Python
- Host: GitHub
- URL: https://github.com/tosox/minecraft-server-status
- Owner: Tosox
- License: mit
- Created: 2022-10-27T08:31:44.000Z (about 2 years ago)
- Default Branch: master
- Last Pushed: 2024-01-29T09:34:47.000Z (10 months ago)
- Last Synced: 2024-01-29T14:25:56.896Z (10 months ago)
- Topics: check, minecraft, python, script, server, status, tosox, windows
- Language: Python
- Homepage:
- Size: 19.5 KB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# Minecraft Server Status
[![](https://img.shields.io/badge/Language-Python-yellow.svg?style=flat)](https://en.wikipedia.org/wiki/Python_(programming_language))
[![](https://img.shields.io/badge/Game-Minecraft-green.svg?style=flat)](https://www.minecraft.net/en-us)
[![](https://img.shields.io/github/languages/code-size/Tosox/Minecraft-Server-Status?color=blue&label=Code%20size&style=flat)](https://github.com/Tosox/Minecraft-Server-Status)
[![](https://tokei.rs/b1/github/Tosox/Minecraft-Server-Status?color=red&label=Total%20lines&style=flat)](https://github.com/Tosox/Minecraft-Server-Status)**A simple server status checker for minecraft written in python**
## Usage
```bash
# Example
> python ./mc_server_check.py -ip mc.hypixel.net --port 25565
```| Arguments | Description | Notes |
|-------------------|----------------------------------------------|------------------------------|
| -ip | Server address | |
| --port | Server address port | Optional - Defaults to 25565 |## Example results
```bash
# Successful
> python ./mc_server_check.py -ip mc.hypixel.net
The server is up and running
``````bash
# No server found
> python ./mc_server_check.py -ip someserver.com
The server is offline or doesn´t exist
``````bash
# The server is probably alive but not responding
> python ./mc_server_check.py -ip anotherserver.net
Warning: the connection timed out
``````bash
# No internet connection
> python ./mc_server_check.py -ip mc.hypixel.net
Error: check your internet connection and try again
``````bash
# Something went wrong when testing the connection
> python ./mc_server_check.py -ip mc.hypixel.net
Error: couldn´t ping the server. Return code: XY
``````bash
[OPTIONAL: --port ]
# Wrong syntax
> python ./mc_server_check.py -address mc.hypixel.net -port
Error: please use the correct syntax: python ./mc_server_check.py -ip
```