carim-discord-bot-heroku

This repo is for deploying the Carim Discord Bot using Heroku

Video guide: https://youtu.be/LiklhYLcYy8

Steps for initial setup

1. Set up a free Heroku account
2. Follow Heroku set up instructions
3. Clone this repository
   • git clone https://github.com/schana/carim-discord-bot-heroku.git
   • cd carim-discord-bot-heroku
4. Configure the bot
5. Commit your changes
   • git add -A
   • git commit -m "Added my configuration"
6. Create the Heroku app
   • heroku create
   • git push heroku master
   • heroku ps:scale worker=1
7. You can check the logs to make sure everything is running properly
   • heroku logs

Steps to update configuration

1. Make your changes
2. Commit your changes
   • git add -A
   • git commit -m "Updated my configuration"
3. Update Heroku app
   • git push heroku master

Steps to update carim-discord-bot

You only need to do this when the bot version needs updated. By default, the lastest version will be used when initially set up.

1. Edit requirements.txt
2. Replace carim-discord-bot with carim-discord-bot=={version}, where {version} is the version you want. Find the latest version on PyPI.
   • carim-discord-bot==2.2.1
3. Commit your changes
   • git add -A
   • git commit -m "Updated bot version"
4. Update Heroku app
   • git push heroku master

Configuration

For additional help, visit the Carim Discord at https://discord.gg/kdPnVu4

1. Create bot account

   • Follow the guide at https://discordpy.readthedocs.io/en/v1.3.3/discord.html
   • Save the token for later
   • In step 6 under "Creating a Bot Account", make sure "Public Bot" is unticked
   • Under "Inviting Your Bot", step 6 has you setup the permissions for the bot
   • Currently, the bot needs "Manage Channels", "View Channels", "Send Messages", and "Embed Links"

2. Update configuration

   • Edit config.json with your values following the descriptions here

   • To get Discord Channel IDs, you need to enable developer mode in the app:

     • Settings -> Appearance -> Advanced -> Developer Mode

   • Then, you will be able to right click on a Channel and select "Copy ID"

CFTools integration

1. Make your cftools account a developer
   • https://wiki.cftools.de/display/CFTOOL/Developer+Accounts
2. Create a cftools application
   • https://network.cftools.de/cfapi/overview
3. Open the application dashboard and copy the grant url
4. Open the grant url and allow your application to access your service
5. Fill in the values in the bot's config for cftools_application_id, cftools_client_id, cftools_secret, and cftools_service_id
6. Use the commands --leaderboard <stat type> and --stats <steam64id> in the user command channel for querying