From b2692900428b04db3632d43781456e03cc493e51 Mon Sep 17 00:00:00 2001 From: Liss-Bot Date: Sat, 15 Mar 2025 16:11:59 +0000 Subject: [PATCH] Update documentation --- docs/widgets.md | 40 ++++++++++++++++++++++++++++++++++++++++ 1 file changed, 40 insertions(+) diff --git a/docs/widgets.md b/docs/widgets.md index dfd44436..06e98f5c 100644 --- a/docs/widgets.md +++ b/docs/widgets.md @@ -40,6 +40,7 @@ Dashy has support for displaying dynamic content in the form of widgets. There a - [Mvg Connection](#mvg-connection) - [Custom search](#custom-search) - [Rescuetime overview](#rescuetime-overview) + - [Minecraft Server](#minecraft-server) - **[Self-Hosted Services Widgets](#self-hosted-services-widgets)** - [System Info](#system-info) - [Cron Monitoring](#cron-monitoring-health-checks) @@ -1378,6 +1379,45 @@ Show an overview of how you have spent your time for the current day. --- +### Minecraft Server + +Show minecraft server status + +

+ +#### Options + +**Field** | **Type** | **Required** | **Description** +--- | --- | --- | --- +**`title`** | `string` | _Optional_ | Display title for server uses server address if not set. +**`server`** | `string` | Required | Server hostname or ip(:port) will use srv records. +**`bedrock`** | `boolean` | _Optional_ | If server is a bedrock edition server. (default false) +**`showMods`** | `boolean` | _Optional_ | Display mod list if available +**`showPlayers`** | `boolean` | _Optional_ | Display player list if available +**`showPlugins`** | `boolean` | _Optional_ | Display plugin list if available + +#### Example + +```yaml + - type: minecraft-status + options: + title: Venity Network + server: play.venitymc.com + bedrock: true + showMods: true + showPlayers: true + showPlugins: true +``` +#### Info + +- **CORS**: 🟢 Enabled +- **Auth**: 🟢 Not Required +- **Price**: 🟢 Free +- **Host**: [Minecraft Server Status](https://mcsrvstat.us/) +- **Privacy**: _See [Minecraft Server Status FAQ](https://mcsrvstat.us/faq)_ + +--- + ## Self-Hosted Services Widgets