NooberPro / minecraft-discord-bot

A feature-rich and highly customizable Discord bot that provides information about your Minecraft server.
https://nooberpro.gitbook.io
MIT License
21 stars 13 forks source link
discord discord-bot discord-js minecraft minecraft-bot minecraft-server

GitHub Downloads GitHub license GitHub issues GitHub Forks
## Features - **Highly Customizable**: Take full control of the bot and tailor its configuration to meet your unique requirements. - **Multilingual Support**: `English`, `Spanish`, `German`, `French`, `Portuguese`, `Russian` and `Ukrainian` translations with customizable language settings for each features. - **Free Hosting Compatibility**: Support for free server hosting providers like Aternos, Falixnodes etc. - **Anti-Crash System:** This feature safeguards the bot, ensuring its stability and uninterrupted operation by preventing crashes and unexpected halts. - **Dynamic Status Message**: Auto-updating status messages with integrated player list . - **Cross-Platform Compatibility**: Supports Java and Bedrock Minecraft servers. - **Real-Time Bot status Updates**: The bot automatically updates its status with the number of online players. - **Multiple Discord bot activities**: `playing`, `listening`, `watching`, and `competing`. - **Multiple Discord bot statuses**: `online`, `idle`, `do not disturb (dnd)`, and `invisible`. - **Auto-updating Player Count Channel Stats**: Automatically updates the player count or server status in a channel counter. - **Auto Responses**: Save time and provide quick information by enabling automatic responses to messages related to IP, status, version, and site. - **ColorFul Console Logging**: Color-coded console logs for improved appearance and clarity. - **Player Avatar List**: Display the players' avatars alongside their names using emojis in player list. - **Varies Slash and Prefix Commands**: - `ip` - **Sends the server address of the Minecraft server.** - `motd` - **Sends the Minecraft Server's Message of the Day (MOTD).** - `players` - **Sends the list of players who are currently online on the Minecraft server.** - `status` - **Sends the current status of the Minecraft server.** - `version` - **Sends the version of the Minecraft server.** - `site` - **Sends the website/vote link of the Minecraft server.** - `help` - **Provides a list of available commands.** - `help [command]` - **Sends the details about a command.** ## Screenshots #### [**More Images Here**](http://nooberpro.gitbook.io/) | **HELP** | **COMMAND HELP** | **STATUS** | **MOTD** | **PLAYERS** | **IP** | **VERSION** | **SITE** | | :-------------------------------------------------------------------------------------: | :------------------------------------------------------------------------------------: | :---------------------------------------------------------------------------------------: | :-------------------------------------------------------------------------------------: | :----------------------------------------------------------------------------------------: | :-----------------------------------------------------------------------------------: | :----------------------------------------------------------------------------------------: | :-------------------------------------------------------------------------------------: | | Help commands embed example | Command Help embed example | Status commands embed example | MOTD commands embed example | Players commands embed example | Ip commands embed example | Version commands embed example | Site commands embed example | | **Auto Updating Status Message** | **Auto Updating Bot's Status** | **Discord Bot Activities** | **Discord Bot Status** | | ------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | Auto Updating Status Message Example | Auto Updating Bot's Status Online Example

Auto Updating Bot's Status Offline Example | Discord Bot Activities - 'Playing'
Discord Bot Activities - 'Watching'
Discord Bot Activities - 'Listening'
Discord Bot Activities - 'Competing'
| Discord Bot Status - 'online'
Discord Bot Status - 'idle'
Discord Bot Status - 'do not distrub (dnd)'
Discord Bot Status - 'invisible'
| | **Colorful Console Logging** | **Player Count Channel** | **Auto Reply** | **Player Avatar Emoji** | | ColorFul Console Logging Example | Player Count Channel Online Example

Player Count Channel Offline Example | Auto Reply Feature Example 1
Auto Reply Feature Example 2 | Player Avatar Emoji Example | ## Installation ### **[Full Documentation here](https://nooberpro.gitbook.io/)** 1. **Requirements:** - Install [Node.js](https://nodejs.org/en/download/current) - _(Recommended: [Visual Studio Code](https://code.visualstudio.com/Download))_ 2. **[Download latest release](https://github.com/Nooberpro/minecraft-discord-bot/archive/refs/heads/main.zip)**. 3. **Install Dependencies:** - Open bot folder in Visual Studio Code. - Launch terminal with **Ctrl + `**. - Run `npm install` in terminal. 4. **Edit the config file.** _**([Instructions](https://nooberpro.gitbook.io/minecraft-discord-bot/installation/config))**_ 5. **Start the bot with `npm start` or `node .`.** #### Quick Start on Replit **You can also run the bot directly and easily by clicking the "Run on Replit" button below.** [![Run on Replit](https://replit.com/badge/github/NooberPro/minecraft-discord-bot)](https://replit.com/new/github/NooberPro/minecraft-discord-bot) ## Translations **Help translate minecraft-discord-bot via [Crowdin](https://crowdin.com/project/minecraft-discord-bot). Contributions in different languages are highly appreciated!** ### Contributors A big thanks to the following contributors who have helped with translations: - **[Zahar1loshara](https://crowdin.com/profile/Zahar1loshara)** - Russian, Ukrainian ## Built with **Technologies used in the project**: - **[Node.js](https://nodejs.org/en/download)** - **[Discord.js](https://discord.js.org/)** - **[node-mcstatus](https://www.npmjs.com/package/node-mcstatus)** - **[CommandKit](https://commandkit.js.org/)**