🍯 honeybot py [ docs ]

<div align="center"> <img src="./assets/honeybot_real.png" width="64" />

<hr> 🇲🇺 🇺🇸 🇨🇦 🇦🇷 🇮🇳 🇬🇧 🇬🇬 🇧🇷 🇸🇽 🇵🇱 🇩🇪 🇲🇼 🇲🇦 </div> <div align="center">

</div>

Table of Contents

• 📮 About
• 🕹 Project Motivation
• ✂ Current Features
• :mountain: GUI clients
• ⌚ Current Plugins
• ⚡ Quickstart
• 💻 Seeing The Bot In Action
• Docker
• 🔧 Plugins Development
• 📃 Contributing Guide
• 🔌 Todo Plugins
• ☑ Allowing Plugins
• :thought_balloon: Project Testimonials
• 📧 Contact (Including vulnerabilities)
• 🖊 Credits

📮 About

HoneyBot is a python-based IRC bot. (python3.7) | If you want to just run the bot, go to the quick start section

HoneyBot is my first time collaborating to an open source project and I'm loving it. Before discovering HoneyBot, I was very intimidated on the idea of working with other people and had no idea what an IRC even was. Now I realize how much fun and rewarding it is to work together on a project with dedicated and friendly individuals. The documentation is easy to follow and everyone is super helpful. I highly recommend any new programmer who want to contribute on an open source project to try out HoneyBot. Personally I enjoy working on this project more than my own schoolwork. --@RiceAbove

Feel free to contribute to the project!

🕹 Project Motivation

Implementing the project in Java was weird, py's connect was sleek. Thus, the project stack was shifted over to Python. If you can think of any features, plugins, or functionality you wish to see in the project. Feel free to add it yourself, or create an issue detailing your ideas. We highly recommend you attempt to implement it yourself first and ask for help in our discord server !

Psst. Since I learnt py through this bot, we decided to keep a new-comers friendly policy. Feeling lost? Just ping.

✂ Current Features

• 🍬 OOP architecture
• 🛰️ keyword parameters
• 🌵 password security with config file [disabled for now]
• 🔌 now with plugins

:mountain: GUI clients

GUI clients are used to manage plugins, launch bot as well as specify credentials.

• CPP client by @Macr0Nerd

⌚ Current Plugins

| Plugin | Description | Contributor | | ---------------------- | ------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------- | | 💎 bitcoin | Get price of bitcoin | @Macr0Nerd | | ⏲ caesar cipher | Encode your text | @kylegalloway | | 🔢 calc | Evaluates maths expressions | @Abdur-rahmaanJ | | 📐 maths | Trigonometry & random number generator | @Abdur-rahmaanJ | | 🍃 conv sniff | Set triggers like how many times a word occur for one or more words and send response | @Abdur-rahmaanJ | | ❄ greet | Demo plugin | @Abdur-rahmaanJ | | ⛓ installed_modules | Checks dependencies installed | @Abdur-rahmaanJ | | 🕶 joke | Get random joke | @Abdur-rahmaanJ, @colbyjayallen | | ❓ self Trivia | Random trivia | @ajimenezUCLA | | 💢 username | Username generator | @Abdur-rahmaanJ, @sseryani | | 📜 quotes | Inspirational quotes | @German-Corpaz | | 📖 dictionary | Returns meaning of word | @iamnishant14 | | 🔣 password generator | The name tells it all | @iamnishant14 | | 🐜 debug | Prints all parameters passed to bot | @Abdur-rahmaanJ | | 📚 wikipedia | Returns a wikipedia article | @Macr0Nerd | | 🗿 translate | Google translate plugin | @a-deeb | | 📑 test | Runs tests | @Abdur-rahmaanJ | | ⛅️ weather | Returns weather info for a given location | @Macr0Nerd | | ✉️ mail | Send emails within the chat | @TannerFry | | 🕴️ hangman | Play hangman in the chat | @JustinWalker4179 | | 🎂 age | Takes in birthday and outputs age | @JustinWalker4179 | | ✔️ fact | Returns a random fact | @JustinWalker4179 | | 🔍 google | Returns three search results from google | @JustinWalker4179 | | 📮 send message | Sends a message to another channel | @JustinWalker4179 | | 📝 log | Logs the chat into a log file | @RiceAbove | | 🚪 joins | Greets everyone who joins the channel | @RiceAbove | | 📅 date | Posts the cu