Sophisticated Pulse-Eloquent Acoustic Kymatologic Eidolon Reverberator

🎶 ...or just sPEAKer

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!

🎮 Controls

Playback control uses your regular interaction buttons, whatever they are.

• Primary: Play/Pause toggle

• Secondary: Next Song

• Scroll: Volume Up/Down

Controller compatible.

Manual Installation

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

Adding Music

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.

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

The idea behind mixtapes is that they are easy to share and organize.
Further updates will support extended metadata. Probably.

Bundling a mixtape for Thunderstore

If you want to upload your own mixtape as a standalone mod, just put an empty sPEAKer.json file in the same folder as your mixtape folder.

You can follow the instructions in Manual Packaging as described here.

Your package should include manifest.json, README.md, /plugins folder and (hopefully) a 256x256 icon.png.

The plugins folder of your package should look something like this:

plugins/
├── sPEAKer.json
└── boss music/
    ├── a true hero.ogg
    ├── omega flowey.mp3
    ├── ...
    └── mixtape.json

sPEAKer.json is the way of telling sPEAKer "this folder contains music".

Once your package is ready, ZIP it and upload it to Thunderstore.

💡 TIP: Keep your original package for updates!

Updating your Thunderstore mixtape

If you wanna add songs to an already published mixtape, add your songs to the original (uncompressed) package and bump the version up in your manifest.json:

{
    "name": "sPEAKer_Undertale_Boss_Music",
    "author": "onlystar",
    "description": "It fills you with determination.",
    "version_number": "1.0.1", // <--- previously "1.0.0"!
    "website_url": "",
    "dependencies": []
}

ZIP it once again, and reupload it.

Disclaimer: Make sure you have permission to upload the audio files your mixtape contains to Thunderstore.

Config. Options 🪚

These are options you can change before starting your game. You can find them in BepInEx/config/onlystar.sPEAKer.cfg

🎛️ Technical Notes

• For the best experience, everyone in the room should have the same tracks and mixtapes.
• In the current version, the host owns the tracklist canon, which means everyone must play the host's catalogue.
• If you are missing a song your host has, don't worry! Every song is hashed by its contents on load. Playback will resume as soon as they start playing something you do have.
• Large files and mp3/wav files can cause significant lag spikes when reading them. Because of this, loading was placed as soon as game awakes, so the lag spike happens at the logos fusing thingy and not during gameplay. Until I further optimize audio loading, this big lag spike is the best solution I thought of. If you have a mod that skips the logos, you will probably experience it as soon as your game is available (untested).

Coming up next... 🔮

• More playback controls (shuffle, loop, etc.)
• Recalling ability for non-host players
• Better mixtape metadata
• Multiple sPEAKer support
• More things that I will not disclose to avoid expectations that may not come true :D

Created by onlystar - Bringing music to the PEAK experience!

Changelog

[1.9.4]

• Dance moves are now networked, me dumb forgot to back in 1.8.2
• Fixed an issue where late joining clients would become rebels and not listen to anything the host had to say.
• "Next" will now start next song even if paused.
• Simplified Technical Notes section in README.

[1.9.3]

• Revamped late joining sync to use host-client handshake so that state is properly set regardless of network conditions (up to a certain threshold). Also added extra checkpoints to ensure a bad state doesn't contaminate all the party.
• Fixed an issue where local volume value would not be reflected in the slider upon going back to main menu and starting a new game.
• Fixed an issue where networked volume would break under certain conditions.
• Fixed an issue where F4 could spawn multiple sPEAKers during item state transtitions. It should now be impossible, unless you spawn it through other methods for which you're fully responsible of :p

[1.9.2]

• Added a Help page to the UI. (Sections: Getting Started, Keybinds and Queue Usage)
• Made it far easier for myself to add new UIs. Up next: Live Settings.

[1.9.1]

• Added Reset button to Queue UI. It restores the queue to its original order. There's no "undo", so it requires a long-press to prevent accidental resets.

[1.9.0] UI UPDATE

• Added Queue UI! Press U to toggle.
• See what's playing, what's played and what's next. Drag and Drop to reorder or Pick a song directly!
• Queue UI can be toggled by anyone who is holding or is currently being followed by sPEAKer.
• NEW CONFIG: QueueUIKey. Yeah this time the new feature comes with its keybind configurable right away lol. Default: U
• NEW CONFIG: UseSpatialAudio. If DISABLED, playback will sound globally instead of coming from sPEAKer. Default: true
• Fixed an issue where some mixtapes were not recognized as such given how they were packaged, causing metadata issues. The audio master was adjusted to account for different styles of packaging and should reliably read most if not all of existing mixtapes now.

[1.8.8]

• NEW CONFIG: SpawnKey keybind. Default: F4
• NEW CONFIG: SoundEffectsEnabled. Default: true

[1.8.7]

• NEW CONFIG: DroneToggle keybind. Default: P
• NEW CONFIG: RecallCommand keybind. Default: LeftControl (used with DroneToggle key)
• NEW CONFIG: DanceEmote keybind. Default: O
• Updated sPEAKer Wiki.
• Actually improved README (last time I only wrote it in the Changelog but didn't do it lol).

[1.8.6]

• NEW: Packaged mixtapes will now show their existing icon.png as mixtape art.
• Laid the foundation for upcoming playlist feature.
• Improved README.

[1.8.5]

• Hashes are now cached for a slight audio loading optimization.
• Drone search should now start following as soon as someone is within range.
• Fixed an issue where all dance moves had a small chance to become unselectable by the random picker.

[1.8.4]

• Added sound effects when sPEAKer is searching someone to follow and when it finds them.
• Added Drone Recall with Ctrl + P. Command sPEAKer to start following you no matter the distance.
• As the host, you can no longer steal sPEAKer with F4 while it's following someone else. Grabbing it manually is still fair game.
• Similarly, you can't use Drone Recall if it's following someone else.
• Optimized late player sync.

[1.8.3]

• Fixed an issue where sPEAKer would just refuse to load.

[1.8.2]

• Added 9 DANCE Moves! Press O when in Drone Mode.
• Removed unintended minimal volume hidden setting. You can now throw sPEAKer very far away and actually enjoy silence and find inner peace.
• Changed how audio falloff curve feels. This is a manually crafted effect, so any feedback from any audiophiles out there in the wild is greatly appreaciated.
• HUGE REFACTOR for [REDACTED]

[1.8.1]

• Instead of binding to a single player forever, Drone Mode will now try to follow the nearest player in a radius every time the mode is engaged.
• This, in turn, disabled the ability to throw it far away and have it come back to you. Don't worry, it will come back as a Recall ability soon™.
• Added an indicator to show exact Drone search radius.
• Fixed an issue where if Drone sPEAKer was following someone and they died, it would follow them to the afterlife.
• Improved custom logging system.

[1.8.0] DRONE UPDATE

• Added DRONE MODE! Drop the sPEAKer and press P.
• Fixed mixtape author incorrectly displaying as unknown.

[1.7.1]

• Added Sound Effect when reaching max Volume
• Added Sound Effect when entering [REDACTED]
• Fixed UI state issues when entering [REDACTED]

[1.7.0] PLAYBACK CONTROLS

• NEW: Loop modes! Toggle with Alt + Secondary
• NEW: Previous song! Use with Shift + Secondary
• Netcode now correctly broadcasts most changes to playback state
• Updated README (it's updated every patch but just in case you only read the changelog :P)

[1.6.0] NEW CONFIGS

• NEW CONFIG: StartupLoadingIndicator, enabled by default, to show an audio loading indicator at game boot. It lasts as long as the initial lag spike does.
• NEW CONFIG: DisplayMixtapeAuthor, enabled by default, to show the mixtape author during playback.
• Fixed an issue where audio loading would break when sPEAKer had been installed through a Thunderstore profile code.
• Fixed an issue where sPEAKer would sometimes spawn below ground level at the Shore.

[1.5.0] MIXTAPE AUTHOR

• Added mixtape author below stamina bar.
• Added indicator when songs and mixtapes are loading.
• Fixed issue where in-game font would sometimes not load.
• Changed song hashing method. This should fix song-syncing issues some people were still having, but will introduce more lag while songs are loading.
• Optimized audio loading, albeit unnoticeable given the previous point.

[1.4.0] LOCAL VOLUME

• Added Local Volume control to pause menu.

[1.3.1]

• Optimized netcode handling.
• Fixed state inconsistencies when getting back to the airport or main-menuing.
• Fixed next song not starting automatically when sPEAKer is pocketed (I refactored an entire class for this 💀).

[1.3.0] TRACK DURATION

• Added Track Duration (enabled by default).
• Added new configs: ShuffleOnStart, TurnOnAndPlay, ShowTrackDuration.

[1.2.1]

• Disabled unfinished feature.

[1.2.0] SHUFFLE

• Added Shuffle.
• Added clarification to add sPEAKer as a dependency to uploaded mixtapes.
• Fixed an issue where downloaded mixtapes sometimes would not load for non-hosts.
• Fixed an issue where netcode would sometimes generate a duplicate photon ID.
• Fixed volume step being too aggressive when using a controller.
• Fixed some localization texts for Spanish, Korean and Japanese.
• Removed Herobrine.

[1.1.5]

• Many optimizations for upcoming 1.2.0
• Removed Herobrine.

[1.1.4]

• Now sPEAKer looks for music on its own folder too (onlystar-sPEAKer), just in case.

[1.1.3]

• Minor optimizations and code cleaning.
• Added instructions to update an existing Thunderstore mixtape in README.

[1.1.2]

• Bundle optimization for MESA update.
• Some groundwork for upcoming feature.

[1.1.1]

• Changed recalling with F4 to be enabled by default (host only).
• Fixed a desync when dropped while paused.
• Fixed files not loading if containing special characters.

[1.1.0] ACTUAL RELEASE

• Added MP3 and WAV support.
• Removed ZIP format requirement for mixtapes.
• Updated README.

[1.0.0] RELEASE

• Initial release, with mixtapes.