About Custom Gather
Custom Gather allows you to have dynamic gather rates on your server!
This allows you to assign different gather rates for as many groups of players as you would like.
What this plugin offers that other gather rate plugins don't:
-
Create custom gather rates based on oxide permission groups
- Example: Have a global 2x gather rate, but have VIPs gather at 4x, and Elite VIPs gather at 8x.
- Modify resources in Unloadable Train Wagons
- Set separate custom rates for Public and Private quarries
- Modify Fishing Rate
- Gather rate modifier includes grubs/worms picked from plants
Configuring JSON Files
This plugin creates two JSON files, one is located in Oxide/Config/CustomGather.json, and the other is in Oxide/Data/CustomGather.json.
- The config file is used to set the global on/off switches, unloadable train wagon settings, the blacklists and the global override list.
-
The data file is used to create and specify custom groups to be assigned via oxide permissions.
- The 'default' group makes a permission named customgather.default and automatically assigns it to the default oxide group
- All other groups generate permissions titled customgather.{groupname} that then must be assigned to an oxide group or player.
- Do NOT delete the data json file during server wipe. It will reset all your custom group settings and need to be reconfigured.
Tutorial
Blacklists & Global Override List
The Blacklists reverts an item's gather rate to 1x for the specified method of gathering that it is listed under. The Global Override List is similar, but you specify a custom gather rate for specific items that is then applied globally, regardless of permission groups or gather method.
Items need to be entered in with their short names. Use this reference to find any item's short name. Insert items by their short names inside quotations and separated by commas.
Chat Commands
- /cg info -- Displays each custom group and their gather rates
Config JSON - Example
{ "Global On/Off Switches. Only set these to false if you use a separate plugin to control specific gather rates.": { "Modify rates for items picked off the terrain (ex: plants, tree stumps, small ore nodes)": true, "Modify rates for items grown in planters": true, "Modify rates for fishing": true, "Modify rates for PUBLIC Quarries and Pumpjacks": true, "Modify rates for PRIVATE Quarries and Pumpjacks": true, "Modify rates for the Giant Excavator": true, "Modify rates for Dispensers (ex: ore nodes, trees, animal corpses)": true, "Modify rates for Resource Train Wagons": true }, "Unloadable Train Wagon Settings": { "Multiplication Rate": 20, "Single Stack of Resources?": true }, "Blacklists (items to gather at vanilla rates)": { "Harvested Items": [ "human.skull", "skull.wolf" ], "Pickup Items": [ "cloth" ], "Planter Box Items": [ "clone.hemp" ], "Fishing": [ "fish.anchovy" ], "Quarries & Pumpjacks": [ "stones" ], "Excavator": [ "stones" ], "Train Resource Wagons": [ "metal.ore" ] }, "Global Override List": { "pumpkin": 20, "hq.metal.ore": 10 } }
Data JSON - Example
{ "Custom Permission Group Settings": { "default": { "Gather Rate": 1, "PUBLIC Quarries & Pumpjacks Rate": 1, "PRIVATE Quarries & Pumpjacks Rate": 1, "Giant Excavator Rate": 1, "Fishing Rate": 1 }, "vip": { "Gather Rate": 2, "PUBLIC Quarries & Pumpjacks Rate": 2, "PRIVATE Quarries & Pumpjacks Rate": 2, "Giant Excavator Rate": 2, "Fishing Rate": 2 }, "Elite": { "Gather Rate": 3, "PUBLIC Quarries & Pumpjacks Rate": 3, "PRIVATE Quarries & Pumpjacks Rate": 3, "Giant Excavator Rate": 3, "Fishing Rate": 3 }, "SuperElite": { "Gather Rate": 4, "PUBLIC Quarries & Pumpjacks Rate": 4, "PRIVATE Quarries & Pumpjacks Rate": 4, "Giant Excavator Rate": 4, "Fishing Rate": 4 }, "MegaElite": { "Gather Rate": 5, "PUBLIC Quarries & Pumpjacks Rate": 5, "PRIVATE Quarries & Pumpjacks Rate": 5, "Giant Excavator Rate": 5, "Fishing Rate": 5 } } }