| This repository does not have a stable version yet, so it is possible that there are bugs and partially implemented features. I'm still making fixes and improvements until the first release, so "watch" this repository to know when the first release comes out. |
|
|---|---|
| 🛟 | Need help? Want to discuss the development? Join the official Discord server! |
HelpBot is a Discord self-hosted bot designed to run on a Node.js server, whose main functions are automated community moderation, leveling, chat utilities and much more!
This project was born out of curiosity, as a way to give form to the knowledge about JavaScript that I acquired during a Professional Formation course that I was doing, but that over time has made me discover that I am passionate about programming.
Given that initially it was a project with quite unstable knowledge bases, the code has undergone several refactorings until reaching this point, from which I have decided that I'm going to make it open source under an MIT license, and continue with it's development and work on other related projects.
Due to this, the bot has NOT been designed from the beginning to work in more than one Discord community (guild) at the same time, so the bot does not have a database system, and instead works with JSON files.
NOTICE:
The bot code is excessively full of comments (in Spanish), because it is a learning project and my goal in doing this was to understand at all times what I was programming, and to easily recover the thread (the old commits, issues and projects were also written in Spanish).
| Swear words filtering | Excesive mentions filtering | XP & role rewards by activity (text & voice) | Preprogrammed scripts support |
| Server invites filtering | Excesive spoilers filtering | Timed messages | Message purging tool |
| Excesive uppercase filtering | Repetitive text filtering | Infractions history | Reports system |
| Links filtering | Automatic penalty dispenser | Multiple locales | Flood filtering |
| Excesive emojis filtering | Manual moderation commands | Role, user and server info. showing | Polls maker |
In the wiki of this repository, you have a guide available where everything about this bot is explained, as well as an initial guide that gives instructions on how to prepare the prerequisites for running the bot, how to download the source code, how to create an account for the bot, how to do the basic configuration and how to run it.
GO TO THE START GUIDE
- Thanks to my programming teacher María José Lozano, for teaching me the basics of JavaScript and how to think like a programmer. Without her lessons, I probably would not have started this project.
- Thanks to the supported languages translators who make this repository accessible to many more people.
- Thanks to the community of Discord.js, who have always been there to answer all my questions about the library, and that they constantly work to cover the 100% of the API.
- Thanks to Flaticon for providing the images contained in the resources/images/ directory.