Installation

Installation and Configuration

This page explains how to install and configure Ambience Mini with a pre-made music pack.

Installation

For a video-based guide: https://www.youtube.com/watch?v=Addpe8c0gQQ

To get started, you'll need the mod jar-file and a music pack and place them into your minecraft client and/or server installation directory as shown in the code blocks below. Mod-configuration files are auto generated and for more information on how to configure the mod, see the next section.

The mod: You install the mod by putting the mod jar-file in the mods-folder (on the server and/or client). Before version 2.2.0, the mod can only be installed on the client. From version 2.2.0 and onward, the mod can be installed on either or both the client and server (see the "Sidedness" section below for details).

The music pack: The .minecraft/ambience_music folder contains the music-configuration file called music_config.txt as well as a music-folder containing all the custom music that Ambience Mini should be able to play. You can download sample music packs for different versions of Ambience Mini below, each of which contains a pre-built ambience_music-folder. See the music packs page if you wish to make your own music pack.

NOTE: If you install the mod but no music pack, the normal Minecraft music will play.

File and folder locations

Client-side:

- .minecraft
  - ambience_music
    - music
      - (music files...)
    - music_config.txt
  - config
    - ambience_mini-client.toml
  - mods
    - AmbienceMini-McVersion-ModVersion.jar

Server-side (only relevant from version 2.2.0 and onward):

- server
  - mods
    - AmbienceMini-McVersion-ModVersion.jar

Sidedness

If Ambience Mini is installed on both the server and client, all features described on this wiki will be enabled. Clients without the mod can still join servers with the mod installed, but will not be able to use any of the Ambience Mini features.

When installed on the client only:

Combat tracking will be much less precise in 1.18.2 and 1.19.2, but only slightly less precise in later versions.
Structure detection (e.g. strongholds) will be disabled.
Sharing (i.e. server-side storage) of areas will be disabled.
The flag system will be disabled and the $flags property will always have the value undefined.

Furthermore, the client and server need not have the same version of the mod installed. The client and server selectively enables/disables features and interactions based on the version of the mod at the other side. Generally, any two versions of the mod should work together without crashing.

Configuration

The mod has two configuration files: "mod configuration" (ambience_mini-client.toml) and "music pack configuration" (music_config.txt). There is currently no configuration for Ambience Mini on the server-side.

`ambience_mini-client.toml`

The ambience_mini-client.toml-file in the .minecraft/config-folder is auto-generated when Minecraft is first launched after installing the mod and contains some low-level settings regarding how Ambience Mini as a whole behaves. In this file, you can configure certain timeouts, the thresholds in relation to determining whether the player is in a village or a ranch, how detailed and far-reaching the measurements of the cave-detector should be, and much more.

See the configuration file for a list of all mod-settings and their descriptions. Typically, it should not be necessary to change any settings in this file.

NOTE: By default, the Ambience Mini music player 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.

`music_config.txt`

This file dictates exactly how the mod should pick music depending on the state of the game. For a guide on how to create or modify music packs and their configurations, as well as a list of supported audio formats, see the music packs page.