> For the complete documentation index, see [llms.txt](https://docs.cuxial.com/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://docs.cuxial.com/scripts/leisure/cuxial-danceclass/installation.md).

# Installation

Install Cuxial Dance Class step by step: dependencies, start order and a first test class.

Cuxial Dance Class needs no SQL import, no inventory items and no convars of its own. It creates its table on first start.

{% stepper %}
{% step %}

## Check the dependencies

These resources must be installed and working first:

* `ox_lib`
* `oxmysql`
* `cuxial_bridge`, with one of the supported frameworks: QBox, QBCore or ESX
* `cuxial_emotes`

{% hint style="warning" %}
Cuxial Emotes is required. Every dance comes from its dance catalog, and the resource will not start without it.
{% endhint %}

`cuxial_gym` is optional. When it is running, dance points raise a gym skill. Without it, classes work the same and no skill is raised.
{% endstep %}

{% step %}

## Copy the resource

Place the `cuxial_danceclass` folder inside your `resources` directory. Keep the folder name as it is.
{% endstep %}

{% step %}

## Start the resource

Start it after its dependencies and after your framework:

{% code title="server.cfg" %}

```cfg
ensure ox_lib
ensure oxmysql
# your framework here (qbx_core, qb-core or es_extended)
ensure cuxial_bridge
ensure cuxial_emotes
# optional
ensure cuxial_gym
ensure cuxial_danceclass
```

{% endcode %}

No SQL to run. The resource creates the table `cuxial_danceclass_history` when it starts.

The texts follow the `ox:locale` convar. `en` and `es` are included:

{% code title="server.cfg" %}

```cfg
setr ox:locale "en"
```

{% endcode %}
{% endstep %}

{% step %}

## Check that it works

You need two players for a full test.

1. Type `/danceclass`. The panel opens.
2. Press the button to draw the zone, place at least three points around you and save. The controls are shown on screen while you draw.
3. Fill in the name and difficulty, leave the fee at 0 and open the class. The panel closes and a side card shows the class.
4. With the second player, walk into the zone. They join and appear in the card.
5. As the instructor, press <kbd>F6</kbd>. After the countdown both characters dance and the student gets the notes to press.
6. When the dance ends, the results table appears. End the class from the panel to see the podium.
   {% endstep %}
   {% endstepper %}

Next: decide who can teach and how classes behave in [Configuration](/scripts/leisure/cuxial-danceclass/configuration.md).


---

# 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 by asking a question.

Perform an HTTP GET request on the following URL with the `ask` and `goal` query parameters:

```
GET https://docs.cuxial.com/scripts/leisure/cuxial-danceclass/installation.md?ask=<question>&goal=<user_goal>
```

`ask` is the immediate question: it should be specific, self-contained, and written in natural language.
`goal` is what the user is ultimately trying to achieve, the reason they need the answer. Sharing it helps GitBook give you a better, more relevant answer. A goal is most helpful when it describes the outcome the user wants rather than restating the question. For example, with `ask=how do I create an API token`, a goal like `automate deployments from our CI pipeline` lets GitBook tailor the answer to that use case.

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.