Discord QuoteBot

Discord banter to keep forever
Report Bug · Request Feature

Table of Contents

1. About The Project
2. Getting Started
   • Prerequisites
   • Installation
3. Usage
4. Contributing
5. License

About The Project

A simple Discord Bot that takes an input and stores it with data in a MongoDB for future searches and to forever hold your favorite memories with your friends.

(back to top)

Getting Started

This bot requires selfhosting and NO external hosting is provided. A simple home server or RaspberryPi is more than enough for this program.

Prerequisites

You must have a Discord app key and token ready for your bot before you begin. You may setup a developer account and create an application with discord by reading their docs.

You also must have a presistant instance of MongoDB installed and running somewhere that can be connected to. The script assumes it is on the local machine with the default port configuations.

Python Dependencies

1. python3.11>=
2. discordpy
3. pymongo
4. json

Installation

1. Start by cloning this repository
2. Fill out the settings_ex.json file with the required information and change it to settings.json
3. Start up the MongoDB instance
4. We recomend creating a python venv to contain the dependencies of this project.
5. Enter the Quotebot folder and run python3 main.py
6. The application will be up as long as the terminal session is active and it has a connection to discord

(back to top)

Usage

The quote bot will automatically be looking for messages in the channel that you specify. The format should be "[quote text] [mention]" with only a single mention. The quote bot will automatically handle the quoting and database insertion.

(back to top)

Contributing

Contributions are what make the open source community such an amazing place to learn, inspire, and create. Any contributions you make are greatly appreciated.

If you have a suggestion that would make this better, please fork the repo and create a pull request. You can also simply open an issue with the tag "enhancement". Don't forget to give the project a star! Thanks again!

1. Fork the Project
2. Create your Feature Branch (git checkout -b feature/AmazingFeature)
3. Commit your Changes (git commit -m 'Add some AmazingFeature')
4. Push to the Branch (git push origin feature/AmazingFeature)
5. Open a Pull Request

(back to top)

License

Distributed under the MIT License. See LICENSE.txt for more information.

(back to top)

Contributors