PunkBuster-Screenshots-to-Discord

Simple tool that sends punkbuster screenshots to a Discord channel using a Discord Bot app.

Features

• Connects to an FTP or SFTP server based on configuration.
• Downloads screenshots and sends them to a Discord channel with Player Name and PB GUID.

Prerequisites

Before running the program, make sure you have:

• Go installed (version 1.20+) (optional)
• Docker and Docker Compose installed
• A Discord Bot Token

Usage

1. Clone this repository:

git clone https://github.com/pruu-networking/PunkBuster-Screenshots-to-Discord
cd PunkBuster-Screenshots-to-Discord

2. Configure the docker-compose.yml file:

SERVER=<FTP_or_SFTP_server>
USER=<Username>
PASS=<Password>
SFTP_FOLDER=<Server_folder_path>
BOT_TOKEN=<Discord_bot_token>
CHANNEL_ID=<Discord_channel_id>
SELECT_FTP_MODE=<sftp_or_ftp>
WAITING_TIME=<Waiting_time_in_minutes>
# DEBUG_MODE=true # Uncomment this line to enable debug mode, use it only for testing purposes

3. Then run it with docker-compose:

sudo docker-compose up --build -d

Update to a new version

Go to the directory where you cloned the repository and run the following commands:

git pull
sudo docker-compose down -v --rmi all
sudo docker-compose up -d --build 

And that's it, the new version is running.

TODO List

• Improve the Config system to something more beautiful.
• Improve the logging system with a log tool/package.
• Improve the code to make it clean and efficient (maybe someday).