Skip to content

Latest commit

 

History

History
43 lines (33 loc) · 2.4 KB

README.md

File metadata and controls

43 lines (33 loc) · 2.4 KB
Raw

A moderation-heavy general purpose Discord bot.

Features

  • Avatar grabber
  • Bans
  • Message purging
  • Mutes
  • Notes
  • Reminders
  • Server information
  • Tracker status
  • Unbans
  • Unmutes
  • Voting
  • Warns

Getting started

You will need a Discord bot with privileged intents enabled and the token for that bot before setup. You can create a new Discord bot here. Keep in mind Chiya will need the bot and applications.commands scopes selected when you generate your OAuth2 URL to function properly. If you intend on using the Reddit functionality, you will also need to create a Reddit application here.

Setup

Chiya is deployed into a production environment using Docker images. As such, the install guide will focus on deployment via Docker. Chiya has been tested on both Windows and Linux bare metal environments and attempts to retain compatibility across both operating systems but this may not always be the case. The install guide assumes that you already have Docker and docker-compose installed.

Steps:

  1. Download docker-compose.yml and fill it out for your deployment.
  2. Create a new directory called config in the same directory.
  3. Download config.default.yml into config, fill it out for your deployment, and rename the file to config.yml.
  4. Pull the Docker image and start the containers by running docker-compose up -d.

Contributing

Contributors are more than welcome to help make Chiya a better bot. If you are a developer, we encourage you to fork the bot, make changes, and PR your changes upstream. For more information about contributing, check out our contributing guide.