📁 Main Configuration

On this page, you will find everything you need to know about the config.yml options of Phoenix Shop

Changes made by hand in config.yml apply with /pshop reload, except the Internal Pool Size and the Database settings, which need a restart. The console names any of those that changed. Options changed from the editor are saved straight away.

#General Configuration

Internal Pool Size - The number of threads the plugin keeps for its own background work, such as database reads. The default of 10 suits almost every server.
Debug - Adds verbose logging to the console, useful when reporting an issue.

performance:
  internal-pool-size: 10
debug: false

#Database

Transactions, stock counts and restock timers are stored in the database. The available types are sqlite, mysql and mariadb.

database:
  type: sqlite
  address: localhost
  name: phoenixshop_db
  port: 3306
  username: phoenixuser
  password: phoenixpassword
  table-prefix: ps

⭐ MySQL and MariaDB are Premium only. The Lite version uses SQLite whatever the type says, prints a warning in the console and leaves your settings in the file untouched.

#History

How many days a transaction is kept in the database before it is deleted. 0 or less keeps every transaction forever.

history:
  keep-days: 7

The history itself can be browsed and exported with /pshop history ⭐.

#Undo ⭐

Lets a player reverse their last transaction with /pshop undo, as long as it happened within the window.

undo:
  enabled: true
  window-seconds: 30

#Player Shops

Chest shops that players build themselves with a sign.

Option	Description
enabled	Turns chest shops on or off. While off, nobody can trade on one, the owner included. Players with `phoenixshop.sign.bypass` can still put a sign up.
creation-cost	Charged once, in money (Vault), when the sign goes up. `0` makes it free.
max-per-player	How many chest shops one player can own. `0` removes the limit.

player-shops:
  enabled: true
  creation-cost: 0
  max-per-player: 5

#Settings File

Transactions, menus, locked categories, the IP limit and sign shops are set in settings.yml. See Settings File.

#Click Mappings

What each click on an item in a category does. The key is the click and the value is the action.

click-mappings:
  LEFT: BUY
  RIGHT: SELL
  SHIFT_LEFT: BUY
  SHIFT_RIGHT: SELL_ALL

Action	Description
BUY	Opens the buy menu, where the player picks the amount.
SELL	Opens the sell menu, where the player picks the amount.
BUY_ONE	Buys one purchase straight away.
SELL_ONE	Sells one purchase straight away.
BUY_STACK	Buys as many purchases as fit in one stack, straight away.
SELL_ALL	Sells every matching item the player carries, straight away. Needs `phoenixshop.sell.all`.
PREVIEW ⭐	Opens the preview of what one purchase gives. Needs `phoenixshop.preview`.
NONE	Does nothing.

A click left out of the list does nothing. The keys are Bukkit click types, so DROP (Q) and CONTROL_DROP (Ctrl + Q) can be mapped too. MIDDLE is left out, as the game only sends a middle-click in creative mode. An action name that does not exist is reported in the console and skipped.

PREVIEW is not mapped by default. Swap it in for a click to use it, such as SHIFT_RIGHT: PREVIEW. On Lite it does nothing and is left out of the item's hint lines.

#Search ⭐

Shops left out of /pshop search, by identifier.

search:
  excluded-shops: []

#Restock and Sale Alerts ⭐

How players are told that an item is back or on sale, see Restock & Sale Alerts.

Option	Description
enabled	Turns restock and sale alerts on or off for everyone.
chat	Sends the alert in chat.
title	Shows the alert as a title and subtitle.
sound	Played with the alert, as `SOUND, volume, pitch`. Empty plays no sound.

alerts:
  enabled: true
  chat: true
  title: true
  sound: 'BLOCK_NOTE_BLOCK_PLING, 1, 1'

#Sell

The settings of /sell and the sell menu.

Option	Description
shops-whitelisted	The shops `/sell` sells to. A shop the player cannot open is skipped.
sell-on-close	Closing the sell menu sells what is in it. When off, the items are given back unless the player confirms.
shulker-boxes	`/sell inventory`, `/sell hand` and the sell menu also sell what is inside shulker boxes. See Shulker Boxes.
sounds.sold	Played after a sale, as `SOUND, volume, pitch`.
sounds.deny	Played when nothing could be sold.
sold.message	Sends the sold message in chat.
sold.title	Shows the sold title, with its fade-in, stay and fade-out in ticks.

sell:
  shops-whitelisted:
    - shop
  sell-on-close: true
  shulker-boxes: true
  sounds:
    sold: 'ENTITY_PLAYER_LEVELUP, 1, 1'
    deny: 'BLOCK_NOTE_BLOCK_BASS, 1, 1'
  sold:
    message: true
    title:
      enabled: true
      fade-in: 5
      stay: 40
      fade-out: 10

Most of these can also be changed from Editor > Settings > Sell.

#Bedrock

How Bedrock players using Geyser or Floodgate see the shops. Every option is explained on GeyserMC / Bedrock.

bedrock:
  forms: true
  input-modes: []
  allow-opt-out: true
  resize-chest-menus: true
  after-transaction: CATEGORY
  confirm-above: 0
  custom-amount: true
  show-balance: true
  sell-form: true
  icons:
    enabled: true
    fallback-url: ""
    head-url: "https://mc-heads.net/head/%texture%"

#Currency Symbols

The symbol shown next to each price in the editor's item list. The key is the currency's identifier, and a PlaceholderAPI placeholder can be used as the symbol. A currency with no entry shows its own name.

currency-symbols:
  money: "$"
  points: "Points"
  experience: "XP"
  levels: "Levels"
  votepoints: "Vote Points"

There is no list of currencies in this file. The currency of a shop, category or item is picked in the editor and saved in that shop's own file. See Shop Configuration File.

#Messages & Translations

Every message the plugin sends lives in the translation file rather than in config.yml. Editing the wording and silencing a message are on Languages & Translations.

#MiniMessage

On top of the usual & colour codes, shop names, item names, lore and menus accept MiniMessage tags for gradients and hex colours. It has its own page: Rich Text (MiniMessage).

Last updated about 1 hour ago