No project description provided
Project description
Minecraft server status webhook for Discord
Poll a server and send customizable webhook embed if the status changes.
Requires Python 3.6+
Table of contents
Installation
Use python
on Windows instead of python3
Update pip and dependencies
$ python3 -m pip install --upgrade pip
$ python3 -m pip install --upgrade setuptools wheel
Install
$ python3 -m pip install git+https://github.com/alexitx/mc-status-webhook.git
Usage
$ python3 mc_status_webhook.py -u "<webhook url>" [options]
or set the appropriate environment variables.
See CLI arguments and Environment variables for configuration.
Example scripts are also provided in the 'examples' directory. Get msw-example.cmd for Windows or msw-example.sh for Linux and modify it to your needs.
Note: It is strongly recommended to run mc-status-webhook on the same machine or local network as the Minecraft server to avoid false notifications due to connection issues and wasting bandwidth. In this case use the loopback address 127.0.0.1 or the local address of the machine.
CLI arguments
Argument | Type | Default | Required | Description |
---|---|---|---|---|
-H, --host | str | 127.0.0.1 | No | Server address |
-p, --port | int | 25565 | No | Server port |
-t, --update-time | float | 10.0 | No | Time in seconds between checking the server status |
-i, --initial-status | bool | No | Send a webhook with the server status on application start | |
-u, --webhook-url | str | Yes | Discord webhook URL | |
-d, --debug | bool | No | Log debug messages | |
--thumbnail-url | str | No | Webhook thumbnail URL | |
--online-color | str | 30c030 | No | Webhook color hex when the server is online |
--offline-color | str | ff4040 | No | Webhook color hex when the server is offline |
--status-title | str | Status | No | Webhook status title |
--status-online-value | str | Online | No | Webhook status value when the server is online |
--status-offline-value | str | Offline | No | Webhook status value when the server is offline |
--address-title | str | Address | No | Webhook address title |
--address-value | str | No | Webhook address value when the server is online |
Environment variables
Environment variable | Equivalent argument |
---|---|
MSW_HOST | -H, --host |
MSW_PORT | -p, --port |
MSW_WEBHOOK_URL | -u, --webhook-url |
MSW_THUMBNAIL_URL | --thumbnail-url |
MSW_ONLINE_COLOR | --online-color |
MSW_OFFLINE_COLOR | --offline-color |
MSW_STATUS_TITLE | --status-title |
MSW_STATUS_ONLINE_VALUE | --status-online-value |
MSW_STATUS_OFFLINE_VALUE | --status-offline-value |
MSW_ADDRESS_TITLE | --address-title |
MSW_ADDRESS_VALUE | --address-value |
License
MIT license. See LICENSE for more information.
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
Built Distribution
Hashes for mc_status_webhook-0.1.0-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | a2137a44b3a82ccbb1cc565a685126b54086f85fb744dc824bf49fedb2f1169e |
|
MD5 | 838cc2c2750df342ca50f1fa6cc77161 |
|
BLAKE2b-256 | fff30989bffc4c9e5295294ac47bcce4c8cf9cfc9c52b43fe9991f5a0030c6bf |