![GitHub Downloads (all assets, all releases)](https://img.shields.io/github/downloads/vxrpenter/ScpToolsBot/total?style=for-the-badge&color=%23c9631f) | Languages | Dependencies | Compatibility | |----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------| |

Refactor Information

## Progress - `5%` ![GitHub commit activity (branch)](https://img.shields.io/github/commit-activity/w/Vxrpenter/SCPToolsBot/kotlin_refactor?style=for-the-badge&color=%239141ac&link=https%3A%2F%2Fgithub.com%2FVxrpenter%2FSCPToolsBot%2Ftree%2Fkotlin_refactor&logo=kotlin) ![GitHub branch status](https://img.shields.io/github/checks-status/Vxrpenter/SCPToolsBot/kotlin_refactor?style=for-the-badge&logo=kotlin&color=%239141ac)

SCPToolsBot is getting a full kotlin refactor. This means that there will be no more content updates until the refactor is done. All issues that are created will be fixed normally but there will be no new features.

[!TIP] If you want to keep up with updates then you can look at refactor branch where new commits and changes are pushed to. The master branch will remain as is for now and before merging there will be a branch created to keep as the old java version

What is ScpToolsBot

ScpToolsBot is a discord bot application written in Java for Scp Secret Laboratory discord servers. It includes support functions, cedmod api syncing including community and team management features

If you need any more information check out the wiki

Feature Overview

Currently the bot comes with:

Support system with unban file
SL ruleparsing
Text translation for features
Configurable commands
Notice of Departure for staff
Automatic notice of departure runout detection
automatic applying of playtime roles with the regular feature

More coming soon, look here for more complete overview

Installation

This bot application should be installed on a alltime running server with good internet connection to handle requests fast and be online all the time

Download the .jar file from the latest STABLE release
Install JDK-23 or higher on your machine
Run the jar using java -jar <filename>
The process will automatically crash and create two new folders called configs and translations. Go into the configs folder and edit the config.yml file
After putting in required info start the bot again and it should be running

Get a full guide here

Handling Issues

Bot not starting, why?

Outdated JDK, install higher version
Missing token or guild ID in config

Got error: "Couldn't commence HTTP request to get banID, is the user banned?"

This means that no banId could be found meaning that the user isn't banned

Got error: "Unbanning of ID failed, does it exist?"

This means that the unban process failed because the user is not banned/the ban id is invalid and does not exist

Get a full guide here

[!NOTE] If you are getting an error, not stated in this documentation and are not able to fix it, please create an issue so the issue can be resolved

Star Chart

Thank you's

Thank you to ced777ric for helping me with the cedmod api

Vxrpenter / SCPToolsBot

readme