You are viewing a potentially older version of this package. View Latest Version
Thunderstore development is made possible with ads. Please consider making an exception to your adblock.
This is sPEAKer, the most feature-packed music player in PEAK.
Unlike the bugle, sPEAKer is an independent audio source. Simply 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.
When it comes to loading songs, you have two solid options.
The first is to use Mixtapes, the favorite format among users of this mod. Thunderstore has plenty to pick and choose from already. There are MANY different styles out there, even some original music from independent artists! Either way, you always have the option to make your own mix and upload it to Thunderstore. Playback is instantaneous and perfectly synced. This is the highest quality option.
The second is to use YouTube Radio, the latest mode that lets you search a song by name (or paste a link) and get infinite recommendations! Literally pick a song and let the vibe carry itself. Or if you prefer, put together a YouTube playlist and input that instead. Sync is entirely host-driven, so clients may start songs a little late. This is the least setup option.
Whatever you choose, sPEAKer has your back.
NOTE: Not all dependencies go into /plugins. If you have issues, use a mod manager before asking for support.
Primary playback uses your regular interaction buttons, whatever they are. Controller compatible.
Primary: Play/Pause toggle
Secondary: Next Song
Scroll: Volume Up/Down
The following controls are not meant for Controllers, but they might work. For rebinding, see "Keybinds" section.
Shift + Secondary: Previous Song
Ctrl + Secondary: Toggle Shuffle
Alt + Secondary: Cycle Loop modes
Y: Activate YouTube Radio / Open URL Input
Ctrl + Y: Go back to Mixtape playback (from YouTube Radio)
P: Activate Drone Mode
Ctrl + P: Activate Drone Recall
O: Dance Emote (when Drone Mode is active)
U: Bring up Queue UI
Local Volume Control: Is available via Pause Menu:
This slider only affects your own playback.
After launching PEAK, your default music folder will be created:
.../plugins/onlystar-sPEAKer Music
This is intended for local playback. To listen in with your friends, you should use mixtapes.
A mixtape is simply a folder containing your collection of audio files.
To create one, start by creating a new folder inside your default 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 allows you to sign your Mixtape with your name.
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 around 500 SUBMISSIONS!! Thank you all for enjoying sPEAKer!
There are SO MANY that there's even an exclusive filter for them:
Just in case you wanna list them all or filter them out of your browsing. A heads up tho: if you're browsing on Thunderstore's webpage, all mixtapes will be under "Resource Packs" instead of "Mods".
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 refer to the general instructions for Manual Packaging as described here.
There's also an alternative explanation on how to create mixtapes here.
As a minimum, your package should include a manifest.json, a README.md, a /plugins folder and (hopefully) a 256x256 icon.png.
manifest.json is formatted as follows, and 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-2.3.4" // remember to 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.
plugins/ folder is where your songs are. It should follow a structure like this:
plugins/
├── sPEAKer.json // <-- this file is empty!
└── 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, otherwise it won't find it.
Important Note: 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 MP3 into OGG.
At this point, you should have everything to put together your package, like so:
some_folder/
├─ manifest.json
├─ README.md
├─ icon.png
└─ plugins/ <-- the folder from before!!
Your next step is to put these files inside a ZIP. This does NOT MEAN to ZIP the containing folder (like "some_folder" in this example), it should only be the contents. In other words, when opening your ZIP you should directly see the manifest.json, README.md, icon.png and plugins/ folder inside.
Once your package is ready, upload it to Thunderstore.
You should only select "Mixtapes" in the Categories field.
💡 Don't delete the files you created your package with! (manifest, README, etc)
👇 It's important for the next section
If you wanna add songs to an already published mixtape, add your songs to the original (uncompressed) plugins/ folder and bump the "version_number" up that's inside your manifest.json. DON'T change the "name" field, otherwise Thunderstore will create a new mod 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-2.3.3"
]
}
ZIP it once again and reupload it.
You should only select "Mixtapes" in the Categories field.
Disclaimer: Make sure you have permission to upload the audio files your mixtape contains to Thunderstore.
YouTube RadioThis has been requested endless times, and it's finally arrived!
Here's how to get it started:
Y.It is autoplay from here (by default). A queue of songs will be filled with endless recommendations based on the song you entered. The recommendations are made to be quite aggressive in their "likeness" so whatever song you pick will become the vibe.
To add more songs later, just press Y to bring QueueUI up again. You can choose whether to Add to End, Play Next or Start the Radio fresh with new recommendations.
No link? No problem. The same box you paste URLs into now also accepts plain text.
Just type the name of a song (or artist, or whatever you're after) and press "Add". sPEAKer will pull up a list of matching results for you to pick from, no alt-tabbing to YouTube required.
Once you choose a result, everything else works the same: autoplay fills the queue with recommendations based on your pick, and you still get to choose whether to Add to End, Play Next or Start the Radio fresh.
YouTube playlist links are supported!
By entering YouTube playlist URL, you skip the recommendations system altogether and the queue will fill with your playlist instead. Playlist support includes albums from YouTube Music, as they are treated as playlists.
You don't need to clean URLs either, just copy and paste.
Note: YouTube Music playlists sometimes display unavailable videos on the YT music app/site. These are filtered out automatically, so you'll probably wanna preview the playlist without the "music." in the URL to see what's actually gonna be added to sPEAKer's Queue.
Spotify links are supported!
But only individual tracks. Spotify playlists are not supported directly.
Instead, you can use a service like Soundiiz to convert Spotify playlists into YouTube ones, which are fully supported.
To go back to Mixtapes, use Ctrl + Y.
This will take you back exactly where you left your mixtape playing, so you always have a backup vibe just in case.
YouTube Radio now keeps state as well, so you can also return to your beloved Queue by pressing Y.
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!
Take your session in however direction you like.
When holding or being followed by sPEAKer, you can press U to bring up the UI.
You can reorder songs by drag and dropping, or directly select one to play from.
There's also a Settings section where you can edit your experience without the need to close the game.
sPEAKer spawns in the airport! Right about here:
Also, when music plays, sPEAKer will take control of the airport flight boards to show four different audio visualizers that react to your music!
Fun fact: I made the first three manually while learning how shaders work. I released star-shaped one on Wallpaper Engine! Please go check it out :-)
The last one was made by JLChnToZ, which goes way harder on their YouTube video.
sPEAKer has a Milestones or Achievements system!
There are 38 milestones of varying difficulty, designed to guide you through everything this mod has to offer and reward you along the way.
Milestones grant XP and work alongside Atomic's Leveling. If you don't have it installed, sPEAKer will hold onto your earned XP until you do.
You can track your progress anytime in the Queue UI (U).
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 |
| FastLoad | 💾 Audio Loading | Makes sPEAKer load songs during gameplay instead of at game start. | true |
| ShowTrackDuration | 🔊 Playback | Shows every song's current time and length. | true |
| DisplayAuthorInfo | 🔊 Playback | Displays track author during 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 |
| SoundEffectsEnabled | 🔊 Playback | Enables JBL sound effects. | true |
| UseSpatialAudio | 🔊 Playback | Enables proximity-based audio. If false, playback will sound globally instead of coming from the sPEAKer. | true |
| RenderVisualizers | 🔊 Playback | Renders visualizers when sPEAKer plays music in the airport. | true |
| AutoPlay | 🔊 Playback | In YouTube Radio mode, whether to keep filling your queue with recommendations or just play what you input. | true |
| MaxCachedSongs | 🔊 Playback | How many songs YouTube Radio is allowed to keep on disk. | 30 |
| PredownloadCount | 🔊 Playback | Number of upcoming songs that YouTube Radio will download in the background. | 5 |
| QueueUITheme | 🔊 Playback | Personalizes your UI with various color styles. Recommended to change in-game. | "default" |
| SpawnAtAirport | 📻 Spawning | Automatically spawn sPEAKer at the airport. | true |
| SpawnAtGameStart | 📻 Spawning | Automatically spawn sPEAKer around the crash site when a game starts. | true |
| SpawnWithF4 | 📻 Spawning | Allows the host to spawn 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, 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! |
true |
To change keybinds more easily, I recommend using ModConfig.
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 |
| YouTubeKey | Enter Youtube Radio mode. Hold Ctrl and this key to exit. | Y |
| SpawnKey | Key to spawn sPEAKer if the corresponding spawning option is enabled. | F4 |
| QueueUIKey | Opens Queue UI. | U |
Keybinds are released regularly alongside new features.
Mixtape Playback
false. You'll then experience a big lag spike when game boots up until music loading finishes, but have no lag during playback.false, as every song will fully load into RAM. This has been tested with up to 250 songs (a mp3/wav/ogg test mix) on a 32 GB system. Potentially more songs could be achieved by using OGG exclusively, and even more if you choose more aggressive compression methods.ExternalAudioFolderPath is set only on first mod load. When moving your game folder, the path won't automatically change. You should set it to your music's folder new location, or you can delete config/onlystar.sPEAKer.cfg to regenerate the correct path (this also resets your other configs).ExternalAudioFolderPath, which will inevitably be an invalid path in your machine. To avoid issues, sPEAKer will automatically default to a relative path to plugins/onlystar-sPEAKer Music when it detects it has been installed through a profile code. Mixtapes downloaded from Thunderstore are unaffected by this config, which is probably the main source of music for shared profiles anyway.YouTube Radio
Y and entering an URL. This works because it kills all pending actions/downloads to prioritize the one you just entered.%temp%/sPEAKerYT, so it's possible you won't need to download tracks you have played recently. You can set how many songs it holds with the MaxCachedSongs config.General
Created by onlystar - Bringing music to the PEAK experience!