Skip to content

Latest commit

 

History

History
76 lines (59 loc) · 6.61 KB

README.md

File metadata and controls

76 lines (59 loc) · 6.61 KB
Raw

support-bot

GitHub Workflow Status (CI) Codecov

Support bot written in python to help manage LizardByte communities. The current focus is Discord and Reddit, but other platforms such as GitHub discussions/issues might be added in the future.

Overview

Discord Slash Commands

command description
/help Return help message, for a list of all possible commands

Instructions

Discord

  • Setup an application at discord developer portal.
  • On Bot page enabled these:
    • Presence Intent
    • Server Members Intent
    • Copy the Token

Reddit

Environment Variables

  • Add the following as environment variables or in a .env file (use sample.env as an example).
    ❗ if using Docker these can be arguments.
    ⚠️ Never publicly expose your tokens, secrets, or ids.
variable required default description
DAILY_TASKS False true Daily tasks on or off.
DAILY_RELEASES False true Send a message for each game released on this day in history.
DAILY_CHANNEL_ID False None Required if daily_tasks is enabled.
DAILY_TASKS_UTC_HOUR False 12 The hour to run daily tasks.
DISCORD_BOT_TOKEN True None Token from Bot page on discord developer portal.
DISCORD_CLIENT_ID True None Discord OAuth2 client id.
DISCORD_CLIENT_SECRET True None Discord OAuth2 client secret.
DISCORD_GITHUB_STATUS_CHANNEL_ID True None Channel ID to send GitHub status updates to.
DISCORD_REDDIT_CHANNEL_ID True None Channel ID to send Reddit post updates to.
DISCORD_REDIRECT_URI False https://localhost:8080/discord/callback The redirect uri for OAuth2. Must be publicly accessible.
DISCORD_SPONSORS_CHANNEL_ID True None Channel ID to send sponsorship updates to.
GITHUB_CLIENT_ID True None GitHub OAuth2 client id.
GITHUB_CLIENT_SECRET True None GitHub OAuth2 client secret.
GITHUB_REDIRECT_URI False https://localhost:8080/github/callback The redirect uri for OAuth2. Must be publicly accessible.
GITHUB_TOKEN True None GitHub personal access token. Must have read:org
GITHUB_WEBHOOK_SECRET_KEY True None A secret value to ensure webhooks are from trusted sources.
GRAVATAR_EMAIL False None Gravatar email address for bot avatar.
IGDB_CLIENT_ID False None Required if daily_releases is enabled.
IGDB_CLIENT_SECRET False None Required if daily_releases is enabled.
PRAW_CLIENT_ID True None client_id from reddit app setup page.
PRAW_CLIENT_SECRET True None client_secret from reddit app setup page.
PRAW_SUBREDDIT True None Subreddit to monitor (reddit user should be moderator of the subreddit)
REDDIT_USERNAME True None Reddit username
REDDIT_PASSWORD True None Reddit password
SUPPORT_COMMANDS_REPO False https://github.com/LizardByte/support-bot-commands Repository for support commands.
SUPPORT_COMMANDS_BRANCH False master Branch for support commands.

Start

python -m src
  • Invite bot to server:
    • https://discord.com/api/oauth2/authorize?client_id=<the client id of the bot>&permissions=8&scope=bot%20applications.commands