Beta Versions

ensure you make a backup copy of your saved variables file before installing a beta version - you cannot revert back to an older version without that backup.

your saved variable file is normally located in \World of Warcraft\WTF\Account\yourwowaccountname\SavedVariables\ArkInventory.lua

a simple way to back it up is to just do a copy and paste then rename the new file (using the version number of AI is a good idea), eg ArkInventory-3-01-09.lua

About

ArkInventory (AI or ARKINV) is an inventory mod that was based off EngInventory when the BtS 2.0.0 patch came out and I needed a working replacement.

AI's display windows are built from "virtual bars", you assign categories (either the default ones or ones you create via rules) to bars so that items in that category are displayed on the specific bars you want. There is no limit to the number of bars you can have inside a window but obviously you only have so much screen real estate before it becomes "too many".

AI uses several methods to assign a default category to an item such as what professions you have, tooltip scanning, basic type/subtype and PeriodicTable. You then assign those categories to a virtual bar.

As the default categories are not perfect, nor will they be correct for the way some people play, you can over-ride them by creating a rule that matches either a single or multiple items.

Keybindings

AI will toggle via B (the default backpack open) or any other key you have assigned to open the backpack (so long as the Blizzard Bag/Bank frames are being hidden). There are also keybinding choices to various other parts and functions from AI.

To access your Keybindings;

• Press ESCAPE to bring up the blizzard menu.
• click on Key Bindings.
• scroll down to ArkInventory.
• bind the keys you want to use (or unbind if required).

Reporting Bugs

Before reporting a bug please check the FAQ and the issues list to see if the bug you are about to report has already been reported (or dealt with).

After checking that your bug hasn't been reported you can create a new issue.

When entering an issue please make sure that you include the following;

• the AI version number (not the svn revision number). AI won't have mid version releases, except betas, and those will have beta version numbers.
• the version of WoW.
• what language (if not english).
• a screenshot for visual bugs (if you can't explain it clearly).
• the error message(s) (if you have an error mod installed then the entire stack trace would be even better).

Known Issues

• replacing a larger bag with a smaller bag can leave some items highlighted (if bag highlight is enabled)
• moving an item from one guild bank tab to another will leave a ghost item behind until you view that tab again (it also increases the tooltip count for that ghost item).
• honor token icon displays the faction for the logged on character, not the displayed character

Version History

If you really want to see what got changed in each revision there is a VersionHistory.txt file included that has all those details.

To Do List

Currently empty, or at least nothing major. ReadMe.txt may have some entries.

Screenshots

Accessing the Options Menu

either through the blizzard addon menu system or you can assign a keybinding to open ArkInventory's options menu directly.

Bag

• Title frame: consists of the main icon, clicking on which will bring up the main menu, then the current characters name is displayed (in green for online and red for offline), lastly followed by several smaller icons which allow you to toggle the other display windows (as well as the current one), the close icon is obvious - this frame can be hidden if not required

• Search frame: enter search text - this frame can be hidden if not required

• Container frame: where your bars and items are displayed

• Bag Changer frame: allows you to move, swap, add or remove a bag (it mirrors the same functionality that the Blizzard frame has) - note that while you have this frame displayed everything needs to be recalculated to cater for a lack of API functionality that can tell me when you've moved a bag so it will be slightly slower with this opened. when you move the mouse over one of the bags it will highlight all the slots in that bag (you can change the colour if you need to). this frame can be hidden if not required

• Status frame: is for showing how many empty slots you have remaining, if you only have normal bags you'll only have a single xx/yy (where xx is the number of empty slots and yy is the total number of slots), if you have profession, ammo or soulshard bags you will also see xx/yy variants for each type of bag, it also has the standard gold frame - this frame can be hidden if not required. You can also format the emply slot status text via the config menus under Settings > Empty Slots > Display Format

Bank (in offline mode)

• The character name will be shown in red (instead of green) and the item icons are faded when you are viewing a bag, bank or keyring in offline mode.

• The item fading is an option that you can turn off if you want to see them at their normally displayed (alpha) level

Guild Bank

• The above shows a user with guild leader access.

• total guild gold is displayed in the status window.

Mail

currently view only

Wearing

currently view only

Pets

Mounts

Tokens

Searching

Locally

ensure that the search frame is not hidden (config menu, settings page)

searching is done against an items name. you can use LUA string patterns, see (link)

enter any text in the search field, as you enter a character any items that do not match are faded so that those that do are more obvious. there is also a clear button on the right hand side that you can click on the clear the search text. (you can also just delete it manually)

Globally

requires that the tooltip option to show item counts is enabled (otherwise all you get is a big list of items that you and all your alts have with no way of seeing whats where)

chat link and dressup clicks are functional

Custom Categories

Custom categories are easy, fast, and efficient. You create a custom categories via the configuration menu, and then just assign items to that custom category.

They do have one downside and that is that they are very basic, they only match against an items ID and soulbound status so where you have an unbound item with an, eg, "of the Wolf" or "of the Owl" sufix, or the same soulbound item but with different enchants/jewels applied then both items would be assigned to the same custom category.

If you need that level of differentiation then you will need to create a Rule to handle it.

Rules

What are rules? Rules let you to categorise your items exactly the way you want to by allowing you to use various bits of item data to write a formula that will match that item (and others like it).

Once you have your rule created you simply assign it to the bar of your choice so that the items that match the rule will are displayed on that bar. Allowable rule functions can be found here and some example rules can be found here

Rules are global, that is every profile can see every rule you create, they can be enabled or disabled per profile and are set to disabled by default when you create a new profile.

Basics

Rule: the number assigned to this rule. you cannot modify this value. rule numbers are assigned sequentially.

Enabled: tick this if you want the rule to be used. disabled rules are ignored. default value is ticked.

Order: rules are processed in ascending numerical order based on this value. default value is 0. if you find that another rule keeps picking up an item you want elsewhere then you would create another rule with a lower order to place it in the proper location. rules with the same order number are processed in a potentially random sequence (or at least one that cannot be known beforehand) so only reuse the same order number if the rules would not have any overlapping items.

Description: a description of the rule.

Formula: a formula that defines which items match a rule, defaults to false.

Data Broker Objects

if you have one of the display mods that can use LibDataBroker objects then you can add any of the objects provided by ArkInventory to it. Bags, Ammo, Currency, Pets, Mounts. see the LDB page for more info.