Skip to main content

Shop Directory

Let players find what they're looking for without wandering the map. The Shop Directory pulls live data from your server's QuickShop database and surfaces it as a searchable directory — available on the website at /shopdirectory and in Discord via /shopdirectory.

note

📸 Screenshot: The /shopdirectory page showing a grid of shops filtered by material, with seller names, prices, and coordinates


For Players

Browsing on the Web

Go to /shopdirectory to browse all listed shops. You can search and filter by:

  • Material — the item type being bought or sold
  • Type — whether the shop is buying or selling

Each listing shows the seller's username, item quantity, price, stock status, and in-game coordinates so you can navigate directly to the shop.

Browsing in Discord

Use the /shopdirectory command to search from Discord:

/shopdirectory material:<item> [type:buying|selling]

Results appear as a paginated embed showing up to 8 shops per page. Use the navigation buttons to browse through pages. The most common item in the results is shown as the embed thumbnail.

note

📸 Screenshot: The /shopdirectory Discord embed showing paginated shop results with prices and coordinates


For Staff

Setup

The Shop Directory reads directly from your QuickShop database. To enable it:

  1. Set QUICKSHOP_URL in .env to your QuickShop MySQL connection string:
    QUICKSHOP_URL=mysql://user:password@host:3306/quickshop_database
  2. Enable the feature in features.json:
    "shopdirectory": true

No additional configuration is required. The directory updates in real time from the live QuickShop database.

tip

The Shop Directory is read-only — it never writes to your QuickShop database.


Feature Toggle

"shopdirectory": false

Disabling this removes the /shopdirectory web page and disables the /shopdirectory Discord command.