Shopkeepers

Table of Contents

logo

Set up custom villager shopkeepers that sell exactly what you want them to sell and for what price. You can set up admin shops, which have infinite supply, and you can also set up player shops, which pull supply from a chest.

It will also prevent any other trades with non-shopkeeper villagers, if you want it to.

For those who are simply looking for a convenient way to modify the trades of vanilla villagers (as an alternative to using complex Minecraft commands), the plugin also includes a graphical editor for regular villagers and wandering traders.

Basic Features

Easily create villager shopkeepers that trade the items you want them to trade.
Admins shops with infinite supplies.
Player shops which pull supplies from a chest.
Different types of player shops: selling, buying, trading, and selling books.
Various supported mob types to represent your shopkeeper, sign shops, and Citizens (NPC) shops.
Editor for regular villagers and wandering traders.
Many configuration options.
Translatable messages.
Open source (Source code on GitHub)

Supported server versions

Shopkeepers supports the latest versions of Bukkit / Spigot.
Note that this plugin is created to work with CraftBukkit (or alternatively Spigot). Bukkit does not have an API for some of the things necessary to make this plugin work. This means that other server software (Tekkit, Forge, Cauldron, etc.) will not work with this plugin.
Other CraftBukkit or Spigot derivatives/forks might work, but are not officially supported. So if you run into issues while using those, try to reproduce your issue on a fresh and up-to-date Spigot server first.

Getting started

All documentation can be found in the wiki:

Showcase

Admin shops:

Configure the trades via the in-game inventory menu:

setup-admin-shop-text

Resulting trading menu:

setup-admin-shop-result

Player shops (ex. selling items):

Fill the shop chest with supplies:

Configure the trades via the in-game inventory menu:

Resulting trading menu:

Video Tutorials

More video tutorials can be found in the wiki: https://github.com/Shopkeepers/Shopkeepers-Wiki/wiki/Video-Tutorials

Tutorial by Donnie, explaining the setup of the different shop types:

Tutorial by Fan Staaff showing the setup of the different shop types in detail:

Tutorial by LastKing2X,showing the setup of the different shop types:

Spanish tutorial by Ajneb97, also mentioning placeholder items and various config options:

Statistics

This plugin uses bStats to collect anonymous plugin usage statistics. This helps me to determine how many servers are using the plugin, which Minecraft versions it is used with the most, and to which degree the different features are used.

Here is a list of all currently tracked information:

Common information: The number of servers using the plugin, the number of players on these servers, online mode, Minecraft version, plugin version, core count, system arch, operating system, server country, Java version.
Shopkeepers specific information: Whether specific related plugins are used (Citizens, Towny, WorldGuard, Gringotts, other Vault economy plugins), number of shops, whether player shops are used, whether certain features are enabled in the config (ex. WorldGuard/Towny compatibility, Citizens shops, delayed saves, colored names, chest protection, removal of inactive shops, tax rate, strict item comparison, purchase logging, disabling of other villagers, ..), the number of worlds containing shops.
All information can be publicly viewed here: https://bstats.org/plugin/bukkit/Shopkeepers/

If you want to disable bStats for all plugins on your server, edit the file plugins/bStats/config.yml, or alternatively disable it only for Shopkeepers by setting 'enable-metrics' to 'false' inside the Shopkeepers config.

Known potential issues

A list of known potential issues of the latest version of Shopkeepers can be found in the wiki: This documents differences between Minecraft/Spigot versions, and existing Minecraft/Spigot issues related to Shopkeepers.

If you run into an issue, check if this list already contains and maybe offers information on how to handle it.

Have issues or further questions?

If you have a pressing issue or simple question, you can join the discord server and ask other plugin users for help:

But submitting a ticket is the best way to get help or report a problem with the plugin.

Before submitting a ticket:

Check if your question is already answered in:
- The documentation (wiki).
- The FAQ.
- The Known Issues.
Check if there is already another ticket for your issue.

Before reporting an issue:

Try to reproduce your issue when using:
- The latest versions of Spigot and Shopkeepers.
- No other plugins.
- No kinds of other server or client mods.

When reporting an issue:

Provide the versions you are using of Minecraft, Spigot and Shopkeepers.
Provide a detailed description of your problem and add as much information as possible which could help reproducing the issue.
If possible, include step-by-step instructions on how to reproduce the issue on a fresh Spigot server.

Donations

If you like this plugin, consider supporting its developers by making a donation:

To blablubbabc (current maintainer: Dec 2013 - today)
To nisovin (former author: Aug 2012 - Dec 2013)

A big "thank you" to everybody who is keeping the motivation up through donations!

Minecraft-Servers-Listing.com	TRS Game Servers	terminalserver.us
Minewind	mercurialmusic	timitimitimi
FatherWh0 (merchantvillages.com)	lukeeexd (tws-mc.com)	PapaJuan
EmeraldHaze (Ninjalette)	Espen	kbtalkin
Dimo (Beyond Vanilla)	RefugiaCraft	Frilioth
Tabletopcheese	Observant Minecraft Server	Ren B.
BadWolfMC	Michael M.	Alejandro A.
Michael B.

Want to help?

Whether you are a programmer or not, there are many ways in which you can contribute! For example:

Help users with issues and questions on Github, Discord, or the comment section.
Create and update translations.
Keep the documentation (the wiki) up-to-date with plugin updates.
Write or maintain add-on plugins (see the open Github issues).

If you are interested or have other ideas on how you can contribute, feel free to contact me via PM.

Add-On Plugins

Sometimes, a feature is either to specific to include directly into the Shopkeepers plugin, or I did not yet have the time to add something similar myself. You can find a list of both official and third-party add-on plugins that extend the functionality of the Shopkeepers plugin in the wiki: https://github.com/Shopkeepers/Shopkeepers-Wiki/wiki/Add-On-Plugins

If you have also written an add-on plugin that you want to add to the list, let me know!

Comments

blablubb
- Join Date: 5/29/2012
- Posts: 3,207
- Member Details
#3164 blablubb

View User Profile

Send Message

Posted Jun 7, 2019
In reply to The_ApolloGaming:

"I'm using shopkeeper 2.7.0 because 2.7.1 I had the issue where I was just taking the items also. And I'm using the most recent version of spigot (1.14.2)."

I just tested v2.7.1 with the latest version of Spigot and I cannot reproduce any of these mentioned issues, neither with the admin nor the player shopkeeper. Also, the changes in v2.7.1 should have no impact on the shopkeeper trading or editor behavior.. If they do then I suspect that you might not be using the latest version of Spigot, or you are not using Spigot at all (maybe you are using Paper instead?).

Can you post the exact Spigot version you are using (output of /version command)? The command should also tell you if you are not up-to-date.

The latest version right now is: git-Spigot-baafee9-7cc7719

Also make sure that you try to reproduce your issue(s) without any other plugins on the server, to ensure that the issue isn't caused by interference between different plugins.

Last edited by blablubb: Jun 7, 2019

Rollback Post to Revision RollBack
florenthz96
- Join Date: 12/25/2016
- Posts: 36
- Member Details
#3159 florenthz96

View User Profile

Send Message

Posted Jun 6, 2019
Hi there...

Im using v2.7.1 for Spigot 1.14.2 and there is a problem, when I select an option (an item) in the menu of the shopkeeper, nothing happens... I only take the item and I can take it to my inventory...

Greetings friend

Rollback Post to Revision RollBack
blablubb
- Join Date: 5/29/2012
- Posts: 3,207
- Member Details
#3160 blablubb

View User Profile

Send Message

Posted Jun 6, 2019
In reply to florenthz96:

Can you create a ticket and explain there step by step which item you are clicking/picking up (editor option item, trade setup item, trading item)? What type of shopkeeper are you having this issue with (admin, selling, buying, trading, book)? Maybe attach some screenshot for clarification.

Last edited by blablubb: Jun 6, 2019

Rollback Post to Revision RollBack
Forge_User_90545625
- Join Date: 6/24/2019
- Posts: 5
- Member Details
#3184 Forge_User_90545625

View User Profile

Send Message

Posted Jul 2, 2019
In reply to florenthz96:

Same thing happening to me, hopefully he can fix it cause this plugin is amazing

Rollback Post to Revision RollBack
blablubb
- Join Date: 5/29/2012
- Posts: 3,207
- Member Details
#3158 blablubb

View User Profile

Send Message

Posted May 28, 2019
v2.7.1 for MC 1.14.2

Checkout the changelog of v2.7.0 regarding the update to MC 1.14.

Fix: Shopkeeper mobs sensing cache is never cleared, resulting in them not looking towards nearby players sometimes.

v2.7.0 for MC 1.14.2

This version is marked as 'beta' since Spigot for MC 1.14 is itself still in development and potentially unstable.

Update for MC 1.14:

Dropped support for MC 1.13. This version only supports MC 1.14.2!

If you are upgrading, make sure that you have successfully updated Shopkeepers to 1.13 first. Migration from older MC versions are not supported and might not work. Reverting to older versions isn't supported either.

Removed pre 1.13 sheep color migration.

Villager shopkeepers:

Changed default profession from farmer to 'none'.

Priest villagers get converted to 'cleric' and blacksmiths become 'armorer'. Previous regular farmer villagers stay farmers (but they look differently now).

Changed the items representing the villager professions in the editor.

Note: Wandering traders are not a villager sub-variant, but a different mob type.

Ocelot shopkeepers of cat types have been converted to corresponding cat shopkeepers.

You might have to adapt your players' permissions, since cat and ocelot shopkeepers require different permissions now. With this migration players can end up with cat shopkeepers even though they don't have the permission to freshly create those if they wanted.

The different cat types are represented by colored leather armor inside the editor.

Added separate settings for disabling trading, spawning and allowing hiring of wandering traders.

When preventing wandering traders from spawning, trader llamas are prevented from spawning as well.

When a wandering trader is hired, its llamas will remain in the world (just like it is the case when the wandering trader dies).

Internal: Spigot is no longer calling creature spawn events for entities that get spawned as part of chunk generation. If spawning of regular villagers or wandering traders is disabled, these get removed during the corresponding chunk load event now.

Added: Sign shops can now switch between different wood types.

Added all new 1.14 mobs to the by default enabled mobs. If you are updating you will have to manually enable them in the config.

Other changes:

Changed: When spawning of villagers or wandering traders is disabled, villagers and wandering traders spawned by other plugins, spawn eggs, mob spawners or due to curing zombie villagers are still allowed to spawn now.

Added a separate setting 'disable-zombie-villager-curing' (default: false) that can be used to prevent curing of zombie villagers.

Made shop and object type matching more strict. This uses a fixed list of internal aliases now.

Removed the generic 'sub type' editor option in favor of letting each shop object supply a list of editor options. This allows living shopkeepers to provide multiple editor options now.

API: Removed getSubTypeItem, cycleSubType and equipItem from ShopObject. Editor options are internal API for now, and mob equipment hasn't properly worked already before due to not getting persisted.

Added new mob attribute editor options:

All ageable mobs (except the wandering trader and parrots) and all zombies (zombie, husk, drowned, pig zombie, zombie villager): Baby variant. Previously this options was only available for zombie and pig zombie shopkeepers. The editor item for this option is a regular chicken egg now.

Zombie villager: Villager profession.

Sheep: Sheared state.

Cat: Collar color.

Villager: Biome type and level.

Fox: Variant, crouching and sleeping state.

Wolf: Collar color, angry state.

Parrot: Color and sitting state.

Chested horse (Donkey, Llama, Mule, TraderLlama): Carrying chest state.

Horse: Color, style and armor.

Llama: Color and carpet color.

Panda: Genes (appearance).

MushroomCow: Variant.

Pig: Saddled.

Added the ability to cycle the editor options back and forth via left and right clicking.

Updated for the latest WorldGuard changes. You will have to update WorldGuard for the WorldGuard integration to work.

The 'allow-shop' flag got removed from WorldGuard itself and it is left for other plugins to register it themselves. Shopkeepers will now attempt to register this flag, if no other plugin has registered it yet (one such other plugin is for example ChestShop). Since WorldGuard only allows registering flags before it got enabled, but we are loading the config at a later point, we will always attempt to register the flag, even if the WorldGuard integration is disabled in the config.

Removed: We no longer check for the alternative 'enable-shop' flag, if the 'allow-shop' flag is not present.

Fixed a class loading issue in case the WorldGuard integration is enabled but WorldGuard is not present.

Fix: Sign shops no longer temporarily load the chunk when checking if they are active.

Internal changes:

Villagers store their profession under 'profession' now. Previous values under 'prof' get imported.

Fixed a minor internal inconsistency with the updating of trades: Trades were updated on the client, but the server was left in the previous state (mostly affected debug messages).

Removed special handling of item damage tags from item comparison. Spigot has made some changes that should make this obsolete.

Moved common de/serialization and validation code of shop object properties into new Property classes.

Config changes (if you are updating, you have to manually apply those changes):

Enabled various mobs by default now, which previously had some issues but seem to work fine now: Horse, mule, donkey, skeleton horse, zombie horse, llama.

Changed the default value for the setting enable-chest-option-on-player-shop to 'true'.

Message changes (if you are updating, you have to manually apply those changes): See the full changelog for a detailed overview.

Known potential issues: See here.

Donations

If you like this plugin, consider making a donation.

Thanks!

Thanks to all donations since the last update:

Minewind
Last edited by blablubb: May 30, 2019

Rollback Post to Revision RollBack
Raptor4694
- Location: The Aether
- Join Date: 8/7/2012
- Posts: 1
- Member Details
#3169 Raptor4694

View User Profile

Send Message

Posted Jun 10, 2019
In reply to blablubb:

I am using the latest 1.14.2 version, and when I try to change the villager's profession, it does not update. The item in the GUI changes, but the villager itself remains a default villager. I can change the villager types, but not their profession. The profession gets saved into the save file, but even reloading the plugin does not change the villager's visual profession.

Rollback Post to Revision RollBack
blablubb
- Join Date: 5/29/2012
- Posts: 3,207
- Member Details
#3170 blablubb

View User Profile

Send Message

Posted Jun 10, 2019
In reply to raptor4694:

Changing the profession works fine for me.

Are there any errors inside the server log?

Can you paste the exact version of Spigot you are using (output of /version) and ensure that you are on the latest version of Spigot?

Also, try without other plugins to ensure that no other plugin is somehow interfering.

And if nothing helps: Try to reproduce the issue on a completely fresh server/world with the default configuration of Shopkeepers.

Edit: Also ensure that you don't have selected the baby villager, since there are no professions for baby villagers..

Last edited by blablubb: Jun 10, 2019

Rollback Post to Revision RollBack
SpigotSlimeDog
- Location: Lafayette
- Join Date: 4/2/2015
- Posts: 168
- Member Details
#3155 SpigotSlimeDog

View User Profile

Send Message

Posted May 25, 2019
Please update to support Spigot 1.14.1. Many things have changed since March 4th. Shopkeepers is trying to run in "compatibility mode" but there are many issues. For examples:

/shopkeepers reload throws exceptions

Shopkeepers does not recognize 1.4 villager professions, reverting them to FARMER

GUI editor throws exception and fails to perform tasks
Last edited by SpigotSlimeDog: May 25, 2019

Rollback Post to Revision RollBack
blablubb
- Join Date: 5/29/2012
- Posts: 3,207
- Member Details
#3156 blablubb

View User Profile

Send Message

Posted May 27, 2019
In reply to SpigotSlimeDog:

Shopkeeper's compatibility mode cannot deal with backwards incompatible changes/issues, which are to be expected from a major update such as MC 1.14 and development build of Spigot. In general, I don't recommend running Shopkeepers on versions which it does not explicitly support. Each individual version of Shopkeepers mentions the supported minecraft versions: https://dev.bukkit.org/projects/shopkeepers/files

I have updated Shopkeepers for MC 1.14 shortly after Spigot released their first development builds (https://github.com/Shopkeepers/Shopkeepers/commit/f6bc00e5af0c7e9e9512ff8be586c3e890e09725).

However, there have been chunk loading related issues in Spigot (and Minecraft) which prevented Shopkeepers from functioning correctly on these development builds (eg. https://hub.spigotmc.org/jira/browse/SPIGOT-4752). In particular, this issue led to Shopkeeper entities duplicating, which is why I did not publish the update yet.

A snapshot of the Shopkeeper update has been available since early may (https://github.com/Shopkeepers/Shopkeepers/issues/562#issuecomment-490683136) for people interested in experimenting with it regardless of these issues.

These issues have only recently (2 days ago) been fixed in Spigot. I still have to verify that the updated Shopkeepers now properly works on Spigot 1.14.1 and will then publish the update here.

However, there is no guarantee that things will work properly if you have been running an incompatible or snapshot version of Shopkeepers on your 1.14.x server.

Rollback Post to Revision RollBack
SpigotSlimeDog
- Location: Lafayette
- Join Date: 4/2/2015
- Posts: 168
- Member Details
#3157 SpigotSlimeDog

View User Profile

Send Message

Posted May 27, 2019
In reply to blablubb:

OK, thanks. I will await developments (and releases) patiently.

Rollback Post to Revision RollBack
natkungtv
- Join Date: 5/20/2019
- Posts: 1
- Member Details
#3150 natkungtv

View User Profile

Send Message

Posted May 19, 2019
Hello Why i use /shopkeeper npc (for Citizen) it's not default player type it's Villager type,

and because Villager type Shopkeeper can walk.

Rollback Post to Revision RollBack
blablubb
- Join Date: 5/29/2012
- Posts: 3,207
- Member Details
#3152 blablubb

View User Profile

Send Message

Posted May 20, 2019
In reply to natkungtv:

It will be a player npc by default if you create a player shop. If you create an admin shop, you can easily change the npc type via citizens commands.

> because Villager type Shopkeeper can walk

They shouldn't. If they do then either its a Citizens issue, or you are not actually creating a citizens npc (maybe not even a shopkeeper at all). Or you are running with an unsupported server version (eg. 1.14) that has an issue which causes this.

Rollback Post to Revision RollBack
towny01
- Join Date: 5/19/2019
- Posts: 2
- Member Details
#3149 towny01

View User Profile

Send Message

Posted May 19, 2019
Hello, is there a way to give multiple players access to the same villager?

Rollback Post to Revision RollBack
blablubb
- Join Date: 5/29/2012
- Posts: 3,207
- Member Details
#3151 blablubb

View User Profile

Send Message

Posted May 20, 2019
In reply to towny01:

Nope.

Rollback Post to Revision RollBack
towny01
- Join Date: 5/19/2019
- Posts: 2
- Member Details
#3153 towny01

View User Profile

Send Message

Posted May 20, 2019
In reply to blablubb:

you should make it an option so that multiple people can own and operate the same shop!

Rollback Post to Revision RollBack
blablubb
- Join Date: 5/29/2012
- Posts: 3,207
- Member Details
#3154 blablubb

View User Profile

Send Message

Posted May 20, 2019
In reply to towny01:

There is an open featur request ticket for this: https://github.com/Shopkeepers/Shopkeepers/issues/342

Maybe elaborate there on how this feature could look like and work in detail.

Rollback Post to Revision RollBack
Forge_User_23917930
- Join Date: 1/24/2018
- Posts: 22
- Member Details
#3147 Forge_User_23917930

View User Profile

Send Message

Posted May 14, 2019
Can we expect a 1.14.1 version?

Rollback Post to Revision RollBack
blablubb
- Join Date: 5/29/2012
- Posts: 3,207
- Member Details
#3148 blablubb

View User Profile

Send Message

Posted May 14, 2019
In reply to Forge_User_23917930:

There is a snapshot version: https://github.com/Shopkeepers/Shopkeepers/issues/562#issuecomment-490683136

But some spigot issue is preventing shopkeepers from working properly currently.

Rollback Post to Revision RollBack
zaino60
- Join Date: 5/9/2019
- Posts: 5
- Member Details
#3145 zaino60

View User Profile

Send Message

Posted May 13, 2019
Please make the plugin compatible with SilkSpawners (https://www.spigotmc.org/resources/silkspawners-★-1-12-2-ready-★-1-million-downloads-★.7811/). Currently if you set a player shop it resets the price of the spawners after the plugin reloads!

Rollback Post to Revision RollBack
blablubb
- Join Date: 5/29/2012
- Posts: 3,207
- Member Details
#3146 blablubb

View User Profile

Send Message

Posted May 13, 2019
In reply to zaino6072557:

Might be a spigot item serialization issue (the item saved item no longer matching the original item after loading it again), or SilkSpawners creates unnormal items that get normalized during serialization/deserialization.

In either case: Please create a ticket over at github and provide detailed reproduction instructions regarding how you have configured SilkSpawners, how to create the spawner item, what type of shop you setup, and which versions of Shopkeepers, SilkSpawners and Spigot you are using.

Last edited by blablubb: May 13, 2019

Rollback Post to Revision RollBack
To post a comment, please login or register a new account.