This is sPEAKer, my first ever mod!
Unlike the bugle, sPEAKer is an independent audio source. You can just press play and enjoy your music. Drop it, toss it around, audio will just not stop!
sPEAKer at the PEAK.
The main feature of this mod is that it works as a true portable speaker. Instead of playing 2D music for everyone, it leverages spatial audio to make it part of the immersive experience of PEAK.
It won't stop playing if you drop it.
Additionally, it supports MP3 and WAV out-of-the-box on top of your regular OGG files.
You can also download mixtapes from the Thunderstore or put together your own and share with friends, or even upload them too!
Playback control uses your regular interaction buttons, whatever they are.
Primary: Play/Pause toggle
Secondary: Next Song
Scroll: Volume Up/Down
Note: The following actions are not Controller compatible.
Shift + Secondary: Previous Song
Ctrl + Secondary: Toggle Shuffle
Alt + Secondary: Cycle Loop modes
P: Activate Drone Mode
Ctrl + P: Activate Drone Recall
O: Dance Emote (when Drone Mode is active)
Local Volume Control: Is available via Pause Menu:
This slider only affects your own playback.
After launching PEAK, your main music folder will be created:
.../plugins/onlystar-sPEAKer Music
You can place audio files directly in it, or you can use mixtapes.
A mixtape is simply a folder containing your collection of audio files.
Just create a new folder inside your main music folder (onlystar-sPEAKer Music) and drop your songs in it. The name of the folder will be used as the mixtape's name by default.
Optionally, you can also include a mixtape.json file inside your mixtape folder:
{
"name": "Undertale Bosses",
"author": "onlystar"
}
This takes priority over default naming, and will be shown in-game when a song from your mixtape starts playing.
Yes, it's "Mixtape Name - Song Name"
Mixtapes are really easy to share and manage. Since release, the available catalogue of mixtapes in the Thunderstore has grown to over 200 submissions! Thank you all for the support! I even discovered some bangers by regularly checking what's being uploaded.
But because Thunderstore is now plagued by mixtapes, there's a new filter for them:
Just in case you wanna list them all or filter them out of your browsing.
If you want to upload your own mixtape as a mod to share with your friends, just put an empty sPEAKer.json file in the same folder as your mixtape folder.
You can follow the instructions for Manual Packaging as described here.
Your package should include manifest.json, README.md, a /plugins folder and (hopefully) a 256x256 icon.png.
Your manifest.json should list sPEAKer as its dependency:
{
"name": "Demo_Mixtape",
"author": "onlystar",
"version_number": "1.0.0",
"website_url": "",
"description": "I'm a short description!",
"dependencies": [
"onlystar-sPEAKer-1.8.5" // add this line
]
}
This way, you can point your friends to your mixtape and their mod manager will install sPEAKer along with it.
Think carefully about the "name". Once uploaded, you can't change it.
The plugins folder in your package should look something like this:
plugins/
├── sPEAKer.json
└── my mixtape/
├── a true hero.ogg
├── omega flowey.mp3
├── ...
└── mixtape.json
sPEAKer.json is the way to tell sPEAKer that your uploaded mod includes a mixtape.
Even though MP3 and WAV are supported, it is highly recommended that you use OGG format. It's the fastest to load, smallest in size and you lose negligible quality. You can use a tool like Convertio or, if you're up for using scripts, check out the Wiki tab for the script I use for mass converting MP3s into OGGs.
Once your package is ready, ZIP it and upload it to Thunderstore. Remember to select "Audio" and "Mixtapes" in the Categories field.
💡 TIP: Don't delete your original package!
If you wanna add songs to an already published mixtape, add your songs to the original (uncompressed) package and bump the "version_number" up in your manifest.json. DON'T change the "name" field, as it will create a new mixtape instead of updating the existing.
{
"name": "Demo_Mixtape",
"author": "onlystar",
"version_number": "1.0.1", // previously "1.0.0"
"website_url": "",
"description": "",
"dependencies": [
"onlystar-sPEAKer-1.8.5"
]
}
ZIP it once again, and reupload it.
Disclaimer: Make sure you have permission to upload the audio files your mixtape contains to Thunderstore.
Instead of having a dedicated slot, you can make sPEAKer engage Drone mode and it will follow you around!
👉 Drop it, press P and you will be followed anywhere you go.
🔍 If you happen to lose it, use Ctrl + P to make it come back directly to you.
sPEAKer features 9 different dance motions / emotes.
Press O when Drone Mode is activated to strike a move!
These are options you can change before starting your game.
You can find them in BepInEx/config/onlystar.sPEAKer.cfg or via your mod manager.
| Key | Category | Description | Default Value |
|---|---|---|---|
| ExternalAudioFolderPath | 💾 Audio Loading | Folder path where sPEAKer will mainly load mixtapes and external audio from. It's recommended to leave unchanged. | "..\onlystar-sPEAKer Music" |
| LoadDemoSong | 💾 Audio Loading | Include a demo song in your track list. | true |
| ExtendedFormatSupport | 💾 Audio Loading | Enables loading of MP3 and WAV files. May impact performance. | true |
| StartupLoadingIndicator | 💾 Audio Loading | Shows a loading text during game start. | true |
| ShowTrackDuration | 🔊 Playback | Shows every song's current time and length. | true |
| DisplayMixtapeAuthor | 🔊 Playback | Displays mixtape author during mixtape playback. | true |
| ShuffleOnStart | 🔊 Playback | Start with Shuffle enabled by default. Saves you a toggle if you only want shuffled playback. | false |
| TurnOnAndPlay | 🔊 Playback | Make sPEAKer start playing immediately after turning it on. | false |
| SpawnAtGameStart | 📻 Spawning | Automatically spawn a sPEAKer around the crash site when a game starts. | true |
| SpawnWithF4 | 📻 Spawning | Allows the host to spawn a sPEAKer in their hands when pressing F4. Only one sPEAKer may exist at a time. |
true |
| RecallEnabled | 📻 Spawning | Enables recalling existing sPEAKer when pressing F4. Only works if SpawnWithF4 is also enabled. Also, a sPEAKer can only be recalled if it's in the ground (not in a slot). |
true |
| DebugMode | 📜 Logging | Enables custom verbose logging. If you want to report a bug, please include your BepInEx/LogOutput.log! |
false |
To change keybinds more easily, I recommend using ModConfig mod. However, given how BepInEx loads configurations, you'll still need to restart your game before keybind changes take effect, at least for now.
The following keybinds are currently configurable:
| Key | Description | Default Value |
|---|---|---|
| DroneToggle | Drone Mode toggle. | P |
| RecallCommand | Hold this while pressing DroneToggle key to make sPEAKer "recall" to you instead of looking for people nearby. | Ctrl(so default usage is Ctrl + P) |
| DanceEmote | Makes sPEAKer dance when Drone Mode is active. | O |
More keybinds are coming in future updates.
ExternalAudioFolderPath when moving your game to another folder, as it is generated only the first time the mod loads. If you're having trouble, delete config/onlystar.sPEAKer.cfg and it will find the correct path again (albeit losing your configs, if you changed any), UNLESS you installed sPEAKer through a shared profile.ExternalAudioFolderPath as the path will be from the original profile's machine. Each time the profile is updated with new mods, the configs will sync again, making it pointless to correct the configured path for your local machine. In other words, you cannot change any of your local configs in shared profiles.plugins/onlystar-sPEAKer Music permanently for that profile. This does not affect downloaded mixtapes (which is most likely the main source for music in shared profiles anyway).Created by onlystar - Bringing music to the PEAK experience!