Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/raremojo/yobot
A basic Discord bot using Cogs for features.
https://github.com/raremojo/yobot
bot cog discord music python
Last synced: 18 days ago
JSON representation
A basic Discord bot using Cogs for features.
- Host: GitHub
- URL: https://github.com/raremojo/yobot
- Owner: RareMojo
- License: mit
- Created: 2024-09-13T18:10:35.000Z (2 months ago)
- Default Branch: main
- Last Pushed: 2024-09-29T19:30:31.000Z (about 2 months ago)
- Last Synced: 2024-10-09T15:41:04.271Z (about 1 month ago)
- Topics: bot, cog, discord, music, python
- Language: Python
- Homepage:
- Size: 171 KB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE.md
Awesome Lists containing this project
README
YoBot
Customization Made Simple, YoBot, yo style!
Explore the docs »
## Guides
- [Installation](https://github.com/RareMojo/YoBot-Discord/wiki/Installation)
- [Configuration](https://github.com/RareMojo/YoBot-Discord/wiki/Configuration)
- [Cog Creation](https://discordpy.readthedocs.io/en/stable/ext/commands/cogs.html)
## Features
### Accessibility
YoBot is meant to be deployed without any knowledge of Python or Discord.py, or programming.
The base bot has some basic functionality and can be used as is.
You can download pre-made extensions to add more features to your bot without any programming knowledge.
You can even try to create your own extensions without touching ANY of the source code.
Creating a Cog extension is a great way to learn Python and Discord.py without having to worry about the rest of the bot.
### OS Compatibility
YoBot is designed to function on both Windows and Linux out of the box.
There are no plans to make support for any other platforms at this time.
### Logging & Terminal Commands
YoBot uses a custom logging module to handle the terminal log, log files, and terminal commands.
These commands allow for great customizability and control without digging through a bunch of files and code.
You can easily create new commands for the terminal and it is another great way to learn Python without having to worry about the rest of the bot.
Start creating them in `terminalcommands.py` within class `TerminalCommands()`.
> :warning: *Please follow security guidelines!*
### Extensions
Extensions are intended for additional modular features to extend the functionality of YoBot.
These are usally called Cogs and can be a number of things. Learn more about Cogs [here.](https://discordpy.readthedocs.io/en/stable/ext/commands/cogs.html)
Each [Cog](https://discordpy.readthedocs.io/en/stable/ext/commands/cogs.html) is expected to be a separate Python script implementing a particular feature or set of features.
## Usage
For complete usage please see the [YobotWiki](https://github.com/RareMojo/YoBot-Discord/wiki).
### Installation
The only prerequisites are a Discord App, Python, Git, and requirements.txt.
See the install guide [here](https://github.com/RareMojo/YoBot-Discord/wiki/Installation)
---
### Configuration
This is done automatically at launch and requires user input for a few details.
You can also edit the config file directly or using various terminal commands.
See more information [here](https://github.com/RareMojo/YoBot-Discord/wiki/Configuration)
## Thank You
Thank you for being interested in the YoBot-Discord project!
We're dedicated to creating a bot that's easy to customize and use, both for programmers and regular users.
If you have any questions, suggestions, or need more information, feel free to get in touch.
Thanks again for your time and happy coding!
## License
YoBot is completely open source, licensed under the [GPLv3](https://www.gnu.org/licenses/gpl-3.0.en.html) license.
See [LICENSE.md](https://github.com/RareMojo/YoBot-Discord/blob/main/LICENSE.md) for more information.
Logo was made with the amazing and fun to use [Stable Diffusion](https://huggingface.co/stabilityai) + [AUTOMATIC1111 Web UI](https://github.com/AUTOMATIC1111/stable-diffusion-webui)