Inspired by "Ambience" by Vazkii and "Ambience - Extras" by viniciusgf1, this mod lets you play custom music based on game state such as boss fights, combat, being underground, sleeping, fishing, the time of day, and many more, but with a much more flexible configuration system compared to the older versions. Furthermore, this version does not provide any of the blocks, items, or commands from the older mods (hence the "Mini" in the name) and I currently have no plans of re-implementing these.

CurseForge contains only the minimum information needed to get started with the mod but you can always find more information on the Ambience Mini Wiki or ask questions on the Ambience Mini Discord Server. Feel free to report errors on Discord or GitHub.

Also, Ambience Mini now has a web-based music configuration editor which helps you create, modify, and test music pack configurations, but more on this further below.

Is this mod a bit over-engineered? Perhaps. Was it fun to make? Yes!

A Rough Feature Overview

Trackable game state: The latest version can detect certain menus (e.g., main menu, joining, or paused), the time of day, the weather (snow, rain, and thunder), villages, ranches, caves, certain player states (e.g., sleeping, fishing, mounts, potion/(de-)buff effects, health, flying on elytra), game mode, difficulty, bosses, general combat, the current dimension, the current biome, and current biome tags (e.g., "is_beach" or "is_snowy"), and sky-light.

Improved cave detection: The cave detection algorithm uses the surrounding lighting and blocks to determine whether the player is in a cave or not. Similar mods have all (to my knowledge) used player elevation and other simple values to determine when the player is in a cave, resulting in inaccurate playing of cave music; this has changed.

Default key bindings:

• P reloads Ambience Mini and the music pack while in-game, so you can apply your changed music config without restarting the game or recover if the music engine crashes.
• End will pause/resume the currently playing music.
• Page Up selects a new music within the current playlist.
• Page Down prints all Ambience Mini state (events and properties) to the Minecraft logs, allowing you to see what the mod sees.

Installation and Configuration

To get started, you need to download and install 1) the mod itself and 2) a music pack. Before version 2.2.0, the mod should only be installed on the client. From version 2.2.0 and up, the mod can be installed on either or both the client and the server. When installed on the server, some events are tracked more precisely (and clients without the mod can still join).

Next, you can either download a sample music pack for Ambience Mini 2.4.x or try making your own. In either case, make sure the ambience_music-folder is placed in the .minecraft-folder alongside the mods-folder.

The list below shows the files and folders used by this mod. The music files are located in .minecraft/ambience_music/music/ and the latest mod version supports MP3 and FLAC music files. The file .minecraft/ambience_music/music_config.txt describes which music should be played under which conditions.

- .minecraft
  - ambience_music    // <-- Sample can be downloaded from the link above
    - music
      - Music1.mp3
      - Music2.mp3
      - ...
      - MusicN.mp3
    - music_config.txt
  - config
    - ambience_mini-client.toml
  - mods
    - AmbienceMini-McVersion-ModVersion.jar

Troubleshooting

The custom music only starts if there are no configuration errors, so if the normal Minecraft music starts playing in the main menu that means there was an error somewhere. In Minecraft, all errors in your configuration file or music-file setup will be printed to the Minecraft logs, but you can also try checking your music config with the Ambience Mini IDE. However, the IDE cannot tell if the files referenced in the music config exist or not, so you will have to look at the Minecraft logs to find errors in your music file setup.

Things of Note

Finally, by default, the mod ignores the master volume setting in Minecraft since the music tends to become way too silent compared to other sounds and it was way easier to just disconnect the music from the master volume than to adjust everything else. This behavior can be changed in the "ambience_mini-client.toml" configuration file.