Configuration
The configuration file for Nexal Shops. Located at plugins/Nexal Shops/config.yml.
config.yml
# ============================================
# Nexal Shops Configuration
# ============================================
# Storage type: "json" or "sql"
storage:
type: json
auto-save-interval: 300 # Seconds between flushes to disk (changes are also written in the background as they happen; 0 to disable)
transaction-retention-days: 30 # Transactions older than this are deleted (0, or leaving the setting out, keeps them forever)
sql:
host: localhost
port: 3306
database: minecraft
username: root
password: ""
# ============================================
# Shop Creation Settings
# ============================================
creation:
# Where the creation wizard starts; the player can change both before confirming
default-display-type: FLOATING_ITEM # FLOATING_ITEM, FLOATING, DISPLAY_ENTITY, ARMOR_STAND, HOLOGRAM_ONLY
default-instant-deposit: true
max-price: 1000000000 # Highest buy or sell price a player can enter
# Shop limits by permission
# Permission: nexalshops.limit.X - player can have X shops
# Permission: nexalshops.limit.unlimited - no limit
shop-limits:
default: 5
unlimited-permission: "nexalshops.limit.unlimited" # Players with this permission have no limit
# ============================================
# Tax Settings
# ============================================
tax:
enabled: true # false: no tax on any sale
default-rate: 5.0 # Percentage taken from sales; new shops start with it, admins can change it per shop
# ============================================
# Display Settings
# ============================================
display:
# Price formatting
# When true, large prices are abbreviated (e.g. $1.5M instead of $1,500,000)
abbreviate-prices: true
# Hologram settings
hologram:
enabled: true # Show a text hologram above every shop
admin-shop-name: "<gradient:#FF5252:#FF7070><bold>Admin Shop</bold></gradient>"
# Lines to display above shop. Available placeholders:
# %owner% - Shop owner name
# %item_name% - Item display name
# %buy_price% - Buy price (only shown if buying is enabled)
# %sell_price% - Sell price (only shown if selling is enabled)
# %stock% - Current stock (lines containing %stock% are hidden for admin shops)
# Lines containing %buy_price% are hidden when buying is disabled.
# Lines containing %sell_price% are hidden when selling is disabled.
lines:
- "<gradient:#FFC107:#FFCD38><bold>%owner%'s Shop</bold></gradient>"
- "<white>%item_name%</white>"
- "<gradient:#2ECC71:#52D68A>Buy: $%buy_price%</gradient>"
- "<gradient:#FFC107:#FFCD38>Sell: $%sell_price%</gradient>"
- "<gradient:#AAAAAA:#BBBBBB>Stock:</gradient> <white>%stock%</white>"
y-offset: 2.0 # Height above shop block
# Floating item display settings
floating-item:
y-offset: 1.0 # Height of the floating item above the shop block
# Floating item display (armor stand with glass head + floating item)
floating-item-display:
glass-type: GLASS # GLASS, TINTED_GLASS, WHITE_STAINED_GLASS, etc.
y-offset: -0.3 # Armor stand feet position above shop block (glass renders ~1.75 above this)
item-y-offset: 1.0 # Item height above shop block
# Armor stand display (invisible stand with armor/items equipped)
# Each slot has its own y-offset since armor pieces render at different heights
armor-stand:
y-offset:
helmet: -0.25
chestplate: 0.25
leggings: 0.75
boots: 1.25
# Display entity settings (1.19.4+)
display-entity:
scale: 0.8
y-offset: 1.5
# ============================================
# Browse GUI Settings
# ============================================
browse:
enabled: true # Set to false to disable the /shops browse GUI
remote-purchase-enabled: true # Allow buying and selling from the browse GUI; when false, players must visit the shop
items-per-page: 45 # Shops per page, at most 45
default-sort: "RECENT" # RECENT, PRICE_ASC, PRICE_DESC, POPULAR
# ============================================
# Teleport Settings
# ============================================
teleport:
enabled: true # Let owners teleport to their shops
cost: 100.0 # Vault cost to teleport (0 for free)
cooldown: 60 # Seconds between teleports
bypass-permission: "nexalshops.teleport.bypass"
# ============================================
# Notification Settings
# ============================================
notifications:
sale-notification: true # Tell owners when someone buys from or sells to their shop
low-stock-threshold: 10 # Warn the owner once when a sale takes the stock to this or lower
revenue-milestones: # Notify an owner when their total revenue passes these amounts
- 1000
- 5000
- 10000
- 50000
- 100000
offline-notifications: true # Queue notifications for offline players
max-pending-notifications: 50 # Maximum pending notifications per player
# ============================================
# Protection Settings
# ============================================
protection:
prevent-break: true # Only the owner (with nexalshops.delete) and admins can break a shop block; when false anyone can, and the shop is removed with its stock returned to the owner
prevent-explosions: true # Explosions do not destroy shop blocks
prevent-pistons: true # Pistons cannot move shop blocks
prevent-hopper-extraction: true # Reserved for linked chest storage; has no effect yet
# ============================================
# Price Suggestion Settings
# ============================================
price-suggestions:
enabled: true # Allow /shops price
cache-duration: 300 # Seconds to cache price data
min-samples: 3 # Minimum shops needed for suggestion
Configuration Options
Below is a reference of the main configuration sections:
storage
============================================ Nexal Shops Configuration
Storage type: "json" or "sql"
creation
============================================ Shop Creation Settings
shop-limits
Shop limits by permission Permission: nexalshops.limit.X - player can have X shops Permission: nexalshops.limit.unlimited - no limit