liz/PluralKit
liz/PluralKit
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity
179 Commits 1 Branch 0 Tags 12 MiB
C# 75.1%
Svelte 18%
TypeScript 2.9%
Rust 1.4%
Go 0.7%
Other 1.7%
3382ca2862
Go to file
Ske 3382ca2862 Fix Discord throwing errors on members named "Clyde" 
This adds a hair-space (\u200A) between the C and the l,
which won't trigger their check for the name. Discord
throws this error because their built-in "status bot"
used in the client is named Clyde.
2018-12-15 19:56:59 +01:00
scripts Fix the backup scripts (cronjob didn't fire for a month...) 2018-11-07 21:16:34 +01:00
src Fix Discord throwing errors on members named "Clyde" 2018-12-15 19:56:59 +01:00
.gitignore Major command handling refactor 2018-09-07 17:34:38 +02:00
docker-compose.yml *insert Dinner Party vasectomy quote here* 2018-12-11 21:02:30 +01:00
README.md Add a Discord invite link to the README 2018-09-09 21:09:31 +02:00

README.md

PluralKit

PluralKit is a Discord bot meant for plural communities. It has features like message proxying through webhooks, switch tracking, system and member profiles, and more.

PluralKit has a Discord server for support and discussion: https://discord.gg/PczBt78

Requirements

Running the bot requires Python (specifically version 3.6) and PostgreSQL.

Configuration

Configuring the bot is done through environment variables.

  • TOKEN - the Discord bot token to connect with
  • CLIENT_ID - the Discord bot client ID
  • DATABASE_USER - the username to log into the database with
  • DATABASE_PASS - the password to log into the database with
  • DATABASE_NAME - the name of the database to use
  • DATABASE_HOST - the hostname of the PostgreSQL instance to connect to
  • DATABASE_PORT - the port of the PostgreSQL instance to connect to
  • LOG_CHANNEL (optional) - a Discord channel ID the bot will post exception tracebacks in (make this private!)

Running

Docker

Running PluralKit is pretty easy with Docker. The repository contains a docker-compose.yml file ready to use.

  • Clone this repository: git clone https://github.com/xSke/PluralKit
  • Create a .env file containing at least TOKEN and CLIENT_ID in key=value format
  • Build the bot: docker-compose build
  • Run the bot: docker-compose up

Manually

You'll need to pass configuration options through shell environment variables.

  • Clone this repository: git clone https://github.com/xSke/PluralKit
  • Create a virtualenv: virtualenv --python=python3.6 venv
  • Install dependencies: venv/bin/pip install -r requirements.txt
  • Run PluralKit with environment variables: TOKEN=... CLIENT_ID=... DATABASE_USER=... venv/bin/python src/bot_main.py