RegionMusic

Every region tells a story with music

Automatically play music when players enter WorldGuard regions!

RegionMusic is a lightweight Minecraft plugin that automatically plays music/sounds when players enter or leave WorldGuard regions. Perfect for creating immersive experiences with region-specific soundtracks!

Love this plugin? Consider supporting the development: Donate via PayPal

✨ Features

• Automatic Music Playback - Plays music/sounds when players enter or leave WorldGuard regions
• Multiple Songs Support - Configure multiple songs per region that play sequentially or randomly
• Auto Loop - Automatically loops back to the first song after the playlist ends
• Play Mode - Choose playback mode: sequential (in order) or random (shuffle)
• Toggle System - Players can toggle music on/off with /togglemusic (default: ON)
• Custom Sounds - Supports both vanilla Minecraft sounds and custom sounds (ItemsAdder, etc.)
• Custom Song Names - Customize display names for songs in musics.yml
• Now Playing Notifications - Shows "Now playing: [song name]" when a song starts
• Volume & Pitch Control - Adjust volume and pitch for each song individually
• ⚡ Performance Optimized - Lightweight and optimized for performance
• No Overlap - Prevents music overlap from different regions
• Customizable Messages - All messages can be customized via language files in lang/ folder
• Multi-Language Support - Supports Vietnamese (vi), English (en), and Chinese (zh) with configurable language selection
• WorldGuard Integration - Works with all WorldGuard regions
• Granular Permissions - Separate permissions for each command
• Persistent Toggle State - Toggle music preference is saved and persists across server restarts
• ️ GUI Interface - Visual interface to view region and song information (/regionmusic gui)
• Add Music via Chat - Add new songs to musics.yml through chat interface (/regionmusic addmusic)
• ⚙️ Config Version & Debug - Version management and debug mode in config.yml
• Custom Logger - Beautiful logger with RYNX prefix for better console visibility

Requirements

• Minecraft Server: Paper/Spigot 1.21.5 or higher
• Java: Java 21 or higher
• WorldGuard: Version 7.1.0 or higher
• WorldEdit: Required by WorldGuard

Installation

1. Download RegionMusic.jar from this page
2. Place the file in your server's plugins folder
3. Restart your server
4. Configure regions.yml and musics.yml in plugins/RegionMusic/
5. Use /regionmusic reload to load the configuration

⚙️ Configuration

regions.yml
Configure which regions play which music:

musics.yml
Define music properties:

Sound Format:
- Vanilla: MUSIC_DISC_CAT, minecraft:music_disc.cat
- Custom: records.cat, itemsadder:records.cat, namespace:sound_name

config.yml
Configure plugin settings:

Config Options:
- version: Automatically updated with plugin version (do not edit manually)
- debug: Enable/disable debug mode for detailed console logging (default: false)
- language: Select plugin language - vi (Vietnamese), en (English), or zh (Chinese)

Language Files:
- lang/vi.yml - Tiếng Việt (Vietnamese) - Default
- lang/en.yml - English
- lang/zh.yml - 中文 (Chinese)

All messages can be customized by editing language files in lang/ folder.

Commands

Command	Description	Permission
/regionmusic reload	Reload configuration files	regionmusic.reload
/regionmusic playmusic	Manually play music for current region	regionmusic.playmusic
/regionmusic stopmusic	Stop currently playing music	regionmusic.stopmusic
/regionmusic togglemusic	Toggle music on/off	regionmusic.togglemusic
/regionmusic nextsong	Skip to next song in playlist	regionmusic.nextsong
/regionmusic about	Show plugin information	regionmusic.about
/regionmusic gui	Open GUI to view regions and songs	regionmusic.admin
/regionmusic addmusic <name>	Add new song via chat interface	regionmusic.admin
/rm	Alias for /regionmusic	Same as /regionmusic
/togglemusic	Toggle music on/off (for all players)	None
/cancel	Cancel adding music process	None

Permissions

Permission	Description	Default
regionmusic.admin	Access to all /regionmusic commands (parent permission)	OP
regionmusic.reload	Access to /regionmusic reload command	OP
regionmusic.playmusic	Access to /regionmusic playmusic command	OP
regionmusic.stopmusic	Access to /regionmusic stopmusic command	OP
regionmusic.togglemusic	Access to /regionmusic togglemusic command	OP
regionmusic.nextsong	Access to /regionmusic nextsong command	OP
regionmusic.about	Access to /regionmusic about command	OP

Note: /togglemusic command is available to all players without permission.

Usage Examples

Example 1: Single Song per Region

Example 2: Multiple Songs (Playlist)

Example 3: Custom Sounds (ItemsAdder)

Notes

• Music is enabled by default for all players
• Players can toggle music on/off with /togglemusic - toggle state is saved and persists across server restarts
• Music automatically stops when players leave the region
• Multiple songs can play sequentially (default) or randomly based on playmode setting
• Use /regionmusic reload after editing config files
• "Now playing" notifications are shown when a song starts or when skipping
• Custom song names can be set in musics.yml with the name field
• Volume and pitch can be adjusted per song for fine-tuned audio experience
• Play mode (sequential or random) can be configured per region in regions.yml
• Language can be changed in config.yml - supports Vietnamese (vi), English (en), and Chinese (zh)
• All messages can be customized by editing language files in lang/ folder
• Use /regionmusic gui to view all regions and songs visually
• Add new songs via /regionmusic addmusic <name> and chat interface
• Debug mode can be enabled in config.yml for detailed console logging
• Logger displays with beautiful RYNX prefix for better visibility

Support

If you encounter any issues or have questions, please:

• Check the GitHub Issues page
• Make sure you're using the latest version
• Check that WorldGuard is properly installed and configured

License

This project is licensed under the MIT License.

Author

rynx
- GitHub: @rynx
- Discord: q.bao1702
---