• ✓ Define regions within the game world.
• ✓ Associate sounds with specific regions.
• ✓ Adjust source, volume, pitch and loop of sounds per region.
• ✓ Sounds/Music can be played from default minecraft sounds or customized from resource packs.

1. Spigot/Bukkit | Paper | Mohist | Arclight from 1.17.1
2. Worldedit plugin [1.17 - 1.20]
3. WorldGuard plugin [1.17 - 1.20]

1. Download the latest version of the AreaSoundEvents plugin JAR file from SpigotMC.
2. Place the downloaded JAR file in the plugins folder of your Bukkit/Spigot server.
3. Restart or reload server to enable the plugin.

★ TIPS: You can create your own resource pack with .ogg sounds/music for client side and overwriting the sounds.json. Datapack could force the mandatory installation in the client... Once client side has the resource pack, AreaSoundEvents is able to handle playing the customized sound/music. Guide to Adding Custom Music to the Plugin




AreaSoundEvents provides a configuration file (config.yml) where you can customize various settings for the plugin:

• Default Sound Settings: Configure default sound settings such as volume, pitch, loop...
• Default Region Sound Events: Define sound events for specific regions, including the sound to be played, its volume, and pitch.
• Other Settings: Configure default settings as silent mode, debug mode or language translation.
• Permissions settings: Customize permissions for plugin use.
• Localization: You can add your language file in AreaSoundEvents/loc.

AreaSoundEvents also allows you to modify and add regions from the file (regions.yml), you will be able to reload the settings in the game without needing to restart the server:

YAML Regions Example

Code (Text):

regions: # Don't touch! is for plugin proposals
       areasoundevents: # The region's id
           name: areasoundevents # Region's name (has to be associate with the id)
           sound: minecraft:music.end # The sound which will be reproduced
           source: MUSIC # The source that sound plays (master, music, records...)
           volume: 0.5 # The volume of the sound (0~1)
           pitch: 1 # The pitch of the sound (0~1)
           loop: false # Allow the loop for the sound (true/false)
           loop-time: 60 # The time that sound replays (seconds)
 

This region is defined to play the sound minecraft:music.end with a volume of 0.5 and a pitch of 1 from the source MUSIC.




AreaSoundEvents plugin provides the following commands:

Main Commands

• /areasoundevents: Main command for the plugin.

Sub Commands

• /areasoundevents help: Display the available commands with descriptions and syntax.
• /areasoundevents reload: Reloads the plugin configuration.
• /areasoundevents list: Lists all defined regions and their associated sound events.
• /areasoundevents save: Save the current created configuration in 'regions.yml' file.
• /areasoundevents create <regionName> <soundName> <source> <volume> <pitch>: Create a new region with the specified sound event.
• /areasoundevents remove <regionName>: Deletes the specified region and its associated sound event.
• /areasoundevents modify {region-name} name=<regionName> sound=<soundName> source=<source> volume=<volume> pitch=<pitch> loop=<loop> loopTime=<loop-time>: Modify one or more properties of the region.

Aliases

• /ase
• /asound
• /areasoundevent

★ TIPS: When you make a modification to the regions.yml file and do not want to restart the server, remember to use the /areasoundevents reload command.

★ TIPS: When you create or modify a region, don't forget to use /areasoundevents save to store it in the regions.yml file. However, every time the server is turned off or restarted, the modifications through the create or modify commands will be saved automatically.

• areasoundevents.admin: Allows access to all plugin commands and features.
• areasoundevents.create: Permission to create new region sound events.
• areasoundevents.delete: Permission to delete existing region sound events.
• areasoundevents.help: Permission to display all commands descriptions and syntax.
• areasoundevents.modify: Permission to modify the region parameters.
• areasoundevents.remove: Permission to remove a region.
• areasoundevents.reload: Permission to reload the plugin configuration.
• areasoundevents.list: Permission to list defined regions and their associated sound events.

Creating Region Sound Events

To create a new region sound event, use the following commands:

1. Use the WorldEdit //wand command to use the coordinates selection tool.
2. Select an area with the tool.
3. Use WorldGuard /region define {region}
4. /rg flags {region}
5. Navigate to the last page (Custom flags) and ALLOW area-sound-events flag.

Then you can use AreaSoundEvents plugin here:

/areasoundevents create {region} {sound} [source] [volume] [pitch] [loop] [loop-time]

• {region}: Name of the region where the sound event will be triggered.
• {sound}: ID of the Minecraft/resourcepack sound to be played.
• [source]: Optional. Sound source category (e.g., MASTER, MUSIC, AMBIENT). Default: MUSIC
• [volume]: Optional. Volume level of the sound (0.0 to 1.0). Default: 1.0
• [pitch]: Optional. Pitch of the sound (0.0 to 1.0). Default: 1.0
• [loop]: Optional. Make your sound on loop (true/false). Default: false
• [loop-time]: Optional. The time in seconds that your sound will replay again. Default: 60

Example: /areasoundevents create bosszone1 minecraft:music.end players 1 1

★ TIPS: I highly recommend to set the source to PLAYERS. Players often set off the music source and on the other hand, I can't find a way to prevent Minecraft music from playing randomly. In the latter case, if you play with the MUSIC source, Minecraft will overlay yours. (I'm researching about gamerules).

Viewing Region Sound Events

To view existing region sound events, use the following command:

/areasoundevents list
This command will display a list of all defined region sound events.

Deleting Region Sound Events

To delete a region sound event, use the following command:

/areasoundevents remove {region}

• {region}: Name of the region sound event to delete.

• ✓ Remove WorldGuard/WorldEdit dependencies and develop own creating region/area, events and flags.
• ✓ Documentation updates.
• ✓ Vídeotutorial.
• ✓ Fix possible issues and give support.
• ✓ Fade in/out effect integration.
• ✓ Integration of a playlist per region.
• ✓ Plugin improvements and develop new and useful ideas.

Credits
AreaSoundEvents Plugin was developed by @LavinyTuttini.