raremojo / yobot-discord Goto Github PK

Customization Made Simple, YoBot, yo style!

Explore the docs »

• Installation
• Configuration
• Extra Cog Installation
• Cog Creation

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.

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.

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 YobotTerminalCommands().

⚠️ Please follow security guidelines!

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.

Each Cog is expected to be a separate Python script implementing a particular feature or set of features.

For complete usage please see the YobotWiki.

The only prerequisites are a Discord App, Python, Git, and requirements.txt.

See the install guide here

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

To install pre-made Cogs, you can use the terminal command getcog.

You can also review Cogs or manually install them from here.

As always, you can try to make your own Cogs without touching any of the source code.

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!

YoBot is completely open source, licensed under the GPLv3 license. See LICENSE.md for more information.

Logo was made with the amazing and fun to use Stable Diffusion + AUTOMATIC1111 Web UI