Config
Config Settings & Explanations
General Settings
Config.Language
Data Type: String
Default Value: 'en'
Description: Sets the language for the user interface and notifications. Additional options can be found in the
language.lua
file.Example Values: 'en' for English, 'de' for German.
Adjustment Necessity: Modify if you want to use a language other than English.
Config.ContinueAfterMaxDays
Data Type: Boolean
Default Value: true
Description: Determines whether players can continue to claim rewards after reaching the maximum number of days(restarting at day 1, after claimed last reward). If set to
false
, players will not be able to claim rewards after reaching the max days.Adjustment Necessity: Modify to either stop or continue the rewards system after the maximum number of days has been reached.
Config.Command
Data Type: String
Default Value: "openrewards"
Description: The chat command used to open the rewards system user interface.
Adjustment Necessity: Modify if you prefer to use a different command.
Location Settings (Coords)
For each location ("Spot 1"):
Coords
Description: Defines the coordinates for the Daily Rewards spot, including the marker and blip.
Adjustment Necessity: Must be uniquely configured for each rewards location.
Marker
Data Type: Object
Description: Settings for the marker that appears at the rewards location, including type, size, and color.
Adjustment Necessity: Modify to change the visibility and appearance of the marker.
Blip
Data Type: Object
Description: Settings for the blip that appears on the map for the rewards location, including sprite, color, and scale.
Adjustment Necessity: Modify to change the visibility and appearance of the blip.
NPC
Data Type: Object
Description: Settings for the non-player character (NPC) that appears at the rewards location, including model, coordinates, and heading.
Adjustment Necessity: Modify to change the appearance and placement of the NPC.
Rewards Settings (Rewards)
For each day (e.g., [1], [2], [3], [4]):
Data Type: Object
Description: Defines the rewards for each day, including type (item, money, weapon, vehicle), name, amount, and label.
Adjustment Necessity: Modify to set up the daily rewards.
Database Settings (vehicleSQL)
tableName
Data Type: String
Description: The name of the database table where vehicles are stored.
Adjustment Necessity: Must be adjusted to match the actual table in your database.
plateColumn
Data Type: String
Description: The column name for vehicle plates in the database table.
Adjustment Necessity: Modify to match the actual column in your database table.
ownerColumn
Data Type: String
Description: The column name for vehicle owners in the database table.
Adjustment Necessity: Modify to match the actual column in your database table.
Notification Functions
clientNotify (function)
Description: Triggers a notification on the client side.
Usage:
clientNotify(message)
wheremessage
is the notification text to be displayed.
serverNotify (function)
Description: Triggers a notification on the server side, sent to the specified client.
Usage:
serverNotify(source, message)
wheresource
is the client identifier andmessage
is the notification text.
Remember to adjust the trigger events to align with your own framework or scripts.
Last updated