nidibot 1.0.4

Discord bot for any Nitrado game server

Nitrado Discord bot

Prerequisites

You need to have following before you proceed with the instructions:

1. Virtual machine (VM) or server somewhere in the Internet.
2. Discord account (register or login at https://discord.com/).
3. Any Discord server where you have access.
4. Nitrado account (register or login at https://server.nitrado.net/en-GB/).
5. Any game server that runs on Nitrado to which you have access.

Installation

1. Login to your VM or server via SSH.
2. Install Python 3.x from https://www.python.org/downloads/ or via following command (only if it is missing or very old):

sudo add-apt-repository ppa:deadsnakes/ppa -y && sudo apt update && sudo apt install python3.12 -y && sudo update-alternatives --install /usr/bin/python3 python3 /usr/bin/python3.12 1

3. Install following packages (Ubuntu/Linux only):

sudo apt install libffi-dev libnacl-dev python3-dev -y

4. Install Discord Python package:

pip install -U discord.py

5. In case if you meet "externally-managed-environment" error under Python 3.11 version, then run following command:

# Ubuntu/Linux only.
sudo mv /usr/lib/python3.11/EXTERNALLY-MANAGED /usr/lib/python3.11/EXTERNALLY-MANAGED.old

6. Install this bot as Python package via pip:

pip install nidibot

7. Or upgrade already installed bot:

pip install nidibot --upgrade

References used (click to show):

• https://discordpy.readthedocs.io/en/latest/intro.html
• https://stackoverflow.com/questions/75608323/how-do-i-solve-error-externally-managed-environment-every-time-i-use-pip-3

Configuration

1. Login to your VM or server via SSH.
2. Create new folder for storing bot files.
3. Proceed to the folder.
4. Call following command for initializing bot in this folder and create default configuration files:

# Ubuntu/Linux only.
python3 -c 'from nidibot import Nidibot; Nidibot.initialize_folder()'

5. Following files should appear.
6. Open bot_configuration.json file in any text editor and modify required values to your own:

{
    "connection": {
        "discord_bot_token": "your-discord-bot-token",
        "nitrado_api_token": "your-nitrado-api-token"
    },
    "discord_admin_users": []
}

7. Install nidibot service, so it will start automatically every system restart.

sudo cp nidibot.service /etc/systemd/system/nidibot.service && sudo systemctl daemon-reload && sudo systemctl enable nidibot.service

8. Start newly installed service:

sudo systemctl start nidibot.service