3.6.0.1

This is a hotfix for 3.6.0.0.

Bug Fixes

1. Fixed CrowdinOTA will cause plugin hard crash if cannot load manifest over Internet from Crowdin server.
2. Fixed Language Override system doesn't load overrides from /overrides/<locale>/messages.yml

Addon-Discount

Bug Fixes

1. Fixed command description translation missing and shown a translate key.

3.6.0.0

Merry Christmas, everyone!
We brought a Christmas update from QuickShop Hikari! Don't worry, Santa Claus will put the update in your chimney. Until it is blackened by smoke and becomes outdated.

Highlights

New addons Plan and Discount now joined QuickShop-Hikari addon's family!
Scroll down to read change logs about our addons!

Plan	Discount

New Features

N/A

Bug Fixes

1. Translation override system doesn't work. The file incorrect created as a same file directory. Override file incorrect merge with exists translation.
2. Translation fallback logic doesn't work.
3. Fixed purchase logger always record zero for item amount in database.

Developer Changes

1. New event ShopInfoPanelEvent added into QuickShop-Hikari, event will raise after user clicked shop container and info panel printed.
2. QuickShop-Common module's CommonUtil new added CommonUtil#parseTime(String) method to allow developer convert a Zulu Time (2022-12-17T10:31:37Z) or UNIX Timestamp in seconds 1671273097 to Java Date.

Addon Family

DiscordSRV

Download

1. Added DiscordSRV artifacts to Modrinth, CodeMC.io and Github Releases artifacts list, You're able to download jars from the sites shown above.

Bug Fixes

1. Fixed the placeholders with emptry string may cause bad embed message error, it was fixed by replacing empty string to ZERO width space.

Plan

Plan addon allow server owners to showcase the recent QuickShop-Hikari activities on the server.

Data Tracked

Recorded data can be displayed from Hikari v2.0.0.0 onwards, but only after version 3.6.0.0 can Item amount in Purchase History be displayed correctly.

Global Scope

• Total shops amount
• All shops (to a Shops list)
• Recent Purchase History (include deleted or invalided shops), only in recent 365 days and 1000 rows will be shown up.

Due the Plan limitations, We can't add more data into the list because the maxmium columns are hardcoded limited to 5 in server scope.
And still is Plan limitations, the list sorting is disturbed, so the display order is not the actual order.

Player Scope

• Total shops amount
• All owned shops (to a Shops list)
• Recent Purchase History (include deleted or invalided shops), only in recent 365 days and 50 rows will be shown up.

Due the Plan limitations, We can't add more data into the list because the maxmium columns are hardcoded limited to 4 in server scope.
And still is Plan limitations, the list sorting is disturbed, so the display order is not the actual order.

Showcase

Global Purchases	Player Purchases

Global Shops	Player Shops

Localization

Due the Plan limitations, translate Plan addon is impossible.

Discount

Discount Addon added Discount Code in your QuickShop-Hikari server.

Permission

• quickshopaddon.discount.use (default: everyone) Permission to use any /qs discount commands.
• quickshopaddon.discount.bypass (default: OP) Permission to bypass the owner checks to force config discount codes, add non-self shops in allow list or remove a discount code.
• quickshopaddon.discount.create.server_all_shops (default: OP) Permission to create discount code that applied to all shops in your server.
• quickshopaddon.discount.create.player_all_shops (default: everyone) Permission to create discount code that applied to player themself shops.
• quickshopaddon.discount.create.specific_shops (default: everyone) Permission to create discount code that applied to shops in the code allow list.

Create a discount code

To create a discount code, you need use discount command:

/qs discount create <code> <code-type> <rate> [max-usage] [threshold] [expired-time]

Command pretty long, but you have in-game command assistant to help you in your tab complete hint.

Available Code Type

• SERVER_ALL_SHOPS (Applied to all shops in your server)
• PLAYER_ALL_SHOPS (Applied to all shops belongs to code creator)
• SPECIFIC_SHOPS (Applied to shops in allow list that added by command /qs discount config <code> addshop)

Install a code

To use a Discount Code, you need install them before purchase shops.

/qs discount install <code>

The installed code will remember during this session.

Uninstall a code

To uninstall a Discount Code, you need use command:

/qs discount uninstall <code>

Show detailes for a installed discount code

To use info subcommand, you can query the code creator, range, remaining usage, expired time, threshold and discount rate.

/qs disount info

Remove discount code

To remove your a specified discount code, execute command:

/qs discount remove <code>

Check if discount code can be applied to specific shop

You need install a discount code first, then you click the shop you want to check, a promot message will show up when you can enjoy the discount in this shop.
If code not accepted by target shop, you will also receive a warning message when you click it.

Apply the discounting

You need install a discount code first, then purchase a shop that accept your code.
Then discount will applied to your puchase, and your remaining count will be consumed.

NOTE: If the above additional conditions are not met, the Discount Code will not be applied and you will not get a discount, but at the same time, the Discount Code will not be consumed, and the prompt message will contain the specific reason.

Auto Purge Expired Code

An expired discount code will automaticlly removed while server startup or in 30mins.
Before they got purged, players who use a expired code will receive a error message that says the code has been expired.

Convert your time

Expired time accepts both Zulu Time format and UNIX Timestamp in seconds format:

There have a such pretty online website can help you convert the time:
https://www.unixtimestamp.com/

For Zulu Time (ISO 8601 Extended) format:

yyyy-MM-dd'T'HH:mm:ssZZ

Note that the server time zone is used for calculations during the conversion.

Some other stuff

Since Nov 20, 2018, I have spent thousands of hours on QuickShop series projects, I have maintain these projects for up to four years.
The fifth year is coming, I would appreciate it if you could light up Star and Fork buttons for Github Repository❤.

Full Changelog: https://github.com/Ghost-chu/QuickShop-Hikari/compare/3.5.0.3...3.6.0.0

Discount Addon and Bug Fixes

Discount Addon

Christmas is coming! We've launched a new Beta version of Addon: Discount.
Now create a Discount Code and let others enjoy discounts in your store!

Create a discount code

To create a discount code, you need use command /qs discount create, there have few options you can custom including:

• code name (e.g XMAS50OFF)
• code type
  • PLAYER_ALL_SHOPS for all your shops
  • SPECIFIC_SHOPS
  • SERVER_ALL_SHOPS for all shops on this server (administrator)
• max usage (like you can use this code up to 5 times)
  • -1 for unlimited
• price rate
  • percentage: 30% is -70%
  • fixed: 50 is -50$
• threshold (e.g only purchase over 500$ in one time then you can enjoy -50$ discount)
  • -1 for unlimited
• expire time
  • -1 for unlimited
  • Support UNIX timestamp in seconds format.
  • Support Zulu standard format.

Follow the in-game tab-completer to fill arguments to create a discount code.

There is time format example:

Install your discount code

By execute command /qs discount install <code> to install a discount code, then it will applied to every purchase that applicable your installed discount code.

If discount codes are available, you will receive a prompt message when you clicking the shop.

Check your discount code information

By execute the command /qs discount info, you will able to check discount code information that you installed.

QuickShop-Hikari

New features

1. Impl ShopInfoPanel event.

Bug Fixes

1. Fixed QuickShop-Hikari languages override system.
2. Fixed QuickShop-Hikari languages safe fallback system.

In 3.6.0.0-beta1, our addon family welcomed a new member, Plan.

By install Plan integration, our addon will add a new page and few panel into your overview and per-player metric page.

It is worth mentioning that QuickShop-Hikari has been available for statistical purposes since it was published, but we have never formally written extensions for it to show the data.

The purchase related history has a bug in the past QuickShop Hikari, which causes all the item amount data of Purchases to be zero. Since 3.6.0.0-beta1, this error has been repaired and new data has been recorded normally.

WARNING: If you executed /qs database purgelogs before, all your metrics will be purged.

Global Metrics

Summary

In global metrics summary panel, you will able to check the total shops and total purchases on your server.

Purchases

In global metrics purchases panel, you will able to check recent 1000 purchases in recent 365 days.
Even deleted and invalid shops are included.

We intentionally limited the size of the displayed dataset to avoid database pressure on large networks.

Shops

In global metrics shops panel, you will able to check all actived shops on your server, even shop out of stock or out of space.
Deleted shops are excluded.

Player Metrics

Not only global, but also per player metrics!
By clicking Playerbase -> Player List -> <username>, you will able to access Plan per-player profile page.
In per-player profile page, expand the Plugins menu on the left nav, you will able to see QuickShop-Hikari panels.

Summary

In player metrics summary panel, you will be able to check how many shops that player owned.

Purchases

In player metrics purchases panel, you will be able to check this player recent 50 purchases.

We intentionally limited the size of the displayed dataset to avoid database pressure on large networks.

Shops

In player metrics shops panel, you will be able to check this player all shops on this server.

Limitations

1. Server global data will update periodical, it finished by Plan's scheduler, we can't control it.
2. Player personal data will update when they left the server.
3. Due to the limitations of Plan's API, it is impossible to localize text display.
4. At present, the number of entries is hard coded and cannot be modified. We will provide the ability to modify them using configuration files later.

Bug Fixes

1. Fixed VirtualDisplayItem on 1.19.3 with ProtocolLib build 5.0.0-SNAPSHOT.

Tested on Paper git-Paper-334 (MC: 1.19.3)

Bug Fixes

1. Fixed VirtualDisplayItem reporting java.lang.ClassNotFoundException: com.comphenix.protocol.wrappers.WrappedDataValue.
2. Fixed VirtualDisplayItem reporting java.lang.RuntimeException: Failed to find NMS class: network.syncher.DataWatcher$b.

For 1.19.3 users, no impacts of those bugs, if you hit java.lang.ClassNotFoundException: com.comphenix.protocol.wrappers.WrappedDataValue on 1.19.3, upgrade ProtocolLib.

Tested on Paper 1.19.2 and Paper 1.19.3.

Bug Fixes

1. Fixed broken VirualDisplayItem (1.19.2) on 3.5.0.0.

New Features

• DiscordSRV addon (beta), it's a standalone plugin and need you install DiscordSRV.
  • Players who linked with their Discord in game now can receive the discord alerts through DM.
    • Including:
      • Anyone sold/bought items to/from your shop.
      • The shop permission settings changed.
      • The shop transfer to you.
      • The shop has run out of space.
      • The shop has run out of stock.
  • Same as QuickShop-Hikari it self, the messages send to players though Discord also use client display languages.
    • If player offline, QuickShop-Hikari will try to use latest known client language.
• User now able to add new languages by create a folder in overrides folder with locale code as name, and same name yaml file inside folder.
  • You can create a locale named hack for example, and add a same name language to game client by using Resources Pack, and QuickShop-Hikari will detect new language and loading translation from custom languages.
• (upstream) VirtualDisplayItem 1.19.3 support.

Bug Fixes

• Rewrtitten SimpleTextManager, CrowdinOTA and LanguageFilesManager
  • Replaced CrowdinOTA codes to a standalone, bug-free library CrowdinOTA
    • This fixed incorrect cache handling, QuickShop-Hikari can correct handling the translations that cached in disk, and validating them when next loading to make sure files exists, up-to-date.
    • This also make translation cache files name be more friendly (human readable).
  • Rewritten files loading logic in SimpleTextManager.
    • This fixed incorrect override order and incorrect whole section override.
    • It always loading files by order: built-in failback -> bundled -> crowdin -> user override
    • Fixed strings lost issue if user or crowdin or bundled translations only override part of strings in a section.
    • Fixed translations merge function.
    • Fixed third-party addons translations registering function.
• Fixed debug.delete-corrupt-shops doesn't work. (contributed by @Nlkomaru)

Developer

• ShopPlayerGroupSetEvent now provides player's uuid in event.

Misc

• Bump adventure-minimessage-platform from 4.1.2 to 4.2.0.

Screenshots

There is quick preview of new features:

Today is my birthday! 🎂 And here is birthday update!

This is a beta build, don't install on live server unless you have full backup.

New Features

• DiscordSRV addon (beta), it's a standalone plugin and need you install DiscordSRV.
  • Players who linked with their Discord in game now can receive the discord alerts through DM.
    • Including:
      • Anyone sold/bought items to/from your shop.
      • The shop permission settings changed.
      • The shop transfer to you.
      • The shop has run out of space.
      • The shop has run out of stock.
  • Same as QuickShop-Hikari it self, the messages send to players though Discord also use client display languages.
    • If player offline, QuickShop-Hikari will try to use latest known client language.
• User now able to add new languages by create a folder in overrides folder with locale code as name, and same name yaml file inside folder.
  • You can create a locale named hack for example, and add a same name language to game client by using Resources Pack, and QuickShop-Hikari will detect new language and loading translation from custom languages.

Bug Fixes

• Rewrtitten SimpleTextManager, CrowdinOTA and LanguageFilesManager
  • Replaced CrowdinOTA codes to a standalone, bug-free library CrowdinOTA
    • This fixed incorrect cache handling, QuickShop-Hikari can correct handling the translations that cached in disk, and validating them when next loading to make sure files exists, up-to-date.
    • This also make translation cache files name be more friendly (human readable).
  • Rewritten files loading logic in SimpleTextManager.
    • This fixed incorrect override order and incorrect whole section override.
    • It always loading files by order: built-in failback -> bundled -> crowdin -> user override
    • Fixed strings lost issue if user or crowdin or bundled translations only override part of strings in a section.
    • Fixed translations merge function.
    • Fixed third-party addons translations registering function.

Developer

• ShopPlayerGroupSetEvent now provides player's uuid in event.

Misc

• Bump adventure-minimessage-platform from 4.1.2 to 4.2.0.

Screenshots

There is quick preview of new features:

3.4.0.3 released with 1.19.3 compatibility

New Features

1. Spigot 1.19.3 compatibility.
2. New command /qs database purgehistory for purge x days ago logs from your database.

Translations

1. Updated translations from Crowdin.

New Features

• [BETA] Velocity Compatibility Module (contribute by 4drian3d)
• /qs find now supports Item Reference

Bug Fixes

• /qs export command doesn't work anymore.

New Feautures

• [BETA] Added BungeeCord Compatibility Module (https://github.com/Ghost-chu/QuickShop-Hikari/discussions/536).

Bug Fixes

• Fixed /qs lookup create command always report name must applied to regex \w.

3.4.0.0

Warning: This is a major update, have a lots internal changes, please make sure you have backup for worlds, databases and configs!

Warning: This update contains database structure changes, downgrade without backup is impossible and may kill your shop data!

New Features:

1. [BETA] Shop Benefits! Now you are able to add players into your shop benefits! Share the earnings together with customize percentage! (only selling shops) [/qs benefit] Check Details
2. Compatibility module Lands now support LandsAPI 6.22.0 and up only.
3. Compatibility ARM now build against advanced-region-market 3.13.12.
4. Discord server link now added into ErrorReporter, now you will see our discord server link while QuickShop catch any internal error then you can report it instantly.

Bug Fixes

1. Fixed exception in /qs find command when any of shop not loaded correctly.
2. Fixed RollbarErrorReporter sometimes report non quickshop errors.
3. Fixed loan feature doesn't work in some situation.
4. Fixed the tax value range warning description.
5. Fixed dupilicate Crowdin manifest retrieve, this should can improve CrowdinOTA performance by reduce the Internet API requests.
6. Fixed debug logger may blocked the threads if any error occurs between after logger lock locked and before lock released.
7. Fixed incorrect Crowdin link in config.yml

Security

1. Fixed potential XXE attacks exploit.

Removed

1. Option trying-fix-banlance-insuffient now removed from configuration since it doesn't work well, most economy plugin can handle balance cache correctly, if something doesn't work, it should be economy plugin side issue.
2. Removed command /qs debug sql <sql> function now completely removed from source code and binary.
3. Some un-used classes and staled classes now removed from both source code and binary.

Optimize

1. Optimized heap memory usage by reduce same fields in objects.
2. General code clean up and optimize.

Dependencies

1. Update towny from 0.98.3.10 to 0.98.4.2.
2. Update PlotSquared-Core from 6.10.1 to 6.10.4.
3. Update PlotSquared-Bukkit from 6.10.1 to 6.10.4.
4. Update LandsAPI from 6.15.0 to 6.20.0. (breaking)
5. Update unirest-java from 3.13.11 to 3.13.12 .
6. Update commons-compress from 1.21 to 1.22.
7. Update advanced-region-market from 3.3.6 to 3.13.12.

Misc

1. Updated developer list in plugin.yml from Github Repository Contributors, thanks for contributing!

3.4.0.0 SNAPSHOT

BACKUP YOUR DATA BEFORE INSTALL SNAPSHOT BUILDS, NEVER RUN SNAPSHOT ON LIVE SERVER

New Features:

1. Shop Benefits! Now you are able to add players into your shop benefits! Share the earnings together with customize percentage! (only selling shops) [/qs benefit] Check Details
2. Compatibility module Lands now support LandsAPI 6.22.0.

Bug Fixes

1. Fixed exception in /qs find command when any of shop not loaded correctly.
2. Fixed RollbarErrorReporter sometimes report non quickshop errors.
3. Fixed loan feature doesn't work in some situation.

Security

1. Fixed potential XXE attacks exploit.

A hot fix for last version that fixed purchase failed bug.

3.3.0.0 Minor Changelog

This update is sponsored by the club cat, say "Hello" to "Huahua".

New features

• Per-player i18n shop infomation sign. (img1)
  • QuickShop-Hikari now support packet based shop infomation sign with ProtocolLib installed. Multiple player can see same sign in same time with different language display now.
• In this version, compatibility modules will provide the shop creation cancel details (like reason).
  • User may need upgrade the compatibility modules to use this feature.
• In this version, player may able to set the shop stack size over the default limit (64). (img2)

Bug Fixes

• Fixed SQLite error for username-uuid lookup mapping caches, it now use memory cache instead.
• Fixed 3rd-party integration resources won't be released after QuickShop-Hikari disabled.
• Fixed database resources won't be released after QuickShop-Hikari disabled.
• Fixed economy hooks loaded in early statup stage, it will load in first server tick to make sure all economy plugin can be loaded.
• Fixed internal-error rollback logic, now it will take a snapshot for shop and trader inventory for error rollbacking instead count amount and add/remove items.
  • Normally, this mechanic should not be triggered, it is a misconfigured or misprogrammed protection mechanism to avoid players or shops from losing/duplicating items and money.
• Fixed /qs paste reported paste missing the Timings, Transactions and Cron logs.

API changes

• TextManager now allow 3rd-party addons register their language k-v to QuickShop locale system.

Images

img1: img2:

3.2.0.2 ChangeLog

Bug Fixes

• Fixed Economy Services Injector.
  • The custom economy services now can be loaded without an native supported economy service.
• Fixed custom-command-alias feature, it has been broked for a long time and should working now!
• Fixed /qs taxaccount command may produce NullPointerException.
• Fixed qscompat-clearlag ConcurrentModificationException.

Fixed a bug that MySQL driver report exception: Unknown column 'SHOPS.id' in 'on clause'.

3.2.0.0 ChangeLog

This update tooked a little long of time due my personal things, but anyway, it's here and enjoy it!

Optimize

• Improved shops loading logic.
  should now get better loading performance, compare old and new loading time cost.
• Improved isolated data logic.
  • the old isolated data scanning will begin once server booted up, which may increase the load on the database.
  • the old isolated data scanning need pull all shops data back to local and calculate one-by-one which slow and may increase the load on the database.
  • new logic will pre-processing them with SQL, calculations will be done on the database so it will have better performance.
    • we do same thing on shops loading logic, seems it working well :)
• Tweak internal logger buffer size and this should reduce the memory footprint by a small amount.
• Improved shops auto-save logic.
  • shops auto-save is now parallel.
  • shops are no longer actively saving changes to the database immediately, we will check every shop that has been modified and update the database every once in a while. *all changes will save into memory when server shutting down.
• Improved database auto-backup.
  • hikari now actively backs up the database before breaking changes, both H2 and MySQL users.

Bug fixes

• Users may can increase the database load if them spam click the shop block.
• Hikari may conflict with LastLoginAPI's H2/HikariCP.