Manual Installation

1. Install BepInEx for PEAK
2. Install required dependencies
   • PEAKLib.Items
   • PEAKLib.Core
   • SoftDependencyFix
   • MonoDetour_BepInEx_5
   • MonoDetour
   • ytModule
3. Place the mod files in your BepInEx plugins folder
4. Launch PEAK

NOTE: Not all dependencies go into /plugins. If you have issues, use a mod manager before asking for support.

🎮 Controls

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.}

Adding Music

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.

📀 Introducing: 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" in Thunderstore

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".

Bundling a mixtape for Thunderstore

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.2.0" // 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

Updating your Thunderstore mixtape

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.2.1"
    ]
  }

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 Radio

This has been requested endless times, and it's finally arrived!

Here's how to get it started:

1. After turning sPEAKer on, switch to YouTube Radio using Y.
2. QueueUI will show up with a box to enter an URL.
3. Enter a YouTube, Spotify or Soundcloud link into it and press "Add".

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.

💾 We have playlists at home

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 Support

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.

🔃 Switch it up

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.

More Features!

🪽 Featuring: Drone Mode

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.

🕺 It can also Dance!

sPEAKer features 9 different dance motions / emotes.

Press O when Drone Mode is activated to strike a move!

🌠 You're in Control

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.

✈️ Takes off with You

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.

🏆 Milestones

sPEAKer has a Milestones or Achievements system!

There are 36 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).

Configuration Options 🪚🔧🔨

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.

⌨️ Keybinds

To change keybinds more easily, I recommend using ModConfig.

The following keybinds are currently configurable:

Keybinds are released regularly alongside new features.

️Technical Notes

Mixtape Playback

• For the best experience, everyone in the room should have the same tracks and mixtapes.
• The host always owns the tracklist canon, which means everyone must play the host's catalogue regardless if you have more music locally.
• If you're missing a song your host has, you'll hear white noise instead. Songs are content-hashed on load, so playback will resume when the host plays something you do have.
• Large files (4MB+) and MP3/WAV files cause significant lag spikes during loading. OGG is strongly recommended.
• Shuffle randomizes your list every time you toggle it on, so you might get repeated songs if you toggle it more than once.
• If you experience lag when playing music, you can load during game startup instead by setting FastLoad to false. You'll then experience a big lag spike when game boots up until music loading finishes, but have no lag during playback.
• Beware of loading too much music with FastLoad set to 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).
• When importing a profile code, it copies both mods AND configs from the original profile. This includes their 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

• This mode has been designed to be used slow. Skipping too quickly will eventually result in a messy state. The room will also eventually sync again, but it can take some time.
• If you're ever stuck in a messy state too long while in YouTube Radio, you can fix it by pressing Y and entering an URL. This works because it kills all pending actions/downloads to prioritize the one you just entered.
• Despite the name, YouTube Radio is download-based and does not stream. This may change in the future.
• Songs next in queue are always being downloaded in the background. This means that while you play a song, you are also downloading the next 10 or so in the queue to achieve a faster playback experience similar to that of mixtapes.
• YouTube Radio always keeps a small cache of songs in %temp%/sPEAKerYT, so it's possible you won't need to download tracks you have played recently. A future update will include configs to set the size of this cache to whatever you want, be it in terms of disk space or amount of songs.
• The sync strategy in YouTube Radio is host-centric. The host always starts playing first, and the rest catch up to them when they can.

General

• sPEAKer monitors its own existence across all clients in the room. If anyone loses track of it or ends up with inconsistent state, sPEAKer will automatically respawn after five seconds to prevent permanent loss.
• sPEAKer is considered to "exist" when it's: on the ground, floating in the air, in a backpack, held in someone's hands, or in someone's pocket. If it disappears from any of these states without explanation, a respawn is triggered.
• When respawning, sPEAKer will appear above its last known holder in Drone mode. Any duplicate copies in inventories/backpacks will be removed to maintain a single instance.
• In some cases, your client may be forced to destroy and respawn sPEAKer even if you never had a failed state. This ensures all clients stay synchronized; consistency is prioritized over continuity.
• The respawn system is still a work in progress. If you encounter cases where sPEAKer fails to respawn or you do lose it permanently, please report it!