Shop

t1ger_mechanic/shared/shop.lua

Job

The Config.Shop.Job section defines the default output of a newly created job in runtime during shop creation.

Config.Shop.Job = { -- Job Settings
    defaultGrades = {
        [0] = {grade = 0, name = "recruit", label = "Recruit", salary = 50},
        [1] = {grade = 1, name = "employee", label = "Employee", salary = 75},
        [2] = {grade = 2, name = "boss", label = "Boss", salary = 100},
        -- make sure boss grade is the very last one (higest grade)
    },
    defaultDuty = true, -- only qbcore/qbox
    offDutyPay = false, -- only qbcore/qbox
}

• defaultGrades (table) — these grades will be automatically created with the newly created job. Make sure they are index properly, starting from 0. The script will automatically convert the grades to match the compatible framework.

• defaultDuty (boolean) — only relevant for qb-core and qbx_core

• defaultPay (boolean) — only relevant for qb-core and qbx_core

Job Account

Config.Shop.JobAccount = true -- true = Use JobAccount system for society/shared account | false = Use our integrated account system

• JobAccount (boolean) — determines whether to use society/shared account to manage funds in the shop or to use our built-in system to manage shop funds.

Please refer to Job Account for properly setting up your shared/society banking script.

Sale

Config.Shop.Sale = true -- allow buy shops? And admins to list shop for_sale or cancel sale?

• Sale (boolean) — Allow shops being listed for sale by admins and purchasable by players?

Admin

The Config.Shop.Admin section defines the important settings for admins.

Config.Shop.Admin = {
    menu = { 
		enable = true, -- enable/disable admin mechanic menu?
		command = {enable = true, str = "mechanic:admin"}, -- enable/disable command
		keybind = {enable = true, default = "F10", description = "Mechanic Admin Menu"} -- enable/disable keybind
	},
}

• menu (table) — controls the admin menu to create & manage mechanic shops

  • enable (boolean) — determines whether to utilize the admin-menu

  • command (table) — enable command with given command name to open the admin-menu

  • keybind (table) — enable keybind with given default key to open the admin menu

Creation

The Config.Shop.Creation section defines the basic shop-creator settings.

Config.Shop.Creation = {
    command = {enable = true, str = "mechanic:create"}, -- enable/disable command to directly open creator interface?
    blip = { -- blip settings for shop blips
		input = true, -- allow admins to modify sprite & color in shop creator interface?
		sprite = 446, -- default sprite
		color = 5, -- default color
		display = 4, -- default display
		scale = 0.75 -- default scale 
	},
}

• command (table) — enable command with given command name to open the shop-creator interface

• blip (table) — default blip settings for mechanic shops

  • input (boolean) — allow admins to modify sprite and color?

Management

The Config.Shop.Management section defines the basic admin management perms.

Config.Shop.Management = {
    command = {enable = true, str = "mechanic:manage"}, -- enable/disable command for admins to directly open management interface?
    markerEdit = true, -- set to false to disable option in admin management menu to edit marker. 
    markerTeleport = true, -- set to false to disable option in admin management menu to TP to marker.
}

• command (table) — enable command with given command name to open the management interface

• markerEdit (boolean) — allow admins to edit a placed marker?

• markerTeleport (boolean) — allow admins to teleport to a marker?

Storage

The Config.Shop.Storage section defines the storage settings.

Config.Shop.Storage = {
    slots = 50, -- default slots for created storage/stash
    weight = 100000, -- default weight for created storage/stash
    maxSlots = 500, -- max slots for editing storage/stash
    maxWeight = 999999 -- max weight for editing storage/stash
}

• slots(integer) — default slots for a created storage/stash

• weight(number) — default weight for a created storage/stash

• maxSlots(integer) — the max slots size admins can set when editing a storage/stash marker

• maxWeight(number) — the max weight admins can set when editing a storage/stash marker.

Marker Settings

The Config.Shop.MarkerSettings section defines the default settings for shop markers.

Config.Shop.MarkerSettings = {
    keybind = 38, -- Keybind for interacting with the marker. 
    distance = 5.0, -- distance to load/draw marker
    textUi = { -- UI settings for prompts.
        position = 'right-center',
        style = {borderRadius = 0, backgroundColor = '#48BB78', color = 'white'}
    },
}

• keybind(integer) — default (E) keybind for interacting with a shop marker

• distance(number) — default distance to marker in order to draw the marker graphics

• textUi(table) — settings for textUi

  • position (string)

  • style (table)