Skip to content
This repository has been archived by the owner on May 1, 2024. It is now read-only.

Shibzel/Shibbot

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

Banner

Shibbot

A feature-rich and modular Discord bot written in Python.

Python version Release Lines of code Discord server Uptime

Description | Hosting | Contributing | Liscense

⚠️ This project is being rewrited, don't use it.

🔮 Description & Motivation

Shibbot was the first project I (*Shibzel, the owner) worked on to learn Python (which was a bad idea... don't start with that) then gradually evolved with my skills to what it is today : a feature rich, open source Discord bot designed to be modular and accessible.

Its specificity is to include several languages and plugins (which can be disabled with a command) without it being hard coded into the bot so that it can include external cogs and; use a file based database : SQLite 3 to not depend on external ressources that are not usually free. It can also use custom prefixed and /slash commands.

Right now it can :

  • Help you with the moderation of your server with all the classic commands like ban, tempmute, warn...
  • Additional specific commands completing the classic moderation commands ("normalize" usernames, clear a user's messages, massban ...)
  • Automod (dangerous links and profanity detection...)
  • Show you beautiful photos of shibas, capybaras, cats and birds
  • Show you memes collected on Reddit.
  • Offer you translation tools, articles on wikipedia and other utilities
  • Play music in the voice channel you're in (classic)
  • Become sentient and threaten humanity
  • Have more functionality thanks to the addition of extensions (external cogs).

If you want to try it yourself on your server you can invite it by adding it on your own server by clicking here or join its server here.

🚀 Self-Hosting

Of course, a new instance of the bot can be hosted on your machine with your own modifications or "vanilla" but you must consider some things :

  • Shibbot is not designed to be lightweight, you must provide him at least more than 64 MiB of RAM otherwise it will not work or not proprely.
  • Since it uses a file based portable database, "hosts" like Heroku won't fit because they wipe all the bot's files every 24 hours or less.
  • It won't work out of the box, don't forget to create a copy of config.toml.exemple named config.toml and reference the Discord token of the new instance and other credentials that the bot needs. If you're using a host that use Pterodactyl you can set the utilisation of the Pterodactyl API to True so that the bot can know the usage of its hardware (optional).

Nevertheless, using our own hosted instance of the bot is also a higly recommended option if you just don't want to undergo all the issues that it is to host a Discord bot.

📜 Requirements

Remember to fulfill the dependencies by running python -m pip install -r requirements.txt into your console before starting the bot.

🤝 Contributing & Issues

All feedbacks, bugs reports, forks and suggestions are welcome ! Do not hesistate to check out our issues page or join our Discord server for that.

It is maybe an useless reminder but a basic understanding of Python and the structure of the program is needed to pull commits into this repo. For that, we're working on a wiki that will arrive soon !

💼 Main contributors

  • Shibzel : The owner and the one who worked the most on it (yet).
  • Cloudy_Paul : For his incredible translation job.

Big thanks to all those listed here too !

💗 Credits

A big muah 😘 to everyone without whom this project would not be as great as it is ! To :

Oh ? You reached the end...