Configuration

Available configuration for resource.

CFG = {}

CFG.FRAMEWORK = 'QBCore' -- 'QBCore', 'QBX', 'ESX', 'ESXOLD' or false to disable it
CFG.INVENTORY = 'qb' -- 'qb', 'ox', 'qs', 'esx' or false to disable it
CFG.TARGET = false -- 'qb-target', 'qtarget', 'ox_target' or false to disable it
CFG.DATABASE = 'oxmysql' -- 'oxmysql', 'mysql-async' or false to disable
CFG.NOTIFY = 'ox' -- 'ox', 'qb', 'esx', 'native' or false

CFG.MENU = {
	type = 'ox', -- 'ox', 'menuv'

	-- 'menuv' uses: topright (default), topleft, bottomright, bottomleft
	-- 'ox' uses: top-right (default), top-left, bottom-right, bottom-left
	pos = 'top-right', 

	-- these settings are only for MenuV
	size = 'size-125', -- menu size
	colour = { r = 250, g = 20, b = 60 }, -- https://www.rapidtables.com/web/color/RGB_Color.html
	banner = 'none', -- 'none', 'default', 'default_native'
	banner_text = false, -- 'TEXT'
}

-- RESTRICTION OPTIONS --
CFG.RESTRICTIONS = {
	--[[ 
		ACE PERMS 
		- put this into your server cfg and edit identifier to yours

		add_ace buddy buddy allow
		add_principal identifier.license:830e0a2add6393cf28f45474dbf6ac4577f0652a buddy #sheen
	]]
	USE_ACE_PERMS = false, -- true / false

	--[[
		JOB RESTRICTIONS (only with QBCore/QBX/ESX/ESXOLD)
		- jobs and grades that have access to buddy menu
		- it's disabled if ace perms are enabled
	]]
	JOBS = {
		-- job name, grade numbers
		['police'] = {0, 1, 2, 3, 4, 5, 6, 7, 8, 9}, 
	}
}

-- https://docs.fivem.net/docs/game-references/controls/ -- list of controls
CFG.CONTROLS = {
	-- AIM AND HIT THE KEY
	aim = {
		attack = 38, -- E
		go = 47 -- G
	},
}

CFG.SETTINGS = {

	WEAPONS = {
		taser = `weapon_stungun`,
		pistol = `weapon_pistol`,
		rifle = `weapon_carbinerifle`,
	},

	HEARING_RANGE = 60.0, -- radius for hearing shots

	-- if false then headshot will deal same damage as any other body shots
	INSTA_HEADSHOT = true, -- true/false

	MAX_BUDDIES = 2, -- max registered buddies per character
	BLIP = true, -- creates blip for your buddy on the map

	DELETE_BUDDY = { -- delete buddy if
		buddy_dead = false, -- if u want to use this option, then disable saving of health and armor below
		owner_dead = false 
	},

	STATUS = {
		-- new registered buddy spawns automatically with maxHealth
		-- u can set any max values
		maxHealth = 200, maxArmor = 100,
	
		--[[ 
			true = it will don't save these values into database, 
			so players are able to respawn his buddy through menu without reviving option
		]]
		disable_hp_and_armor_saving = false, 
	
		heal = {
			revive_timer = 3, -- reviving buddy
	
			timer = 3, -- applying bandage
			amount = {from = 10, to = 25}, -- how much hp will be added to buddy
			item = 'bandage',
		},
		armor = {
			timer = 3,
			amount = {from = 10, to = 25}, -- how much armor will be added to buddy
			item = 'armor',
		},
	}
}

-- BUDDIES FOR REGISTRATION --
CFG.BUDDIES = {
	-- label and spawn name
	['Cop'] = `s_m_y_cop_01`,
	['Male MP'] = `mp_m_freemode_01`,
}

CFG.COMMANDS = {

	BINDING_SYSTEM = { -- fivem keybinding system
		enable = true, -- true/false
		commands = {
			--[[ 
				- three parameters -
					command is name of command from the list below
					key is primary key for triggering
					label is showed in FiveM keybinds as description for bind

				- list of usable keys
				https://docs.fivem.net/docs/game-references/input-mapper-parameter-ids/keyboard/
			]]

			[1] = { command = 'buddy', key = 'K', label = 'Open Buddy Menu' }, -- binding command buddy to K key (example)
			-- [2] = { command = 'bdanimations', key = 'L', label = 'Open Buddy Animations' },
		},
	},


	--[[
		LIST OF COMMANDS
		- code_name and name of command
		- change only name of command if you need to!
	]]
	disable = false, -- true = disable all commands

	-- main
	['register_buddy'] = 'bdregister',
	['reselect'] = 'bdreselect',
	['main_menu'] = 'buddy',
	['save_buddy'] = 'bdsave',
	['check_buddy'] = 'bdcheck',
	['spawn'] = 'bdspawn',
	['animations'] = 'bdanimations',

	-- actions
	['follow'] = 'bdfollow',
	['vehicle'] = 'bdvehicle',

	-- other
	['heal'] = 'bdheal',
	['armor'] = 'bdarmor',
	['carry'] = 'bdcarry',

}

-- ANIMATIONS --
-- u can add more
CFG.BUDDY_ANIMATIONS = {
	--[[

		-- supports scenarios and animations, look down for examples

		FLAGS FOR ANIMATIONS:
		1 = repeat animation
		2 = stop on last frame of animation
		0 = normal
	]]

	{
		name = 'Cop Idles',
		scenario = 'WORLD_HUMAN_COP_IDLES'
	},
	{
		name = 'Cop Beacon',
		scenario = 'WORLD_HUMAN_CAR_PARK_ATTENDANT'
	},
	{
		name = 'Cop Investigate',
		dict = 'amb@code_human_police_investigate@idle_a', anim = 'idle_b', flags = 1,
	}, 
	{
		name = 'Crossarms',
		dict = 'anim@amb@nightclub@peds@', anim = 'rcmme_amanda1_stand_loop_cop', flags = 51,
	}, 
	{
		name = 'Reaching',
		dict = 'move_m@intimidation@cop@unarmed', anim = 'idle', flags = 51,
	}, 
	{
		name = 'Smoke',
		scenario = 'WORLD_HUMAN_AA_SMOKE'
	}, 
}

CFG.WALK_STYLES = {
	["Alien"] = {"move_m@alien"},
	["Armored"] = {"anim_group_move_ballistic"},
	["Arrogant"] = {"move_f@arrogant@a"},
	["Brave"] = {"move_m@brave"},
	["Casual"] = {"move_m@casual@a"},
	["Casual2"] = {"move_m@casual@b"},
	["Casual3"] = {"move_m@casual@c"},
	["Casual4"] = {"move_m@casual@d"},
	["Casual5"] = {"move_m@casual@e"},
	["Casual6"] = {"move_m@casual@f"},
	["Chichi"] = {"move_f@chichi"},
	["Confident"] = {"move_m@confident"},
	["Cop"] = {"move_m@business@a"},
	["Cop2"] = {"move_m@business@b"},
	["Cop3"] = {"move_m@business@c"},
	["Default Female"] = {"move_f@multiplayer"},
	["Default Male"] = {"move_m@multiplayer"},
	["Drunk"] = {"move_m@drunk@a"},
	["Drunk"] = {"move_m@drunk@slightlydrunk"},
	["Drunk2"] = {"move_m@buzzed"},
	["Drunk3"] = {"move_m@drunk@verydrunk"},
	["Femme"] = {"move_f@femme@"},
	["Fire"] = {"move_characters@franklin@fire"},
	["Fire2"] = {"move_characters@michael@fire"},
	["Fire3"] = {"move_m@fire"},
	["Flee"] = {"move_f@flee@a"},
	["Franklin"] = {"move_p_m_one"},
	["Gangster"] = {"move_m@gangster@generic"},
	["Gangster2"] = {"move_m@gangster@ng"},
	["Gangster3"] = {"move_m@gangster@var_e"},
	["Gangster4"] = {"move_m@gangster@var_f"},
	["Gangster5"] = {"move_m@gangster@var_i"},
	["Grooving"] = {"anim@move_m@grooving@"},
	["Guard"] = {"move_m@prison_gaurd"},
	["Handcuffs"] = {"move_m@prisoner_cuffed"},
	["Heels"] = {"move_f@heels@c"},
	["Heels2"] = {"move_f@heels@d"},
	["Hiking"] = {"move_m@hiking"},
	["Hipster"] = {"move_m@hipster@a"},
	["Hobo"] = {"move_m@hobo@a"},
	["Hurry"] = {"move_f@hurry@a"},
	["Janitor"] = {"move_p_m_zero_janitor"},
	["Janitor2"] = {"move_p_m_zero_slow"},
	["Jog"] = {"move_m@jog@"},
	["Lemar"] = {"anim_group_move_lemar_alley"},
	["Lester"] = {"move_heist_lester"},
	["Lester2"] = {"move_lester_caneup"},
	["Maneater"] = {"move_f@maneater"},
	["Michael"] = {"move_ped_bucket"},
	["Money"] = {"move_m@money"},
	["Muscle"] = {"move_m@muscle@a"},
	["Posh"] = {"move_m@posh@"},
	["Posh2"] = {"move_f@posh@"},
	["Quick"] = {"move_m@quick"},
	["Runner"] = {"female_fast_runner"},
	["Sad"] = {"move_m@sad@a"},
	["Sassy"] = {"move_m@sassy"},
	["Sassy2"] = {"move_f@sassy"},
	["Scared"] = {"move_f@scared"},
	["Sexy"] = {"move_f@sexy@a"},
	["Shady"] = {"move_m@shadyped@a"},
	["Slow"] = {"move_characters@jimmy@slow@"},
	["Swagger"] = {"move_m@swagger"},
	["Tough"] = {"move_m@tough_guy@"},
	["Tough2"] = {"move_f@tough_guy@"},
	["Trash"] = {"clipset@move@trash_fast_turn"},
	["Trash2"] = {"missfbi4prepp1_garbageman"},
	["Trevor"] = {"move_p_m_two"},
	["Wide"] = {"move_m@bag"},
}

-- LANG --
CFG.LANG = {
	ox_notify_header = 'BUDDY ALERT',

	register_header = 'REGISTER YOUR BUDDY',
	choose_desc = 'Choose your buddy',
	name_buddy = 'Name Your Buddy',
	register_buddy = 'Register Buddy',
	name = 'Name',

	select_buddy = 'SELECT YOUR BUDDY',
	buddy_menu = 'BUDDY MENU',

	spawn = 'Spawn | Remove',
	spawn_desc = 'Call your buddy',

	follow = 'Follow',
	stop = 'Stop',
	follow_desc = 'Follow me!',

	get_in = 'Get In',
	get_out = 'Go Out',
	get_desc = 'Send your buddy to vehicle',

	animations = 'Animations',
	anim_desc = 'Play Animations',

	reselect = 'Reselect Buddy',
	reselect_desc = 'Open selection menu',

	other = 'Other Options',
	other_desc = 'Some cool features hiding there',

	check_buddy = 'Check Status',
	check_desc = 'Make sure your buddy is okay',

	other_actions = 'Check Your Buddy',

	carry = 'Carry',
	carry_desc = 'Carry your buddy',
	stop_carry = 'Press ~INPUT_DETONATE~ to ~r~stop ~w~carrying.',

	heal_buddy = 'Revive | Heal',
	armor_buddy = 'Armor',
	heal_desc = 'Help your buddy',

	appearance = 'Apperance',
	buddy_style = 'Switch Style (Random)',
	change_appearance = 'Appearance (BETA)',
	
	attack = 'Attack!',
	go = 'Go!',

	buddy_died = 'Your buddy died and got removed.', -- shows this message only if u using -> buddy_remove = true

	missing_item = "You missing required item (%s)",

	status = "Health: %s, Armor: %s",

	max_limit = "You can't register more buddies... (limit %i)",

	nobody_close = 'Nobody close.',

	buddy_not_close = 'You must be close to your buddy.',

	required_job = "You don't have required job.",

	all_seats_occupied = "All seats are occupied...",
	veh_no_found = "Vehicle not found.",
	no_vehicle = "Couldn't find vehicle, make sure you looking on one.",
	no_plate = "Couldn't find vehicle with plate.",
	veh_no_supported = "This vehicle model isn't supported.",
 
	saved = 'Buddy was saved.',
	not_loaded = "Your buddy isn't loaded.",
}

Last updated