Buy Dropper file

By Cogwheel — v0.9B1
Inspired by FreeRefills by Kyahx

BuyDropper keeps a list of items to purchase automatically from vendors.

Please visit Cogwheel’s Workshop for updates, bug reports, feature requests, etc.

THE SOFTWARE IS PROVIDED “AS IS”, WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

* Guide
o Managing your list
+ Adding items
* Reference
o options
o add
o list
o change
o priority
o remove
o clear
o vendor
+ toggle
+ confirm
+ budget
+ fallthrough
o bank
o overstock
o dropper
+ toggle
+ position
+ label
o profile
o standby
o about
* Bugs/Improvements
* Changes

Guide
Managing your list
Adding items

The first thing you’ll want to do is add an item to BuyDropper’s tracking list. This can be done in two easy ways. By default, every vendor window has a dropper in the upper right and there is also a dropper on BuyDropper’s options window. Simply drag and drop an item onto one of these droppers and a window will appear where you can enter the amount you want to track. When you click Accept or press Enter, BuyDropper will print a message showing the item and quantity added to the list.

The other way to add items is the /buydropper add command. This duality of GUI/slash commands is seen throughout BuyDropper’s operations. For the rest of the guide, I will focus on the GUI aspects. You can use the Reference below to discover how to use the various commands.

[TODO: Rest of the documentation. For now, take a look at /buydropper options and the Reference below]
Reference

These are all the slash commands available from BuyDropper. Typing /buydropper (or /bd) will show this list of commands. Sub-commands are displayed when you enter the main command with no options. E.g. /buydropper vendor will display all the sub-commands of vendor.
options

Usage: /buydropper options

Opens the BuyDropper options window. The options window provides support for most of the operations of the following slash commands. Any that are unique to the slash commands will be so noted.
add

Usage: /buydropper add

Adds an item to the bottom of your tracking list or changes the amount of an item you are already tracking.

To use this command, type /buydropper add with a space after it. Now shift-click any item at a vendor, in your backpack, on your character, etc. Add another space, and type in the amount of the item you want to track.
list - slash command only (for now)

Usage: /buydropper list

Lists the items you are currently tracking in order of descending priority.
change - slash command only (for now)

Usage: /buydropper change

Changes the tracking amount for the given item. priority is obtained from the list command. amount must be 1 or more.
priority - slash command only (for now)

Usage: /buydropper priority

Changes the priority of an item in your tracking list. current priority is obtained from the list command. new priority must be a number from 1 to the number of items you are tracking. The item’s entry is removed from its current location and inserted at the new priority, shifting the item currently at that priority down the list.
remove - slash command only (for now)

Usage: /buydropper remove

Removes the item at the specified priority from your tracking list.
clear

Usage: /buydropper clear

Clears all items from your list. A confirmation will appear to make sure you mean it.
vendor

Usage: /buydropper vendor

Sub-commands:
toggle

Usage: /buydropper vendor toggle
Default: enabled

Toggles whether vendors should be scanned for items you are tracking.
confirm

Usage: /buydropper vendor confirm
Default: enabled

Toggles whether to confirm purchases from vendors.
budget - slash command only (for now)

Usage: /buydropper vendor budget
Default: 50

Sets your budget for automatic purchases from vendors. number must be from 1 to 100 and represents the percentage of your total money BuyDropper is allowed to use when purchasing a given item at a vendor. This is only applicable if the confirmation is turned off.
fallthrough - slash command only (for now)

Usage: /buydropper vendor fallthrough
Default: disabled

Toggles whether to continue purchasing lower-priority items when higher-priority items cannot be purchased for lack of space or money.
bank

Usage: /buydropper bank
Default: enabled

Toggles whether to withdraw items from the bank. Note: bank withdrawals are not yet implemented.
overstock

Usage: /buydropper overstock
Default: disabled

Toggles whether to overstock items that come in preset stacks like food or water. For example, say you are tracking Ice Cold Milk × 20 and you have 17 in your inventory and you open a vendor who sells Ice Cold Milk. With overstock enabled, you will buy a bundle of 5 to bring your total to 22.
dropper

Usage: /buydropper dropper

Sub-commands:
toggle

Usage: /buydropper dropper toggle
Default: enabled

Toggles whether to show the dropper in vendor windows.
position

Usage: /buydropper dropper position
Default: 100

Sets the position of the dropper in vendor windows. number must be from 1 to 100 and represents the percentage from 0 in the far left to 100 in the far right.
label

Usage: /buydropper dropper label
Default: enabled

Toggles whether to show the label next to the dropper in vendor windows.
profile - slash command only

Usage: /buydropper profile

Sub-commands:
choose

Usage: /buydropper profile choose
Default: Character: of

Chooses a pre-existing profile to use for BuyDropper’s settings. This is stored per-character so every character can use a particular profile. Using this command without providing a profile parameter will display a list of possible profiles to use. If you want to create a new profile, use the other sub-command.

You can provide either the full name of the profile, e.g. Character: Cogwheel of Shadowsong or a shortcut. Possible shortcuts are char, realm, or class.
other

Usage: /buydropper profile other
Default: char

Similar to the choose sub-command, but creates a profile if the name you specify does not exist.
copy

Usage: /buydropper profile copy

Copies the data from another profile into your currently active profile. Running this command without providing a profile will display a list of profiles from which you can choose.
standby - slash command only (for now)

Usage: /buydropper standby
Default: enabled

Turns BuyDropper on and off. When disabled, it will not do anything when you open a vendor or visit the bank.
about - slash command only

Usage: /buydropper about

Displays some basic information about BuyDropper.
Bugs/Improvements

* The GUI is not complete:
o It does not support the Budget or Fallthrough vendor options.
o The tracking list is not functional (hence none of the tracking list controls are either).
* BuyDropper does not yet withdraw items from the bank

Please visit Cogwheel’s Workshop if you have any suggestions or bug reports, and to see what is in store for the future.