liz/PluralKit
liz/PluralKit
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity
471 Commits 1 Branch 0 Tags 12 MiB
C# 75.1%
Svelte 18%
TypeScript 2.9%
Rust 1.4%
Go 0.7%
Other 1.7%
606f48fdb5
Go to file
Ske 606f48fdb5 Add display name to member card
2019-08-09 10:39:03 +02:00
.github Create FUNDING.yml 2019-07-15 16:04:51 +02:00
docs Add display names to documentation 2019-08-09 10:34:41 +02:00
PluralKit.API Return member after create/edit 2019-07-28 23:23:48 +02:00
PluralKit.Bot Add display name to member card 2019-08-09 10:39:03 +02:00
PluralKit.Core Add member proxy display names 2019-08-09 10:12:38 +02:00
PluralKit.Web Clean up unused imports 2019-07-17 13:38:23 +02:00
scripts Make backup script more robust 2019-07-21 01:05:09 +02:00
.gitignore Add basic logging framework 2019-07-18 17:13:42 +02:00
docker-compose.yml Bump database maximum connections to 1000 in Docker 2019-08-04 13:52:25 +02:00
Dockerfile Fix Dockerfile not including API subdirectory 2019-07-10 08:55:24 +02:00
pluralkit.conf.example Actually add the example config file 2019-07-01 01:16:44 +02:00
PluralKit.sln Add basic API, only with system endpoints 2019-07-09 20:39:29 +02:00
README.md Clarify install instructions in the README 2019-07-10 16:24:33 +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.

Do you just want to add PluralKit to your server? If so, you don't need any of this. Use the bot's invite link: https://discordapp.com/oauth2/authorize?client_id=466378653216014359&scope=bot&permissions=536995904

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

Requirements

Running the bot requires .NET Core (v2.2) and a PostgreSQL database.

Configuration

Configuring the bot is done through a JSON configuration file. An example of the configuration format can be seen in pluralkit.conf.example. The configuration file needs to be placed in the bot's working directory (usually the repository root) and must be called pluralkit.conf.

The configuration file is in JSON format (albeit with a .conf extension), and the following keys (using . to indicate a nested object level) are available:

The following keys are available:

  • PluralKit.Database: the URI of the database to connect to (in ADO.NET Npgsql format)
  • PluralKit.Bot.Token: the Discord bot token to connect with

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 pluralkit.conf file in the same directory as docker-compose.yml containing at least a PluralKit.Bot.Token field
    • (PluralKit.Database is overridden in docker-compose.yml to point to the Postgres container)
  • Build the bot: docker-compose build
  • Run the bot: docker-compose up

In other words:

$ git clone https://github.com/xSke/PluralKit
$ cd PluralKit
$ cp pluralkit.conf.example pluralkit.conf
$ nano pluralkit.conf  # (or vim, or whatever)
$ docker-compose up -d

Manually

  • Install the .NET Core 2.2 SDK (see https://dotnet.microsoft.com/download)
  • Clone this repository: git clone https://github.com/xSke/PluralKit
  • Create and fill in a pluralkit.conf file in the same directory as docker-compose.yml
  • Run the bot: dotnet run --project PluralKit.Bot

License

This project is under the Apache License, Version 2.0. It is available at the following link: https://www.apache.org/licenses/LICENSE-2.0