Poggy's Supply Drops

Overview#

Poggy's Supply Drops adds two kinds of world event to your RedM server. Both start by themselves on a schedule you control, and admins can start one at any time with a command.

• Supply drops. A crate floats down under a hot air balloon at a random place on the map. Every player is told where. The first player to reach the crate and hold G takes the goods.
• Scavenger hunts. A treasure is hidden somewhere in the world. Players type /clue to see a photo of the hiding place and the reward. A riddle is hidden behind a button: revealing it helps, but costs part of the reward.

Features

• Balloon drops that come down, release the crate and fade away.
• 10 drop locations and 30 scavenger hunts ready to use, each hunt with its own photo and riddle.
• Weighted loot for drops, including weapons.
• Cash, gold or item rewards for hunts.
• Map blips, notifications, and five colour themes for the hunt window.
• Separate Discord webhooks for drops and for hunts.
• Every setting, location, loot entry and hunt can be edited in game in /poggy.
• English, Spanish and French messages included.
• No database tables.

Requirements#

No database is used and nothing needs importing.

Installation#

1. Download the script from your Cfx.re portal (Granted Assets) and unzip it.
2. Put the poggy_supplydrops folder in your server's resources folder.
3. Make sure poggy_core is installed and started.
4. Add the script to server.cfg, after poggy_core:

   ensure poggy_core
   ensure poggy_supplydrops

5. Check the items. The default drop loot uses common VORP item names (coal, apple, iron, wood, beef, milk and so on) and four weapons. The default hunt rewards include the item golden_nugget. Remove or rename any entry whose item your server does not have.
6. Restart the server.

Configuration#

The easiest way to change settings is in game: type /poggy and open Supply Drops & Scavenger Hunts. Settings are split into tabs (General, Supply drops, Scavenger hunts, Timing & schedule, Notifications & Discord, Text & language, Advanced), and the hub has help pages for the schedule, adding drop locations and loot, and adding hunts. You can also edit config.lua and translations.lua by hand. Restart the script after a change.

General

Timing and schedule

Drops and hunts each run on their own timer. After an event starts (by itself or by command), a cooldown begins: the cooldown time plus a random extra. When it ends, the script waits a random time between the shortest and longest wait, then starts the next event.

With the defaults a new supply drop comes about every 70 to 135 minutes, and a new hunt about every 110 to 210 minutes. For more drops, lower the cooldown and the longest wait. If a longest wait is not above its shortest, one minute more than the shortest is used.

Supply drops

Drop locations

Ten locations ship, including Saint Denis Docks, Rhodes, Blackwater Docks, Riggs, Wallace, Annesburg, Bacchus, Armadillo and Emerald train stations, and the Oil Fields. Each drop picks one at random. To add one in game:

1. Stand on an open spot with clear sky above it (the balloon comes down from 40 m).
2. Open /poggy → Supply Drops & Scavenger Hunts → Supply drops, and in Drop locations press Add location.
3. Give it a Name (players read it in the notification), press use my position, then save and restart the script.

Drop loot

Each drop picks one loot entry. Every entry has an Item, a Label players see, an Amount (min, max), a Weight and a Crate prop (the object players see, such as p_crateapple01b).

• Weight is not a percent. An entry with 20 is twice as likely as one with 10. An entry's chance is its weight divided by the total of all weights. Use whole numbers.
• Weapons: use a weapon name that starts with WEAPON_, such as WEAPON_REVOLVER_CATTLEMAN. The player gets one weapon; the amount is ignored.
• The default list has 22 items (food, meat, wood, ores and more) and four rare weapons at weight 1.

Scavenger hunts

Hunt rewards

Each hunt picks one reward by weight. The defaults are cash between $16 and $80 (weight 50) and 10 to 30 golden_nugget items (weight 10).

Adding a scavenger hunt

1. Take a screenshot of the hiding place, save it as a .jpg with a short name such as oldmill.jpg, and copy it into the script's ui/images folder. Only .jpg files are sent to players.
2. Stand exactly where the treasure should be.
3. Open /poggy → Supply Drops & Scavenger Hunts → Scavenger hunts, and in Hunt locations press Add hunt.
4. Press use my position, set Photo to the file name and write the Clue (the riddle). Title and Treasure prop (p_moneybag02x) can stay as they are.
5. Save and restart the script. The restart also sends the new photo to players.

Notifications and Discord

Text and language

Config.Language (in translations.lua, default "en") picks the language: en, es or fr. Lines a language does not have fall back to English. Every message can be edited on the Text & language tab. Keep words in braces such as {item} and {location}: the script fills them in. To add a language, copy the en block in translations.lua.

Advanced

• Balloon chance (AirdropChance, 100): only used if you delete the UseAirdrops line from config.lua. Then each drop has this percent chance to come by balloon.
• Basket (UseBasket): not used by the script at the moment.
• Collect notification style (SuccessNotificationColor, SuccessNotificationDict, SuccessNotificationIcon): the colour and icon of the "you collected" notification.

Commands#

Keys: hold G at a crate or treasure to collect it.

Permissions#

There is no permission setting in this script. /supplydrop, /scavengerhunt and /nextdrop detailed are for admins, and poggy_core decides who is an admin from your framework's admin groups. The server console can always use them. Everything else is open to every player.

Using it in game#

Supply drops

1. A drop starts at a random location. Every player online gets a notification naming the place and the goods, and a blip on the map.
2. Players near the spot see the balloon come down. Players far away find the crate already on the ground when they arrive.
3. The first player to reach the crate and hold G collects it. If their inventory is full, they are told so and the crate stays for someone else.
4. A drop nobody collects disappears after 15 minutes (by default).

Scavenger hunts

1. A hunt starts at one of the hunt locations. Every player gets a notification and a map blip.
2. Players type /clue to see a photo of the hiding place and the reward. The riddle is blurred. Clicking the photo opens it large, with a magnifier. Esc closes the window.
3. Pressing SHOW CLUE reveals the riddle and lowers the reward (by 30% by default). The window shows the new amount.
4. The first player to reach the treasure and hold G claims it, and the hunt ends for everyone.
5. A hunt nobody claims disappears after 45 minutes (by default).

Anyone can type /nextdrop to see how long until the next events may start.

Troubleshooting#

No drops or hunts ever start.

Check Automatic events on the Timing & schedule tab and the two feature switches on the General tab. Events only start after the first player has loaded in, and the first one comes after the shortest-to-longest wait (10 to 45 minutes for drops, 20 to 60 for hunts by default). Use /nextdrop to see the timers, or /supplydrop to test at once.

A drop cannot be collected: the prompt keeps coming back.

The item probably does not exist on your server, or the player's inventory is full. Every loot item must be a real item in your framework.

A hunt says "Error processing reward".

The reward could not be given, usually because the reward item (by default golden_nugget) does not exist on your server. The hunt stays open. Add the item to your server or remove that reward.

The hunt photo is a broken image.

The file is missing from ui/images, is not a .jpg, or the Photo name does not match the file. Restart the script after adding a photo.

Some scavenger hunts never start.

Check the money amounts in the hunt rewards. Use whole dollars or halves (16 or 16.5); some cent values cannot be rolled.

Gold rewards fail on RSG Core.

RSG Core only pays gold in whole amounts, while hunt money rewards are rolled to the cent and the clue penalty can leave a fraction. On RSG, use cash rewards, or give gold as an item reward instead.

The crate is invisible.

The Crate prop name is wrong. Use a valid RedM object model, such as mp001_p_mp_crateweapon_01a.

A player who joined late cannot see the current drop or hunt.

Events are announced to the players online when they start. Someone who joins afterwards does not get that event and will catch the next one.

Nothing reaches Discord.

Turn on Post to Discord for that event and paste a real webhook URL in place of the placeholder. Then run testdiscord supply or testdiscord scavenger in the server console and look in the channel.

Updating#

poggy_core's updater installs new versions for you and keeps your settings, locations, loot, hunts and translations. See Updates in the poggy_core documentation.

If you ever replace the folder by hand instead, first keep a copy of config.lua, translations.lua and any hunt photos you added to ui/images.