Installation Guide

Setup guide for the current oxide-weed resource.

Prerequisites

Required resources

Resource	Purpose
ox_lib	Locale, callbacks, utility helpers
oxmysql	Database driver
o-link	Framework and system abstraction used by this resource

o-link expectations

This resource depends on your server's o-link setup for:

• player identity and character lookup
• usable item registration
• inventory reads, writes, metadata, and image paths
• money reads and removals
• target interactions for plants, equipment, store, and scientist
• notifications
• progress bars
• stash registration and opening

Installation Steps

1. Place the resource

Place oxide-weed inside your server's resources folder.

2. Add startup order

Start dependencies before the resource:

ensure ox_lib
ensure oxmysql
ensure o-link
ensure oxide-weed

3. Database setup

Run sql/install.sql against your database.

The current install creates these tables:

Table	Purpose
drugs_progression	Weed XP, level, total created, and total sold
drug_equipment	Placed weed tables, totes, water containers, drying racks, freeze dryers, and brick presses
drug_plants	Plant state, genetics, timers, ownership, and quality data
drug_lamps	Grow lamps linked to plants
drug_heaters	Heaters linked to weed tables
drug_drying_slots	Weed table drying slot state
drug_strains	Registered base and hybrid strain metadata

4. Register items

Register these item names in your inventory.

Core materials and outputs

Item	Label
cannabis_seed	Cannabis Seed
weed_bud	Weed Bud
dried_weed_bud	Dried Weed Bud
pruned_weed_bud	Pruned Weed Bud
cannabis_leaf	Cannabis Leaf
pollen	Pollen
weed_1g	Weed (1g)
weed_eighth	Weed (1/8 oz)
weed_quarter	Weed (1/4 oz)
weed_half	Weed (1/2 oz)
weed_ounce	Weed (1 oz)
weed_brick	Weed Brick
joint	Joint
blunt	Blunt

Supplies

Item	Label
plant_pot	Plant Pot
water	Water
fertilizer	Fertilizer
baggy	Baggy
trimming_scissors	Trimming Scissors
rolling_papers	Rolling Papers
cigarillo_wraps	Cigarillo Wraps
lighter	Lighter
watering_can	Watering Can
growing_manual	Growing Manual

Equipment

Item	Label
grow_lamp	Grow Lamp
weed_heater	Heater
weed_table	Weed Table
storage_tote	Storage Tote
water_container_small	Small Water Container
water_container_large	Large Water Container
drying_rack	Drying Rack
freeze_dryer	Freeze Dryer
brick_press	Brick Press

5. Inventory setup examples

oxide-weed uses o-link at runtime, but your inventory still needs matching item definitions.

QBCore with qb-inventory

Add items to qb-core/shared/items.lua using your server's current QB item syntax:

cannabis_seed = { name = 'cannabis_seed', label = 'Cannabis Seed', weight = 1, type = 'item', image = 'cannabis_seed.png', unique = false, useable = true, shouldClose = true, description = 'Cannabis seed used for planting' },
weed_bud = { name = 'weed_bud', label = 'Weed Bud', weight = 100, type = 'item', image = 'weed_bud.png', unique = false, useable = false, shouldClose = true, description = 'Fresh cannabis bud' },
weed_table = { name = 'weed_table', label = 'Weed Table', weight = 7000, type = 'item', image = 'weed_table.png', unique = false, useable = true, shouldClose = true, description = 'Processing table for weed operations' },

ox_inventory

Add items to ox_inventory/data/items.lua using your current item syntax:

['cannabis_seed'] = {
    label = 'Cannabis Seed',
    weight = 1,
},

['weed_bud'] = {
    label = 'Weed Bud',
    weight = 100,
},

['weed_table'] = {
    label = 'Weed Table',
    weight = 7000,
},

Important exact-name checks:

• water is the item name used by the resource
• rolling_papers is plural
• baggy must match exactly
• joint and blunt must exist as usable outputs

6. Copy item images

Copy the .png files from item images/ into your inventory image directory.

Common locations:

• qb-inventory/html/images/
• ox_inventory/web/images/

7. Review configuration

Review:

• shared/config.lua
• shared/config/plants.lua
• shared/config/strains.lua
• shared/config/genetics.lua
• shared/config/drying.lua
• shared/config/equipment.lua
• shared/config/lamps.lua
• shared/config/freezedryer.lua
• shared/config/dryingrack.lua
• shared/config/progression.lua
• shared/config/smoking.lua
• shared/config/store.lua
• shared/config/scientist.lua
• shared/config/wildplants.lua

See the Configuration Guide for the full reference.

Verification

1. Start the server and confirm ox_lib, oxmysql, o-link, and oxide-weed all load without dependency errors.
2. Join the server and verify a test player can receive the required items.
3. Use /weed_kit for a fast setup path during verification.
4. Plant a seed and confirm placement, watering, and fertilizer consumption work.
5. Place a weed table and confirm interactions appear through your configured o-link target system.
6. Open the store and scientist interactions and verify the UIs load.
7. Harvest, dry, prune, and bag at least one product to confirm the full item pipeline.

Notes

• Dirty money handling only applies to scientist transactions and is configured in shared/config.lua under Config.DirtyMoney.
• The Germinator store always uses regular cash.
• The packaged web/dist build is already included. Rebuild the UI only if you edit files under web/src.

Next Steps

• Features
• Configuration
• Admin Guide
• Troubleshooting