search

Faithful-Resource-Pack / CompliBot

The official bot for the Faithful Discord servers.
https://faithfulpack.net
GNU Affero General Public License v3.0
8 stars 8 forks source link
bot discord discord-bot discord-js discordjs faithful node-js

readme

CompliBot

CompliBot

The official bot for the Faithful Discord servers.

![RepoSize](https://img.shields.io/github/repo-size/Faithful-Resource-Pack/CompliBot) ![Issues](https://img.shields.io/github/issues/Faithful-Resource-Pack/CompliBot) ![PullRequests](https://img.shields.io/github/issues-pr/Faithful-Resource-Pack/CompliBot) [![Crowdin](https://badges.crowdin.net/e/656f9fc7c628d23c87426953b11cf26c/localized.svg)](https://faithful.crowdin.com/complibot)

Found an issue?

Please submit it using our bug tracker or by using the /feedback form on our bot.

Requirements

Running

pnpm install
pnpm dev

Bot setup:

DISCLAIMER: We won't help you rebrand the bot for any other server. If you really want to do that, then you need to figure it out yourself.

  1. Create an app on the Discord Developer Portal.
  2. Go to the Bot tab, create a bot and copy its token.
  3. Rename tokens.json.example in the json/ folder to tokens.json.
  4. Paste your token after token. Additional information like API tokens and various testing modes can be enabled from there as well.

API Reference:

This project is heavily developed around our public API. Check out our API documentation at https://api.faithfulpack.net/docs for more information about endpoints and making requests.

Translating:

Many messages shown throughout the bot can be translated into users' native languages for easier usage. Our translation service is powered by Crowdin, and you can start translating there by clicking on your language in the list. All languages that Discord supports should be listed there.