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

# Installation

## Steps

{% stepper %}
{% step %}

### Drop the resource

Drop the resource into `resources/[addons]/tyrix_business`.
{% endstep %}

{% step %}

### Add to `server.cfg`

```
ensure tyrix_business
```

{% endstep %}

{% step %}

### Restart the server

Schema auto-creates on first start — no SQL import needed.
{% endstep %}

{% step %}

### Open the manager

In-game (admin), run `/business` to open the manager.
{% endstep %}
{% endstepper %}

`install/install.sql` is optional - useful only if you want to pre-provision the schema or hand it to a DBA as reference.

## Dependencies

| Dependency     | Required                          | Purpose                                                               |
| -------------- | --------------------------------- | --------------------------------------------------------------------- |
| `ox_lib`       | Yes                               | UI callbacks, skill checks, progress bars, cache.                     |
| `ox_inventory` | Yes                               | All stashes, shops, and the `business_box` item.                      |
| `oxmysql`      | Yes                               | Database driver.                                                      |
| `es_extended`  | Yes (one of the three frameworks) | Framework - ESX.                                                      |
| `qb-core`      | Yes (one of the three frameworks) | Framework - QBCore.                                                   |
| `qbx_core`     | Yes (one of the three frameworks) | Framework - QBox.                                                     |
| `ox_target`    | Auto-detected                     | Target zones. Swaps to `qb-target` if that's what's running.          |
| `qb-target`    | Auto-detected                     | Alternate target backend. Auto-picked when `ox_target` isn't started. |

## Framework Support

| Framework | Status |
| --------- | ------ |
| ESX       | ✅      |
| QBCore    | ✅      |
| QBox      | ✅      |

## One-time item setup

The Boxes feature uses a custom `ox_inventory` item that needs to be registered once - see [Item Setup](broken://pages/facab686e9e33eb099bffcc123ab90910d79f56d).

## Migrating from another business resource

Server owners coming from the another Business Creator like `pug_businesses` can auto-import their existing data. See [Migration](/docs/script-resources/tyrix-business/migration.md).