Bukkit

In reply to adixon3877:

 This is a Bukkit plugin, not a mod. No corresponding mod is planned.

v2.23.4 for MC 1.21.5, 1.21.4, 1.21.3, 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.5.
  • Add support for cow, chicken and pig variants.
  • Item hover events in trade notifications do not support component data currently.
• Add saddle editor option for zombie horse, skeleton horse, mule, donkey, camel and strider.
• Command: The /shopkeeper transfer command also allows transferring shops to offline players now.
  • The player can be specified by unique id and name. The command checks for matching players among the currently online players, among the current shop owners, and among offline player. But we only check for a matching offline player if we didn't find any matching player among the online players and shop owners.
  • Command completion and ambiguous name handling is not supported for offline players.
  • The lookup by name may involve a blocking roundtrip to the Mojang servers.
• Config: Add slime-max-size (default: 5) and magma-cube-max-size (default: 5). The maximum supported size is 10.
  • Data: If you have existing slime or magma cube shopkeepers with larger sizes, they are automatically shrunk when they are loaded. To prevent this, manually add these new settings to your config file with the intended values before you update the plugin.
• Config: Add enable-glowing-sign-text (default: true).
• Data: Add shopkeeper data migration to remove invalid player head profile names. See GH #907.
  • Since MC 1.20.5, player head profile names must be valid player names, i.e. have a maximum length of 16 and only contain allowed characters (spaces are not allowed).
  • Minecraft itself cleared invalid profiles names during its own item data migration. However, this migration was not automatically applied to the item data of shopkeepers. On Spigot, the invalid item data is loaded but can result in crashes later on. On Paper, the invalid item data is already rejected during the loading of the shopkeeper data.
  • Profiles always require a non-empty name or a unique id. If our migration clears a profile name and the profile has no unique id, we add a fixed dummy unique id (5458ec26-8221-366d-8836-be7a07a5e29b).
  • If the save data has changed as result of the migration, we create a backup of the previous save file. If you are not happy with the result of the migration, you can use this backup to apply your own migration.
  • Debug: If the debug mode is enabled, we also write the migrated save file to disk. This can help diagnose issues if the migrated save file subsequently fails to load.
  • After the migrated shopkeeper data has been successfully loaded, we forcefully save all shopkeepers to disk to persist the migration result.
• Data: Remove old shopkeeper data migration from the save file in the plugin folder.
• Fix: We were not correctly tracking players teleporting between worlds. This resulted in a memory leak, and in issues when trying to find nearby players (e.g. used by shulker shopkeepers to decide whether to peek). Additionally, we now log a warning whenever we unexpectedly fail to cleanup the data for a player. This should help us identify any remaining memory leaks in this area, if any.

Known potential issues: See here.

Donations

If you like this plugin, consider making a donation.

Thanks!

In reply to Summer_Kwami:

 I have no plans to write a datapack or mod version of this plugin currently. There are also some online tools that can help you create the commands to create custom villagers, but they will behave mostly like vanilla villagers with custom trades then.

v2.23.3 for MC 1.21.4, 1.21.3, 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.4.
  • Add pale oak sign and hanging sign shops.
  • Add creaking to the by default enabled mob types.
• Commands: Add command /shopkeeper teleport [player] <shop> ['force'] that teleports a player near the specified shopkeeper.
  • Permissions: shopkeeper.teleport (default: op) and shopkeeper.teleport.others (default: op).
  • The command tries to find a safe teleport location in a small radius in front of the shopkeeper. The force argument can be used to teleport the player even if no safe location is found.
• Commands: Improve the handling of ambiguous player names, shopkeeper names, and targeted shopkeepers.
• Commands: Evaluate command argument fallbacks from front to back instead of from back to front. This results in better error messages since we usually prefer error messages for earlier arguments over error messages for later arguments. And this fixes an issue with for example the command /shopkeeper list 123 2 being interpreted differently than /shopkeeper list X 2: The latter previously resulted in an error rather then checking for shop owners named X.
• Fix: Prevent damage caused by shopkeeper mobs, e.g. when touching puffed pufferfish shopkeepers.
• Fix: The remote command ignored shops that cannot be opened because they have no trades currently. We still want to show these shops in command completions.

Known potential issues: See here.

Donations

If you like this plugin, consider making a donation.

Thanks!

In reply to yeenium:

 Yes, you can freely use this plugin for your server. This is the purpose of publishing it here.

v2.23.2 for MC 1.21.3, 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

• Fix: Partially matching items were no longer accepted in trades.
  • The fix only applies to MC 1.21.1+. The previous behavior cannot be restored for server versions 1.20.5 - 1.21.
  • The partial matching only applies to item components as a whole now. Any data inside a component (including the "custom data" component used for plugin data) is always fully matched now due to the changes in Minecraft 1.20.5+.
• Fix: Config sound effects fail to play on Spigot 1.21.3. Added a config migration from sound enum names to namespaced keys. This also resolves an issue with shift trading not working.
• Add "no permission" message feedback when a user tries to edit a shopkeeper which they don't have access to.
• Commands: In addition to the command permission itself, various commands require the player to have editing access for the involved shopkeeper now, and hide command completions for shopkeepers that the executing player has no access to. Affected commands:
  • edit (already required editing access before)
  • remote/open (already required trading access before)
  • remove
  • setForHire
  • setTradePerm
  • transfer (already required editing access before)
  • All snapshot commands.
• Config: Add check-spawn-location-interaction-result (default: false). If enabled, players are only able to place shopkeepers in places where no other plugin denies them to interact with blocks.
  • We check for this by calling a dummy block interaction event for other plugins to react to.
  • If the spawn location is currently empty (i.e. of type air), we temporarily place a dummy block to get better interaction results from other plugins.

Known potential issues: See here.

Donations

If you like this plugin, consider making a donation.

Thanks!

v2.23.1 for MC 1.21.3, 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.3.
  • MC 1.21.2 was immediately replaced and is not supported.
  • Squids and dolphins support a baby variant now.
  • Salmons support size variants now.
  • Experimental features (creaking and pale oak sign shops) are not yet supported.
• Fix: Error "IncompatibleClassChangeError: Found interface org.bukkit.craftbukkit.inventory.CraftMerchant, but class was expected" when a player shop becomes out of stock. This version is built against the latest version of Spigot 1.21.1 and might not be compatible with Spigot 1.21.1 builds from before 2024-09-07.
• Add SQLite based trade log storage. (Thanks @akshualy)
  • In the future, this can be used for additional features, such as offline trade notifications.
  • Config: Add new setting `trade-log-storage`. Available values: `DISABLED` (default), `SQLITE` (recommended), `CSV`.
  • Config: Add migration from the old `log-trades-to-csv` to the new `trade-log-storage` setting.
  • Only one storage type can be selected: Logging trades to both CSV and the SQLite is not supported.
• Config: Remove `file-encoding` setting: We use Bukkit to load the save data, which always expects the data to be UTF-8 encoded.
• Fix: Remove shopkeepers from the spawn queue again when their chunk is unloaded. This can for example occasionally be observed during server startup on MC 1.21.1.
• Fix: Player shops got deleted when their container is hit by a wind charge and `protect-containers` is disabled and `delete-shopkeeper-on-break-container` is enabled: We need to ignore explosions if they don't actually delete the affected blocks.
• Fix: Allay shopkeepers were able to pick up items matching the item in their hand.

Known potential issues: See here.

Donations

If you like this plugin, consider making a donation.

Thanks!

In reply to ariozake:

 Your plugin version is not fully compatible with your server version. Check the update notes about information on compatibility and pick a plugin ersion compatible with your server version.

In reply to ariozake:

 The latest Shopkeepers version should actually be compatible with 1.21.1. But some other user reported some issue caused by some recent change in Spigot, which might have broken something for that version. I still need to check that.

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!