README.md

Tanzanite

Tanzanite is a multipurpose moderation and utility bot. It contains an extensive auto-moderation system, leveling features, message highlighting, and information commands.

Set Up

Prerequisites

• Node.JS v20.11.0+
• Yarn
• git
• A discord bot to use
• PostgreSQL
  • You will need two databases, by default: "tanzanite-dev" and "tanzanite-shared"

Steps

• Clone the repo
• Install the dependencies by running yarn install
• Copy config/options.example.ts to config/options.ts
  • Modify config/options.ts with your bot token and postgres login
• Copy lib/badlinks-secret.example.ts to lib/badlinks-secret.ts
• Start the bot with yarn start
  • Run yarn dev to start the bot using incremental compilation

Contributing

If you would like to contribute to the bot feel free to open a pull request and one of the devs will look at it.

Credits

• discord.js - The main library used to interface with discord
• discord-akairo - The framework the bot is built on