Skip to content

Faithful-Resource-Pack/CompliBot-Submissions

Repository files navigation

CompliBot

CompliBot Submissions

Fully automated texture pushing and submission system for the Faithful Discord servers.

RepoSize Issues PullRequests


Found a bug or want to suggest something?

You can either create an issue on our bug tracker or use the /feedback form on our bot.


Requirements

  • NodeJS 18+ https://nodejs.org
  • pnpm (corepack enable + corepack prepare pnpm@latest --activate)

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.

  • Create an app on the Discord Developer Portal.
  • Go to the Bot tab, create a bot and copy its token.
  • Rename the .env.example file to .env and open it using any text editor.
  • Paste in your token after CLIENT_TOKEN.
  • Create two files in resources/ called settings.json and packs.json, both of which can be just a set of curly brackets {}. This will be loaded dynamically later but needs to be created first because of GitHub limitations.

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.

Configuration

  • resources/strings.json for all types of bot-related messages
  • resources/settings.json for roles, channel ids, and colors
  • resources/packs.json for submission pack information

Make sure to disable settings fetching in your .env file if you're adding your own packs locally!

About

Fully automated texture pushing and submission system for the Faithful Discord servers.

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published