FAXES Documentation > Overflow Bot > Installation

Installation

FAXES

Requirements:
Overflow Bot has some requirements to have your bot placed online. This guide assumes you have the below things set up and operating.


Don't have the requirements? Check out Snowside hosting and use code FAXES @ checkout and get 25% off forever!


Creating A Discord Application

First off you will need to head on to the Discord developer portal and create an application.

img

Click on Bot > Add Bot. Then copy the token, use this in the config.json file in the next step. once done, go back to the General Information tab and copy the Client ID. Go to the below link and insert the client ID in the URL.

https://discordapp.com/oauth2/authorize?client_id=CLIENT_ID_HERE&scope=bot&permissions=8

Replace the CLIENT_ID_HERE with your bots Client ID. This will invite the bot into the selected Discord when you enter the URL.

Installing Bot Files

Unpackage your bot into a folder where you wish to run the bot from. A folder on the desktop will work in most cases for Windows users. For Linux, the /home directory should work. Extract the package into the folder.

Configuration

OverflowBot is a feature rich bot and with that is over 150 configuration options. Be sure to check out the OverflowBot Configuration Documentation for details on each configuration option.

Edit the config.json file to your liking. Make sure to place the token into the token location. we copied this in Step 2 above. Once that is edited, save it.

IMPORTANT. READ THIS!!!
The /db folder should not be touched at all unless you know what you're doing! you can break your bot massively if you make even minor edits to files in this folder!

Starting Overflow Bot

Navigate to the folder where your bot is install in. and run the below listed commands for your OS.

Windows:

  • In the folder of your bot use SHIFT and RIGHT CLICK and select Open Powershell window here

  • Run the below command. If NPM does not work, make sure Node.js is installed globally (C: drive) and not in some folder in a different location.

npm i

This installs all the packages required for Overflow Bot to run.

Run the start command to have your bot online.

node index.js

You will always use this command to start the bot. Use Ctrl + C to stop the bot.


Linux:

Navigate to the folder of your bot via cd.

cd /home/overflowbot

Run the below command. If NPM does not work, make sure Node.js is installed globally and not in some folder in a different location.

npm i

Now you can start your bot making your bot online.

node index.js

You will always use this command to start the bot. Use Ctrl + C to stop the bot.