Shop

The server's own shop: shops of products with a buy price, a sell price or both, and shops drawn inside other shops. The whole catalogue lives in the database and is edited from the game — there is no shop file to write. By default every server on the database shares one catalogue, and each shop chooses the servers that offer it.

Module id shop, file modules/shop/config.yml, commands /shop and /shopadmin (also /shopa).

For players

/shop opens the front: one button per shop that is not inside another, a History button and a Cart button. When a server offers only one shop, /shop skips the front and opens that shop; its back button then closes the menu. /shop <id> opens one shop straight away, and a shop may have commands of its own, such as /blocks or /store (see Shops).

Inside a shop, products and the shops inside it share one grid, where the admin placed them. A shop the player has no permission for is hidden, or drawn locked when hide-locked-categories is off. Each product shows its buy and sell price and how many you carry; whether the price is moving, its discount, its stock and what your limit leaves are shown only when they apply. The bottom row has Back (to the shop above, or the front), Cart, and a Sell button that opens the /sell window on a left-click and sells everything on a right-click.

The amount screen has ±1, ±16, ±64, One and Max buttons; from one, +16 lands on 16, not 17. The amount stops at max-amount, the stock, what your limit leaves and what you can pay; for selling, at what you carry and your sell allowance. Confirm only appears when the trade can happen. When buying, the screen also has Coupon and Gift in its bottom corners and Add to cart above Back.

• Buying something that does not all fit asks first, from the amount screen or a shift-click: on a yes, what fits goes into your inventory and the rest waits in /collect. Nothing ever lands on the floor.
• Selling takes matching items from your inventory (not armour or off hand), then pays. Selling a product that has stock adds it back, up to its maximum.

Gifts

Gift on the amount screen asks for a name: anybody who has played on the server. The buyer pays and the purchase counts against the buyer's limits; the recipient gets the items in their inventory, or in /collect when they are not here, and a command product runs its commands for them where they are. The recipient is told, at once or on their next join. Leaving the name blank buys for yourself again.

You cannot gift yourself, and a gift to a player who is in combat on this server is refused with the time the fight has left. It needs exyliamarket.shop.gift.

Coupons

Coupon asks for a code and checks it at once; the code is kept on the screen until the purchase. It takes its percentage off the whole purchase, after any discount. A code is refused when it is unknown, expired, used up, already used by this player (a once-per-player code) or meant for another shop. A use is taken only when the purchase goes through: a payment that fails gives it back. Staff create coupons, see Coupons and sales.

The cart

Add to cart sets the amount on screen aside instead of buying it. The cart (/shop cart, or the Cart button) holds up to 54 products, kept while you are on the server and emptied when you leave. Nothing is reserved by being in it: prices, stock and limits are read again at checkout.

Command products are added once. Adding and checking out need exyliamarket.shop.cart.

History

/shop history, or the History button of the front, lists the latest 180 things you bought and sold in the shop, newest first: what, how many, for how much and how long ago.

Products

How prices move

Draws and rotations follow UTC: a 6-hour draw changes at 00, 06, 12 and 18 UTC.

What the sell price is held to

• Discounts apply to the buy price only. A product's and its shop's discount do not add up: the larger one wins.
• The sell bonus (exyliamarket.shop.sell.<multiplier>) and shop-sell boosters raise what selling pays. See Selling.
• Selling never pays as much as buying the same units back costs right now, nor as much as crafting the item from things the shop sells. The price is held one step below both, so the shop cannot be farmed.

Shops

A shop sits on the front screen or inside another shop, up to six levels deep.

The editor

/shopadmin opens the front exactly where /shop draws it.

• Click a shop to edit it; shift-click picks it up, and the next click drops it on an empty place, swaps it with another, or puts it back.
• The bottom row: Create asks for an id; Load default shop (left-click adds what is missing, right-click replaces everything, see below); Coupons; Sale, a discount on every shop at once; Back to /marketadmin.

A shop's screen has Status, General (name, description, icon, pages), Placement (inside, position, commands, servers), Sales (currency, discount and its duration, permission, celebrate), Rotation, Products, Player view, Back (to the shop above) and Delete shop, which deletes it and every product in it after a confirmation; the shops inside it move up a level.

In a shop's grid, holding an item on the cursor and clicking an empty slot creates a product from it, both prices off. The bottom row also creates a new shop inside this one and a command product. Click a product or an inner shop to edit it, shift-click to move it, the page arrows carry it to another page. A product's screen has Enabled, General (item, name, description, position), Prices (buy, sell, currency, pricing, discount), Stock (setting it fills it), Limits (buy, sell, period, permission), Commands, Delivery for a command product, and Delete.

Lowering a shop's pages when something sits on the pages that go asks first, then moves it into the free slots of the pages that stay. It is refused only when it no longer all fits.

Coupons and sales

Coupons are listed and edited from the editor's Coupons button or /shopadmin coupon list: the discount, uses, expiry, the shop it works in (and every shop inside it), whether each player may use it once, and Delete coupon. A use is counted on the stored row, so a code with 50 uses is spent 50 times across every server, never 51.

The Sale button of the editor and a shop's Discount ask for a percentage, then how long it lasts (at least a minute); 0 percent ends it.

Celebrations

A purchase in a shop marked Celebrate, or inside one, is announced on every server. For celebration.seconds anyone who types one of celebration.words as their whole chat message earns celebration.rewards once, and their word shows in rainbow colours. Another celebrated purchase meanwhile extends the window without rewarding anyone twice. Announcements reach the other servers over Redis; without it, only the buyer's server celebrates. The words players read are in messages.yml.

The default catalogue

On a shop with no shops and no products, and with example-catalogue on, the plugin writes its default shop: 20 shops and 402 products. When the server has a currency other than the default one, a Premium Store priced in it is added, with Ranks and Temporary Ranks inside it: 23 shops and 415 products. Materials the server's version does not know are skipped.

A network

The shop module is shared by every server on the database by default (network.modules.shop: global in config.yml, see Configuration); each shop's Servers then chooses where it is offered. Every server keeps the catalogue in memory. With Redis on, an edit made on one server reaches the others at once; without Redis, other servers only see an edit after their next restart. Stock is safe either way: a purchase only completes once the database has taken the change. Each player's limits are read when they join and merged with what the server they came from wrote.

A command product with a Delivery server, or a gift whose recipient is elsewhere, runs its commands when the player is on the right server: bought on the hub, a survival rank is given on survival.

Settings

modules/shop/config.yml. The catalogue is not here.

Known issues

• The front shows a rotating shop's whole pool as its product count, not the rotation size.
• Chat counts items (units × the product's stack), /shopadmin log in the console counts units.
• Two admins editing the same shop at once: the last save wins the whole row.
• /shopadmin defaults replace keeps players' limit counters: the default products get the same ids again.
• A shop whose id is cart or history cannot be opened with /shop <id>: those are subcommands. Give it a command of its own instead.
• The cart's checkout refuses a line that does not fit rather than offering /collect as a single purchase does.