Skip to content

justinmtech/Minebuddy

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

19 Commits
 
 
 
 
 
 
 
 

Repository files navigation

Minebuddy

A Minecraft plugin utility that allows you to host a Discord bot. The bot has basic admin commands such as broadcast and stop, and a variety of server status information such as TPS, player count, unique joins and ram usage.

Is this for me?

If you run a Minecraft server and would like a lightweight plugin to see your server's status straight from your Discord server, you may find this useful.

Why Minebuddy?

Minebuddy is lightweight and configurable, and it can be used on 1.13+. As a Minecraft server owner/developer, you probably spend a bit of time on Discord. Being able to view useful server statistics without leaving Discord is convenient sometimes! With Minebuddy, you can skip all of annoying channel integration and complicated configuration.

Dependencies

You need to have PlaceholderAPI installed to run this plugin: https://www.spigotmc.org/resources/placeholderapi.6245/

Setup

  1. Create a Discord bot here if you don't already have one: https://discord.com/developers/applications/
  2. Download and place the plugin JAR file into your plugins folder.
  3. Ensure you have PlaceholderAPI installed: https://www.spigotmc.org/resources/placeholderapi.6245/
  4. Reboot your server and open the config in plugins/Minebuddy/config.yml
  5. Set the token value to your bot's private token (do not share this token!)
  6. Boot the server
  7. If the bot is not already in your server, invite it with the link prompted in the console startup
  8. Try using "!help" on your Discord server
  9. If it works, you're done! Feel free to change the configuration to suit your needs.

Troubleshooting

  • If you get the "failed to connect to Discord" error, make sure your token is set properly.
  • If the plugin enables properly and the bot is in your discord, but commands do not work, ensure the bot has chat permissions.
  • PlaceholderAPI is a required dependency. Be sure you have it installed!

Warning

  • This bot is a staff tool, so be careful giving normal players permission to use it (they will be able to issue broadcast/stop commands).

Commands

Command syntax is determined like this: "{commandSymbol}{commandPrefix}{commandName}" You can change the symbol, prefix and command name in the config.

  • BROADCAST: Broadcast a message to all online players
  • PLAYERS: View all online players (except players with permission corresponding with "invisible-on-list-permission")
  • STATUS: View a variety of server info such as unique joins, ram usage and tps
  • STOP: Executes the stop command
  • HELP: View all bot commands