mc-bot

module
v0.0.0-...-5c9ae66 Latest Latest
Warning

This package is not in the latest version of its module.

Go to latest
Published: Mar 12, 2023 License: MIT

README

Minecraft Bot for Discord

This is a small personal project to allow small-scale management of a Minecraft server via Discord. It also supports other games, right now including Valheim.

Features

  • Whitelist Management: Discord members can request to be added to the Minecraft whitelist. Once a member with the Approvers role confirms, they will be added.

  • Server Restarts: Discord members can request a server restart. The restart blocks until the server is empty. A member with the Approvers role can override.

  • Players: Discord members can request the current number and names of online players.

  • RCON Channel: A Discord channel can be converted into an RCON console.

Screenshots
Whitelist Command

Whitelist Command

Whitelist Interaction

Whitelist Interaction

Whitelist Result

Whitelist Result

Restart Command

Restart Command

Restart Interaction

Restart Interaction

Restart Result

Restart Result

Players Result

Players Result

Valheim Support

Valheim support is the first other mode added to the bot. It supports the same restart and player info command. Restarting happens by terminating the Kubernetes Pod the server runs in. Player Info gets fetched from the server via the Steam Query Protocol. Valheim only supports player count so far, no player names are returned.

Deployment

The bot can be deployed on Kubernetes. Simply edit the manifests in examples/ and then run:

kubectl apply --server-side -f examples/

It's recommended to build the bot yourself as the upstream image built on quay.io/kwiesmueller/mc-bot won't follow any stability guarantees and be updated on demand. Stay safe and make sure you know what you run.

Contributing

Should you want to try the bot yourself or even contribute, please go ahead. It won't receive any active support, but Github Issues are a good way to report issues. This is not intended as a full server management solution running across multiple guilds and servers. It's just a project from friends for friends.

If you want to do more with this, feel free to get in touch :-)

Thanks to

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL