Custom Sounds

EcoItems can add fully custom sounds to your server: music, ambience, UI feedback, ability sounds - anything you can put in a .ogg file. Sounds are delivered through the resource pack and play like any vanilla sound.

Creating a sound

Each sound is one config in the sounds/ folder - the file name is the sound's ID. Drop the audio file in pack/assets/ecoitems/sounds/ as a .ogg, and reference it from the config (a [namespace:]path relative to sounds/, no extension, namespace defaulting to ecoitems):

# sounds/battle_horn.yml
category: player
subtitle: "Battle Horn"
sound: battle_horn # pack/assets/ecoitems/sounds/battle_horn.ogg

After /ecoitems reload, the sound plays as ecoitems:battle_horn:

/playsound ecoitems:battle_horn player @a

Or from any libreforge effect config, with the play_sound effect:

effects:
  - id: play_sound
    args:
      sound: ecoitems:battle_horn
    triggers:
      - alt_click

All options

# (Optional) The client volume slider this sound belongs to. One of:
# master, music, record, weather, block, hostile, neutral, player,
# ambient, voice. Defaults to master.
category: master

# (Optional) The subtitle shown when the sound plays (with subtitles enabled).
subtitle: "Battle Horn"

# The sound files. One entry plays as-is; multiple entries are picked
# randomly, weighted by weight.
sounds:
  - sound: horns/battle_horn # pack/assets/ecoitems/sounds/horns/battle_horn.ogg
    volume: 1.0 # (Optional) Playback volume, defaults to 1.0
    pitch: 1.0 # (Optional) Playback pitch, defaults to 1.0
    weight: 2 # (Optional) Random-pick weight, defaults to 1
    stream: false # (Optional) Stream from disk; use for long sounds like music
    attenuation-distance: 16 # (Optional) Audible range in blocks, defaults to 16
    preload: false # (Optional) Load when the pack loads instead of on demand
  - sound: horns/battle_horn_alt

Simple sounds can skip the list entirely with sound: <name>, and a plain list of names works too:

sounds:
  - horns/battle_horn
  - horns/battle_horn_alt

An entry can also reference vanilla samples by namespaced key (e.g. minecraft:dig/stone1) instead of a file in pack/assets/ecoitems/sounds/.

Language files

The pack can also override the client's translation strings, with lang files at their normal vanilla location. Entries in pack/assets/minecraft/lang/global.json apply to every language at once; per-language files like pack/assets/minecraft/lang/en_us.json override it for that language:

// pack/assets/minecraft/lang/global.json
{
  "menu.disconnect": "§7See you soon!"
}

// pack/assets/minecraft/lang/en_us.json
{
  "menu.returnToGame": "Back to the EcoItems experience"
}

Values support :glyph: placeholders (see Glyphs) and § color codes. Keys starting with _ are treated as comments. Any vanilla translation key can be overridden - the defaults EcoItems ships are just a starting point.

Custom music discs

Add a jukebox section to any sound and EcoItems registers it as a jukebox song (through a generated datapack - needs a restart, the console tells you when):

# sounds/welcome.yml
category: record
sound: welcome
jukebox:
  description: "Welcome" # the disc tooltip / now-playing text
  length-seconds: 30 # how long the jukebox stays busy
  comparator-output: 4 # redstone comparator level, 1-15
  # range: 48            # (Optional) audible range in blocks

Then any item with a jukebox_playable component becomes a working music disc (see the shipped welcome_disc example):

item:
  item: paper
  components:
    "minecraft:max_stack_size": 1
    "minecraft:jukebox_playable": "ecoitems:welcome"