Editing Shops - Shopkeepers/Shopkeepers-Wiki GitHub Wiki

Once you have created your shop (admin or player), there are various actions you can perform to either customize your shop further, or delete it again. This page describes how editing of shops works in general, and what the available actions common to all shop types are.

Opening the "Editor Window"

By right-clicking on the shopkeeper while sneaking, you can open the shop's "Editor Window". This will look like a regular chest inventory, but it has a couple of special icons. Those represent buttons you can click to perform certain actions on the shopkeeper.

Example of the (empty) admin shop editor window:
images/setup/admin-shop-editor-empty.png

Renaming the shop

To set the shop's name, click the name tag and then type the new name into the chat.

The new name is validated according to the name-regex setting: This regular expression specifies the allowed characters, as well as the allowed minimum and maximum length of the name.

If wanted, the server admin can modify this name-regex setting by adding & and § to the list of allowed characters in order to allow the use of &-based color and formatting codes in shopkeeper names: For example, &cName will then result in a red Name.

Is is also possible to use hex color codes, either via Bukkit's hex format (&x&a&a&b&b&c&c), or using the more compact hex format (&#aabbcc). Internally, since Spigot only supports the Bukkit hex format in a few contexts, any user-specified compact hex color codes are automatically converted to the Bukkit hex format before the name is validated and applied to the shopkeeper.

Be aware that color codes count towards the maximum length of the shopkeeper name.

Changing the object variant

Some shop object types provide multiple variants you can select from inside the editor window. For example, for a villager shopkeeper you can cycle through the various villager professions and biome types by clicking the corresponding items.

Moving the shop

To move the shopkeeper to another location, click the enderpearl. The editor closes and you can then right-click a block to place the shopkeeper there. You can abort the action by left-clicking.

When you right-click a block to place the shopkeeper, we ignore interactions with some types of blocks that are relevant for navigation, such as doors, trap doors, fence doors, buttons, levers, etc. Other types of interactable blocks (work benches, chests, signs, etc.) are not ignored, because we want shopkeepers to be placeable against those (even if some plugins may use them for navigation purposes, e.g. command signs).

The shopkeeper is only moved if the clicked location is a valid spawn location, which depends on the shopkeeper and shop object type. The same placement restrictions apply as when you initially placed the shopkeeper: For example, player shopkeepers can only be placed in a certain radius around the shop container.

The moving of player shopkeepers can be disabled via the config setting enable-moving-of-player-shops.

Moving the shopkeeper also allows you to rotate it, as it is the case when you freshly created the shopkeeper: The placed shopkeeper will be rotated to face towards you. However, it is currently not possible to rotate the shopkeeper 'in-place', i.e. without first moving it to another location.

When sign post shopkeepers are enabled inside the config, moving a sign shop object will convert it between the sign post and wall sign variant depending on the block face you clicked.

Deleting the shop

If you want to delete the shopkeeper, you can click on the bone in the bottom-right corner. Be careful, there is no undo!

Setting up trades

The setup of trades works differently for each shop type. Information on that can be found at Admin Shop Setup and Player Shop Setup.