Minion Beta! - Help us test our new AddOn updater. Get it now!
Download
(131 Kb)
Download
Updated: 09-21-12 09:30 AM
Pictures
File Info
Compatibility:
Mists of Pandaria (5.0.4)
Updated:09-21-12 09:30 AM
Created:04-04-11 05:34 AM
Downloads:1,642
Favorites:10
MD5:
Custom Combat Sounds
Version: 2.02
by: Choonstertwo [More]
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
For the latest changes, please see CurseForge.

--v0.04 alpha--
Changed the CombatSoundsChannel Saved Variable to a Saved Variable for each of the four event types (Swing, Spell, Periodic, Range)

Added a Saved Variable for the format of each event type, allowing you to choose between .ogg and .mp3. (Thanks to Vancha of WoW Interface for the idea of multiple formats)

--v0.03 alpha--
Added the CombatSoundsChannel Saved Variable, allowing you to change the channel that the sounds are played in.

Fixed an error in the usage information present from my other AddOn.

--v0.02 alpha--
Finished implementing the CombatSoundsEnabled Saved Variable. The AddOn will now remember if you've turned it off via command line.

Disabling the AddOn via command line now "hides" the frame. This will likely lead to slightly less memory usage.
Optional Files (0)


Archived Files (5)
File Name
Version
Size
Author
Date
2.01
123kB
Choonstertwo
04-21-12 02:33 PM
0.04 alpha
4kB
Choonstertwo
04-22-11 04:32 AM
0.03 alpha
3kB
Choonstertwo
04-22-11 01:20 AM
0.02 alpha
3kB
Choonstertwo
04-07-11 12:52 AM
0.1 alpha
3kB
Choonstertwo
04-04-11 05:34 AM


Post A Reply Comment Options
Unread 09-21-12, 03:20 PM  
dont
A Kobold Labourer

Forum posts: 0
File comments: 13
Uploads: 0
Originally Posted by Choonstertwo
So easy that I've just released it to Curse and WoW Interface now.
You are an angel, my friend. That' so beautiful. I think it will become popular. I'll be your first user!
dont is offline Report comment to moderator  
Reply With Quote
Unread 09-21-12, 02:40 PM  
Choonstertwo
A Flamescale Wyrmkin
 
Choonstertwo's Avatar
AddOn Author - Click to view AddOns

Forum posts: 104
File comments: 66
Uploads: 29
Originally Posted by Choonstertwo
The UPDATE_MOUSEOVER_UNIT thing should be very easy to do.
So easy that I've just released it to Curse and WoW Interface now.

Once it's approved you can find it here:
WoW Interface
CurseForge
Curse
Last edited by Choonstertwo : 09-21-12 at 02:40 PM.
Choonstertwo is online now Report comment to moderator  
Reply With Quote
Unread 09-21-12, 01:10 PM  
Choonstertwo
A Flamescale Wyrmkin
 
Choonstertwo's Avatar
AddOn Author - Click to view AddOns

Forum posts: 104
File comments: 66
Uploads: 29
Originally Posted by dont
I am also grateful that you are considering adding code (a separate module) for mapping non-combat events to sounds. I'm not certain what you consider "fancy stuff" - I'm wondering if you will support those special events going to the Ambience sound channel instead of the default Sound Effects channel.
I should be able to support channels and extensions like CCS does. By fancy stuff I meant actually looking at the event's arguments and playing different sounds based on what they are. Each event will just play one sound regardless of what arguments it had.

Originally Posted by dont
This is a longshot, but is there any way for Lua to access the speech synthesis function in a Mac? That way I could get it to actually say "You just looted THREE gold" for example. Based on what I've seen, that doesn't look possible. There are a few Mac-specific things in WoW such as the ability to record video and access iTunes songs, but I doubt that they allow us to access speech synthesis. I find programming much more rewarding than game-playing, so I'm hoping to get into the WoW/Lua world myself.
Unfortunately this isn't possible within a WoW AddOn. AddOns don't have access to anything outside of WoW and WoW doesn't include any sort of voice synthesis software.
Choonstertwo is online now Report comment to moderator  
Reply With Quote
Unread 09-21-12, 12:49 PM  
dont
A Kobold Labourer

Forum posts: 0
File comments: 13
Uploads: 0
Originally Posted by Choonstertwo
I'm not sure if you already know this, but despite their names the PLAYER_(ENTER/LEAVE)_COMBAT events aren't actually fired when you enter/leave combat but rather when you start/stop auto-attacking. I could add support for those along with PLAYER_REGEN_(DISABLED/ENABLED) (which fire when you enter/leave combat) and the UPDATE_PENDING_MAIL event (with separate sounds in/out of combat).

I may make an optional module that can play a sound for any event, but it will probably just map the event name directly to the sound name without any fancy stuff like CCS does for CLEU (e.g. the UNIT_POWER event plays the sound Interface\AddOns\CustomCombatSounds\Sounds\UNIT_POWER.mp3).

The UPDATE_MOUSEOVER_UNIT thing should be very easy to do.
THANKS for all the info, especially the suggestion that you would consider the MOUSEOVER addon idea. I would use that module dozens of times per day. Eg, "who was that guy that just flew over me?"

Thanks for clarifying the explanation of the events that trigger when combat starts. I was unsure but you have straightened me out. I prefer the REGEN events. I did read those event descriptions but I was unclear how they differed from ENTER/LEAVE when I read them.

I am also grateful that you are considering adding code (a separate module) for mapping non-combat events to sounds. I'm not certain what you consider "fancy stuff" - I'm wondering if you will support those special events going to the Ambience sound channel instead of the default Sound Effects channel. I am finding it quite peaceful so far playing with only a select few sound effects. I mean after all, do we really need to hear the sounds of swords clanking (ie, Autoattack sounds) or mobs dying (all that is fluff in my opinion)? I can become a much smarter player if I turn on only the sounds that I really need to hear, such as for spells that I haven't mastered yet. Things like "Icy Touch" which is used perhaps every ten seconds are things that I do NOT need to hear anymore, although I will probably replace such spells with a short DING for now, and remove it completely if I'm comfortable with that. For many spells I will replace the sound with my own voice because it's too difficult remembering which sound is for which spell. If my system works well, I may make it into a custom addon (which will probably require CCS to use.) I was thinking about using a male voice for spells that are OUTGOING and a female voice for spells that are INCOMING.

This is a longshot, but is there any way for Lua to access the speech synthesis function in a Mac? That way I could get it to actually say "You just looted THREE gold" for example. Based on what I've seen, that doesn't look possible. There are a few Mac-specific things in WoW such as the ability to record video and access iTunes songs, but I doubt that they allow us to access speech synthesis. I find programming much more rewarding than game-playing, so I'm hoping to get into the WoW/Lua world myself.
dont is offline Report comment to moderator  
Reply With Quote
Unread 09-21-12, 11:22 AM  
Choonstertwo
A Flamescale Wyrmkin
 
Choonstertwo's Avatar
AddOn Author - Click to view AddOns

Forum posts: 104
File comments: 66
Uploads: 29
I'm not sure if you already know this, but despite their names the PLAYER_(ENTER/LEAVE)_COMBAT events aren't actually fired when you enter/leave combat but rather when you start/stop auto-attacking. I could add support for those along with PLAYER_REGEN_(DISABLED/ENABLED) (which fire when you enter/leave combat) and the UPDATE_PENDING_MAIL event (with separate sounds in/out of combat).

I may make an optional module that can play a sound for any event, but it will probably just map the event name directly to the sound name without any fancy stuff like CCS does for CLEU (e.g. the UNIT_POWER event plays the sound Interface\AddOns\CustomCombatSounds\Sounds\UNIT_POWER.mp3).

The UPDATE_MOUSEOVER_UNIT thing should be very easy to do.
Choonstertwo is online now Report comment to moderator  
Reply With Quote
Unread 09-21-12, 10:43 AM  
dont
A Kobold Labourer

Forum posts: 0
File comments: 13
Uploads: 0
Originally Posted by Choonstertwo
It would be possible to add more events, at the moment it only uses COMBAT_LOG_EVENT_UNFILTERED (which covers 99% of combat-related things). If you tell me exactly events you want added (either event descriptions or names) I'll see what I can do.
I don't expect you to make enhancements just for me, but since you ask I'll tell you what I would like. I would like custom sounds for these events. PLAYER_ENTER_COMBAT, PLAYER_LEAVE_COMBAT. Also I'd like to be clearly and audibly notified when I'm battling if I have any new incoming mail so I would like a custom sound for UPDATE_PENDING_MAIL but wouldn't it be easier to support all the events on http://wowprogramming.com/docs/events/ than just a handful? But if you do add support for single messages, please also consider BAG_UPDATE, CHAT_MSG_WHISPER, CHAT_MSG_SAY which are common things that happen during my farming. There is another addon that I use for those last two ("CREMATORIOUS CHATSOUNDS") but it doesn't have the same flexibility as yours with respect to output channels and throttle delays.

Every time I read the event list I see this one: UPDATE_MOUSEOVER_UNIT and I always wonder if someone could write an addon to post the name of the unit into the chat frame. The problem I need to solve is that I see lots of people and I want to remember their names, but it's hard to remember. If a mouseover would write the name of the target into the chat frame, it could be logged (I have chatframe logging on). That's a free idea for you for another addon. I think it would be popular. The user should be able to configure it as to whether to include NPCs for example.
dont is offline Report comment to moderator  
Reply With Quote
Unread 09-21-12, 10:10 AM  
Choonstertwo
A Flamescale Wyrmkin
 
Choonstertwo's Avatar
AddOn Author - Click to view AddOns

Forum posts: 104
File comments: 66
Uploads: 29
Originally Posted by dont
Originally Posted by Choonstertwo
lol, no problem. If you have trouble figuring out the sound name for a particular spell/action, you can turn on Verbose Mode from the GUI or by typing /cs verbose on. It will spam the hell out of your chat in any real combat situation, so you'll want to turn it off again when you've got the right name.
I got my first sound effect working. I'm thrilled. Just a beep for now. Your verbose mode really helps, but the problem is that verbose doesn't write the spell names of the spells into a loggable file. If verbose mode put the names into the "say" channel I could log all those spell names into a file rather than visually have to read and retype each one, which is very tedious.

There are a couple of battle "related" events your addon doesn't seem to handle, like PLAYER_ENTER_COMBAT, which I think I understand why, but it's still sad. Any ideas? What I'm thinking is that you could enhance your addon to support other general sound effects like the ones on this page: http://wowprogramming.com/docs/events/ I don't expect you to do that for me but do you have any suggestions for me?

The surprisingly wonderful thing about your addon is that I can change the output channel for my effects. Most of WoW's channels are annoying and noisy, but the Ambience channel is usually pretty quiet. So by changing the channel of my special sounds to Ambience and muting the Sound Effects channel I get exactly what I want, which is only the battle sounds of my choice appearing. You are brilliant.
It would be possible to add more events, at the moment it only uses COMBAT_LOG_EVENT_UNFILTERED (which covers 99% of combat-related things). If you tell me exactly events you want added (either event descriptions or names) I'll see what I can do.
Choonstertwo is online now Report comment to moderator  
Reply With Quote
Unread 09-21-12, 09:59 AM  
dont
A Kobold Labourer

Forum posts: 0
File comments: 13
Uploads: 0
Originally Posted by Choonstertwo
lol, no problem. If you have trouble figuring out the sound name for a particular spell/action, you can turn on Verbose Mode from the GUI or by typing /cs verbose on. It will spam the hell out of your chat in any real combat situation, so you'll want to turn it off again when you've got the right name.
I got my first sound effect working. I'm thrilled. Just a beep for now. Your verbose mode really helps, but the problem is that verbose doesn't write the spell names of the spells into a loggable file. If verbose mode put the names into the "say" channel I could log all those spell names into a file rather than visually have to read and retype each one, which is very tedious.

There are a couple of battle "related" events your addon doesn't seem to handle, like PLAYER_ENTER_COMBAT, which I think I understand why, but it's still sad. Any ideas? What I'm thinking is that you could enhance your addon to support other general sound effects like the ones on this page: http://wowprogramming.com/docs/events/ I don't expect you to do that for me but do you have any suggestions for me?

The surprisingly wonderful thing about your addon is that I can change the output channel for my effects. Most of WoW's channels are annoying and noisy, but the Ambience channel is usually pretty quiet. So by changing the channel of my special sounds to Ambience and muting the Sound Effects channel I get exactly what I want, which is only the battle sounds of my choice appearing. You are brilliant.
dont is offline Report comment to moderator  
Reply With Quote
Unread 09-21-12, 08:30 AM  
Choonstertwo
A Flamescale Wyrmkin
 
Choonstertwo's Avatar
AddOn Author - Click to view AddOns

Forum posts: 104
File comments: 66
Uploads: 29
Originally Posted by dont
Originally Posted by Choonstertwo

Is it showing up in the character selection screen AddOn list? If not, you've installed it wrong. Unkle has a good FAQ about installing AddOns here.

If it is showing up, make sure you've got it enabled for the character you're testing it on.
I'm so sorry! You were right. Normally I remember to check that. I'm unworthy to be in your presence let alone receiving help form you, thank you very much. Now I still have to figure out how this beast works, but I think you got me into the right ballpark. THANKS. Once I master this beast I'll probably come back and tell you how much I like it. :-)
lol, no problem. If you have trouble figuring out the sound name for a particular spell/action, you can turn on Verbose Mode from the GUI or by typing /cs verbose on. It will spam the hell out of your chat in any real combat situation, so you'll want to turn it off again when you've got the right name.
Choonstertwo is online now Report comment to moderator  
Reply With Quote
Unread 09-21-12, 08:08 AM  
dont
A Kobold Labourer

Forum posts: 0
File comments: 13
Uploads: 0
Originally Posted by Choonstertwo

Is it showing up in the character selection screen AddOn list? If not, you've installed it wrong. Unkle has a good FAQ about installing AddOns here.

If it is showing up, make sure you've got it enabled for the character you're testing it on.
I'm so sorry! You were right. Normally I remember to check that. I'm unworthy to be in your presence let alone receiving help form you, thank you very much. Now I still have to figure out how this beast works, but I think you got me into the right ballpark. THANKS. Once I master this beast I'll probably come back and tell you how much I like it. :-)
dont is offline Report comment to moderator  
Reply With Quote
Unread 09-21-12, 01:58 AM  
Choonstertwo
A Flamescale Wyrmkin
 
Choonstertwo's Avatar
AddOn Author - Click to view AddOns

Forum posts: 104
File comments: 66
Uploads: 29
Originally Posted by dont
Originally Posted by Choonstertwo
I've just released a new alpha version to CurseForge. It works for me, could you give it a try and see if you it works?

http://wow.curseforge.com/addons/cus...-0-3-g8fd1fd3/
I tried it. I put it into the Addons folder. Restarted the game. Still, /cs does nothing. I'm still very excited about this addon and I hope it can be made to work again.
That's odd, I downloaded that version and it had no issues opening the menu with /cs or playing sounds.

Is it showing up in the character selection screen AddOn list? If not, you've installed it wrong. Unkle has a good FAQ about installing AddOns here.

If it is showing up, make sure you've got it enabled for the character you're testing it on.
Choonstertwo is online now Report comment to moderator  
Reply With Quote
Unread 09-20-12, 01:13 PM  
dont
A Kobold Labourer

Forum posts: 0
File comments: 13
Uploads: 0
Originally Posted by Choonstertwo
I've just released a new alpha version to CurseForge. It works for me, could you give it a try and see if you it works?

http://wow.curseforge.com/addons/cus...-0-3-g8fd1fd3/
I tried it. I put it into the Addons folder. Restarted the game. Still, /cs does nothing. I'm still very excited about this addon and I hope it can be made to work again.
dont is offline Report comment to moderator  
Reply With Quote
Unread 09-20-12, 06:35 AM  
Choonstertwo
A Flamescale Wyrmkin
 
Choonstertwo's Avatar
AddOn Author - Click to view AddOns

Forum posts: 104
File comments: 66
Uploads: 29
I've just released a new alpha version to CurseForge. It works for me, could you give it a try and see if you it works?

http://wow.curseforge.com/addons/cus...-0-3-g8fd1fd3/
Choonstertwo is online now Report comment to moderator  
Reply With Quote
Unread 09-18-12, 01:29 PM  
Choonstertwo
A Flamescale Wyrmkin
 
Choonstertwo's Avatar
AddOn Author - Click to view AddOns

Forum posts: 104
File comments: 66
Uploads: 29
Re: Re: Re: Re: Re: Re: Does this work with WoW v5?

I'll have to do some testing myself a bit later to see what's going on. Thanks for the report.
Choonstertwo is online now Report comment to moderator  
Reply With Quote
Unread 09-18-12, 01:14 PM  
dont
A Kobold Labourer

Forum posts: 0
File comments: 13
Uploads: 0
Re: Re: Re: Re: Re: Does this work with WoW v5?

Originally Posted by Choonstertwo
Originally Posted by Choonstertwo
I'll fix the .pkgmeta file now and have Curse repackage the AddOn with the correct libraries.
I've just pushed the changes to Curse, try this alpha version and let me know if it works:
http://wow.curseforge.com/addons/cus...-0-1-g2c9b4aa/
I downloaded the ZIP file and put it into my addons folder and I still can't get /cs to do anything. Of course, there's always a chance that I'm making some mistake, but at this point I don't think so. I'll keep trying. I would have tried earlier but WoW was down all morning.
dont is offline Report comment to moderator  
Reply With Quote
Post A Reply



Category Jump: