README.md

BruhBot

BruhBot is a chatbot for use with the Discord chat service.

Dependencies

• Ruby 2.1+
• Bundler Ruby Gem Bundler.
• Image Magick
• libav-tools
• ffmpeg

Other dependencies are listed in the Gemfile.

Installation - Linux

1. Install dependencies using the command: sudo apt-get install git libav-tools imagemagick libmagickwand-dev ffmpeg

2. Run the command: git clone https://github.com/FormalHellhound/BruhBot.git yourfoldername

3. Go into the directory you just cloned into with: cd /path/to/yourfoldername

4. Clone the plugins repository with: git clone https://github.com/FormalHellhound/BruhBot-Plugins.git plugins

5. Bundler Install bundler by running the following command: gem install bundler

6. Now run the command: bundle install to install all of the dependencies.

Configuration

1. Make a copy of apikeys.json.sample and name it apikeys.json

2. Open apikeys.json and fill in the desired API keys.

3. Go through each plugin folder in plugins, and copy the sample config files to config.json and make any desired changes.

Running - Linux

1. I recommend running using screen, so that you can have it run in the background while doing other things in the terminal.

2. Install screen with: sudo apt-get install screen

3. Navigate to the folder where you cloned the project, and run: screen -S BruhBot You can replace BruhBot with whatever name is easy for you to remember.

4. You will be in a screen. Run the command: ruby bot.rb or ./bot.rb

5. Hold control and press a and then d to disconnect from the screen.

6. To rejoin the screen run: screen -r BruhBot BruhBot would be the name of your screen if you changed it to something else in Step 3.

7. Hold control and press c in the screen to stop the bot, or run the !shutdown command in your Discord server.