> ## Documentation Index
> Fetch the complete documentation index at: https://docs.thunder-studio.net/llms.txt
> Use this file to discover all available pages before exploring further.

# Installation

> How to install and configure the script.

## 1. Requirements

This script relies on the following dependencies. Make sure they are installed **before** running the resource:

* **[ts-lib](https://store.thunder-studio.net/download/ts-lib)** (**Required**)\
  This resource acts as a bridge and utilities wrapper to ensure ts-persistence is completely standalone and independent.
  <Card title="Download TS-Lib" icon="download" href="https://store.thunder-studio.net/download/ts-lib">
    Get the latest version of the required library.
  </Card>

* **[ox\_lib](https://github.com/communityox/ox_lib/releases)** (**Required**)\
  Installation guide: [https://coxdocs.dev/ox\_lib](https://coxdocs.dev/ox_lib)

* **[oxmysql](https://github.com/communityox/oxmysql/releases)** (**Required**)\
  Installation guide: [https://coxdocs.dev/oxmysql](https://coxdocs.dev/oxmysql)

> Overextended resources are now maintained under the Community Ox organization. You can find their documentation [here](https://coxdocs.dev/).

***

## 2. Framework Support

A framework is required for this script to function. The following frameworks are supported:

* **[QBCore](https://github.com/qbcore-framework/qb-core)**
* **[QBox](https://github.com/Qbox-project/qbox-core)**
* **[ESX](https://github.com/esx-framework/esx_core)**
* **Standalone** (custom bridges available inside `ts-lib`)

> **\[IMPORTANT]**\
> We no longer configure frameworks, vehicle keys, or garage systems inside `ts-persistence`. Instead, this is fully routed through **`ts-lib`**. Please configure your keys and garage inside the `ts-lib/shared/config.lua` file.

## 3. Installation

<Steps>
  <Step title="Add the script">
    Add the `ts-persistence` folder to your server's `resources` directory.
  </Step>

  <Step title="Configure server.cfg">
    Add `ensure ts-persistence` to your `server.cfg` file, ensuring it starts after its dependencies.

    ```js server.cfg theme={null}
    ensure <your_framework>

    ensure ox_lib
    ensure oxmysql
    ensure ts-lib

    ensure ts-persistence
    ```
  </Step>
</Steps>