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

# Installation

## Dependencies

✅ **Supported Scripts**\
Scripts that are fully tested and officially supported.\
🟢 Compatible and ready to use without any additional changes.

❌ **Unsupported Scripts**\
Scripts that are not tested or officially supported.\
🔴 May require custom edits or additional development to work correctly.

⚠️ **Required Dependency**\
This script is required for this resource to work properly.\
Without this dependency installed, the script will not function.

***

## Framework

| Dependency | Support |
| :--------: | :-----: |
|     QBX    |    ✅    |
|   QBCore   |    ✅    |
|     ESX    |    ✅    |
|   Ox lib   |    ⚠️   |

## Inventory

|   Dependency  | Support |
| :-----------: | :-----: |
| ox\_inventroy |    ✅    |
|  qb-inventroy |    ✅    |
|  qs-inventroy |    ❌    |
| esx-inventory |    ❌    |

## Spawn Selectors

|     Dependency     |   Support  |
| :----------------: | :--------: |
|     qbx\_spawn     |      ✅     |
|      qb-spawn      |      ✅     |
|      um-spawn      | Not Tested |
|  okokspawnselector | Not Tested |
| vms\_spawnselector | Not Tested |
|  Project07\_Spawn  |      ✅     |

## Housing & Apartments

|    Dependency   | Support |
| :-------------: | :-----: |
| qbx\_properties |    ✅    |
| qbx\_apartments |    ✅    |
|  qb-apartments  |    ✅    |
|    qb-housing   |    ✅    |
|   0r-apartment  |    ❌    |
|    ps-housing   |    ✅    |
|   bcs\_housing  |    ❌    |

## Appearance

|      Dependency     |   Support  |
| :-----------------: | :--------: |
| illenium-appearance |      ✅     |
|   fivem-appearance  |      ✅     |
|  rcore\_appearance  | Not Tested |
|    bl\_appearance   |      ✅     |
|    crm-appearance   | Not Tested |
|   tgiann-clothing   | Not Tested |
|  0r-clothingv1 - v2 | Not Tested |
|   origen\_clothing  | Not Tested |
|     qb-clothing     |      ✅     |

## WeatherSync

|      Dependency     | Support |
| :-----------------: | :-----: |
|    qb-weathersync   |    ✅    |
|     cd\_easytime    |    ✅    |
| renewed-weathersync |    ✅    |

## Installation

{% stepper %}
{% step %}

### Place the resource in your server's resources folder.

Example:

```bash
resources/
  Project07_Characters/
```

{% endstep %}

{% step %}

### Ensure the required dependencies are started before this script.

Example in server.cfg:

```cfg
ensure ox_lib
ensure oxmysql
ensure Project07_Characters
```

{% endstep %}

{% step %}

### Import the SQL files from the sql folder into your database.

Recommended order:

* sql/p07\_characters.sql
* sql/p07\_character\_slots.sql
* sql/p07\_admin\_locations.sql
* sql/p07\_admin\_logs.sql
* sql/p07\_settings.sql
* sql/players\_last\_logged\_out.sql

If you keep `Config.database.autoMigrate = true`, the script will auto-create/repair the required tables when it starts.
{% endstep %}

{% step %}

### Configure the script.

Edit the main config files:

* config.lua
* config/starter\_items.lua
* config/qbx.lua
* config/qbcore.lua
* config/esx.lua
* config/preview\_scenes.lua
* config/theme\_presets.lua
* config/weather.lua
* config/random\_peds.lua
  {% endstep %}

{% step %}

### Restart the server.

{% endstep %}
{% endstepper %}

## Admin Permission

The resource uses the ACE permission below for admin commands:

```cfg
add_ace group.admin project07.character allow
```

This allows access to:

* /addcharslot \[id]
* /logout \[id]
* /charadmin (admin tablet)

### Default Commands

```txt
/addcharslot [id]
/logout
/logout [id]
/charadmin
```