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

# Overview

izzy-dancing is a full dancing event system for FiveM roleplay servers:

* Create **lobbies** with entry fee (bet), password, player count, music, and difficulty
* Place a **dance floor** manually or use **fixed map locations**
* Invite nearby players, manage members, kick, change settings
* Run a **rhythm mini-game** — press falling keys in time; wrong answers eliminate players
* **Winner** takes the full pot (bet × player count)
* Optional **mugshots**, **ox\_target / qb-target**, **Discord logs**, **opening hours** per location

### Requirements

| Resource                               | Required | Purpose                                     |
| -------------------------------------- | -------- | ------------------------------------------- |
| `izzy-dancing-stream`                  | **Yes**  | Custom dance floor prop (`flank_carpet_01`) |
| `es_extended` / `qb-core` / `qbx_core` | **Yes**  | Framework (auto-detected)                   |
| `xsound`                               | **Yes**  | Positional music from speaker prop          |
| `MugShotBase64`                        | Optional | Player avatars in lobby UI                  |
| `ox_target` / `qb-target`              | Optional | Target interaction on carpets               |
| `ox_inventory` / `qs-inventory` / etc. | Optional | Usable items & cash-as-item                 |


---

# 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, and the optional `goal` query parameter:

```
GET https://izzyshop-1.gitbook.io/izzyshop-docs/izzyshop-resources/izzy-dancing/overview.md?ask=<question>&goal=<endgoal>
```

`ask` is the immediate question: it should be specific, self-contained, and written in natural language.
`goal` is optional and describes the broader end goal you are ultimately trying to accomplish on behalf of the user. GitBook uses it to tailor the answer towards what is most useful for that goal.

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.