Shopkeepers

Shopkeeper

This plugin allows you to 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.

Installation and Configuration

Simply download the latest file and put it into your plugins folder. When the plugin first loads, it will create a config.yml file in the Shopkeepers folder. There are several configuration options you can customize. See the Configuration Options page for more information.

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, etc.) will not work with this plugin.

Creating a Shopkeeper

To create an admin shopkeeper, just use the command /shopkeeper [object type] while looking at a block. A villager will be spawned at the block you are looking at.

To create a player shopkeeper, you will need a villager spawn egg (or whatever item is defined in the config file). You must not be in creative mode when creating a shopkeeper. First, you can right-click in air (not on a block) to cycle through the different shop types (normal, book, buying, and trading). You can also hold sneak while right-clicking to cycle through the shopkeeper types (villager, sign, witch, ..). Then, right click on a chest to select it, then right click on another block to place the shopkeeper at that location.

You can also create a player shopkeeper by using the /shopkeeper [shop type] [object type] command while looking at a chest, but this will make the shopkeeper stand on top of the chest.
If no shop type and no object type are specified in the command, then either your current selection (the one you made via right clicking with the creation item in hand) or the default will be used. Alternatively you can specify only [shop type], only [object type], or both.

Every shopkeeper villager's AI will be overwritten so it doesn't wander away, and it is invulnerable to damage. It will also teleport back to its spawn location after a few seconds if it gets bumped out of place.

The default available player shop types are: normal (alias sell), buy, trade, book.

Shop object types are the things which represent the shop in the world, ex. the villager entity by default.
The default available shop object types are: sign, citizen (alias npc), or the mob name for all currently supporte mob types.

Setting Up Trades (Admin Shopkeepers)

To modify the shop's trades, right-click on the shopkeeper while sneaking. This will open a regular-looking chest inventory, but it has a couple special icons on the right.

http://nisovin.com/shopkeepers/shopkeeper_admin_editor.png

Each column in the inventory represents a trade option. The top item is the first cost, the middle item is the second cost, and the bottom item is the item to sell. The top and bottom items are required, but the middle item (the second cost) is optional. You can simply drag your recipes into the inventory. You can input up to eight recipes on a shopkeeper.

Once you are done editing the trades, simply close the inventory window to save. Now just right click on the shopkeeper, and see the trades! It should work with any items, including enchanted items and written books.

To set the shop's name, click the anvil then type the name into the chat. You can cycle through the villager professions by clicking on the wool block. 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 Costs (Player Shopkeepers)

First, the player will need to place items they wish to sell in the chest. In order to sell written books you must use the special book shopkeeper (in this case, you must put the written books you want to sell in the chest, then stock it with book & quill items).

http://nisovin.com/shopkeepers/shopkeeper_player_chest.png

Then, right-click on the villager while sneaking. This will open up the shopkeeper editor. The top row will show the various item types for sale from the chest. The bottom row will show the costs of those items. If no cost has been specified yet, there will be a slimeball. To modify the cost, left-click the emerald (or slimeball) to increase the cost, and right-click to decrease the cost. You can also hold shift while clicking to modify the cost by 10 at a time. You can adjust the item quantity in the same way, with left and right clicks.

http://nisovin.com/shopkeepers/shopkeeper_player_editor.png

Once the costs are all set up, just close the window to save. You can also click the anvil to rename the shopkeeper, click wool block to cycle through the villager professions, and click the fire to delete the shopkeeper.

When a player purchases an item from a player shopkeeper, the item in the chest will be removed and the emeralds used to purchase will be added. Due to limitations in the game, the trades will not update even when a player purchases the final stack of a certain item. However, if a player attempts to make a purchase when the chest is out, the trade will fail and the trade inventory window will close automatically.

For the special "buying" shopkeepers, you must place at least one of each type of item you want to sell in the chest, as well as plenty of currency. Then when you open the editor interface, it works the same except the items are on bottom and the currency is on top. A buying shopkeeper can only buy basic items, not enchanted items, books, or maps.

Available mob types

Besides sign shops, there is currently only a limited number of mob shops available:
villager, chicken (those still lay eggs though), cow, creeper, iron_golem, mushroom_cow, ocelot, pig, sheep, skeleton, snowman, witch, wolf, zombie (burns in sun light)

Some of those might be disabled by default, so you will have to enable them first in the config. Also each of them can only be used if the player has the needed permission node: shopkeeper.entity.<mobtype> (or shopkeeper.entity.* for access to all mob types).
By default players are only able to create villager, witch or creeper shops (if those are not disabled).

For compatibility with older versions there exist alternative permission nodes for some mob types: shopkeeper.villager, shopkeeper.witch and shopkeeper.creeper

If you want to use other entity types you might want to try out citizens shopkeepers.

Citizens shopkeepers

There is experimental support for shopkeepers using citizens npcs (disabled by default).
The permission needed to create citizens player shops is: shopkeeper.citizen

You can create an admin citizens shopkeeper with the command /shopkeeper npc.
Alternatively there is a 'shopkeeper' trait which you can assign to already existing citizens, though creating the citizens with the above command is the recommended way of doing it.

Citizens admin shopkeepers will default to normal villagers as mob type. You will have to use the citizens commands to change the mob type of the npc.

Citizens player shopkeepers will automatically default to player-type npc's with the name of the shop owner. There is a configuration options which determines if player's are allowed to renamed those npc player shops (default: false).

Special Commands

Help

Using the /shopkeepers help command will display the available commands. Commands for which a player doesn't have the needed permission get filtered out.

Reload

You can use the /shopkeepers reload command to reload the plugin. This will save any changes and reload the config file.

Debug

Use /shopkeepers debug to toggle debug mode. This allows you to see sometimes useful information in the console.
Also there is a /shopkeepers checkitem command, which prints debug information about the item in hand, and the item in the next slot.

Transfer

Use /shopkeepers transfer playername to transfer ownership of a shopkeeper to another player. You must use this command while looking at a chest owned by a shopkeeper.

Hire

Use /shopkeepers setforhire to set a player shopkeeper for hire. Hold the hire cost in your hand, and look at a chest owned by a shopkeeper when you use this command. This will allow another player to pay the hire cost and gain ownership of that shopkeeper.

Permissions

PermissionDescriptionDefault
shopkeeper.adminCreate and modify admin shops.op-only
shopkeeper.debugAccess to the debug command.op-only
shopkeeper.bypassModify player shops that you do not own.op-only
shopkeeper.reloadUse the /shopkeeper reload command.op-only
shopkeeper.transferTransfer a shopkeeper to another player.op-only
shopkeeper.setforhireSets a shopkeeper to be up for hire.op-only
shopkeeper.tradeAllows trading with shopkeeperseveryone
shopkeeper.hireAllows a player to hire a shopkeeper.everyone
shopkeeper.player.normalCreate normal player shops.everyone
shopkeeper.player.bookCreate book-selling player shops.everyone
shopkeeper.player.buyCreate buying player shops.everyone
shopkeeper.player.tradeCreate item trading player shops.everyone
shopkeeper.playerAll player shops.
shopkeeper.entity.<mobtype>Create shopkeepers of the specified mob type
shopkeeper.entity.*Create all types of mob shopkeepers.
shopkeeper.entity.villagerCreate a villager shopkeeper.everyone
shopkeeper.entity.witchCreate a witch shopkeeper.everyone
shopkeeper.entity.creeperCreate a creeper shopkeeper.everyone
shopkeeper.signCreate a sign shopkeeper.everyone
shopkeeper.maxshops.<option>Check out the configuration options for this.none

Video Tutorials

A tutorial by KreatorB showing how to setup shops with the more recent versions

An old but good tutorial provided by TrowbridgeHD/RyanDT13

Frequently Asked Questions

Something's gone wrong! I have a problem! Will you please help me?

Submitting a ticket is the best way to get help or report a problem with the plugin. Please provide the version you are using of both Craftbukkit/Spigot and Shopkeepers, and thoroughly describe the problem you are having, including step-by-step instructions on how to reproduce the problem.

My shop isn't working! Why can't I buy stuff from my shop?

You cannot buy items from your own player shop. This restriction is in place to help reduce duplication bugs if and when they arise. It doesn't completely prevent them, but it helps keep them from being obvious.

A shop isn't working! I can't take the item out of the trade result slot!

The items offered for the trade probably don't match the required items. The plugin not only compares the item types but also additional internal data of the items like display names, lore, enchantments, data values / durability, attributes and all kinds of even more specific data for items like skulls, books, potions, fireworks, etc.
If you turn debug mode on you should get detailed information in the console log why certain trades failed.

Why don't colors seem to be working in the config? They seem to turn into weird characters!

You should try setting your file-encoding option in the config file. Set it to "UTF-8".

I can't use color codes for shopkeeper names!

Every time a shopkeeper is renamed the new name get validated first. The plugin uses a regular expression for this validation which you can find and edit in the config file. This regular expression specifies which characters can be used for the name and how long the name has to be at least and at maximum. By default this regular expression might not contain the color code character '&'. So in order to allow colors for shopkeeper names you have to add that character to the regular expression in the config.

Will you add support for currency plugins (integrate with Vault)?

No, sorry. The trade interface is really designed for item trades only. For example, the purchase item doesn't even show up until you've put in the item cost required. As an alternative, you could use another plugin to create some sort of bank, where you would buy and sell emeralds for virtual currency. In this way players could deposit and withdraw emeralds for shopping. You may also be interested in the plugin Gringotts or GoldIsMoney.

How can I get shopkeepers to spawn when some other plugin like WorldGuard blocks them?

You could first try if it works when you enable the setting 'bypass-spawn-blocking' in the shopkeeper config.
If that doesn't work you will have to search for a setting in the other plugin which allows disabling this spawn blocking.
WorldGuard for example has a configuration option to specify which mob types it blocks from spawning. The option is under mobs, called block-creature-spawn. If it is empty, you will need to add in all of the creature types you wish to block, making sure you leave out Villager. Another option is to set WorldGuard's block-plugin-spawning option (also under mobs) to false, but this may have other side effects.

Can I have more than eight trades on a shopkeeper?

I feel like eight trades is plenty to have on one shopkeeper, and that it would be best to set up multiple shopkeepers if you need to have more items for sale. However, if you insist, it is possible, just more work.

For player shopkeepers, it's actually fairly easy. The cost setup will show the first eight item types in the chest. So, just set up the costs for those items, then rearrange the items in the chest. You will then be able to set up the costs for the other items.

For admin shopkeepers, the only way is to modify the save.yml file and add the options manually. Please note that I do not support doing this. If you try to do this and mess up your save file, you'll have to fix it on your own. In my opinion, you shouldn't do this anyway. It is a lot more user-friendly to have multiple shopkeepers with various categories of items (probably indicated by nearby signs).

Can you instead just rebalance the regular villager trade options, or allow admins to configure what trades are possible with regular villagers?

There is another plugin that offers villager trade rebalancing as well as custom trade options, you can find it here: http://dev.bukkit.org/server-mods/rebalance-villagers/

Oh wise Nisovin, how can I create a successful economy?

I've actually put a bit of thought into this. You can read my opinions here.

I am a plugin developer: How can I check if a given entity is a shopkeeper?

Every shopkeeper entity should be tagged with the 'shopkeeper' metadata, so you can check for that.

Can I see the source code?

Certainly, here it is.

Changelogs

You can find all previously uploaded files together with their changelogs on the 'Files' page.

You must login to post a comment. Don't have an account? Register to get one!

  • Avatar of blablubbabc blablubbabc Mar 01, 2015 at 01:54 UTC - 0 likes

    @KhajiitV: Go

    For me this looks like you have not yet set up your shopkeeper. Read the descrition above on how to setup and edit the shopkeeper trades.

  • Avatar of KhajiitV KhajiitV Mar 01, 2015 at 01:30 UTC - 0 likes

    http://prntscr.com/6b5yq7

    What?? This looks NOTHING like what it said it does. Where is the villager plugin I was supposed to download?

  • Avatar of blablubbabc blablubbabc Feb 28, 2015 at 17:57 UTC - 0 likes

    @zto: Go

    The setup for the trading shopkeeper is not very intuitive:
    You have to click an item in your inventory and then click the slot in the editor view where you want to insert it. Then you can increase and decrease it's amount there by left and right clicking it.

  • Avatar of zto zto Feb 28, 2015 at 17:44 UTC - 0 likes

    don't know what fixed it but after multiple reloads and restarts it's working how it should. only issue now is the trade shops. i can put the items i want in the chest but i can't put a price into the shopkeeper inventory, it doesn't let me put anything in there.

  • Avatar of blablubbabc blablubbabc Feb 26, 2015 at 17:09 UTC - 0 likes

    @guyag: Go

    The setLocation() might not properly work currently until the next reload, if you move the shopkeeper into a different chunk. Even more noticeable if you move it into a chunk far away.

    @zto: Go I tested it with only /shopkeeper while looking at a chest and it worked fine for me: it created the player shopkeeper, I was able to put items into the chest and in the editor view of the shopkeeper I was then able to modify the costs.

    What do you see instead?

    Regarding additional command parameters:
    Shop and object type are optional. You can either specify nothing, then it might use the defaults, or your current selection. Or you specify the shop type, or you specify the object type, or you specify both.
    The possible shop types are: 'normal' (alias 'sell'), 'buy', 'trade', 'book'.
    The possible object (the object (ex. entity) representing the shopkeeper) types are: 'sign', 'citizen' (alias 'npc'), or the mob type name for every supported mob type.

  • Avatar of zto zto Feb 26, 2015 at 15:50 UTC - 0 likes

    i've enabled it in the config but it's still having the same problem, it doesn't want to use the chest.

    i think this is the problem for me: [shop type]

    are the names different than what i think they should be? i tried a bunch of variations and all of them come back as "unknown shop object type"

  • Avatar of guyag guyag Feb 24, 2015 at 20:23 UTC - 0 likes

    @blablubbabc: Go

    I've done something very similar - get all the shopkeepers in the chunk and match the UUID with the one I have stored. The setLocation() method seems to be working alright from my testing.

    BFAK:67855,fbd3bcc609922ca85d5c8c782298e322b1b06cd85bbefa81d458b00642cd7099

  • Avatar of blablubbabc blablubbabc Feb 24, 2015 at 16:51 UTC - 0 likes

    @guyag: Go

    The setLocation() method seems to be not fully implemented yet.. and getShopkeeperByUUID seems to be missing as well.
    For now you could store the shopkeepers chunk data and it's uuid (not entity uuid, but shopkeeper uuid), and then, on startup, use getShopkeepersInChunk(chunkdata) and search through that for a shopkeeper with the matching shopkeeper uuid and then remove and recreate the shopkeeper.

    @zto: Go

    Make sure that 'create-player-shop-with-command' is enabled in the config.

  • Avatar of guyag guyag Feb 24, 2015 at 16:24 UTC - 0 likes

    @blablubbabc: Go

    Interesting, thanks for the detailed explanation. What I'm trying to do here is move the villager to different places on server startup. Previously I was doing this by (trying to) despawn it on shutdown, and respawning it on startup. I seem to have overlooked the ShopKeeper.setPosition(Location) method though, which would be easier and much less roundabout... So now I'm storing the UUID myself and and trying to use the getShopkeeperByEntity method, but Chunk.getEntities() doesn't appear to include the villagers, which is where I'm now stuck.

  • Avatar of zto zto Feb 24, 2015 at 15:49 UTC - 0 likes

    i'm having problems with the /shopkeeper command while looking at a chest. it creates a shopkeeper but i'm not able to use the chest for the shop. it uses their own inventory and the currency items don't increase when something is bought. i dont know if this is bugged or anything.

Facts

Date created
Aug 03, 2012
Categories
Last update
Feb 13, 2015
Development stage
Release
License
GNU General Public License version 3 (GPLv3)
Curse link
Shopkeepers
Downloads
301,429
Recent files
  • R: v1.46 for 1.8 Feb 13, 2015
  • R: v1.45.1 for 1.8 Feb 06, 2015
  • R: v1.45 for 1.8 Feb 05, 2015
  • R: v1.44 for 1.8 Feb 03, 2015
  • R: v1.43 for 1.8.1 Jan 10, 2015

Authors