liz/PluralKit
liz/PluralKit
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity
541 Commits 1 Branch 0 Tags 12 MiB
C# 75.1%
Svelte 18%
TypeScript 2.9%
Rust 1.4%
Go 0.7%
Other 1.7%
397da2e1fa
Go to file
Noko 397da2e1fa Added max member count to limits 
A given system can now have up to 1000 members. Within 50 members of that limit, a warning will display whenever a new member is created via the bot. Once the limit is reached, a final warning will appear indicating that no additional members can be created unless members are first deleted. Attempting to create a new member at that point by any method will result in an error message indicating that the limit has been reached.

Respecting this in pk;import required some restructuring to tease apart which members already exist and which ones need to be created prior to creating any members as it seems preferable to fail early and give the user the ability to intervene rather than pushing the system to the member cap and requiring manual deletion of "lower priority" members before others can be created. One consequence of the restructure is that existing members are being read in bulk which is a performance improvement of 25-70% depending on how many switches need to be imported (the more members you have, the more noticeable this is).
2019-10-20 02:16:57 -05: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 Added max member count to limits 2019-10-20 02:16:57 -05:00
PluralKit.Core Added max member count to limits 2019-10-20 02:16:57 -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