Skip to content

znibb/WowDiscordRaidHelperBot

Repository files navigation

WowDiscordRaidHelperBot

For convenient automation of interactions with Google Sheets.

For change log check CHANGELOG.md

Setup

File setup

  1. Create a project directory, e.g. cd ~ && mkdir WowDiscordRaidHelperBot && cd WowDiscordRaidHelperBot
  2. Download docker-compoes.yml to your docker host, e.g. wget https://raw.githubusercontent.com/znibb/WowDiscordRaidHelperBot/master/docker-compose.yml
  3. Download .env-remplate to .env, e.g. wget -O .env https://raw.githubusercontent.com/znibb/WowDiscordRaidHelperBot/main/.env-template
  4. Download config.json-template to config.json, e.g. wget -O config.json https://raw.githubusercontent.com/znibb/WowDiscordRaidHelperBot/main/config.json-template
  5. Copy the channel IDs of the channel where you want the bot to listen to commands and output announcements to BOT_CMD_CHANNEL_ID and BOT_ANNOUNCE_CHANNEL_ID fields respectively in .env

Discord

  1. Go to http://discordapp.com/developers/applications
  2. Create a new application
  3. Go to Bot sub menu and create a bot user
  4. Copy the bot TOKEN and paste it into the DISCORD_TOKEN field in .env
  5. From the Bot sub menu make sure SERVER MEMBERS INTENT is enabled
  6. Go to OAuth2 sub menu
  7. In SCOPES select bot and in BOT PERMISSIONS select View Channels, Send Message, Manage Messages and Embed Links
  8. Copy the generated URL and paste it into your web browser of choice
  9. Select which server to add bot user to

Google Sheets

  1. Go to https://console.cloud.google.com/apis/credentials and log in
  2. Create a project
  3. Select Credentials -> Create Credentials -> Service account
  4. Enter a suitable Service account name and Service account description, what you name it doesn't matter, it's just what will be shown in access logs later on
  5. Click Continue
  6. Enter Editor under Select a role.
  7. Click Done
  8. Click your newly created Service account in the list and go to the KEYS tab
  9. Click ADD KEY -> Create new key
  10. Select Key type JSON and click CREATE
  11. You will be prompted to download the created file, save it in the project directory (e.g. ~/WowDiscordRaidHelperBot) as google_key.json (THIS FILE IS SECRET, SHOULD BE HANDLED WITH CARE AND SHOULD NOT BE DISTRIBUTED)
  12. Go to the DETAILS tab and copy the account email
  13. Go to your Google Sheet, click File->Share and add the email from last step with editor rights.
  14. Copy the URL to your sheet and paste it into the SPREADSHEET_URL file in .env

Start the bot

  1. From the repo dir, run docker-compose up -d

Usage

The information linking your raids to worksheets resides in config.json.

About

For convenient automation of interactions with Google Sheets.

Resources

Stars

Watchers

Forks

Packages

No packages published