110 lines
5.5 KiB
Markdown
110 lines
5.5 KiB
Markdown
# Welcome!
|
|
|
|
## Introduction
|
|
Hey there, fellow adventurer! This soundpack was made specifically for users of [VIPMud](https://www.gmagames.com/vipmud.html), and it's here to make your gaming more immersive. With over **2,000 unique sound effects** (and growing), your daily sessions will feel like full-blown adventures. New sounds are added regularly, and older ones are polished up, so there's always something fresh to enjoy.
|
|
|
|
## Features
|
|
- **Sound Effects**: Covers most in-game activities and actions.
|
|
- **Ambiences and Music**.
|
|
- **Gag Manager**: Easily hide the lines you don't want to see or hear.
|
|
- **More to discover as you play.**
|
|
|
|
## Installation
|
|
Here's how to get the soundpack running:
|
|
|
|
1. **Connect to Cosmic Rage**
|
|
Go to the **Connect** menu in VIPMud and choose **Character Setup/Connect**. Hit enter to open the connection wizard.
|
|
- **Note**: NVDA may not read the edit boxes, but here's what you need to know:
|
|
- **Character Name**: This is your character's in-game name. Don't leave it blank, and don't use spaces or "Unnamed".
|
|
- **Character Reference**: A unique ID, usually the same as your character name. Again, no spaces or "Unnamed".
|
|
- **MUD List**: If you've made other characters, they'll show up here. Pick Cosmic Rage or tab past to fill the next fields.
|
|
- **MUD Name**: Must be "Cosmic Rage" with the space. Get this wrong and the pack won't load.
|
|
- **Host Name**: Use one of these: `cosmicrage.earth`, `cosmicrage.nathantech.net`, or `87.106.252.196`.
|
|
- **Port Number**: Use `7777` for Cosmic Rage.
|
|
- **Notes and Descriptions**: Optional notes about your character.
|
|
- **Password**: Your character's login password. This is encrypted and can't be recovered.
|
|
- **Auto Login**: Check this to log in automatically.
|
|
- **Keep Variable Values**: Keeps your variable states between sessions.
|
|
- **Simple Script Control**: Enables simple scripting support. See the VIPMud manual for more info.
|
|
|
|
2. **Download the Soundpack**
|
|
first, download the pack by clicking [this](https://gitea.nathantech.net/CosmicRage/VIPMudCosmicRageScripts/archive/main.zip) link. Once downloaded, extract this folder to a location of your choosing.
|
|
Important! Due to the limitations of Vip Mud, the folder you extract should not have any special or non-English character such as ö, ğ, ü.
|
|
Once you have the pack, launch `installer.bat` as an administrator by pressing the applications key or Shift + F10, then selecting "Run as administrator." Wait for the process to finish.
|
|
To update the soundpack, launch `updater.bat` as an administrator and wait for the process to complete.
|
|
Finally, restart VIPMud to load the soundpack.
|
|
|
|
## Hotkeys Reference
|
|
|
|
### Buffer Keys
|
|
|
|
- **Alt + Shift + Right**: Add a new buffer
|
|
- **Alt + Shift + Left**: Delete a buffer
|
|
- **Alt + Left**: Go to previous buffer
|
|
- **Alt + Right**: Go to next buffer
|
|
- **Alt + Page Up**: Scroll up 10 messages
|
|
- **Alt + Page Down**: Scroll down 10 messages
|
|
- **Alt + Up**: Go to previous message
|
|
- **Alt + Down**: Go to next message
|
|
- **Alt + #**: Jump to buffer number
|
|
- **Alt + Home**: Go to top of buffer
|
|
- **Alt + End**: Go to bottom of buffer
|
|
- **Alt + Delete**: Clear current buffer
|
|
- **Alt + Shift + Delete**: Clear all buffers
|
|
- **Control + Shift + Enter**: Toggle Buffer Sounds.
|
|
|
|
### Soundpack Volume and Behavior
|
|
|
|
- **F5**: General volume
|
|
- **F6**: Ambience volume
|
|
- **F7**: Communication volume
|
|
- **F8**: Music volume
|
|
- **Ctrl + F5**: Clocks volume
|
|
- **Ctrl + F6**: Combat music volume
|
|
- **Ctrl + F7**: IC social volume
|
|
- **Ctrl + F8**: 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
|
|
- **F9**: Toggle IC social sounds
|
|
- **F10**: Toggle OOC social sounds
|
|
- **Alt + F9**: Toggle sound panning
|
|
- **Alt + F10**: Toggle pitch shifting
|
|
- **Alt + F11**: Toggle ambiance
|
|
- **Alt+Shift+F9**: Toggle OOC Social Sound Interruption.
|
|
- **Ctrl + F9**: Toggle planetary music
|
|
- **Ctrl + F10**: Toggle space combat music
|
|
- **Ctrl + F11**: Toggle weather sounds
|
|
- **Alt + F12**: Restart soundpack
|
|
- **F2**: Open server-side settings
|
|
- **Ctrl + S**: Save client-side settings
|
|
- **Alt + N**: Add a new string to be gagged
|
|
- **Alt + F2**: Open the gag-related configuration manager
|
|
- **Alt + F3**: Toggle Intro Music
|
|
- ** Control + F2 and Control + F3**: Turn the client side main volume down and up respectively
|
|
- **Shift + f1**: Toggle The Soundpack
|
|
- **Alt + Shift + H**: Display a short help file related to soundpack updating.
|
|
- **Shift + F2**: Bring up the interface to change the defined paths for scripts and sounds. Use at your own risk!
|
|
- **Control+Shift+R**: Reload the soundpack.
|
|
- **Control+`**: Toggle command displaying in the output window.
|
|
## FAQ
|
|
|
|
**Q: My soundpack doesn't work. What now?**
|
|
A: Type `sp on` to enable the soundpacks channel. Then send messages with `sp <message>`. You can also open an issue in the repo for help.
|
|
|
|
**Q: I found a bug. How do I report it?**
|
|
A: Type `spbug` in-game to submit a bug report.
|
|
|
|
**Q: I have a suggestion. Where do I send it?**
|
|
A: Use the `spsuggest` command to share your idea.
|
|
|
|
**Q: Can I become a soundpack developer?**
|
|
A: Not right now. But if you make a cool sound, send it via `spsuggest` with a download link. If it's good, you'll be credited in the changelog and might even earn some donator dollars.
|
|
|
|
Happy MUDDing!
|