Configuration
Setting up config
Triggers
This triggers section is used for each of the supported frameworks. You can change these to suit for framework if you need too. You may also need to modify events and functions in the bridge folder if using custom frameworks.
Admin Options
The admin options section is used to allow certain ace permissioned user access to use certain commands.
enable is used to enable or disable the admin commands.
ranks are the ace perms given in the server.cfg so set these to whatever you wish so your staff have access to them or not 🤣
inputType is used for the type of input given for the commands. Currently the standard "command" format is supported but that maybe likely change in due course.
commands is used for the commands in the script with the correct string. If you know basic scripting you can add more to your commands list and add it to the command section of the script. Found in client > commands.lua
Debug
Debug is used to enable or disable debug prints. These help with allowing better support and querying any problems you may have. for instance with an edit you made to a branch in the config and making sure it's added correctly.
When asking for support you will likely be asked to make this option true to help with fixing the problem at hand.
Default Levels
Default Levels are used as the "standard" level options if you don't want to use custom levels for each branch. You can increase the amount of levels used by default by adding more of the default level entries underneath.
title is used for the label of the level that branch is currently on. You can replace the Lang[default option] with your own string or change it in the language.lua file
minxp is minimum xp for that level to register. (keep set to 00 for level 1 as to not break the script)
maxxp is the maximum xp for that level and when on the next whole number it will either go to the next level or max out the levels available to that branch.
Lose Branch Knowledge
Lose Branch Knowledge when enabled is used to have xp decrease over time. (basically degradation like food items can have in some inventories)
enable is to enable or disable the xp loss feature.
notification if true will give a notification when they lose some xp. The message given in the notification can be changed in language.lua file.
update is how often you want it to update the branches so they get deducted xp. Default is every 15 minutes. I wouldn't recommend going lower than 15 minutes per update cycle.
Menu
The knowledge system uses a menu of sorts to display the information for the branches.
type is used to determine which type of menu is used (ox_lib/ qb_menu)
sort is used for if you want it sorted by highest xp amount ('xp') or through alphabetic order ('alphabetic')
default icon is used for when the branches don't have a icon given to them in the config.
ox is used for all options related to ox_lib.
type is used for changing the styling of the list of branches to 'context' or 'menu'
colour is used to define the look of the progress bar in either option.
position is to decide where the menu goes.
branch xp info if type is 'menu' and this is set to true you will get a little more data about the branch above the menu.
Knowledge Title
knowledge title is for the title used for the header of the list.
Chat Command
enable is used to enable the command for people to check their branches levels/ xp amounts.
command name is the string used for the user to open their branches list.
Notification
enable is used to enable standard notifications when gaining, "spending" or loosing xp (this isn't affected by the lose branch knowledge option)
notify type is for choosing which notification system you wish to use.
Default options are : ox, okok, qb and esx
email
enable is to enable sending emails for leveling up.
type is for what type of phone is used for ALL email options.
For email based notification requires a compatible phone or adding your own exports in bridge > client > utilities.lua, may also need to find ss-knowledge:server:lb-phone:sendMail in server > main.lua to add a different outcome if your phone requires server based exports/ functionality.
Branches
lockpicking is the name of the branch when using the exports for adding, removing or checking for the levels of that branch.
enable to enable or disable the branch so it can be in used or not. (if being turned off after being enabled and updated your xp branches it will remove the branch from each users branch list reducing amount of data sent and making it slightly more efficient.)
title Is what is used in the list for the branches title. I.E. Lockpicking and Hotwiring.
icon is used to choose the branches own icon which is used in the list. IF is left as blank in the config it will use the default option.
custom levels if not marked/ commented out then it will use the custom levels as your level choice for that branch.
Custom Levels
title is used for the label of the level that branch is currently on.
minxp is minimum xp for that level to register. (keep set to 00 for level 1 as to not break the script)
maxxp is the maximum xp for that level and when on the next whole number it will either go to the next level or max out the levels available to that branch.
Messages
enable is used to enable custom notifications (standard or email based )
notify type is used to choose what type of notification you want to to use. ("notification" for standard or "email" for email)
For email based notification requires a compatible phone or adding your own exports in bridge > client > utilities.lua, may also need to find ss-knowledge:server:lb-phone:sendMail in server > main.lua to add a different outcome if your phone requires server based exports/ functionality.
Make sure your type in the email area in the notification section is correct if you want to use this.
positive is used for when you go higher than that xp amount. The player will get a message telling them the message.
negative is used for when you go lower than that xp amount. The player will get a message telling them the message.
Last updated