dFxPhoeniX
Adds zones, permissions, and other options to modify gather rates!

Supported Games
GameServerKingsGameServerKings
works with

Overview

UGather adds a flexible, permission-based gathering system that allows you to control harvest rates for different resource types and areas.

Zone Gathering

Zone gathering works using ZoneManager and some basic logic. When you create a zone using the chat commands, the zone mimics one of the permissions in the config and it will use that as a base for the gather rates. Zones have plenty of options for the ultimate customization needed.

Zone Customization

Here are some of the variables you are able to edit when you create a zone using this plugin.

  • Position - Pretty self explanatory, this is the position where the zone will be on the map
  • Radius - This is how big the zone is, I assume this is in meters. Look at ZoneManager if you want more info about these.
  • Enter Message - This is the message a player will receive upon entering the zone, if it requires permission then you must have permission to see the message.
  • Leave Message - The message a player receives upon leaving the zone, same permission applies as above.
  • Require Permission - If the player needs the permission the zone is set up to use to access the gather rates of the zone.
  • Overtake Priority - If this is set to true, the zone will demand full priority and will override all other gather rates.
  • Restrict Permission - If this is set to true, the permission will be disabled for everyone except if they are within the zone (and have permission if that is enabled)
  • Permission - This is not editable after the zone is created, but this is the permission it uses to get gather rates from the configuration.

Permissions

The permissions are created in the configuration file and offer a variety of gather modifications. If any sort of gathering was missed, it will be automatically added to the config with a multiply factor of 1 so you can edit it at a later point. Currently the oil refinery is not included in this.

  • ugather.admin - The permission that allows for any chat commands to be used.

Configuration

Note, default config contains more then this. But I used a shortened version for the sake of looks.

{
  "Gather Perms : The list of permissions that grant specified gather rates.": {
    "ugather.basic": {
      "Barrels": {
        "crude.oil": 2.0,
        "fuse": 2.0,
        "gears": 2.0,
        "lowgradefuel": 2.0,
        "metalblade": 2.0,
        "metalpipe": 2.0,
        "metalspring": 2.0,
        "propanetank": 2.0,
        "roadsigns": 2.0,
        "rope": 2.0,
        "scrap": 2.0,
        "semibody": 2.0,
        "sewingkit": 2.0,
        "sheetmetal": 2.0,
        "tarp": 2.0
      },
      "Bonus": {
        "hq.metal.ore": 2.0,
        "metal.ore": 2.0,
        "stones": 2.0,
        "sulfur.ore": 2.0,
        "wood": 2.0
      },
      "Dispenser": {
        "bearmeat": 2.0,
        "bigcatmeat": 2.0,
        "bone.fragments": 2.0,
        "charcoal": 2.0,
        "chicken.raw": 2.0,
        "cloth": 2.0,
        "crocodilemeat": 2.0,
        "deermeat.raw": 2.0,
        "fat.animal": 2.0,
        "horsemeat.raw": 2.0,
        "hq.metal.ore": 2.0,
        "humanmeat.raw": 2.0,
        "leather": 2.0,
        "meat.boar": 2.0,
        "metal.fragments": 2.0,
        "metal.ore": 2.0,
        "metal.refined": 2.0,
        "metalpipe": 2.0,
        "roadsigns": 2.0,
        "skull.wolf": 2.0,
        "snakemeat": 2.0,
        "stones": 2.0,
        "sulfur.ore": 2.0,
        "wolfmeat.raw": 2.0,
        "wood": 2.0
      },
      "Excavator": {
        "hq.metal.ore": 2.0,
        "metal.ore": 2.0,
        "stones": 2.0,
        "sulfur.ore": 2.0
      },
      "Pickups": {
        "black.berry": 2.0,
        "blue.berry": 2.0,
        "blueberries": 2.0,
        "cloth": 2.0,
        "coconut": 2.0,
        "corn": 2.0,
        "fish.raw": 2.0,
        "green.berry": 2.0,
        "metal.ore": 2.0,
        "mushroom": 2.0,
        "potato": 2.0,
        "pumpkin": 2.0,
        "red.berry": 2.0,
        "seed.black.berry": 2.0,
        "seed.blue.berry": 2.0,
        "seed.corn": 2.0,
        "seed.green.berry": 2.0,
        "seed.hemp": 2.0,
        "seed.potato": 2.0,
        "seed.pumpkin": 2.0,
        "seed.red.berry": 2.0,
        "seed.wheat": 2.0,
        "seed.white.berry": 2.0,
        "seed.yellow.berry": 2.0,
        "stones": 2.0,
        "sulfur.ore": 2.0,
        "wheat": 2.0,
        "white.berry": 2.0,
        "wood": 2.0,
        "yellow.berry": 2.0
      },
      "Quarry": {
        "hq.metal.ore": 2.0,
        "metal.ore": 2.0,
        "stones": 2.0,
        "sulfur.ore": 2.0
      },
      "Survey": {
        "hq.metal.ore": 2.0,
        "metal.ore": 2.0,
        "stones": 2.0,
        "sulfur.ore": 2.0
      }
    }
  },
  "Base Permission : The basic permission given to group default.": "ugather.basic",
  "Default Group : The group all players should be in, these players get the base perm.": "default",
  "Stackable Permissions : If a user has multiple perms, should they stack gather rate.": false
}

Chat Commands

  • /ugather zone - Shows the commands for the zone portion ingame.
  • /ugather rate - Shows the commands for the permission handling ingame.

Languages

UGather have two languages by default (English and Romanian), but you can add more in Oxide lang folder.

Credits

  • DylanSMR, for the original version of this plugin
  • dFxPhoeniX, current maintainer
This plugin is unlicensed and the original author reserves all rights to it.

The original author may request that this plugin be removed and there is a risk that the plugin may be unavailable in the future.

Note that the current maintainer may not have permission to assign a license to the plugin if they are not the original author, so explicit permission would need to be obtained from the original author in order for the plugin to remain openly available and guarantee that it will be around for all to enjoy going forward.