Virtual Quarries

depends on

Image Library

PopUp API

Works with

Server Rewards

Economics

Bank System

About Virtual Quarries

RUST Plugin Test Server
TEST MY PLUGINS THERE!

connect play.thepitereq.ovh:28050

Virtual Quarries plugin is a major upgrade to quarries. You can create and place quarries that extract any type of resource and access them from anywhere on the map. Set up an infinite number of quarry types, apply custom quarry limits with a permission system, grant friends access to resource storage, upgrade your quarry to get more resources, customize survey items and fuel, and much more! You can even customize the static quarries on the map to be instanced, allowing each player to have their own quarry.

Extensive customization and enhancements for quarries.
Place an infinite number of quarries of various types and give access to friends and teammates, including offline players.
Customize the output for each quarry type, allowing them to dig anything from stone and ores to rockets and C4, with full support for skins and display names.
The permission system lets you limit the number of quarries per player, and you can upgrade your quarries for better output, capacity, and fuel efficiency.
The items required to place quarries can be customized based on the quarry's resource output. M
ultiple types of survey charges, each corresponding to different quarry types.
Full data merge through wipes.
Responsive RUST-themed UI.
Customizable fuel types for each quarry.
Custom digging method ensures quarries dig once every 60 seconds by default to improve performance, but this frequency is configurable.
Supports static quarries, pumpjacks, and the giant excavator pit, with instanced inventories for each player and customizable outputs.

virtualquarries.use - Allows you to open /qr menu. (Needs to be enabled in config)
virtualquarries.share - Allows players to give other teammates access to their quarries. (Needs to be enabled in config)
virtualquarries.static.quarry - Gives access to static quarries. (Needs to be enabled in config)
virtualquarries.static.pumpjack - Gives access to static pump jacks. (Needs to be enabled in config)
virtualquarries.static.excavator - Gives access to giant excavator. (Needs to be enabled in config)

/qr - Opens Virtual Quarry Menu. (Configurable)

Economy Plugin Config

0 - None
1 - Economics
2 - ServerRewards
3 - IQEconomic
4 - BankSystem
5 - ShoppyStock

Quarry Limit Extra

You can limit sum of quarries by adding "*" into your permission list, so players can mix quarry profiles until they reach overall limit.
Example:
```
    "virtualquarries.default": {
      "*": 3,
      "pumpjack": 1
    },
```
Based on regular configuration this setup will limit player to have 3 of any type of quarrym but only 1 pumpjack, so he can have 2 quarries and 1 pumpjack or 3 quarries and no pumpjack.

OnQuarryUpgraded(BasePlayer player, int quarryLevel, string quarryProfile) - Called when quarry is successfully upgraded.
OnQuarryRemoved(BasePlayer player, string quarryProfile) - Called when quarry is successfully removed.
OnCustomSurveyThrow(BasePlayer player, string quarryProfile) - Called when custom survey is successfully throwed.
OnQuarryPlaced(BasePlayer player, string quarryProfile) - Called when quarry is succesfully placed.

Example Config
With additional quarry types, more upgrade levels etc. (my private configuration)

VirtualQuarries.json

{
  "Command List": [
    "qr",
    "quarry",
    "quarries",
    "vq",
    "virtualquarry",
    "virtualquarries"
  ],
  "UI Action Cooldown (in seconds, 0 to disable)": 0.0,
  "Enable Console Logs": true,
  "PopUpAPI - Preset Name": "Legacy",
  "Override Custom Skinned Items With Steam Icons (no URLs needed)": false,
  "Additional Steam Image Download": false,
  "Require Permission For Use": false,
  "Lock Access To Quarry Profiles If Lost Permission": false,
  "Mining Quarry/Pump Jack Limit Permissions": {
    "virtualquarries.default": {
      "pumpjack": 1,
      "quarry": 2
    },
    "virtualquarries.vip": {
      "pumpjack": 2,
      "quarry": 3
    }
  },
  "Sharing - Require Permission": false,
  "Sharing - Remove Members If Owner Offline More Than X Days (0, to disable)": 0,
  "Sharing - Share Only To Teammates": false,
  "Data - Enable Data Wipe On Server Wipe": false,
  "Data - Store Container Data In File And Restore On Server Wipe": false,
  "Data - Store Container Interval (in seconds)": 1800,
  "Quarry Tick (how often quarries dig resources, in seconds)": 60,
  "Static Quarry Tick (how often quarries dig resources, in seconds)": 60,
  "Excavator Quarry Tick (how often quarries dig resources, in seconds)": 60,
  "Storage Prefab": "assets/prefabs/deployable/large wood storage/box.wooden.large.prefab",
  "Sound - Start Sound": "assets/prefabs/npc/autoturret/effects/online.prefab",
  "Sound - Stop Sound": "assets/prefabs/npc/autoturret/effects/offline.prefab",
  "Survey Charge - Allow Throwing Survey Charges": false,
  "Survey Charget Types": {
    "survey": {
      "Effect Path": "assets/bundled/prefabs/fx/survey_explosion.prefab",
      "Required Permission (empty, if not required)": "",
      "Chance For Resources (0-100)": 75,
      "Displayed Survey Title Translation Key": "SurveyCharge",
      "Required Item": {
        "Shortname": "surveycharge",
        "Skin": 0,
        "Amount": 1,
        "Display Name": null,
        "Icon URL": ""
      }
    }
  },
  "Upgrades - Used Economy Plugin (0 - None, See Website For More Info)": 0,
  "Upgrades - Economy Currency (If Economy Plugin Is 5 - ShoppyStock)": "rp",
  "Removing Quarries - Refund Items": true,
  "Removing Quarries - Refund Upgrades": false,
  "Go Back Button - Position (1-2)": 1,
  "Upgrade UI - Responsive Position": true,
  "Static Quarries - Enable": false,
  "Static Quarries - Disable Running Effect": false,
  "Excavator Quarry - Enable": false,
  "Excavator Quarry - Lock Air Drops": false,
  "Excavator Quarry - Resource Container Size": 18,
  "Excavator Quarry - Fuel Container Size": 6,
  "Static Quarries - Quarry Requires Permission": false,
  "Static Quarries - Pump Jack Requires Permission": false,
  "Static Quarries - Excavator Requires Permission": false,
  "Static Quarries - Resource Container Size": 18,
  "Static Quarries - Fuel Container Size": 6,
  "Static Quarries - Fuel Item": {
    "Shortname": "lowgradefuel",
    "Skin": 0,
    "Amount": 1.0,
    "Display Name": null,
    "Icon URL": null
  },
  "Excavator Quarry - Fuel Item": {
    "Shortname": "diesel_barrel",
    "Skin": 0,
    "Amount": 1.0,
    "Display Name": null,
    "Icon URL": null
  },
  "Static Quarries - Metal Quarry Output": [
    {
      "Shortname": "stones",
      "Skin": 0,
      "Amount Per Tick": 150.0,
      "Display Name": ""
    },
    {
      "Shortname": "metal.ore",
      "Skin": 0,
      "Amount Per Tick": 22.5,
      "Display Name": ""
    }
  ],
  "Static Quarries - Sulfur Quarry Output": [
    {
      "Shortname": "sulfur.ore",
      "Skin": 0,
      "Amount Per Tick": 22.5,
      "Display Name": ""
    }
  ],
  "Static Quarries - HQM Quarry Output": [
    {
      "Shortname": "hq.metal.ore",
      "Skin": 0,
      "Amount Per Tick": 1.5,
      "Display Name": ""
    }
  ],
  "Static Quarries - Pump Jack Output": [
    {
      "Shortname": "crude.oil",
      "Skin": 0,
      "Amount Per Tick": 6.0,
      "Display Name": ""
    }
  ],
  "Static Quarries - Excavator Outputs": {
    "HQM": [
      {
        "Shortname": "hq.metal.ore",
        "Skin": 0,
        "Amount Per Tick": 50.0,
        "Display Name": ""
      }
    ],
    "Metal": [
      {
        "Shortname": "metal.fragments",
        "Skin": 0,
        "Amount Per Tick": 2500.0,
        "Display Name": ""
      }
    ],
    "Stone": [
      {
        "Shortname": "stones",
        "Skin": 0,
        "Amount Per Tick": 5000.0,
        "Display Name": ""
      }
    ],
    "Sulfur": [
      {
        "Shortname": "sulfur.ore",
        "Skin": 0,
        "Amount Per Tick": 1000.0,
        "Display Name": ""
      }
    ]
  },
  "Quarry Profiles": {
    "pumpjack": {
      "Required Permission (empty, if not required)": "virtualquarries.pumpjack",
      "Displayed Icon": {
        "Shortname": "mining.pumpjack",
        "Skin": 0,
        "Amount": 1,
        "Display Name": null,
        "Icon URL": ""
      },
      "Survey Type": "survey",
      "Displayed Quarry Title Translation Key": "PumpjackTitle",
      "Chance": 5,
      "Minimal Resources Per Node": 1,
      "Maximal Resources Per Node": 2,
      "Fuel Required Per Tick": {
        "Shortname": "lowgradefuel",
        "Skin": 0,
        "Amount": 1.0,
        "Display Name": null,
        "Icon URL": null
      },
      "Enable Upgrades": true,
      "Items Required To Place": [
        {
          "Shortname": "mining.pumpjack",
          "Skin": 0,
          "Amount": 1,
          "Display Name": null,
          "Icon URL": ""
        }
      ],
      "Resources": {
        "crude": {
          "Output Item - Shortname": "crude.oil",
          "Output Item - Skin": 0,
          "Output Item - Display Name": "",
          "Output Item - Icon URL (Required if Skin not 0)": "",
          "Include Always": true,
          "Required Permission (empty if not required)": "",
          "Chance": 0,
          "Minimal Output Per Tick": 0.8,
          "Maximal Output Per Tick": 3.0,
          "Additional Items Required To Place": []
        }
      },
      "Upgrades": [
        {
          "Required Items": [],
          "Required Currency (0 to disable)": 0,
          "Fuel Storage Capacity": 6,
          "Capacity": 6,
          "Gather Multiplier": 1.0,
          "Fuel Usage Multiplier": 1.0,
          "Additional Resources (Resources keys)": []
        },
        {
          "Required Items": [
            {
              "Shortname": "wood",
              "Skin": 0,
              "Amount": 14000,
              "Display Name": null,
              "Icon URL": ""
            },
            {
              "Shortname": "stones",
              "Skin": 0,
              "Amount": 10000,
              "Display Name": null,
              "Icon URL": ""
            }
          ],
          "Required Currency (0 to disable)": 12000,
          "Fuel Storage Capacity": 6,
          "Capacity": 9,
          "Gather Multiplier": 1.2,
          "Fuel Usage Multiplier": 1.0,
          "Additional Resources (Resources keys)": []
        }
      ]
    },
    "quarry": {
      "Required Permission (empty, if not required)": "",
      "Displayed Icon": {
        "Shortname": "mining.quarry",
        "Skin": 0,
        "Amount": 1,
        "Display Name": null,
        "Icon URL": ""
      },
      "Survey Type": "survey",
      "Displayed Quarry Title Translation Key": "QuarryTitle",
      "Chance": 25,
      "Minimal Resources Per Node": 1,
      "Maximal Resources Per Node": 2,
      "Fuel Required Per Tick": {
        "Shortname": "lowgradefuel",
        "Skin": 0,
        "Amount": 1.0,
        "Display Name": null,
        "Icon URL": null
      },
      "Enable Upgrades": true,
      "Items Required To Place": [
        {
          "Shortname": "mining.quarry",
          "Skin": 0,
          "Amount": 1,
          "Display Name": null,
          "Icon URL": ""
        }
      ],
      "Resources": {
        "hq": {
          "Output Item - Shortname": "hq.metal.ore",
          "Output Item - Skin": 0,
          "Output Item - Display Name": "",
          "Output Item - Icon URL (Required if Skin not 0)": "",
          "Include Always": false,
          "Required Permission (empty if not required)": "",
          "Chance": 10,
          "Minimal Output Per Tick": 0.3,
          "Maximal Output Per Tick": 2.0,
          "Additional Items Required To Place": []
        },
        "metal": {
          "Output Item - Shortname": "metal.ore",
          "Output Item - Skin": 0,
          "Output Item - Display Name": "",
          "Output Item - Icon URL (Required if Skin not 0)": "",
          "Include Always": false,
          "Required Permission (empty if not required)": "virtualquarries.metal",
          "Chance": 50,
          "Minimal Output Per Tick": 22.5,
          "Maximal Output Per Tick": 45.0,
          "Additional Items Required To Place": []
        },
        "scrap": {
          "Output Item - Shortname": "scrap",
          "Output Item - Skin": 0,
          "Output Item - Display Name": "",
          "Output Item - Icon URL (Required if Skin not 0)": "",
          "Include Always": false,
          "Required Permission (empty if not required)": "virtualquarries.scrap",
          "Chance": 5,
          "Minimal Output Per Tick": 0.1,
          "Maximal Output Per Tick": 1.0,
          "Additional Items Required To Place": [
            {
              "Shortname": "wood",
              "Skin": 0,
              "Amount": 7000,
              "Display Name": null,
              "Icon URL": ""
            }
          ]
        },
        "stone": {
          "Output Item - Shortname": "stones",
          "Output Item - Skin": 0,
          "Output Item - Display Name": "",
          "Output Item - Icon URL (Required if Skin not 0)": "",
          "Include Always": true,
          "Required Permission (empty if not required)": "",
          "Chance": 0,
          "Minimal Output Per Tick": 150.0,
          "Maximal Output Per Tick": 300.0,
          "Additional Items Required To Place": []
        },
        "sulfur": {
          "Output Item - Shortname": "sulfur.ore",
          "Output Item - Skin": 0,
          "Output Item - Display Name": "",
          "Output Item - Icon URL (Required if Skin not 0)": "",
          "Include Always": false,
          "Required Permission (empty if not required)": "",
          "Chance": 50,
          "Minimal Output Per Tick": 15.0,
          "Maximal Output Per Tick": 30.5,
          "Additional Items Required To Place": []
        }
      },
      "Upgrades": [
        {
          "Required Items": [],
          "Required Currency (0 to disable)": 0,
          "Fuel Storage Capacity": 6,
          "Capacity": 6,
          "Gather Multiplier": 1.0,
          "Fuel Usage Multiplier": 1.0,
          "Additional Resources (Resources keys)": []
        },
        {
          "Required Items": [
            {
              "Shortname": "wood",
              "Skin": 0,
              "Amount": 7000,
              "Display Name": null,
              "Icon URL": ""
            },
            {
              "Shortname": "stones",
              "Skin": 0,
              "Amount": 5000,
              "Display Name": null,
              "Icon URL": ""
            }
          ],
          "Required Currency (0 to disable)": 6000,
          "Fuel Storage Capacity": 6,
          "Capacity": 9,
          "Gather Multiplier": 1.2,
          "Fuel Usage Multiplier": 1.0,
          "Additional Resources (Resources keys)": [
            "scrap"
          ]
        }
      ]
    }
  }
}