💰 Gold Pan

VORP RSG TPZ

🛒 Buy on zoo-scripts.com

Gold panning for VORP, RSG and TPZ. The player uses a gold pan standing in a river, lake or creek, crouches, fills the pan with gravel, digs through it and looks into it for a piece of gold.

Install

1. Put the zoo_goldpan folder in resources/[zoo]/.

2. Add this line to server.cfg after your framework (its core and its inventory) and oxmysql:

   ensure zoo_goldpan

3. RSG and TPZ only. zoo_goldpan writes its items into your framework's item file, so server.cfg must allow it (anywhere before the server finishes starting). Add the line for your framework:

   add_filesystem_permission zoo_goldpan write rsg-core

   add_filesystem_permission zoo_goldpan write tpz_inventory

4. Config.Framework in config/config.lua is 'auto': the framework that runs is found by itself. Name it ('vorp', 'rsg' or 'tpz') only if you run more than one.

5. Start the server. On the first start zoo_goldpan adds its two items where your framework keeps items, if they are not there yet: the pan (goldpan) and the piece of gold it gives (gold_nugget on VORP, mediumnugget on RSG, goldnugget on TPZ). The inventory reads its items only when it starts, so restart the server once more. The console says so when it added any.

   Framework	Where the items go
   VORP	the items table
   RSG	rsg-core/shared/items.lua
   TPZ	tpz_inventory/item_registrations.lua, or its items table when UseDatabaseItems is on

6. The picture of the pan: the VORP and TPZ inventories already have a goldpan.png. RSG's has none: copy images/goldpan.png from this folder into rsg-inventory/html/images/.

7. Do not run another gold panning script that uses the item goldpan (tpz_goldpanning, bcc-goldpanning and the like): the item can only belong to one of them.

Panning

Give the player a goldpan. Using it while standing in one of the listed wild waters (shared/shared.lua) puts the pan in their hands.

Control	What it does
R	digs once. Every fill of gravel lasts a number of digs, and a pan dug empty is filled again
Right mouse, held	looks into the pan
Left mouse, inside the look	picks a piece of gold the digs have found
F, or /pan	puts the pan away

The server rolls every piece of luck, so a client cannot give itself gold. A found piece that is left lying in the pan can go out with the gravel. Each fill wears the pan, and a broken pan cannot be used. Every pan is an item of its own, with its own wear. A spot that is panned a lot gives less gold for a while.

Settings

config/config.lua holds them all, each with its own comment:

• the framework and the language
• who may pan: everyone, or only some jobs and ranks
• the pan's item and what a piece of gold gives
• the pan's wear
• the pause between digs
• the chance of gold, and how a spot runs out of it

config/webhook.lua sets a Discord log of every piece of gold picked. It is off out of the box, and only the server reads it.

Languages: English, French, Spanish and German.