Understanding Our Structure
Allow us to walk you through the structure of our scripts, designed with flexibility and customization in mind to meet your specific needs. Our scripts consist of various folders and files, each serving a distinct purpose:
Client Folder:
Inside this folder, you will find:
Some files are encrypted using FiveM Asset Escrow, you can learn more about it here
- main.lua (encrypted): This file (or files) contains the core script code, but it is not accessible for direct modification.
- editable_*.lua (open-source): These files encompass different functions triggered at various moments during gameplay. You can use these files to integrate your custom framework, notifications, or adapt the script to suit your requirements.
Server Folder:
This folder includes:
- main.lua (open-source): We have made our server-side code open-source in all of our scripts, granting you greater flexibility and control.
Config Folder:
Our scripts rely heavily on the config file since it contains critical customization choices. These choices are frequently given as boolean or integer values, which makes it simple to modify the script to suit your requirements. You can update the value supplied after the equal symbol (=) to change an option. Every option in the configuration file is made as simple as possible, ensuring that you understand what it does and how it works.
An example of what you may commonly see in a configuration file is given below:
- Enable/Disable Features: By changing the boolean values (true/false) associated with particular features, you may turn them on or off.
- Default Values: Establish default values for a variety of factors, including the minigame options, spawn places, and job payment amounts.
- Language Settings: Choose the language that will be used for alerts and in-game notifications.
Remember to save any changes made to the config file. By carefully adjusting the options, you can seamlessly integrate the script with your FiveM server and provide an optimal experience for your players. Furthermore, it is vital to point out the need of backing up your script files before making any changes to them. This preventative action makes sure you have a backup plan in case something goes wrong throughout the customisation procedure.
You may quickly tweak and change our scripts to fit the needs of your server by becoming familiar with their structure and arrangement. Our scripts will smoothly integrate into your FiveM server thanks to their inherent versatility, making them the ideal fit for your unique requirements.