https://github.com/snaacky/chiya

A moderation-heavy general purpose Discord bot
https://github.com/snaacky/chiya

bot discord discord-slash discord-slash-commands discordbot discordpy

Last synced: 1 day ago
JSON representation

A moderation-heavy general purpose Discord bot

• Host: GitHub
• URL: https://github.com/snaacky/chiya
• Owner: Snaacky
• License: unlicense
• Created: 2020-12-06T15:57:59.000Z (about 4 years ago)
• Default Branch: master
• Last Pushed: 2024-12-21T05:08:02.000Z (about 1 month ago)
• Last Synced: 2024-12-21T05:20:08.861Z (about 1 month ago)
• Topics: bot, discord, discord-slash, discord-slash-commands, discordbot, discordpy
• Language: Python
• Homepage:
• Size: 1.63 MB
• Stars: 38
• Watchers: 5
• Forks: 11
• Open Issues: 11
• Metadata Files:
  • Readme: README.md
  • Contributing: CONTRIBUTING.md
  • License: LICENSE

Awesome Lists containing this project

README

        








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](https://discordpy.readthedocs.io/en/stable/intents.html) enabled and the token for that bot before setup. You can create a new Discord bot [here](https://discord.com/developers/). 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](https://www.reddit.com/prefs/apps/).

## Setup

Chiya is deployed into a production environment using [Docker](https://docs.docker.com/get-started/) 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](https://docs.docker.com/compose/) installed.

#### Steps:

1. Download [`docker-compose.yml`](https://github.com/Snaacky/chiya/blob/master/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`](https://github.com/Snaacky/chiya/blob/master/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](https://github.com/Snaacky/chiya/blob/master/CONTRIBUTING.md).