Project Documentation

This guide will help you become familiar with the bot on a deeper level. It’s intended for people who want to understand how the bot works and may want to contribute. If you're looking to deploy the bot instead of contributing, please check out the deployment guide on the GitHub repository or theinstallation page.

import KahootBot

This will import the Kahoot Bot into your project.

Note: If you haven't installed Just_Another_KahootBot yet, refer to the installation guide.

Important Information

This documentation assumes you have a solid understanding of Python. If you're not familiar with Python, I recommend reviewing the basics before proceeding. While you can still follow along, some advanced features may be difficult to understand without a deeper grasp of the language. If you're interested in learning more, here are some great resources:

Before diving deeper, it’s important to understand how the bot is structured. It is made up of two main components:

Main Components

KahootBot: This is the main component. It joins games, answers questions, and makes intelligent decisions about what to do next. It uses WebSockets, as described in the installation guide.
Swarm: This component manages several KahootBots and ensures they’re running properly. Its primary job is to handle lifetimes, but it also acts as an event handler for certain Kahoot events and decides how to respond.