Skip to content

Installation

Follow the steps in order. The only part that differs between servers is step 4 and step 5, where you add the job and the items to your own framework and inventory.

Make sure these run on your server (see the overview for the full list):

  • oxmysql and ox_lib
  • One framework: es_extended, qb-core, or QBX with its QB-Core compatibility bridge enabled
  • One inventory: ox_inventory, the ESX default inventory, or qb-inventory
  • One target: ox_target or qb-target

The default coordinates are set for the Kivo Weedshop interior. Install that map on your server and make sure it starts. Without it the zones float in the world and the plant, rack and stock props in the interior do not change.

  1. Put the script folder in your server resources directory. The examples on this page use the folder name kivo-weedshop.
  2. Use exactly the same folder name in server.cfg (step 7).

The custom props stream automatically with the script. You do not add them anywhere. For reference, the props are:

  • kivo_forrent_prop.yft, kivo_forrent_prop2.ydr
  • kivo_fertilizer_bag.ydr
  • kivo_jar_closed.ydr, kivo_jar_open.ydr, kivo_jar_justbuds.ydr
  • kivo_shear_l.ydr, kivo_shear_middle.ydr, kivo_shear_r.ydr
  • kivo_weed_leaf.ydr, kivo_weed_drying.ydr
  • kivo_skyhigh_scriptprops.ytyp

The job name must match EmployeeConfig.jobName (default skyhigh) and the five grades must exist as grades 0 to 4. The definitions are in items.lua inside the resource. They are repeated here.

Add this to qb-core/shared/jobs.lua, inside the QBCore.Shared.Jobs table:

['skyhigh'] = {
label = 'SkyHigh Dispensary',
type = 'weedshop',
defaultDuty = true,
offDutyPay = false,
grades = {
['0'] = { name = 'Trainee', payment = 100 },
['1'] = { name = 'Employee', payment = 200 },
['2'] = { name = 'Supervisor', payment = 400 },
['3'] = { name = 'Manager', payment = 600 },
['4'] = { name = 'Boss', payment = 1000, isboss = true, bankAuth = true },
},
},

If you prefer to add it after the table, write it as QBCore.Shared.Jobs['skyhigh'] = { ... } with the same content.

Add the same job and grades to qbx_core/shared/jobs.lua, unless your server already defines skyhigh. QBX uses numbers as grade keys:

['skyhigh'] = {
label = 'SkyHigh Dispensary',
type = 'weedshop',
defaultDuty = true,
offDutyPay = false,
grades = {
[0] = { name = 'Trainee', payment = 100 },
[1] = { name = 'Employee', payment = 200 },
[2] = { name = 'Supervisor', payment = 400 },
[3] = { name = 'Manager', payment = 600 },
[4] = { name = 'Boss', payment = 1000, isboss = true, bankAuth = true },
},
},

Run this SQL against your ESX database:

INSERT INTO `jobs` (`name`, `label`) VALUES
('skyhigh', 'SkyHigh Dispensary')
ON DUPLICATE KEY UPDATE `label` = VALUES(`label`);
INSERT INTO `job_grades`
(`job_name`, `grade`, `name`, `label`, `salary`, `skin_male`, `skin_female`) VALUES
('skyhigh', 0, 'trainee', 'Trainee', 100, '{}', '{}'),
('skyhigh', 1, 'employee', 'Employee', 200, '{}', '{}'),
('skyhigh', 2, 'supervisor', 'Supervisor', 400, '{}', '{}'),
('skyhigh', 3, 'manager', 'Manager', 600, '{}', '{}'),
('skyhigh', 4, 'boss', 'Boss', 1000, '{}', '{}')
ON DUPLICATE KEY UPDATE
`name` = VALUES(`name`),
`label` = VALUES(`label`),
`salary` = VALUES(`salary`);

Restart es_extended after the import, or restart the server.

The script uses five items: weed_seed, weed_shears, wet_weed_plant, dried_weed_plant and weed_preroll. Add them where your inventory reads its items.

Your setup Where the items go
ox_inventory (any framework, including QBX) ox_inventory/data/items.lua
qb-inventory on QB-Core qb-core/shared/items.lua, inside QBCore.Shared.Items
ESX default inventory The items table in your database (SQL below)
['weed_seed'] = {
label = 'Weed Seeds',
weight = 10,
stack = true,
close = true,
description = 'Seeds for growing weed plants. Requires 6 to plant.'
},
['weed_shears'] = {
label = 'Weed Shears',
weight = 500,
stack = false,
close = true,
description = 'Shears used to harvest mature weed plants.'
},
['wet_weed_plant'] = {
label = 'Wet Weed Plant',
weight = 100,
stack = true,
close = true,
description = 'Freshly harvested weed plant. Needs to be dried.'
},
['dried_weed_plant'] = {
label = 'Dried Weed Plant',
weight = 80,
stack = true,
close = true,
description = 'Dried weed plant. Ready for processing.'
},
['weed_preroll'] = {
label = 'Weed Pre-roll',
weight = 30,
stack = true,
close = true,
description = 'A rolled pre-roll ready to be sold at the dispensary.'
},
weed_seed = { name = 'weed_seed', label = 'Weed Seeds', weight = 10, type = 'item', image = 'weed_seed.png', unique = false, useable = false, shouldClose = true, combinable = nil, description = 'Seeds for growing weed plants. Requires 6 to plant.' },
weed_shears = { name = 'weed_shears', label = 'Weed Shears', weight = 500, type = 'item', image = 'weed_shears.png', unique = true, useable = false, shouldClose = true, combinable = nil, description = 'Shears used to harvest mature weed plants.' },
wet_weed_plant = { name = 'wet_weed_plant', label = 'Wet Weed Plant', weight = 100, type = 'item', image = 'wet_weed_plant.png', unique = false, useable = false, shouldClose = true, combinable = nil, description = 'Freshly harvested weed plant. Needs to be dried.' },
dried_weed_plant = { name = 'dried_weed_plant', label = 'Dried Weed Plant', weight = 80, type = 'item', image = 'dried_weed_plant.png', unique = false, useable = false, shouldClose = true, combinable = nil, description = 'Dried weed plant. Ready for processing.' },
weed_preroll = { name = 'weed_preroll', label = 'Weed Pre-roll', weight = 30, type = 'item', image = 'weed_preroll.png', unique = false, useable = false, shouldClose = true, combinable = nil, description = 'A rolled pre-roll ready to be sold at the dispensary.' },
INSERT INTO `items` (`name`, `label`, `weight`, `rare`, `can_remove`) VALUES
('weed_seed', 'Weed Seeds', 10, 0, 1),
('weed_shears', 'Weed Shears', 500, 0, 1),
('wet_weed_plant', 'Wet Weed Plant', 100, 0, 1),
('dried_weed_plant', 'Dried Weed Plant', 80, 0, 1),
('weed_preroll', 'Weed Pre-roll', 30, 0, 1);

The statement matches the standard ESX items table. If your table has different columns, adapt the column list and keep the names, labels and weights.

If your ESX version reads items from a Lua file instead of the database, use the same values in that file’s format:

['weed_seed'] = { name = 'weed_seed', label = 'Weed Seeds', weight = 10, rare = false, canRemove = true },
['weed_shears'] = { name = 'weed_shears', label = 'Weed Shears', weight = 500, rare = false, canRemove = true },
['wet_weed_plant'] = { name = 'wet_weed_plant', label = 'Wet Weed Plant', weight = 100, rare = false, canRemove = true },
['dried_weed_plant'] = { name = 'dried_weed_plant', label = 'Dried Weed Plant', weight = 80, rare = false, canRemove = true },
['weed_preroll'] = { name = 'weed_preroll', label = 'Weed Pre-roll', weight = 30, rare = false, canRemove = true },
Item Used for Amount
weed_seed Planting in an empty plot 6 used up
weed_shears Harvesting a plant 1 required, kept
wet_weed_plant Given by harvesting, put on a drying rack 6 given, 6 used per rack
dried_weed_plant Given by a drying rack, used for rolling 6 given
weed_preroll Given by the rolling area, sold in the selling area 6 per batch by default

The planting, harvesting and drying amounts are fixed at 6. Only the rolling recipe can be changed (see Configuration).

The resource does not ship item images. Add these five files to the image folder of your inventory (for example ox_inventory/web/images or qb-inventory/html/images):

  • weed_seed.png
  • weed_shears.png
  • wet_weed_plant.png
  • dried_weed_plant.png
  • weed_preroll.png

The QB-Core item definitions above point to these exact file names. For ox_inventory the image is picked by item name.

ensure oxmysql
ensure ox_lib
ensure es_extended # or qb-core / qbx_core
ensure ox_inventory # or qb-inventory (or the ESX default inventory)
ensure ox_target # or qb-target
ensure kivo-weedshop

Start the framework, the inventory and the target before the script. Your shop interior map must also be started.

To show players’ Discord avatars in the computer, set a Discord bot token as a convar. Put this line in server.cfg, before the script starts:

set weedshop:discordToken "YOUR_BOT_TOKEN"

Without it the script uses the fallback avatar. See Discord avatars.

Restart the framework or the whole server so the new job and items load, then start the script. In the server console you should not see any of these lines:

Console line Meaning
[kivo-weed-shop] No framework detected (ESX or QBCore required) Neither es_extended nor qb-core was running within 10 seconds. Check the start order.
[kivo-weed-shop] No supported inventory detected No supported inventory was found. See the detection order on the overview page.
[kivo-weed-shop] No target system detected (ox_target or qb-target required) Neither target resource was running. Check the start order.
  1. Set your own job with your framework’s admin command, for example /setjob [id] skyhigh 4 to become the boss (grade 4).
  2. Make sure you are on duty. The QB-Core and QBX job above starts players on duty. On ESX a player counts as on duty unless your framework sets an onDuty value on the job.
  3. Give yourself weed_seed (at least 6) and weed_shears with your inventory’s admin item command.

Next, read Configuration to adjust pay, permissions and zones.