⚙️Master Config

Explore the Master Config, the hub for essential settings that allow the resource to work.

Framework-Specific Configuration

Base Config

Base QBox Config

Permissions Config

Base Permissions Config

---

Base Config Explanation

Config.CheckVersion = true 

A version check upon server startup, ensuring that you are running the latest version. It also provides real-time logs to both Discord and the Server Console.

Config.Framework = "QBCORE"

This setting needs to be specified with your chosen framework type, selecting from "ESX". "QBUS", or "QBOX". If you are using a custom framework, you must make the necessary code adjustments in framework.lua, both on the client and server sides.

Config.UseOx_Inventory = true

Set this setting to true if you are utilizing ox_inventory. This setting is integral to the functionality of the item-based lock system.

Config.CustomIdentifier = true

• Set this setting to "true" if you intend to utilize your framework's built-in character identification system.

• Only set it to "false" if you are not using any framework at all.

• If you have a custom framework in place, please ensure that you make the necessary adjustments under framework.lua to align with your custom setup.

Config.DespawnCheck = true

Enable this setting by setting it to "true" to ensure that the resource actively checks for despawned player owned vehicles and automatically respawns them. We highly recommend keeping this setting enabled.

Database.Database = "OXMYSQL"

• Responsible for the database resource you are using. We currently support OXMYSQL, MySQL.Async and GhmattiMySQL.
• Please ensure your fxmanifest.lua has the appropriate option pointed as well.

'@oxmysql/lib/MySQL.lua', -- for OXMYSQL
'@mysql-async/lib/MySQL.lua', -- for MYSQLASYNC  

Database.VehiclesTableNameInDatabase = "player_vehicles"

This setting must contain the player owned vehicles table name to establish a successful connection with your database. Double-check and confirm the accuracy of this setting to avoid any potential database-related issues.

Database.GaragesTableNameInDatabase = "rvs_garages"

This setting must contain the private garages table name to establish a successful connection with your database. Only change this if you've altered the table name.

Database.SQLUpdateTime = 30000 --this is in milliseconds

This setting dictates the frequency at which the resource updates the database with changes to vehicles. It specifically targets vehicles that have undergone interactions or modifications. Our recommended interval is 30,000 milliseconds, equivalent to 30 seconds.

Config.DebugPolyzones = false

Toggle this setting to enable or disable debugging for Polyzones. When enabled, it generates box grids for each polyzone, including Insurance, Impound, Public Garages, and Private Garages.

Config.PrintSortingOnServerConsole = false

Toggle this setting to enable server sided printing for the sorting of vehicles. Useful for debugging and understanding our sorting algorithm.

Config.UseDeveloperCommands = false

Toggle this setting for developer commands. Keep note that developer commands do not have permissions by default. Everyone can use them! So please edit for your own server.

Permissions Config Explanation

Config.PrintPermissionsCommandsOnF8 = true

Toggles printing of permissions on Client-Sided console if you are an authorized user.

Config.PermissionUsers = {
    ["OBO47723"] = "developer",
}

This setting assigns roles to users. In the example, OBO47723 is the user's identifier ID (in this case QBCore Character ID), and is given developer permissions.

Config.PermissionClasses = {
    ["developer"] = {
        "tpv",
        "fixVehicle",
        "checkImpound",
        "partsDebug",
        "insideGarage",
        "tempKeys",
        "addVeh",
        "setPart",
        "grabTest",
        "stressTest",
        "getStreet",
        "security",
        "customDespawn",
        "checkKeys",
        "fixAllPart",
    }
}

This setting configuration defines what commands each role can use. You can create custom roles, each with its specific commands. For example, 'moderator' has access to commands like "tpv" and "fixVehicle", while 'admin' includes these plus "addVeh" and "setPart". The 'developer' role, designed with the broadest access, includes all available commands by default.