# Welcome to the MushClient Soundpack for Cosmic Rage!

This soundpack is designed to enhance your gaming experience in Cosmic Rage, providing over **2,000 unique sound effects** (and growing) to make your adventures more immersive. We regularly add new sounds and polish existing ones, ensuring your gameplay is always engaging.

## Features

*   **Extensive Sound Effects**: Covers a wide range of in-game actions and events.
*   **Ambiences and Music**: Adds atmospheric depth to your gameplay.
*   **Automatic Updates**: The pack will download new sounds as you encounter them.
*   **Discover more as you play!**

## Installation

Getting the soundpack up and running is simple:

1.  **Download the Soundpack**: Click [this link](https://gitea.nathantech.net/CosmicRage/Mush-Soundpack/archive/main.zip) to download the soundpack.
2.  **Extract the Files**: Extract the downloaded zip file to a location of your choice.
    *   **Important**: Ensure the extracted folder does not contain any special or non-English characters (e.g., ö, ğ, ü) as this can cause issues with MushClient.
3.  **Run the Installer**: Locate the `installer.bat` file within the extracted folder. Right-click it and select "Run as administrator". Wait for the installation process to complete.
4.  **Update the Soundpack**: To update the soundpack in the future, simply run `updater.bat` as an administrator.
5.  **Restart MushClient**: Close and reopen MushClient for the soundpack to be loaded.

## Connecting to Cosmic Rage

MushClient is a portable client designed specifically for Cosmic Rage. The game world will automatically load, so there's very little setup required on your end.

1.  **Launch MushClient**: Open the MushClient application.
2.  **Connect**: The game world should automatically load. If it doesn't, or if you need to re-establish a connection, you can typically do so through the client's connection menu.

## Hotkeys Reference

### General Soundpack Control

*   **Shift + F1**: Toggle the entire soundpack on/off.
*   **Alt + F12**: Restart the soundpack.
*   **Control + Shift + R**: Reload the soundpack.
*   **Alt + Shift + H**: Display a short help file related to soundpack updating.
*   **Shift + F2**: Access the interface to change script and sound file paths (use with caution!).
*   **Control + `** (backtick): Toggle command displaying in the output window.

### Volume Controls

*   **F5**: General volume control.
*   **F6**: Ambience volume.
*   **F7**: Communication volume.
*   **F8**: Music volume.
*   **Control + F5**: Clock volume.
*   **Control + F6**: Combat music volume.
*   **Control + F7**: In-character (IC) social volume.
*   **Control + F8**: Out-of-character (OOC) social volume.
*   **Alt + F5**: Ground combat volume.
*   **Alt + F6**: Harvesting volume.
*   **Alt + F7**: Salvage volume.
*   **Alt + F8**: Games volume.
*   **Shift + F5**: Ship combat volume.
*   **Shift + F6**: Ship volume.
*   **Shift + F7**: Ship movement volume.
*   **Shift + F8**: Vehicle volume.
*   **Control + F2**: Decrease the client-side main volume.
*   **Control + F3**: Increase the client-side main volume.

### Sound Toggles

*   **F9**: Toggle IC social sounds.
*   **F10**: Toggle OOC social sounds.
*   **Alt + F9**: Toggle sound panning.
*   **Alt + F10**: Toggle pitch shifting.
*   **Alt + F11**: Toggle ambiance sounds.
*   **Alt + Shift + F9**: Toggle OOC Social Sound Interruption.
*   **Control + F9**: Toggle planetary music.
*   **Control + F10**: Toggle space combat music.
*   **Control + F11**: Toggle weather sounds.
*   **Alt + F3**: Toggle Intro Music.

### Buffer Management 

*   **Alt + Shift + Right**: Add a new buffer.
*   **Alt + Shift + Left**: Delete a buffer.
*   **Alt + Left**: Go to the previous buffer.
*   **Alt + Right**: Go to the next buffer.
*   **Alt + Page Up**: Scroll up 10 messages in the current buffer.
*   **Alt + Page Down**: Scroll down 10 messages in the current buffer.
*   **Alt + Up**: Go to the previous message in the current buffer.
*   **Alt + Down**: Go to the next message in the current buffer.
*   **Alt + #**: Jump directly to buffer number `#`.
*   **Alt + Home**: Go to the top of the current buffer.
*   **Alt + End**: Go to the bottom of the current buffer.
*   **Alt + Delete**: Clear the current buffer.
*   **Alt + Shift + Delete**: Clear all buffers.
*   **Control + Shift + Enter**: Toggle buffer sounds on/off.

## FAQ

**Q: My soundpack isn't working. What should I do?**

A: First, ensure you have correctly installed the soundpack by running `installer.bat` as administrator. Then, make sure the soundpack is enabled within MushClient. You can typically do this through the soundpack's configuration or by typing `sp on` in the MushClient command line if a specific command channel is set up. If issues persist, you can open an issue in the GitHub repository for assistance.

**Q: How do I report a bug?**

A: Type `spbug` in the MushClient command line. This will typically open a way to submit your bug report.

**Q: I have a suggestion for the soundpack. How can I share it?**

A: Use the `spsuggest` command in MushClient to submit your ideas.

**Q: Can I contribute as a soundpack developer?**

A: While direct development positions aren't currently available, you can contribute cool sounds by sending them via the `spsuggest` command with a download link. If your contribution is integrated, you'll be credited in the changelog and may be rewarded.

Happy MUDding!