Skip to content

Minecraft

Pings a Minecraft server with its status protocol. This shows players and the version.

config.yaml
integrations:
minecraft:
type: minecraft
host: mc.example
title: Minecraft
layout:
- title: Infrastructure
widgets:
- minecraft.status
OptionTypeDefaultWhat it does
hoststringrequiredThe server’s address.
portwhole number25565The server’s port. Range -9007199254740991 to 9007199254740991.
titlestringMinecraftThe card’s title.

One widget. Its key is minecraft.status, using the instance name from your config.

minecraft.status · stats card · refreshes every minute while the page is open.

Minecraft, Minecraft, small size
Small
Minecraft, Minecraft, wide size
Wide
Minecraft, Minecraft, medium size
Medium
Minecraft, Minecraft, large size
Large
Minecraft, Minecraft, in chat
In chat

Tall draws the same as medium, so it isn't shown. Only the empty space changes.

Minecraft Minecraft: Nobody on
Nobody on
Minecraft Minecraft: Can't reach it
Can't reach it