VIP-Exchanger-Bot

Documentation · Report Bug · Request Feature

• About the Project
• Tech Stack
• Environment Variables
• Requirements
• Getting Started
• Usage
• Commands
• Roadmap
• License
• Contact

The VIP-Exchanger-Bot is a Discord bot for synchronizing and managing VIP lists for Hell Let Loose servers. The bot can synchronize VIP lists between servers, perform automatic synchronizations and manage VIPs.

• Programming language: Python 3.12
• Libraries: discord.py, python-dotenv, aiohttp, requests
• Database: SQLite3

The following environment variables must be defined in an .env file:

DISCORD_BOT_TOKEN=<YOUR DISCORD BOT TOKEN>
RCON_API_TOKEN=<API TOKEN FROM CRCON-TOOL>
RCON_API_URL=<CRCON API URL>
TARGET_API_URL=<TARGETSERVER API URL>
TARGET_API_TOKEN=<API TOKEN FROM CRCON-TARGERTSERVER>
DB_FILE=vips.db
ALLOWED_ROLES=123456789012345678,987654321098765432
VIP_REGEX=(\S+)\s(.+)\s(\d{4}-\d{2}-\d{2}T.+)
VIP_FILTERS=VIP,Admin,Mod #z.B. KL,23.,[100.]
AUTO_SYNC_INTERVAL=24  # Synchronization of the filtered VIP list every 24 hours
VIP_LOG_CHANNEL=1329971694609240116 #Channel for notifications of VIP changes

The VIP list must be maintained in such a way that you can clearly identify your members. It is recommended to put a 'clan tag' in front of each name. Example data:

<SteamID>          <Clantag. Name>  <expiration date>
12345678912345342  [KL]Schultz  3000-01-01T00:00:00+00:00

A tab should be used between SteamID, name and expiration date.

The following authorizations must be set up so that the bot can work correctly with the RCON API under http://:/admin/:

• can_download_vip_list: Download the VIP list.
• can_add_vip: To add VIPs.
• can_remove_vip: For removing VIPs.
• can_view_vip_ids: To retrieve the IDs of VIPs.

• can_view_playerids: To retrieve player IDs and names.
• can_view_detailed_players: For detailed player information.
• can_view_player_info: For basic player information (name, Steam ID, etc.).

Create an additional API token that will be required later in the .env

- Take a Username for your Bot and a Icon if you want.
- Push the Button RESET TOKEN and save your Discord Token that you need for the .env later
- Enable the "Message Content Intent" under Privileged Gateway Intents.

SCOPES: applications.commands and bot
PERMISSIONS: READ MESSAGE HISTORY, SEND MESSAGES, ATTACH FILES, EMBED LINKS, and Manage Messages

INSTALLATION: Copy the install link and run it in your browser.

# Clone the project repository
git clone https://github.com/FwSchultz/Discord-VIP-Exchanger
cd Discord-VIP-Exchanger

A virtual environment (venv) makes it possible to manage dependencies for the bot in isolation. This ensures that the installed packages do not overlap with other Python projects.

sudo apt update && sudo apt install python3 python3-venv python3-pip -y  # Debian/Ubuntu
sudo dnf install python3 python3-venv python3-pip -y  # Fedora
sudo yum install python3 python3-venv python3-pip -y  # CentOS/RHEL

cd /home/user/bot

python3.12 -m venv venv && source venv/bin/activate && pip install -r requirements.txt && deactivate

DISCORD_BOT_TOKEN=<YOUR DISCORD BOT TOKEN>
RCON_API_TOKEN=<API TOKEN FROM CRCON-TOOL>
RCON_API_URL=<CRCON API URL>
TARGET_API_URL=<TARGETSERVER API URL>
TARGET_API_TOKEN=<API TOKEN FROM CRCON-TARGERTSERVER>
DB_FILE=vips.db
ALLOWED_ROLES=123456789012345678,987654321098765432
VIP_REGEX=(\S+)\s(.+)\s(\d{4}-\d{2}-\d{2}T.+)
VIP_FILTERS=VIP,Admin,Mod #z.B. KL,23.,[100.]
AUTO_SYNC_INTERVAL=24  # Synchronization of the filtered VIP list every 24 hours
VIP_LOG_CHANNEL=1329971694609240116 #Channel for notifications of VIP changes

cp .env.dev .env

<bot-directory> venv/bin/python bot.py

Managing Services with systemctl

• edit the file with your settings

[Unit]
Description=Discord-VIP-Exchanger
After=network.target

[Service]
User=root
WorkingDirectory=/home/user/Discord-VIP-Exchanger
ExecStart=/home/user/Discord-VIP-Exchanger/venv/bin/python3 /home/user/Discord-VIP-Exchanger/bot.py
Restart=always

[Install]
WantedBy=multi-user.target

sudo systemctl enable <service-name>  # Enable the service at boot
sudo systemctl start <service-name>   # Start the service immediately

sudo systemctl stop <service-name>    # Stop the service
sudo systemctl disable <service-name> # Prevent the service from starting at boot

sudo systemctl status <service-name>

The bot runs as a Discord bot and can be controlled via chat commands.

• Backup System
• Language file (en,esp,fr,de)

Dieses Projekt ist unter der MIT License lizenziert.

Erstellt von Fw.Schultz. Bei Fragen oder Vorschlägen, bitte ein Issue auf GitHub erstellen.

📧 Kontakt: Discord