Redm Digging

Ground search for RedM and VORP. A player looks at the ground at their feet, chooses "Search the ground" and rubs the dirt away with the mouse to uncover the items the server buried, then clicks each one to pick it up. You choose what the ground gives, where and for whom, in the config files.

Requires vorp_core, vorp_inventory, ox_lib, oxmysql, and ox_target (the RedM fork) or cm-target: the search is a target option. One new item, branch, is added to your items table on the first start.

THE MINI GAME

• Rub the dirt away. Hold the left mouse button to clear the dirt. Not timed. An item glows once it is uncovered, a click picks it up.
• The loot is drawn by the server before the window opens. What the player leaves in the ground stays there: searching the same spot again shows the same items, so closing the window loses nothing and rerolls nothing.
• Uncovered items are shown by their picture from your inventory, by their name, or both. A picture that does not load shows the name.
• A "Ready?" screen to read the instructions, and a pause key.

WHAT YOU CAN SET

Loot. Named loot tables. Each line has an item, a chance, a minimum and maximum quantity, and an optional picture name. A maximum number of different items per search keeps the rarest first. A line can also call an open hook, for example to give a seed from a farming resource. The chances can be shown next to the board, or hidden.

Where. Everywhere on natural ground under open sky, only inside zones, or both. A zone is a sphere, a box or a polygon. It can replace the loot, the jobs, the rest time and the cap, or forbid the search.

Who and how often. Jobs (a list, or a job and a minimum grade), globally, for the search or per zone. Rest time per spot, shared by every player or per player, delay per player, cap per period per character or per zone.

Tool. No tool by default. You can require one (a shovel for example) or wear it only when the player carries it. Durability and loss per search are written in the item metadata, or in the durability column of vorp_inventory when the item has a value there. The most worn tool is used first, it breaks at zero, never at random.

Game and screen. Brush size, size of the items, share to uncover before a click, delay of the empty ground message, picture folder, accent colour, sounds, crouch scenario. The mini game can be replaced by a progress bar.

Staff and logs. Staff by ACE or by VORP group, with a test command and a position command that prints the zones and the loot table where you stand. Finds and broken tools sent to a Discord webhook, each can be turned off.

Languages. English and French included. A missing key in your own translation falls back to English.

GOOD TO KNOW BEFORE YOU INSTALL

The natural ground check (no floor, no roof, no prop) runs on the client, with the game's collision. The server cannot see the ground: it checks the character, the position, the zone, the jobs, the rest time, the cap, the tool and the duration of the game. That is why every spot rests after a search.

Rest times and caps are kept in memory: a restart clears them.

Pictures are read from the inventory resource: cm-inventory or vorp_inventory are found on their own. With another inventory, set the picture folder in the config.

The default seed line gives nothing until a farming resource answers its hook. The hook file explains how to plug one in.

The bush cut mini game is not included: it is a separate resource, cm-foraging. Both can run on the same server.

The Cfx asset escrow only encrypts Lua. The config, the locales, the open hooks and the interface are shipped readable.

INSTALLATION

• Copy the folder into your resources.
• Add ensure cm-digging after vorp_core, vorp_inventory, ox_lib, oxmysql and ox_target or cm-target.
• Start the server once, then restart vorp_inventory so it loads the new item.
• Edit config/config.lua, config/loot.lua and config/zones.lua.

DOCUMENTATION AND SUPPORT

Full documentation: docs.camsurmotion.fr
Questions, bug reports and feature requests: Discord