Guild Inventory 

Guild Inventory is the solution to a guild banker's problems. It scans your guild bank character's bank (of which you may have multiple), and allows others in your guild to see its contents.

V3 - Now facilitates actual guild banks!

IMPORTANT: If nothing else, read the Initial Setup (either mass distribution or in-game) section, as it is crucial to the mod's operation!

Note: this also works for communities formed over several guilds. The difference is that bank data is "advertised" over raid, rather than guild messaging.


Data Transfer
Guild Inventory works by transferring data through (hidden) whispers, so it cannot be intercepted by unintended players. Every few seconds, Guild Inventory broadcasts the list of banks it has data for in the guild and raid (using the addon messages, so nobody will see anything even if they don't have the mod), and how recent the data is. Any other player with the addon that needs said bank data will ask for it, and if the password is correct, will receive it. No data is transmitted without being set up to be - e.g. your main character's inventory will never be sent unless you specifically set up the mod to do so.


Initial Setup - Mass Distribution
For the preferred distribution method, this mod requires an initial setup via modification of the GuildBanks.lua file with a standard text editor (although probably not Notepad, use Wordpad instead). The idea is that the guild or community leader will set the addon up with all the relevant bank details, and then upload it on to their website (or otherwise give it to all guild members).

In this file, you will find the following LUA function (approximately):

You can remove and add to these as you see fit, just don't change the "content" or "updated" fields. An example from my own guild would be:
Where you see "Example1", that is the bank character's name. ["name"] refers to the name that appears on the list.

Initial Setup - In-game Method
If modification of the LUA file does not appeal to you, then you can use in-game commands to create, edit and remove banks from Guild Inventory. Note that for mass distribution throughout a guild, this method is a little more tedious, as everyone else has to do the same too. The main commands for this are:

/gi create bank <Bank Character>
/gi delete bank <Bank Character>
/gi password <Bank Character> <New Password>
/gi clear bank <Bank Character>

Each is self-explanatory. When a bank is created, it's password is defaulted to the character name of the bank character, but it is recommended you change it. From default settings, Guild Inventory has 3 example banks, which should be deleted first. These banks just serve as a convenience for the mass-distribution method, and are included for that reason. Keeping them in the system won't cause any harm, but they will still appear in the list, hence it is better to delete them.


Distribution
Re-package the files and upload them to your guild website or equivalent, and ask everyone in the guild to download it. Note that anyone that downloads that particular distribution of the mod will be able to read your guild bank's content if they are in a raid group with another in your guild, so restrict access to the download, or send it via other means. For version 1.5.0 and onwards, you should be able to just update from this site.

If everyone is willing to do the in-game setup, then you can just direct them to this site, but you'd have to tell them which banks to create and the passwords set for them. For small distributions, this may be more appropriate.


In-Game Operation
Once the intial setup is complete, in-game operation is straight-forward. All commands can be viewed with the '/gi help' command. For normal operation, log in to one of your guild bank characters. Open up the bank, and then type '/gi scan'. It will then perform a scan of all items in your inventory and bank, and load them in to memory. If another guild member is online (with the mod set up in the same way), then the guild bank's content will be automatically transferred to them. Repeat this process for any other banks.

You can type '/gi' or '/gi show' to view Guild Inventory, and all banks that were scanned, or content that was transmitted to you. Bank content data cascades through online players. Anyone with more up-to-date data will send it to those with out-dated data, so you end up with everyone having the latest guild bank information. Guild bank information is saved between sessions, and is not character-specific.

If you want to send a request for an item to the relevant bank, open up a mailbox, type '/gi' to show the Guild Inventory window, select the required bank, and double-click the item of desire.

Now there's a minimap icon! Currently, it's only functionality is left-click to open up Guild Inventory, but more features coming soon.


Sending Bank Details to Others - New Feature!
In version 1.2.0, you can send bank authentication details to other players, if they're using that version of the addon. You will only be able to send details to others in your guild or raid. To do so, type '/gi broadcast'. The rest is self-explanatory.


Upgrading
It is recommended that when you update the addon afer a major update, you perform a reset of all the data. Note that this will clear all banks, and restore the "factory" default settings. Type '/gi resetall' to do this. If you have custom settings in the GuildBanks.lua file, then it will load these instead.


Exporting
You can, as of 2.1.0, now export data from Guild Inventory. There are 3 supported formats; plain text, item tags, and url tags (linking to thottbot) for phpBB. To do so, type:
/gi export Mybank url
/gi export Mybank item
/gi export Mybank text

You can then copy the data using Ctrl-C, and paste it in to the browser window. Use '/gi export' (without parameters) to see the latest list of exportable formats.


Comments
Any comments would be greatly appreciated, especially if they further development. If needed, you can contact me (Wintry) in whispers or mail on Argent Dawn (EU). Don't forget to vote if you like it!


Version History
3.0.0
- Now supports actual guild banks. Commands such as '/gi create guildbank <Name of Guild>' allow you to do this. Please see '/gi help' for more commands. To scan a guild bank, open the guild bank, cycle through all tabs (this loads the data from the server), and then just type '/gi scan' as normal.
- Items now show their locations on hover-over, such as guild bank tabs.
- Due to these changes, 3.0.0 is incompatible with previous versions.

2.2.0
- Now compatible with WoW 2.1.
- Switched from whisper communication to "addon whisper" communication. This has the added benefit of not producing errors when your character is drunk, for starters.
- Due to this change, version 2.2.0 will not interface with Guild Inventory 2.1.0 or lower.
- Bank data will be automatically cleared on first addon load upon upgrading.

2.1.0
- Now has the capability to export data, using the /gi export command. See the section "Exporting" for more information.

2.0.0
- Major update - No longer compatible with pre-2.0.0 versions. Older versions won't fail to run, but they will not communicate with a 2.0+ version.
- Banks automatically cleared on first-load due to storage changes.
- No actual links are transmitted any more, so disconnects should not occur.
- Now you can Ctrl-Click an item to view it on yourself (if it can be worn).
- Shift-Clicking an item will copy the link in to the chat window.

1.8.3
- You can now close the Guild Inventory window with the escape key.

1.8.2
- Fixed a bug with transfers timing out (timeout wasn't resetting when items were received).

1.8.1
- Fixed a bug (caused by using an old version of ChatThrottleLib), bringing up error messages.

1.8.0 (Beta)
- I've now integrated ChatThrottleLib in to Guild Inventory in order to permanently solve the disconnection problem. However, this has not been fully-tested yet. You may use this version if you like, but I cannot guarantee it will work properly.

1.7.0
- Added two commands to show/hide the minimap icon, '/gi showminimap' and '/gi hideminimap'.
- Tripled the time inbetween data transfer elements. This may or may not fix the disconnect issue, but if it does, it's only a temporary fix.

1.6.1
- Seems I left some debug code in 1.5.1, which is now removed. Sorry about that!

1.6.0
- Added a minimap icon with functionality to open Guild Inventory (thanks Gello!)
- Once opened for the first time since login/reload, Guild Inventory will show a much smaller amount of boxes
- Guild Inventory window is now clipped to the screen. This also allows you to keep the window at a corner of the screen, for example, irrelevant of inventory size.

1.5.1
- Fixed a bug which caused the addon to crash when it encountered certain items.

1.5.0
- Now improved for distribution - default banks are in GuildBanks.lua, to be changed by guild leaders.
- Fixed a bug whereby if you were to transfer data to a person in AFK status, an AFK message would appear for every item transferred. (Should be fixed, but let me know if it isn't)

1.4.2
- Updated to work with WoW 2.0.3.

1.4.1
- Accidentally left debug mode on, fixed now

1.4.0
- Improved sorting order. Now arranges items (but will require a rescan/transfer to take effect) in the following order: Consumables, trade goods, reagents, recipes, miscellaneous, everything else (depending on categories assigned by Blizzard).

1.3.0
- Added a new command, '/gi movable' which toggles the movability of the panel, and removes the blackness.
- Guild bank contents now fits in to a smaller window, varying size by the quantity of stuff inside it.

1.2.0
- Added ability to send bank authentication details to others with the '/gi broadcast' command.

1.1.1
- Bug fix: sometimes when in a raid, broadcasts would not be made. This should be fixed.
- Bug fix: Punctured Voodoo Doll should no longer stack (will require a re-scan).
- The addon will no longer broadcast during combat, this is just to prevent possible lag.

1.1.0
- Improved command-line use, now no longer requires editing of the LUA (although is still recommended).
- When the Guild Inventory window is open, you can no longer control your character with the keyboard.