NexaShop Documentation

Main runtime settings, license, modules, limits, storage and feature behavior.

# ...
# Short documentation excerpt from config.yml.
# This is not the complete YAML file.
# Lines before and after this preview are omitted from the docs.
# ...
settings:
  default-currency: "vault"
  language: "en"
  debug: false
  transaction-log-file: true

license-key: "LICENSE"

storage:
  type: "sqlite"
  sqlite-file: "nexashop.db"
  mysql:
    host: "localhost"
    port: 3306
    database: "nexashop"
    username: "root"
    password: ""
    use-ssl: false
  mariadb:
    host: "localhost"
    port: 3306
    database: "nexashop"
    username: "root"
    password: ""
    use-ssl: false

network:
  enabled: false
  server-id: "server-1"
  require-production-database: true
  heartbeat-seconds: 10
  stock-sync: true
  player-shop-sync: true
  redis:
# ...
# More options continue in the generated plugin YAML file.
# Open plugins/<plugin-folder>/config.yml to review every setting.
# ...

Plugin-specific YAML settings used by this product.

# ...
# Short documentation excerpt from currencies.yml.
# This is not the complete YAML file.
# Lines before and after this preview are omitted from the docs.
# ...
default: "vault"

currencies:
  vault:
    type: "vault"
    display-name: "$"
  experience:
    type: "experience"
    display-name: "EXP"
  emeralds:
    type: "item"
    display-name: "Emeralds"
    material: "EMERALD"
  playerpoints:
    type: "playerpoints"
    display-name: "Points"
  coinsengine:
    type: "coinsengine"
    display-name: "Coins"
    currency-id: "coins"
  tokenmanager:
    type: "tokenmanager"
    display-name: "Tokens"
    withdraw-command: "tokens remove {player} {amount_int}"
    deposit-command: "tokens add {player} {amount_int}"
  gemseconomy:
    type: "gemseconomy"
    display-name: "Gems"
    withdraw-command: "gems take {player} {amount_int}"
    deposit-command: "gems give {player} {amount_int}"
  ultraeconomy:
    type: "ultraeconomy"
    display-name: "Ultra"
    withdraw-command: "ultraeconomy remove {player} {amount}"
# ...
# More options continue in the generated plugin YAML file.
# Open plugins/<plugin-folder>/currencies.yml to review every setting.
# ...

Inventory layout, titles, slots, materials, names, lore and click behavior.

# ...
# Short documentation excerpt from layouts.yml.
# This is not the complete YAML file.
# Lines before and after this preview are omitted from the docs.
# ...
default:
  content-slots:
    - 10
    - 11
    - 12
    - 13
    - 14
    - 15
    - 16
    - 19
    - 20
    - 21
    - 22
    - 23
    - 24
    - 25
    - 28
    - 29
    - 30
    - 31
    - 32
    - 33
    - 34
  filler:
    material: "BLACK_STAINED_GLASS_PANE"
    name: " "
  back:
    slot: 45
    material: "ARROW"
    name: "<yellow>Back"
  previous:
    slot: 48
    material: "ARROW"
    name: "<yellow>Previous Page"
# ...
# More options continue in the generated plugin YAML file.
# Open plugins/<plugin-folder>/layouts.yml to review every setting.
# ...

Feature modules and ready setup presets.

# ...
# Short documentation excerpt from modules.yml.
# This is not the complete YAML file.
# Lines before and after this preview are omitted from the docs.
# ...
server-shops: true
player-shops: true
stock-system: true
dynamic-pricing: true
rotating-items: true
seasonal-pricing: true
temporary-sales: true
shop-stands: true
npc-shops: true
discord-logs: false
transaction-export: true
migration-tools: true
# ...
# More options continue in the generated plugin YAML file.
# Open plugins/<plugin-folder>/modules.yml to review every setting.
# ...

Economy, product, currency, marketplace or limit behavior.

# ...
# Short documentation excerpt from shops.yml.
# This is not the complete YAML file.
# Lines before and after this preview are omitted from the docs.
# ...
categories:
  building:
    title: "<aqua>Blocks</aqua>"
    currency: "vault"
    item: "BRICKS"
    slot: 10
    lore:
      - "<gray>Building blocks and decoration materials."
      - "<dark_gray>{products} products available"
  ores:
    title: "<blue>Ores</blue>"
    currency: "vault"
    item: "DIAMOND"
    slot: 11
    lore:
      - "<gray>Ingots, gems, blocks and mine drops."
      - "<dark_gray>{products} products available"
  farming:
    title: "<green>Farming</green>"
    currency: "vault"
    item: "WHEAT"
    slot: 12
    lore:
      - "<gray>Crops, seeds and farm materials."
      - "<dark_gray>{products} products available"
  food:
    title: "<gold>Food</gold>"
    currency: "vault"
    item: "COOKED_BEEF"
    slot: 13
    lore:
      - "<gray>Cooked meals, raw food and snacks."
      - "<dark_gray>{products} products available"
  mobs:
# ...
# More options continue in the generated plugin YAML file.
# Open plugins/<plugin-folder>/shops.yml to review every setting.
# ...

# ...
# Short documentation excerpt from messages.yml.
# This is not the complete YAML file.
# Lines before and after this preview are omitted from the docs.
# ...
prefix: "<aqua>NexaShop</aqua> <dark_gray>|</dark_gray> "
missing-message: "<red>Missing message: <key>"

no-permission: "<red>You do not have permission."
player-only: "<red>Only players can use this command."
reload-complete: "<green>NexaShop reloaded."
module-disabled: "<red>The <module> module is disabled."
shop-not-found: "<red>Shop not found."
product-not-found: "<red>Product not found."
item-not-found: "<red>Item not found."
category-not-found: "<red>Category not found."
shop-or-item-not-found: "<red>Shop or item not found."
shop-or-category-not-found: "<red>Shop or category not found."
currency-unavailable: "<red>Currency provider is unavailable."
transaction-success: "<green>Transaction complete."
transaction-failed: "<red>Transaction failed: <reason>"
operation-success: "<green><message>"
operation-warning: "<yellow><message>"
operation-failed: "<red><message>"
status-ok: "ok"
status-enabled: "<green>enabled"
status-disabled: "<red>disabled"
status-enabled-plain: "enabled"
status-disabled-plain: "disabled"

usage-sell: "<red>Usage: /sell <hand|handall|all|inventory|gui>"
sell-unknown-mode: "unknown sell mode"
sell-all-total: "<gray>Sell-all total: <green><total>"
sell-all-summary-line: "<dark_gray>- <gray><line>"

license-header: "<gold>NexaShop License"
license-status-line: "<gray>Status: <white><status>"

network-header: "<gold>NexaShop Network"
# ...
# More options continue in the generated plugin YAML file.
# Open plugins/<plugin-folder>/messages.yml to review every setting.
# ...

Purpose: Provides economy withdrawals, deposits, prices, banks or metadata through Vault.

Troubleshooting: If balances, rewards or banks do not work, confirm Vault has an active economy provider and that no economy plugin loads after this product.

1. Install Vault and one compatible economy or permission provider.
2. Restart the server and confirm Vault reports a provider in console.
3. Enable prices, banks, rewards or currency features that depend on Vault.
4. Test one deposit and one withdrawal with a non-op account.

Purpose: Registers or consumes PlaceholderAPI values for scoreboards, formats and external displays.

Troubleshooting: If values stay blank, reload expansions and verify the identifier exactly matches the placeholder shown in this docs page.

1. Install PlaceholderAPI or the listed placeholder provider.
2. Install required expansions when the provider uses external expansions.
3. Use the exact placeholder identifiers documented in this page.
4. Reload the display plugin after changing scoreboard, tablist, menu or chat format files.

Purpose: Provides a named currency provider for prices, rewards, trades or shop transactions.

Troubleshooting: If transactions fail, verify the currency id, provider startup order and whether the player has enough balance or inventory space.

1. Install the economy/shop provider and create the currency key used by this product.
2. Match the currency id in the product config.
3. Test a buy/sell/withdraw flow with a player account.
4. Check transaction logs if balances do not change.

Purpose: Provides custom item, glyph or resource-pack integration.

Troubleshooting: If visuals are missing, check asset ids, resource-pack generation and provider reload order.

1. Install the visual/resource plugin and load its pack or asset registry.
2. Use valid item, glyph or hologram ids from that plugin.
3. Reload the visual provider first, then reload this product.
4. Open the GUI or display feature and check missing material/glyph warnings.

Purpose: Provides custom item, glyph or resource-pack integration.

Troubleshooting: If visuals are missing, check asset ids, resource-pack generation and provider reload order.

1. Install the visual/resource plugin and load its pack or asset registry.
2. Use valid item, glyph or hologram ids from that plugin.
3. Reload the visual provider first, then reload this product.
4. Open the GUI or display feature and check missing material/glyph warnings.

Purpose: Provides custom item, glyph or resource-pack integration.

Troubleshooting: If visuals are missing, check asset ids, resource-pack generation and provider reload order.

1. Install the visual/resource plugin and load its pack or asset registry.
2. Use valid item, glyph or hologram ids from that plugin.
3. Reload the visual provider first, then reload this product.
4. Open the GUI or display feature and check missing material/glyph warnings.

Purpose: Connects gameplay behavior to claims, regions or group ownership rules.

Troubleshooting: If region or claim rules do not apply, check region priority, claim ownership, world names and whether the hook is enabled.

1. Install the claim or region plugin before this product starts.
2. Create the region, claim, town or faction area you want the plugin to read.
3. Enable the matching hook in the integration/config file when a toggle exists.
4. Test the protected workflow inside and outside the region with a normal player.

Purpose: Publishes logs or events to Discord channels or webhooks.

Troubleshooting: If Discord messages do not send, check webhook validity, rate limits and whether the event type is enabled.

1. Create the webhook or channel integration in Discord.
2. Paste the webhook/token into the product config if the feature exists.
3. Send one test event from the product.
4. Confirm Discord receives only the events you want to expose.

Purpose: Provides NPC entities used by bot or combat punishment workflows.

Troubleshooting: If NPCs or bots fail, check Citizens startup errors, skin fetch warnings, disabled worlds and pathfinder restrictions.

1. Install Citizens before starting the server.
2. Confirm Citizens loads without NPC registry errors.
3. Enable the feature that uses NPCs, bots, corpses or combat entities.
4. Spawn or trigger one test entity and check console for skin, pathfinder or trait errors.

1. Install a preset with /shop preset install survival on staging.
2. Review categories, item ids, currencies and prices.
3. Open the generated shop as a non-op and test one buy/sell item.
4. Copy only approved entries to the production catalog.

1. Run import/dry-run commands against a backup.
2. Map legacy material, price, category and stock fields.
3. Apply the import, then verify stock decrement, restock and limits.

Check menu materials, category ids, command aliases and whether the economy/storage provider loaded before the GUI opened.

Verify buy price, stock, currency provider, inventory space, permission requirements and any WorldGuard/shop region restriction.

Check item matcher rules, NBT/custom item ids, price priority and whether the sell menu uses a different product key than the buy menu.

Confirm the selected storage/network backend is enabled on every server and that product ids are identical across configs.

Check Vault/CoinsEngine startup order, currency id casing and whether the provider is enabled in hooks/config.

Verify database writes, owner UUID storage, shutdown save logs and whether the shop world is excluded.