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

# Scripts

Enhance your server's gameplay and mechanics with our custom, optimized scripts.

Welcome to the scripts documentation section. Here you will find all the resources required to install, configure, and seamlessly integrate NS Studios scripts into your RedM server. Our codes are written with performance in mind, ensuring smooth gameplay and minimal server resource usage (low ms).

### How to use this section

On the left sidebar, you will find dedicated subpages for each script available in our catalog. Inside each specific page, we detail:

* Framework Compatibility: Supported frameworks (e.g., VORP, RedEM:RP, RSG, QBR) and required versions.
* Dependencies: Any third-party scripts or UI libraries required for our script to function.
* Configuration Guide: Detailed explanations of the `config.lua` file so you can tailor the script to your server's economy and style.

### General installation guide

While every script has its own unique configuration and requirements, the standard installation process generally follows these steps:

1. Download: Retrieve your purchased script from your Cfx.re Keymaster account.
2. Extract: Extract the downloaded file and place the folder into your server's `resources` directory. We recommend creating a dedicated `[ns-scripts]` folder for better organization.
3. Database (SQL): If the script includes any database dependencies, it will be created automatically with the start of the resource.
4. Configure: Open the `config.lua` file inside the script's folder. Adjust the framework settings, language, and script features according to your server's needs.
5. Server Config: Open your `server.cfg` file and add the command `ensure [script_folder_name]`. Make sure to start our script *after* its required dependencies (like frameworks or inventory systems).
6. Restart: Restart your server or use the `refresh` and `start` commands in your server console.

### Important notes

* Cfx.re Escrow: To protect our intellectual property, the core logic files (client and server-side Lua) of our scripts are encrypted using the official Cfx.re Escrow system.
* Unlocked Files: You will always have full access to the `config.lua`, translation files, and sometimes specific client/server functions (bridge files) to ensure you can integrate the script with your custom framework or inventory.

If you encounter any console errors or bugs during the installation, please open a support ticket on our Discord. Always provide a screenshot of the error (F8 console or server console) to speed up the support process.