Status Manager Bot

• A functional Discord bot created by myself to address a niche concept that suits my needs. Its main functionality is monitoring a Minecraft server, displaying the public IP of the machine running the JAVA server, the number of players, their names, and whether the server is online.

• Main support functionality: Minecraft server LOG in a Discord chat for better remote monitoring, show in embeds the players who joined and left the server, achievement logs are shown too.

• It is recommended to start the bot together with your main minecraft server is ON (Right about when the server is on succesfully, you can start the bot). The bot reads the latest.log file and would send everything again in the chat specified, so attention is advised (I'm looking into better solutions to this problem, any guidance would be appreciated).

• Be aware of the risks of using RCON. Do not map or port-foward the port of your RCON!

How things should look!

Server will show all of its data in real time, how many players, their names, if the server is online, etc.

---

Communication between discord server and minecraft server through RCON:

---

Players joining and leaving the server!

---

Advancements/goals/challenges will be shown with their respective color!

---

Deaths of players, named entities and villagers will be shown!

---

Now, lets get started!

Table of Contents

• Pre-requisites
• Installation
• Configuration
• Executing
• Important Notes

Pre-requisites

• Python 3.8 or higher
• Docker (optional)

Installation

1. Clone the repository (if you haven’t done so already):

git clone <https://github.com/VslVictor7/Status-Manager-Bot.git>

cd Status-Manager-Bot

2. Create a Virtual Environment (venv):

python -m venv venv

3. Activate the Virtual Environment::

source .venv/scripts/activate

4. Upgrade pip

python -m pip install --upgrade pip

5. Install requirements.txt

pip install -r requirements.txt

Configuration

1. Configuration of the .env file:

• Duplicate the .example-env file and rename it to .env

DISCORD_TOKEN=: This is explained by itself.

CHANNEL_ID=: ID of the channel where it will be sent a placeholder message to be edited later on, continue to understand what i mean.

2. Send the bot's initial message:

• Python file directory: bot/core/utils/bot_sender.py

• with both the token and channel_id collected, you can now run the script 'bot_sender.py'.

• Run the bot_sender.py script to send a placeholder message that will be used as a base to update the message with an embed showing Minecraft server information.

python bot_sender.py

• Don’t worry, you can run the script independently. As long as you're in the file directory, use 'py bot_sender.py' to run the script.

3. Finishing .env configuration.

With the two steps out of they way, we can now continue to configure the env file.

MESSAGE_ID=: ID of the placeholder message we literally just sent. collect it and put it here.

JSON_PATH=: path of the 'stats' folder. It is present inside a minecraft server in the 'world' folder. you just need to copy the path of the stats folder, nothing else.

SERVER_LOGS=: Beta feature im still working on. Ignore this and let it blank.

DISCORD_CHANNEL_CHAT_EVENTS_ID=: This will be the ID of the channel to show every event currently set within the bot. So, people joining and leaving the server, deaths of players, players chatting, deaths of mobs, Advancements and Discord user messages appearing inside the server. It is advised to create a new channel just for this one.

MINECRAFT_SERVER=: IP of your server. It will only accept: SRV records and Local ip's. IF you're running your server in a docker container, you need to insert the local ip address of the machine running the container (192.168.15.1 for example). If its not running in a docker container, you can just leave it there with "localhost".

MINECRAFT_PORT=: This is explained by itself.

SERVER_MODE=: Leave this to "0" or blank if your minecraft server is running the setting: "online-mode=true". if your server is "false", set the variable to "1", futhermore it will be explained what you should do IF you want to make everything look preatier in offline mode.

RCON_HOST= RCON_PORT= RCON_PASSWORD=: These are important to make the joining and leaving the server events and discord users sending messages to work. if you're running the server in a container, set the host to be the name of your minecraft server SERVICE, the name is within your compose file. If your server is not running in a container, set the host to be the IP of your minecraft server (explained what can work in the variable MINECRAFT_SERVER).

API_PORT=: And finally, the API port. This is the API that will search for mob icons and death messages, so set the port to whatever you want, as long as it matches to the api.

'Offline mode' servers (Ignore section if your server is "online-mode:true"):

• For offline servers, there is a variable in the .env.example that you can output a number "1" to set it to run in a offline server.

• It tracks the local UUID files, so it is important to read the .env.example with caution.

1. Create a "players.json" file inside bot/core/utils/json and map the player names and their respective UUID's

• Example of "players.json" (Add more players in the same format as bellow if you want to):

{
   "Awesome-gamer-NAME": {
        "uuid": "487f52ba-919b-39c1-8a46-1e37aef66614",
        "original": false,
        "skin": null
   },
   "Player1-nameEXAMPle": {
        "uuid": "0377e3e3-c767-330c-b352-70f60f5e7b83",
        "original": true,
        "skin": null
   },
   "JorjinGamer": {
        "uuid": "86c5cd29-ecd6-3611-8e9a-c937807f9807",
        "original": false,
        "skin": "https://p.novaskin.me/6250983452049408.png?class=thumbnail"
   }
}

• If player DOES have the original game: set "true" in original and "null" in skin.

• If player DOES NOT have the original game: set "false" in original and in skin, add a domain directly to a .png file of the helm (face of the minecraft skin). For instance:

"https://p.novaskin.me/6250983452049408.png?class=thumbnail"

IMPORTANT: the uuid's present in the "players.json" are NOT the online uuid's you find in the internet! They are a separate type of UUID.

• Go to the directory present in "bot/tools/offline-uuid.py", that's a function to see what is the UUID of a set String. It should look like this:

• In the line present in "final = get_offline_uuid("test")" change the string "test" to the username you want to get the uuid. For isntance:

final = get_offline_uuid("JorjinGamer")

• Be certain to be in the same directory as the said script before you run it, then run the script by using:

py offline-uuid.py

• The script should return something like this:

86c5cd29-ecd6-3611-8e9a-c937807f9807

• Collect each UUID for each player as you wish and add them in "players.json"

Docker configuration (Ignore section if you're not using docker)

• You might need to tweak some things depending on how you're planning to run the bot.

• The compose file, by default, is looking like this:

services:
  discord-bot:
    build:
      context: .
      dockerfile: Dockerfile
    container_name: bot-desenvolvimento
    image: discord-bot:dev
    env_file:
      - .env
    tty: true
    stdin_open: true
    environment:
      RCON_PASSWORD: ${RCON_PASSWORD}
      RCON_PORT: ${RCON_PORT}
    volumes:
      - server_test:/data:ro
      - /data/logs/latest.log:/logs/latest.log
      - /data/world/stats:/world/stats
    networks:
      - request

volumes:
  server_test:
    external: true

networks:
  request:
    external: true

• It considers: 1. You're running the minecraft server in a docker container (Itzg minecraft image or a custom one). 2. The api is running on a container too.

• Why is this you ask?

1. The bot will read the latest.log file as well as getting the stats from the players in the /stats directory. the volume is needed for that reason.

2. The network is made to avoid the mapping of the RCON port and to make requests for the api. In any circumstance you SHOULD NOT map the RCON port.

• If that's your case, just change the name of the volume and networks to the one you're using in the services mentioned the line behind.

If that's not your use case, that's okay too, here's the guide:

• As mentioned in the ENV variables section, this part will be a little similar.

1. You need to get the path of your stats folder and the path of the latest.log file. example bellow:

services:
  discord-bot:
    build:
      context: .
      dockerfile: Dockerfile
    container_name: bot-desenvolvimento
    image: discord-bot:dev
    env_file:
      - .env
    tty: true
    stdin_open: true
    environment:
      RCON_PASSWORD: ${RCON_PASSWORD}
      RCON_PORT: ${RCON_PORT}
    volumes:
      - "C:/path/to/your/server/world/stats:/data/world/stats"
      - "C:/path/to/your/server/logs/latest.log:/data/logs/latest.log"

The above example uses a windows path, change it according to your system.

• That should be your compose file! Now keep going down to see how to run!

Executing:

• After configuring the .env file and obtaining a placeholder message, run the bot using:

python main.py

(Be sure to be in the same directory as "main.py" before running the script)

Finally, if you plan to run it in a Docker container, read below:

Running with Docker Container

• Make sure you are in the directory of the Dockerfile and docker-compose files.

• Ensure the .env and requirements.txt files are also in the directory mentioned above.

Run the container with:

docker compose up --build

Important Notes

• .gitignore File: Include the name of your venv folder (e.g., venv/ or .venv/) in the .gitignore to avoid commit conflicts.

• Necessary Substitutions: Make sure to replace the tokens and IDs in the .env file to ensure the bot functions correctly.