Minecraft Server Status
Show the amount of players on your Minecraft server in a channel and display your MOTD and more in a message.
Minecraft Server Status
Show the amount of players on your Minecraft server in a channel and display your MOTD and more in a message.
This module is storing data in your bot's database.
This module has one configuration file.
This module is being actively used on over 2.7K other servers on SCNX.
This module is included for free in every plan. Learn more about prices.
Features
- Display the current player count and status of your Minecraft server in a voice channel or category name.
- Show detailed server information (MOTD, version, player count) in an automatically updating message embed.
- Support for both Java and Bedrock edition servers.
- Support for SRV records and custom ports.
- Customizable online and offline status messages.
Setup
- Make sure your Minecraft server has the
enable-queryoption set totruein yourserver.propertiesfile. - Open the Minecraft Servers configuration.
- Click on "Add new Minecraft server" and configure it as described in the configuration section.
- If you want to use the status channel feature, create a voice channel or category and make sure the bot has "View channel" and "Manage channel" permissions on it.
- If you want to use the status message feature, make sure the bot has "View channel", "Send messages" and "Embed links" permissions on the configured text channel.
- Reload your bot's configuration to apply the changes.
Usage
After setting up and configuring this module, no additional actions are required. The bot will automatically check the status of your configured Minecraft servers every six minutes and update the configured channels and messages accordingly.
- If you enabled the status channel feature, the name of the configured voice channel or category will be updated to reflect the current player count or show an offline message.
- If you enabled the status message feature, the bot will send a message in the configured text channel and keep it updated with the current server status, including player count, version, MOTD and more.
Configuration
This configuration file allows you to add and configure your Minecraft servers. Open it in your dashboard.
| Field | Description |
|---|---|
| Server Address | The address of your Minecraft server. You can include a port if needed. SRV records are supported. |
| Bedrock server? | Enable this if your server is a Bedrock edition server instead of Java edition. |
| Enable status as channel name? | If enabled, a voice channel or category can be used to display the server status in its name. |
| Status Channel | The voice channel or category whose name will be updated to reflect the server status. Only available if the status channel feature is enabled. |
| Offline status | The channel name to display when the server is not reachable. Only available if the status channel feature is enabled. |
| Online status | The channel name to display when the server is reachable. Only available if the status channel feature is enabled. Please review available parameters in your dashboard. |
| Enable status as a message? | If enabled, a message will be sent and automatically updated with the server status. |
| Channel to send message into | The text channel in which the status message will be sent and updated automatically. Only available if the status message feature is enabled. |
| Online status message | The message displayed when the server is online. Supports embeds. Only available if the status message feature is enabled. Please review available parameters in your dashboard. |
| Offline status message | The message displayed when the server is not reachable. Supports embeds. Only available if the status message feature is enabled. Please review available parameters in your dashboard. |
Troubleshooting
The server status is not updating
- Make sure your Minecraft server has the
enable-queryoption set totruein yourserver.propertiesfile. - Verify that the server address you entered is correct and reachable.
- If your server has been flagged as "Breaking Minecraft EULA", it will not be supported.
- Ensure the bot has the "Manage channel" permission on the configured voice channel (for channel name updates) or "Send messages" and "Embed links" permissions on the text channel (for status messages).
- The status updates every six minutes. Please wait for the next update cycle.
The channel name is not changing
- Discord rate-limits channel name changes. It may take longer than expected for the change to appear.
- Make sure the bot has "View channel" and "Manage channel" permissions on the configured channel.
- The channel name will only be updated if the new name differs from the current one.
Stored data
The following data is being stored about every status message:
- The channel ID combined with the server address (used as a unique identifier)
- The ID of the status message sent by the bot
- Metadata about the entry (date when created and last updated)
To remove all data stored by this module, purge the module database.