Chatpack Overview

Chatpack is ...

Installation

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. Running chatpack on top of other worlds in MushClient is not recommended unless you have a healthy knowledge of lua coding, as detailed below.

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, as they both use LuaJIT.
Chatpack does not work alongside soundpacks using the LuaAudio plugin including  those of Mush-Z for Alter Aeon, Cosmic Rage, Epitaph, Empire Mud, Godwars, Miriani, Prometheus or the Unofficial Squaresoft Mud. You will want to install the soundpack to its own folder.

To download only the Chatpack files, use this zip file To install, do the following:

Updating Chatpack

Normally, you can update chatpack by simply running the update chatpack option in the start menu, or browsing to the location where you installed chatpack and running chatpack-updater.exe. Occasionally, the updater receives an update, in which case you will want to download it from the web site as shown below. This is quite rare though.

If you need to update your updater, follow these steps:

Note: You will only need to redownload the updater file if I announce that the updater has been updated, which is infrequent.

Frequently Asked Questions and problems

I get an access denied error when starting the client

This is a minor problem with the client and you can safely ignore it. It will only appear the first time you load chatpack.

I get a deluge of errors about missing xml files when starting the client.

This problem is a bit harder to solve. Many people report this error after having installed the Cosmic Rage soundpack, which installs to their program files folder. The best way to fix this problem is to move the mushclient folder out of the program files (x86) folder, so that you can still play Cosmic Rage, then uninstall mushclient via the programs and features Control Panel applet, which will remove the registry entries pointing to the program files folder. If you need help, contact me or a tech-savvy friend.

Can I modify the sounds or add new ones?

Yes, to a point. The sounds are inside the sounds folder, and you can indeed modify them, but running an update will change them back to what they were. Check out the file chatpack-standard.update-ignore to read up on how to set up ignore patterns for the updater.

How can I check what version of Chatpack I have?

You can do this from within ChatMUD by typing @ping me. It will tell you the version of chatpack that you have, and you can type @soundpacks 1 to see the latest version. Compare the two numbers to see if you are up to date or not.

An annoying sound is playing. How do I stop it?

Sound playback can be cut off by hitting shift-f11, which kills everything in your client's sound buffers that was playing when the command was issued. This won't help you with a person spamming you repeatedly with new sounds though.

Customizing Chatpack

Volume Control

To give you better flexibility with prioritizing sounds, Chatpack divides sounds into four categories, each with its own volume control:

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.

Credits