Skip to content

Find Feature

Sparkling Comet edited this page Sep 24, 2023 · 3 revisions

Find Feature

This feature is designed to allow players to find shops that sell and/or purchase specific items within a specified range.

Goals

Expand
Goal Status Ver Added in
Basic Implementation Completed V1 2.6.1
Basic variable command allowing user to choose options Completed V1 2.6.1
Improved text command usability Planned V2 N/A
GUI interface using creative GUI to select items Planned V2 N/A
Track first command with a held compass Planned V3 N/A

Usage

Expand
Feature Stats
Usable By Players Only
Requires
Permissions
Yes
Permissions
needed
tradeshop.info.find
Command
usage
/tradeshop {command} {options}
Commands
and
Aliases5
  • Find
  • Where
  • Near
Command
Options
Name5 Aliases5 Listable Re-Usable Value Type Examples
Cost
  • C
Yes1 Yes2 Name of desired cost(s)
  • cost:dirt
  • cost=diamond
  • c:diamond,gold_ingot
  • cost=iron_ingot,coal_ore
Product
  • P
Yes1 Yes2 Name of desired product(s)
  • product:dirt
  • product=diamond
  • p:diamond,gold_ingot
  • product=iron_ingot,coal_ore
In-Stock
  • S
  • InStock
  • Stock
No No Boolean3
Range
  • R
  • D
  • Distance
No No Integer6
Config
Options
Name Path Value Type Default Value Note
max-find-range global-options:
global-find-options
Integer6 256
  • This value sets the maximum
    value any player can use for
    range in a find command.
  • Setting this value to 0 will
    disable the find command.
  • Larger values can lead to
    exponential increase in server
    lag during find commands.
  • Minimal testing done above 256.

default-find-range

global-options:
global-find-options
Integer6 64
  • This sets the default range
    of a find command if none is specified
  • Larger values can lead to
    exponential increase in
    server lag during find commands.


1. Listable options can reference multiple values together. They are separated with a comma(,) and must not have any spaces.
For Example: "cost:dirt,stone" would look for shops with a cost of dirt AND stone

2. Re-Usable can be used multiple times in a single command. They each will have their own option name and separator(: or =) and will be treated as separate options.
For Example: "cost:dirt cost:stone" would look for shops with a cost of dirt OR stone

3. A boolean value is either True or False
Other True options: t, tru, yes, y, all

4. Values marked by this would be used if the option is not specified

5. Commands and Option names/aliases are not case-sensitive. (A=a)

6. An integer value is a whole number with no seperating characters (, or .)
Examples: 1, 5, 1000, 354, 10738

Wiki Index

Downloads

  • You may download the latest version here.
  • You may clone the source with the command git clone https://github.com/TradeShop/TradeShop.git
  • You may also clone the whole wiki to your computer with the command git clone https://github.com/TradeShop/TradeShop.wiki.git.

Contact

You may contact the developers for any reason on Discord or on GitHub.

License

The entire project is licensed under the Apache License v2.0.

Clone this wiki locally