> For the complete documentation index, see [llms.txt](https://nooberpro.gitbook.io/minecraft-discord-bot/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://nooberpro.gitbook.io/minecraft-discord-bot/introduction.md).

# Introduction

<figure><img src="/files/YaDJQwm2gnGDUIivRtdm" alt=""><figcaption><p><a href="https://github.com/NooberPro/minecraft-discord-bot">@NooberPro/minecraft-discord-bot</a></p></figcaption></figure>

### 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` , `Ukrainian` and `Russian` translations with customizable language settings for each features.
* **Cross-Platform Compatibility**: Supports Java and Bedrock Minecraft servers.
* **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 .

<div><figure><img src="/files/RDkWjYcedAYJ9hkfUb3P" alt=""><figcaption><p><strong>Online Status Message for Java</strong></p></figcaption></figure> <figure><img src="/files/X5mrWiMevwJnVPINwuw3" alt=""><figcaption><p><strong>Online Status Message for Bedrock</strong></p></figcaption></figure> <figure><img src="/files/tlRgbitO3n2ulFoTqMdH" alt=""><figcaption><p><strong>Offline Status Message</strong></p></figcaption></figure></div>

* **Real-Time Bot status Updates**: The bot automatically updates its status with the number of online players.

<div><figure><img src="/files/3MP1P1gCd1ygdJ38Gwac" alt=""><figcaption><p><strong>Online Bot Status</strong></p></figcaption></figure> <figure><img src="/files/TuBCStjpH8PfjOLHLhCz" alt=""><figcaption><p><strong>Offline Bot Status</strong></p></figcaption></figure></div>

* **Multiple Discord bot activities**: `playing`, `listening`, `watching`, and `competing`.

<div><figure><img src="/files/HPPQx7NIZBZ205gFU2mS" alt=""><figcaption><p><strong>Playing Activity</strong></p></figcaption></figure> <figure><img src="/files/G1SbpXX3xodUVCkYg669" alt=""><figcaption><p><strong>Watching Activity</strong></p></figcaption></figure></div>

<div><figure><img src="/files/HCGWxIEixCBVsQptgplx" alt=""><figcaption><p><strong>Competing Activity</strong></p></figcaption></figure> <figure><img src="/files/6Wp3KpMFH3RyKM2ktCec" alt=""><figcaption><p>Listening <strong>Activity</strong></p></figcaption></figure></div>

* **Multiple Discord bot statuses**: `online`, `idle`, `do not disturb (dnd)`, and `invisible`.

<div><figure><img src="/files/pTEeMnxRbCJx6EfomkwA" alt=""><figcaption><p><strong>Online Status</strong></p></figcaption></figure> <figure><img src="/files/bnqpWt1ig7GHMOISlyX2" alt=""><figcaption><p><strong>Idle Status</strong></p></figcaption></figure></div>

<div><figure><img src="/files/87xDLQ12CwtmSubiECmk" alt=""><figcaption><p><strong>Do Not Disturb (dnd) Status</strong></p></figcaption></figure> <figure><img src="/files/lQSFVuTjqcIX6qbIa4K5" alt=""><figcaption><p><strong>Invisible Status</strong></p></figcaption></figure></div>

* **Auto-updating Player Count Channel Stats**: Automatically updates the player count or server status in a channel counter.

<div><figure><img src="/files/p3T5515siqrq0YBRuZvu" alt=""><figcaption><p>Online with Player Count Stats</p></figcaption></figure> <figure><img src="/files/YS0oFag5ISKTmAPremrh" alt=""><figcaption><p>Offline Stats</p></figcaption></figure></div>

* **Auto Responses**: Save time and provide quick information by enabling automatic responses to messages related to `IP`, `status`, `version`, and `site`.

<div><figure><img src="/files/EtM0FwHo1JBvB1BVzfC3" alt=""><figcaption><p><strong>Auto Reply for <code>version</code>, <code>ip</code></strong></p></figcaption></figure> <figure><img src="/files/nvgVZj8JEhEpkW4sRFVV" alt=""><figcaption><p><strong>Auto Reply for <code>site</code>, <code>status</code></strong></p></figcaption></figure></div>

* **Colorful Console Logging**: Color-coded console logs for improved appearance and clarity.

<figure><img src="/files/R0WCu7nlNWsQQc0uI4KS" alt=""><figcaption><p><strong>Colorful Console Logging Example</strong></p></figcaption></figure>

* **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.**

<div><figure><img src="/files/n9UpjHlXSAXIpCYHngJT" alt=""><figcaption><p><strong>Status Command Example</strong></p></figcaption></figure> <figure><img src="/files/6fwG4YXeRAkP4ZOpicOP" alt=""><figcaption><p><strong>Help Command Example</strong></p></figcaption></figure> <figure><img src="/files/8TRtkQjFoosjeobkQomT" alt=""><figcaption><p><strong>Command Help Example</strong></p></figcaption></figure></div>

<div><figure><img src="/files/p5qEddRO23eLT1reXXKV" alt=""><figcaption><p><strong>Version Command Example</strong></p></figcaption></figure> <figure><img src="/files/ZcjidpEWpImL1i8yfVoe" alt=""><figcaption><p><strong>Site Command Example</strong></p></figcaption></figure> <figure><img src="/files/Z9a531dAsuGqMTYrpEZx" alt=""><figcaption><p><strong>IP Command Example</strong></p></figcaption></figure></div>

<div><figure><img src="/files/LCYryvoBDSAKodKHrt5O" alt=""><figcaption><p><strong>MOTD Command Example</strong></p></figcaption></figure> <figure><img src="/files/oNqiqN6pZwKA1vHKMfo1" alt=""><figcaption><p><strong>Players Command Example</strong></p></figcaption></figure></div>

### 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/)