Sound Sets

Sound sets define collections of sound events for items, NPCs, weapons, and UI interactions. They map action contexts to specific sound event IDs.

Asset Locations

DirectoryAssets/Server/Audio/
- DirectoryItemSounds/
  - ISS_Default.json
  - ISS_Weapons_Blade_Large.json
  - ISS_Weapons_Blunt_Small.json
  - ISS_Armor_Heavy.json
  - ISS_Items_Potion.json
  - (36 item sound sets)
- DirectorySoundSets/
  - CreativePlayDefaults.json
- DirectoryAudioCategories/
  - AudioCat_Music.json
  - AudioCat_Weapons.json
  - AudioCat_Footsteps.json
  - AudioCat_NPC.json
  - AudioCat_Inventory.json
  - AudioCat_Discovery.json
  - DirectoryNPC/
    AudioCat_NPC_Wolf.json
    AudioCat_NPC_Zombie.json
    (80+ NPC audio categories)
  - DirectoryWeapons/
    AudioCat_Sword.json
    AudioCat_Battleaxe.json
    AudioCat_Shortbow.json
    (8 weapon categories)

Item Sound Sets (ISS)

Item Sound Sets define sounds for inventory interactions like dropping and dragging items.

Schema

{
  "SoundEvents": {
    "Drop": "<sound_event_id>",
    "Drag": "<sound_event_id>"
  }
}

Field	Type	Description
`SoundEvents`	`object`	Map of action context to sound event ID
`SoundEvents.Drop`	`string`	Sound when item is dropped
`SoundEvents.Drag`	`string`	Sound when item is dragged

Sound Set	Description
`ISS_Weapons_Blade_Large`	Large swords, greatswords
`ISS_Weapon_Blade_Small`	Daggers, knives
`ISS_Weapon_Blunt_Large`	Hammers, maces
`ISS_Weapons_Blunt_Small`	Clubs, small bludgeons
`ISS_Weapons_Stone_Large`	Large stone weapons
`ISS_Weapons_Stone_Small`	Small stone weapons
`ISS_Weapons_Wood`	Wooden weapons
`ISS_Weapons_Wand`	Magic wands
`ISS_Weapons_Shield_Metal`	Metal shields
`ISS_Weapons_Shield_Wood`	Wooden shields
`ISS_Weapons_Arrows`	Arrows and bolts
`ISS_Weapons_Books`	Spellbooks

Sound Set	Description
`ISS_Armor_Heavy`	Plate armor, metal gear
`ISS_Armor_Leather`	Leather armor
`ISS_Armor_Cloth`	Cloth armor, robes

Sound Set	Description
`ISS_Items_Metal`	Metal ingots, tools
`ISS_Items_Cloth`	Fabric, clothing
`ISS_Items_Leather`	Leather items
`ISS_Items_Paper`	Books, scrolls, paper
`ISS_Items_Potion`	Potions, bottles
`ISS_Items_Gems`	Gems, crystals
`ISS_Items_Ingots`	Metal bars
`ISS_Items_Bones`	Bones, skeletal items
`ISS_Items_Seeds`	Seeds, small items
`ISS_Items_Foliage`	Plant materials
`ISS_Items_Clay`	Clay, ceramic items
`ISS_Items_Shells`	Shells, chitin
`ISS_Items_Splatty`	Soft, wet items
`ISS_Items_Chest`	Chests, containers
`ISS_Items_Gadget`	Mechanical items

Sound Set	Description
`ISS_Blocks_Wood`	Wooden blocks
`ISS_Blocks_Stone`	Stone blocks
`ISS_Blocks_Gravel`	Gravel, loose materials
`ISS_Blocks_Soft`	Soft blocks (dirt, sand)
`ISS_Blocks_Splatty`	Wet/muddy blocks

Examples

{
  "SoundEvents": {
    "Drop": "SFX_Drop_Weapons_Blade_Large",
    "Drag": "SFX_Drag_Weapons_Blade_Large"
  }
}

{
  "SoundEvents": {
    "Drag": "SFX_Drag_Item_Default",
    "Drop": "SFX_Drop_Item_Default"
  }
}

{
  "SoundEvents": {
    "Drag": "SFX_Drag_Armor_Heavy",
    "Drop": "SFX_Drop_Armor_Heavy"
  }
}

Usage in Items

Items reference sound sets via the ItemSoundSetId property:

{
  "Parent": "Template_Weapon_Sword",
  "ItemSoundSetId": "ISS_Weapons_Blade_Large",
  "Model": "Items/Weapons/Sword/Iron.blockymodel"
}

Block Sound Sets

Block Sound Sets define sounds for block interactions like walking, breaking, and building. These are separate from the ISS_Blocks_* item sound sets (which handle inventory drag/drop for block items).

Schema

{
  "SoundEvents": {
    "<context>": "<sound_event_id>"
  },
  "MoveInRepeatRange": { "Min": 0.5, "Max": 1.5 }
}

Field	Type	Default	Description
`SoundEvents`	`object`		Map of `BlockSoundEvent` context to sound event ID
`MoveInRepeatRange`	`object`	`{ Min: 0.5, Max: 1.5 }`	Time range (seconds) between repeated MoveIn sounds

Block Sound Events

Event	Description
`Walk`	Player walking on the block
`Land`	Player landing on the block
`MoveIn`	Player entering the block space
`MoveOut`	Player leaving the block space
`Hit`	Block being hit/mined
`Break`	Block being destroyed
`Build`	Block being placed
`Clone`	Block being cloned (creative)
`Harvest`	Block being harvested

Usage in Blocks

Blocks reference block sound sets via the BlockSoundSetId property:

{
  "BlockSoundSetId": "BSS_Stone"
}

UI Sound Sets

UI Sound Sets define sounds for specific interface interactions.

Schema

{
  "SoundEvents": {
    "<context>": "<sound_event_id>"
  },
  "Category": "<audio_category>"
}

Field	Type	Description
`SoundEvents`	`object`	Map of context key to sound event ID
`Category`	`SoundCategory`	Sound category enum: `Music`, `Ambient`, `SFX`, `UI`

Creative Play Sound Set

{
  "SoundEvents": {
    "Error": "SFX_Creative_Play_Error",
    "Rotate_Yaw": "SFX_Rotate_Yaw_Default",
    "Rotate_Pitch": "SFX_Rotate_Pitch_Default",
    "Rotate_Roll": "SFX_Rotate_Roll_Default",
    "Eyedropper_Select": "SFX_Creative_Play_Eyedropper_Select",
    "Add_Mask": "SFX_Creative_Play_Add_Mask",
    "Set_Mask": "SFX_Creative_Play_Set_Mask",
    "Selection_Scale": "SFX_Creative_Play_Selection_Scale",
    "Selection_Drag": "SFX_Creative_Play_Selection_Drag",
    "Selection_Widget": "SFX_Creative_Play_Selection_Widget",
    "Selection_Place": "SFX_Creative_Play_Selection_Place",
    "Brush_Mode": "SFX_Creative_Play_Brush_Mode",
    "Brush_Erase": "SFX_Creative_Play_Brush_Erase",
    "Brush_Paint": "SFX_Creative_Play_Brush_Paint_Base",
    "Brush_Stamp": "SFX_Creative_Play_Brush_Stamp",
    "Brush_Paint_Idle_Layer": "SFX_Creative_Play_Brush_Paint_Idle_Layer",
    "Brush_Paint_Move_Layer": "SFX_Creative_Play_Brush_Paint_Move_Layer",
    "Brush_Shape": "SFX_Creative_Play_Brush_Shape",
    "Paste": "SFX_Creative_Play_Paste"
  },
  "Category": "UI"
}

Audio Categories

Audio categories define volume settings and hierarchy for groups of sounds.

Schema

{
  "Volume": <float>,
  "Parent": "<parent_category_id>"
}

Field	Type	Description
`Volume`	`float`	Volume adjustment in decibels (-100 to 10). Acts as an audio bus — combined with parent volumes up the hierarchy
`Parent`	`string`	Parent category for inheritance

Top-Level Categories

Category	Description
`AudioCat_Music`	Background music
`AudioCat_Weapons`	Weapon sounds
`AudioCat_Footsteps`	Movement sounds
`AudioCat_NPC`	NPC vocalizations
`AudioCat_Inventory`	Inventory interactions
`AudioCat_Discovery`	Discovery notifications

NPC Audio Categories

NPC-specific audio categories inherit from AudioCat_NPC:

{
  "Volume": 0,
  "Parent": "AudioCat_NPC"
}

Available NPC Categories:

Livestock: AudioCat_NPC_Cow, AudioCat_NPC_Sheep, AudioCat_NPC_Pig, AudioCat_NPC_Horse, AudioCat_NPC_Chicken
Predators: AudioCat_NPC_Wolf, AudioCat_NPC_Bear_Grizzly, AudioCat_NPC_Hyena, AudioCat_NPC_Fox
Creatures: AudioCat_NPC_Spider, AudioCat_NPC_Snake, AudioCat_NPC_Scorpion, AudioCat_NPC_Bat
Enemies: AudioCat_NPC_Zombie, AudioCat_NPC_Skeleton, AudioCat_NPC_Goblin, AudioCat_NPC_Trork
Mythical: AudioCat_NPC_Dragon, AudioCat_NPC_Yeti, AudioCat_NPC_Fen_Stalker
Birds: AudioCat_NPC_Crow, AudioCat_NPC_Owl, AudioCat_NPC_Sparrow, AudioCat_NPC_Raven

Weapon Audio Categories

Weapon-specific categories for combat sounds:

Category	Description
`AudioCat_Sword`	Sword combat sounds
`AudioCat_Battleaxe`	Axe combat sounds
`AudioCat_Mace`	Blunt weapon sounds
`AudioCat_Daggers`	Dagger combat sounds
`AudioCat_Shortbow`	Bow sounds
`AudioCat_Hand_Crossbow`	Crossbow sounds
`AudioCat_Magic_Staff`	Staff/magic sounds
`AudioCat_Shield`	Shield block sounds

Ambience Sound Sets

Ambience systems define environmental audio with conditions.

AmbienceFX Top-Level Properties

Each AmbienceFX asset can contain multiple audio components:

Field	Type	Description
`Conditions`	`object`	When this ambience activates
`Sounds`	`object[]`	Positional emitter sounds
`Music`	`object`	Music tracks to play
`AmbientBed`	`object`	Background ambient loop
`SoundEffect`	`object`	Reverb/EQ effects to apply
`Priority`	`int`	Priority for music and sound effect (higher = higher priority, min 0)
`BlockedAmbienceFxIds`	`string[]`	Other AmbienceFX IDs this one blocks
`AudioCategory`	`string`	Audio category for volume routing (affects ambient bed and music, not emitters)

Ambient Bed Schema

Background ambient loops:

{
  "Conditions": {
    "DayTime": {
      "Min": 5,
      "Max": 19
    },
    "SunLightLevel": {
      "Min": 10,
      "Max": 15
    },
    "EnvironmentTagPattern": {
      "Op": "And",
      "Patterns": [
        { "Op": "Equals", "Tag": "Zone1" },
        {
          "Op": "Or",
          "Patterns": [
            { "Op": "Equals", "Tag": "Plains" },
            { "Op": "Equals", "Tag": "Encounters" }
          ]
        }
      ]
    },
    "Walls": {
      "Min": 0,
      "Max": 3
    }
  },
  "AmbientBed": {
    "Track": "Sounds/Environments/Zone1/Environments/Plains/Day/Z1_Plains_Gen_Day_Stereo_LOOP.ogg",
    "Volume": 1.0,
    "TransitionSpeed": "Default"
  }
}

Ambient Bed Properties

Field	Type	Default	Description
`Track`	`string`		Path to stereo audio file
`Volume`	`float`	`0`	Volume in dB (-100 to 10)
`TransitionSpeed`	`string`	`"Default"`	Fade speed: `Default`, `Fast`, `Instant`

Emitter Schema

Positional ambient sounds:

{
  "Conditions": {
    "DayTime": {
      "Min": 5,
      "Max": 19
    },
    "SunLightLevel": {
      "Min": 10,
      "Max": 15
    },
    "EnvironmentTagPattern": {
      "Op": "And",
      "Patterns": [
        { "Op": "Equals", "Tag": "Zone1" },
        { "Op": "Or", "Patterns": [
          { "Op": "Equals", "Tag": "Plains" },
          { "Op": "Equals", "Tag": "Encounters" }
        ]}
      ]
    },
    "WeatherTagPattern": {
      "Op": "Not",
      "Pattern": { "Op": "Equals", "Tag": "Rain" }
    }
  },
  "Sounds": [
    {
      "SoundEventId": "SFX_Z1_Emit_Plains_Gen_Day_Birds",
      "Frequency": { "Min": 1, "Max": 3 },
      "Radius": { "Min": 1, "Max": 7 }
    },
    {
      "SoundEventId": "SFX_Z1_Emit_Plains_Gen_Day_Insects",
      "Radius": { "Min": 2, "Max": 8 },
      "Frequency": { "Min": 2, "Max": 4 }
    },
    {
      "SoundEventId": "SFX_Z1_Emit_Plains_Gen_Day_Wind",
      "Frequency": { "Min": 0, "Max": 2 },
      "Radius": { "Min": 2, "Max": 5 }
    }
  ]
}

Condition Properties

Field	Type	Default	Description
`Never`	`bool`	`false`	If true, never conditionally triggers (can still be set server-side)
`EnvironmentIds`	`string[]`		Specific environment IDs to match
`EnvironmentTagPattern`	`object`		Environment tag pattern matching
`WeatherIds`	`string[]`		Specific weather IDs to match
`WeatherTagPattern`	`object`		Weather tag pattern matching
`FluidFXIds`	`string[]`		Fluid effect IDs to match
`SurroundingBlockSoundSets`	`object[]`		Block sound sets surrounding the player
`Altitude`	`object`	`{ Min: 0, Max: 512 }`	Y-level range
`Walls`	`object`	`{ Min: 0, Max: 4 }`	Enclosure level
`Roof`	`bool`	`false`	Whether a roof is required
`RoofMaterialTagPattern`	`object`		Tag pattern to match roof material
`Floor`	`bool`	`false`	Whether a floor is required
`SunLightLevel`	`object`	`{ Min: 0, Max: 15 }`	Sun exposure level
`TorchLightLevel`	`object`	`{ Min: 0, Max: 15 }`	Torch light level
`GlobalLightLevel`	`object`	`{ Min: 0, Max: 15 }`	Combined light level
`DayTime`	`object`	`{ Min: 0, Max: 24 }`	Hour range

Tag Pattern Operators

Operator	Description
`Equals`	Tag matches exactly
`And`	All patterns must match
`Or`	Any pattern must match
`Not`	Pattern must not match

Emitter Sound Properties

Field	Type	Default	Description
`SoundEventId`	`string`		Sound event to play
`Play3D`	`string`	`"Random"`	3D positioning mode: `Random`, `LocationName`, `No`
`BlockSoundSetId`	`string`		Optional block sound set filter
`Altitude`	`string`	`"Normal"`	Altitude positioning: `Normal`, `Lowest`, `Highest`, `Random`
`Frequency`	`object`	`{ Min: 1, Max: 10 }`	Time between plays (seconds)
`Radius`	`object`	`{ Min: 0, Max: 24 }`	Distance range (blocks)

Music Schema

Conditional music tracks:

{
  "Conditions": { ... },
  "Music": {
    "Tracks": [
      "Music/Zone1/Plains/Z1_Plains_Day_01.ogg",
      "Music/Zone1/Plains/Z1_Plains_Day_02.ogg"
    ],
    "Volume": -3.0
  },
  "Priority": 5
}

Field	Type	Default	Description
`Tracks`	`string[]`		Array of music file paths (must be non-empty)
`Volume`	`float`	`0`	Volume in dB (-100 to 10)

Sound Effect Schema

Apply reverb and EQ based on conditions:

{
  "Conditions": { ... },
  "SoundEffect": {
    "ReverbEffectId": "Rev_Cave",
    "EqualizerEffectId": "EQ_Default",
    "IsInstant": false
  },
  "Priority": 10
}

Field	Type	Default	Description
`ReverbEffectId`	`string`		Reverb effect to apply
`EqualizerEffectId`	`string`		EQ effect to apply
`IsInstant`	`bool`	`false`	Whether to apply the effect instantly

Ambience Organization

DirectoryAssets/Server/Audio/AmbienceFX/
- DirectoryAmbience/
  - DirectoryZone1/
    DirectoryGlobal/
    DirectoryNight/
    …
    DirectoryWind/
    …
    DirectorySunrise/
    …
    DirectorySunset/
    …
    DirectoryEnvironments/
    DirectoryPlains/
    DirectoryDay/
    …
    DirectoryNight/
    …
    DirectoryForest/
    …
    DirectorySwamp/
    …
    DirectoryMountain/
    …
    DirectoryShore/
    …
    DirectoryDungeon/
    …
    DirectoryTrork/
    …
    DirectoryKweebec/
    …
  - DirectoryZone2/
    …
  - DirectoryZone3/
    …
  - DirectoryZone4/
    …
  - DirectoryGlobal/
    DirectoryCave/
    …
  - DirectoryUnique/
    DirectoryForgotten_Temple/
    …
    DirectoryDread_Wade/
    …
- DirectoryReverbZones/
  - DirectoryPlains/
    …
  - DirectoryForest/
    …
  - DirectoryMountain/
    …
  - DirectorySwamp/
    …
  - DirectoryUnderground/
    …
  - DirectoryPrefabs/
    …

Creating Custom Sound Sets

Item Sound Set

{
  "SoundEvents": {
    "Drop": "SFX_MyPlugin_Item_Drop",
    "Drag": "SFX_MyPlugin_Item_Drag"
  }
}

NPC Audio Category

{
  "Volume": 0,
  "Parent": "AudioCat_NPC"
}

Custom Ambience

{
  "Conditions": {
    "SunLightLevel": {
      "Min": 0,
      "Max": 4
    },
    "EnvironmentTagPattern": {
      "Op": "Equals",
      "Tag": "Cave"
    }
  },
  "AmbientBed": {
    "Track": "Sounds/MyPlugin/Cave_Ambient_LOOP.ogg",
    "Volume": -5.0
  }
}

Best Practices

Use appropriate categories - Match item type to sound set
Inherit from parents - Use Parent for NPC categories
Set conditions carefully - Ensure ambience doesn’t overlap incorrectly
Use tag patterns - Combine environment and weather tags
Test volume levels - Ensure sounds aren’t too loud/quiet
Follow naming conventions - Use ISS_, AudioCat_, AmbFX_ prefixes

Audio Overview - Audio system overview
Sound Events - Sound event definitions
Audio Effects - Reverb and EQ effects
Weather Systems - Weather that affects ambience
Environments - Environment tags

Sound Sets

Asset Locations

Item Sound Sets (ISS)

Schema

Categories

Weapons

Armor

Items

Blocks

Examples

Usage in Items

Block Sound Sets

Schema

Block Sound Events

Usage in Blocks

UI Sound Sets

Schema

Creative Play Sound Set

Audio Categories

Schema

Top-Level Categories

NPC Audio Categories

Weapon Audio Categories

Ambience Sound Sets

AmbienceFX Top-Level Properties

Ambient Bed Schema

Ambient Bed Properties

Emitter Schema

Condition Properties

Tag Pattern Operators

Emitter Sound Properties

Music Schema

Sound Effect Schema

Ambience Organization

Creating Custom Sound Sets

Item Sound Set

NPC Audio Category

Custom Ambience

Best Practices

Related