¶ Nebula_PropManager
Documentation for Nebula Prop Manager resource.
¶ Installation
- Unzip the file downloaded from https://keymaster.fivem.net
- Add the resource to your designed Fivem resource folder. There is a risk changing file names will break the resource, do so at your own risk.
- Add
start nebula_propmanagerto your start config (may be located in server.cfg depending on your setup) - If you would like to save props that are spawned to the DB, import nebula.sql. You can set per-prop saving in the
config.lua. - Dependancies:
- Target script (qTarget, BT-Target, etc.), you can download and install https://github.com/serraz/qtarget.
- oxmysql (recommended) or mysql-async (edit fxmanifest) - https://github.com/overextended/oxmysql/releases
¶ Setup & Configuration
- Open
config.lua, and edit to your servers needs. - If not using ESX or QBCore, edit
server/framework.luawith your framework triggers. - If not using mythic_notify, edit
server/framework.luaNotifyClientfunction for your notification script. - If using props as items, follow steps 5-6 . If using props as a menu item, follow step 7.
- After adding your desired props to the
config.lua, add the items to your database or inventory config (depends on your inventory) - Add item to your desired location to purchase or in a script to give items to players.
- To spawn a prop using a menu, your menu must be able to trigger to a client event and pass the prop name you want to spawn.
TriggerClientEvent('nebula_propmanager:client:menuEvent', propname)propnamemust be a string with the name of the prop in the config (e.g.'prop_roadcone02a'). Please note: Due to too many variations we will not provide support on setting up your individual menus to work with our script.
Config = {}
-- Menu trigger event: TriggerClientEvent('nebula_propmanager:client:menuEvent', propname) must be name of prop, not the item name. Use this event to bypass item requirements and spawn using menu.
Config.BTConfig = {
Export = exports['qtarget'], -- Set your export for the target script of your choosing. Must have "AddTargetModel" as an export option
PickupIcon = "fas fa-trash-restore", -- Icon used for target Pickup menu option
MoveIcon = "fas fa-expand-arrows-alt", -- Icon used for target Move menu option
TargetDist = 1.5, -- Distance you can be from target to see options
}
Config.SaveInterval = 5 -- Default: 5 - How frequently in minutes will the script save props to database? Set to 0 if you want to disable database saving. This will impact server performance if you lower this number.
Config.Framework = 'esx' -- Set the framework you are using 'esx' or 'qbcore'. Please go into server/framework.lua and set the notification export to what you need.
Config.DropControl = 73 -- Default: X -- Used to drop a item after picked up.
--[[
Ace perms require you to know the identifier type your server uses for setting up command acces.
You will need to add_ace to your ace server.cfg file for it to check the right access.
Add aces to match your groups that you use in ace permissions. So if you have a group call "god", add "add_ace group.god god allow" to your server.cfg
Example:
add_ace group.superadmin superadmin allow
add_ace group.admin admin allow
add_ace group.mod mod allow
PLEASE NOTE: YOU DO NOT NEED TO USE THIS FEATURE FOR PROPS TO WORK. Only needed if you want to lock a prop to group perms.
]]
Config.Identifier = 'license' -- Ace group permission identifier for your server. Usually license or steam.
Config.Props = {
["prop_roadcone02a"] = { -- Propname
name = "roadcone", -- Item name
bone = 28422, -- Bone to attach to
pos = {0.6,-0.15,-0.1}, -- Position on ped when attached
rot = {315.0,288.0,0.0}, -- Rotation on ped when attached
push = false, -- Pushing animation when moving
freeze = true, -- Freeze a prop in position or not (remove for not frozen)
jobs = {['police'] = 0,['ambulance'] = 0}, -- Jobs who have access to this prop and grade for that job
groups = false, -- Example: {'mod','admin','superadmin'} Role based access control based on admin groups. Set false to not check.
zone = {radius = 10.0, speed = 0}, -- Radius around the prop for AI cars to slow down speed of Ai cars around prop (remove if not needed )
dbsave = true, -- Does this prop save to db?
},
["prop_gas_pump_old2"] = {
name = "gaspump",
bone = 28422,
pos = {0.0,-0.5,-1.3},
rot = {-195.0,-180.0,180.0},
freeze = true,
jobs = false,
groups = {'mod','admin','superadmin'},
dbsave = true,
},
["prop_barrier_work06a"] = {
name = "barrier",
bone = 28422,
pos = {0.6,-0.15,-0.1},
rot = {315.0,288.0,0.0},
push = false,
freeze = true,
jobs = false,
groups = false,
zone = {radius = 10.0, speed = 0},
dbsave = true,
},
["prop_cs_trolley_01"] = {
name = "ttrolly",
bone = 28422,
pos = {-0.1,-0.6,-0.85},
rot = {-180.0,-165.0,90.0},
push = true,
freeze = false,
jobs = {['mechanic'] = 0,},
groups = false,
dbsave = true,
},
["prop_tool_box_04"] = {
name = "toolboxp",
bone = 28422,
pos = {0.4,-0.1,-0.1},
rot = {315.0,288.0,0.0},
push = true,
freeze = false,
jobs = {['mechanic'] = 0,},
groups = false,
dbsave = true,
},
["prop_engine_hoist"] = {
name = "hoist",
bone = 28422,
pos = {0.0,-0.5,-1.3},
rot = {-195.0,-180.0,180.0},
push = true,
freeze = false,
jobs = {['mechanic'] = 0,},
groups = false,
dbsave = true,
},
}
Config.BackupRemove = 'zoneremove' -- Command to remove zone should there be issues picking up prop.
Lang = {
['noJob'] = "You are not authorized to use this item.",
['move'] = "Move",
['pickup'] = "Pickup",
}```