> For the complete documentation index, see [llms.txt](https://elabbadi.gitbook.io/quizquest/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://elabbadi.gitbook.io/quizquest/readme.md).

# QuizQuest 🎮

Transform your study sessions into epic RPG adventures! QuizQuest is a gamified learning platform that turns boring revision into exciting boss battles, where every correct answer deals damage and every victory levels up your character.

## Features

### Epic Boss Battles

* Face off against Knowledge Bosses for each subject (e.g., "The Evil Calculator" for Math)
* Visual combat system with health bars for both player and boss
* Deal damage with correct answers, take damage with wrong ones
* Defeat bosses to earn massive XP rewards

### RPG Progression System

* Earn XP with every correct answer
* Level up your Adventurer character using the formula: `Level = floor(0.1 * sqrt(XP)) + 1`
* Track your progress on an intuitive dashboard
* Watch your stats grow as you master new subjects

### AI-Powered Quiz Generator

* Generate personalized quizzes on **any topic**
* Choose your difficulty: Easy, Medium, or Hard
* Customize the number of questions
* AI creates relevant, challenging questions tailored to your needs

### Automatic Revision Notes

* Wrong answers are automatically saved to your "Revision Notes"
* Transform mistakes into targeted learning opportunities
* Review weak areas with ease
* Clear path from failure to mastery

### Progress Dashboard

* View your total XP and current level
* Track battles won and subjects mastered
* Visualize your learning journey
* Monitor your improvement over time

## Getting Started

### Prerequisites

* Node.js (v14 or higher)
* npm or yarn
* MongoDB

### Installation

1. **Clone the repository**

```bash
```


---

# Agent Instructions
This documentation is published with GitBook. GitBook is the documentation platform designed so that both humans and AI agents can read, navigate, and reason over technical content effectively. Learn more at gitbook.com.

## Querying This Documentation
If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question.

Perform an HTTP GET request on the current page URL with the `ask` query parameter:

```
GET https://elabbadi.gitbook.io/quizquest/readme.md?ask=<question>
```

The question should be specific, self-contained, and written in natural language.
The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.

Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.