Skip to content
 
 

Repository files navigation

CompliBot Logo

CompliBot Commands

The official bot for the Faithful Discord servers.

RepoSize Issues PullRequests Crowdin


Requirements

  • Node.js v22+ (https://nodejs.org)
  • pnpm (corepack enable + corepack prepare pnpm@latest --activate)

Running

pnpm install
pnpm dev

Warning

While CompliBot is designed to be reasonably easy to fork and run your own instance of, we can't offer individual support for your specific use case. Your mileage may vary in terms of necessary code modifications!

  1. Log into the Discord Developer Portal.
  2. Create an application, navigate to the Bot tab in its settings, 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 uses the Faithful API for retrieving most dynamic data, such as texture information, user contributions, and available resource packs. Check out our API reference for documentation about each API endpoint and its associated types.

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.

About

The official bot for the Faithful Discord servers.

Resources

Stars

0 stars

Watchers

0 watching

Forks

Releases

Packages

Contributors

Languages