> For the complete documentation index, see [llms.txt](https://sl-scritps.gitbook.io/sl-scripts-documentation/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://sl-scritps.gitbook.io/sl-scripts-documentation/getting-started.md). # Getting Started ## Getting Started This page explains the basic workflow for installing and using SL Scripts resources. SL Scripts resources are designed to be modular, configurable and easy to manage. Each product has its own page with specific instructions, but most resources follow the same general setup process. *** ### Basic workflow Before using any SL Scripts resource, follow this order: 1. Download the resource from Tebex / CFX Asset Delivery. 2. Place the resource folder inside your server `resources` folder. 3. Make sure the folder name is correct. 4. Check the required dependencies. 5. Configure `config.lua`. 6. Configure `custom.lua` if needed. 7. Import SQL if the resource requires a database. 8. Add the resource to your `server.cfg`. 9. Restart your server. 10. Check server console and client F8 console for errors. *** ### Resource folder name Each resource must keep its expected folder name. Example: ```txt sl_smartwatch sl_vintage_jukebox sl_coffee_stand sl_fight_club ``` Do not rename the folder unless the product documentation specifically says it is safe to do so. A wrong folder name can cause: * Missing files * NUI not loading * Asset Escrow issues * Config not loading * Resource errors on startup *** ### Main files Most SL Scripts resources include these files: ```txt fxmanifest.lua config.lua custom.lua locales/ client/ server/ shared/ web/ if the resource uses NUI sql/ if the resource uses database tables README.md ``` *** ### `config.lua` `config.lua` contains the main settings of the resource. Common options include: * Language * Framework mode * Debug mode * Commands * Distances * Keys * Permissions * Target settings * Inventory settings * Webhook settings * Feature toggles This is the first file you should review. *** ### `custom.lua` `custom.lua` is used for server-specific adaptations. This file may include: * Custom notifications * Custom framework bridge * Custom inventory bridge * Custom permission checks * Custom job checks * Custom banking functions * Server-specific overrides Use this file when your server uses a modified framework or a custom system. *** ### Locales Most SL Scripts resources include language files. Common locale files: ```txt locales/es.lua locales/en.lua ``` Use these files to edit visible text, notifications, buttons and UI labels when supported. *** ### Dependencies Some resources are standalone. Others may support or require optional systems. Common supported systems: * QBCore * Qbox * ESX * ox\_lib * oxmysql * ox\_inventory * ox\_target * qb-target * qb-inventory * Custom notify systems Always check the product page for specific requirements. *** ### Server.cfg ensure order Dependencies must start before the SL Scripts resource that uses them. Example: ```cfg ensure oxmysql ensure ox_lib ensure ox_inventory ensure ox_target ensure sl_smartwatch ``` If a dependency starts after the resource, the script may fail to detect it correctly. *** ### SQL setup Some resources require database tables. If the product includes: ```txt sql/install.sql ``` you may need to import it into your database. Some resources also include automatic migrations. Even then, the SQL file is usually provided as a manual fallback. Always check the specific product page. *** ### Permissions Admin and owner features may require permissions. Depending on the resource, permissions may use: * Ace permissions * Framework groups * Jobs * Job grades * Config-based admin lists * Custom permission bridge Common permission levels: ```txt view use manage admin owner ``` The exact permission names are listed in each product page. *** ### Testing after installation After installing a resource, test the following: * Resource starts without server console errors. * Client F8 console has no errors. * Startup log appears if enabled. * Main command works if the resource has one. * Main UI opens and closes correctly. * Permissions work correctly. * Required items work if applicable. * Target interaction appears if applicable. * SQL data saves after restart if applicable. *** ### Common first checks If something does not work, check: ```txt 1. Is the folder name correct? 2. Is the resource ensured in server.cfg? 3. Are dependencies started before the resource? 4. Is config.lua correctly configured? 5. Did you import SQL if required? 6. Are permissions configured? 7. Are there server console errors? 8. Are there F8 console errors? ``` *** ### Next step After reading this page, continue with: * Installation * Product-specific documentation * Troubleshooting --- # Agent Instructions This documentation is published with GitBook. GitBook is the documentation platform designed so that both humans and AI agents can read, navigate, and reason over technical content effectively. Learn more at gitbook.com. ## Querying This Documentation If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question. Perform an HTTP GET request on the current page URL with the `ask` query parameter, and the optional `goal` query parameter: ``` GET https://sl-scritps.gitbook.io/sl-scripts-documentation/getting-started.md?ask=&goal= ``` `ask` is the immediate question: it should be specific, self-contained, and written in natural language. `goal` is optional and describes the broader end goal you are ultimately trying to accomplish on behalf of the user. GitBook uses it to tailor the answer towards what is most useful for that goal. The response will contain a direct answer to the question and relevant excerpts and sources from the documentation. Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.