Who made it: Athlon, et al (see the Credits section)
Why use it: Sounds and other features not available in ChatMud, such as convenient channel history buffers and output logging.
How to use it: Download the file in the above link and run it. The installer will ensure you have the latest version of Chatpack before starting.
Download the full distribution in the top navigation section and run the chatpack-setup.exe file to install. If you already use MUSHclient and are comfortable doing an in-place installation, read the next section, but be aware of the caveats.
Installing over an existing Mushclient
Warning: Chatpack now uses LuaJit, which breaks compatibility with non LuaJit soundpacks, including the popular Mush-Z. Unless Mush-Z updates to use LuaJit in the future, you will not be able to run both muds in the same window. You will want to do a full install of chatpack instead.
Chatpack can work alongside Tony's YuGiO soundpack, as well as the Aardwolf Client Package.
If you are already using MUSHclient for other muds, you can forego the installer and download only the Chatpack files. The file is located at this link
To install, do the following:
Download the .zip file and open it.
In the zip file you will see a folder called Chatpack-master; open this folder.
In the chatpack-master folder, open the chatpack folder.
Copy all files from this folder into the folder where MUSHclient is installed, and say yes to any replacement messages.
Open MUSHclient, and press control-o for the open dialog box. Choose ChatMUD.mcl to open up the provided world file. This world file has the necessary plugins installed.
If you need to update your chatpack, follow these steps:
Save the file in the mushclient folder. If you are asked to confirm file replacement, do so.
Run the file.
Note: You will only need to redownload the updater file if I announce that the updater has been updated, which is infrequent.
Chatpack is ...
compatible with major Windows screen readers: JAWS, NVDA, or SAPI as a fallback
Easily extensible: one can quickly add sounds or sound variations
Convenient: if you use MushClient to play other muds, you can have all of your muds in a tidier, tabbed interface.
Actively maintained and updated: I am open to your feature suggestions and bug reports, and will listen to feedback. But remember that nothing pleases everyone. Luckily the code is totally open-source, so if you don't like something, change it.
To give you better flexibility with prioritizing sounds, Chatpack divides sounds into four categories, each with its own volume control:
Channel sounds: these are sounds that play for each channel when a message, social, or emote is sent to it.
Social sounds: These sounds playe when socials occur: on channels, in the same room, and from afar.
Object sounds: sounds that are not channel or social sounds, but used the OOB tag to play, fall under this category. They are called object sounds because you will most often hear these sounds because an object maker tagged his or her object accordingly.
Other sounds: these sounds are for other events not covered by the above three categories. Common sounds from this category include say, tell, players teleporting in or out, watched players logging on or off the mud, and the sound that plays when the mud does not recognize the command you typed.
To change the volumes of each of these categories, use f10 to toggle through the categories, then use f11 and f12 to adjust the volume down or up in increments of 3% respectively. If you want to set the volume to an absolute number, type volume followed by the number. The minimum volume is 0, silencing the category, and the maximum volume is 100.
The config command
You can customize some functionality settings by typing config while you are in the Mushclient window. The settings should be self-explanatory, but contact me if you don't understand something.
Adding or Modifying Sounds
Chatpack comes loaded with many sound effects that play to alert you to various events, such as a message being sent to a channel, a social happening, or when a player on your watchlist logs in. Sound effects are also useful because they can be played on top of speech or each other, saving you a lot of time. All of Chatpack's sounds can be perused and manipulated from the sounds/chatpack folder inside your Mushclient folder. All sounds must be in .ogg format and have a .ogg extension to play; if your sounds are in a diferent format, you can use a converter program to change them to ogg format.
Many of the sounds one hears in Chatpack are loaded as needed. This means that if you add a new sound that matches the sound search parameters discussed below, it will immediately be taken into account when selecting what sound to play, if any, for certain things.
Channel sounds: if you receive a message sent to a channel, Chatpack looks in the channels subfolder for a sound exactly matching the name of the channel. If that sound is not found, it plays global.ogg instead. Thus you can add a sound for any new channel you create by simply adding an ogg file with the channel's name to that folder. Some channel owners have picked out their channel sounds and distributed them somewhere, such as over a dropbox link, so you can add them to your own chatpack this way.
numbered sounds: Sounds that are not channel sounds can be randomized, by adding a number to all sounds after the first. For example, in the guns subfolder, you will see target_miss.ogg, target_miss2.ogg, and target_miss3.ogg. When someone misses with their gun, Chatpack will select randomly between these three sounds. If you wanted to add a fourth option, you would name a file target_miss4.ogg and place it in the same folder.
Warning: You must ensure that the files are numbered sequentially, or the client may become confused. If you have a target_miss3.ogg, you must have a target_miss.ogg and a target_miss2.ogg. Also, adding a number 1 to the first file (such as target_miss1.ogg) will cause Chatpack to skip it. It must not be numbered in order to be included.
Object sounds: Some players have added sound tags to things they create. If you want to add sounds for these tags, first type config oobdebug to turn OOB Debugging mode on. This will print out the expected file path for sound files that Chatpack could not find. You may get a line such as:
#$#json: folder_name file_name
In order to create a sound for this data, create a subfolder of the sounds folder called folder_name, and place a file called file_name.ogg into it. You could then decide to randomize the selection by adding filename2.ogg, filename3.ogg, and so on.
Main coder and sound designer: Athlon
Coders: Slej, Weyoun, Sinistral, Dernan (updater)
Sounds: Sinistral, Criela
And Thanks to everyone who has suggested cool and/or useful features!