Fabric Wiki

This page is read only. You can view the source, but not change it. Ask your administrator if you think this is wrong.
====== Playing Sounds ======
Ready to replace those zombie sounds with your own sounds? You've come to the right place.   

===== Playing a pre-existing sound =====
Playing a pre-exisiting sound is fairly simple. Make sure you are on the logical server and call ''world.playSound'' like so:
<code java>
if (!world.isClient) {
      world.playSound(
              null, // Player - if non-null, will play sound for every nearby player *except* the specified player
              blockPos, // The position of where the sound will come from
              SoundEvents.BLOCK_ANVIL_LAND, // The sound that will play, in this case, the sound the anvil plays when it lands.
              SoundCategory.BLOCKS, // This determines which of the volume sliders affect this sound
              1f, //Volume multiplier, 1 is normal, 0.5 is half volume, etc
              1f // Pitch multiplier, 1 is normal, 0.5 is half pitch, etc
      );
}
</code>

You can do this when the block is right clicked for example, by overriding ''onUse'':
<code java>
public class ExampleBlock extends Block {
    [...]
    
    @Override
    public ActionResult onUse(BlockState blockState, World world, BlockPos blockPos, PlayerEntity placedBy, Hand hand, BlockHitResult blockHitResult) {
        if (!world.isClient) {
            world.playSound(null, blockPos, SoundEvents.BLOCK_ANVIL_LAND, SoundCategory.BLOCKS, 1f, 1f);
        }

        return false;
    }
}
</code>

===== Adding a custom sound =====
There's some extra steps involved in playing a sound that's not already in the game. We'll add a "punch" sound, that is available under CC0 [[https://freesound.org/people/Ekokubza123/sounds/104183/|here]] for the example.
==== Step 1: Add your .ogg sound file ====
To play a sound, you first need a sound file. Minecraft uses the ''.ogg'' file format for those. 
If your sound file is in a different format (like the one in the provided link), you can use an online converter to convert from your format to ''.ogg''. 
Make sure your sound has only one channel, otherwise the attenuation effect (gradual loss of volume with distance) won't be applied to it.  
Now put your .ogg file in the ''resources/assets/modid/sounds'' folder. In the example case the file will be ''resources/assets/tutorial/sounds/my_sound.ogg''.  
==== Step 2: Add a sounds.json file, or add to it if you already have one ====
Under ''resources/assets/modid'' add a new file named ''sounds.json'', if you do not have one yet.
Then add a new object entry with the name of your sound, and the sound's identifier in ''"sounds"'', for example:
<code javascript resources/assets/tutorial/sounds.json>
{
  "my_sound": {
    "sounds": [
      "tutorial:my_sound"
    ]
  }
}
</code>
You can also add a subtitle to your sound. The subtitle is a translation key, which should go in your language file.
<code javascript resources/assets/tutorial/sounds.json>
{
  "my_sound": {
    "subtitle": "subtitles.tutorial.my_sound",
    "sounds": [
      "tutorial:my_sound"
    ]
  }
}
</code>

See the [[https://minecraft.gamepedia.com/Sounds.json|Minecraft Wiki]] for more details about ''sounds.json''.
==== Step 3: Create your sound event ====
Simply create a new instance of ''SoundEvent'' with the identifier ''modid:sound_name'', for example:
<code java>
public class ExampleMod {
    [...]
    public static final Identifier MY_SOUND_ID = Identifier.of("tutorial:my_sound");
    public static SoundEvent MY_SOUND_EVENT = SoundEvent.of(MY_SOUND_ID);
}
</code>
If you're using version 1.19.2 or below, please replace ''SoundEvent.of'' with ''new SoundEvent'', and 
if you're using versions below 1.21, replace ''Identifier.of'' with ''new Identifier''。 
==== Step 4: Register your sound event ====
Register your sound event under the ''SOUND_EVENT'' registry:
<code java>
@Override
public void onInitialize(){
     [...]
     Registry.register(Registries.SOUND_EVENT, ExampleMod.MY_SOUND_ID, MY_SOUND_EVENT);
} 
</code>
If you're using version 1.19.2 or below, please replace ''Registries'' with ''Registry''。
==== Step 5: Use your sound event ====
Use the sound event just like we explained at the start (''onUse'' is just an example, use it anywhere you have access to ''World'' instance):
<code java>
public class ExampleBlock extends Block {
    @Override
    public ActionResult onUse(BlockState blockState, World world, BlockPos blockPos, PlayerEntity placedBy, Hand hand, BlockHitResult blockHitResult) {
        if (!world.isClient) {
            world.playSound(
                    null, // Player - if non-null, will play sound for every nearby player *except* the specified player
                    blockPos, // The position of where the sound will come from
                    ExampleMod.MY_SOUND_EVENT, // The sound that will play
                    SoundCategory.BLOCKS, // This determines which of the volume sliders affect this sound
                    1f, //Volume multiplier, 1 is normal, 0.5 is half volume, etc
                    1f // Pitch multiplier, 1 is normal, 0.5 is half pitch, etc
            );
        }
        return false;
    }
}
</code>
You should now hear a punch sound when you right click your block!
==== Troubleshooting ====
Don't hear anything? Try:
  * Turning up your in-game volume sliders.
  * Deleting the output directory.