QuickShop-Hikari

Major Changes

• Removed Spigot Platform Modules, and stopped loading QS if Spigot is detected. This will mean that unless the protocol changes that we use for display items, QS won't need updated for each version.
• Revamped Economy Code Completely
  • New classes for all economy-related systems
  • Any economy-related or benefits-related events are incompatible with previous versions.
• Added sign layout customizations per-type allowing you to change how lines are configured, an empty string('') will leave an empty line for that line of the sign.

  #The layout of signs for shops.
  layout:

    #The layout of BUYING shops.
    BUYING:
      line1: "header"
      line2: "trading"
      line3: "item"
      line4: "price"

    #The layout of FROZEN shops.
    FROZEN:
      line1: "header"
      line2: "trading"
      line3: "item"
      line4: "price"

    #The layout of SELLING shops.
    SELLING:
      line1: "header"
      line2: "trading"
      line3: "item"
      line4: "price"

• Add wildcard support for item blacklist patterns(thanks to bennycallanan)

  • Added support for wildcard patterns in the item blacklist configuration, allowing users to block entire categories of items with simple patterns.

  • Features

    • Wildcard patterns like *_AXE and *_SPAWN_EGG now work in blacklist configuration
    • Supports * for any characters and ? for single character matching
    • Case-insensitive pattern matching
• Overhauled GUI system(thanks to Yusakidev)
  • Implemented gui.yml configuration file for customizing the GUI.
  • Implemented better filtering for qs browse
  • Implement GUI system to be more stable, and less error prone.
  • Added gui.yml for fully configurable GUI layouts and text
  • Browse menu: search, sort (price/name/stock), and filter (all/buying/selling/in-stock)
  • Staff menu: search functionality for player/staff selection
  • Grouped item pages for better shop browsing
  • Refactored all menu pages to use configurable display/lore
• Added worldedit compat to QS internally as it's widely used.
• Revamped the taxation system to be more flexible and easier to configure.
  • introduced a new progressive tax system that allows you to tax based on the balance of players.(suggested by YuanYuanOwO)
  • introduced the ability to tax the player interacting with the shop, the owner, or both
  • all tax-related configurations have been moved under the shop-tax section of the config. this may require reconfiguration of your tax settings.
  • added a new ShopEnhancedTaxEvent, deprecated the old ShopTaxEvent.
  • Added a new TaxManager, and TaxProvider interfaces, this allows for custom tax providers to be added by addons/third-party developers.

Addons/Compats Changes

• Added UltimateClaims compat
• Added SimpleClaimSystem compat
• Added Quests by Pika addon
• Added BetonQuest addon
• Added Pl3xMap addon
• MatcherPlus Compat Improvements
  • Added support for CrazyCrates
  • Added support for ExcellentCrates
  • Added support for SilkSpawners.
• WorldGuard Compat Improvements(Thanks to golovin12)
  • Added clear permission handling:
    • Region owners and members automatically have permission to create and trade in their own regions.
    • Other players must have the appropriate WorldGuard flags enabled (quickshophikari-create, quickshophikari-trade) to interact with shops.
  • If a shop is located outside any region, default QuickShop behavior applies (no extra restrictions)
• Added colored markers based on shop state for bluemap(thanks to YusakiDev)
• Updated dynmap/towny addons to use the new ShopTypeEnhancedEvent instead of ShopTypeEvent.
• Removed worldedit compat, it's now included in the main plugin.
• Added support for global flags to the worldguard compat.

Internals/Developer APIs

• Removed several deprecated methods and classes.
• Revamped the interaction manager. It is now more flexible and allows external additions
  • This involves two classes InteractionBehavior and InteractionType.
  • InteractionType details the type of interaction such as: STANDING_LEFT_CLICK_SIGN, STANDING_LEFT_CLICK_SHOP
  • InteractionBehavior outlines a behavior for an InteractionType such as CONTROL_PANEL and TRADE_UI
• Added UserLimitCalculationEvent, which allows for custom limits to be applied to users.
  • This is useful for limiting the number of shops a user can have, or adding on to the existing limits provided by the ranks system without needing to implement a new RankLimiter.
• Added a new ShopLayoutProvider interface, and default implementation.
  • This allows for custom layouts to be used for shops, allowing for more customization.
  • This also allows for developers to override the default layout provider and create their own implementation.
• How to make your own?
  • Implement the classes you would like to then register with the InteractionManager:

  •    InteractionManager manager = QuickShop.getInstance().getInteractionManager();
    
       manager.interaction(new MyTradeInteraction());
       manager.behavior(new MyTradeBehavior());
    

• Replaced some Apache Commons calls that could be easily replaced with built-in java methods, reduces some calls by ~ 1100ms/method call
• Deprecated the ShopType enum, and the ShopTypeEvent. These are replaced with the new IShopType interface and implementing classes.
  • The new event is ShopTypeEnhancedEvent.
  • This allows for third-party addons to add their own shop types, and simplifies code checks for translations.
• Updated config system to use Boosted-yaml
  • this allows for auto-updating of config files without complex update scripts
  • this also allows for the config system to not be minecraft-dependent.
• Replaced logical PaperLib calls with native PaperAPI calls.

Minor Changes

• Bump Java version up to 21
• Added shop.display-allow-enchants to enable/disable enchantments for display items on shops.
• Added workaround for packetevents not supporting custom enchants on itemstacks for virtual display items.
• Using locale translations for shop-type in mode toggle icon(thanks to ExyiN)
• Bumped Residence version for the compat(thanks to YuanYuanOwO)
• add world whitelist support(thanks to wling-art)
• added /qs database save command, which saves all currently dirty-marked shops to the database.
• Split up interactions _SHOPBLOCK into _SHOPBLOCK and _CONTAINER.
  • _SHOPBLOCK relates to shops, where _CONTAINER relates to shop-valid containers that are not currently shops.
• Added inventory as an option for command panel, this is useful for adding a secondary option for players to open a shop's inventory.
• Moved crowdin arguments from system properties to config.yml
  • crowdin-host
  • use-crowdin-ota

Fixes

• Fixes issue with item price restrictions(thanks to maxcom1)
• Fixes issue with 1.20.x protocol lib displays(thanks to YuanYuanOwO)
• Fixes issue when no item is in hand for itemdebug(thanks to YuanYuanOwO)
• Fixes issue with dominion addon(thanks to YuanYuanOwO)
• Add a simple check to avoid this. If it is not own shop, reject limit request directly.(Thanks to YuanYuanOwO)
• Fix NPE by not setting tax for price in TransactionBuilder(thanks to maxcom1)
• Fixes /quickshop suggestprice to differentiate between buy/sell shops. (Thanks to MidSpike)
• PacketEvents ClassNotFoundException with ProtocolLib(thanks to wling-art)
• Reallocate block state access to region thread for shop creation(thanks to r00tbeerman)
• resolve SLF4J StaticLoggerBinder loading error(thanks to wling-art)
• sign hijacking issue by validating sign facing direction(thanks to wling-art)
• Performance improvements for QuickShop disabling to prevent potential freezes.
• Fixed issue with 1.20.4 packetevents virtual displays not staying put.
• Fixes critical issue in GriefPrevention compatibility plugin.
• Fixes issue with shop owner not getting money when benefits active.
• Fixes for lands addon on folia, Use regionThread for Folia compatibility(thanks to YusakiDev)
• Fixes for TRADE_DIRECT on stacking shops
• Fixes issue for protocollib 5.4.0 with undocumented packet changes.
• Fixes issue where item stacks could be used on creation above the max stack size.
• Fixes issue with BukkitAudiences-related crashes on 1.21.11.
• Fix issue with shop deletion when getting too impatient.
• Fix the permission check issue when a shop owned by a non-owner is transferred to someone else. (thanks to YuanYuanOwO)
• Fix ui with supertool (thanks to YuanYuanOwO)
• Fix issue with logs generating outside debug mode.
• Fix issue with /qs find.
• Fix configuration loading timing.
• Fix configuration loading/creation warning message language.
• Fix command description language key mismatch(thanks to wling-art)
• Fix qs clean command on folia(thanks to wling-art)
• Fix per-player-shop-sign on folia(thanks to wling-art)
• Fix potential recursive deadlock in virtual display packet sending(thanks to wling-art)
• Fix configuration loading/creation warning message language.
• Fix issue with /qs browse and ShopItemOnly addon not behaving properly together on folia.
• Fix issue with PLAN using outdated APIs.
• Fix issue with /qs clean on folia.(thanks to wling-art)
• Fix issue with /qs cleanghost on folia(thanks to wling-art)
• More thread safety fixes for shops on folia.(thanks to wling-art)
• Fix owner payment calculations with benefits(thanks to wling-art)

6.2.0.10

Major Changes

• Added support for 1.21.6 for paper(spigot has not been updated as we look to deprecate spigot support, nag the spigot developers about modernizing their API)
• Added support for 1.21.7 for paper(spigot has not been updated as we look to deprecate spigot support, nag the spigot developers about modernizing their API)
• Added support for 1.21.8 for paper(spigot has not been updated as we look to deprecate spigot support, nag the spigot developers about modernizing their API)
• Some internal updates for packetevents(2.9.0 is now required.)
• Updated Lands support

Addon Changes

• Added MatcherPlus Addon
  • Allows support for BreweryX and AdvancedItems stacks in shops with improved matching abilities
• Added FabledSkyblock Compat
• Added Dominion Compat
• Added HuskTowns Compat
• Added IridiumSkyblock Compat
• Added member-create for member creation in ARM compat
• Added admin-override and quickshop.arm.admin permission for admin overrides in ARM

Minor Changes

• Added configurations for the coordinates of the display item.
• Added /qs toggledisplayall on/off server/owned
  • Players need to have permission node quickshop.toggledisplayall.admin to toggle all on the server.
• Added ability to use abbreviations in /qs price and /qs create commands such as 2.5k for 2500
• Added ability to set default display status using shop.default-display in config.yml

Fixes

• Fixed issue with display item being sent to the moon on 1.21.5
• Fixed issue where TRADE_UI interactions interfered with quick create.
• Fixed issue with displays on protocollib falling through the chest
• Fixed issue with signs on .9 and previous .10 snapshots on early versions
• Implemented some performance improvements for paper servers
• Fixed all outstanding issues with Folia usage.(thanks to RootB33R/SleazLee for contributions)

Possible 6.2.0.11 Features

Here's an outline for some features that may arrive in 6.2.0.11:

• Additional compats/addons that have been piling up.
  • see: https://github.com/QuickShop-Community/QuickShop-Hikari/issues/1756
• gradle?(interested to see compilation time uplifts)
• Update documentation
• Update configuration comments
• Update configuration system?
  • auto updating?
  • Allows removal of the update code
• Remove waste spigot modules?
  • Any versions of 1.20 that can be discarded due to low use?
• Bug fixing, of course
• Sign parser implementation?
  • probably have to re-evaluate since it's been awhile since it has been looked at...

6.2.0.9 - Important Note: Contains Exploit Fix, Please Update ASAP.

Remember to backup your DB before updating.

Major Changes

Exploit Fix Included for GUI Exploit

This build fixes an exploit in the GUI system that was recently outlined.

Lots of Events Changes

See discord changelog for event system here

Control Panel Component System Overhaul

The shop control panel system has been overhaul to separate it into different classes. This allows third-party plugins to add additional components to the control panel easily. There was also an added event, ControlComponentGenerateEvent, which is called PRE, MAIN, and POST of a ControlComponent being generated. The MAIN phase supports changing the ControlComponent object with a custom one that will replace the original during control panel sending.

Introduction of the Revamped Packet System

1. About:

   • A modular and scalable system for managing packets related to virtual display items in Minecraft.
   • Supports both ProtocolLib and PacketEvents libraries for greater flexibility.

2. Custom Packet Factories:

   • Modular implementation of PacketFactory for game versions 1.20.x and 1.21.x.
   • Packet types:
     • Spawn Packet: Spawns a virtual item entity at a specific location.
     • Metadata Packet: Updates the visual properties of virtual items.
     • Velocity Packet: Adds motion/velocity to entities (currently optional).
     • Destroy Packet: Removes the entity from the client view.

3. Error Handling and Logging:

   • Enhanced debug logs to trace packet-related issues.
   • Detailed error messages for missing factories or unregistered listeners.

Improvements:

• Better modular design to facilitate support for future Minecraft versions.

Deprecations:

• Legacy packet handling mechanisms replaced with this new Packet System.

Event System Overhaul

Added

• event/Phase.java - Introduces a phase-based event system to track different stages of an event lifecycle.
• event/PhasedEvent.java - Defines events that occur within different phases, allowing better event state management.

Packet Handling Events:

• event/packet/handler/PacketHandlerAddedEvent.java - Triggered when a new packet handler is registered in the system.
• event/packet/handler/PacketHandlerInitEvent.java - Fired when a packet handler is initialized, useful for debugging or custom setups.
• event/packet/send/PacketHandlerSendDestroyEvent.java - Dispatched when a packet instructs a client to remove an entity from their view.
• event/packet/send/PacketHandlerSendMetaEvent.java - Fired when metadata about an entity is sent via packets.
• event/packet/send/PacketHandlerSendSpawnEvent.java - Triggered when an entity is spawned using packet-based communication.

Shop Events

• ShopUpdateEvent has been replaced with the ShopDatabaseEvent
• ShopAuthorizeEvent has been replaced with the ShopPermissionCheckEvent
• ShopClick, ShopCreate, ShopDelete, ShopLoad have been replaced with similar named events, but they are in the event.management package now, and are phased events.

Shop Settings Events:

• event/settings/ShopSettingEvent.java - Generic event to handle changes in shop settings dynamically.
• event/settings/package-info.java - Documentation package containing metadata for shop settings.

Shop Type-Specific Settings:

• event/settings/type/ShopCurrencyEvent.java - Handles changes in the currency type used in a shop.
• event/settings/type/ShopDisplayEvent.java - Triggers updates when a shop’s display settings (e.g., holograms, signs) are modified.
• event/settings/type/ShopItemEvent.java - Fired when the main item being sold in a shop is changed.
• event/settings/type/ShopNameEvent.java - Occurs when a shop’s name is updated.
• event/settings/type/ShopOwnerEvent.java - Manages ownership transfers and modifications in a shop.
• event/settings/type/ShopOwnerNameEvent.java - Triggered when the owner's display name is modified.
• event/settings/type/ShopPlayerGroupEvent.java - Handles updates to the player group associated with a shop.
• event/settings/type/ShopPriceEvent.java - Dispatched when an item’s price is changed in a shop.
• event/settings/type/ShopSignLinesEvent.java - Manages updates to sign-based shop displays.
• event/settings/type/ShopTaxAccountEvent.java - Fired when a shop's tax account information is modified.
• event/settings/type/ShopTypeEvent.java - Tracks changes in the classification or type of shop.
• event/settings/type/ShopUnlimitedEvent.java - Handles changes to a shop’s unlimited stock setting.

Shop Benefit System:

• event/settings/type/benefit/ShopBenefitAddEvent.java - Fired when a new benefit (e.g., discounts, loyalty rewards) is added to a shop.
• event/settings/type/benefit/ShopBenefitEvent.java - General event for tracking shop benefit modifications.
• event/settings/type/benefit/ShopBenefitRemoveEvent.java - Triggered when a shop benefit is removed.

Removed

• event/details/ShopItemChangeEvent.java - Replaced with ShopItemEvent.java for a more consistent structure.
• event/details/ShopNamingEvent.java - Merged into ShopNameEvent.java.
• event/details/ShopOwnerNameGettingEvent.java - Superseded by ShopOwnerNameEvent.java.
• event/details/ShopOwnershipTransferEvent.java - Now handled by ShopOwnerEvent.java.
• event/details/ShopPlayerGroupSetEvent.java - Integrated into ShopPlayerGroupEvent.java.
• event/details/ShopPriceChangeEvent.java - Merged into ShopPriceEvent.java.
• event/details/ShopTypeChangeEvent.java - Replaced by ShopTypeEvent.java.
• event/details/ShopUnlimitedStatusEvent.java - Now managed under ShopUnlimitedEvent.java.
• event/display/ShopDisplayItemDespawnEvent.java - Removed in favor of ShopDisplayEvent.java.
• event/display/ShopDisplayItemSafeGuardEvent.java - Consolidated into a broader display event category.
• event/economy/ShopTaxAccountChangeEvent.java - Now included in ShopTaxAccountEvent.java.
• event/economy/ShopTaxAccountGettingEvent.java - No longer necessary due to a refactored shop economy system.
• event/packet/PacketHandlerAddedEvent.java - Moved to event/packet/handler/PacketHandlerAddedEvent.java.
• event/packet/PacketHandlerInitEvent.java - Now handled by event/packet/handler/PacketHandlerInitEvent.java.

Modified

• event/AbstractQSEvent.java - Updated base event structure to support phase-based execution.
• event/QSCancellable.java - Added new cancel conditions to prevent unintended event termination.

Packet Events:

• event/package-info.java - Updated to reflect new event structures.
• event/packet/PacketHandlerEvent.java - Now supports additional packet handling scenarios.

Minor Changes

• If a player doesn't have permissions for CONTROL_PANEL_UI it'll open the TRADE_UI for them
• Added the quickshopdontsend override to allow server owners to prevent certain messages from sending(paper only)
• Made it so invalid chat entries for UIs escape the chat ui

Config Changes

• added shop.control-panel to control what components of the text control panel are enabled.
• added shop.sign-wax to control if the shop sign is waxed or not, default is false.
• added shop.display-protocol which allows you to select packetevents or protocollib for packet handling

Fixes

• readded the /qs history permissions to the default quickshop.player
• fixed issue where some folks wouldn't have the encoded db column
• Fixed issue with reached-maximum-can-create not being implemented correctly
• fixed issue where pistons would move shulker shops.
• fixed issue where colored shulkers could be bought and put inside non-colored shulker
• fixed issue with griefprevent /transfer command not unregistering owner
• fixed issue where signs weren't updated when lock was set to false
• Fixed issue where slime compat explosive pick wasn't being caught by QS(Thanks to YuanYuanOwO and Starfruit)
• Fixed exploit(thanks to macaw/casper for being the first to report this)

Version Changes

• Removed support for 1.18 and 1.19. These versions had minimal usage.
• Added support for 1.21.5

6.2.0.8

Major Changes

• Added initial Folia Support
• CONTROL_PANEL_UI is a new interaction that allows you to use a GUI control panel instead of the chat one.
  • From this GUI you can add/remove staff, transfer ownership, set selling mode of shop, change the price and delete the shop!
• Readded QS History GUI
• Removed Real Item and Entity displays; They provided no advantages over virtual displays and mainly caused issues.
  • If protocol lib is not up-to-date/installed it will default to no display.
• Added /qs browse [world], which allows a player to view the shops by server or by world depending of if they attach world as an argument
• Added TRADE_UI interaction, which opens up a GUI-based trading menu for the player to buy/sell predefined, and custom amounts from/to a shop.
• Updated to MC 1.21.3, MC 1.21.4.
• Added VaultUnlocked Support

Minor Changes

• Added 2 new interaction behaviours that will be coming soon. CONTROL_PANEL_UI and TRADE_UI
• Made it so that when price change fees are set to 0, the fee charge message isn't sent.
• Added /qs staffall to manage staff for all shops.
• Added a new shop mode, frozen.
  • This allows admins/shop staff to hault trading with the shop temporarily
  • This mode was added to the Shop Keeper menu.
  • This mode was added to the text-based control panel.
  • This mode introduces new commands: /qs silentfreeze and /qs freeze
• Made the default action for /qs suggestprice try to use the itemstack in hand when shop not in sight.
• Added shop.finding.global to remove distance limit for /qs find
• Made sign shop sign waxed to prevent modifications(thanks to ThiagoROX)
• Add SignOpen listener(thanks to ThiagoROX)
• Add sub command overrides(thanks to ThiagoROX)

Internals

• Added style guidelines.
• Added final inside code where possible.
• Made ShopNamingEvent get called when unsetting shop name.
• Added ShopUnlimitedStatusEvent that is called when changing the unlimited status of a shop.
• Rearranged Events into different packages. This will break plugins that rely on the events.

Discord Changes

• Added Sponsor role for those that sponsor through GitHub.

Compat Plugins

• Towny
  • Added ruined town config to remove shops when town goes into ruins.

Addon Plugins

SuperiorSkyblock

• Made it so the compat plugin can delete shops when someone is banned from an island.

Fixes

• Fixed issue with Velocity and Bungee Compat Jars
• Fixed issue with Towny Compat Jar not removing shops when plot is cleared, or town is deleted.
• Fix item restrictions being bypassed using shulkers(thanks to TauCubed)
• Fix Towny town/nation account lookup with Essentials(thanks to galacticwarrior9)

Notes

• Pending removal of 1.18/1.19 support soon.

Changelog

• Completely rewrote display item code
• Added new completely revamped item matcher, set work-type to 3 which corrects lots of issues(still in testing phase)
• Added 1.21.1 support, this will be the new default, which should allow for future updates to continue to work so long as the protocol doesn't change.
• Add finding enchantments on books and gear support for find sub command(thanks SarahGreyWolf)

Other Notes

• Testing builds for folia support may be found on the discord.
• RealItemDisplay will be getting removed in a future release. It is inefficient and causes more issues than it's worth. Please move to virtual displays.

Bug Fixes

• Fixed exploit with shop items and certain functionality(thanks to bridgelol)
• Temporarily disabled QS history while working on replacement due to errors end-users are running into.
• Fixed issue with enchantment restrictions not detecting them in enchanted books(thanks toTauCubed)

What's Changed

Full Changelog: https://github.com/QuickShop-Community/QuickShop-Hikari/compare/6.2.0.5...6.2.0.6

New Features

1. 1.21 support

Bug Fixes

1. Fixed /qs clean may delete all stores
2. Fixed /qs cleanghost may delete all stores

Changes

• Virtual Display Item available again when use ProtocolLib Build 710 and up, please update your ProtocolLib

Bug Fixes

1. Fixed display item check when using RealDisplayItem, the check may delete non-display item from player/container inventory if an item contains lore that is a valid JSON string. It should won't affcet most servers.
2. Fixed /quickshop cleanghost won't delete the stores that trading blacklisted items

Ahhh forget to update version number!

Bug Fixes

• Fixed entity explosion may not check attached block

Bug Fixes (6.2.0.1)

• History GUI's paging button doesn't use translated text
• 1.20.4/1.20.5 didn't use Spigot new potion API
• The potion effect level in shop info panel always smaller one than actual level in RomanNumber
• The blank lines may send to players when you set a translatable text to empty
• Fixed quickshop.alert that should be use as quickshop.alerts in PlayerListener

Bug Fixes

• History GUI's paging button doesn't use translated text
• 1.20.4/1.20.5 didn't use Spigot new potion API
• The potion effect level in shop info panel always smaller one than actual level in RomanNumber
• The blank lines may send to players when you set a translatable text to empty
• Fixed quickshop.alert that should be use as quickshop.alerts in PlayerListener

Warning! Due to Minecraft's major update to ItemStack, downgrading is not an option! Please backup all data before upgrading!

Reremake users: This is the last chance to complete your migration from Reremake to Hikari before you upgrade to 1.20.5/1.20.6. The migration requires QuickShop-Reremake to be up and running. After upgrading to 1.20.5/1.20.6, Reremake will no longer work properly.

1.18, 1.19 users: All versions 1.18 and 1.19 have been marked as “End Of Life” and these versions are no longer supported. It may be broken in a future update. Please consider upgrading to 1.20.x!

流萤 - Artist Nid417

It's been a long time! This release has been delayed several times due to huge changes in 1.20.5/1.20.6. But anyway, 6.2.0.0 is here now!

New Features

• 1.20.5/1.20.6 supports both for Spigot and Paper
  • The hover item preview function on Spigot 1.20.6 is not available at the moment, please click to access the GUI to preview the item
  • The virtual DisplayItem feature of 1.20.6 has been temporarily disabled because ProtocolLib has not been updated yet.
• Display entity support for display-item
  • The use of ItemDisplay as a hover is now supported, which has better performance than RealDisplayItem (both for Server and Client). Set display-type to 3 to enable ItemDisplay entity
• Displaying detailed levels of potion effects is now supported on 1.20.5+
• /quickshop history enhance
  • New subcommands: /quickshop history owned, /quickshop history accessible and /quickshop history global to allow you query multiple stores transaction history in single query
    • owned: Select all shops which you're owner
    • accessible: Select all shops which you have per-shop permission to access the store history
    • global: Select all shops on this server (require permission)

Bug Fixes

• Fixed /quickshop benefit command may not save when remove users
• Fixed chunks load/unload loop on specific Spigot versions when use RealDisplayItem
• Fixed double-chest related issues
  • QuickShop may only recognizes half inventory of a DoubleChest store that spans a Chunk junction after chunk unload/server restart
  • When creating a store on a DoubleChest, symbolLink is always bound to the side with type=left, no matter which side of the DoubleChest the store cube is on. After the user destroys the corresponding side of the chest, the store will be invalidated.
• Fixed the issue that some items in the History GUI could not be displayed because they were out of the GUI display range.
• Fixed show-tax purchase messages doesn't show tax currency in message.

Debugging

We added localized text and Tab completion to allow all users to use QuickShop-Hikari's built-in debugging tools.

These debug commands are for debugging purposes only and have no operational confirmation. Using them incorrectly may result in inconsistent status or loss of data. Figure out what happens before you execute them.

All commands are started with prefix: /quickshop debug

• dev/debug/devmode: Toggle debug mode
• signs: Print the coordinates of the all identifiable information sign for the store you are looking at
• updateplayersigns <player name>: Refresh the contents of the store information boards in all designated players' stores.
• force-shops-reload: Unload all loaded stores and re-load them (to refresh the state)
• force-shoploader-reload: Unload and delete them from memory, then re-execute the ShopLoader sequence to reload all stores from the database.
• check-shop-status/check-shop-debug: Prints quite useful store status debugging information to confirm the current state of the store in memory
• toggle-shop-load-status: Simulate store loading/unloading without changing the chunks loading state
• set-property: Register/change the Java property sheet to change specific behavior via property switch without touch startup command line (They are usually changed through the startup parameters). For security reasons, this command is restricted to change QuickShop-Hikari properties only, any request to change any other properties will be denied.
• reset-shop-caches: Reset store lookup cache for benchmark/or debugging possible cache update issues
• reset-dbmanager: Force reset of SQLManager, only for MySQL data sources, using this command on H2 will cause the plugin to crash
• dump-db-connections: Dump SQLManager's Current Active Queries on chat.
• stop-db-any-queries: Force close SQLManager's currently active queries.
• toggle-db-debugmode: Toggles the debugging state of SQLManager and prints the executed SQL statements and performance timings on the console when SQLManager debug mode is enabled.
• dump-hikaricp-status: Printing status information for HikariCP.
• set-hikaricp-capacity: Dynamically change the size of HikariCP's connection pool to allow more connections to be fetched urgently.
• item-info: Prints the NBT data for the item in hand (if any) and the item in the store (if any). If the item is in the hand and is looking at a store, it will also output the item match.
• mark-all-shops-dirty: Forces all store change status indicators to be flagged as changes not saved in order to force a refresh of their current data into the database.
• clean-display-entities: Scans all loaded blocks and removes any entities recognized as QuickShop DisplayItem. Useful when uncleared entities appear after changing the DisplayItem type.

Ko-fi supporters

Thanks to these friends on Ko-fi for their support in this update, they are:

• GradynWursten(GNUGradyn)
• Namiu
• narumincho
• lunar

(The names are in no particular order)

Bug fixes

1. Fixed H2 driver conflict on some server setup and cause the startup failure.

Performance Improves

• Optimized shop loading logic, significantly improved the loading speed of stores when the world loads, now skipping any unrelated stores.

Bug Fixes

• Fixed NoClassDefError when starting up without ProtocolLib
• Fixed cached stock/space API

New Features

• Added CoinsEngine Economy API support
• Added Treasury Economy API support
• [Compat] Added VoidChest compatibility module, contributed by @GeorgeV220 (first contribution)

Changes

• Number formatting now follows player's locale
• Messages now will delay to send while player logging in
• QUser now use Fork-Join-Pool to resolve
• InventoryWrapper can now verify that it is still valid

Performance

• Display item teleport now use Paper API if available
• Avoid create empty YamlConfiguration instance if no extra data for shop to save memory (lazy init)

Bug Fixes

• Compat/Addon's API getShops may returns the shops that not in selection and cause accident deletion if they in same chunk
• Added multiple missing localization keys
• Player may still to charged even ShopPriceChangeEvent has been cancelled
• Shop creation may failed if user entered a super large number like 999999999999999999999999999999.99 with default new generated configuration
• Some parts didn't use QuickShop's Permission Manager
• Some commands are using the wrong permission node
• quickshop.use permission node was ignored
• /qs staff clear and /qs staff remove won't save to database after modified staff list
• Shop display still spawned even player use /qs toggledisplay to turned it off if server enabled display auto despawn
• Fixed TNE economy type may populate StackOverFlow error while purchasing

Other

Several new Startup Flags have been added to allow users to fine-tune the internal implementation, which will be made available on-demand by developers in the support channel.

Bug Fixes

1. On some server platform, database sources settings may not read properly.

Bug Fixes

1. Plugin may crashed on startup due incorrect configuration upgrade script.
2. (Try-to) fix double-chest may cannot detect another half-part items.
3. [COMPACT] GriefPrevention compatibility module may crash on startup if build don't have ClaimResizeEvent.

Summary by CodeRabbit

• New Features
  • Enhanced logging in the GriefPrevention compatibility module for better startup and event handling visibility.
  • Improved error handling in the configuration reload process to ensure stability.
• Bug Fixes
  • Fixed an issue with handling DoubleChest instances in inventory management, ensuring proper functionality.
• Chores
  • Updated dependencies to the latest version (6.0.0.9) across various modules for improved performance and compatibility.
  • Adjusted configuration scripts to accommodate new donation key handling.

Bug Fixes

1. Fixed top N valuable customers query
2. Fixed Minecraft vanilla bug can break the shop container
3. (Try to-) fix the GriefPrevention compat's permission override
4. Fixed ItemFlag may not respected.

(6.0.0.8 is a hot patch for 6.0.0.7)

Bug Fixes

• Fixed /quickshop history command will stuck when user using MySQL.

Optimization

• The store now saves after startup only after modifications have occurred.

If you meet HikariPool-1 - Connection is not available, request timed out after 30000ms. errors in past versions, please upgrade to this version and see if it still happening, and join our Discord server to participate in the discussion of the issue. We are investigating this issue and releasing mitigation measures.

Bug Fixes

• Fixed NoClassDefError on Paper 1.20.1 (It's definitely fixed this time :) )

Optimization

• Resolved SQL query performance to avoid performing full table scans and causing severe query performance degradation

Changes

• Temporarily deactivated statistical metrics about the database, which we found were blocking in the main server thread and triggering a server crash when there were problems with the database connection
• Add performance indicators for newly added ShopHistory-related queries to provide feedback on query performance in Paste.
• Adjust logger to reduce useless logging.
• Added several debug subcommands to check for database performance issues and HikariCP related issues.
• Changed ShopHistory related queries from parallel to serial and limited the number of simultaneous executions to 1 to avoid completely exhausting all available connections to HikariCP and crashing the plugin.

Bug Fixes

• Fixed shop history query use database executor, causes a deadlock on execution resources and results in a query execution failure
• Fixed an issue where the default HikariCP pool parameters in the configuration file were incorrect, now incorrect configuration keys and configuration values will be automatically migrated and adjusted. Care should be taken to avoid accidental value changes if you have changed the relevant parameters manually.

Optimization

• We have noticed that the new /quickshop history feature is applying more database pressure due to log_purchase not being configured with proper indexing. This hot patch will create an index for log_purchase to alleviate the performance issue.
  • If you still continue to experience query performance issues after this update, please join our Discord to provide feedback.

This is a hot-patch for 6.0.0.0 major update.

Fixes

1. [ADDON] Reremake-Migrator doesn't work with 6.0.0.0
2. [ADDON] BlueMap Addon doesn't work (NullPointerException)
3. [ADDON] ItemsAdder Addon don't load due package name changes

Although all updates is addon related, but you also need update QuickShop-Hikari it self.

6.0.0.0 Major Update - Furina

Focalors & Furina, Artist Tiko

For the Lunar New Year, QuickShop-Hikari has received a new major update that includes several feature updates for large networks and transaction-oriented servers. At the same time, we also fixed some bugs.

New Features

Shop History

The new Shop History feature allows you to open a store history panel for all past trade requests that have occurred in this store.
At the same time, you will be able to see your Most Valuable Customers, showing those players who have made the most transactions in your store.
The panel also will allow you to view the number and value of transactions for the last 24h, 3d, 7d, 30d, all-time, and unique purchasers count.
This feature is based on a long-existing transaction logging system, so after you upgrade, you can view the transaction history that created before the upgrade.

Change the shop sign material

New command /quickshop sign <material> that allow users to change their shop's info sign material.

Transfer Shop Ownership

Added New command /quickshop transferownership for shop transfer.

• This new command will allow player request to transfer a shop to another player, without re-create the shop.
• To complete the transfer, the requested player must accept the transfer request.
• To avoid ambiguity, the old /quickshop transfer command is now renamed /quickshop transferall.

Price Suggestion

New command /quickshop suggestprice that calculates the most expensive price, the cheapest price, the average price, and the median price for other stores on this server that have the same items and selling patterns as the current store, so that players can set appropriate prices for their stores.

Addons

• [Addon][Discoumt] New command /quickshop discount listall
  • The new command allows server administrators to list all discount codes on the server for better management.
• [Addon][Slimefun] New Addon to allow the use Item Expression to reference a Slimefun items.
• [Addon][ItemAdder] New Addon to allow the use Item Expression to reference a ItemAdder items.
• [Addon][Lands] Now supports deleting all stores in Land when it's deleted.
• [Addon][List] The command /quickshop list are now presented in a paged format, and you can toggle the paging by appending a number. No more crowding the chat box when there are tons of stores.

Misc

• Added new configuration item shop.info-panel.show-enchantments, shop.info-panel.show-effects, shop.info-panel.show-durability, to allow you disable some information on shop info panel to avoid too much data crowned your chat.

Improvements

• Added delete confirmation for [Remove Shop] button in shop control panel.

Optimization

• Improved checking of the best mirror source, which now gains speed and enables correct use of the best mirror source to resolve plugin dependencies. This is a significant improvement for users in mainland China.
  • Multiplexing of libraries cached by the Spigot Libraries Loader (SERVER_ROOT/libraries) is now supported to reduce network requests and traffic consumption.

Refactor / Changes

• Introduced a new registry system and plan to convert more modules to use this system in the future.
• The control panel now suggest new /quickshop transferownership instead /quickshop setowner.
• API to Shop#getRemainingStock and Shop#getRemaingingSpace now supports async call, to retrieve cached data from database.

Bug Fixes

• EconomyFormatter may use incorrect currency to format the balance.
• Fix NoClassDefError on some Paper 1.20.2 instances. (hopefully)
• Fixed the command sounds doesn't work at all
• Fixed tab-complete doesn't work for non-operator players.
• Fixed respect-item-flag option doesn't work.

Addons

• [Addon][DiscordSRV] Re-build with DiscordSRV 1.27.0 to fix linked accounts related features.
• [Addon][DiscordSRV] Fixed messages may send twice for shop owners.

Tweaks

• EcoEnchants fixes missing enchantments, QuickShop-Hikari now works with EcoEnchants 12.2.1 or later, and the compatibility module works properly.
• The ability for users to disable the built-in dependency resolver via startup flag and fallback to SpigotLibraryLoader by copying the list of dependencies into the libraries field of plugin.yml helps to solve the Aether illegal access issue reported on Mohist. We are still working with the Mohist developers to resolve this issue. MC 1.20.4 or later builds of Mohist are not affected by this issue.

Bug Fixes

• Fixed relocation bug that caused addons reporting NoClassDefFoundError/ClassCastException.
• Fixed decimal-format always report the language key is missing.

Bug Fixes

• Fixed broken DiscordSRV addon (maybe also other 3rd-party addons).
• Fixed China Geo detection for optimized libraries resolver doesn't work if CloudFlare services cannot be accessed (which is common in China mainland).

Bug Fixes

• Fixed /qs permisison doesn't save the changes
• Fixed plugin on Paper 1.20.1 may report NoClassDefException.

Optimization

• SpigotLibraryLoader is abandoned and dependency resolution is now handled by QuickShop-Hikari itself.
• Added mirror for dependency resolution for server in China.
  • Users in China will use Maven Central mirrors from Aliyun, Tencent Cloud, and NetEase to accelerate dependency resolution.
  • Users in Global will keep the original (Maven Central) repository.

Fixed a security issue:

Missing store ownership check when a player modifies a user's store permissions using the /qs permission command. This allows the user to take over arbitrary store permissions, including the administrator store.

This patch will not revoke permissions, you will need to do a check on the store's already set Per-player permissions property to avoid pre-existing exploits. For past versions, you can disable the command interface for the per-player permission system to avoid new exploits /lp group default permission set quickshop.permission false. However, upgrading is still recommended.

Considering that this security vulnerability allows for store privilege escalation (including unlimited stores, aka AdminShop) and allows for the modification of store transaction contents, prices, and disruption of the server's economic system, we strongly recommend that you plan an update immediately and utilize LuckPerms through the guide to disable this feature before you maintain it.

Bug Fixes

• /qs reload will cause OngoingFeeWatcher to be executed early
  • Repeated execution of restarting the server is within the design.
• Fixed an issue where store owners would not automatically grant ADMINISTRATOR permissions.

Summary by CodeRabbit

• Dependency Updates

  • Updated quickshop-hikari to version 5.2.0.9.
  • Upgraded Maven compiler plugin to version 3.12.1.
  • Updated versions-maven-plugin to version 2.16.2.
  • Incremented EcoEnchants to version 11.2.0.
  • Updated eco to version 6.68.0.
  • Upgraded LandsAPI to version 6.42.15.
  • Updated towny to version 0.100.0.17.
  • Incremented EconomyCore dependency to version 0.1.2.6-Pre3.

• Refactor

  • Modified permission handling logic in ContainerShop.
  • Adjusted module reload process in QuickShop.

This is a quick update to prevent QuickShop-Hikari running on server which installed EcoEnchants v11+ to avoid data corruption.
Also updated Adventure Lib to 4.15.0 for MC 1.20.3+ compatibility.

This update introduces support for Spigot 1.20.4.

New Features

• 1.20.4 supports
  • You may need update ProtocolLib to ProtocolLib#675 or higher if you're running a 1.20.4 server.
  • You may need update NBT-API to 2.12.2-SNAPSHOT or higher if you're running a 1.20.4 server, you can download from QuickShop-Hikari's support channel or click here

As always, we keep it updated with bug fixes and performance improvements.

New

• -Dcom.ghostchu.quickshop.shop.ContainerShop.updateShopSignOnLoad debug startup flag was added, when it set to true, the shop will update their signs when shop enter the loaded state from unloaded state, This will result in lower performance, but will improve the update lag of the signs. Startup use only on servers that are confirmed to have this issue.
• [ADDON] Reremake-Migrator now able to migrate QuickShopBan addon's data.
• [ADDON] Reremake-Migrator now able to migrate QuickShop-Reremake's transaction logs into database.

Optimization

• Reintroduced an optimized StackWalker API to improve the performance of the background logger. This contribution was submitted by @SirYwell. 👍

Changes

• In new QuickShop-Hikari installations, transaction logs are now logged to the database by default instead of the qs.log file, and you can manually change the configuration file to restore the original behavior.

Bug Fixes

• Fixed Inventory Holder isValid() check issue
• Disabled the BlockState fetching optimization for the Paper platform, which seems to no longer be needed since the 1.16 update, when the speed of the BS API was significantly improved, and was causing inconsistent fetched state errors.
• Fixed the issue where the display of some words in the store information board did not follow the language setting.
• Fixed plugin crash when ProtocolLib not installed and display-type was set to VIRUAL_DISPLAYITEM.

Summary by CodeRabbit

• Dependency Updates

  • Updated quickshop-hikari dependency across multiple modules.
  • Updated BlueMapAPI, Plan, ChestProtectAPI, EcoEnchants, LandsAPI, openinvapi, worldedit-bukkit, Reforges, towny, item-nbt-api-plugin, specialsource-maven-plugin, placeholderapi, EconomyCore, csvjdbc, slf4j-jdk14, commons-text, commons-compress, and various net.kyori artifacts to their latest versions.

• New Features

  • Introduced new search functionality for transaction logs in the reremake-migrator module.
  • Added a new MockPlugin class for mocking plugin behavior.
  • Implemented a new ShopLogsMigrate class for migrating shop logs to a database.

• Bug Fixes

  • Fixed null-safe comparison in griefprevention compatibility module.

• Refactor

  • Simplified error handling in VirtualDisplayItemManager.
  • Streamlined isValid method in BukkitInventoryWrapper.
  • Enhanced double chest handling in BukkitInventoryWrapperManager.
  • Removed unnecessary asynchronous behavior in Util and Log classes.
  • Adjusted PerfMonitor to use Log.Caller directly.

• Documentation, Style, Tests, Chores, Revert

  • No specific end-user facing changes noted in these categories.

This is a cumulative update to fix bug reports received since the last LTS release.

Compatibility

We have partnered with the developers of Mohist and worked on improving the stability of QuickShop-Hikari on Hybird Server.

In the latest Mohist 1.20.1/.2 you can run QuickShop-Hikari perfectly and QuickShop-Hikari protects its store containers from being accessed by other mods pipes or machines.

Also, in the latest version of Mohist 1.20.1/.2, QuickShop-Hikari is able to use most of the Mod containers as store containers.

Bug Fixes

1. Fixed annoying NPE error when loading a store that is in an unloaded world during startup, althrough it won't cause any actual issues.
2. [Addon] Fixed an issue where the item stack amount setting was not preserved for stores that migrated from Reremake.

Changes

1. Disabling the H2 compatibility warning on Mohist will test H2 to work fine on Mohist.
2. Added /quickshop debug reset-shop-caches subcommand to allow user purge all caches from memory to debugging the cache issues.

Privacy

To inform you of warnings about QuickShop-Hikari in accordance with our Privacy Transparency Policy.

We received a data breach alert from the Rollbar* cloud service informing us that our Access Token (post_server_items) had been compromised and a forced reset was performed on our affected Token, not only QuickShop-Hikari but also QuickShop-Reremake affected.
However, our Access Token (post_server_items) is distributed with Jar, so whether it was compromised or not doesn't affect us in any way - it's inherently public and we use it for public purposes. As a result, this forced reset caused the Rollbar to no longer be able to report bugs in older versions of QuickShop-Hikari, where we distributed the new Access Token (post_server_items).

We practice our privacy policy and therefore all submitted data is submitted in the minimal sample and anonymized. Your data is therefore not affected. Although no QuickShop-Hikari is actually affected, you can always disable the error log reporting feature if you want.

* Rollbar is a service used by QuickShop-Hikari AND QuickShop-Reremake that used for collecting error logs that generated by QuickShop plugin.
*This warning only affects developers who sign up for Rollbar (that's me), and based on current research, this warning has no effect on QuickShop users.