Skip to content

Naviamold1/Multi-Functional-Discord-Bot

Repository files navigation

Welcome to Multi-Functional-Bot 👋

Python application Docker Image CI CodeQL Ruff License: MIT Twitter: naviamold

Bot with variety of function like cooking, geography trivia, url shortening, weather telling and more.

Install

git clone https://github.com/Naviamold1/Multi-Functional-Discord-Bot.git
cd Multi-Functional-Discord-Bot
cp .env.template .env

ENV File

Open the .env file and fill it in with asked values.

Here's a list where you can get each values.

ENV Place to get it from
BOT_TOKEN https://discord.com/developers/
SPOONACULAR_SECRET https://spoonacular.com/food-api
CUTTLY_SECRET https://cutt.ly/edit
WEATHER_SECRET https://home.openweathermap.org/api_keys
DB_SECRET If using Docker leave empty, else any Postgresql Database URI

Docker Installation (recommended)

If you have already installed Docker on your system just run the following command:

docker compose up -d

Manual Installation

Continue EITHER with Pip OR Poetry to install dependencies

  • If you don't know what Poetry is just go with Pip

  • If you are planing to contribute to this repo please go with Poetry

Using Pip

pip install -r requirements.txt
python main.py

Using Poetry

poetry shell
poetry install
poetry run python main.py

If you plan on altering or contributing to this repo you should also install dev dependencies

poetry install --with dev

Usage

After running and adding bot to your server simply type / to view and use command.

To get a full list of commands you can type /help but make sure to select your bots command.

Author

👤 Naviamold

🤝 Contributing

Contributions, issues and feature requests are welcome!

Though if you do plan to contribute please install and set this up via Poetry.

Feel free to check issues page.

Show your support

Give a ⭐️ if this project helped you!


This README was generated with ❤️ by readme-md-generator