RPSync Garbage Collector

RPSync Garbage Collector

Professional garbage collection job system with an immersive 3-step collection process, animations, and vehicle deposit system — built for ESX Legacy servers.

---

✨ Features

Core Gameplay

• 3-Step Collection Process — Arrival → Pickup → Throw, with a real grab-from-ground animation before the carry loop
• Neighbourhood-Clustered Runs — every run stays in one area instead of sending you across the whole map
• Persistent Collection HUD — bag counter, progress bar and step instructions always on screen during a run
• Abandon Run — cancel a run anytime with Backspace
• Completion Bonus — extra payout for finishing a full run
• Carried Objects — visible garbage bag prop on player
• 40+ Collection Points spread across the entire map
• GPS Waypoints — automatic routing to collection points
• Vehicle Deposit System — $400 deposit, returned if truck undamaged
• Automatic Salary — $250 every 10 minutes
• Per-Bag Payment — $25-45 per collected bag
• Uniform System — high-visibility work outfit (illenium-appearance)

Multilingual

• English translation included
• French translation included
• Easily extendable to other languages

Modern UI

• Professional service management menu
• Vehicle garage menu
• RPSync brand theme (blue & yellow accents)
• Smooth animations and transitions
• Status indicators
• Deposit information display

---

📋 Requirements

Before installing make sure your server has:

• FiveM server running
• ESX Legacy framework
• oxmysql installed
• illenium-appearance (uniform system)
• Basic server knowledge

---

📦 Installation

Quick start:

Step 1 — Download

Download the script from your Tebex purchase.

Extract the archive to:

resources/rpsync_garbage

---

Step 2 — Database

Run install.sql against your database.

---

Step 3 — Add to server.cfg

ensure rpsync_garbage

---

Step 4 — Configure

Edit config.lua to match your server.

---

Step 5 — Restart server

Restart the resource:

restart rpsync_garbage

or restart the entire server.

---

⚙️ Configuration

All configuration is located in:

config.lua

---

Language

Config.Locale = 'en' -- or 'fr'

---

Payments

Config.Salary = 250 -- Every 10 minutes
Config.Payment = {
    PerBag = {min = 25, max = 45}
}

---

Deposit

Config.Deposit = {
    Enabled = true,
    Amount = 400,
    DamageThreshold = 50
}

Deposit is taken from cash first, then from the bank account for the remainder — a player is never blocked from taking the truck just because they aren’t carrying enough cash. Refunds go straight to the bank account.

---

Collection Clustering

Config.ClusterCollectionByArea = true

Keeps every run inside a single neighbourhood instead of scattering collection points across the whole map.

---

Abandon Run

Config.CancelRunControl = true

Lets players press Backspace to abandon a run at any time.

---

Completion Bonus

Config.CompletionBonus = true

Pays an extra bonus when a player finishes a full 8-bag run.

---

💰 Earnings

Type	Amount	Frequency
Fixed Salary	$250	Every 10 minutes
Per Bag	$25-45	Per collection

Example: ~$530 per 10 minutes

---

🎯 How It Works

1. Get job (via Job Center or admin)
2. Start service (equip uniform)
3. Get truck ($400 deposit)
4. Start collection run — 8 bags, all in the same neighbourhood
5. 3-step collection process, tracked live on the collection HUD:
   • 🟢 Arrive & confirm
   • 🟠 Pick up bag (real pickup animation)
   • 🔵 Throw in truck
6. Finish the run for a completion bonus (or press Backspace anytime to abandon)
7. Return truck (get deposit back)
8. End service

---

📍 Collection Points

40+ locations including:

• Grove Street, Davis, Strawberry
• La Mesa, Mirror Park, East Vinewood
• Downtown, Vespucci, Del Perro
• Rockford Hills, Sandy Shores, Paleto Bay

---

🧑‍💻 Player Usage

Players must:

1. Get the job via Job Center or an admin
2. Start service and equip the uniform
3. Take a truck (pay the deposit)
4. Complete collection runs — arrive, pick up, throw, repeat
5. Return the truck to recover the deposit
6. End service

---

🔒 Escrow

Protected: client/, server/, html/ Accessible: config.lua, locales/, install.sql, README.md

---

🐛 Troubleshooting

Menu does not open

Check:

• Resource started
• ESX loaded
• Player has the garbage collector job
• No F8 errors

Deposit not returned

Check:

• Config.Deposit.Enabled is true
• Truck damage is below Config.Deposit.DamageThreshold
• Truck was properly returned, not abandoned

Black rectangle behind menu/HUD

Update to the latest version — this was a known NUI transparency issue, fixed in 1.1.2.

---

📊 Changelog

1.1.3

• Vehicle deposit is now taken from cash first, then the bank account for the remainder — a player is no longer blocked from taking the truck just because they aren’t carrying enough cash
• Deposit refunds now go straight to the bank account

1.1.2

• Fixed a hard black rectangle showing behind every menu and the collection HUD (missing NUI transparency on <html>, plus an unreliable backdrop-filter blur)

1.1.1

• Fixed a bug where the service menu could open automatically on join instead of only at the Collection Center

1.1.0

• New animations: a real one-shot pickup (bend down & grab) before the carry loop, corrected throw animation
• Collection runs are now clustered by neighbourhood instead of scattered across the whole map (Config.ClusterCollectionByArea)
• Added a persistent collection HUD (bag counter, progress bar, step instructions)
• Added the ability to abandon a run with Backspace (Config.CancelRunControl)
• Added a completion bonus for finishing a full run (Config.CompletionBonus)
• Full visual redesign on the official RPSync brand theme (blue & yellow accents, Unbounded/Plus Jakarta Sans)
• Blip now shows live progress (“Collection 3/8 - Grove Street”)

1.0.0

• Initial release

---

📞 Support

Before requesting support:

1. Check documentation
2. Check F8 console
3. Restart resource

Support channels:

• Discord
• Tebex Store

---

📜 License

RPSync License

Allowed:

• Use on your server
• Modify configuration
• Modify translations

Not allowed:

• Resell
• Redistribute
• Remove escrow protection