GrantBirki / err-backend-discord

Backend for Discord for Errbot

Geek Repo:Geek Repo

Github PK Tool:Github PK Tool

Errbot - Discord

This is a Discord back-end for Errbot. It allows you to use Errbot from Discord to execute commands.

Updates [ ~ Dependencies scanned by PyUp.io ~ ]

Installation

An Errbot instance is required to install the discord back-end. See the Errbot installation documentation for details.

Requirements

  • Python 3.6 or later
  • Discord.py 1.2.3 or later

Virtual Environment

The steps below are to install the discord back-end in Errbot's virtual environment. In the examples below, the virtual environment was set to /opt/errbot/virtualenv and Errbot initialised in /opt/errbot. The "extra" back-end directory is set to /opt/errbot/backend.

  1. If not already set, set Errbot's BOT_EXTRA_BACKEND_DIR variable in /opt/errbot/config.py to the directory you will use to place additional back-ends.
BOT_EXTRA_BACKEND_DIR=/opt/errbot/backend
  1. Set the back-end to use Discord.
BACKEND = 'Discord'
  1. Clone repository to your Errbot back-end directory.
cd /opt/errbot/backend
git clone https://github.com/gbin/err-backend-discord.git
  1. Install back-end dependencies (Errbot's virtual environment must be activated to install the dependencies into it).
source /opt/errbot/virtualenv/bin/activate
cd err-backend-discord
pip install -r requirements.txt
deactivate
  1. Set the bot's token (see Create a discord application for information on how to get the token).
BOT_IDENTITY = {
 'token' : 'changeme'
}
  1. Enable SERVER MEMBERS INTENT for your bot on the Discord website. See here for the required steps.

Create a discord application

For further information about getting a bot user into a server please see: https://discordapp.com/developers/docs/topics/oauth2. You can use this tool to generate a proper invitation link. The reactiflux community have written a quick start guide to creating a discord bot and getting a token

Contributing

  1. Fork it!
  2. Create your feature branch: git checkout -b my-new-feature
  3. Commit your changes: git commit -am 'Add some feature'
  4. Push to the branch: git push origin my-new-feature
  5. Submit a pull request :D

About

Backend for Discord for Errbot

License:GNU General Public License v3.0


Languages

Language:Python 100.0%