> For the complete documentation index, see [llms.txt](https://docs.tzmc.dev/docs/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://docs.tzmc.dev/docs/qb-core/begging-and-garbage-searching.md).

# Begging & Garbage Searching

Elevate your FiveM server's immersion with the Begging & Garbage Searching Script, designed to bring a gritty and realistic element to your roleplay experience. This script allows players to engage in begging and scavenging activities, providing a unique way to earn money and rewards while navigating the streets of Los Santos.

⚡ **Key Features**:

* **Interactive Begging System**: Use a customizable begging board to interact with NPCs across the map, with randomized outcomes and rewards based on probability settings.
* **Garbage Searching**: Scavenge through a variety of garbage bins scattered around the map to find valuable items or come up empty-handed, adding an element of risk and reward.
* **Customizable Cardboard & Bin Models**: Easily configure the types of bins and cardboard piles players can interact with, providing flexibility to match your server's environment.
* **Progress Bar for Scavenging**: A fully configurable progress bar enhances the scavenging experience, allowing players to see how long it takes to search through a bin.
* **Dynamic Reward System**: Customize the type and amount of cash rewards players can earn from begging, as well as the types of items they can find while searching bins.
* **Cool Down Periods**: Prevent repetitive gameplay by setting cooldown periods for garbage bins, ensuring a balanced and fair experience for all players.
* **Immersive Notifications**: Inform players with detailed and contextually appropriate notifications, whether they are searching a bin, interacting with NPCs, or collecting rewards.

📋 **Requirements**:

* **QBCore Framework**: This script integrates seamlessly with QBCore, making it easy to add to your existing server setup.

🔧 **Setup & Configuration**:

1. **Installation**: Place the script in your server's resources folder and ensure it is started in your server.cfg.
2. **Configuration**: Customize the script to fit your server's needs by adjusting the `config.lua` file. You can define reward probabilities, interaction times, bin models, and much more.
3. **Integrate with QBCore**: Use the provided functions to integrate rewards into your server's economy, ensuring a smooth and immersive player experience.

Whether you're looking to add more depth to your server's roleplay or create new and challenging ways for players to earn rewards, the Begging & Garbage Searching Script is a perfect addition.
