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!

Feature overview

The full capabilities of the mod are explained throughout the wiki, but here is a rough overview.

The latest version can detect/read:

Certain open menus (main menu, joining, disconnected, credits, paused).
Certain world information (difficulty, dimension id, biome ids and tags).
The time of day (day, night, dusk, dawn).
The weather (rain, snow, thunder).
Certain player states (health, sleeping, fishing, underwater, mounts/vehicles, potion/(de-)buff effects, elytra, and more).
Combat state (number of fought mobs, active bosses, and whether a warden is nearby).
Villages and ranches by counting nearby entities.
Whether the player is in a cave based on the surrounding blocks and lighting.
All user-defined areas/regions the player is currently located within. (some features require server support)
Whether the player is in auto-generated structures such as villages and strongholds. (requires server support)
Flags (named text/string values) stored on the server and which can be set with commands. (requires server support)

Cave detection: The cave detection algorithm uses the surrounding lighting and blocks to determine how likely it is that the player is in a cave or not, allowing for much more precise detection of caves compared to other music mods which typically rely solely on ligting and/or elevation.

Area system: Players can define named areas using a fully client-side-based system using key bindings and menus, even when the mod is not installed on the server. With server support, areas can be shared between players.

Flag system: With server support, players with operator privileges can define named variables with text/string values which can be used for music selection. You can also use command blocks to update these flags.

Supported file formats: MP3, OGG, and FLAC.

Basic 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, a few additional features are enabled (and clients without the mod can still join).

Next, you can either download a sample music pack for Ambience Mini 2.5.x-2.6.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/. 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

If you run into problems with setting up the mod or music packs, see also the troubleshooting page.

Things of Note

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.