RedMart Documentation

Version 1.0 • Java 17+ • Spigot/Paper 1.18.x

Introduction

RedMart is a modern sign-shop plugin. Players can buy/sell using signs; admins can create admin shops. Storage backends include YAML (default), SQLite, and MariaDB. Economy features are powered by Vault.

Tip: Configure the plugin in plugins/RedMart/config.yml. Messages are in plugins/RedMart/messages/.

Installation

  1. Place RedMart-1.0.jar and Vault (plus your economy plugin) into plugins/.
  2. Restart the server to generate config and messages.
  3. (Optional) Edit config.yml to pick storage backend, enable/disable displays, and configure tax.

Requirements

  • Minecraft 1.18.x
  • Java 17+
  • Vault + economy plugin (for currency features)

Storage Backends

  • YAML (default)
  • SQLite (bundled driver)
  • MariaDB (bundled driver; shaded & relocated)

Quick Start

  1. Create a sign with one of the supported formats (see “Sign Formats”).
  2. Right-click to buy, left-click to sell. Default cooldown is 250ms.
  3. Use /shop recolor to change sign colors.

Commands

/mart

/mart
  • Opens the in‑game Player GUI manager. See Player GUI.

/shop

/shop recolor <DyeColor|default> [glow|no-glow]
  • Recolor the targeted RedMart sign. default restores config default. Optional glow/no-glow.

/redmart

General

/redmart version
/redmart reload
/redmart index rebuild
  • version – show plugin version.
  • reload – reload config, messages, libraries, and economy hooks.
  • index rebuild – rebuild storage index (YAML/SQL) from disk.

Move

/redmart move here <world> <x> <y> <z>
/redmart move look <world> <x> <y> <z> [range]
/redmart move <fromWorld> <x> <y> <z> here
/redmart move <fromWorld> <x> <y> <z> look [range]
/redmart move <fromWorld> <x> <y> <z> <toWorld> <x> <y> <z>
  • Moves a shop from its current sign block to a new sign block.

Pedestal

/redmart pedestal open look [range]
/redmart pedestal open at <world> <x> <y> <z>
  • Opens a pedestal shop’s virtual inventory (if enabled in config). look targets the block you look at.

Shop (Admin)

/redmart shop info [look|at <world> <x> <y> <z>]
/redmart shop remove [look|at <world> <x> <y> <z>]
/redmart shop setprice <buy|sell> <price|none> [look|at <world> <x> <y> <z>]
  • info – show a panel with details.
  • remove – remove the targeted shop.
  • setprice – set or disable (none) buy/sell price of the targeted shop.

Displays

/redmart display cleanup
/redmart display reset [radius]
  • cleanup – remove stray item displays.
  • reset – despawn and respawn item displays around you (default radius 16).

Transactions Log

/redmart tx last [lines]
/redmart tx at [world] <x> <y> <z> [lines]
  • last – tail the most recent entries.
  • at – show entries for a specific location; world optional for players (uses current world).

Permissions

  • redmart.admin – Admin commands (default: op)
  • redmart.create.player – Create player shops (default: true)
  • redmart.create.admin – Create admin shops (default: op)
  • redmart.use.buy – Buy from shops (default: true)
  • redmart.use.sell – Sell to shops (default: true)
  • redmart.edit.any – Bypass protection (default: op)
  • redmart.remove.admin – Remove admin shops via shift+break (default: op)
  • redmart.shop.recolor – Use /shop recolor (default: true)
  • redmart.pedestal.open.any – Open any pedestal (default: op)
  • redmart.mart.open – Open Player GUI with /mart (default: true)

Configuration

Edit plugins/RedMart/config.yml. Below is a trimmed example with key sections:

storage:
  type: yaml            # yaml | sqlite | mysql
  sqlite:
    file: data/redmart.db
  mysql:
    host: localhost
    port: 3306
    database: redmart
    user: root
    pass: secret

interactions:
  right-click: buy
  left-click: sell
  cooldown-ms: 250

economy:
  enabled: true
  server-account: server
  tax:
    enabled: true
    buy-percent: 0.0
    sell-percent: 0.0
    refund-on-failure: true

logging:
  transactions:
    enabled: true
    rotate: daily

sign:
  text-color: ""
  glow-text: false

# Floating item displays
display:
  enabled: true
  type: dropped_item   # auto | item_display | dropped_item

# Pedestal virtual storage
pedestal:
  enabled: true
  rows: 3

Reminder: taxes apply to player shops only, not admin shops (by design).

Sign Formats

Legacy

[RedMart]
[buy|sell|both|admin]
<amount> x <item>
B:<price> S:<price>

Compact

[RedMart]
<amount or 64x>
<minecraft:item or hand>
B:<price>

Economy & Tax

  • Requires Vault + an economy plugin.
  • Tax applies to player shops only (not admin shops).
  • Configure under economy.tax in config.yml.
  • Players with redmart.tax.exempt ignore tax.

Floating Item Displays

  • Optional hologram-like item shown above the shop.
  • Choose item_display (Paper modern) or dropped_item.
  • Can be disabled globally.

Pedestal Shops (Virtual Inventory)

  • Virtual storage behind the sign—no chest needed.
  • Rows configurable via pedestal.rows.

Admin & Maintenance

  • /redmart reload – Reload config & messages
  • /redmart index rebuild – Rebuild internal index
  • /redmart move ... – Move shops (see usage help)
  • Transaction logs: plugins/RedMart/logs/

Troubleshooting

  • Vault missing: Install Vault and an economy plugin.
  • No space / No stock: Check linked chest or use pedestal shops.
  • Database issues: Review DB config; SQLite is recommended to start.

FAQ

Q: Does it work on Spigot & Paper? A: Yes. Built for 1.18.x and Java 17+.

Q: Can I change sign colors? A: Yes, via /shop recolor and config.

Q: Can I disable displays? A: Yes, set display.enabled: false.

Player GUI

RedMart includes an in‑game GUI for managing your shops. It focuses on editing existing shops without commands. Creation remains sign‑based.

Open & Permissions

  • Command: /mart
  • Permission: redmart.mart.open (default: true)

What You Can Do

  • My Shops – a paginated list of your shops with item, amount, prices, and location.
  • Edit Shop – adjust buy/sell prices and enable/disable each side.

Editing a Shop

  1. Run /mart and click a shop in the list.
  2. Use these actions:
    • Set Buy Price – prompts in chat to enter a number (e.g., 25.5).
    • Set Sell Price – prompts in chat similarly.
    • Toggle Buy – if enabled, click to disable; if disabled, click to enable (you’ll be prompted to enter a price).
    • Toggle Sell – same behavior as Buy.
  3. After changes, the shop’s sign text and its item display are refreshed automatically.

Price Entry (Chat)

  • Type a positive number to set the price (e.g., 25 or 25.00).
  • Type none to disable that side (buy/sell).
  • Type cancel to abort the change.

Notes

  • Only shop owners can edit their Player Shops. Admins with redmart.edit.any can edit any shop.
  • Creation stays sign‑based for clarity and compatibility with existing flows and templates.
  • The GUI uses a clean, color‑coded layout with background panes and clear labels.

Support

Open an issue or join our Discord for help: