Bukkit

v2.23.0 for MC 1.21.1, 1.21, 1.20.6

I only list the primary changes here. For information on API changes, internal changes, and changes to the language files, you can find the complete changelog on Github: https://github.com/Shopkeepers/Shopkeepers/blob/master/CHANGELOG.md

• Update for MC 1.21.1.
• Drop support for MC versions below 1.20.6 to update the plugin to use Java 21 and build against a more modern API version. If you want to run this plugin on an older server version, you need to use an older plugin version.
• Item display name and lore data from the language file can be specified as Json text now. Other text does not yet support the Json format.
• Fix: Color codes in text (e.g. from the language file) did not reset formatting.
• Fix: Item data containing attribute modifiers was not correctly saved to the plugin config and failed to load.
• Extend the item stack we use for server assumption tests to include newer item data.
• Update the compatibility mode.

Known potential issues: See here.

Donations

If you like this plugin, consider making a donation.

Thanks!

v2.22.3 for MC 1.21, 1.20.6, 1.20.4, 1.20.2, 1.20.1, 1.19.4, 1.18.2, 1.17.1, 1.16.5

I only list the primary changes here. For information on API changes, internal changes, and changes to the language files, you can find the complete changelog on Github: https://github.com/Shopkeepers/Shopkeepers/blob/master/CHANGELOG.md

• Fix: Compatibility with the latest versions of Spigot 1.21 (Thanks @DerMistkaefer).
  • Spigot 1.21 builds from before 2024-07-07 are not supported.
  • Spigot's `enum-compatibility-mode` is not supported, but also not required for this plugin.

Known potential issues: See here.

Donations

If you like this plugin, consider making a donation.

Thanks!

v2.22.2 for MC (1.21,) 1.20.6, 1.20.4, 1.20.2, 1.20.1, 1.19.4, 1.18.2, 1.17.1, 1.16.5

Update: Some change in Spigot 1.21 broke this version of the Shopkeepers plugin. This version only works on Spigot versions from before 2024-07-06.
I only list the primary changes here. For information on API changes, internal changes, and changes to the language files, you can find the complete changelog on Github: https://github.com/Shopkeepers/Shopkeepers/blob/master/CHANGELOG.md

• Add: Equipment editor for shopkeeper mobs and normal villagers.
  • The equipment editor can be opened from the shopkeeper editor, as well as from the editor for normal villagers. There is no equipment editor for Citizens NPC shopkeepers yet.
  • Players can also use placeholder items to setup the equipment items.
  • As before, to reduce the amount of entity combust events that we need to handle, we automatically apply a small (invisible) default head item for mobs that usually burn in sunlight. If a custom head item is configured inside the editor, the item from the editor is used instead. If the configured item is destructible, it is automatically made unbreakable to not break when exposed to the sunlight.
  • By default, the equipment can only be edited for mobs and slots that are known, at least for certain items, to visually affect the mob.
    • If the mob is not affected by any equipment, the editor option is omitted.
    • If a mob already provides dedicated editor buttons for certain equipment slots (e.g. horse armor, llama carpet), we omit these slots from the equipment editor.
    • Vindicators currently don't support the mainhand slot, because they only render the item when chasing a target, which is not the case for shopkeeper mobs.
  • Config: Add setting enable-all-equipment-editor-slots (default: false) that enables the equipment editor for all mobs and all equipment slots, regardless of which equipment slots the mob actually supports.
    • This can for example be useful for testing purposes.
    • If the mob provides dedicated editor options for certain equipment slots, any non-empty equipment configured in the equipment editor takes precedence.
  • Command: The /shopkeeper replaceAllWithVanillaVillagers command ignores the custom equipment for now, because vanilla villagers can end up dropping the equipped items, e.g. on death, which might not be intended.
  • Debug: Extend the /shopkeeper debugCreateShops command to accept an argument testEquipment: When specified, we spawn a shopkeeper for each enabled mob type and apply a default equipment. This can be useful to quickly test which equipment slots the individual mobs support.
• Add: Configure the carried block of endermans by assigning an item to their mainhand in the equipment editor.
  • Only items with a corresponding block type result in a block to be carried by the enderman.
  • Players can also use placeholder items to specify the block type. This also allows players to use block types for which there doesn't exist a corresponding item (e.g. potted flowers).
  • Any block state data contained by the item (BlockStateTag / block_state component) is applied to the carried block. If the item is a placeholder item, any contained block state data is applied to the substituted block type.
  • Note: Some blocks do not properly render (e.g. player heads, signs, etc.).
• Debug: The command /shopkeeper debugCreateShops spawns the shopkeepers now in the direction the player is facing.
• Minor changes related to the trading shop editor. Players can now click a non-empty slot in their inventory to swap the item on the cursor.

Known potential issues: See here.

Donations

If you like this plugin, consider making a donation.

Thanks!

v2.22.1 for MC 1.21, 1.20.6, 1.20.4, 1.20.2, 1.20.1, 1.19.4, 1.18.2, 1.17.1, 1.16.5

I only list the primary changes here. For information on API changes, internal changes, and changes to the language files, you can find the complete changelog on Github: https://github.com/Shopkeepers/Shopkeepers/blob/master/CHANGELOG.md

• Fix: Since Spigot 1.20.5, snowman and mushroom cow shopkeepers failed to load because these mobs have been renamed to their Minecraft names ('SNOW_GOLEM' and 'MOOSHROOM').
  • When running on MC 1.20.5 or above, we automatically migrate these shop object types to their new names so that they load again.
  • Config: When updating to MC 1.20.5 or above, the old mob names in the `enabled-living-shops` setting might still work for now, but it is recommended to update them to their new names. We log a warning now should the old mob names no longer be recognized in the future.
  • Config: The default config was updated to use the new mob names. When running on an older server version, this results in a warning now, similar to the warnings that are logged for any default enabled mob types that are not supported by the server's Minecraft version.
  • Adjusted the shop object type aliases so that the `/shopkeeper` command recognizes both the old and new mob names.
• Fix: In Shopkeepers v2.22.0, after a server upgrade, some shopkeepers failed to load with an error `Invalid trade offer 1: Failed to load property 'resultItem': Data is not of type ItemStack, but com.nisovin.shopkeepers.util.inventory.SKUnmodifiableItemStack!`.

Known potential issues: See here.

Donations

If you like this plugin, consider making a donation.

Thanks!

v2.22.0 for MC 1.21, 1.20.6, 1.20.4, 1.20.2, 1.20.1, 1.19.4, 1.18.2, 1.17.1, 1.16.5

I only list the primary changes here. For information on API changes, internal changes, and changes to the language files, you can find the complete changelog on Github: https://github.com/Shopkeepers/Shopkeepers/blob/master/CHANGELOG.md

• Fix: Resolve a compatibility issue with Paper servers for MC 1.21.

Known potential issues: See here.

Donations

If you like this plugin, consider making a donation.

Thanks!

v2.21.0 for MC 1.21, 1.20.6, 1.20.4, 1.20.2, 1.20.1, 1.19.4, 1.18.2, 1.17.1, 1.16.5

I only list the primary changes here. For information on API changes, internal changes, and changes to the language files, you can find the complete changelog on Github: https://github.com/Shopkeepers/Shopkeepers/blob/master/CHANGELOG.md

• Update for MC 1.21. Add bogged and breeze to the by default enabled mob types.
• Debug: Add additional debug output if one of the item related server assumption tests fails.
• For developers: The Maven repository URL has changed (see Github readme). The old URL will still work for now, but consider updating to the new URL as soon as possible.

Known potential issues: See here.

Donations

If you like this plugin, consider making a donation.

Thanks!

v2.20.1 for MC 1.20.6, 1.20.4, 1.20.2, 1.20.1, 1.19.4, 1.18.2, 1.17.1, 1.16.5

I only list the primary changes here. For information on API changes, internal changes, and changes to the language files, you can find the complete changelog on Github: https://github.com/Shopkeepers/Shopkeepers/blob/master/CHANGELOG.md

• Fix: Avoid adding empty item stacks to merchant recipes. This resolves a crash on Paper 1.20.6 servers.
• Fix: The default config version is `6`. We previously applied a redundant migration from version 5 to 6 that did nothing.

Known potential issues: See here.

Donations

If you like this plugin, consider making a donation.

Thanks!

v2.20.0 for MC 1.20.6, 1.20.4, 1.20.2, 1.20.1, 1.19.4, 1.18.2, 1.17.1, 1.16.5

I only list the primary changes here. For information on API changes, internal changes, and changes to the language files, you can find the complete changelog on Github: https://github.com/Shopkeepers/Shopkeepers/blob/master/CHANGELOG.md 

• Update for MC 1.20.6:
  • MC 1.20.5 was replaced and is not supported.
  • Add wolf variants.
  • Placeholder items: Some potion and enchantments have been renamed in Bukkit to now match their Minecraft counterparts. If you used the Bukkit names in placeholder items, they might no longer get recognized and you need to update those items to use the Minecraft names instead. The "empty"/"uncraftable" potion is also no longer supported in placeholder items.
• Drop support for MC 1.19, 1.19.2, and 1.19.3 to speed up build times. MC 1.19.4 is still supported and can be updated to without issues.
• Add settings to identify the shop creation item by a custom NBT tag.
  • Previously, we identified shop creation items by matching their item data with the data specified in the shop-creation-item setting. Adding and identifying the shop creation item by a custom NBT tag instead has several benefits, such as being able to change the shop-creation-item in the future without breaking any existing shop creation items in the world (e.g. in chests, player inventories, trades, third-party plugin data, etc.). Also, in the past, we occasionally ran into issues when the server implementation made changes to how it creates the item based on the data specified inside the config.
  • These new settings are enabled by default for new configurations, but disabled when migrating from a previous Shopkeepers version in order to not break backwards compatibility for existing items.
  • Setting add-shop-creation-item-tag (default: true): Whether to add the tag to newly created shop creation items, e.g. when created via the /shopkeeper give command.
  • Setting identify-shop-creation-item-by-tag (default: true): Whether to identify the shop creation item by the tag.
    • This is a separate setting in order to help server owners with the migration process: Server owners can enable add-shop-creation-item-tag very early to already add the tag to all newly created shop creation items, but separately enable identify-shop-creation-item-by-tag later, once they expect or verified that the old shop creation item is no longer in use.
    • Unfortunately, the Shopkeepers plugin provides no built-in solution to automatically migrate all occurrences of the old shop creation item in the world or plugin data.
• Change the default shop-creation-item display name to use json-based text.
  • Since somewhere around MC 1.20.4, display names with &-based color codes were no longer converted to a json text representation, but to legacy color codes. This caused some issues with existing shop creation items no longer getting recognized or stacking correctly. On some servers, these legacy color codes are in some circumstances later converted to json-based text, which causes similar issues with these shop-creation items suddenly no longer working after these conversions.
  • The default display name was changed to the compact '{"text":"Shopkeeper","italic":false,"color":"green"}'. This change is not automatically applied to existing configurations, because it could break existing shop creation items.
  • If you want to use a json-based display name that matches the previous representation on Spigot servers prior to MC 1.20.4, you can change the display name in the config to display-name: '{"extra":[{"bold":false,"italic":false,"underlined":false,"strikethrough":false,"obfuscated":false,"color":"green","text":"Shopkeeper"}],"text":""}'.
• Fix: In v2.19.0, we added a workaround for a change in the Paper server to now force teleports of shopkeeper entities. However, on Spigot servers, we need to manually reset the forced teleport request again after the entity teleport, because we don't receive an EntityTeleportEvent there.
• Fix: The angry state of wolves would previously get reset after some time (when the random AngerTime runs out). We now periodically re-apply it.
• Debug: Add debug option text-components to log additional debug output whenever component-based text is sent.
• Prepare for Paper's future removal of CraftBukkit's package relocation: Adjust the fallback compatibility mode to no longer try to parse the CraftBukkit version from the package name.
• Fix: The entity argument for command editVillager no longer accepts non-villagers, shopkeepers, or Citizens NPCs.

Known potential issues: See here.

Donations

If you like this plugin, consider making a donation.

Thanks!

In reply to Rip_Foxx:

 Consider creating a ticket over on Github and attach information on your server version, plugin version, and the exact error. Also make sure that both your server and the plugin are up to date.

v2.19.0 for MC 1.20.4, 1.20.2, 1.20.1, 1.19.4, 1.19.3, 1.19.2, 1.19, 1.18.2, 1.17.1, 1.16.5

I only list the primary changes here. For information on API changes, internal changes, and changes to the language files, you can find the complete changelog on Github: https://github.com/Shopkeepers/Shopkeepers/blob/master/CHANGELOG.md 

• Add support for MC 1.20.4. MC 1.20.3, which is mostly the same, is not officially supported. No new features or mobs. Experimental MC 1.21 mobs are not yet supported.
• Add setting `citizen-npc-fluid-pushable` (default: `false`) to make all shopkeeper Citizens NPCs pushable by fluids (`true`), unpushable by fluids (`false`), or not modify their current behavior (`"undefined"`).
  • When set to `"undefined"`, the Citizens NPCs are not modified but retain their default or previously set fluid pushable behavior.
  • Unfortunately, the Citizens plugin has no in-game command yet to toggle the fluid pushable state of individual NPCs. But this is likely to be added in the future.
• Shulker shopkeepers peek at nearby players now.
  • This behavior can be disabled with the setting `shulker-peek-if-player-nearby` (default: `true`).
  • The setting `shulker-peek-height` (default `0.3`) defines how much the shulker opens when it peeks.
• Add: Support for setting up items that execute a command when being traded (either sold or bought).
  • Add: Command `/shopkeeper setTradedCommand <command>` (permission `shopkeeper.settradedcommand`, default `op`): Sets the command to execute when the held item is traded.
  • The command to execute is stored inside the item's data under the Bukkit key `shopkeepers:traded_command`.
  • When an item that has a traded command assigned is traded, the item is destroyed and the assigned command is executed as often as there are items in the item stack.
  • This feature is not meant to replace the requirement for custom third-party plugins or scripts in order to implement complex or custom behaviors. In order to reduce implementation and maintenance effort, only a single command can be assigned to an item and only a very limited set of placeholders is supported: `{player_name}`, `{player_uuid}`, `{player_displayname}`, `{shop_uuid}`.
    • Simple command sequences can also be defined via command aliases in Bukkit's "commands.yml" (see https://bukkit.fandom.com/wiki/Commands.yml).
    • If additional context information is required, e.g. about the shopkeeper's location or shop owner, a custom plugin that listens for the `ShopkeeperTradeEvent` might be better suited to implement the intended behavior.
• Add: Utility command "/shopkeeper replaceAllWithVanillaVillagers".
  • This command deletes all shopkeepers and replaces them with corresponding vanilla villagers without AI that are configured very similar to villager shopkeepers.
  • This might for example be useful when migrating a world to vanilla Minecraft, e.g. when a server closes a world but wants to provide it as download to its players with all the shopkeepers included.
  • This command requires all of the following permissions: `shopkeeper.debug`, `shopkeeper.remove-all.player`, `shopkeeper.remove-all.admin`.
• Add: "No shops were found" message to the "removeAll" command.
• Fix: Moving shopkeepers did not update their location in the AI system, breaking gravity and AI activations when being moved out of their original chunk.
• Fix: Verify that the Citizens API is still available before we try to use it. This guards against cases in which the Citizens plugin reports as "enabled", but the Citizens API is not in a properly initialized state. Reloading the Citizens plugin via PlugMan also seems to leave the Citizens API in an unusable state.
• Fix: The check whether the cursor can hold the traded item was off by one, unnecessarily preventing trades in some cases.
• Fix: Shopkeepers could no longer be moved after a recent change in the Paper server (PR 9937) to now also call the EntityTeleportEvent for plugin invoked teleports: All plugins that previously cancelled or modified entity teleports in certain cases (including the Shopkeepers plugin itself) can now accidentally cancel or modify plugin invoked entity teleports that were not supposed to be cancelled or modified previously. For now, we restore the previous behavior for all of our plugin triggered shopkeeper entity teleports by forcing these teleports, bypassing any cancellation and modification attempts of plugins.
• API (breaking): Changes to the `ShopkeeperTradeEvent`.
  • The result item received by the trading player and the items received by the shopkeeper can now be altered via the `ShopkeeperTradeEvent` (`#get/setReceivedItem1/2`, `#get/setResultItem`).
    • Breaking: Plugins that use this event can no longer assume that the received items equal those of the trading recipe.
    • It is also possible to clear the received items. This might for example be useful when implementing items that apply alternative effects when traded (e.g. command items, or Vault integration).
    • Trade logging and trade notifications still log the original items of the trading recipe.
    • Some shopkeepers ignore changes to the received items in certain cases. For example, when removing items from a shop container or when adding or removing currency items to or from shop containers, the default shopkeepers will ignore any changes to the received items.
  • Since the received items can now be modified by plugins during the trade event, the event is called earlier now, prior to certain inventory related checks.
    • Breaking: Plugins can no longer assume that the trade will actually take place even if the trade event remains uncancelled.
  • Add a non-cancellable `ShopkeeperTradeCompletedEvent` that is called if the trade actually took place, after all trade effects have been applied.
  • Add `ShopkeeperTradeEvent#getTradeEffects` that allows custom `TradeEffect` instances to be added that are invoked when the trade is either aborted or completed.
    • This can be useful when implementing custom trade effects that are meant to only be executed once the trade is actually applied.
    • This might also be used for some of the built-in default trade effects in the future.

Known potential issues: See here.

Donations

If you like this plugin, consider making a donation.

Thanks!

v2.18.0 for MC 1.20.2, 1.20.1, 1.19.4, 1.19.3, 1.19.2, 1.19, 1.18.2, 1.17.1, 1.16.5

I only list the primary changes here. For information on API changes, internal changes, and changes to the language files, you can find the complete changelog on Github: https://github.com/Shopkeepers/Shopkeepers/blob/master/CHANGELOG.md 

• Add compatibility for MC 1.20.2.

Known potential issues: See here.

Donations

If you like this plugin, consider making a donation.

Thanks!

In reply to TeamDucks:

 Maybe there is some issue related to saving the shopkeeper trades to disk. Check your server log for errors.
Also, the latest plugin version resolved an issue related to Paper. So if you are using Paper, try out Shopkeepers v2.17.2.

In reply to curiousemo:

 Update to Shopkeepers version 2.17.1.