Config Files
Information
Our configuration files are highly detailed and structured for easy understanding. To make it as simple as possible for you, an explanation is provided next to each setting.
All configuration files can be found in the /configs
folder.
Included configuration files:
---------------------------------------------------------------------------------------------------------------
-- If you have any questions or issues, feel free to open a ticket on our Discord.
-- https://discord.gg/unique
-- "true" = activated, "false" = deactivated. (Applies universally)
-- DO NOT TOUCH THE KEYS BEFORE THE "=" CHARACTER TO PREVENT ERRORS!
-- YOU CAN ONLY EDIT THE VALUES BEHIND THE "=" CHARACTER UNLESS MENTIONED!
UNIQUE = {}
UNIQUE.Framework = exports['es_extended']:getSharedObject()
-----------------------------------------------------------------------
-- [NOTIFICATIONS]
UNIQUE.Locale = 'en' -- Select your language. ['en' or 'de']
UNIQUE.NotifySettings = {
['Announce'] = {
['label'] = "ANNOUNCE", -- Enter the display name for this status here.
['icon'] = 'announce.svg', -- Enter the icon for this status here. [All new icons must be located in /html/img/icons/NotifyTypes.]
['color'] = '#FE9B22', -- Enter the color for this status as a HEX code here. [ATTENTION! = Use a light color of your desired hue. The background will be generated automatically from this.]
},
['NotifyTypes'] = { -- Here you can create custom NotifyTypes that you can use in the export for the Notify. [Each identifer must be unique!]
['success'] = {
['label'] = "SUCCESS", -- Enter the display name for this status here.
['icon'] = 'success.svg', -- Enter the icon for this status here. [All new icons must be located in /html/img/icons/NotifyTypes.]
['color'] = '#26FE22', -- Enter the color for this status as a HEX code here. [ATTENTION! = Use a light color of your desired hue. The background will be generated automatically from this.]
},
['error'] = {
['label'] = "ERROR", -- Enter the display name for this status here.
['icon'] = 'error.svg', -- Enter the icon for this status here. [All new icons must be located in /html/img/icons/NotifyTypes.]
['color'] = '#FE2222', -- Enter the color for this status as a HEX code here. [ATTENTION! = Use a light color of your desired hue. The background will be generated automatically from this.]
},
['warning'] = {
['label'] = "WARNING", -- Enter the display name for this status here.
['icon'] = 'warning.svg', -- Enter the icon for this status here. [All new icons must be located in /html/img/icons/NotifyTypes.]
['color'] = '#FE9B22', -- Enter the color for this status as a HEX code here. [ATTENTION! = Use a light color of your desired hue. The background will be generated automatically from this.]
},
['lifeinvader'] = {
['label'] = "LIFEINVADER", -- Enter the display name for this status here.
['icon'] = 'lifeinvader.svg', -- Enter the icon for this status here. [All new icons must be located in /html/img/icons/NotifyTypes.]
['color'] = '#9022FE', -- Enter the color for this status as a HEX code here. [ATTENTION! = Use a light color of your desired hue. The background will be generated automatically from this.]
},
-- EXAMPLE FOR A NEW NOTIFY TYPE:
['info'] = {
['label'] = "INFORMATION", -- Enter the display name for this status here.
['icon'] = 'info.svg', -- Enter the icon for this status here. [All new icons must be located in /html/img/icons/NotifyTypes.]
['color'] = '#2294FE', -- Enter the color for this status as a HEX code here. [ATTENTION! = Use a light color of your desired hue. The background will be generated automatically from this.]
},
},
['SoundEffects'] = {
['Announce'] = {
['enabled'] = false, -- Do you want to enable the sound effect for announcements?
['filename'] = 'announce.mp3', -- Enter the filename of your desired .mp3 file, which must be located in /html/mp3/.
['volume'] = 0.5, -- Volume of the sound. [0.1 - 1.0]
},
['Notify'] = {
['enabled'] = false, -- Do you want to enable the sound effect for announcements?
['filename'] = 'notify.mp3', -- Enter the filename of your desired .mp3 file, which must be located in /html/mp3/.
['volume'] = 0.5, -- Volume of the sound. [0.1 - 1.0]
},
},
}
-- [NOTIFICATIONS]
-----------------------------------------------------------------------
-----------------------------------------------------------------------
-- [MAIN SETTINGS]
UNIQUE.Settings = {
['TopRight'] = { -- Every image specified in this section must be located in the /html/img/icons/TopRight folder!
['ServerName'] = {
['logo'] = "Logo.png", -- Your logo.
['name'] = "SERVERNAME", -- Enter your server name here.
['subtitle'] = "ROLEPLAY", -- Enter a desired text here that will be displayed below your server name.
['name_letter_spacing'] = 0, -- Letter spacing for the name.
['subtitle_letter_spacing'] = 0.7, -- Letter spacing for the subtitle.
},
['OnlinePlayers'] = {
['enabled'] = true, -- Would you like to display the current players on your server?
['seperator'] = " / 2048",
},
['ID'] = {
['enabled'] = true, -- Would you like to display the player's ID?
['prefix'] = "#",
},
['Job'] = {
['enabled'] = true, -- Would you like to display the player's job?
['jobgrade'] = true, -- Would you like to display the player's rank?
['seperator'] = " - ",
},
['Accounts'] = {
['LoopRequest'] = false, -- Do you want to query the player's accounts every second? [If this feature is enabled, no animations will occur when adding or removing money.]
['First'] = {
['enabled'] = true, -- Would you like to display an account?
['label'] = "Bank", -- Enter the display name for this account here.
['account'] = 'bank', -- Enter here which account you would like to display.
['color'] = '#41B9FF', -- Enter the color with a HEX code that this account should have.
['icon'] = "bank.svg", -- Enter the icon that should be displayed next to the account.
},
['Second'] = {
['enabled'] = true, -- Would you like to display an another account?
['label'] = "Cash", -- Enter the display name for this account here.
['account'] = 'money', -- Enter here which account you would like to display.
['color'] = '#41FF5A', -- Enter the color with a HEX code that this account should have.
['icon'] = "cash.svg", -- Enter the icon that should be displayed next to the account.
},
['Third'] = {
['enabled'] = false, -- Would you like to display an another account?
['label'] = "Dirty Money", -- Enter the display name for this account here.
['account'] = 'black_money', -- Enter here which account you would like to display.
['color'] = '#FF4141', -- Enter the color with a HEX code that this account should have.
['icon'] = "blackmoney.svg", -- Enter the icon that should be displayed next to the account.
},
['Animation'] = {
['enabled'] = true, -- Would you like to keep the animation of "rolling up" the money?
['roll'] = 3, -- How long should the animation last?
['fade'] = 3, -- How long should the small box displaying the amount of money be visible?
},
},
['Weapon'] = {
['enabled'] = true, -- Would you like to display the weapon indicator + ammunition?
['seperator'] = " / ",
['tickrate'] = 500, -- Here you can adjust the tick rate of the weapon display.
},
},
['TopLeft'] = {
['Date'] = {
['enabled'] = true, -- Would you like to display the date / time?
['format'] = "%H:%M - %d.%m", -- Date format. [%d = day, %m = month, %Y = year, %H = hour, %M = minute] <- Pay attention to the case sensitivity!
},
},
['BottomRight'] = {
['Speedo'] = {
['unit'] = "kmh", -- Choose between 'kmh' and 'mph'.
['maxspeed'] = 240, -- Enter the max speed of the speedo.
['tickrate'] = 50, -- Here you can change the tick rate of the speedometer.
['ShowOnlyForDriver'] = false, -- Would you like to display the entire speedometer only for the driver?
['VehicleLights'] = {
['enabled'] = true, -- Would you like to enable the indicator for vehicle lights?
},
['VehicleEngine'] = {
['enabled'] = true, -- Would you like to enable the indicator for engine health?
['damaged_enginehealth'] = 400.0,
['broken_enginehealth'] = 150.0,
},
['VehicleLock'] = {
['enabled'] = true, -- Would you like to enable the indicator for the locked or unlocked vehicle?
},
},
},
['BottomLeft'] = {
['Location'] = {
['enabled'] = true, -- Would you like to display the location?
['VehicleSettings'] = {
['enabled'] = false, -- Would you like to display the location only in the vehicle?
['show_only_for_driver'] = false, -- Would you like to display the location only for the driver?
},
},
['Minimap'] = {
['food'] = true, -- Would you like to display the hunger indicator?
['thirst'] = true, -- Would you like to display the thirst indicator?
['Voice'] = {
['enabled'] = true, -- Would you like to display the voice ui?
['type'] = 'saltychat', -- Choose between 'saltychat' and 'pma'.
['show_marker'] = true, -- Would you like to display a marker when changing the voice radius?
['marker_color'] = '#BFFF38', -- Enter the color for the marker as a HEX code here.
['Ranges'] = { -- Enter here all the voice ranges available on your server. ( ATTENTION! = Saltychat starts at [0] and PMA-Voice starts at [1] )
[0] = {range = 3, ui_width = 10}, -- [1] = Voice range number 1, 'range' = voice range, 'ui_width' = percentage length of the voice UI.
[1] = {range = 7, ui_width = 40},
[2] = {range = 14, ui_width = 70},
[3] = {range = 28, ui_width = 100},
-- [4] = {range = 3.5, ui_width = 10},
-- [SALTYCHAT] = Normally 4 voice states. (Voice ranges can be changed in the saltychat folder in the config.json file.)
-- [PMA-VOICE] = Normally 3 voice states. (Voice ranges can be changed in the pma-voice folder in the shared.lua file.)
},
},
['Radio'] = {
['enabled'] = true, -- Would you like to display the radio ui?
},
},
},
['HudSettings'] = {
['enabled'] = true, -- Would you like to enable the HUD settings?
['command'] = 'hud', -- What is the command used to invoke these settings?
['Hotkey'] = {
['enabled'] = false, -- Would you like to set a hotkey for the HUD settings?
['key'] = 'F11', -- What is the hotkey used to invoke these settings? [https://docs.fivem.net/docs/game-references/input-mapper-parameter-ids/keyboard/]
},
['Settings'] = { -- Here are all the HUD settings.
['HideAll'] = {
['enabled'] = true,
['label'] = "SHOW HUD",
},
['CinematicBars'] = {
['enabled'] = true,
['label'] = "CINEMATIC MODE",
},
['Minimap'] = {
['enabled'] = true,
['label'] = "SHOW MINIMAP",
},
['ServerName'] = {
['enabled'] = true,
['label'] = "SHOW SERVERNAME",
},
['OnlinePlayers'] = {
['enabled'] = true,
['label'] = "SHOW ONLINE PLAYERS",
},
['ID'] = {
['enabled'] = true,
['label'] = "SHOW MY ID",
},
['Job'] = {
['enabled'] = true,
['label'] = "SHOW MY JOB & GRADE",
},
['Accounts'] = {
['enabled'] = true,
['label'] = "SHOW MY ACCOUNTS",
},
['Weapon'] = {
['enabled'] = true,
['label'] = "SHOW WEAPON INFORMATION",
},
['Date'] = {
['enabled'] = true,
['label'] = "SHOW DATE & TIME",
},
['Speedo'] = {
['enabled'] = true,
['label'] = "SHOW SPEEDO",
},
['Location'] = {
['enabled'] = true,
['label'] = "SHOW LOCATION",
},
['Food'] = {
['enabled'] = true,
['label'] = "SHOW FOOD",
},
['Thirst'] = {
['enabled'] = true,
['label'] = "SHOW THIRST",
},
['Voice'] = {
['enabled'] = true,
['label'] = "SHOW VOICE",
},
['Radio'] = {
['enabled'] = true,
['label'] = "SHOW RADIO",
},
},
['DisplayOrder'] = { -- Here you can customize the arrangement in the HUD settings, if desired.
"HideAll",
"CinematicBars",
"Minimap",
"ServerName",
"OnlinePlayers",
"ID",
"Job",
"Accounts",
"Weapon",
"Date",
"Speedo",
"Location",
"Food",
"Thirst",
"Voice",
"Radio",
},
},
}
-- [MAIN SETTINGS]
-----------------------------------------------------------------------
-- https://discord.gg/unique
-- If you have any questions or issues, feel free to open a ticket on our Discord.
---------------------------------------------------------------------------------------------------------------
---------------------------------------------------------------------------------------------------------------
-- If you have any questions or issues, feel free to open a ticket on our Discord.
-- https://discord.gg/unique
-- "true" = activated, "false" = deactivated. (Applies universally)
-- DO NOT TOUCH THE KEYS BEFORE THE "=" CHARACTER TO PREVENT ERRORS!
-- YOU CAN ONLY EDIT THE VALUES BEHIND THE "=" CHARACTER UNLESS MENTIONED!
------------------------------------------------------------------------
-- [APPEARANCE SETTINGS]
UNIQUE.Commands = {
['Announce'] = {
['enabled'] = true, -- Do you want to activate this command?
['command'] = 'announce', -- How do you create an announcement command?
['title'] = "SERVER", -- Title of the announcement.
['duration'] = 15, -- Displaytime of the announcement.
['Ranks'] = { -- Enter here all the ranks that can use this command.
'superadmin',
'admin',
-- 'developer',
},
},
['RestrictedZones'] = {
['enabled'] = true, -- Do you want to activate this command?
['command'] = 'newzone', -- How do you create an announcement command?
['displayname'] = "RESTRICTED ZONE", -- Title of the announcement and display name in the UI.
['duration'] = 15, -- Displaytime of the announcement.
['auto_delete_zone_range'] = 100.0, -- If no player is within this radius, the affected restricted zone will be automatically deleted.
['Jobs'] = { -- Enter all jobs here that can create restricted zones using the specified command.
['police'] = {
['Announce'] = {
['label'] = "POLICE", -- Enter the display name for this announce here.
['icon'] = "police.svg", -- Enter the icon for this announce here. [All new icons must be located in /html/img/icons/NotifyTypes.]
['color'] = "#2294FE", -- Enter the color for this announce as a HEX code here. [ATTENTION! = Use a light color of your desired hue. The background will be generated automatically from this.]
['msg'] = "The LSPD has just announced a restricted area! <br> Comply with the police department's demands!", -- Announce message. ['<br>' = Linebreak.]
},
['Blips'] = {
['name'] = "RESTRICTED AREA", -- Blip name.
['main_sprite'] = 60, -- Blip sprite. [https://docs.fivem.net/docs/game-references/blips/#blips]
['radius_sprite'] = 161, -- Blip sprite. [https://docs.fivem.net/docs/game-references/blips/#blips]
['color'] = 3, -- Blip color. [https://docs.fivem.net/docs/game-references/blips/#blip-colors]
},
},
['ambulance'] = {
['Announce'] = {
['label'] = "AMBULANCE", -- Enter the display name for this announce here.
['icon'] = "ambulance.svg", -- Enter the icon for this announce here. [All new icons must be located in /html/img/icons/NotifyTypes.]
['color'] = "#FE224A", -- Enter the color for this announce as a HEX code here. [ATTENTION! = Use a light color of your desired hue. The background will be generated automatically from this.]
['msg'] = "The LSMD has just announced a restricted area! <br> Please keep your distance so we can do our work!", -- Announce message. ['<br>' = Linebreak.]
},
['Blips'] = {
['name'] = "RESTRICTED AREA",-- Blip name.
['main_sprite'] = 61, -- Blip sprite. [https://docs.fivem.net/docs/game-references/blips/#blips]
['radius_sprite'] = 161, -- Blip sprite. [https://docs.fivem.net/docs/game-references/blips/#blips]
['color'] = 1, -- Blip color. [https://docs.fivem.net/docs/game-references/blips/#blip-colors]
},
},
},
},
}
-- [DISCORD LOGS]
------------------------------------------------------------------------
-- https://discord.gg/unique
-- If you have any questions or issues, feel free to open a ticket on our Discord.
---------------------------------------------------------------------------------------------------------------
Last updated