Version 2.0 is here!
Version 2.0 has been rewritten around Ace3 and now supports more events with a more complex sound file format.
I recommend you delete any previous copies of the AddOn and its saved variables to ensure a smooth installation.
Description
Custom Combat Sounds plays sounds on various combat events.
This AddOn does not currently come with any sounds.
If you wish to add sounds, place them in the "CustomCombatSounds\Sounds\" directory. Sounds must be in .ogg or .mp3 format and named exactly as specified below to be recognised.
If you wish to contribute sounds for others to use, please upload them as optional files on the AddOn's WoW Interface page.
Localisation
If you're fluent in a language other than English and want to use the AddOn in your language, please visit the Localisation page.
Sound File Format
The sound file format has up to four sections, each separated by a dash:
source/dest-event-spellID-crit/norm/miss.extension
All parts of the sound file name are in lower-case letters. Extension is either mp3 or ogg, determined by your settings.
Quotation marks are used here to show exactly what each part of the format is, but are not actually present in the file name.
source/dest
- Describes whether you or your pet were the source or destination of the combat log event that triggered this sound.
- If you were the source, this part is "source"; if you were the destination, this is "dest". If your pet was the source or destination, this is "pet-source" or "pet-dest" respectively.
- If the source and destination were you and your pet (or vice versa), the source will take priority.
- This is present for all combat log events.
event- The sub-event of COMBAT_LOG_EVENT_UNFILTERED that triggered this sound.
- You can see the names of all the sub-events here.
- You can see descriptions of when most of them fire here.
- This is present for all combat log events.
spellID- This is not present for events with the SWING, UNIT or PARTY prefixes.
- For events with the ENVIRONMENTAL prefix, this is the type of environmental damage. You can see a list of environmental types here.
- For events with the RANGE, SPELL, SPELL_PERIODIC and SPELL_BUILDING prefixes, this is the spellID of the spell that was cast.
SpellIDs can be found on the end of Wowhead URLs. For example, Kill Shot has a spellID 53351. Its Wowhead URL is http://www.wowhead.com/spell=53351
- Events with the DAMAGE prefix mimic various SPELL events, see here for details.
crit/norm/miss- For events with the _MISSED suffix, this is the miss type.
- For events with the _DAMAGE or _HEAL suffix, this is either "critical" or "normal" depending on whether or not the spell critically hit.
- For events with the _AURA_BROKEN_SPELL suffix, this is the extra spellID (the spellID of the spell that broke the aura).
- For events with other _AURA_ suffixes, this is the aura type (either "buff" or "debuff").
- This is not present for all other suffixes.
Examples- If I wanted a sound to play every time I did non-critical damage with my auto-attack, I'd name it source-swing_damage-normal.mp3 (or .ogg).
- If I wanted a sound to play every time I applied the Corruption debuff to someone, I'd name it source-spell_aura_applied-172-debuff.mp3 (or .ogg).
- If I wanted a sound to play every time I took non-critical damage from fires (e.g. cooking fires, braziers), I'd name it dest-environmental_damage-fire-normal.mp3 (or .ogg).
- If I wanted a sound to play every time my pet successfully cast Lash of Pain, I'd name it pet-source-spell_cast_success-7814.mp3 (or .ogg).
- If I wanted a sound to play every time my Rejuvenation periodic effect critcally healed someone, I'd name it source-spell_periodic_heal-774-critical.mp3 (or ogg).
Converter
I recommend
SUPER or
Audacity to convert your sound files to or from .ogg or .mp3 format.
Direct download link for SUPER
In SUPER, simply drag and drop the files into the window, select "OGG (Audio Only)" or "MP3 (Audio Only)" from the drop-down menu in the top-left and click "Encode (Active Files)" to start the conversion. The converted files can be found in the same folder as the original files.
To convert files to mp3 in Audacity, apply the "MP3 Conversion" chain to the files.
This page explains how to apply chains.
To convert to ogg, you'll need to make your own chain that follows the same steps as the MP3 Conversion one but uses the "ExportOgg" step instead of "ExportMp3".
This page explains how to make chains. Once you've made the chain, apply it in the same way as above.
The converted files can be found in a folder called "cleaned", located in the same folder as the input files.
Direct download link for Aduacity
For the security conscious, here are some security reviews of the websites I linked:
Google's Safe Browsing Diagnostic page for erightsoft.com
McAfee's SiteAdvisor page for erightsoft.com
Google's Safe Browsing Diagnostic page for erightsoft.org
McAfee's SiteAdvisor page for erightsoft.org
Google's Safe Browsing Diagnostic page for audacity.sourceforge.net
McAfee's SiteAdvisor page for audacity.sourceforge.net
Google's Safe Browsing Diagnostic page for manual.audacityteam.org
McAfee's SiteAdvisor page for manual.audacityteam.org
API
CCS provides a single public function that can be used in your own AddOns/scripts. You can see how to use the :PlayCombatSound method on the
API page.
Credits
I'd like to thank
Wowpedia and all of its contributors, especially those who wrote the UI-related pages that have helped me learn Lua.
I'd also like to thank the posters in the official
UI and Macros forums for all of their help.
Original idea courtesy of Vancha of Black Dragonflight US