Prospectus

# Prospectus Paper plugin for Minecraft servers running [Shopkeepers](https://github.com/Shopkeepers/Shopkeepers). Lets players search for shops by item and check their own shop stock. **Requirements:** Paper 26.1.2+, Shopkeepers 2.27.0+ --- ## Commands | Command | Description | |---|---| | `/who sells ` | List shops selling the item, sorted cheapest per unit first | | `/who buys ` | List shops buying the item | | `/stocks` | Show your own shops and which trades are out of stock | | `/stocks ` | Show another player's shop stock | | `/prospectus addarea pos1` | Set region corner 1 to your current position | | `/prospectus addarea pos2` | Set region corner 2 to your current position | | `/prospectus addarea submit` | Save the cuboid between pos1 and pos2 as a region filter | `` accepts a Material name (`diamond sword`) or an enchantment (`sharpness`, `mending`). Enchantment search matches both applied enchantments and stored enchantments (enchanted books). Searches look inside shulker boxes and bundles, so a shulker of dirt shows up when searching for dirt; the contained quantity is used for price ordering. Results are paginated with clickable arrows (page size is configurable). Hovering item amounts shows the full item tooltip. Hovering the owner name or distance shows coordinates. Shops within the configured radius are highlighted in-world with a glowing outline visible through walls. `/prospectus addarea` writes to the `regions` list in the config and applies immediately, but region filtering only takes effect once `regions.enabled` is set to true. --- ## Permissions | Node | Default | Description | |---|---|---| | `prospectus.who` | true | Use `/who sells` and `/who buys` | | `prospectus.stocks` | true | Use `/stocks` to view own shops | | `prospectus.stocks.others` | op | Use `/stocks ` | | `prospectus.tp` | op | Click a shop entry in chat to teleport to it | | `prospectus.addarea` | op | Use `/prospectus addarea` to define region filters in-game | | `prospectus.excluded` | false | Hides the holder's shops from all search results | --- ## Config `plugins/Prospectus/config.yml` is created on first run. Options: ```yaml settings: page-size: 5 # entries per page for /who and /stocks include-admin-shops: true excluded-permission: "prospectus.excluded" blacklisted-players: [] # list of UUIDs to exclude blacklisted-items: [] # items/enchantments that cannot be searched highlight: enabled: true radius: 32 duration-seconds: 30 regions: enabled: false list: [] # cuboid filters: {world, min-x, min-y, min-z, max-x, max-y, max-z} colors: # named colors or hex; styles the built output amount: "white" second-item: "white" shop-name: "yellow" distance: "dark_aqua" world-name: "white" separator: "dark_gray" label: "gray" in-stock: "green" out-of-stock: "red" format: # MiniMessage templates search-title: ":" stocks-title: " shops:" search-row: " " stocks-row: " " ``` Both titles and rows are MiniMessage. Row templates receive pre-built placeholders that carry their own item tooltips and click-to-teleport actions, so you can rearrange and restyle rows while keeping the interactive parts intact. Available placeholders: - `search-title`: `` (searched item/enchant) - `stocks-title`: `` ("Your" or "``'s") - `search-row`: ``, ``, ``, ``, ``, ``, `` - `stocks-row`: ``, ``, `` The `colors` section styles the pieces inside those placeholders (amounts, item names, stock numbers, separators, etc.).