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

# Installation

## Customs Script Installation Guide

Follow these steps to install the NeedForScripts Customs Script on your FiveM server.

### Prerequisites

Before you begin, ensure you have:

1. FiveM server with administrator access
2. File transfer capability (FTP or direct file access)

### Step 1: Install Dependencies

The Customs Script requires two dependencies:

1. [ox\_lib](https://github.com/overextended/ox_lib)
2. [bl\_bridge](https://github.com/Byte-Labs-Studio/bl_bridge)

To install these:

1. Download `ox_lib` from [overextended GitHub repository](https://github.com/overextended/ox_lib)
2. Download `bl_bridge` from [Byte Labs GitHub repository](https://github.com/Byte-Labs-Studio/bl_bridge)
3. Place both resources in your server's resources folder
4. Add the following lines to your `server.cfg`:

   ```
   ensure ox_lib
   ensure bl_bridge
   ```
5. Add the bl\_bridge convars to your server.cfg with your server options: <br>

   ```
   # Frameworks 'ox' | 'qb' | 'esx' | 'qbx'
   setr bl:framework 'qb' 

   # Inventories 'ox' | 'qb' | 'esx' | 'ps' | 'qs' | 'origen' | 'none'
   setr bl:inventory 'ox'

   # Context 'ox' | 'qb'
   setr bl:context 'ox'

   # Target 'ox' | 'qb'
   setr bl:target 'ox'

   # Progress 'ox' | 'qb'
   setr bl:progressbar 'ox'

   # Radial 'ox' | 'qb'
   setr bl:radial 'ox'

   # Notification 'ox' | 'qb' | 'esx'
   setr bl:notify 'ox'

   # TextUI 'ox' | 'qb' | 'esx'
   setr bl:textui 'o
   ```

### Step 2: Install the Customs Script

1. Download the Customs Script from your NeedForScripts purchase
2. Extract the files to your server's resources folder
3. Add the following line to your `server.cfg`:

   ```
   ensure nfs-customs
   ```

### Step 3: Configuration

1. Open the `config.lua` file in the Customs Script folder
2. Adjust settings according to your server's needs (refer to our Configuration Guide for details)

### Step 4: Start Your Server

1. Save all changes
2. Start or restart your FiveM server

### Verification

To verify the installation:

1. Connect to your server
2. Visit a vehicle customization shop in-game
3. Confirm that you can access and use the customization features

If you encounter any issues, please check our Troubleshooting Guide or contact our support team.

Enjoy using the NeedForScripts Customs Script on your server!
