Boss Notes
About Boss Notes
Boss Notes provides shareable notes and other information for your guild, party and raid community. The add-on lets you take notes from your boss encounter learnings and share this information with other players. You can also use Boss Notes as a general, structured in-game notepad. In addition, Boss Notes records trash and boss abilities as well as boss emotes and provides a collection of short encounter tactics. With the powerful Rules module, you can extend your existing boss mod with additional encounter rules for custom notifications, timers, raid target icons and yells.
Boss Notes is based on a modular design. The standard distribution contains the Personal Notes, Abilities, Emotes, Tactics and Rules modules. Extension modules can provide additonal functionality.
Usage
If you have a Lightweight Data Broker (LDB) container add-on such as Titan Panel, Boss Notes shows in that container. Left-clicking the Boss Notes icon toggles the Boss Notes window; right-clicking the icon shows the options.
If you do not have an LDB container, type /bn toggle to show the Boss Notes window and /bn options to show the options.
Boss Notes provides a key binding to toggle the Boss Notes window. You may want to assign a key to that binding to gain quick access to Boss Notes.
Screenshots
The Boss Notes window lets you choose between the generic category and specific instances and encounters. The window then displays the information available on the selected category. Boss Notes automatically switches the category when a known mob is mouseovered or targeted in a dungeon or raid.
The Boss Notes tooltip provides quick access to the currently selected information.
All information can be sent to various types of chats.
Modules
Boss Notes functionality is provided by modules. The following sections describe the modules that are part of the Boss Notes standard distribution.
Personal Notes
The Personal Notes module provides shareable notes. Notes are by default shared with other players in your guild, party or raid. Other players can browse your notes and you can browse theirs. Sharing happens transparently in the background. If you want to limit the distribution of your notes, you can disable sharing for the guild, party or raid in the addon options under Syndication.
To edit a personal note, left-click on the content area in the lower half of the Boss Notes window. This opens the editor. The editor supports in-game links by shift-clicking. This allows you to link to items, abilities, tradeskills and other information in your notes.
For each category, there is a public default note. You can right-click a note to bring up a context menu that allows you to add to remove additional notes. Additional notes can be either public or private notes. Public notes are by default shared with other players in your guild, party or raid. To ensure that Boss Notes does not cause excessive network traffic, public notes are limited to 1'000 bytes per note. Boss Notes uses smart caching to further reduce network traffic. Private notes on the other hand are not shared with other players. Therefore, they have a much higher size limitation which is currently set at 10'000 bytes per note.
Player Name Colorizing
Player names can be colorized in personal notes. This is useful for raid leaders to quickly check and update encounter setup macros. To colorize a player name, enclose it in double curly braces, i.e. {{Player}}
. Players with this markup are colorized as follows:
- Green if the player is in raid groups 1-5
- Red if the player is in raid groups 6-8
- Grey if the player is not in the raid
Abilities
The Abilities module lists the abilities of known trash mobs and bosses (NPCs) in dungeons and raids. The module differentiates between 10 player and 25 player difficulty as well as normal and heroic difficulty. Abilities are learned automatically as they are used by the NPCs.
Please note that only the boss abilities matching the current dungeon or raid size and difficulty are displayed and that abilities are learned seperately for each difficulty.
The encounter database is still work in progress. It is fairly complete for Cataclysm and Wrath of the Lich King, and less complete for older dungeons and raids. Please consult the Encounter Database Status page for more information.
Emotes
The Emotes module lists the emotes, whispers and yells of known trash mobs and bosses (NPCs) in dungeons and raids.
Tactics
The Tactics module provides short tactics for dungeon and raid encounters. The tactics are maintained by DrKazza. Please contact him directly if you have feedback on the content or want to contribute.
Customizing Tactics
You can right-click on a tactics entry in order to copy its content to the clipboard. From there, you can paste it in a personal note and customize it to fit your needs.
Rules
The Rules module allows the definition of custom encounter rules for notifications, timers, raid target icons and yells. In a nutshell, it supports a roll-your-own boss mod approach to encounters which is completely in-game and does not require programming. Instead, declarative rules are used. The rules module is not intended to replace your current boss mod. Rather, it provides bridges to common boss mods that integrate your custom rules with the regular display provided by your boss mod. As the Rules module is powerful and complex, its complete description is on a separate page.
Learning Mode
Learning mode is an advanced feature that is used by the Boss Notes development team in order to maintain the encounter database that is included with Boss Notes. When playing on live, you generally do not need to use this option. Especially, you do not need to use this option for Boss Notes to learn NPC abilities.
You may want to use the learning mode when playing new content on a beta or test realm where the encounter database is not yet up to date. Use the /bn learn command after entering the zone. This causes Boss Notes to begin associating unknown NPCs with the currently selected instance and encounter while you are in the zone. Learning can be stopped by typing the same command again. Learnings can be cleared by typing /bn clear. NPCs are always learned on the currently selected instance and encounter. Please note that this selection must be adjusted manually in many cases as there is no automatic switching for learned NPCs.
Reporting Bugs
Please use the Ticket System on WowAce when reporting bugs. This ensures that your error reports receive proper and timely processing. You can log in on WowAce with your Curse Network account. Posting error reports in the comments section on Curse.com is not recommended and most likely leads to the respective comment being deleted without consideration.
Extending Boss Notes
Boss Notes is based on a modular design. The add-on can be extended with additional modules. Please see the Boss Notes Provider Modules page for further information.
Another question regarding the Event tab. I understand what is meant with the first three options but I can't figure out how to deal with the Unit parameter. It gives me the options Enter Combat / Change Target / Death. Which unit is meant? According to the description on WoWAce the triggering unit is the source unit of the event. There is no option to specify one.
Using BN 1.1.3
As for the unit event, this is triggered when *any* unit enters combat, changes target or dies. (Some WoW inherent restrictions apply for target changes as this will only report NPC target when you have the NPC targeted or focused.) You can then use the conditions to limit rule processing to specific units.
Let me give a concerete example. The goal of the following rule is to set raid target icons on on the Val'kyr Shadowguards in phase 2 of The Lich King encounter:
Event: (Unit event) Enter Combat
Condition: (NPC condition) Event Source is Val'kyr Shadowguard (36609)
Action: (Set Raid Target action.) Icons 2-4, set on Event Source, duration 15, collapse 10
Hope this helps.
Regarding feature requests. Should I post them here or do you prefer them via a ticket on WoWAce?
The rule is set as follows:
Event:
Unit -> Change Target
Condition:
Event Source is Player
Event Destination is In Raid
Event Destination has Buff/Debuff
Action:
Notification -> "Text"
Test Environment:
Instance:Violet Hold
Encounter: All Encounters
What I also discovered is that in order for rules to work you have to be in combat. Is that intentional?
Also with 3.3 Blizzard prohibited the use of the RaidWarning Feature in 5-Man instances, which is why those notifications get blocked and the following error shows up: You are not in a raid group. This change btw was undocumented.
Multiple firings of rule relying on target change of the player while in a party and the disabled raid warnings are probably bugs. Feel free to open tickets for these issues on Wowace.com
New release should come soon... Bethink, check your inbox pls
and such..
Also where do you customize the tactics text? Some of them a bit hard to understand and don't make things all that clear. and some raid boss fights we use a diff tactic then mentioned that just works well for us. I'd like a detailed explanation and a short 'reminder' version for those that have done it before and just need a quick reminder of some things.
Would LOVE input on where they can be shortened please.
Kazza
Is there a way to Hotkey the Tactics for a boss to a default channel?
Like Tactics (GD) does (but outdated now) All you have to do is highlight the boss and hit a key or a command line.
http://wow.curse.com/downloads/wow-addons/details/tactics-gd.aspx
Thanks
The only situation where the learning mode is required is if you do new content (typically in the first 1-2 days after launch) and if I have not been able to play that content on the PTR. In this case, the NPC-to-encounter associations in the encounter database may be incomplete and the learning mode allows you to fill that gap until a new version of Boss Notes with an updated encounter database is released.