liz/PluralKit
liz/PluralKit
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity
712 Commits 1 Branch 0 Tags 12 MiB
C# 75.1%
Svelte 18%
TypeScript 2.9%
Rust 1.4%
Go 0.7%
Other 1.7%
9e47f98a23
Go to file
BeeFox-sys 9e47f98a23
Improve Docs (#151) 
* Added configurable command prefix

* Added getting started, renamed files

* Add nav order, add assests, add system example

* Added a lot

* Update Emojis

* Add guide links to bot

* Added Images
2020-02-09 14:17:26 +01:00
.github Check out submodules when building in Actions 2019-12-24 01:15:29 +01:00
Discord.Net@23567d17a6 Update D.NET repo pointer 2020-01-17 19:01:19 +01:00
docs Improve Docs (#151) 2020-02-09 14:17:26 +01:00
PluralKit.API Fix API token handling 2020-02-01 22:17:13 +01:00
PluralKit.Bot Improve Docs (#151) 2020-02-09 14:17:26 +01:00
PluralKit.Core Handle imports from other systems/instances with different HIDs 2020-02-03 15:16:57 +01:00
scripts Make backup script more robust 2019-07-21 01:05:09 +02:00
.dockerignore Exclude in-dir archives/backups from the Docker context 2019-12-23 01:45:40 +01:00
.editorconfig Add .editorconfig 2019-08-13 23:28:03 +02:00
.gitignore Update .gitignore 2019-08-13 23:28:24 +02:00
.gitmodules Use fork of D.NET to potentially resolve issues 2019-12-23 18:36:56 +01:00
docker-compose.yml Don't expose API port to the outside world 2019-12-22 00:42:06 +01:00
Dockerfile Fix Docker build with new D.NET 2019-12-23 18:46:58 +01:00
pluralkit.conf.example Actually add the example config file 2019-07-01 01:16:44 +02:00
PluralKit.sln Use fork of D.NET to potentially resolve issues 2019-12-23 18:36:56 +01: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