- RecipeBook: Ayradyss's Addon
- Last Update: 11 March 2010
- Contact: recipebook (at) mistwalker.org
- Install: Unzip into the World of Warcraft/Interface/AddOns directory.
RecipeBook Version 3.3.2 beta 2
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
/rbk or /recipebook will all work for slash commands.
PLEASE NOTE: /rbk no longer works for RecipeBook.
RecipeBook has a minimap icon that allows you to access most RecipeBook commands as well.
General:
- - /rbk help : Displays a help message
Sharing:
- - /rbk 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.
- - Right-click on the minimap icon and select "Shared Data" for sharing options. If a character is targeted, RecipeBook will use that character. Otherwise, you will be prompted for a name.
Banking:
- - /rbk bank : Displays your banked items and options for banked items.
Skill Display
- - /rbk skill : Use /rbk 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 "/rbk 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
- - /rbk search : Opens the RecipeBook Search Window. (You can also bind this to a key)
- - /rbk search <item> : Searches for items containing the given string.
- - /rbk searchmats <item> : Searches for items using materials which match the given string.
Configuration:
- All configuration options can be accessed through the RecipeBook GUI: use /rbk 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.
Color Configuration:
- Use the minimap icon to change colors for items or open the RecipeBook UI window with /rbk config and select the "Colors" tab.
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.
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.
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.3.2-beta 2:
- THIS VERSION WILL RESET DEFAULT OPTIONS. Whoops, I didn't check my set defaults closely enough.
- TRANSLATIONS NEEDED: I have hacked a few lines and changed some others so that the non-English clients should stop erroring on popup.
- Tidied up the help messages to stop suggesting /rb when it doesn't work any longer :)
- When someone new shares data with you it should now show up without requiring a reload of the UI.
- Using the minimap icon to select a RecipeBook tab while the RecipeBook window is open now correctly loads that tab.
3.3.2:
- THIS VERSION WILL WIPE YOUR DATA. RecipeBook will clear its database on first loading - this means that EVERYTHING will need to be reloaded: character skills, cached items, everything. I'm having trouble with old (uncached) data again.
- THIS VERSION WILL RESET MOST OPTIONS. I made some changes for the color-coding customization.
FIXED:
- Guild Bank items should now tooltip correctly once again.
- Several small changes in the code should now clarify whether the "RecipeBook data not yet loaded" error stems from a blank DB or a lag concern, and help eliminate it recurring.
!NEW!
+ Color customization added: Check the "colors" tab in the RecipeBook UI for an option to change the colors of items and text.
+ If RecipeBook cannot quickly load all of your recipe/reagent data, it will now give you a popup message to that effect. Clicking "Accept" will attempt to force-load all of the tradeskill data.
- This replaces the "Some items were not scanned for this tradeskill" and "Some reagents for this tradeskill's items were not yet in local cache" messages that were previously in your chat frame.
- This scan may lag the UI intermittently; do not do it when you are doing things that are control-intensive.
- You have the option of clicking "Cancel" which will wait for the next time RecipeBook updates to check again.
- Doing this scan in Dalaran or other high-lag areas may require a little time. You will be updated periodically on the status of the deep scan.
3.2.0:
- /rb has been pulled as a slash command. You will need to use /rbk. I'm just exhausted by my workarounds for RatingBuster not working around from one patch to the next.
- Some tooltip debugging in the pattern matching section. RecipeBook will now default to using the GameTooltip if it is trying to access a tooltip that doesn't have the methods it wants. Please report ALL unusual behavior.
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)...
