QSFindItemAddOn

QSFindItemAddOn Archived

Shop Search AddOn For QuickShop

An unofficial add-on for the QuickShop Reremake and Hikari spigot plugin. Adds a /finditem command in game for searching through all the shops on the server.

MC Ver

Features

  • Search items based on buying/selling shops
  • Search items by item type
  • Supports query based item search
  • Supports item custom model data for custom items
  • Configurable shop sorting methods
  • Displays enchantments in the result for enchanted items
  • Hides item enchants if item has hide_enchants flag
  • Displays potion effects in the result for Potion items
  • Hide certain shops from appearing in search lists
  • Supports completely safe direct shop teleportation (configurable in config.yml)
  • Ignores shops that are out of stock by default
  • Support for world blacklisting (Shops in blacklisted worlds are ignored in the search result)

Sample config.yml with each field explained

  • For AddOn v2.* - Link
  • For AddOn v1.* - Link

QuickShop-Hikari Support

Hexcode color support

  • All messages in the config.yml support hexcodes.

View all shops on server

  • 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.

Shop visit count

  • 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. 😄

Customizable command aliases

  • You can find a 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:
command-alias: []

Integrations

  • Supports PlayerWarps (by Olzie-12) integration. It shows the nearest warp to each shop in the search result GUI.
  • Supports EssentialsX Warps integration 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 /finditemadmin reload
    • Remember, this applies only to Essential Warps.
  • WorldGuard region support for fetching the WorldGuard region the shop is in (if overlapping regions, highest priority will be chosen)

Requires

OR

Assumptions

  • A compatible economy plugin is installed
  • Vault 1.7.3 or higher is installed

How to use?

Just drop it in your plugins folder, restart the server and you're good to go.
Make sure you have Java 16 or 17 installed on your server machine.

Permissions

  • finditem.use - Enables players to use the /finditem command
  • finditem.admin - For OP. Includes all of the below perms.
    • finditem.reload - Enables use of /finditemadmin reload to reload the config
  • finditem.shoptp - If 'allow-direct-shop-tp' is enabled in config, players require this permission to be able to teleport
  • finditem.hideshop - For running /finditem hideshop or /finditem revealshop

Command Usage

  • /finditem {Arg1} {Arg2}
    • Arg1: TO_BUY or TO_SELL (Customizable in config.yml)
    • Arg2: Item Type from Tab Autofill (Uses Bukkit item types)
  • /finditem {Arg1} {Arg2}
    • Arg1: TO_BUY or TO_SELL (Customizable in config.yml)
    • Arg2: Any word from the Item display name
  • /finditem reload: Reloads the config.yml
  • 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.

Issue & Feature Tracking

Please create a new issue here if you encounter any errors. Please try to explain in detail about your issue, and attach your console log if possible. You can also find the list of features currently being worked on (if any) in the same link.

BStats Metrics

BigImage