discord-bot

---

Features

Commands

Slash and prefix commands:

• /afk (+afk): Let others know you're AFK (Away From Keyboard).
• /alias add (+alias): Create a custom alias for quick reuse.
• /alias list (+aliases): Display a list of your saved aliases.
• /alias remove (+unalias): Remove a saved alias.
• /avatar (+avatar): Display the specified member's avatar(s).
• /badge (+badge): Change your badge (top role icon) on the server.
• /banner (+banner): Display the specified member's banner.
• /color (+color, +cor): Change your color (top role color) on the server.
• /emote add: Add a custom emote to the server.
• /emote remove: Remove a custom emote from the server.
• /emote rename: Rename a custom emote in the server.
• /fake: Send a message impersonating another user in the current channel.
• /remind (+remind, +remindme): Set a reminder for yourself or others.
• /server banner (+serverbanner): Display the guild's banner.
• /server icon (+servericon, +server): Display the guild's icon.
• /snipe (+snipe): Restore the last deleted message in the current channel.
• /sticker add: Add a sticker to the server.
• /sticker remove: Remove a sticker from the server.
• /sticker rename: Rename a sticker in the server.
• /summarize (+summarize, +resumo): Summarize the recent conversation in the chat.
• /weather (+weather, +w, +clima): Retrieve the current weather for a specified city.

Listeners

These features run automatically, without user commands:

• Automatically transcribes voice messages (speech-to-text).
• Automatically downloads tracks from Spotify links.
• Automatically fixes Twitter/X and Instagram link previews.
• Automatically evaluates simple math expressions.

Getting Started

Prerequisites

• Docker
• Docker Compose
• Bot account

Installing

1. Clone the repository using Git.

git clone [email protected]:leandcesar/discord-bot.git

2. Go to directory.

cd discord-bot

Running

3. Ensure to fill in the necessary environment variables in the .env file.
4. Build the Docker service for the application.

make build

5. Check if everything was installed correctly.

make up

Cleaning up

6. Uninstall all Docker components.

make down

Contributing

Prerequisites

• Python 3.10 or higher
• Coroutines and Awaitables

Development

1. Create a venv and install dependencies with pip.

make install

2. Create a new branch with a descriptive name.

git checkout -b awesome-branch-name

3. Implement and add your code changes on this new branch.

Code Style

4. Perform static code analysis with ruff and mypy.

make lint

5. Validate code security issues with bandit.

make security

6. Format the code according to defined standards with black and organize imports with isort.

make format

Contribute

7. Commit your changes to your local branch using Conventional Commit messages.

git add .
git commit -m 'feat(scope): example message'

8. Push your changes to the remote GitHub repository.

git push origin awesome-branch-name

9. Create a Pull Request to the main branch.

Cleaning up

10. Remove temporary files.

make clean

11. Uninstall all dependencies.

make uninstall

References

• disnake: asynchronous Discord API wrapper for Python
• disnake-ext-plugins: plugin extension for disnake providing a alternative to cogs
• AIOHTTP: asynchronous HTTP Client/Server for Python
• Pillow (PIL Fork): Python Imaging Library
• spotDL: Spotify music downloader