MinecraftBackgroundMusic

MinecraftBackgroundMusic

A mod for PEAK that replaces region music with custom MP3s, supporting per-region music folders and smooth track transitions. Pre-configured with minecraft music but can be changed easily.

Features

• Plays custom MP3s for PEAK’s regions: Beach, Tropics, Alpine, Mesa, Caldera, Kiln, Peak, and Tomb.
• Automatically switches to a new random track when the current one ends.
• Option to preload tracks so no stutter while tracks switch ingame(Note: Needs to be turned on in config, be aware it makes game lag for about 5-10 secs on the main menu when first launching as its loading the tracks into cache).
• Supports a folder structure with optional region-specific music and a Default fallback if no region-specific music specified.
• Configurable folder names via a config file, including an option to use vanilla Tomb music.
• Preconfigured with Minecraft music, including Nether Update and pre-1.16 Nether tracks for the later stages.

You can customize MP3s however you want! You can delete the included tracks and use your own. The mod plays any MP3s found in the specified folders, making it a versatile background audio mod.

Installation

1. I've only installed this mod manually, its drag and drop. Not sure if it works with thunderstore mod loader thingy.
2. Install BepInEx-BepInExPack_PEAK-5.4.75301 - I installed it manually, just drag contents of BepInExPack_PEAK to Program Files (x86)\Steam\steamapps\common\PEAK.
3. After you've installed BepInEx, you can install my mod.
4. Merge contents of my mod's BepInEx folder (includes the config and plugins folder) into Program Files (x86)\Steam\steamapps\common\PEAK\BepInEx.
5. Optionally add or edit MP3s to subfolders (e.g., CustomBackgroundMusic/Beach, CustomBackgroundMusic/Tropics, CustomBackgroundMusic/Mesa, CustomBackgroundMusic/Tomb, CustomBackgroundMusic/Default). See below to see how the folder structure works. Basically it defaults to the Default folder, and if theres any mp3s in the region specific folders, it uses those instead.

Folder Structure

The mod uses a CustomBackgroundMusic folder located in BepInEx/plugins. Inside, create subfolders for each region:

• Beach: Music for the Beach region.
• Tropics: Music for the Tropics region.
• Alpine: Music for the Alpine region.
• Mesa: Music for the Mesa region.
• Caldera: Music for the Caldera region.
• Kiln: Music for the Kiln region.
• Peak: Music for the Peak region.
• Tomb: Music for the Tomb region (optional, can use vanilla music via config).
• Default: Fallback folder used if a region’s folder is missing or empty. These will play in every region that does not have specific mp3s in their folder.

Currently every region is using the Minecraft Alpha and Classic music (and a couple beta songs I like) from the default folder. Then just for the later stages (Caldera and Kiln) i put the nether music in those folders, so these regions will cycle only between these mp3s. The Tomb region defaults to vanilla music unless you set UseDefaultTombMusic to false and add MP3s to the Tomb folder.

Example:

BepInEx/plugins/
├── CustomBackgroundMusic/
│ ├── Beach/
│ │ ├── track1.mp3
│ │ ├── track2.mp3
│ ├── Tropics/
│ │ ├── tropical_song.mp3
│ ├── Mesa/
│ │ ├── mesa_track.mp3
│ ├── Tomb/
│ │ ├── tomb_track.mp3
│ ├── Default/
│ │ ├── fallback_track.mp3
├── backgroundMusic.dll

• Place MP3s in the appropriate region folders. The mod randomly selects an MP3 from the region’s folder when you enter that region.
• If a region folder is missing or empty, the mod falls back to the Default folder.
• You can delete any region folders you don’t need (or just keep them empty), but ensure the Default folder has MP3s for fallback.

Configuration

The mod generates a config file at BepInEx/config/com.mthwj.minecraftmusic.cfg on first run. It contains entries for each region’s folder name:

• BeachFolder: Folder for Beach region music (default: Beach).
• TropicsFolder: Folder for Tropics region music (default: Tropics).
• AlpineFolder: Folder for Alpine region music (default: Alpine).
• MesaFolder: Folder for Mesa region music (default: Mesa).
• CalderaFolder: Folder for Caldera region music (default: Caldera).
• KilnFolder: Folder for Kiln region music (default: Kiln).
• PeakFolder: Folder for Peak region music (default: Peak).
• TombFolder: Folder for Tomb region music (default: Tomb).
• DefaultFolder: Fallback folder (default: Default).
• UseDefaultTombMusic: If true, uses vanilla Tomb music instead of custom MP3s (default: true).
• AllowStingerMusic: If true, allows ingame stinger effects (e.g. the game has default short tracks played, seperate to background music when sunset or sunrise or at nighttime or when changing region)(default: false).
• PreloadAudioClips: If true, preloads all MP3s during game startup to avoid lag spikes during gameplay, but may cause initial main menu screen lag (e.g., 10 seconds depending on amount and file size of audio tracks)(default: false). I do recommend turning it on, otherwise you get stutters between each track change, just defaulted it to off so people dont get spooked why their game lags horribly for 10 secs when first launched.

Folder names can be relative to CustomBackgroundMusic (e.g., Beach) or absolute paths (e.g., C:\Music\Beach). Edit the config to change folder names or point to custom locations.

Notes

• The mod is preconfigured with Minecraft music, including Nether Update tracks and pre-1.16 Nether music for less peaceful regions (e.g., Caldera, Kiln). The Mesa biome now supports custom tracks, and the Tomb region can use either vanilla or custom music based on the UseDefaultTombMusic config. Feel free to replace these with your own MP3s.
• Join the PEAK modding Discord and discuss in my mod's c