Introduction

Ever get tired of World of Warcraft's default music? Wish you could inject a little bit of aural life into your game, but on your own terms? Soundtrack is the mod for you! Soundtrack allows you to assign any music you own from your own personal music library to almost any event in the game, including death, getting on your mount, leveling up, entering stealth, and various forms of combat that can distinguish between world mobs, PvP, boss battles, and more! When the event occurs, Soundtrack will play the music you have assigned to that event, almost as if the music were a part of the game itself!

PLEASE NOTE: I am not the original author. Morricone was the man behind the project, and as of now we he has yet to return to the project. This is a fan update created in order to fix a small, very limited number of bugs that have been neglected due to Morricone's unexplained absence.

Installation

Soundtrack requires extra installation steps to gather your music information, so please follow these steps:

• Download and Install: Install the addon the usual way. Follow the instructions from the Install tab above.
  
• Install Python: Python is a programming language with which Soundtrack was written. A specific version of Python (version 2.5.2-2.5.X) is necessary in order for Soundtrack to work. The installer for Python 2.5.2 is included in the zip file and, if automatically installed, will be extracted into the /Soundtrack directory in your Addons folder.
  
• Verify the installation: You should have a C:\Program Files\World of Warcraft\Interface\Addons\Soundtrack folder on your machine if you installed correctly.
  
• Copy mp3s you want to use in-game to the Interface\AddOns\Soundtrack\Music folder. If you have a lot of mp3's, you should organize them into sub-folders. (NOTE: Soundtrack also cooperates with junctions, so if you do not wish to copy your music and you have it all stored in one localized place, you may create a junction to the folder.)
  
• Generate your track library: One more thing before you start WoW. Run the Interface\AddOns\Soundtrack\GenerateMyLibrary.py file. This generates a file called MyTracks.lua, which is a list of every mp3 you placed in the Music folder. Soundtrack will use this list as a reference to your music. It is absolutely vital that you run GenerateMyLibrary.py whenever you add/remove mp3 files to the Music folder.

Features

• Play your own mp3s inside the game.
  
• Assign music to entire zones or specific sub zones. The default music still plays in zones that you do not assign music.
  
• Assign music when battling various levels of mobs, specific named monsters, or elite mobs.
  
• A plethora of events that you can assign music: Victory, Flight, Dance, Stealth, Swimming, Level Up, etc.
  
• Expose the full World of Warcraft score in your library to assign Blizzard's music to your own events (currently does not include music from Lich King).
  
• Can be used as a standard media player. You can create playlists and play them using mini floating playback controls.
  
• Interface to assign music to events. See all your tracks, sortable or filterable by track title, album or artist names.

Custom events allows you to create your own events through lua scripting. Only for very advanced users with scripting knowledge.

Known Issues

• Zone and battle music sometimes gets interrupted in instances or battlegrounds.
  
• Dance music does not stop when your character stops dancing. This is because there is currently no way to detect that you have stopped dancing, so the track stops when it reaches its end.
  

Feature Requests and Bug Reports

Please report any feature suggestions or bugs to my google code page.

Frequently Asked Questions

Why does my playlist stop when I close the main window?
That's because the main window only lets you preview your playlists. To actually play them, you need to use the miniframe's playlist drop down and pick a playlist.

What types of music files are supported?
Only mp3s. Other formats are not supported by Blizzard such as wav, ogg, wma, m3u, m4a, m4p, aac, midi. MP3s with Japanese or other non-US characters in their names can cause problems, so I suggest renaming them.

There are a lot of programs to convert various music formats to mp3. I personally use iTunes for that. In iTunes, Edit->Preferences, select the Importing tab, and make sure you Import using: MP3 Encoder. Then you’ll be able to convert any tracks to an mp3 file.

Why do I need to copy my music to the Soundtrack/Music folder?
The only files that can be played by WoW are files placed under the World of Warcraft folder when the game is started. Advanced users might want to try junctions to add a virtual link between Soundtrack's music folder and your music folder.

How do I transfer my assignments to another machine?

1. Exit WoW on the target machine.
   
2. Copy your Interface/Addons/Soundtrack/Music folder to the target machine. If you only copy partial music files, it will still work, but the events that are missing tracks will be fixed automatically and you will lose the track assignments (since the tracks don’t exist).
   
3. Regenerate the library on the target machine. You do this the usual way, by running GenerateMyLibrary.py. You can also copy MyTracks.lua directly if you want to skip this step.
   
4. Copy the settings. All of Soundtrack settings are stored in World of Warcraft\WTF\Account\<UserName>\SavedVariables\Soundtrack.lua. So copy this file to the same location on the target machine.
   
5. Start WoW on the target machine!
   

Why do I need to install Python?

Because the Blizzard API with which I write the addon does not let me scan your music folder. This limitation is probably to prevent cheats or from addons to screw up your pc files. If this limitation is lifted, I will remove the script.So the only way to feed your list of tracks to the addon, is to generate that list outside of the game. I could have written a program in any language, but the reason I picked Python is because the same script works on both Mac and PCs, and you can read the script yourself, in case you are worried about the scripts security.

The script scans all your mp3s and saves the name, album, artist and track length to the MyTracks.lua file, which is loaded in the game.