# Installation & Configuration

{% stepper %}
{% step %}

### Add the resource

**Drag the `dynyx_weed` folder into your `resources` directory.**\
Make sure it’s properly placed so your server can access it. Don’t forget to add `ensure dynyx_weed` to your `server.cfg` file to activate the resource.
{% endstep %}

{% step %}

### Download Required Weed Props

**Download the required weed prop assets from the following link:**\
🌐 <https://github.com/Annalouu/an-weedprops>\
These props are used to visually enhance the weed growing system.
{% endstep %}

{% step %}

### Import the SQL File

**Open your database (e.g., HeidiSQL, phpMyAdmin) and import the provided SQL file.**\
This will create the necessary database tables and data for the weed growing script to function correctly.
{% endstep %}

{% step %}

### Configure Inventory Integration

**Navigate to the `inventory` folder.**\
Each inventory system requires a slightly different configuration. Follow the guide specific to your inventory (like ox\_inventory, qb-inventory, ps-inventory or qs-inventory).\
The item images for your inventory can be found in the `images` folder to ensure seamless visual integration.

* [ox\_inventory](https://dynyx-scripts.gitbook.io/dynyx-scripts/weed-growing/installation-and-configuration/ox_inventory)
* [qb-inventory](https://dynyx-scripts.gitbook.io/dynyx-scripts/weed-growing/installation-and-configuration/qb-inventory-ps-inventory) / [ps-inventory](https://dynyx-scripts.gitbook.io/dynyx-scripts/weed-growing/installation-and-configuration/qb-inventory-ps-inventory)
* [qs-inventory](https://dynyx-scripts.gitbook.io/dynyx-scripts/weed-growing/installation-and-configuration/qs-inventory)
  {% endstep %}
  {% endstepper %}

## Configuration:

```lua
Config = {}

Config.FrameWork = "QBCore" --  We Support 3 Framworks for this verison [QBCore / QBOX / ESX]
Config.Lan = 'en' -- Translation 'en', 'es', 'de', 'fr'
Config.Notifications = "OX" -- [OX / QB]
Config.WebHooks = false -- Enable or disable Discord webhooks (true = enabled, false = disabled)
Config.WebHookURL = "PASTE_YOUR_URL_HERE" -- URL for the Discord webhook where logs will be sent

-- Use Object Gizmo for placement visualization (true = enable, false = disable)
-- If disabled, the script will use the built-in placement system instead.
Config.UseObjectGizmo = false  

-- ITEM NAMES
Config.Shovel = 'plant_shovel'
Config.Shears = 'plant_shears'
Config.Fertilizer = 'plant_fertilizer'
Config.Pot = 'plant_pot'
Config.Water = 'water'
Config.Baggie = 'plant_emptybag'

-- Plant Growth Requirements
Config.MinimumGrowthRequirement = 50 -- The minimum percentage of water and fertilizer needed for the plant to keep growing.
Config.MaxPlantLimit = 15 -- Maximum number of plants a player can plant at the same time

-- Water Settings
Config.StartAmountWater = 60 -- Initial water percentage when a plant is created.
Config.LoseWaterAmount = 5 -- Water percentage lost every set time interval.
Config.LoseWaterTime = 30 -- (SECONDS) Time interval at which the plant loses water.
Config.WaterFeedAmount = 15 -- Water percentage restored when watering the plant.

-- Fertilizer Settings
Config.StartAmountFertilizer = 55 -- Initial fertilizer percentage when a plant is created.
Config.LoseFertilizerAmount = 2 -- Fertilizer percentage lost every set time interval.
Config.LoseFertilizerTime = 60 -- (SECONDS) Time interval at which the plant loses fertilizer.
Config.FertilizerFeedAmount = 15 -- Fertilizer percentage restored when adding fertilizer.

-- Growth Settings
Config.GainGrowthAmount = 5 -- Growth percentage gained every set time interval.
Config.GainGrowthTime = 30 -- (SECONDS) Time interval at which the plant gains growth.

-- Plant Lifespan & Placement
Config.PlantLifetime = 180 -- (MINUTES) Time before a neglected plant is deleted due to lack of water and fertilizer.
Config.MinDistanceBetweenPlants = 2.0 -- Minimum required distance between plants to prevent overlap.

Config.Plant = {
    ['bluedream'] = {
        label = 'Blue Dream Plant', -- Label for weed 
        seed = 'seed_bluedream', -- Weed Seed item name
        baggie = 'bluedream_bag', -- Weed Baggy item name
        bud = 'bud_bluedream', -- Weed Bud item name
        budMin = 5, -- Minimum buds you get from harvesting plant
        budMax = 10, -- Maximum  buds you get from harvesting plant
        BudsForBag = 5, -- Buds require to make 1 weed bag
        PlacingProgressBarDuration = 1, -- Duration of the progress bar when planting a seed (in seconds)
        RequirePot = true, -- Whether a pot is required to plant this seed (true = required, false = not required) 
        RemovePot = 1, -- Number of pots required to plant a single seed
        RequireShovel = true, -- Whether a shovel is required to plant this seed (true = required, false = not required)
        RemoveShovel = 0, -- Number of shovels required if a shovel is needed for planting
        Props = { -- Plant props for each stage
            [1] = `an_weed_blue_01_small_01a`,
            [2] = `an_weed_blue_med_01b`,
            [3] = `an_weed_blue_lrg_01a`
        }
    },
    ['purplehaze'] = {
        label = 'Purple Haze Plant',
        seed = 'seed_purplehaze',
        baggie = 'purplehaze_bag',
        bud = 'bud_purplehaze',
        budMin = 5,
        budMax = 10,
        BudsForBag = 5,
        PlacingProgressBarDuration = 10,
        RequirePot = true,
        RemovePot = 1,
        RequireShovel = true,
        RemoveShovel = 0,
        Props = {
            [1] = `an_weed_purple_01_small_01a`,
            [2] = `an_weed_purple_med_01b`,
            [3] = `an_weed_purple_lrg_01a`
        }
    },
    ['glue'] = {
        label = 'Glorilla Glue Plant',
        seed = 'seed_glue',
        baggie = 'glue_bag',
        bud = 'bud_glue',
        budMin = 5,
        budMax = 10,
        BudsForBag = 5,
        PlacingProgressBarDuration = 10,
        RequirePot = true,
        RemovePot = 1,
        RequireShovel = true,
        RemoveShovel = 0,
        Props = {
            [1] = `an_weed_white_01_small_01a`,
            [2] = `an_weed_white_med_01b`,
            [3] = `an_weed_white_lrg_01a`
        }
    },
    ['bananakush'] = {
        label = 'Banana Kush Plant',
        seed = 'seed_bananakush',
        baggie = 'bananakush_bag',
        bud = 'bud_bananakush',
        budMin = 5,
        budMax = 10,
        BudsForBag = 5,
        PlacingProgressBarDuration = 10,
        RequirePot = true,
        RemovePot = 1,
        RequireShovel = true,
        RemoveShovel = 0,
        Props = {
            [1] = `an_weed_yellow_01_small_01a`,
            [2] = `an_weed_yellow_med_01b`,
            [3] = `an_weed_yellow_lrg_01a`
        }
    },
}
```

<br>