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

# Welcome to CoreX

Install CoreX, add resources, and build on one source of player data.

CoreX is a FiveM survival framework with native player data, inventory, survival and world systems. Its compatibility layer connects supported QBCore, Qbox and ESX public APIs to those same systems.

<sub>Cover: conceptual illustration, not an in-game screenshot.</sub>

## Choose your starting point <a href="#start-with-what-you-want-to-do" id="start-with-what-you-want-to-do"></a>

<table data-view="cards"><thead><tr><th></th><th></th><th></th><th data-hidden data-card-target data-type="content-ref"></th></tr></thead><tbody><tr><td><i class="fa-download">:download:</i></td><td><strong>Install CoreX</strong></td><td>Set up the package, database and startup order.</td><td><a href="/corex-docs/start-here/installation.md">Install CoreX</a></td></tr><tr><td><i class="fa-puzzle-piece">:puzzle-piece:</i></td><td><strong>Add a resource</strong></td><td>Check dependencies, register items and test one script.</td><td><a href="/corex-docs/start-here/add-a-resource.md">Add a resource</a></td></tr><tr><td><i class="fa-code">:code:</i></td><td><strong>Build with CoreX</strong></td><td>Create a small resource, then learn the native contracts.</td><td><a href="/corex-docs/build/first-resource.md">Build your first resource</a></td></tr></tbody></table>

## Follow the owner journey <a href="#for-server-owners" id="for-server-owners"></a>

[Install](/corex-docs/start-here/installation.md) · [Connect the database](/corex-docs/start-here/database.md) · [Add a resource](/corex-docs/start-here/add-a-resource.md) · [Add its items](/corex-docs/start-here/add-items.md) · [Troubleshoot](/corex-docs/start-here/troubleshooting.md) · [Update safely](/corex-docs/start-here/updating.md).

Each guide names the file to edit, the command to run and what to check. Start one resource at a time and keep your working inventory while testing it. [Changing inventory](/corex-docs/start-here/change-inventory.md) is a separate migration, not an item-installation step.

## One server, one source of player data <a href="#one-server-one-source-of-player-data" id="one-server-one-source-of-player-data"></a>

You do not install three full frameworks. CoreX's resources named `qb-core`, `qbx_core` and `es_extended` translate supported calls. Native CoreX owns player data; one selected inventory owns possessions.

| Distinction      | What it means                                                                                  |
| ---------------- | ---------------------------------------------------------------------------------------------- |
| Item definition  | Name, label, weight, image and stack rules. Registering it gives nobody an item.               |
| Player inventory | Owned items, counts, slots and metadata. Delivery must succeed through the selected inventory. |
| Compatibility    | Public API translation, not another framework's private database or every companion resource.  |

A script that imports `ox_lib` or calls `ox_inventory` still needs that real dependency. Phones, housing, target libraries and vendor SQL have their own contracts. Read [compatibility and tested examples](/corex-docs/start-here/compatibility.md) before relying on a specific feature. Startup success or content-pack `READY` is not proof of connected gameplay or committed saves.

{% hint style="info" %}
These pages describe the compatibility build. Confirm your package includes `corex-capabilities`, `corex-adapters`, the three facades and `corex-content`; an older download may not. The included `sm_hunting` and `qbx_binoculars` packs demonstrate real item setup. [Check before updating](/corex-docs/start-here/updating.md).
{% endhint %}

## Continue as a developer <a href="#for-developers" id="for-developers"></a>

After [your first resource](/corex-docs/build/first-resource.md), learn [player tables](/corex-docs/build/players.md), [metadata](/corex-docs/build/metadata.md) and [events and replicated state](/corex-docs/build/events-and-state.md). Keep [exports](/corex-docs/reference/exports.md), [providers](/corex-docs/reference/providers.md) and the [resource index](/corex-docs/reference/resource-index.md) nearby.

Source and installation: [CoreX resource organization](https://github.com/corex-zombies) · [txAdmin recipe](https://github.com/corex-zombies/txAdminRecipe). The old `ABUGIZA/COREX-Framework` repository is an information page, not a framework download.