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

# How To Install

{% embed url="<https://youtu.be/w4MsR6NJrZo>" %}

### 📁 Installation Steps

{% stepper %}
{% step %}

#### Download Patches

Please download the compatibility patches from our github repository

➡️ [DOWNLOAD](https://github.com/TStudio3d/tstudio_maps_patches/archive/refs/heads/main.zip)

⚠️ **Important:** This is required if you our maps and maps from other creators!
{% endstep %}

{% step %}

#### Prepare Resource Folders

Create the following folder structure in your `resources` directory:

```
resources/
├── [tstudio_maps]/
│   ├── tstudio_zmapdata
│   ├── tstudio_audioocclusion
│   ├── tstudio_map1
│   ├── tstudio_map2
│   └── ...
├── [tstudio_vehicles]/
│   ├── tstudio_aveh_metadata
│   ├── tstudio_cveh_police_1
│   └── ...
└── [tstudio_maps_patches]/ # Dont add this to your server.cfg! 
    ├── tstudio_zpatch_map1_map2
    └── ...
```

{% endstep %}

{% step %}

#### Install Resources

* **Drag and drop** all map-related `tstudio_*` resources into `[tstudio_maps]/`
  * Includes MLOs, Mapping & tstudio\_zmapdata
* **Drag and drop** all vehicle-related `tstudio_*` resources into `[tstudio_vehicles]/`
  * Includes `tstudio_aveh_metadata` and all `tstudio_cveh_*` and `tstudio_eveh_*` vehicles
* **Unzip and drop** all `tstudio_zpatch_*` resources (Step 1) into `[tstudio_maps_patches]/`
  {% endstep %}

{% step %}

#### Configure server.cfg

Add the following lines to your `server.cfg`:

```cfg
ensure [tstudio_maps]
ensure [tstudio_vehicles]
```

⚠️ **Important:** Do not manually start the `[tstudio_maps_patches]` folder – our system handles this automatically.
{% endstep %}

{% step %}

#### Finalize Installation

1. **Clear your server cache** after installation
2. **Restart your server**
   {% endstep %}

{% step %}

#### Confirm Installation

if you see the following patches starting you did everything right

<figure><img src="/files/TVLsMWlFUZz010NB88Kg" alt=""><figcaption></figcaption></figure>

{% hint style="warning" %}
if you dont see **"starting map fix for XYZ"** you did something wrong and start by step 1!
{% endhint %}
{% endstep %}
{% endstepper %}

***

### 🔄 Update Process

Follow these steps to update your resources:

1. **Delete** old `tstudio_*` resources (maps and vehicles)
2. **Replace** them with the new versions
3. **Clear** your server cache
4. **Restart** your server

***

### 🔧 Server Requirements

Before installation, ensure your server meets these requirements:

| Requirement           | Minimum Version                 |
| --------------------- | ------------------------------- |
| **FXServer Artifact** | `7290` or higher                |
| **Game Build**        | `3258` or higher                |
| **Recommended**       | txAdmin for resource management |

### 🚀 Performance Tips

#### Load Order Priority

* Load `tstudio_zmapdata` and `tstudio_audioocclusion` **first**
* Maintain the original file structure
* Run tests on a development server before deploying live

#### Best Practices

* ✅ Keep original filenames and folder structure
* ✅ Clear cache after each update
* ✅ Use txAdmin for easier management
* ❌ Do not rename resources or files
* ❌ Do not modify folder structure

***

### 🆘 Support & Community

Need help or want to connect with other users?

**Join our Discord:**\
<https://discord.gg/tstudio>

***

**Made with ❤️ by TStudio**

***
