About Medley
This addon allows you to further customize events in the game with sounds! By either using already built-in sound files or your own custom ones, you can add effects or notifications to make the game more enjoyable and/or helpful to you. :) It is named "Medley" because it fit's the definition quite nicely: "an arrangement made from a series of melodies, often from various sources."
Medley was created using Ace3 libraries, Quixote 2.0 and is localization-ready. It also has a launcher for DataBroker!
Type /medley to bring up the options or you can find it in the "AddOns" section of WoW's default Interface panel.
Current Features
- Enable/disable the different sounds
- Use built-in game sound files
- Use custom sound files
- Profiles for different configurations
Supported Events
Here is a list of the events Medley currently supports along with the default sounds:
- Quest objective completion - Peon says "Ready to work!"
- Quest full completion - Peon says "Work complete!"
- Quest failed - Orc death cry
- Level up - Lots of drums beating
- Duel finished - A crowd cheers
- Mail notification - A low pitch thump
- Whisper notification - A "wisp" noise
- Auto follow - This is the only one not customizable at this time, if enabled your character will automatically do the train emote once when first following someone.
- Achievement notification - A crowd cheers
Remember that the default sounds can be changed and you can always go back to them by resetting your profile. :) I plan to add several more as I work on the mod and I am open to suggestions on what to add next. I'd love to fit as many events as possible in here so to give everyone the freedom to customize Medley to their liking.
Possible/suggested sounds to add:
- Achievement notification (WotLK)
- New title earned notification
- Aggro alert
- Minimap pinged
- Ready check (would be enhanced)
- Guild MOTD change notification
- Guild kick/demote/promote/gquit/join notifications
- Guildmate sign on/off
- Friend sign on/off
- Hunter pet happiness/loyalty change
- Hunter pet level up
- Health/mana low warning
- Durability low warning
- Rogue combo points at max (5)
- Reputation level up
I'm just listing these out quickly at the moment, they may or may not end up being possible once I do more research into the events/API. Keep the suggestions coming though!
NOTE:These customizations do NOT REPLACE current game sounds, but play along with them. If you are using another mod that adds sounds to events, you may want to disable those specific sounds in Medley or in the other mod to avoid having them all play at the same time.
How to Use In-Game Sounds
To use a sound file that is built-in to the game, browse these two lists:
http:www.wowwiki.com/API_PlaySoundFile_SoundList
http:www.wowwiki.com/API_PlaySoundFile_SoundList2
If you have WoW up at the same time, copy and paste the line of code ("/script blah blah") into your chat frame and you should hear the sound played for you. You can test which in-game sounds you like most this way! There are hundreds listed there though, so be warned! ;) Be careful of the "ambience" sounds because they are usually long looping sounds. Try to stick to ones that look short to test.
When you decide on an in-game sound to use, copy and paste the file path into the corresponding input box for the event you want to change (see screenshot to the right). The sound path must follow this format example: "Path\To\Sound\File.wav", but you don't have to use just wav files.
NOTE: Make sure to delete the extra backslashes that are in the path names, instead of "Path
To
Sound
File.wav" it should be Path\To\Sound\File.wav. Otherwise the game will not recognize the sound.
How to Use Custom Sounds
To use a custom sound file that is not already in the game, make sure that file is in the Medley/Sounds folder and then type the path into the corresponding box like so: Interface\AddOns\Medley\sounds\SOUNDNAME.wav ... change "SOUNDNAME" to the exact file name of the sound and make sure to use the correct extension (.wav, .mp3, whatever the file is) or it will not work.
Feedback
I appreciate any and all feedback on this mod, especially since it is my first one! Whether you have bug reports, suggestions for new events, or need help please feel free to post comments here. :)
Known Issues
- Mail notification may play twice when new mail is received
------------------------------------------------------------------------
r10 | kiralyn | 2008-10-30 16:39:52 +0000 (Thu, 30 Oct 2008) | 1 line
Changed paths:
M /trunk/Medley.lua
Fixed a typo (eep!) keeping an option from performing correctly.
------------------------------------------------------------------------
r9 | kiralyn | 2008-10-29 19:53:52 +0000 (Wed, 29 Oct 2008) | 1 line
Changed paths:
M /trunk/.pkgmeta
Fixing pkgmeta to correctly pull LibQuixote-2.0.
------------------------------------------------------------------------
r8 | kiralyn | 2008-10-17 02:37:36 +0000 (Fri, 17 Oct 2008) | 1 line
Changed paths:
M /trunk
M /trunk/.pkgmeta
A /trunk/libs
A /trunk/libs/LibDataBroker-1.1
A /trunk/libs/LibDataBroker-1.1/LibDataBroker-1.1.lua
Oops, forgot LibDataBroker-1.1!
------------------------------------------------------------------------
r7 | kiralyn | 2008-10-17 02:20:56 +0000 (Fri, 17 Oct 2008) | 1 line
Changed paths:
M /trunk/Locale-enUS.lua
M /trunk/Medley.lua
M /trunk/Medley.toc
M /trunk/embeds.xml
Updated to 3.0, added new "Achivement Earned" sound and a DataBroker launcher!
------------------------------------------------------------------------
r6 | kiralyn | 2008-10-04 16:24:28 +0000 (Sat, 04 Oct 2008) | 1 line
Changed paths:
A /trunk/sounds/How to Use Custom Sounds.txt
------------------------------------------------------------------------
r4 | kiralyn | 2008-10-04 16:17:13 +0000 (Sat, 04 Oct 2008) | 1 line
Changed paths:
M /trunk/.pkgmeta
------------------------------------------------------------------------
r3 | kiralyn | 2008-10-04 16:12:59 +0000 (Sat, 04 Oct 2008) | 1 line
Changed paths:
A /trunk/.pkgmeta
A /trunk/Locale-enUS.lua
A /trunk/Medley.lua
A /trunk/Medley.toc
A /trunk/embeds.xml
A /trunk/sounds
Initial commit, take two. :P
------------------------------------------------------------------------
r2 | kiralyn | 2008-10-04 16:12:01 +0000 (Sat, 04 Oct 2008) | 1 line
Changed paths:
M /trunk
Initial commit!
------------------------------------------------------------------------
r1 | root | 2008-10-04 15:52:49 +0000 (Sat, 04 Oct 2008) | 1 line
Changed paths:
A /branches
A /tags
A /trunk
"medley/mainline: Initial Import"
------------------------------------------------------------------------
Installation Guide
- Exit "World of Warcraft" completely
- Download the mod you want to install
- Make a folder on your desktop called "My Mods"
- Save the .zip/.rar files to this folder.
- If, when you try to download the file, it automatically "opens" it... you need to RIGHT click on the link and "save as..." or "Save Target As".
- Extract the file - commonly known as 'unzipping'
Do this ONE FILE AT A TIME!
- Windows
- Windows XP has a built in ZIP extractor. Double click on the file to open it, inside should be the file or folders needed. Copy these outside to the "My Mods" folder.
- WinRAR: Right click the file, select "Extract Here"
- WinZip: You MUST make sure the option to "Use Folder Names" is CHECKED or it will just extract the files and not make the proper folders how the Authors designed
- Mac Users
- StuffitExpander: Double click the archive to extract it to a folder in the current directory.
- Verify your WoW Installation Path
That is where you are running WoW from and THAT is where you need to install your mods.
- Move to the Addon folder
- Open your World of Warcraft folder. (default is C:\Program Files\World of Warcraft\)
- Go into the "Interface" folder.
- Go into the "AddOns" folder.
- In a new window, open the "My Mods" folder.
- The "My Mods" folder should have the "Addonname" folder in it.
- Move the "Addonname" folder into the "AddOns" folder
- Start World of Warcraft
- Make sure AddOns are installed
- Log in
- At the Character Select screen, look in lower left corner for the "addons" button.
- If button is there: make sure all the mods you installed are listed and make sure "load out of date addons" is checked.
- If the button is NOT there: means you did not install the addons properly. Look at the above screenshots. Try repeating the steps or getting someone who knows more about computers than you do to help.
Translations
When you download a mod, please be sure that the mod is compatible with your translation of wow. Some mods only work on the US versions, while some only work on some of the various European versions. These variations are called "Localizations".
TOC Numbers (Out of Date Mods)
When Blizzard patches WoW, they change the Interface number. This means that all mods will be "out of date" unless or until the author releases a new version for that interface. Some people go into the .toc files and update the numbers themselves, but this is STRONGLY advised against as it will cause problems locating possible incompatibilities addons. When you log into WoW after a patch, you DO NOT have to delete your interface directory. All you have to do is simply tell WoW to ignore the interface numbers and load all the mods anyway. All you have to do is, while at the "character select" screen, look in the lower left corner and click on the "addons" button. A window will pop up listing all your installed mods.
If you look in the upper left corner of that window there should be a box that says "Load Out of Date AddOns". You want to CHECK this box. Now simply go into WoW normally and all your mods should load. As of the 1.9 patch, you will have to do this after EVERY patch/update that Blizzard posts! If you encounter any problems with a mod after a patch, please be sure to let the author of the mod know so they can fix it.
See also: About "Out Of Date AddOns"
Mac Support
WoW addons are not platformed based. As such, they can be used on either Mac or PC. You can extract both .zip and .rar files on a Mac using StuffitExpander.
Directory Structure
World of Warcraft
|_ Interface
|_AddOns
|_*AddonName*
|_ *AddonName*.toc
|_ *AddonName*.xml
|_ *AddonName*.lua
|_ (possibly others as well)...
