4d65237ee1
This is no longer used in our infra, and probably should never have been in this repo anyway Closes: PluralKit/PluralKit#511 |
||
|---|---|---|
| .github | ||
| Myriad | ||
| PluralKit.API | ||
| PluralKit.Bot | ||
| PluralKit.Core | ||
| PluralKit.Tests | ||
| dashboard | ||
| docs | ||
| lib/libpk | ||
| proto | ||
| scripts | ||
| services | ||
| .dockerignore | ||
| .editorconfig | ||
| .gitignore | ||
| .gitmodules | ||
| BRANCHRENAME.md | ||
| Cargo.lock | ||
| Cargo.toml | ||
| Dockerfile | ||
| Dockerfile.bin | ||
| Dockerfile.rust | ||
| LEGACYMIGRATE.md | ||
| PluralKit.sln | ||
| README.md | ||
| docker-compose.yml | ||
| go.work | ||
| go.work.sum | ||
| netlify.toml | ||
| pluralkit.conf.example | ||
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://discord.com/oauth2/authorize?client_id=466378653216014359&scope=bot%20applications.commands&permissions=536995904
PluralKit has a Discord server for support, feedback, and discussion: https://discord.gg/PczBt78
Requirements
Running the bot requires .NET 5, a PostgreSQL database and a Redis database. It should function on any system where the prerequisites are set up (including Windows).
Optionally, it can integrate with Sentry for error reporting and InfluxDB for aggregate statistics.
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). The following keys are available (using . to indicate a nested object level), bolded key names are required:
PluralKit.Bot.Token: the Discord bot token to connect withPluralKit.Database: the URI of the database to connect to (in ADO.NET Npgsql format)PluralKit.RedisAddr: thehost:portof a Redis database to connect toPluralKit.Bot.Prefixes: an array of command prefixes to use (default["pk;", "pk!"]).PluralKit.Bot.ClientId: the ID of the bot's user account, used for calculating the bot's own permissions and for the link inpk;invite.PluralKit.SentryUrl(optional): the Sentry client key/DSN to report runtime errors to. If absent, disables Sentry integration.PluralKit.InfluxUrl(optional): the URL to an InfluxDB server to report aggregate statistics to. An example of these stats can be seen on the public stats page.PluralKit.InfluxDb(optional): the name of an InfluxDB database to report statistics to. If either this field orPluralKit.InfluxUrlare absent, InfluxDB reporting will be disabled.PluralKit.LogDir(optional): the directory to save information and error logs to. If left blank, will default tologs/in the current working directory.
The bot can also take configuration from environment variables, which will override the values read from the file. Here, use : (colon) or __ (double underscore) as a level separator (eg. export PluralKit__Bot__Token=foobar123) as per ASP.NET config.
Running
Docker
The easiest way to get the bot running is with Docker. The repository contains a docker-compose.yml file ready to use.
- Clone this repository:
git clone https://github.com/PluralKit/PluralKit - Create a
pluralkit.conffile in the same directory asdocker-compose.ymlcontaining at leastPluralKit.Bot.TokenandPluralKit.Bot.ClientIdfields- (
PluralKit.Databaseis overridden indocker-compose.ymlto 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/PluralKit/PluralKit
$ cd PluralKit
$ cp pluralkit.conf.example pluralkit.conf
$ nano pluralkit.conf # (or vim, or whatever)
$ docker-compose up -d
Manually
- Install the .NET 6 SDK (see https://dotnet.microsoft.com/download)
- Clone this repository:
git clone https://github.com/PluralKit/PluralKit - Create and fill in a
pluralkit.conffile in the same directory asdocker-compose.yml - Run the bot:
dotnet run --project PluralKit.Bot- Alternatively,
dotnet build -c Release -o build/, thendotnet build/PluralKit.Bot.dll
- Alternatively,
(tip: use scripts/run-test-db.sh to run a temporary PostgreSQL database on your local system. Requires Docker.)
Scheduled Tasks worker
There is a scheduled tasks worker that needs to be ran separately from the bot. This handles cleaning up the database, and updating statistics (system/member/etc counts, shown in the pk;stats embed).
Note: This worker is not required, and the bot will function correctly without it.
If you are running the bot via docker-compose, this is set up automatically.
If you run the bot manually you can run the worker as such:
dotnet run --project PluralKit.ScheduledTasks- or if you used
dotnet buildrather thandotnet runto run the bot:dotnet build/PluralKit.ScheduledTasks.dll
Upgrading database from legacy version
If you have an instance of the Python version of the bot (from the legacy branch), you may need to take extra database migration steps.
For more information, see LEGACYMIGRATE.md.
User documentation
License
This project is under the GNU Affero General Public License, Version 3. It is available at the following link: https://www.gnu.org/licenses/agpl-3.0.en.html