🐸 FrogBot

FrogBot is a collaborative effort among a few of us to create the best bot possible. Please note that the bot is still in a very rough state, and things are constantly breaking.

Table of Contents

• Branches
• 🚀 Current Features
• 💬 Usage Examples
• 🤝 Contributing
• 📞 Connect
• 🙌 Acknowledgments

Branches

• 🔥 Beta: This is the most updated branch and is constantly being updated and may break.
• 🛠️ Dev: A go-to point for PRs and other contributions, it's the more stable of the newer branches but not immune to breaking.
• 🕰️ Old: This is the first revision of the bot; there are a few broken things with it, and we wouldn't recommend using it.

Note: Dev is considered the starting point for most people, as it's primarily for PRs, and we aim to keep it stable.

🚀 Current Features

• Drag and Dop-in Cogs
• Automatic role assignment based on points
• Points assignment and removal
• Points tracking
• Add points via reactions
• Updating via commands
• AI LLM and RAG integration via Llama Index
• Reply context chain for the LLM; you can simply reply to the bot's message to continue the conversation
• Web search for specific sites

💬 Usage Examples

• To add points to a user: /add points user
• To remove points from a user: /remove points user
• To check a user's points: /check_points
• Ask questions or seek information by mentioning the bot in your message: @{bot name} What's the current price of a C3?
• Use /help for more information on available commands.

🤝 Contributing

Contributions to FrogBot are welcome! Follow these steps to contribute:

1. Create a Cog.
2. Create a new PR for it.
3. Profit???

📞 Connect

For support and questions, join our Discord server: FrogPilot Discord.

Just go-to #bot-general channel at the bottom!

🙌 Acknowledgments

Thanks-

• Joeslinky
• twilsonco
• nik.olas
• cone_guy_03312
• pkp24
• mike854
• frogsgomoo
• And all those that help to test the bot

Disclaimer this README file was written mostly by ChatGPT 3.5 Turbo.