Poggy Storage

Overview#

Poggy Storage lets players buy a storage at the spot where they stand, keep their gear in it, and decide who else may open it. Storages survive restarts. A storage can be shared with named characters or with a whole job, and each one has its own money balance and ledger.

You can also set up storages that belong to a job (police evidence, a doctor's cabinet), and armories: job-locked shops with endless stock. Admins manage every storage from one table in /poggy.

• Player-owned storages, with paid capacity upgrades that cost a little more each time.
• Keys for named characters at three levels (Manager, Member, Basic), or for a whole job by grade.
• A money balance and a ledger in every storage.
• Map blips for the storages a player can open.
• Job storages, clerk NPCs and job-locked armories, set in the config or in /poggy.
• Optional Discord logging for job storages and armories.
• A Storages panel in /poggy to rename, resize, move, re-own or delete any storage, manage its keys and see what is inside.
• English, Spanish and German text.

Requirements#

No menu, input or inventory add-on is needed: every menu, prompt, container and shop is drawn by poggy_core.

Installation#

1. Download Poggy Storage and put the poggy_character_storage folder in your resources folder.
2. Add it to server.cfg, after poggy_core and oxmysql:

   ensure oxmysql
   ensure poggy_core
   ensure poggy_character_storage

3. Give your admins the permission (see Permissions).
4. Start the server and check the console for the ready line from poggy_character_storage.

There is no SQL to import. The character_storage table is created and kept up to date automatically each time the script starts.

Configuration#

Every setting can be changed in game: type /poggy and open Poggy Storage. You can also edit config.lua by hand (the translations are in the same file). Restart the script after a change.

Buying and upgrading

Player storages

Job storages

Job storages (Config.DefaultStorages, the Locations tab) are stashes you define: nobody buys them and they never expire. The shipped examples are a police evidence storage at eight sheriff offices and a doctor storage at seven doctor's offices. Each one has:

Clerks (Config.NPCs) are decorative NPCs, such as a clerk behind the evidence desk. They are frozen, cannot be hurt and are not interactive. They spawn within 80 m and despawn past 100 m by default.

Armories

An armory (Config.ArmoryShops, the Armories tab) is a job-locked shop with endless stock. One ships as an example, at Blackwater for police, sheriff and marshal.

Each armory has a position, an id, a name, a job list (joblock, empty for everyone), an optional clerk and blip, and sellitems: the name of an item list in the config, such as "WeaponArmoryItems". That shipped list holds the stock weapons, ammunition, gun oil and handcuffs, all at price 0.0 (shown as Free). Each item has a name, a label, a price and a type (item_weapon or item_standard).

Discord logging

Every job storage and armory has a discord block, off by default. A job storage posts an inventory summary (every 600 seconds by default) and an activity log of who took or added what; an armory posts who took what.

1. Paste a channel webhook into webhook and set enabled = true.
2. Restart the script. The server console prints the message ids it created.
3. Paste them into inventory_message_id and activity_message_id, so the same messages are edited from then on instead of new ones being posted.

Commands#

Command names can be changed on the Access & permissions tab. The defaults:

Permissions#

A player is a storage admin if they have the ACE, or their character's group is in Admin groups.

add_ace group.admin character_storage.admin allow

The Storages panel in /poggy is open to whoever may edit settings in /poggy.

Access levels inside a storage

The owner gives named characters a level. When a storage lets a whole job in, the player's grade decides the level: grades in Manager grades get Manager, grades in Member grades get Member, any other grade gets Basic.

Using it in game#

For players

1. Stand where you want the storage and type /createstorage. Confirm to pay and create it.
2. Walk up to it and press G. The menu lets you open it, rename it, upgrade it, deposit and withdraw money, and read the ledger, depending on your access level.
3. Under Access Management the owner adds players (by searching or by name) and sets their level, or adds a job rule such as police 0,1,2 or police all.

Armories

1. Walk up to the armory and press G. Your job is checked when it opens and again on every take.
2. Pick an item and say how many. Weapons are always one.
3. The script checks you can carry it, takes the money, then gives the item. If the inventory refuses it, the money is refunded.

For admins: the Storages panel

Open /poggy → Poggy Storage → Storages. It lists every storage, player and job, with its owner, location, slots, upgrades, keys and jobs. Changes apply at once, with no restart.

• Rename or resize a player storage by editing the cell. Lowering the size below what is inside keeps the items, but nothing more fits.
• Move to my position, Change owner and Delete storage on each row. Change owner and Delete ask you to type the storage id to confirm.
• Open a row to give a character a key, change a level or remove access.
• Contents on any row, job storages too, shows what is inside and lets you add, remove or empty it.

Job storages are read-only in the panel apart from Contents; change them in the config. Every change is printed to the server console with who made it.

Troubleshooting#

A storage looks empty after a restart

Make sure poggy_core starts before poggy_character_storage in server.cfg.

A player storage disappeared

It may have expired: nobody opened it for Unused for days while Delete unused storages was on (60 days by default).

No prompt at a storage

Stand closer, or raise Open distance.

No blips at all

Check Map blips is on.

An admin command says no permission

Grant the ACE, or add the character's group to Admin groups.

A job storage or armory will not open for a job

Job names are case-sensitive. Use exactly the name your framework uses.

Discord posts nothing

Paste a real webhook URL, set enabled = true, and restart.

Discord posts a new message every restart

Paste the message ids the console printed into the storage's or armory's discord block.

Text shows a key such as storage_created

That line is missing from your language block. Copy it from english.

Updating#

Poggy Storage updates through poggy_core's updater, which keeps your values in config.lua (see Updates).

From the old character_storage folder

1. Remove the old character_storage folder and put in poggy_character_storage.
2. In server.cfg, change ensure character_storage to ensure poggy_character_storage.

Your data carries over: the table is still character_storage, the containers keep their ids, and the admin ACE is still character_storage.admin. If another resource called this one by its old name, point it at poggy_character_storage.