Garbage System (Garbage Truck, Dumpsters, Income & Custom Models)

As a garbage collector your job is to collect and empty garbage dumpsters and garbage bins. Retrieve a garbage truck from the NPC and drive around the town. You are prompted via notifications and displays on your HUD when dumpsters and bins are empty. You earn a passive paycheck with the job, but emptying dumpster and bins earn you an additional bonus based on the server configuration.

Any other job can also earn money by collecting trash. This can be any entity that is configured as a trash entity by the server owner. It can also be the trash entities that comes with the addon.

Trash entities are spawned with random spawn locations around the map. You can throw the trash directly into the dumpsters or bins to earn cash, but you can also collect and store more trash in trash bags. Trash bags comes in various sizes (small, medium and large) and then you throw those into the dumpster or bins to collect a larger amount of money at a time.

Features

👨‍🏭 Garbage Collector Job

• A garbage collector job is automatically added to the F4 menu.
• As a garbage collector you must collect trash dumpsters and bins.
• You can equip a garbage truck from the NPC.
• Use the garbage truck to empty dumpsters and bins.
• Earn bonuses by emptying dumpsters and bins.

🥡 Trash Bags

• Trash bags comes in three sizes; small, medium and large.
• They have a different max worth size based on your configuration.
• Each trash bag can hold different "size" trash. You can configure which entities each trash bag accepts.
• Trash has it's own worth. You can configure minimum and maximum worth for each trash entity in the config.
• There is also a trash bag weapon that you can buy and equip from the F4 menu. Allows for easier picking up trash as you go around town.

🗑️ Dumpsters & Bins

• Dumpsters and bins are setup by the server owner as static entities on the map.
• Empty trash bags in the dumpsters and bins to receive their worth.
• Throw single trash items in them to receive the worth of the item/entity.
• Dumpsters and bins have custom animations and effects.

🚚 Garbage Truck

• Retrieve a garbage truck from the NPC on the map.
• Use the truck as a garbage collector to drive around town to empty dumpsters and bins.
• Garbage truck has a custom model by SligWolf and can be changed to any vehicle in the config.

💲 Income

• As any job you can earn money by emptying trash bags in the dumpster and bins.
• You can also throw single trash entities into them to earn their worth.
• As a garbage collector you receive a pre-configured percentage of the dumpster and bins worth for emptying them.

🚯 Trash Spawners

• Trash spawners generate random trash entities.
• The generated trash can be thrown into dumpster, bins and trash bags.
• Trash spawners execute a drop after a configured amount of time.
• You can randomize the chance for each spawner to trigger giving it x% chance to drop trash.
• Trash spawners will not drop if there's already a trash entity nearby to keep entity spam low.

💾 Saving System

• Setup unlimited trash spawn locations.
• Map based saving system.
• Simple in-game admin menu to save entities.
• Console commands to setup NPC's.

👜 Inventory Support

• Supports Xenin Inventory
• Supports ItemStore Inventory
• Trash bags and trash entities save worth.
• Trash worth is shown in description inside the inventory.

🎨 Theme Support

• Supports themes for user interface.
• Gray (default).
• GMS Blue.

💻 bLogs Support

• Trashing an item.
• Emptying trash dumpsters and bins.

💯 Level System Support

• Support for Sublime Levels
• Support for Vrondakis Level System
• Support for Elite XP System (EXP2)
• Support for DarkRP Essentials or Brick's Essentials
• Support for GlorifiedLeveling

🌎 Language System

• English
• French
• Danish
• Spanish
• Russian
• German

✨ Supported Addons

• By default the addon is configured to support multiple addons from gmodstore.
• You can easily add any entity you wish in the config.
• Support for Bitminers entities.
• Support for The Cocaine Factory entities.
• Support for VCMod entities (not lights).

Discord Server

I own a Discord server for customers and anyone else who wish to join. I will occasionally provide exclusive offers and help with minor issues that might occur with my scripts. If you have a more serious problem, please create a support ticket on GModStore.

This addon supports DarkRP 2.7.0+

Extract ch_garbage_system to your addons folder.

CONTENT

There's a single content pack that you must add to your servers workshop collection.

Garbage System Workshop

JOBS

A garbage collector job is automatically added to your DarkRP. You can setup more as you wish and define them in the configuration file.

SETUP NPC & TRUCK SPAWNS

You have to setup positions for the NPC and the garbage truck spawn locations. This is done via in-game console commands.

Garbage Truck NPC command: ch_garbage_settrucknpcspawn

You can only setup one garbage truck npc, but the npc can have multiple garbage truck spawn positions.

Add new tow truck spawn command: ch_garbage_addtruckspawnpos

Clear all tow truck spawn command: ch_garbage_clearalltruckspawns

All positions are instantly in effect.

TRASH DUMPSTER & BINS

To setup trash dumpsters and trash bins you find the entities in the Q menu and then use the in-game admin menu to save them.

To find the entities go to Q Menu -> Entities -> Garbage System by Crap-Head

The default chat command to open the admin menu is !garbageadmin

TRASH SPAWNERS

You can setup trash spawners from the admin menu in-game.

The default chat command to open the admin menu is !garbageadmin

Click on the buttons to add / remove trash spawners and give them a unique name.

You can also manually delete trash spawners in data/craphead_scripts/ch_garbage_system/mapname/trash_spawns/...

OPTIONAL

You can also use the following console commands to perform the setup.

• ch_garbage_savetrashdumpsters <- Saves all trash dumpster entities in their current positions.
• ch_garbage_cleartrashdumpsters <- Saves all trash dumpster entities in their current positions.
• ch_garbage_savetrashbins <- Saves all trash dumpster entities in their current positions.
• ch_garbage_cleartrashbins <- Saves all trash dumpster entities in their current positions.
• ch_garbage_addtrashspawn <name> <- Adds a trash spawner at your current position with a unique name.
• ch_garbage_removetrashspawn <name> <- Remove the trash spawner with the unique name specified.

To customize the general settings go to ch_garbage_system/lua/ch_garbage_system/shared/ch_garbage_config.lua

To modify and add trash entities go to ch_garbage_system/lua/ch_garbage_system/shared/ch_garbage_trash_config.lua

To modify and add themes go to ch_garbage_system/lua/ch_garbage_system/shared/ch_garbage_themes_config.lua

To modify the default garbage collector job go to ch_garbage_system/lua/ch_garbage_system/shared/ch_garbage_darkrpadds.lua

General Config

--[[
     SET LANGUAGE & THEME
--]]
-- Available languages: English: en - French: fr - Danish: da - Russian: ru - Spanish: es
-- Available themes: Gray, GMSBlue
CH_GarbageSystem.Config.Language = "en" -- Select the language for the addon.

CH_GarbageSystem.Config.Theme = "Gray" -- Set the theme of the script.

--[[
     General Config
--]]
CH_GarbageSystem.Config.NotificationTime = 7 -- How many seconds a DarkRP notification appears on the screen for players

CH_GarbageSystem.Config.DistanceTo3D2D = 500000

CH_GarbageSystem.Config.GarbageAdminChatCommand = "!garbageadmin" -- Chat commnad to open the admin menu.

--[[
     Garbage Collector
--]]
CH_GarbageSystem.Config.GarbageCollectorTeams = { -- The DarkRP team name that defines garbage collector jobs. Here we use the team we create in ch_garbage_darkrpadds.lua
     ["Garbage Collector"] = true,
     ["Garbage Supervisor"] = true,
}

CH_GarbageSystem.Config.EmptyGarbagePercentage = 50 -- Trash dumpsters and trash bins has a worth displayed. The garbage collector gets x percent of that worth when emptying them.

--[[
     Garbage Truck
--]]
CH_GarbageSystem.Config.GarbageTruckNPCModel = "models/odessa.mdl" -- Model of the garbage truck NPC.

CH_GarbageSystem.Config.GarbageTruckName = "Mercedes Truck" -- The name of the garbage truck vehicle as shown in the menu.
CH_GarbageSystem.Config.GarbageTruckModel = "models/sligwolf/garbagetruck/sw_truck.mdl" -- Model of the garbage truck itself.
CH_GarbageSystem.Config.GarbageTruckVehicleScript = "scripts/vehicles/sligwolf/sw_truck.txt" -- Vehicle script for the garbage truck.
CH_GarbageSystem.Config.GarbageTruckSkin = 1 -- Skin of the garbage truck.
CH_GarbageSystem.Config.GarbageTruckColor = Color( 70, 70, 70, 255 ) -- Color of the garbage truck.
CH_GarbageSystem.Config.GarbageTruckHealth = 300 -- Health of the garbage truck.

CH_GarbageSystem.Config.EmptyGarbageButton = IN_ZOOM -- The button you use from inside the truck to empty trash containers (Default = ZOOM (H)). Here is a full list: https://wiki.facepunch.com/gmod/Enums/IN
CH_GarbageSystem.Config.PickupRadiusSize = 250 -- Area size the garbage truck "searches" in when trying to empty trash.

--[[
     Trash Max Worth
--]]

CH_GarbageSystem.Config.TrashEntityMaxWorth = { -- How much can each entity add up in total value before being full.
     ["ch_garbage_small_trashbag"] = 500,
     ["ch_garbage_medium_trashbag"] = 1250,
     ["ch_garbage_large_trashbag"] = 2500,
     ["ch_garbage_trash_bin"] = 5000,
     ["ch_garbage_trash_dumpster"] = 10000,
}

--[[
     Random Generated Trash
--]]

CH_GarbageSystem.Config.GeneratedTrashModels = { -- Randomized model for the generated trash. You can add any model you'd like.
     "models/props_junk/metal_paintcan001a.mdl",
     "models/props_junk/plasticbucket001a.mdl",
     "models/Gibs/wood_gib01d.mdl",
     "models/props_c17/computer01_keyboard.mdl",
     "models/props_c17/tools_wrench01a.mdl",
     "models/props_junk/PopCan01a.mdl" -- NO COMMA ON LAST LINE!
}

CH_GarbageSystem.Config.GeneratedTrashSpawnInterval = 10 -- How many seconds between triggering each spawner?
CH_GarbageSystem.Config.ChanceOfSpawning = 100 -- Percentage chance for EACH trash spawner?
CH_GarbageSystem.Config.TrashNearbyBlockDistance = 5000 -- If another trash entity is found within this distance then we BLOCK the trash spawning.

--[[
     Entities Health
--]]

CH_GarbageSystem.Config.EntitiesHealth = { -- Set health for trash bags, trash bins and dumpsters.
     ["ch_garbage_trash"] = 50,
     ["ch_garbage_small_trashbag"] = 75,
     ["ch_garbage_medium_trashbag"] = 100,
     ["ch_garbage_large_trashbag"] = 150,
     ["ch_garbage_trash_bin"] = 250,
     ["ch_garbage_trash_dumpster"] = 500,
}

--[[
     3RD PARTY ADDON SUPPORT
--]]
-- XP SUPPORT
CH_GarbageSystem.Config.DarkRPLevelSystemEnabled = false -- DARKRP LEVEL SYSTEM BY vrondakis https://github.com/uen/Leveling-System
CH_GarbageSystem.Config.SublimeLevelSystemEnabled = false -- Sublime Levels by HIGH ELO CODERS https://www.gmodstore.com/market/view/ZulBh6wzRg2udB-bskk59w
CH_GarbageSystem.Config.EssentialsXPSystemEnabled = false -- Brick's Essentials and/or DarkRP Essentials by Brickwall https://www.gmodstore.com/market/view/8vAdDl46QUmo9upPDM02kA & https://www.gmodstore.com/market/view/MNKuVyfcQjykUYkLV63Fmg
CH_GarbageSystem.Config.EXP2SystemEnabled = false -- Elite XP SYstem (EXP2) By Axspeo https://www.gmodstore.com/market/view/uInsVHfPQ-q3apZhBLEX3A
CH_GarbageSystem.Config.GlorifiedLevelingXPSystem = false -- GlorifiedLeveling by GlorifiedPig https://www.gmodstore.com/market/view/ZI2Ev9tOQT2avLrCXQxGWA

CH_GarbageSystem.Config.TrashIntoDumpsterOrBinXP = 50 -- Amount of XP given when throwing trash / trash bags into a dumpster or bin.
CH_GarbageSystem.Config.EmptyTrashContainerXP = 50 -- Amount of XP given when emptying dumpster or bin as garbage collector.

Trash Example

CH_GarbageSystem.Trash[ "entity_name" ] = { -- The name of the entity goes here. You can find entities in addonname/lua/entities or by right-clicking the entity in the Q menu.
    Sizes = { -- What sizes do we allow this entity to be thrown into? Do not add other sizes, use the variables true/false for each of the existing ones.
        ["Small"] = true, -- Can this entity be thrown into a small sized trash bag?
        ["Medium"] = true, -- Can this entity be thrown into a medium sized trash bag?
        ["Large"] = true, -- Can this entity be thrown into a large sized trash bag?
        ["Bin"] = true, -- Can this entity be thrown into a trash bin?
        ["Dumpster"] = true, -- Can this entity be thrown into a trash dumpster?
    },
    Worth = { 20, 50 }, -- The Worth defines minimum and maximum value. When you trash this entity, the worth is randomized between these two numbers.
}

If you find any problems with the script, please create a support ticket with details of the situation and a copypaste of the error in console. I am also not interested in modifying you a custom version of the addon. Also not upon payment. Sorry!

Conflicting addons is not to be said if I will support that or not. This is something I will decide upon confrontation about a conflicting addon. If you have some sort of proof that an addon is conflicting with my addon, please send me a PM with the details you might have.

Thank you!

Custom models, materials and animations by NvC_DmN_CH

Garbage Truck by SligWolf (Original garbage truck content available on the workshop HERE)

Banners made by Miskie

Icons made by Freepik from Flaticon

Font is Poetsen One

Translations by Tekiad, nocturni, Wolflix, Levanchik & Miya

If you like this script, you should check out some of my other addons for DarkRP. Just click the banner to open the script page in a new tab.