- RecipeBook: Ayradyss's Addon
- Last Update: 27 May 2009
- Contact: recipebook (at) comcast.net
- Install: Unzip into the World of Warcraft/Interface/AddOns directory.
RecipeBook Version 3.1.0 beta 1
Note: interim builds are available at http://home.comcast.net/~recipebook - but be aware, these builds may be buggy and may or may not be compatible with formal release versions.
A RL Note: I work full-time plus and have a toddler. Real Life always comes first. Please do keep me up to date on bugs and requests, but there may be blocks of 4-6 weeks where I don't do anything but work and sleep, no time for code.
Brief description:
Adds information to recipes on which alts know or can learn them. Color codes recipes in the auction house. Allows sharing of recipe data between accounts.
For example:
I have character BetsyRoss, who is a tailor by nature. She knows Pattern: American Flag, but for some reason, I can never remember this when UncleScrooge goes to the auction house to buy patterns.
- Previously, would have to keep a written or mental list of BetsyRoss's known patterns so that UncleScrooge didn't buy her a second copy of Pattern: American Flag on accident.
- Now, with RecipeBook, UncleScrooge can mouse over Pattern: American Flag and see "Already known by: BetsyRoss" right there on the tooltip - or, if he chooses, in a special chat tab just for RecipeBook information.
It's fun! It's helpful! It's easy to use! It's also still in development, so there are a few known issues and some miscellaneous housework to be done.
Usage
/rb or /rbk or /recipebook will all work for slash commands.
I am aware that RatingBuster uses /rb. That's what /rbk is for :)
General:
- - /rb help : Displays a help message
Sharing:
- - /rb send <alt> to <player> : Sends your RecipeBook data for a given alt to another player. Use 'all' as your alt to send all alts you know. Use 'me' to send just your character. Use 'guild' to send to your guild.
Banking:
- - /rb bank : Displays your banked items and options for banked items.
Skill Display
- - /rb skill : Use /rb skill to open a window which allows you to browse recipes known by alt and tradeskill. So, just in case UncleScrooge were curious, he could type "/rb skill", select BetsyRoss via the dopdown menu accessed by clicking on the "[click to change]" next to his name, and view all her Tailoring recipes.
Searching
- - /rb search : Opens the RecipeBook Search Window. (You can also bind this to a key)
- - /rb search <item> : Searches for items containing the given string.
- - /rb searchmats <item> : Searches for items using materials which match the given string.
Configuration:
- All configuration options can be accessed through the RecipeBook GUI: use /rb config to open this, use the minimap icon to open the configuration, or bind a key to it using the "keybindings" button in your main menu.
Known issues:
- RecipeBook only updates its recipe list when your tradeskill window is open. So, if BetsyRoss just learned Pattern: Giant American Flag, she'll have to open her Tailoring window before RecipeBook (or UncleScrooge) knows about it.
- I suspect Enchant Weapon: Unholy Weapon is still broken.
Compatibilities:
- === For mod authors: ===
- The easiest way to add RecipeBook compatibility to *your* mod is to call the following in your tooltip output:
RecipeBook_DoHookedFunction(tooltip, [link]);
- - Where tooltip is the tooltip (or tooltip name) you're using and (now optional) link is the item link itself. That will add RecipeBook's data lines.
- === Awaiting compatibility data from WotLK and 3.0 ===
Special thanks:
Curse Gaming's Pentarion and Ghandi, for some hard work helping me debug the German client version. Particularly to Pentarion for ongoing translation work.
3.1.0:
- deDE version: Alchimie --> Alchemie; hopefully alchemy will detect now.
- Altered my Auctioneer tooltip hooks to be more in line with Auctioneer's API, thank you the Auctioneer IRC folks. Method to remove duplicate tooltips a little clunky, but seems to work.
- Nil check to RB skill brouse window.
- /rbk searchmats reinstated :D
- When right-clicking an item returned from the Search box, "Has Tradeskill (skill)" line is no longer present if no other alts have that tradeskill.
BETA 2:
- As a workaround for the Taint/focus issue, I've moved the RecipeBook sharing options. It's a little less intuitive, but I'm actively seeking feedback on what you think.
Right-click on the RecipeBook minimap button to get the share menu. It will use your current target if that target is a friendly player; otherwise it will prompt you for a name.
- Those who don't believe in minimap buttons, please continue to use "/rbk send altname to target" to share.
- I've added in "/rbk update from <player>" as well, to request an update from a player.
3.0.8:
FIXED:
- Turning off "banked" tracking for bags will now actually prevent items from being added to your banked list when you pick them up.
- RecipeBook data should now update more accurately when you are actively skilling up.
- No longer requires a relog to update the difficulty of known recipes if it changes while you are logged in.
- Fixed a line 234 error that occurred when mousing over a recipe that had a rep requirement AND a character could learn it in the future.
- Fixed a typo in RECIPEBOOK_ERR_TRADESKILLNOTSCANNED; now possessive is correctly used.
- Now using Blizzard's EasyMenu for some RecipeBook dropdown menus instead of tediously copying Blizzard code; this should improve functionality
- When a character is deleted from the Browse tab their name should no longer appear in the character selection dropdown.
- Fixed line 633 and 652 errors (apparently, that variable is no longer explicitly global)
- Auctioneer's Appraiser tab now includes RecipeBook data for its tooltips.
STILL A BUG:
- I am aware that if you have a lot of Shared data, RecipeBook throws a taint error on trying to Set Focus through the player frame right-click menu. Currently, my options are: 1) Take away the right-click menu for RecipeBook 2) Live with it. I'm trying to find option (3).
PREVIOUS FIXES FROM LAST RELEASE (alpha 6)
ALPHA 7:
- API change: Call RecipeBook_DoHookedFunction(self, tooltip) to pull RB data into a tooltip.
- Some more conversions to match the new Blizzard API in tooltip processing.
- ALPHA ADDITION: There is now a RecipeBook option to auto-save Linked tradeskills as shared tradeskills.
Basically, when you click on a [Tradeskill] link, the opened skill will save just as if that player had shared that skill.
The option is found on your Sharing tab.
ALPHA 8:
- NEW: RecipeBook now defaults its merchant and AH color-coding to only your personal data.
You may change this option on the Options Tab, under Auction and Merchant Options.
- Small adjustment to spacing on Options tab to stop overlap of some options labels.
- Added check to make sure you don't wind up storing yourself as shared data when clicking on links.
- Linked tradeskills default to not being stored. Go to the Sharing tab to enable this option.
- Fixed a rather interesting bug involving deleting characters from the Browse tab. This means they should now delete instead of pretending. :)
- When characters are deleted from the Browse tab, the tab should now return to your current character.
- Zoning appears to give RecipeBook problems on updating known data. Working on this.
Installation Guide
- Exit "World of Warcraft" completely
- Download the mod you want to install
- Make a folder on your desktop called "My Mods"
- Save the .zip/.rar files to this folder.
- If, when you try to download the file, it automatically "opens" it... you need to RIGHT click on the link and "save as..." or "Save Target As".
- Extract the file - commonly known as 'unzipping'
Do this ONE FILE AT A TIME!
- Windows
- Windows XP has a built in ZIP extractor. Double click on the file to open it, inside should be the file or folders needed. Copy these outside to the "My Mods" folder.
- WinRAR: Right click the file, select "Extract Here"
- WinZip: You MUST make sure the option to "Use Folder Names" is CHECKED or it will just extract the files and not make the proper folders how the Authors designed
- Mac Users
- StuffitExpander: Double click the archive to extract it to a folder in the current directory.
- Verify your WoW Installation Path
That is where you are running WoW from and THAT is where you need to install your mods.
- Move to the Addon folder
- Open your World of Warcraft folder. (default is C:\Program Files\World of Warcraft\)
- Go into the "Interface" folder.
- Go into the "AddOns" folder.
- In a new window, open the "My Mods" folder.
- The "My Mods" folder should have the "Addonname" folder in it.
- Move the "Addonname" folder into the "AddOns" folder
- Start World of Warcraft
- Make sure AddOns are installed
- Log in
- At the Character Select screen, look in lower left corner for the "addons" button.
- If button is there: make sure all the mods you installed are listed and make sure "load out of date addons" is checked.
- If the button is NOT there: means you did not install the addons properly. Look at the above screenshots. Try repeating the steps or getting someone who knows more about computers than you do to help.
Translations
When you download a mod, please be sure that the mod is compatible with your translation of wow. Some mods only work on the US versions, while some only work on some of the various European versions. These variations are called "Localizations".
TOC Numbers (Out of Date Mods)
When Blizzard patches WoW, they change the Interface number. This means that all mods will be "out of date" unless or until the author releases a new version for that interface. Some people go into the .toc files and update the numbers themselves, but this is STRONGLY advised against as it will cause problems locating possible incompatibilities addons. When you log into WoW after a patch, you DO NOT have to delete your interface directory. All you have to do is simply tell WoW to ignore the interface numbers and load all the mods anyway. All you have to do is, while at the "character select" screen, look in the lower left corner and click on the "addons" button. A window will pop up listing all your installed mods.
If you look in the upper left corner of that window there should be a box that says "Load Out of Date AddOns". You want to CHECK this box. Now simply go into WoW normally and all your mods should load. As of the 1.9 patch, you will have to do this after EVERY patch/update that Blizzard posts! If you encounter any problems with a mod after a patch, please be sure to let the author of the mod know so they can fix it.
See also: About "Out Of Date AddOns"
Mac Support
WoW addons are not platformed based. As such, they can be used on either Mac or PC. You can extract both .zip and .rar files on a Mac using StuffitExpander.
Directory Structure
World of Warcraft
|_ Interface
|_AddOns
|_*AddonName*
|_ *AddonName*.toc
|_ *AddonName*.xml
|_ *AddonName*.lua
|_ (possibly others as well)...
