Go to file

Astrid 029eed3786 Merge pull request #134 from nephanim/feature/member-limit Add members per system cap & improve import performance		2019-10-22 19:33:30 +02:00
.github	Create FUNDING.yml	2019-07-15 16:04:51 +02:00
docs	Include underscore properly in display_name API docs	2019-10-18 13:38:25 +02:00
PluralKit.API	Added max member count to limits	2019-10-20 02:16:57 -05:00
PluralKit.Bot	Merge pull request #134 from nephanim/feature/member-limit	2019-10-22 19:33:30 +02:00
PluralKit.Core	Fix edge case of importing exactly enough members to hit the cap	2019-10-20 18:24:00 -05: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
.dockerignore	Optimize Docker build files	2019-08-12 06:49:18 +02:00
.editorconfig	Add .editorconfig	2019-08-13 23:28:03 +02:00
.gitignore	Update .gitignore	2019-08-13 23:28:24 +02:00
docker-compose.yml	Optimize Docker build files	2019-08-12 06:49:18 +02:00
Dockerfile	Optimize Docker build files	2019-08-12 06:49:18 +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	Fix README formatting	2019-08-31 19:12:48 +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

Building the docs

The website and documentation are automatically built by GitHub Pages when pushed to the master branch. They use Jekyll 3, which requires Ruby and Bundler.

To build the docs locally, run:

$ cd docs/
$ bundle install --path vendor/bundle
$ bundle exec jekyll build

To run an auto-reloading server, substitute the last command with: $ bundle exec jekyll serve

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