Skip to content

Latest commit

 

History

History
107 lines (79 loc) · 2.91 KB

README.md

File metadata and controls

107 lines (79 loc) · 2.91 KB

Vacuum Bot

Vacuum Bot is a Discord bot developed for the Vacuum community. It is built using Python and the discord.py library. The bot provides various features to enhance the community's experience.

Features

  • Pomodoro: The bot allows users to start and manage Pomodoro sessions, helping them stay focused and productive.
  • Job Search: Users can utilize the bot to search for job opportunities.

Getting Started

To run Vacuum Bot locally, follow these steps:

  1. Make sure that FFmpeg was installed in your system.

    Windows user:

    1. Can be installed using the installer and setting up environment variables.
    2. Or using a package manager like chocolatey

  2. Clone the repository:

git clone https://github.com/masachetti/Vacuum-Bot.git
cd Vacuum-Bot
  1. Install the required dependencies:
pip install -r requirements.txt

  1. Obtain a Discord bot token by creating a new bot on the Discord Developer Portal.

  2. Create a .env file in the root directory and add your bot token and guild id:

TOKEN=YOUR_TOKEN
GUILD_ID=YOUR_GUILD_ID
  1. Add the bot to your server with those permissions:
bot
bot:Send Messages
bot:Connect
bot:Speak
applications.commands
  1. Run the bot:
python main.py

Project Structure

The project follows a feature-based structure, where each feature has its own folder and cog. This organization allows for modularity and easy addition of new features. Additionally, a shared folder exists to store files that are used across multiple features.

├── shared
│   ├── file1.py
│   └── file2.py
├── cogs
│   ├── pomodoro.py
│   ├── vagas.py
│   ├── other_feature.py
│   ├── ...
├── pomodoro
│   ├── file.py
│   ├── ...
├── jobs
│   ├── file.py
│   ├── ...
├── other_feature
│   ├── file.py
│   ├── ...
├── main.py
└── ...

Contributing

Contributions to Vacuum Bot are welcome! If you would like to contribute, please follow these guidelines:

  1. Fork the repository and create a new branch for your feature/bug fix.
  2. Commit your changes with descriptive commit messages.
  3. Push your changes to your forked repository.
  4. Submit a pull request, explaining the changes you have made.

Please ensure that your code follows the project's coding conventions.

License

This project is licensed under the MIT License.