> For the complete documentation index, see [llms.txt](https://lumen-works-1.gitbook.io/lumen-works/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://lumen-works-1.gitbook.io/lumen-works/redm/herbs.md).

# Herbs

## Installation

* Works with [RedEM:RP](https://github.com/RedEM-RP) /[VORP](https://github.com/VORPCORE) / [RSG ](https://rexshack-gaming.gitbook.io/rsg/rsg-redm-server-build)/  RedEM:RP. Be sure you installed one of them before to use this script.
* Drag and drop the resource in your resources folder
  * lumen\_herbs
* Edit the config.lua to make sure to customize the code

If you have any questions, please contact our lumen works discord.

## Framework

```lua
Config.framework = "redemrp"
```

You can set the framework you need. The available options are "redemrp",  "vorp", "rsg", "redemrpold".

## Language

```lua
Config.Text = {
    [1] = "It seems that it has not been good for you to eat ",
    [2] = "Nearby you can find ~t6~", 
    [3] = "You got ~t6~x ",
    [4] = "You have eaten too many plants recently, wait a bit to eat again",
}
```

## Other configurations

```lua
Config.rangeBlip = 60.0
Config.satiate = {time = 30, qty = 4}
```

You can customize these parameters

* rangeBlip : Here you can set the distance where the blip will appear on the map.
* satiate : You can modify the number of times you can eat before satiety and every how many seconds you will subtract 1 satiety point.

## Notifications / Metabolism / Custom Reward

```lua
Config.notifyServer = function(text,src)
    TriggerClientEvent('redem_roleplay:ShowObjective',src, text, 4000)
end

Config.notifyClient = function(text)
    TriggerEvent('redem_roleplay:ShowObjective', text, 4000)
end

Config.metabolismHungry = function(src,qty)
    --ADD YOUR METABOLISM SCRIPT HERE
end

Config.metabolismThirst = function(src,qty)
   --ADD YOUR METABOLISM SCRIPT HERE
end


Config.CustomReward = true
Config.customReward = function(src)

    --ADD YOUR CUSTOM REWARD SCRIPT HERE
end

```

Set your custom notification system here, by default redemrp is added\
Add your metabolism script, if you don't have one or have doubts about how to add yours, contact us by discord.

Adding extra rewards from other scripts you have (for example experience or levels)

Here 

## Plants & Eggs

```lua
    [1] = { 
        composite = "COMPOSITE_LOOTABLE_AGARITA_DEF",
        blipname = "Agarita",
        bliphash = -675651933, --https://filmcrz.github.io/blips/
        coordsZone =  vector3(-4691.35, -2326.63, 28.161),
        quantityNodes = 5,
        model = -834461873,
        item = "agarita",
        quantity = {min = 1, max = 3},
        metabolism = {hungry = 20, thirst = 20},
        indigestion = false,
        probIndigestion = 80,
    },
```

This is an example of a node, you can find the following configurations:

* composite = Do not modify, this is the id of the plant model
* blipname = Name node
* bliphash = Icon that will appear on the map
* coordsZone = Node spawn coordinates
* quantityNodes = Number of nodes appearing in the zone
* model = do not change
* item = name of the item that will be added to the inventory when collected
* quantity = Minimum and maximum item quantity
* metabolism = Amount of hunger and thirst for metabolism
* indigestion = You can choose true or false. This enables or disables the possibility of getting sick when eating.
* probIndigestion = probability of indigestion (100 % = always)<br>


---

# Agent Instructions
This documentation is published with GitBook. GitBook is the documentation platform designed so that both humans and AI agents can read, navigate, and reason over technical content effectively. Learn more at gitbook.com.

## Querying This Documentation
If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question.

Perform an HTTP GET request on the current page URL with the `ask` query parameter:

```
GET https://lumen-works-1.gitbook.io/lumen-works/redm/herbs.md?ask=<question>
```

The question should be specific, self-contained, and written in natural language.
The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.

Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.