Sounds

Table of contents

Intermediate

In bedrock, we have the ability to add custom sounds, without overwriting any vanilla sounds. This is done by adding files to the resource pack.

protip: The best way to learn about sounds is downloading and playing around with the default resource pack.

Folder Structure

There are two main files that we edit when we want to add sounds. Note how sound_definition is nested inside sounds.

└───example_RP
    │   sounds.json
    └───sounds
            sound_definitions.json

Sound Formats

The following sound formats are accepted:

• .ogg (reccomended)
• .wav
• .mp3 (Not executable with /music!)
• .fsb (difficult to work with)

sound_definitions.json

sound_definitions.json is where we define new sound short-names. This should be thought of as typing a short-name or id to a physical sound path. Here is an example sound_definitions.json that adds a new trumpet sound called example.toot.

{
    "format_version": "1.14.0",
    "sound_definitions": {
        "example.toot": {
            "category": "neutral",
            "sounds": [
                "sounds/trumpet"
            ]
        }
    }
}

Sounds added in this way can be triggered using /playsound. Please note that playsound does not auto-correct, so you will need to be careful in your typing.

note: New files that are referenced by file path, such as sounds, DO need a full client restart in order to load. This means that if sounds don’t work, you should restart your entire MC client, rather than just reloading the world.

Top Level Keys

In the example above, I showed two top-level fields: category, and sounds. Sounds will be discussed in further detail bellow, but the other top-level keys will be discussed here:

Categories

Categories are used internally by the engine to decide how each sound is played. We can utilize different channels to get different effects.

min_distance

WIP

max_distance

WIP

Sound definitions

In the example above, I showed sounds as simply a list with a single path. This is good for simple sounds, but does not have much power. For starts, I can add multiple sounds into the list. These sounds will be randomized when played:

"sounds": [
    "sounds/trumpet",
    "sounds/trumpet2",
    "sounds/trumpet3"
]

Additionally, we can define each sound as an object, instead of a string. This allows us finer control, and unlocks some new settings. The string/object style can be mixed and matched.

name

The path to the file, such as: "sounds/music/game/creative/creative1"

stream

Limits the sound to only be played a limited number of instances at a time. Good for improving preformance on sound heavy worlds.

volume

How loud the sound should play, from 0.0 to 1.0. Sounds cannot be made louder than originally encoded.

load_on_low_memory

Forces the loading of the sound even when nearing low memmory. “load_on_low_memory” is now deprecated as of 1.16.0

pitch

The pitch of the sound (how low/high it sounds). Ranges from 0.0 to 1.0 (normal), but can be higher, such as 1.48.

Example

Here is a more realistic example containing these options:

"block.beehive.drip": {
    "category": "block",
    "max_distance": 8,
    "sounds": [
        {
            "name": "sounds/block/beehive/drip1",
            "load_on_low_memory": true
        },
        "sounds/block/beehive/drip2",
        "sounds/block/beehive/drip3",
        "sounds/block/beehive/drip4"
    ]
}

sounds.json

If we want our sounds to run automatically, we can add them into the sounds.json file. This will tie the sound definitions directly to game events, and cause them to play, without needing to trigger with /playsound.

Sounds can be added into various categories:

Adding Entity Sounds

I assume that sounds can be added in other categories, but I personally only have experience adding sounds into the entities category. Entity sounds are automatically played at various points in the entities life-cycle.

Common events:

There are also many sound events, which most likely trigger automatically, but which I don’t have details for, such as:

Example

{
    "entity_sounds": {
        "entities": {
            "sirlich:elephant": {
                "volume": 1,
                "pitch": [
                    0.9,
                    1.0
                ],
                "events": {
                    "step": {
                        "sound": "elephant.step",
                        "volume": 0.18,
                        "pitch": 1.1
                    },
                    "ambient": {
                        "sound": "elephant.trumpet",
                        "volume": 0.11,
                        "pitch": 0.9
                    }
                }
            }
        }
    }
}

Adding sounds to Animations

Sounds played in animations function based off of short-name definitions in the RP entity file.

This example shows playing a wing-flap sound, synced with an animation.

RP/entities/dragon.jsonminecraft:client_entity/description

"sound_effects": {
    "wing_flap": "wiki.dragon.wing_flap" //where wiki.dragon.roar is a sound definited in sound_definitions
}

RP/animations/dragon.jsonanimations/animation.dragon.flying

"sound_effects": {
    "3.16": {
        "effect": "wing_flap"
    }
}

Adding sounds to Animation Controllers

You can play sounds within animation controllers in a similar way that animations can be.

This example shows playing an explosion sound, synced using an animation controller.

RP/entities/custom_tnt.jsonminecraft:client_entity/description

"sound_effects": {
    "explosion": "wiki.custom_tnt.explosion" //where wiki.custom_tnt.explosion is a sound definited in sound_definitions just like animation sounds.
}

RP/animation_controllers/custom_tnt.animation_controllers.jsonanimation_controllers/custom_tnt.animation_controllers.json

"states": {
  "default": {
    "transitions": [
      {
        "explode_state": "query.mark_variant == 1"
      }
    ]
  },
  "explode_state": {
    "sound_effects": [
      {
        "effect": "explosion"
      }
    ],
    "transitions": [
      {
        "default": "query.mark_variant == 0"
      }
    ]
  }
}