Curse

About

Van32's CombatMusic, or just CombatMusic is an addon that you can use to bring that RPG feel back to your World of Warcraft experience! It helps you by automatically playing music you choose when you get into fights ingame!

Important!

News

CombatMusic's latest version is release_v4.5.1 with the following changes:

• Fixed bug mentioned by Zuedama. This should fix the issue where ingame music would fade out or play extremely loudly despite having a specific type of music disabled (Battles, for instance)

Have a suggestion? Found a bug in the AddOn? Follow this link to submit a ticket!

If you really like CombatMusic and wish to help out: Click on that Donate button! It's the best thing anyone could do for an addon author!

FAQ

My CombatMusic doesn't play songs when I enter Combat! HALP!

• All right, did you read the README first?
• Check to make sure your songs are set up properly. You have to put them in Interface/Music, not in the CombatMusic folder, and they need to be named properly, or CombatMusic won't see them!
• If they still don't work, submit a ticket!

Are you going to add mounted/per-zone music options?

• No. The addon is called CombatMusic. To have that would not make sense. I want to keep it simple for the end-user (That would be you.) to set up and use. Having to add the files, and rename them for all the zones is too much.

Why 'Interface/Music' and not 'Interface\Addons\Van32s_CombatMusic\'?

• Because?
• No really. I took into consideration the Curse Client deleting all of your music files every time I updated the addon. Which it would do, if I stored them in it's directory.

Features

Overview

CombatMusic is designed, first and foremost, to play music when your character is in combat. It can do this in a variety of ways, with as many songs as you like.

The add-on is designed to tell the difference between a monster that is a boss, or not, and can play music appropriate to the encounter. It will pick songs randomly from your list of songs, or you can tell it to pick specific songs, it doesn't matter.

The main thing is; there's no playlists to set up. There are no extraneous UI's and EXE files you need to run to set it up, making it easier to set up.

Want to see CombatMusic in action? Want to see what it really does? Go and check out this YouTube video!

In Combat

CombatMusic, when you enter combat, will first check to see what you or your focus has targeted. This is how it knows if you're fighting a boss or not. It checks those two, against a variety of different things, starting with your custom "BossList", a list of NPC names, and music, that you've set up for it. If it doesn't find it there, It'll check to see if it should play something from the "Bosses" folder, or from the "Battles" folder instead.

After Combat

After Combat, one of three things can happen:

1. If you lost, CombatMusic will play the Game Over song.
2. If it was a boss, it'll play your fanfare!
3. Otherwise, it'll just fade out the music.

Other uses

CombatMusic won't just play the victory fanfare when you beat a boss, it'll play it for you when you level up as well... It'll also play the game over song whenever your character dies, not just during a fight... (My main's heard it more than 2000 times, if that's any reference.)

How it works ingame

The slash commands

There's an entire list of these you can use, I'll explain each one that's important below. /cm or /combatmusic can be used along with any of the parameters below, to change the various settings the addon has. Here, text surrounded in [ ] means that the argument is required, where { } means optional. Multiple possible arguments for the same command are seperated with a |

• help|?
• on
• off
• battles {#|off}
• bosses {/#|off}
• volume [#]
• cooldowns [gameover|victory] {#|off}
• extras [gameover|victory|ding] [on|off]
• usefocus [on|off]
• useding [on|off]
• useboss [on|off]
• fade {#|off}
• bosslist {add|remove}
• comm [on|off]
• reset
• debug [on|off]

help|?

This will show all the slash commands you can do and give a brief explanation of how they all work ingame.

on/off

Enables or disable CombatMusic entirely.

battles {#|off}

(Default = off)
When used without any arguments, this command shows you how many songs you've registered to CombatMusic.

When used with number argument, it sets how many songs are registered to CombatMusic. Make sure the number is the same as the biggest number in the Music\Battles folder!

When used with off, this will disable battle music from being played.

bosses {#|off}

(Default = off)
When used without any arguments, this command shows you how many songs you've registered to CombatMusic.

When used with number argument, it sets how many songs are registered to CombatMusic. Make sure the number is the same as the biggest number in the Music\Bosses folder!

When used with off, this will disable boss music from being played.

volume [#]

(Default = 0.85)
This will set the volume of the music in combat. It will not affect the outside combat music volume. The number must be between 0 and 1.

cooldowns [gameover|victory] {#|off}

(Defaults GameOver = 10; Victory = 10)
This is a wordy one.

It lets you set the period of time that CombatMusic will wait before playing your gameover or victory, whichever you chose.

extras [gameover|victory|ding] [on|off]

(Defaults GameOver = On; Victory = On; Ding = On) Lets you enable or disable specific features of the addon.

usefocus [on|off]

(Default = off)
Allows you to toggle the new "Prefer focus target" feature of the addon. With on, CombatMusic will check your foucs' target before your target, and use the bosslist information from that.

Please note, that it will fall back onto using the non-preffered target for boss checks. (Example: Your focus' target is a training dummy, and your target is a flagged player, it will still play boss music.)

useding [on|off]

(Default = off)
Allows you to tell the addon whether or not to look for "DING.Mp3" and play that when you level up, instead of the "Victory.mp3"

useboss [on|off]

(Default = off)
Allows you to tell CombatMusic to also check the "boss1" through "boss4" targets. Please note that this consumes a lot of extra memory, I wouldn't reccomend it on a low-performance machine.

fade {#|off}

(Default = 5)
When used without any arguments, this command shows you your current fadeout time setting.

When used with a number argument, it will set your fade-out time to that number of seconds.

When used with off, it will disable the music fade-out feature.

bosslist {add|remove}

Allows you to add, remove, or display the bosslist entries ingame.

This lets you play specific songs for any NPC ingame, with the plus of it being flagged as a boss.

To add an NPC, it's as simple as targeting them, or entering their name in the first dialogue, and the second one, the song file you want to play!

To remove an NPC, say you put them there by accident or something, you can just use the remove command with them targeted, or again, enter the name of the NPC.

Paths in the game start from your World of Warcraft Directory, so that's the root directory... CombatMusic stores it's files, to World of Warcraft in "Interface\Music\", and this is what comes up by default when you go to add a boss.. Don't fret if you don't put the right song, doing the Add command again will overwrite any existing entries. And if WoW can't find the song, it just won't play anything but Background music!

If you just want to see who you put on the list, you can check by passing display to this command!

comm [on|off]

(Default = on)
Apart from being used in non-personal metrics replies, CombatMusic uses the addon communication channel to check for updates as well.

The data used for metrics:

• Your GUID - This is the only information saved.
• Your name
• Your current addon version
• The current boss and battles counts.

reset

USE WITH CARE! This command deletes all of your settings!

This command will reset your CombatMusic setup to the default settings, should something go wrong. There's a warning first, of course...

Unfortunately, it can't be undone.

debug [on|off]

(Default = off)
For those of us who care, this slash command just wastes a lot of your precious chat frame space, spamming out information about what the addon is doing.

Legal Stuff

This addon, and it's code files (excluding any included libraries, which are used with permission.) are the copyrighted material of Vandesdelca32, and are given to you under the GNU General Public Licence (v3).

Release Notes

release_v4.5.0

• All music will now fade logarithmically.
• Music will no longer change while fading out
• CombatMusic sets the global Enable Sound and Enable Music options due to the fact that it won't work properly without these options on.

release_v4.4.0

• Boss music waits for your fadeout, before playing a fanfare, but does not fade.

release_v4.3.11

(This includes changes from 4.3.0 to 4.3.11)

• Many bug fixes related to new features
• Metrics was re-enabled
• Version checking was added

release_v4.2.4

(This includes changes from 4.2.0 to 4.2.4)

• Level Up isn't on the fanfare cool down if you're using the alternate fanfare
• Code and efficiency updates
• Implemented being able to check boss1 through boss4 unitIDs

release_v4.1.11

(Contains changes from 4.1.0 to 4.1.11)

• Other bug fixes and improvements
• Added some proper settings change messages and stuff.
• Sorted the Strings.lua table a bit better.
• Fixed the reset dialogue: It now displays the text with the colour codes replaced properly by escape sequences.
• Small fix to the settings reset. It should actually reset your settings now.
• The bosslist add dialog now warns you if it finds an existing entry.

release_v4.0

(Contains changes from 4.0 to 4.0.2)

• Version bump to 4.0
• Included LibVan32
• Changed addon messages
• Added new command "cooldowns"
• added new command "extras"
• Added new command "useding"
• Added new command "usefocus"
• Added a PerCharacter setting for preferring the player's focus target over their own target.