trendingtechnology / ric-bot

An Open-Source Discord bot created to provide basic functionality which should be in every discord guild. We use this same bot with additional configurations for our guilds.

A Discord bot completely written to be taken from the source and built according to your own custom needs.

This bot supports some core features and is built to be pluggable with other features when and where required.

The core features which will be available for you to use when you setup this bot with the secrets are

1. Fetching latest Memes from Reddit
2. [Development] Deleting promotional messages from your server and keeping control where links are allowed.
3. [Development] Random and motivating quotes on demand and on certain times.
4. [Development] Saving random messages for particular users in your guild.

While source code of this bot is OpenSource you will need to build and host this bot somewhere to have it running on your guild and steps for that can be found here

Building and running the bot locally

For running the bot there are two ways.

1. Building a docker image and then running that image.
2. Running the bot on local virtual environment using pipenv.

Steps for running with docker are -

1. Build a docker image for the repository. Make sure you have you have docker desktop installed before you do this step.

docker build -t ric-bot-image .

This command will take the Dockerfile in the current directory . and build image for the same.

2. Run the image by providing necessary .env variables to it.

   In this repository there is a .env.example file which you will have to rename to .env and fill the variable values with correct values yourself.

   DISCORD_TOKEN is bot token provided to you by discord.

   REDDIT_CLIENT_ID is client id of your reddit account.

   REDDIT_CLIENT_SECRET is client secret of your reddit app.

   After doing so run the following command.

docker run --env-file .env -it --rm --name ric-bot-running ric-bot-image

The above command

1. Checks if there is a image running with the name ric-bot-running and removes it if present.
2. Provides the .env file to the process.
3. Runs the image with the provided variables.

Contributors ✨

Thanks goes to these wonderful people (emoji key):

Ricardo Prins 💻

Kamal Sharma 💻 📖

Adnan Mansuri 💻

A N U S H 💻

Ganesh Tiwari 💻 📖

This project follows the all-contributors specification. Contributions of any kind welcome!