GuildTools v 2.0 (formally GuildBank)
Table of Content
1. About GuildTools
2. Installation
3. Using GuildTools
-BankScan
-IncomingMail
4. Number of suggestions on using AddOn
5. FAQ
1. About GuildBank
GuildTools is a combination of tools for guild use.
Contains 2 parts:
BankScan (BS) - allows to scan characters possesions (including personal posessions and content of the bank) and pars it for the web site. Consists of 2 parts: WoW addon part and executable aplication for data parsing.
IncomingMail (IM) - automatically grabs all items and money sent to the character through ingame mail on open of the mailbox. Also keeps track of every received item (and money) in database, also give capability to pars that data for web site. Consists of 2 parts: WoW addon part and executable aplication for data parsing.
2. Installation
************ Important *************
If you used older version of this AddOn (GuildBank) you will have to remove it and then install GuildTools.
To remove GuildBank do the following:
Remove GuildBank folder from WoW/Interface/AddOns/ folder.
Run WoW.
Exit WoW.
To install GuildTools:
Unrar the content of the archive into WOW/Interface/AddOns/ folder, where WOW is the location of your WoW (by default: c:/Program Files/World of Warcraft).
There is an optional component available, called ImagePack. This part contains all the WoW icons you might need in .jpg files. Images needed for html files.
3. Using GuildTools
GuildTools (GT) is the master AddOn that invokes smaller parts (ie BS, IM).
In order to activate GT for your current character you will need to run / command: '/gt on' in-game.
Typing '/gt info' in-game will display the available / commands for GT.
Currently there are 2 subAddOns built into GT:
Bank Scan:
This part of AddOn will scan the possesions of the character (including bags and bank) and parse it into html or text file.
BS consist of two parts: BankScan and BankParser (TextBankParser).
To obtain the html file with the items in posession of guild bank character follow the folowing steps:
- Run WoW and activate GuildTools.
- Log in as the character, whos posessions need to be scanned.
- Activate BankScan ('/gt bson', GT has to activated for this character).
- Open the bank dialog window.
- Type '/gt bsinfo' in the chat window to get information on BankScan commands.
- You can type '/gt bscan' to scan inventory.
- If BankScan succedes you will get the message that it did, otherwise you will get error message, in that case try to eliminate cause of the error in messages description.
- Close WoW via exit button.
- Copy GuildTools.lua file from WoW/WTF/Account//SavedVariables/GuildTools.lua to WoW/Interface/AddOn/GuildTools/SV/. Very important not to copy it to WoW/Interface/AddOn/GuildTools/ because this will screw up the addon.
- Run BankParser.exe from GuildTools/apps/
- Your html file (index.html by default) is located at WoW/Interface/AddOn/Guildtools/html/ you can edit and/or upload it as you wish.
Advanced mode of BankParser
Advanced mode is available for BankParser application. Please do not use advanced mode unless you understand at least basics of html and programming because resulting html file might get corupted if inproper atributes are entered. To get more information on advanced mode run 'BankParser.exe -?'.
Using TextBankParser
TextBankParser is another parser available for parsing bank info. This intended to be used to upload data into the database. Aplication is for advanced users. That application (located at GuildTools/apps/) will parse info into text file format. On the info on how to use TextBankParser run it without any parameters. It is comand prompt program, so run it from separate command prompt.
Incoming Mail:
This part of AddOn will grab the items and money from the inbox as soon as mailbox is opened and will record all the transactions for later parsing it into html or text file.
IM consist of two parts: IncomingMail and MailParser (TextMailParser).
To have IM grab your mail automatically do the following:
- Run WoW and activate GuildTools.
- Log in as the character, whos mail you want to be handled.
- Activate IM ('/gt imon', GT has to activated for this character).
To obtain the html file with the items and money received by this character follow the folowing steps:
- IM should be activated for the character in question.
- Type '/gt iminfo' in the chat window to get full information on IM commands.
- You can type '/gt imsave' to set all the registered mail for this char to parse.
- IM should prompt you on success.
- Close WoW via exit button.
- Copy GuildTools.lua file from WoW/WTF/Account//SavedVariables/GuildTools.lua to WoW/Interface/AddOn/GuildTools/SV/. Very important not to copy it to WoW/Interface/AddOn/GuildTools/ because this will screw up the addon.
- Run MailParser.exe from GuildTools/apps/
- Your html file (donations.html by default) is located at WoW/Interface/AddOn/Guildtools/html/ you can edit and/or upload it as you wish.
Advanced mode of MailParser
Advanced mode is available for MailParser application. Please do not use advanced mode unless you understand at least basics of html and programming because resulting html file might get corupted if inproper atributes are entered. To get more information on advanced mode run 'MailParser.exe -?'.
Using TextMailParser
TextMailParser is another parser available for parsing mail info. This intended to be used to upload data into the database. Aplication is for advanced users. That application (located at GuildTools/apps/) will parse info into text file format. On the info on how to use TextMailParser run it without any parameters. It is comand prompt program, so run it from separate command prompt.
4. Number of suggestions on using AddOn
- Items in resulting html file go in the same order as they appear in your invetory, so sorting them before scan will make your html file more orgnized.
- Here's a suggestion on how to orgonize your donations page:
Let's say you update your page with rescent donation once a day and you want the history to be stored on weekly basis (ie one pake for week worth of donations) then you can do this: Every day you run /gt imsave and run MailParser afterwards, then upload the resulting file on your website.
Once a week run /gt imsave and /gt imclear. /gt imclear will clear all the mail currently saved, data for MailParser will remain intact though. then run MailParser and add resulting html file to your weekly archive.
5. FAQ
Q:
I cannot see the tooltips on the page. What did I do wrong?
A:
If you copied the text from the generated html file make sure you copied it all. Most likely you are missing java script at the top of the html file.
Q:
I just look at the generated html file and still can't see the tooltip, other people say they can see it.
A:
There is a setting in brouser that disables Active content. Tooltip is actually active content, so if it is disabled you will not be able to see the tooltip.
Q:
I ran the script, but when I try to run BankParser.exe it says that data was not found in SavedVariables.
A:
Make sure you follow all the steps:
- Run WoW and run /gt bscan with bank window opened. You should get message like: "Scan was successful ... run .exe"
- Exit WoW, or at least log out from current character.
- Copy GuildTools.lua from WoW/WTF//SavedVariables/ to the addon folder (WoW/Interface/AddOns/BankScan/SV/)
- Run BankParser.exe.