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

# Overview

An in-game knowledge base: rules, tutorials, job handbooks and news, written and managed in the game.

Chaos Guidebook puts your server's rules, tutorials, job handbooks and news into the game. Players open it with a key, at a help point in the world or from a person standing there, and find what they need with a search that forgives typos. You write the pages in a block editor right in the game: no Lua, no restarts. New players can be held at the rules until they pass a short quiz.

{% embed url="<https://www.youtube.com/watch?v=hQdyEBPQyX0>" %}

## What it does

* **A guide players actually read.** Categories in any depth, a table of contents on every page, bookmarks, notes, continue reading, and a search that still finds "polcie hand".
* **Written in the game.** A block editor with 33 block types, undo, autosave, a version for every save, preview as any job, and publishing on a schedule.
* **Help points in the world.** A person, a marker or a floating name, with ox\_target, qb-target, ox\_lib or a key. 830 ped models and 42 animations to pick from pictures.
* **Tutorials with routes.** Steps with checkpoints on the ground that tick off on arrival, and a reward paid once.
* **A rules quiz before playing.** Graded on the server; passing can give a permission, money or an item.
* **Onboarding.** The right handbook opens the first time a character gets a job, reaches a place or uses an item.
* **The Control Center.** Dashboard, roles and an access tester, analytics, announcements (also to Discord), media library, audit log and backups.
* **Your look.** 16 themes and your own, with contrast checks. Players pick theme and text size.
* **Eight ready pages** in English and German, and a Markdown import for your Discord rules channel.

## Frameworks

Chaos Guidebook runs on **ESX, Qbox, QBCore or standalone** and finds what is running by itself. The only requirement is **oxmysql**. See [Installation](/organized-chaos-docs/chaos-guidebook/installation.md).

## Try it first

The real interface runs in your browser, as a player and in the Control Center: [the live demo](https://chaos-guidebook-demo.pages.dev/).

## The pages

* [Installation](/organized-chaos-docs/chaos-guidebook/installation.md)
* [For players](/organized-chaos-docs/chaos-guidebook/for-players.md)
* [The editor](/organized-chaos-docs/chaos-guidebook/editor.md)
* [Help points](/organized-chaos-docs/chaos-guidebook/help-points.md)
* [Tutorials and routes](/organized-chaos-docs/chaos-guidebook/tutorials-and-routes.md)
* [Rules quiz](/organized-chaos-docs/chaos-guidebook/rules-quiz.md)
* [Onboarding](/organized-chaos-docs/chaos-guidebook/onboarding.md)
* [Announcements](/organized-chaos-docs/chaos-guidebook/announcements.md)
* [Permissions](/organized-chaos-docs/chaos-guidebook/permissions.md)
* [Uploads and media](/organized-chaos-docs/chaos-guidebook/uploads-and-media.md)
* [Backups](/organized-chaos-docs/chaos-guidebook/backups.md)
* [Configuration](/organized-chaos-docs/chaos-guidebook/configuration.md)
* [Discord logging](/organized-chaos-docs/chaos-guidebook/discord-logging.md)
* [Commands](/organized-chaos-docs/chaos-guidebook/commands.md)
* [Exports](/organized-chaos-docs/chaos-guidebook/exports.md)
* [Security and data](/organized-chaos-docs/chaos-guidebook/security-and-data.md)
* [Troubleshooting](/organized-chaos-docs/chaos-guidebook/troubleshooting.md)