[QuickShop Addon] Shop Search icon

[QuickShop Addon] Shop Search -----

Adds a /finditem command in game for searching through all the shops on the server.




Changelog
  • fixed item meta not showing correctly in Search GUI
  • Player Warps dependency updated
----------, Nov 25, 2024

Changelog
  • Added config option to suppress update notifications in chat
Code (YAML):
suppress-update-notifications : false
  • Added config option to configure blacklisted materials
Code (YAML):
blacklisted-materials :
- "BARRIER"
- "STRUCTURE_BLOCK"
- "COMMAND_BLOCK"
----------, Oct 28, 2024

Changes
  • Added runnable custom commands on GUI item click. New related config options added.
Code (YAML):
player-shop-teleportation :
# You can run custom commands whenever a player clicks on a shop from the Search GUI
# Placeholders:
#     {PLAYER_NAME} -> Player name
#     {SHOP_LOC_X} {SHOP_LOC_Y} {SHOP_LOC_Z} -> Shop x,y,z coordinates
    custom-commands
:
      run-custom-commands
: false
      commands-list
:
       - tp {PLAYER_NAME } {SHOP_LOC_X } {SHOP_LOC_Y } {SHOP_LOC_Z }
        - eco give {PLAYER_NAME } 1000000
  • Added a new permission to bypass safety check for shop tp.
You will manually have to add this permission to give players access to this feature. (Check this link for full list of permissions)​
----------, Oct 16, 2024

Changes
  • Residence support for fetching the residence the shop is in (including subzones) (#45) [Contribution by SengyEU]
  • Configurable "No ... near shop" messages (#45) [Contribution by SengyEU]
  • Spigot API updated to 1.21.
Bug fixes
  • Fixed NPE when putting AIR as a filler item (#46) [Contribution by SengyEU]
  • Fixed bug where exception was thrown when trying to render player heads in GUI buttons (Broke in 1.21 update)
----------, Jul 27, 2024

Changes
  • Added stack size placeholder to shop lore (#37)
  • Added a 500 block limit for searching nearby PlayerWarp (ToDo: to be made configurable in a future version)
  • Added option to show only player owned warps in GUI (#38) [Contribution by lukemango]
----------, Jul 6, 2024

Bug fixes
  • Changed scheduled task loggers to debug-mode only (#29)
  • Critical fix for players not getting teleported (#30)
----------, May 7, 2024

Changes (Feature request #23)
  • Plugin updated for Minecraft version 1.20.5.
  • Changed 15Min Scheduled Task to run in async thread (should help with lag).
  • Reremake implementation will no longer be updated. Last support is for QS-Reremake v5.1.2.5.
  • Changed logger statements to show Main/Async thread state.
  • Structural changes in the config.yml, specifically for shop-gui related options.
  • Fixed an issue with showing large numbers in currency.
  • Added new feature to format currency format. For example: $10,210,100 will be shown as $10.21M. New config option to toggle it:
Code (YAML):
shop-gui:
  use-shorter-currency-format
: true
  • New config option added as below to toggle if players should be allowed to warp to locked warps (Only for PlayerWarps).
Code (YAML):
player-shop-teleportation:
  nearest-warp-tp-mode
:
    do-not-tp-if-warp-locked
: true
  • Config version is now 15.
----------, Apr 29, 2024

Bug fixes
  • Fixed a bug where disabling hideshop/revealshop will not disable it for /qs finditem (#13)
  • Fixed stock/space not updating properly from QS cache (#17)
----------, Apr 22, 2024

Bug fixes
  • Fix the lag issue caused due to new QS-Hikari cache feature impl (#12)
  • Fixed a code refactoring bug where search all shops would return no shops for Quickshop Reremake
  • Added a INFO level logger to log time taken for a search process
----------, Mar 24, 2024

Bug fixes
  • Fixed /finditem command not working in some cases (#9)
  • Added a config option to disable the /finditem {TO_BUY | TO_SELL} *
----------, Mar 10, 2024

Features
  • Added Go to First and Last page GUI buttons (#3)
  • Added new config option to include empty chests in the search result (#3)
  • Added compatibility with QS Hikari 6.* shop stock/space fetch from cache feature. This should help prevent massive lag spikes.
Bug fixes
  • Full/out of space chests will be excluded from /finditem TO-SELL <item_name> (#3)
  • Bug fix to prevent lag when during /finditem TO_BUY * on large servers (Only for QuickShop Hikari)
  • Fix for issue where hideshop/revealshop stopped working (#5)
Btw, the plugin is now on Modrinth!
----------, Feb 25, 2024

Added a TP delay feature
- Concerns were raised that players can instantly pull up the shop menu to teleport to a shop when they are about to die. Hence, this new feature. ( #28)
- When player clicks on a shop on the search GUI, based on time configured in config.yml, player will be teleported.
- This is applicable only for direct to shop TP when below config is enabled:
Code (YAML):
player-shop-teleportation:
    direct-shop-tp-mode
:
        tp-player-directly-to-shop
: true
- Added below new config option to configure the TP delay message shown when they click on a shop:
Code (YAML):
player-shop-teleportation:
    direct-shop-tp-mode
:
        tp-delay-in-seconds
: 5
        tp-delay-message
: "&6You will be teleported in &c{DELAY} &6seconds..."
- Set as '' if you do not want to show any message to player
- {DELAY} will be automatically replaced with value set in 'tp-delay-in-seconds'

Bug fixes
- Fixed a bug where CustomModelData set for Close button does not work ( #31)
----------, Nov 19, 2023

Updated the addon to make it compatible with the recent QuickShop and other dependency updates.

Thanks @Ghostchu for the merge request!
----------, Sep 26, 2023

  • Updated QuickShop-Hikari dependency to v4.0.0.0
  • Updated PlayerWarps dependency to v6.18.1
  • Updated QuickShop-Reremake dependency to v5.1.1.2
  • Fixed issue #25
This means this version of addon (v2.0.5.1) will no longer work with previous versions of the above mentioned plugins.

Thanks to @Ghostchu for bringing to my notice the QS-Hikari update which required few changes in this addon to make it usable again.

How have you all been? It's been a long time since I have posted any update to this plugin. Unfortunately life got in the way so any updates/new feature implementations have been on hold. If some critical issue is found which makes this addon unusable, I will try to update it as soon as possible.
----------, Jan 22, 2023

  • Fix for Issue #24
  • Fixed a bug related to nearest warp teleportation algorithm
  • Other minor bug fixes
With release of this version, I am removing the snapshot tag making it a RELEASE version. It should also support Spigot/Paper 1.19 versions.

Update to this version is highly recommended!
----------, Jul 22, 2022

  • Minor bug fixes
  • Updated PlayerWarps API to latest version and fixed a NPE console error

PS: Although 1.19 should be supported by default without any update, I have not tested it so far. So if you encounter any issues, please report it in the issue link below.

To view a full list of changes in the new v2.0 Shop Search AddOn, click here.

=======================================================
Note: This is a SNAPSHOT build as there are a lot of new features added. Backup your QSFinditemAddOn folder inside /plugins before upgrading. Since its just me developing this add-on, its not possible for me to test it completely. So, I do not recommend it for production servers as of now. If you find any bugs, please report them here.

If you want a stable version of this add-on, download v1.9.2 from here. But you will miss out on the new features in v2.0.

A stable v2.0 build with official 1.19 support is coming really soon! I am waiting for all the dependent plugins to update to 1.19 first.
----------, Jul 1, 2022

Bug Fixes:
  • Fixed bug in which the new /qs finditem sub-command was not showing up in /qs help.
  • Fixed a NullPointerException bug for PlayerWarps plugin integration.
  • More minor fixes and code refactors.
Added a new sample-config.yml file which will be copied over to the plugin folder. This file is just for your reference when editing the fields in the actual config.yml file.

PS: Although 1.19 should be supported by default without any update, I have not tested it so far. So if you encounter any issues, please report it in the issue link below.

To view a full list of changes in the new v2.0 Shop Search AddOn, click here.

=======================================================
Note: This is a SNAPSHOT build as there are a lot of new features added. Backup your QSFinditemAddOn folder inside /plugins before upgrading. Since its just me developing this add-on, its not possible for me to test it completely. So, I do not recommend it for production servers as of now. If you find any bugs, please report them here.

If you want a stable version of this add-on, download v1.9.2 from here. But you will miss out on the new features in v2.0.

A stable v2.0 build is coming really soon! ;)
----------, Jun 18, 2022

Bug Fixes:
  • Made minor bug fixes when enabling plugin.
  • Made some fixes in the search system for shops that are buying items.
  • Some other minor stability fixes.
Added finditem sub-command for /qs:
Now you can try the below commands, same functionality.
Some examples:
upload_2022-6-4_16-11-3.png

Please remember that this feature removes the original /qs find sub-command to avoid confusion among players.

To view a full list of changes in the new v2.0 Shop Search AddOn, click here.

=======================================================
Note: This is a SNAPSHOT build as there are a lot of new features added. Backup your QSFinditemAddOn folder inside /plugins before upgrading. Since its just me developing this add-on, its not possible for me to test it completely. So, I do not recommend it for production servers as of now. If you find any bugs, please report them here.

If you want a stable version of this add-on, download v1.9.2 from here. But you will miss out on the new features in v2.0.
----------, Jun 4, 2022

This is a recommended update for all v2.0 users.

Compatibility with QuickShop-Hikari v2.0.0.0:

Added support for Per Shop permission management for "quickshop-hikari.search". If for a shop, the shop owner Steve configures Alex to be in a group that does not have "quickshop-hikari.search" permission, then Alex won't be able to see that shop in GUI when searching.

Bug Fix:
Fixed a bug that broke autocompletes for all commands in-game.

To view a full list of changes in the new v2.0 Shop Search AddOn, click here.

=======================================================
Note: This is a SNAPSHOT build as there are a lot of new features added. Backup your QSFinditemAddOn folder inside /plugins before upgrading. Since its just me developing this add-on, its not possible for me to test it completely. So, I do not recommend it for production servers as of now. If you find any bugs, please report them here.

If you want a stable version of this add-on, download v1.9.2 from here. But you will miss out on the new features in v2.0.
----------, May 15, 2022

Note: This is a SNAPSHOT build as there are a lot of new features added. Since its just me developing this addon, its not possible for me to test it completely. So, I do not recommend it for production servers as of now. If you find any bugs, please report them here.

If you want a stable version of this addon, download v1.9.2 from here. But it won't have the below listed features.


Changes

QuickShop-Hikari Support

It now supports both QuickShop-Reremake and QuickShop-Hikari.

Hexcode color support

All messages in the config.yml now support hexcodes so you can get a lot more creative with colors.

Different commands for players and admins
The /finditem command is now split into two:
  • /finditem - This will support the usual shop searches and hiding
  • /finditemadmin or /fiadmin - This will support plugin reloads
    • For example: /fiadmin reload
View all shops on server
Now you can do /finditem TO_BUY * or /finditem TO_SELL * to view all shops on the server. As of this version, the sequence is always randomized. Sorting options are a work in progress.

New shop visit count
Now you can choose to display shop visits count in the shop lore in Search GUI. Just add the placeholder {SHOP_VISITS} in the "shop-gui-item-lore" in config.yml. To prevent visit spamming, a new config property "shop-player-visit-cooldown-in-minutes" has been added. Please don't use decimals here LOL.

New storage format
The "hiddenShops.json" will automatically be converted to a new file called "shops.json" which will store data of all shops along with their player visit count and whether they are hidden from searches.

New Next/Back buttons
The default next/back buttons are now fancy playerheads to make more sense. If you don't wish to use them, just specify the material in the config.yml.

Customizable command aliases
Added a new property in config.yml called "command-alias" where you can specify your own list of command aliases for /finditem command. If you don't wish to add any, just make it as:
Code (Text):
command-alias: []
Bug fix:
  • Removed an erroneous config field "warp-player-to-nearest-warp".
  • Fixed an issue where it will load up the plugin before QuickShop is done loading causing it to disable itself. Thanks Baran for reporting :)
  • Added support for EssentialsX /back

All new config options will be added automatically upon updating. Refer link to view a sample config.yml with all fields explained.
----------, May 14, 2022

This is a SNAPSHOT build as there are a lot of new features added. As I am just a single person developing this addon, its not possible for me to test it completely. So, I do not recommend it for production servers as of now. If you find any bugs, please report them here.

If you want a stable version of this addon, download v1.9.2 from here.

QuickShop-Hikari Support

It now supports both QuickShop-Reremake and QuickShop-Hikari.

Hexcode color support

All messages in the config.yml now support hexcodes so you can get a lot more creative with colors.

Different commands for players and admins
The /finditem command is now split into two:
  • /finditem - This will support the usual shop searches and hiding
  • /finditemadmin or /fiadmin - This will support plugin reloads
    • For example: /fiadmin reload
View all shops on server
Now you can do /finditem TO_BUY * or /finditem TO_SELL * to view all shops on the server. As of this version, the sequence is always randomized. Sorting options are a work in progress.

New shop visit count
Now you can choose to display shop visits count in the shop lore in Search GUI. Just add the placeholder {SHOP_VISITS} in the "shop-gui-item-lore" in config.yml. To prevent visit spamming, a new config property "shop-player-visit-cooldown-in-minutes" has been added. Please don't use decimals here LOL.

New storage format
The "hiddenShops.json" will automatically be converted to a new file called "shops.json" which will store data of all shops along with their player visit count and whether they are hidden from searches.

New Next/Back buttons
The default next/back buttons are now fancy playerheads to make more sense. If you don't wish to use them, just specify the material in the config.yml.

Customizable command aliases
Added a new property in config.yml called "command-alias" where you can specify your own list of command aliases for /finditem command. If you don't wish to add any, just make it as:
Code (Text):
command-alias: []
Bug fix:
  • Removed an erroneous config field "tp-player-to-nearest-warp".

All new config options will be added automatically upon updating.
----------, May 14, 2022

More details can be found here.
----------, Apr 7, 2022

Fixed 2 bugs in this version:
  1. hiddenShops.json would get wiped if there is an error in the config.yml forcing the plugin to disable itself.
  2. Shop teleportation wouldn't work if in GUI the next/previous button material is same as the one the player is searching for.
----------, Apr 4, 2022

Optimized Search
Made several optimizations to the shop search algorithm so it should now be able to handle large number of shops (> 1000)

New Shop Teleportation Options
Added option to configure whether player should be able to teleport to the shop or to the nearest warp.
Added some new options in the config.yml:
upload_2022-2-5_21-8-23.png

These changes should get reflected automatically in your existing config.yml file.
You can refer the sample config.yml to know more on each of those new properties.

Removed /finditem updatelist command that was used to update the EssentialX Warps. Now you can use /finditem reload for the same purpose.
----------, Feb 5, 2022

Added support for 1.18.

If you find a bug, please raise an issue here.
----------, Dec 28, 2021

This is a quick hot fix for issue #10 where anyone could use /finditem hideshop and hide someone else's shop. This was a major oversight and has now been fixed with this version.

Only the shop owner can now hide/reveal their shops.
----------, Nov 10, 2021

  • Now you can hide your shop from appearing in /finditem searches.
    • Do /finditem hideshop while looking at the chest shop (NOT the shop sign) you wish to hide and it will no longer appear in searches.
    • Do /finditem revealshop while looking at a hidden chest shop to make it public again.
    • Requires finditem.hideshop permission to run the above two commands.
  • Added support for QuickShop v5.0. With this support, this addon will no longer work with v4.0 and below as official support for those versions have ended.
This version has been in development for a while now and might still have bugs, please use this link to raise an issue if you encounter one.

As always, thanks for using this addon!
----------, Nov 6, 2021

  • Added a new option in config.yml 'nearest-warp-mode'. By default it will be set to 1 (Essential Warps).
upload_2021-9-18_21-51-53.png
  • Added Essential Warps support for fetching nearest warps.
    • Global warps list for essentials is updated in batches every 15 minutes due to technical limitations, which is then used in every search query.
    • If you added a new warp and want it to get updated immediately, run /finditem updatelist
    • Remember, this applies only to Essential Warps.
  • Added WorldGuard region support for fetching nearest WorldGuard region (if overlapping regions, highest priority will be chosen)
  • Added a new option in config.yml 'blacklisted-worlds'.
upload_2021-9-18_21-52-57.png

All new config options will be added automatically to existing config files. If you face any issues, my discord is on the plugin overview page.
Updated config.yml with comments can be found here.
----------, Sep 18, 2021

  • When performing a query based search, teleportation wouldn't work for all item types. It's fixed now.
  • Fixed a small bug with safe teleportation system.
----------, Sep 7, 2021

  • Added PlayerWarps (by Olzie-12) integration. Can now show the nearest warps to each shop in the search result (check sample config.yml to know how to configure)
  • Fixed a bug where doing a query based search with more than one material type will show only one type of material in the GUI.
  • Added option to search through loaded shops only.
Not required to regenerate config file, as extra options will get added to the existing file automatically when you update.

Known issues & WIP Features:
- Doing a /qs reload will make this addon and all other QuickShop addons stop working (Spigot limitation). Please restart your server if you recently reloaded QuickShop plugin.
- Working on integration of PWarps in future. On hold due to unavoidable technical challenges.
----------, Sep 5, 2021

  • Removed EssentialsX plugin dependency, so you are now free to use any economy plugin as you wish.
    • Currency symbol now needs to be mentioned in the shop lore in config.yml
  • Autocomplete for /finditem command to select between buying/selling shops can now be customized. upload_2021-8-22_15-18-2.png
  • Search GUI title is now customizable as well. upload_2021-8-22_15-23-16.png
You need to regenerate your config.yml if you wish to use the above changes, otherwise not needed.

Finally, huge thanks to the community for all the suggestions so far in making this addon better for everyone else. Do consider leaving a 5 star rating if you found it useful. :)
----------, Aug 22, 2021

  • Teleportation to shops will be much more safe now.
  • Fixed a bug where color codes were not being translated in chat.
----------, Aug 21, 2021

  • Fixed a bug with /finditem reload command when run from console
  • Few under the hood performance and stability fixes
----------, Aug 19, 2021

Note: This update contains major config.yml updates and name update so please delete the data folder of this plugin before updating to this version.
  • Almost all labels shown in the search GUI are now configurable in config.yml
  • Added 3 sorting methods (Random, based on price, based on stock)
  • Added option to set custom model data for GUI bottom bar navigation icons for those who want to use custom textures
  • Added a permission node "finditem.shoptp" for those who want to enable shop TP in general but wish to restrict it for some players.
  • Enchantments and potion effects should show up perfectly now along with enchant glint and potion color (still respects hide enchants and potion effects flag)
This update has gone through a lot of testing so I will mark it as a final release at this point. If you still find any issues, the link to report it is this.
----------, Aug 14, 2021

  • Minor bug fixes, code cleanup and optimizations
  • Added 3 new command aliases
    • /searchitem
    • /shopsearch
    • /searchshop
  • Added anonymous bStats metrics (This will help me get some insight and help me add more features in future)
----------, Aug 10, 2021

Two fixes in this version:
  • Now you can view all the shops that match your search criteria using multiple navigable GUI pages.
  • Fixed a minor bug with command /finditem reload when run from console.
ss8_1.png

Bugs may still exist in this version. So please raise an issue here if you find one and try to provide as much details as possible.

Thanks for using this QuickShop addon!
----------, Aug 10, 2021

Resource Information
Author:
----------
Total Downloads: 2,745
First Release: Aug 8, 2021
Last Update: Nov 25, 2024
Category: ---------------
All-Time Rating:
11 ratings
Find more info at github.com...
Version -----
Released: --------------------
Downloads: ------
Version Rating:
----------------------
-- ratings