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:

cl_config.lua

---------------------------------------------------------------------------------------------------------------
-- 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 = {}

-----------------------------------------------------------------------
-- [NPC INTERACTION]

UNIQUE.NPC = {
	['ImmigrationViaNPC_OR_Bell'] = 'auto', -- Choose from the following options:
										   -- true = Manual entry available at any time via NPC.
										   -- false = Bell to notify active team members.
										   -- 'auto' = Automatic switch between the bell when team members are online and manual entry when no team members are online.
										   
	['coords'] = vector3(-1085.49, -2837.88, 27.69), -- At which coordinates should the NPC be accessible?

	-- Auto Immigration. [These settings only apply if the ['ImmigrationViaNPC_OR_Bell'] entry is set to 'true' or 'auto' read above!]
	['questionnaire'] = 'random', -- Choose between 1, 2, 3, or 'random'.
	['time'] = 15, -- Enter the number of minutes the player has to complete the questionnaire.
	-- Auto Immigration. [These settings only apply if the ['ImmigrationViaNPC_OR_Bell'] entry is set to 'true' or 'auto' read above!]

	-- Bell. [These settings only apply if the ['ImmigrationViaNPC_OR_Bell'] entry is set to 'false' or 'auto' read above!]
	['cooldown'] = 120, -- In what intervals (in seconds) can the player use this bell?

	['Ranks'] = { -- Which ranks should be notified when using the bell?
		'superadmin',
		'admin',
	},

	['Audio'] = {
		['enabled'] = true, -- Would you like a sound to be played for the players with the specified job?
		['audioname'] = 'ATM_WINDOW', -- Audio Name. [https://altv.stuyk.com/docs/articles/tables/frontend-sounds.html]
		['audioref'] = 'HUD_FRONTEND_DEFAULT_SOUNDSET', -- Audio Ref. [https://altv.stuyk.com/docs/articles/tables/frontend-sounds.html]
	},
	-- Bell. [These settings only apply if the ['ImmigrationViaNPC_OR_Bell'] entry is set to 'false' or 'auto' read above!]

    ['Blip'] = {
        ['enabled'] = true, -- Would you like to activate the blip?
		['name'] = "Immigration Bell", -- Blip name.
		['sprite'] = 177, -- Blip sprite. [https://docs.fivem.net/docs/game-references/blips/]
		['color'] = 47, -- Blip color. [https://docs.fivem.net/docs/game-references/blips/#blip-colors]
		['scale'] = 1.0, -- Blip scale. [0.1 - ∞]
    },
    ['Marker'] = {
        ['enabled'] = false, -- Would you like to use a marker?
		['type'] = 21, -- Marker sprite. [https://docs.fivem.net/docs/game-references/markers/]
		['rotate'] = true, -- Would you like the marker to rotate?
		['bounce'] = true, -- Would you like the marker to bounce?
		['color'] = '#F1A502', -- Marker color. [HEX-Code]
		['scale'] = {X = 1.0, Y = 1.0, Z = 1.0}, -- Marker scale.
		['opacity'] = 100, -- Marker opacity. [0 - 255]
		['actiondistance'] = 1.0, -- Marker interaction radius.
		['drawdistance'] = 10.0, -- Marker viewdistance. [Higher value = Higher usage.]
    },
	['NPC'] = {
		['enabled'] = true, -- Would you like to spawn a NPC?
		['model'] = 'a_m_m_prolhost_01',
		['heading'] = 240.94,
		['Animation'] = {
			['enabled'] = true, -- Would you like to assign an animation to the NPC?
			['animdict'] = "anim@heists@heist_corona@single_team", -- Animation (https://gtahash.ru/animations/)
			['animname'] = "single_team_loop_boss", -- Flag (https://gtahash.ru/animations/)
		}
	}
}

-- [NPC INTERACTION]
-----------------------------------------------------------------------

-----------------------------------------------------------------------
-- [NOTIFICATIONS]

UNIQUE.Locale = 'en' -- Select your language. ('en' or 'de')

UNIQUE.ActionNotifys = true -- Do you want to display all action messages for the person performing a player action? (e.g., 'You have teleported ... to yourself.')

UNIQUE.Customnotify = false -- Do you want to use your own notify?

function Notify(type, msg) -- Your Notify Trigger. ('msg' must be retained.)
	if type == 'info' then 
        TriggerEvent('unique_notify:Notify', 'information', msg, 5000)
    end

    if type == 'success' then
        TriggerEvent('unique_notify:Notify', 'success', msg, 5000)
    end

    if type == 'error' then 
        TriggerEvent('unique_notify:Notify', 'error', msg, 5000)
    end
end

UNIQUE.HelpNotify = false -- Do you want to use a helpnotify?
function HelpNotify() -- Your HelpNotify Trigger / Export.
    exports['unique_helpnotify']:TriggerHelpNotify("PRESS E TO INTERACT.")
end

-- [NOTIFICATIONS]
-----------------------------------------------------------------------

-----------------------------------------------------------------------
-- [FUNCTIONS]

function GetSkin() -- Function to query and set the current appearance of a player. [CLIENT SIDE]
	ESX.TriggerServerCallback('esx_skin:getPlayerSkin', function(skin)
		TriggerEvent('skinchanger:loadSkin', skin)
	end)
end

function OpenSkinMenu(src, Player) -- Function to open the skin menu. [SERVER SIDE]
	Player.triggerEvent('esx_skin:openSaveableMenu')
end

function DeletePlayersIdentity(src, Player, Teammember_Name) -- Function to delete the players identity. [SERVER SIDE]
	Player.kick(_msg('deleted_character_for_target_kick_message', Teammember_Name))
	Citizen.Wait(500)
	MySQL.Async.execute('DELETE FROM users WHERE identifier = @identifier', {
		['@identifier'] = Player.identifier,
	})
end

UNIQUE.SuccessFunction = false -- Do you want to trigger a custom function once the player successfully passed the immigration?
function Success(src, Player) -- Your custom function. [SERVER SIDE]
	-- Player.addInventoryItem('bread', 10)
	-- print("success")
end

UNIQUE.ImmigrationReward = false -- Would you like to reward immigration officers when they immigrate a player?
function ImmigrationReward() -- Your custom function. [CLIENT SIDE]
	-- print("Immigration Reward")
end

UNIQUE.BanReward = false -- Would you like to reward immigration officers when they ban / kick a player?
function BanReward() -- Your custom function. [CLIENT SIDE]
	-- print("Ban Reward")
end

-- [FUNCTIONS]
-----------------------------------------------------------------------

-----------------------------------------------------------------------
-- [MAIN SETTINGS]

UNIQUE.AutoWhitelistNewPlayers = false -- WARNING! This function automatically whitelists all new players. [DISABLES SAFEZONE & BACK TELEPORT!] (Intended for, a weekend without immigration, etc.)

UNIQUE.Settings = {
	['Immigration'] = { -- Coordinates to which team members will be teleported once they enter the immigration command.
		['coords'] = vector3(-1065.66, -2798.19, 27.71),
		['heading'] = 151.32,

		['dimension'] = 0, -- 0 = Normal dimension.
	},
	['Success'] = { -- Coordinates to which the player will be teleported upon successfully completing the questionnaire.
		['coords'] = vector3(-1042.98, -2746.61, 21.40),
		['heading'] = 335.4,
	},
	['Failed'] = { -- Coordinates to which the non-whitelisted player will be teleported back once they leave the designated area.
		['coords'] = vector3(-1134.88, -2774.56, 26.80),
		['heading'] = 150.0,
	},
	
	['Immigration_Zone'] = { -- All immigration zone options.
		['coords'] = vector3(-1067.62, -2796.59, 27.71), -- Center point of the airport zone.
		['radius'] = 110.0, -- Size of the airport area.
		['show_marker'] = false, -- Do you want to display the radius marker for testing purposes?

		['Player_IDs'] = {
			['enabled'] = true, -- Would you like to display the ID and name above players heads for active immigration officers?
			['show_ingame_name'] = true, -- Would you like to display the player's first and last name? [Default FiveM name.]
			['range'] = 50.0, -- How far would you like the ID + player name to be visible?
		},

		['Safezone'] = true, -- Prevents hitting and using weapons within the specified radius.
	},

	['Custom_Job'] = { -- Here you can set a job that an immigration officer receives during their service. [Upon leaving via command, they will revert to their previous job.]
		['enabled'] = false, -- Would you like to enable this function?
		['jobname'] = 'police', -- Enter the name of the job that the immigration officer should receive here.
		['jobgrade'] = 0, -- Enter the rank of the job that the immigration officer should receive here.
	},

	['Custom_Ped'] = { -- Ped that every player receives when teleporting to the immigration via command. (Disable Outfit Function!)
		['enabled'] = false, -- Do you want to activate this function?
		['male'] = 'csb_vincent', -- Ped for men.
		['female'] = 'a_f_y_business_01', -- Ped for women.
	},

	['Outfit'] = { -- Outfit that every player receives when teleporting to the immigration via command. (Disable Ped Function!)
		['enabled'] = false, -- Do you want to activate this function?
		['Male'] = { -- Outfit for men.
			['helmet_1'] = -1,  	['helmet_2'] = 0,
			['mask_1'] = 0,			['mask_2'] = 0,
			['ears_1'] = -1,     	['ears_2'] = 0,
			['glasses_1'] = -1,  	['glasses_2'] = 0,
			['chain_1'] = 128,    	['chain_2'] = 0,
			['tshirt_1'] = 15,  	['tshirt_2'] = 0,
			['torso_1'] = 322,   	['torso_2'] = 0,
			['bproof_1'] = 0,		['bproof_2'] = 0,
			['arms'] = 4, 			['arms_2'] = 0,
			['pants_1'] = 24,   	['pants_2'] = 0,
			['shoes_1'] = 7,   		['shoes_2'] = 0,
			['bags_1'] = 0,     	['bags_2'] = 0
		},
		['Female'] = { -- Outfit for women.
			['helmet_1'] = -1,  	['helmet_2'] = 0,
			['mask_1'] = 0,			['mask_2'] = 0,
			['ears_1'] = -1,     	['ears_2'] = 0,
			['glasses_1'] = 5,  	['glasses_2'] = 0,
			['chain_1'] = 98,    	['chain_2'] = 0,
			['tshirt_1'] = 14,  	['tshirt_2'] = 0,
			['torso_1'] = 329,   	['torso_2'] = 2,
			['bproof_1'] = 0,		['bproof_2'] = 0,
			['arms'] = 2, 			['arms_2'] = 0,
			['pants_1'] = 34,   	['pants_2'] = 0,
			['shoes_1'] = 29,   	['shoes_2'] = 0,
			['bags_1'] = 0,     	['bags_2'] = 0
		},
	},

	['Tablet'] = {

		['Command'] = {
			['command'] = 'tablet', -- Example = "/tablet".
			['only_available_in_immigration'] = false, -- Do you want to allow opening the tablet only when inside the immigration service?
			['Hotkey'] = {
				['enabled'] = false, -- Would you like to set a hotkey for this command?
				['hotkey'] = "F11", -- Currently, "F11" is selected. (You can find all keys here: https://docs.fivem.net/docs/game-references/input-mapper-parameter-ids/keyboard/)
			},
		},

		['NewPlayerNotify'] = true, -- Displays to all players with access to the immigration tablet that a new player has arrived at the airport.

		['PlayerActions'] = {
			["Goto"] = { -- Teleports the player performing the action to the selected player.
				['CloseUI'] = true, -- Should the tablet close after this action?
				['Ranks'] = { -- List all the ranks here that are allowed to perform this action.
					'superadmin',
					'admin',
				},
			},
			["Bring"] = {
				['CloseUI'] = true, -- Should the tablet close after this action?
				['Ranks'] = { -- List all the ranks here that are allowed to perform this action.
					'superadmin',
					'admin',
				},
			},
			["Freeze"] = {
				['CloseUI'] = true, -- Should the tablet close after this action?
				['Ranks'] = { -- List all the ranks here that are allowed to perform this action.
					'superadmin',
					'admin',
				},
			},
			["Skinmenu"] = {
				['CloseUI'] = true, -- Should the tablet close after this action?
				['Ranks'] = { -- List all the ranks here that are allowed to perform this action.
					'superadmin',
					'admin',
				},
			},
			["DeleteChar"] = {
				['CloseUI'] = true, -- Should the tablet close after this action?
				['Ranks'] = { -- List all the ranks here that are allowed to perform this action.
					'superadmin',
					'admin',
				},
			},
			["Ban"] = {
				['CloseUI'] = true, -- Should the tablet close after this action?
				['Duration'] = 72, -- Duration of the ban in hours.
				['Ranks'] = { -- List all the ranks here that are allowed to perform this action.
					'superadmin',
					'admin',
				},
			},
		},

		['ImmigrationOptions'] = {

			['fail_ban_duration'] = 24, -- Duration of the ban in hours if the player fails to complete the questionnaire.

			['AvailableTime'] = {
				[1] = {
					['minutes'] = 5, -- Time in minutes for option 1.
				},
				[2] = {
					['minutes'] = 10, -- Time in minutes for option 2.
				},
				[3] = {
					['minutes'] = 15, -- Time in minutes for option 3.
				},
				['Custom'] = {
					['maxlength'] = 2, -- Maximum digits.
				},
			},

			['SendPlayerInQuestionnaire'] = {
				['ChangeDimension'] = true, -- Do you want to teleport the player to a random dimension?

				['Teleport'] = {
					['enabled'] = true, -- Do you want to teleport the player?
					['coords'] = vector3(1173.51, -3196.6, -40.02), -- Coordinates of the location.
					['heading'] = 95.77,

					['Freeze'] = { -- Prevents map glitching for players with lower-end PCs.
						['enabled'] = true, -- Do you want to freeze the player for the number of seconds indicated one below?
						['seconds'] = 2, -- The seconds for which the player is freezed after teleportation.
					},
				},

				['seconds_until_questionnaire'] = 3, -- Seconds until the questionnaire appears. (If freeze is activated, seconds after the freeze.)

				['seconds_until_statistic'] = 3, -- Seconds until the questionnaire statistics are displayed.

				['seconds_until_teleport_after_statistic'] = 3, -- Seconds until the player is teleported to the respective position.

				['CloseUI'] = true, -- Should the tablet close after this action?
				['Ranks'] = { -- List all the ranks here that are allowed to perform this action.
					'superadmin',
					'admin',
				},
			},

			['ImmigratePlayerInstant'] = {
				['CloseUI'] = true, -- Should the tablet close after this action?
				['Ranks'] = { -- List all the ranks here that are allowed to perform this action.
					'superadmin',
					'admin',
				},
			},

			['Questionnaires'] = {
				['Prevent_Tabbing_Out'] = {
					['enabled'] = true, -- Kicks the player if they attempt to tab out of the game during a questionnaire. (Tracks the mouse cursor as well as potential keys designated for window switching.)
					['ban_duration'] = 72, -- Duration of the ban in hours if the player leaves the game window during the questionnaire.
				}
			}
		}
	}
}

-- [MAIN SETTINGS]
-----------------------------------------------------------------------

-- https://discord.gg/unique
-- If you have any questions or issues, feel free to open a ticket on our Discord.
---------------------------------------------------------------------------------------------------------------

sv_config.lua

---------------------------------------------------------------------------------------------------------------
-- 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!


------------------------------------------------------------------------
-- [DISCORD LOGS]

UNIQUE.Appearance = {
    ['static_avatar_url'] = '/html/img/elements/no_player.svg', -- Enter your static image here if you have disabled Discord avatars. (You can also use links.)

    ['discord_functions'] = false, -- Do you want to display each player's Discord avatar and name?
    ['discord_bot_token'] = '' -- Bot token of a bot on your Discord server. (Required for Discord avatars!)
}

UNIQUE.NoteBanDateFormat = "%d.%m.%Y - %H:%M:%S" -- Format of the date. ('%d' = day, '%m' = month, '%y' = year, '%H' = hour, '%M' = minute, '%S' = second.)
UNIQUE.SaveDateFormat = "%d.%m.%Y" -- Format of the date. ('%d' = day, '%m' = month, '%y' = year)

UNIQUE.Commands = {
    ['Tablet'] = { -- Command to open the immigration tablet.
        -- COMMAND CAN BE FOUND IN CLIENTSIDE NOW!

        ['Ranks'] = { -- Which ranks are allowed to use this command?
            'superadmin',
            'admin',
        },
    },
    ['Immigration'] = { -- Command for teleporting in and out of the immigration. (All ranks that can access the tablet can also use this command.)
        ['command'] = "immigration", -- Example = "/immigration".
    },
    ['ShowActiveImmigrationOfficers'] = { -- With this command, you can display how many immigration officers are currently on duty. (All ranks that can access the tablet can also use this command.)
        ['enabled'] = true, -- Would you like to activate this function + command?
        ['command'] = "immigrationofficer", -- Example = "/immigrationofficer".
        -- The position of the display can be changed in the settings.css.
    },
    ['ToggleBellNotifications'] = { -- With this command, team members can unregister from the bell. (All ranks that can access the tablet can also use this command.)
        ['enabled'] = true, -- Would you like to activate this function + command?
        ['command'] = "bellnotify", -- Example = "/bellnotify".
    },
    ['Whitelist'] = {
        ['Add'] = { -- Command to whitelist a player. (All ranks that can access the tablet can also use this command.)
            ['enabled'] = true, -- Do you want to activate this command?
            ['command'] = "wladd", -- Example = "/wladd ID".
        },
        ['Remove'] = { -- Command to remove a player from the whitelist. (All ranks that can access the tablet can also use this command.)
            ['enabled'] = true, -- Do you want to activate this command?
            ['command'] = "wlremove", -- Example = "/wlremove ID".
        },
    },
    ['Unban'] = { -- Command to unban a temporary banned player.
        ['enabled'] = true, -- Do you want to activate this command?
        ['command'] = "wlunban", -- Example = "/wlunban ID".

        ['Ranks'] = { -- Which ranks are allowed to use this command?
            'superadmin',
            'admin',
        },
    },
    ['UpdateAllUsers'] = { -- Warning! This command will whitelist all players registered in the database!
        ['enabled'] = false, -- Do you want to activate this command?
        ['command'] = "wlupdate", -- Example = "/fixdimension ID".
        ['Ranks'] = { -- Which ranks are allowed to use this command?
            'superadmin',
            'admin',
        },
    },
    ['Dimension'] = {
        ['Fix'] = { -- Command to teleport a player to the normal dimension.
            ['enabled'] = true, -- Do you want to activate this command?
            ['command'] = "fixdimension", -- Example = "/fixdimension ID".
            ['Ranks'] = { -- Which ranks are allowed to use this command?
                'superadmin',
                'admin',
            },
        },
    },
}

UNIQUE.Logs = {
    ['enabled'] = false, -- Do you want to enable Discord logs?
    ['webhook'] = "", -- Webhook URL for all logs if you want all logs in 1 channel.

    ['checked_symbol'] = "🔸", -- Displayed in the Discord log before each checked question.
    ['unchecked_symbol'] = "🔹", -- Displayed in the Discord log before each unchecked question.
    ['right_answer'] = "- ✅", -- Displayed in the Discord log after each correct answer.
    
    ['SplitLogs'] = false, -- Do you want to split the logs into different channels/webhooks?

    ['NewPlayer'] = { -- All "New Player" logs.
        ['enabled'] = true, -- Do you want to enable logs for this action?
        ['webhook'] = "", -- Webhook URL for this action.
    },

    ['EnteredImmigration'] = { -- All "Entered Immigration" logs.
        ['enabled'] = true, -- Do you want to enable logs for this action?
        ['webhook'] = "", -- Webhook URL for this action.
    },

    ['LeavedImmigration'] = { -- All "Leaved Immigration" logs.
        ['enabled'] = true, -- Do you want to enable logs for this action?
        ['webhook'] = "", -- Webhook URL for this action.
    },

    ['Goto'] = { -- All "Goto" logs.
        ['enabled'] = true, -- Do you want to enable logs for this action?
        ['webhook'] = "", -- Webhook URL for this action.
    },

    ['Bring'] = { -- All "Bring" logs.
        ['enabled'] = true, -- Do you want to enable logs for this action?
        ['webhook'] = "", -- Webhook URL for this action.
    },

    ['Freeze'] = { -- All "Freeze" logs.
        ['enabled'] = true, -- Do you want to enable logs for this action?
        ['webhook'] = "", -- Webhook URL for this action.
    },

    ['Skinmenu'] = { -- All "Skinmenu" logs.
        ['enabled'] = true, -- Do you want to enable logs for this action?
        ['webhook'] = "", -- Webhook URL for this action.
    },

    ['DeleteChar'] = { -- All "Delete Char" logs.
        ['enabled'] = true, -- Do you want to enable logs for this action?
        ['webhook'] = "", -- Webhook URL for this action.
    },

    ['Ban'] = { -- All "Ban" logs.
        ['enabled'] = true, -- Do you want to enable logs for this action?
        ['webhook'] = "", -- Webhook URL for this action.
    },

    ['Unban'] = { -- All "Unban" logs.
        ['enabled'] = true, -- Do you want to enable logs for this action?
        ['webhook'] = "", -- Webhook URL for this action.
    },

    ['ChangedPlayerData'] = { -- All "ChangedPlayerData" logs.
        ['enabled'] = true, -- Do you want to enable logs for this action?
        ['webhook'] = "", -- Webhook URL for this action.
    },

    ['SendedInQuestionnaire'] = { -- All "Changed Player Data" logs.
        ['enabled'] = true, -- Do you want to enable logs for this action?
        ['webhook'] = "", -- Webhook URL for this action.
    },

    ['QuestionnairePassed'] = { -- All "Sended In Questionnaire" logs.
        ['enabled'] = true, -- Do you want to enable logs for this action?
        ['webhook'] = "", -- Webhook URL for this action.
    },

    ['QuestionnaireNotPassed'] = { -- All "Questionnaire Not Passed" logs.
        ['enabled'] = true, -- Do you want to enable logs for this action?
        ['webhook'] = "", -- Webhook URL for this action.
    },

    ['InstantImmigrate'] = {
        ['enabled'] = true, -- Do you want to enable logs for this action?
        ['webhook'] = "", -- Webhook URL for this action.
    },

    ['WhitelistAddCommand'] = {
        ['enabled'] = true, -- Do you want to enable logs for this action?
        ['webhook'] = "", -- Webhook URL for this action.
    },

    ['WhitelistRemoveCommand'] = {
        ['enabled'] = true, -- Do you want to enable logs for this action?
        ['webhook'] = "", -- Webhook URL for this action.
    },

    ['WhitelistUpdateAllUsersCommand'] = {
        ['enabled'] = true, -- Do you want to enable logs for this action?
        ['webhook'] = "", -- Webhook URL for this action.
    },
    
    ['color'] = 15836418, -- Enter your desired color code on [https://www.spycolor.com/], copy the "decimal index" color code, and replace the current one with your new code.

    ['header'] = "unique_immigration", -- Author text.
	['header_link'] = "https://discord.gg/invite/unique", -- Author link. 
	['header_image'] = "https://unique-studio.de/UNIQUE/DESIGNS/Logo_New.png", -- Author image.

    ['thumbnail'] = "https://unique-studio.de/UNIQUE/DESIGNS/Logo_New.png", -- Thumbnail image.

    ['footer_date_format'] = "%d.%m.%Y 〢 %H:%M:%S", -- Date format. (%d = day, %m = month, %Y = year, %H = hour, %M = minute, %S = second.) <- Pay attention to the case sensitivity!
    ['footer_emoji'] = "📅", -- Footer emoji.
}

-- [DISCORD LOGS]
------------------------------------------------------------------------

-- https://discord.gg/unique
-- If you have any questions or issues, feel free to open a ticket on our Discord.
--------------------------------------------------------------------------------------------------------------