PVPWarn aims to help the player to hear and see enemy spells casted on himself and also spells that an enemy player resisted or spells that the player himself resisted
PVPWarn uses both visual and acoustic effects to make the player aware of certain events. The addon aims to be configurable to the players preferences and allows customization on exactly what spells should be brought to the attention of the player and in what form.
Note: With the release of World of Warcraft classic this addon is entering maintenance only mode. This means that no new features will be implemented and only the most important bugs are fixed. For the classic version of this addon see PVPWarn-Classic.
WoW-Addons are installed directly in your WoW directory:
[WoW-installation-directory]\Interface\AddOns
Make sure to get the newest version of the Addon from the releases tab:
Note: If the Addon is not showing up in your ingame Addonlist make sure that the Addon is named
PVPWarnin your Addons folder
This Addon is using LogParser for parsing its events. PvPWarn cannot run without it make sure to install it.
Note: PvPWarn will check on upstart if LogParser is present and if the version matches the expected one. WoW however already prevents loading Addons that are missing their dependencies. In your Addon Tab you can see if the Addon can be loaded.
When everything is fine the Addon tab shows this as well.
When you have LogParser installed but it is disabled WoW will warn you about it as well.
PVPWarn shows a flashing icon of the detected enemy spell. It can show up to 5 spells and will ignore the spell if there is no slot free to display the spell.
Casts and auras are read from the combatlog. The default range for the combatlog to pick up such casts and auras is 40 yards. Using the following command can increase this up to 100 yards. This can have a negative effect on the performance if a lot of addons are reading the combat log and get overwhelmed with the amount of messages but can also be very helpful picking up events from players that are far away.
/console SET CombatLogRangeHostilePlayers "100"
To revert, run the same command with a value of 40.
Configurable spells are grouped into different categories. Other than the different class categories there are also categories for misc, racials and items.
| Category | Description |
|---|---|
| druid, hunter, mage, paladin, priest, rogue, shaman, warlock, warrior | Category for class related spells |
| racials | Category for all spells that are considered a racial spell meaning it is only available to certain races |
| items | Category for items such as trinkets and engineering items |
| misc | The misc category contains potions and usable consumables and everything else that doesn't fit any other category |
Inside such a category a list of spells is displayed that can be enabled or disabled. Additionally a spell can be configured to have a sound and a visual warning played to the player upon detection in the combat log. The buttons to fire of such an alert are for testing purpose only.
The category itself is additionally separated into two tabs.
Inside this tab spells that are cast by the enemy can be configured.
This tab is responsible for the configuration of spells that the player itself resisted. An example for this would be that a warning is fired whenever you resist an enemy mages's counterspell.
For the opposite warning if an enemy player resisted an important spell of yours there is the "Enemy Avoid" configuration. The configuration itself is the same as for other categories. However based on your current class different spells are displayed inside this navigation point.
Note: A spell that is enabled but has no sound and no visual warning enabled will not show a warning to the player. The spell is tracked by the addon but never alerted to the player.
The addon can be configured to be either completely disabled or only disabled in all Battlegrounds. This includes Warsong Gulch, Arathi Basin and Alterac Valley. This can be useful to prevent the warnQueue to get to annoying in places where a lot of such events are triggered. Also consider reducing the spells that are enabled if this is the case.
Events can be ignored while the player is dead and wishes to not see any warning during this state.
This option allows to ignore surrounding events and only report events for your current target.
Note: Events with type CHAT_MSG_SPELL_PERIODIC_SELF_DAMAGE will always be shown because they have no source. This includes events such as Blind, Fear, Polymorph and have the form of "You are afflicted by [some spell]".
The Alert icons with detected spells that are displayed by default can be disabled with this configuration.
To configure the placement of those icons use:
/pvpw configure enable
Then drag the frame to whatever position works best for you. To leave the configuration mode use:
/pvpw configure disable
Keep in mind that the iconbar will be filled with spells from left to right when you choose your new placement.
Note: To make sure that the placement is remembered next time you login do not forget to make a proper logout instead of using Alt+F4 when closing WoW.
Make sure to recheck the installation part of this Readme and check that the addon is placed inside [WoW-installation-directory]\Interface\AddOns and is correctly named as PVPWarn.
When a warning event is detected it is put into a queue before it is played to the user. This prevents the addon to play multiple of those warning at the same time to the user. However this means that it can take some time until an event is played when there is already an event playing. The more warning events that are active the higher the chance that an event has to wait until it is played to the player. This can lead to a point that a warning event might be considered as no longer relevant because it happened some seconds ago. While this should usually not be the case if you see this warning often you should consider disabling some of the warning events in the options menu.
This is also more likely to happen in a crowded place with lots of players. You can either temporarily disable the addon in the settings or use the option to disable the addon in battlegrounds.
This can have different reasons. Make sure to check that the spell you would like to be alerted is configured and active in the addon. If you cannot find the spell in the list chances are the spell cannot be tracked or is not yet included in the addon. While certain spells are untraceable others might simply be missing. Before creating an issue please make sure to check the limitations chapter for an explanation why your spell might not be available in the configuration. If you cannot find an entry for that spell feel free to create a GitHub issue with an enhancement request and I will look into it and see if it is possible to support that spell.
This is what we call a LUA error and it usually happens because of an oversight or error by the developer (in this case me). Take a screenshot off the error and create a GitHub Issue with it and I will see if I can resolve it. It also helps if you can add any additional information of what you we're doing at the time and what other addons you have active. Also if you are able to reproduce the error make sure to check if it still happens if you disable all others addons.
Definition of wording throughout the project:
An event is a state that is detected by the addon. The event itself doesn't necessarily has to be alerted to the user. Depending on the configuration of the player events might be ignored.
A spell cast event can be triggered by certain spells that are tracked by this addon.
A spell avoid event is triggered by spells that are avoided by the player itself.
A spell enemy avoid event is fired for spells that are resisted by an enemy player. Depending on the class of the player different spells can be configured.
A warning is fired based on an event that is detected by the addon and also configured to be active by the player. A warning can be both visually and acoustically alerted to the user.
Avoid is used in the context as either the player or an enemy avoided a certain spell. Avoiding capsules multiple possibilities of avoiding the effects of a spell. WoW has the following ways that are all considered as avoided by this addon.
- dodge
- resist
- parry
- immune
- miss
- block
Additionally we differentiate between self avoid and enemy avoid. While enemy avoid means that an enemy avoided a spell by the player itself - self avoid means the opposite that you as a player avoided an enemy spell.
E.g. you're casting Frost Nova as a Mage and the enemy player resists your Frost Nova.
"Your Frost Nova was resisted by SomeEnemyPlayer."
This is considered an enemy avoid. Based on the class you are the configurable spells inside the addon option menu differ. You can only configure spells that your class can learn.
Turning things around and you are a Warrior that walks into a Frost Nova of an enemy Mage but not before getting a Blessing of Freedom from a friendly Paladin might result in the following combat message.
"SomeEnemyPlayer's Frost Nova failed. You are immune."
This is considered a self avoid. You as a player resisted an enemy spell.
This addon has certain limitations for some spells. As a rule of thumb if an event is not showing up in your combat log it cannot be tracked by the addon. This applies to some really important spells such as Vanish, Feign Death and others. For an overview of supported and unsupported spells see Spelllist.
Switching between development and release can be achieved with maven.
mvn generate-resources -Dgenerate.sources.overwrite=true -P development
This generates and overwrites PVPW_Environment.lua and PVPWarn.toc. You need to specifically specify that you want to overwrite to files to prevent data loss. It is also possible to omit the profile because development is the default profile that will be used.
Switching to release can be done as such:
mvn generate-resources -Dgenerate.sources.overwrite=true -P release
In this case it is mandatory to add the release profile.
Note: Switching environments has the effect changing certain files to match an expected value depending on the environment. To be more specific this means that as an example test and debug files are not included when switching to release. It also means that variables such as loglevel change to match the environment.
As to not change those files all the time the repository should always stay in the development environment. Do not commit PVPWarn.toc and PVPW_Environment.lua in their release state. Changes to those files should always be done inside build-resources and their respective template files marked with .tpl.
To package the addon use the package phase.
mvn package -Dgenerate.sources.overwrite=true -P development
This generates an addon package for development. For generating a release package the release profile can be used.
mvn package -Dgenerate.sources.overwrite=true -P release
Note: This packaging and switching resources can also be done one after another.
# switch environment to release
mvn generate-resources -Dgenerate.sources.overwrite=true -P release
# package release
mvn package -P release
Before creating a new release update addon.tag.version in pom.xml. Afterwards to create a new release and deploy to GitHub the deploy profile has to be used.
# switch environment to release
mvn generate-resources -Dgenerate.sources.overwrite=true -P release
# deploy release to GitHub
mvn package -P deploy
For this to work an oauth token for GitHub is required and has to be configured in your .m2 settings file.
MIT License
Copyright (c) 2022 Michael Wiesendanger
Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:
The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.