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

# Installation

Installation guide and fundamental concepts of crm-core.

{% hint style="info" %}
crm-core is a free resource, included with any package you buy from our store. You only need to install it once, and it serves as the foundation for all your scripts. It's essential to ensure you have the latest version for optimal performance.
{% endhint %}

### 1. Download Resource

To begin, download your recently purchased resource from [our store](https://corem.tebex.io/)

To do this, log in to your [cfx portal](https://portal.cfx.re/) account and navigate to the 'Asset Grants' section, where you will find your owned resources.

### 2. Dependencies

Download and install the following dependencies:

<details>

<summary><a href="https://github.com/overextended/oxmysql/releases">ox_lib</a></summary>

A FiveM library and resource implementing reusable modules, methods, and UI elements.

</details>

<details>

<summary><a href="https://github.com/overextended/oxmysql/releases">oxmysql</a></summary>

A FiveM resource to communicate with a MySQL database using node-mysql2.

</details>

### 3. Asset Arrangement

Inside your FiveM **resources** directory, create a new folder named:

```
resources/
└── [crm-scripts]/
```

Place the **crm-core** package inside the newly created folder:

```
resources/
└── [crm-scripts]/
    └── crm-core
```

If you have purchased any additional CoreM scripts, place them in the **same folder**:

```
resources/
└── [crm-scripts]/
    ├── crm-core
    ├── crm-multicharacter
    ├── crm-appearance
    ├── crm-shopscreator
    └── ... (any other CoreM scripts)
```

In your `server.cfg`, you must:

1. **Ensure `crm-core` first**
2. Then ensure the entire `[crm-scripts]` folder

{% hint style="danger" %}
**Important**\
Ensure CoreM scripts *after* your framework (qb-core / qbx-core / es\_extended).
{% endhint %}

```
# CoreM
ensure crm-core
ensure [crm-scripts]
```
