ShopDB Documentation

This page is an overview of the ShopDB documentation.

ShopDB is a Minecraft plugin and web application that allows players to easily search for chest shops to buy or sell from.

Feedback

Have a suggestion, or found a bug?

ShopDB has evolved significantly over the past two years thanks to the support of the community. If you have an idea, or find a bug, please share it on the forums. All feedback is welcomed and encouraged.

Integration

How is ShopDB updated?

Each time a player interacts with a chest shop, the chest shop data is captured and sent to ShopDB.
Interactions include:
  • A chest shop is created
  • A chest shop is opened
  • A chest shop is used
  • A chest shop is destroyed
After each interaction, the chest shop information (including the shop owner and region information) is sent to and updated in ShopDB in specified intervals. By default, shops are updated every ten minutes.

Usage

How can I add or remove my chest shops from ShopDB?

By default, all chest shops are hidden. Two criteria must be met for chest shops to be shown:

  • The chest shop must be in a WorldGuard region.
  • A region owner has listed the region.

To check if a chest shop is in a region, go to the chest shop in-game and type: /rg i.

To see if a region is listed, visit the regions page and search for it. Under the region name is an indication of whether or not it is listed. If the region is not displayed, ensure you have unchecked the 'Hide Unlisted' option.

It is also possible that the region is not yet in ShopDB. Regions are only sent to or updated in ShopDB after a chest shop within it has been interacted with, or after the region has been listed.

Listing a region

To list a region, run the command in-game /shopdb list <region-name>. You must be an owner to list the region. After a region is listed, all chest shops within it will be visible on ShopDB.

Unlisting a region

To unlist a region, run the command in-game /shopdb unlist <region-name>. You must be an owner to unlist the region. After a region is unlisted, all chest shops within it will be hidden on ShopDB.

Subregions

How are overlapping regions handled?

Sometimes regions overlap. For example, all the chest shops in the market are also in spawn. In ShopDB, chest shops are linked to only one region. In this case, the following criteria is used to select which region the shop likely belongs to:

  1. The region which is listed will be linked.
  2. If no region is listed, or both are listed, the smallest region will be chosen.

In most cases, this selection criteria results in the correct region being linked. However, if a region is chosen incorrectly, this can be resolved by the region owners by ensuring that only the correct region is listed. Then, chest shops will be correctly linked after interactions occur.

Equality

Which chest shops show up first?

The sorting criteria selected determines the order in which shops are listed. Best price, selected by default, sorts chest shops by the best value (cheapest per individual item sold, or most money offered per individual item purchased). However, many times players trade items for the same price as others.

In the case where the sorting criteria results in a tie, the results are randomized. This way, no chest shops are favored or listed higher than other chest shops.

Uniqueness

Where are my other 100 dirt chest shops?

To avoid filling search results with redundant chest shops, hide identical shops, enabled by default, filters out chest shops that have the same item, owner, region, and price. This can be disabled by unchecking the filter.

When the filter is enabled, the most available chest shop will be the unique shop selected and shown. When purchasing, this prioritizes shops with greater quantity. When selling, this prioritizes shops with the greatest space available.