> 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

A feature-rich and highly customizable Discord bot that provides information about your Minecraft server.

<figure><img src="https://43304169-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FtsdPnIZry8wtSfrbNMOV%2Fuploads%2F7yNvLSofnwcdkh4UiXGf%2Fminecraft-discord-bot-rounded-optimized.png?alt=media&amp;token=1ab07c88-6613-4bcd-b1a7-9123f34f7678" 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="https://43304169-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FtsdPnIZry8wtSfrbNMOV%2Fuploads%2FUu6EezdSwcGDtisacs06%2Fauto%20Updating%20status%20online%20java.png?alt=media&amp;token=b7a0c573-97e9-4ddd-8c0f-57a7fdd601fb" alt=""><figcaption><p><strong>Online Status Message for Java</strong></p></figcaption></figure> <figure><img src="https://43304169-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FtsdPnIZry8wtSfrbNMOV%2Fuploads%2FcnqBJ4h2p2L2DCh3mjew%2Fauto%20Updating%20status%20online%20bedrcok.png?alt=media&amp;token=87ce5e01-cb7d-4775-9d01-81e06344022f" alt=""><figcaption><p><strong>Online Status Message for Bedrock</strong></p></figcaption></figure> <figure><img src="https://43304169-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FtsdPnIZry8wtSfrbNMOV%2Fuploads%2FBg3iGHLN2HLXk43NNvmK%2Fauto%20Updating%20status%20offline.png?alt=media&amp;token=7e619984-a33e-424c-a13d-e90d1f26e2ac" 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="https://43304169-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FtsdPnIZry8wtSfrbNMOV%2Fuploads%2FoN0ZUkzRixo1dkevWRoi%2Fonline%20playing.png?alt=media&amp;token=425299e4-42b9-4d9d-a53f-cb65e63a7193" alt=""><figcaption><p><strong>Online Bot Status</strong></p></figcaption></figure> <figure><img src="https://43304169-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FtsdPnIZry8wtSfrbNMOV%2Fuploads%2FKZvpTlqQv8iqd10kwgk5%2Fidle%20playing%20offline.png?alt=media&amp;token=e92be597-d4d4-47f1-8507-32dd6167e7ac" 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="https://43304169-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FtsdPnIZry8wtSfrbNMOV%2Fuploads%2FPbAgbhSxNCWdYYHygqnR%2Fonline%20playing.png?alt=media&amp;token=9efa77fd-e526-403f-85e9-2ed43fe3fdae" alt=""><figcaption><p><strong>Playing Activity</strong></p></figcaption></figure> <figure><img src="https://43304169-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FtsdPnIZry8wtSfrbNMOV%2Fuploads%2FCEQeu8c03tpkrxOH140c%2Fonline%20watching.png?alt=media&amp;token=66da5f0d-4087-4fbc-967e-301cd4000196" alt=""><figcaption><p><strong>Watching Activity</strong></p></figcaption></figure></div>

<div><figure><img src="https://43304169-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FtsdPnIZry8wtSfrbNMOV%2Fuploads%2FrXK9bCYYasRumMb3ve3z%2Fonline%20competing.png?alt=media&amp;token=312256ae-ad27-4f5c-b215-9e2c30e304fd" alt=""><figcaption><p><strong>Competing Activity</strong></p></figcaption></figure> <figure><img src="https://43304169-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FtsdPnIZry8wtSfrbNMOV%2Fuploads%2FQtHBQNBusVS6zwJpdWKM%2Fonline%20listening.png?alt=media&amp;token=6ba3a8a0-a213-4048-8b76-9d48b7841af5" 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="https://43304169-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FtsdPnIZry8wtSfrbNMOV%2Fuploads%2FmWBJcPc3D73IaHRqW6gO%2Fonline.png?alt=media&amp;token=eea3ed14-225b-4e26-a95a-318dfb5fbc73" alt=""><figcaption><p><strong>Online Status</strong></p></figcaption></figure> <figure><img src="https://43304169-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FtsdPnIZry8wtSfrbNMOV%2Fuploads%2FfGsDvDmklsDHrqFzxbY4%2Fidle.png?alt=media&amp;token=688b98a2-d629-4428-b8d6-714cf8d63a0e" alt=""><figcaption><p><strong>Idle Status</strong></p></figcaption></figure></div>

<div><figure><img src="https://43304169-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FtsdPnIZry8wtSfrbNMOV%2Fuploads%2FgtEZaeg2Pad6VtzUHmgX%2Fdnd.png?alt=media&amp;token=a0f21969-7418-4d67-bc8e-dea0b0069a7c" alt=""><figcaption><p><strong>Do Not Disturb (dnd) Status</strong></p></figcaption></figure> <figure><img src="https://43304169-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FtsdPnIZry8wtSfrbNMOV%2Fuploads%2FF7jD96f1k2K6r8zDAeVG%2Finvsible.png?alt=media&amp;token=99ba21ff-bc0b-4792-9877-c4d3d83ed7fd" 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="https://43304169-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FtsdPnIZry8wtSfrbNMOV%2Fuploads%2FXnHkOCNEeh6A90pB4kcq%2Fonline%20channel.png?alt=media&amp;token=3c153fcc-f4ae-48f0-871d-ecbc031eae0d" alt=""><figcaption><p>Online with Player Count Stats</p></figcaption></figure> <figure><img src="https://43304169-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FtsdPnIZry8wtSfrbNMOV%2Fuploads%2Fd4SHsGoamDBzil67zRHD%2Foffline%20channel.png?alt=media&amp;token=e6259c4d-d83e-448e-b971-fff533211389" 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="https://43304169-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FtsdPnIZry8wtSfrbNMOV%2Fuploads%2FMRTXErcQ554JAtKjFU4R%2FautoReply%201.png?alt=media&amp;token=05f39510-5770-413e-a5a5-fb131e043351" alt=""><figcaption><p><strong>Auto Reply for <code>version</code>, <code>ip</code></strong></p></figcaption></figure> <figure><img src="https://43304169-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FtsdPnIZry8wtSfrbNMOV%2Fuploads%2FGRA8DkMeVy4i2vCx64ik%2FautoReply%202.png?alt=media&amp;token=498f194e-96b4-4495-83dd-87f637900bad" 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="https://43304169-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FtsdPnIZry8wtSfrbNMOV%2Fuploads%2FKfg3jhYZK8IyotCqXbRg%2FColor%20Ful%20console.png?alt=media&amp;token=45724749-c551-4386-b385-b3e19ad18072" 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="https://43304169-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FtsdPnIZry8wtSfrbNMOV%2Fuploads%2FsW6H9kTK3AiZx4ESEzmm%2Fstatus.png?alt=media&amp;token=969e6c23-1106-4884-ad52-0f5054271554" alt=""><figcaption><p><strong>Status Command Example</strong></p></figcaption></figure> <figure><img src="https://43304169-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FtsdPnIZry8wtSfrbNMOV%2Fuploads%2FXeTngii0SMPmyZHDs9Vr%2Fhelp.png?alt=media&amp;token=fa3d630e-9075-4940-a364-dbfcab431c0d" alt=""><figcaption><p><strong>Help Command Example</strong></p></figcaption></figure> <figure><img src="https://43304169-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FtsdPnIZry8wtSfrbNMOV%2Fuploads%2F0tLzCnXovoyjpb2BJx9P%2Fhelp%20-%20player.png?alt=media&amp;token=e40091a5-13de-4b56-8ece-301b41fb7c08" alt=""><figcaption><p><strong>Command Help Example</strong></p></figcaption></figure></div>

<div><figure><img src="https://43304169-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FtsdPnIZry8wtSfrbNMOV%2Fuploads%2FhrO8r5P2Bl6MXn524dJj%2Fversion.png?alt=media&amp;token=7cdc00a1-e96e-4b68-8a54-e06a7d2d86a9" alt=""><figcaption><p><strong>Version Command Example</strong></p></figcaption></figure> <figure><img src="https://43304169-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FtsdPnIZry8wtSfrbNMOV%2Fuploads%2FjZhcCx2YUkux9SYfStkc%2Fwebsite.png?alt=media&amp;token=fd686033-539d-4d34-8714-252e96daed7b" alt=""><figcaption><p><strong>Site Command Example</strong></p></figcaption></figure> <figure><img src="https://43304169-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FtsdPnIZry8wtSfrbNMOV%2Fuploads%2F394iZexpIfhYUeWSX4cJ%2Fip.png?alt=media&amp;token=10623c31-7d85-45ea-954f-aa318a5c7c45" alt=""><figcaption><p><strong>IP Command Example</strong></p></figcaption></figure></div>

<div><figure><img src="https://43304169-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FtsdPnIZry8wtSfrbNMOV%2Fuploads%2FdlPpQCFh3qDWmeRneFZo%2Fmotd.png?alt=media&amp;token=6c0dee7c-dd03-448e-86fb-13765b063ecd" alt=""><figcaption><p><strong>MOTD Command Example</strong></p></figcaption></figure> <figure><img src="https://43304169-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FtsdPnIZry8wtSfrbNMOV%2Fuploads%2FDuUqJEmqFtTBG6wFbb2x%2Fplayers.png?alt=media&amp;token=f836a1c8-4454-418a-838e-7834d4cfae03" 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/)


---

# Agent Instructions
This documentation is published with GitBook. GitBook is the documentation platform designed so that both humans and AI agents can read, navigate, and reason over technical content effectively. Learn more at gitbook.com.

## Querying This Documentation
If you need additional information that is not directly available in this page, you can query the documentation by asking a question.

Perform an HTTP GET request on the following URL with the `ask` and `goal` query parameters:

```
GET https://nooberpro.gitbook.io/minecraft-discord-bot/introduction.md?ask=<question>&goal=<user_goal>
```

`ask` is the immediate question: it should be specific, self-contained, and written in natural language.
`goal` is what the user is ultimately trying to achieve, the reason they need the answer. Sharing it helps GitBook give you a better, more relevant answer. A goal is most helpful when it describes the outcome the user wants rather than restating the question. For example, with `ask=how do I create an API token`, a goal like `automate deployments from our CI pipeline` lets GitBook tailor the answer to that use case.

The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.

Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.