Installation
There are 3 ways of installing the bot. After following this installation guide, it would be good if you looked at the Setup Guide that guides you through configuration etc.
There's an installation script that is updated with every release. Just head to the latest release and download the installer.sh. After downloading the installer, give it the right permissions and execute it.
chmod +x installer.sh
sudo ./installer.sh
You can always head to the latest release and download the .jar that contains the bot. Just make sure you have java 22 or higher installed and you are good to go.
sudo java -jar <file.jar>Note
The image itself, that it provided on docker hub can run without a compose file, but will not work, due to the missing configuration bind. You have to download the compose config, as well as the .env to run the bot.
Make sure you have docker, as well as docker compose installed on your system. If docker is not running, activate it with sudo systemctl start docker (linux)
You can just download the docker-compose.yml and .env file and run docker compose to start up the image.If you want to change the bind location of the configs, go into the .env file and change the location to whatever you like.
mkdir ScpToolsBot
cd ScpToolsBot
curl -L https://raw.githubusercontent.com/Vxrpenter/SCPToolsBot/blob/master/docker-compose.yml
curl -L https://raw.githubusercontent.com/Vxrpenter/SCPToolsBot/blob/master/.env
sudo docker compose upIf you want to build the image yourself you have to clone the repository and change the docker-compose.yml to this.
services:
bot:
build: .
ports:
- "8080:8080"
volumes:
- ${CONFIG_PATH}/SCPToolsBot/:/bot/SCPToolsBot/When you want the latest version that is available not even for release you can build from source. This means that you will need to clone the GitHub repository and compile it to a .jar file. You can find the build in the /build/libs/ folder.
git clone https://github.com/Vxrpenter/SCPToolsBot
cd SCPToolsBot
chmod +x gradlew
./gradlew shadowjar