Getting Started
Setup

Setting up the bot

💡

Make sure you have read the prerequisites to avoid any issues during the setup.

This section will guide you through the steps to set up the bot. A video version of this can be found below.

You can download the bot from here (opens in a new tab).

Local Setup

  1. Create a folder on your desktop.
  2. Move the bot jar file into the folder.
  3. Inside the folder, create a text file and name it "run".
  4. Open the text file and paste the following inside:
:: If your compiled bot jar has a different name, make sure to change it accordingly.
java -jar RankedBot.jar
pause
  1. Rename the text file and change its file extension to .bat, so it should look like run.bat.

When you run the file, it will create all the necessary folders and files, such as those for fonts, themes, databases, etc.

If you encounter an error or see a message in the terminal window indicating that there is no token in the config.yml file, you need to obtain the token from the Discord Developer Portal.

Bot Setup

Now that you have set up the bot on your local machine, you need to obtain a token from the Discord Developer Portal.

Developer Portal

⚠️

Do not share your bot's token with anyone, as it grants full access to your bot.

  1. Go to the Discord Developer Portal (opens in a new tab).
  2. Create a new application.
  3. In the sidebar, click on the "Bot" section.
  4. Here, you can find the token and name your bot.
  5. Click on "Reset Token" to generate a new token.
  6. Copy the bot's token and paste it in your config.yml file.
# Bot's token
token: PASTE_TOKEN_HERE
  1. Scroll down to "Privileged Gateway Intents", and enable all three options.

Inviting the bot

  1. In the sidebar, click on the "OAuth2" section.
  2. Scroll down to "OAuth2 URL Generator", and check the "bot" box.
  3. Scroll down to "Bot permissions", and check the "Administrator" box.
  4. Then scroll down again and copy the generated url.
  5. Select the server you want the bot to be added to.

Starting the bot

After completeting the steps above, you can run the bot using the run.bat file we created earlier.

It might take a moment to start for the first time.

That's it! You have successfully setup the bot. If you are having an issues with the bot, join our Discord (opens in a new tab) server for support.

PrerequisitesStats Builder