# 🚜 Farm Store Robbery Script — Gabz Edition (README)

Thank you for choosing the Farm Store Robbery script for your FiveM server! This package provides an immersive, configurable store-robbery experience (Gabz locations & props supported) with extensive per-interaction options, minigame hooks, loot tables, and police dispatch integration. 🎭💰

---

## ⚠️ Important Notice (Dependencies)

To ensure the script works properly you **must** install the following:

- community_bridge (required) 🔗  

  <https://github.com/The-Order-Of-The-Sacred-Framework/community_bridge>

- ox_lib (required) 🔗  

  <https://github.com/overextended/ox_lib>

Optional / recommended for vanilla experience (minigames & UI):

- boii_minigames (minigame implementations) 🎮

  <https://github.com/boiidevelopment/boii_minigames>

- bl_ui (UI used by some minigames) 🖼️  

  <https://github.com/Byte-Labs-Studio/bl_ui>

• lockpick (lockpick minigame) 🔓  

  <https://github.com/baguscodestudio/lockpick>

Compatibility: QBOX | QBCORE | ESX | STANDALONE (script-side glue required). ⚙️

Join our Farm Discord for help, updates and community: <https://discord.gg/nKPvwZTfcq> 🎧

---

## 🚀 Quick Installation / Startup

1. Download and install `community_bridge` and any minigame resources you plan to use.

2. Place folders in your server `resources` directory.

3. Ensure the dependencies are started before this resource in your server.cfg:

```lua

ensure community_bridge

ensure boii_minigames

ensure bl_ui

ensure lockpick

ensure farm_gabz_storerobbery

```

(Only ensure the resources you actually install.)

---

## ✨ Key Features

- 🔧 Full control for every robbery interaction: Electric box, Registers, Keypad, Safe, Computer, Shelves, Fridges, Freezer, Donut stands, Door.

- 🎯 Per-interaction settings: enable/disable, interaction type, required items, skill checks, minigames, progress bars, police alerts.

- 💵 Flexible reward system: cash/bank/item, skill XP, item drops with configurable chances and amounts.

- ⏱️ Global or per-location cooldown/reset timers.

- 🔬 Evidence system integration leaves forensic evidence at robbery scenes for police investigation.

- 🐞 Debug mode and per-action logging options for troubleshooting.

- 🧩 Supports community_bridge / drawtext interactions for flexible UX.

- ✍️ pre-translated into 24 languages for international server compatibility.

---

## 🧭 Config Overview (config.lua)

Top-level:

- Config.Locale — language code (default: 'en') 🌐

- Config.Debug — enable debug prints / debug zones 🐛

- Config.Keybind — key for 'drawtext' interactions (default: 38) ⌨️

- Config.Logs — toggles for logging: startRobbery, resetRobbery, dispatch, addMoney, addSkill, addItem 📚

RobberySettings (main table) includes:

- ResetTime — minutes until location resets (default: 60) ⏲️

- PoliceJobs — list of job names (e.g., 'police', 'sheriff') that receive alerts 🚓

- MinimumPoliceRequired — minimum online cops required to start a robbery 👮‍♂️

- StartFromElectricBox — whether robbery must begin at electric box 🔌

- Cooldown.global — true = single global cooldown across all locations; false = per-location ❄️

Each interaction (ElectricBox, Registers, Keypad, Safe, Computer, Shelves, Fridges, Donut, Freezer, Door) has similar configurable keys:

Common keys:

- enable — toggle ✅/❌

- interaction — 'bridge' (community_bridge) 🔗 or 'drawtext' ✍️

- skill — { required = bool, level = { skill = 'name', level = N } } 🎓

- itemsRequired — mapping itemName => { quantity, breakChance } 🧰

- Minigame — identifier string ('wirecut', 'lockpick', 'numberslide', 'skillbar', 'circleprogress') 🎮

- ProgressBarTime — seconds for progress bar ⏳

- alertPolice — send dispatch alert? 📣

- size / zone — vec3(...) interaction size 📐

- props — table of prop model names for randomized props 🎲

---

## 🎁 Reward Structure (per interaction)

- Reward.Money:

  - Moneytype — "cash" | "bank" | "item" | nil (use Lua nil to disable) 💸

  - MoneyItem — item name used when Moneytype == "item" (commonly "dirty_money") 🧾

  - MoneyReward — { min = x, max = y } amount range ⚖️

- Reward.Skill:

  - Enable — boolean to grant skill XP 🆙

  - Name — skill identifier 🏷️

  - Reward — { min = x, max = y } points range 🎯

- Reward.GetItem — whether to drop items 🎒

- Reward.Item — array of loot entries: { item = "name", chance = percentage, amount = { min, max } } 🎲

Notes:

- Moneytype = nil (Lua nil) is different from string "nil" — use nil to disable monetary rewards. ⚠️

- breakChance is a 0–100 percentage for item break on use. 🔨

---

## 📝 Example Defaults (from config.lua)

- Registers: Moneytype = "cash", MoneyReward 150–300; skill 'registers'; item drops like diamond_ring, goldchain. 💍

- Safe: Moneytype = "cash", MoneyReward 500–1000; skill 'safe'; richer item table (diamond_ring, goldchain, rolex). ⌚

- ElectricBox: can give dirty_money + copper; used to trigger full robbery. 🔌🪙

- Shelves / Fridges / Donut / Freezer: typically GetItem = true and provide food/drinks (donut, water, milk, etc.). 🍩🥤

---

## 🕹️ Minigame Names & Integration

Minigame identifiers used in config (script needs to call your minigame implementations accordingly):

- wirecut ✂️

- lockpick 🔓

- numberslide 🔢

- skillbar 🧠

- circleprogress ⭕

Make sure your server has minigame resources and that the script maps these identifiers to the appropriate minigame exports/events.

---

## 💡 Tips & Recommendations

- Adjust MinimumPoliceRequired for realistic RP balance — higher = more challenging. ⚖️

- Use Cooldown.global = true to prevent "store-hopping" farming across the map. 🌍

- For best UX, use community_bridge (interaction = 'bridge'). 👍

- Tune ProgressBarTime to align with minigame durations so players don't see mismatched timers. ⏱️

- For harder content, increase MoneyReward, increase item chance for safes/computers. 🔧

- Use Config.Debug = true during setup to visualize interaction zones and logs. 🧭

---

## 🛠️ Troubleshooting

- Interactions not showing:

  - Verify community_bridge is installed and interaction is set to 'bridge', or set to 'drawtext' if you don't use bridge. 🔍

- Items not consuming / break logic:

  - Confirm your inventory integration removes items and applies breakChance logic. 🧾

- Police alerts not firing:

  - Ensure PoliceJobs matches your framework's job names and dispatch integration is present. 🚨

---

## ✍️ How to Customize

- Edit Reward.Item lists to change loot tables. 🧾

- Change itemsRequired to require different tools (e.g., custom tools instead of lockpick). 🛠️

- Toggle alertPolice and tailor PoliceJobs to who should receive alerts. 📞

- Change MoneyReward min/max to tune economy impact. 💱

---

## ▶️ Suggested Next Steps

- Integrate the script with your server's economy and inventory (QBCore/ESX/etc) to manage Moneytype behaviors and item grants. 🔄

- Map your minigame resources to the identifiers used in the config. 🧩

- Tune PoliceJobs, MinimumPoliceRequired, and rewards for your target playerbase. 👥

- Consider enabling Config.Logs while testing to capture detailed events for debugging. 📝

---

## 📦 Credits & Links

- community_bridge — <https://github.com/The-Order-Of-The-Sacred-Framework/community_bridge>

- boii_minigames — <https://github.com/boiidevelopment/boii_minigames>

- bl_ui — <https://github.com/Byte-Labs-Studio/bl_ui>

- lockpick — <https://github.com/baguscodestudio/lockpick>

- Farm Discord — <https://discord.gg/nKPvwZTfcq>