Tutorial / Settings
Shipments
Set up shipments that store-owner jobs buy in the F3 hub and resell, plus the store types that decide which job sells what.
What it does
Shipments let jobs run their own shops. A job buys a shipment in the F3 hub (Shipments tab). It is a box holding several of one item, placed in front of the buyer. The owner sets the price of one, and everyone else buys one with E. The money goes to the owner.
This page has the shipment rules, the shipment catalog (what can be bought, how many, for how much) and the store types. A store type is a set of classes, such as weapons or food. A job sells the store types ticked for it in Settings > Jobs.
Where to find it
Q menu > KGX's Admin Toolbox > Settings > Shipments.
Only superadmins can change these settings. The catalog and store type editors are shown only to superadmins. Others see "Only superadmins can change the shipment list."
The panel
Checkboxes and Owners pay for shipments from take effect at once. The two sliders take effect when you click Apply. Catalog and store type changes are saved straight away, for every map.
Rules
| Option | What it does | Default | Range |
|---|---|---|---|
| Shipments on | Switches shipments. | On | - |
| Admins see and may buy every shipment (off: only their job's, like players) | An admin whose job sells shipments still sees only that job's. | On | - |
| Items can also be bought one at a time (a box of one) | Adds a Buy x1 button in the hub. | On | - |
| Shipments break when damaged (everything falls out for free) | Shipments can be broken open. | On | - |
| Shipments set as a store stay when their owner leaves | Their sales are mailed to the owner's bank. | On | - |
| Damage a shipment takes before it breaks | Shipment health. | 150 | 10-5,000 |
| Most shipments out per player | Overall limit per player. | 4 | 1-20 |
| Apply | Saves the two sliders. | - | - |
| Owners pay for shipments from | Their wallet, Their bank, or Their bank, the wallet pays the rest. | Their bank | - |
Shipment catalog (superadmins)
The list shows Shipment, Units, Price, Class and Jobs. Click a row to load it into the fields below.
| Field | What it does | Default |
|---|---|---|
| Item type | Weapon, Ammo, Entity, Prop, Health, Armor, Speed boost (x1.5), Jump boost (x1.5), or Food / drink (a buff id, Create Buffs). | Weapon |
| Class (weapon / entity class, ammo type, or prop model) | What the shipment holds. | empty |
| Name | Name shown to players. | empty |
| Amount per unit (ammo rounds, health / armor points, boost seconds) | 1 to 500. | 1 |
| Units in one shipment | 1 to 100. | 10 |
| Shipment price (admin set) | What the job pays for the whole shipment, 0 to 100,000. | 2,500 |
| Price of a box of one (0 = shipment price split up + 10%) | 0 to 100,000. | 0 |
| Shipment prop model (empty = the item's own model) | The box model. A small preview shows it. | empty |
| Only these jobs (comma separated; empty = every job that buys this kind) | Job names. | empty |
| Category | A label shown in the hub. | empty |
| Food: health it gives when eaten (props only; 0 = not food) | 0 to 200. A food prop is eaten when bought or taken. | 0 |
| Sold as | Normal (store types with its class sell it), or Black market only. | Normal |
| Only these ranks (comma separated; empty = any rank) | Job rule. | empty |
| Needs license | A license the buyer must hold. | (none) |
| Most of this one a player has out (0 = only the overall limit) | 0 to 50. | 0 |
| Minutes before the same player buys it again (0 = no wait) | 0 to 1,440. | 0 |
Buttons: Add as a new shipment, Update the selected shipment and Remove the selected shipment. The catalog holds up to 100 shipments.
Store types (superadmins)
The list shows Store type and Sells. Six come by default: General store, Gun store, Food store, Hardware store, Pharmacy and Black market.
| Field | What it does |
|---|---|
| Name | Name of the store type. |
| Class boxes | Weapons, Ammo, Food (props set as food), Props, Entities / items, Health & armor, Boosts (speed, jump), Black market. |
| Add as a new store type | Adds the name and ticked classes as a new type. |
| Update the selected store type | Saves changes to the selected type. |
| Remove the selected store type | Deletes it. |
| Reset the store types to the defaults | Back to the six defaults (asks first). Jobs keep their ticks for types that still exist. |
How to use it
Add a pistol shipment for a gun store job
- Set Item type to Weapon and Class to
weapon_pistol. Type a Name. - Set Units in one shipment and Shipment price (admin set).
- Click Add as a new shipment.
- In Settings > Jobs, tick Gun store (or General store) for the job.
Sell food
- Set Item type to Prop and put a food prop model in Class.
- Set Food: health it gives when eaten above 0.
- Click Add as a new shipment. It is sold by store types with the Food class.
Run a shipment as an owner
- Buy it in the F3 hub, Shipments tab.
- Press Alt + E on it for its window.
- Pick how it works: Closed shipment, Dedicated box (free) or Store. Use Set the price of one... to set your price.
Settings and commands
| Setting | Default | Range |
|---|---|---|
kgxat_shipments |
1 | 0-1 |
kgxat_shipments_admin_all |
1 | 0-1 |
kgxat_shipments_single |
1 | 0-1 |
kgxat_shipments_breakable |
1 | 0-1 |
kgxat_shipments_store_keep |
1 | 0-1 |
kgxat_shipments_health |
150 | 10-5,000 |
kgxat_shipments_max |
4 | 1-20 |
kgxat_shipments_pay |
1 | 0 = wallet, 1 = bank, 2 = bank first, then wallet |
Tips and limits
- Shipments need the economy on.
- The catalog and store types are saved in
data/kgx_admin_toolbox/shipments.json, for every map. - Owners take their shipments with them when they leave, except shipments set as a store when Shipments set as a store stay... is on.
- In Store mode, each sale is mailed to the owner's bank. Only stores can be frozen with the physgun.
- A broken shipment spills everything on the ground for free.
- The owner's window also has Take one for myself, Unpack: everything falls out on the ground and Throw the shipment away.
- Jobs made before v3.5.20 without store type ticks: Store owner sells General store, Black market dealer sells Black market.