Kingdom of Symet – Region Music

# Symet Music

**Bring your server’s regions to life with their own music and names.**

Symet Music is a **client-side** NeoForge mod that plays custom music in WorldGuard regions and
shows the player where they are. It’s controlled entirely by the server through the companion
**SymetMusic Paper plugin**, so server admins decide what plays where without shipping new mod
versions.

> ⚠️ This mod does nothing on its own. It needs a server running **Paper + WorldGuard + the
> SymetMusic plugin**. On other servers and in singleplayer the game behaves as usual.

## Features

### 🎵 Region music
– Every region can have its own **playlist**, set with a simple WorldGuard flag:
  `/rg flag market symet-music town`
– Playlists can use **vanilla music** (e.g. `minecraft:music.overworld.forest`, music discs),
  **sounds from the server resource pack**.
– Smooth **fade-in / fade-out** and **crossfades** between regions
– Configurable **pauses between tracks**, **shuffle** (no track repeats twice in a row) and volume
– **Vanilla background music is muted** inside music regions and comes back when you leave
– Respects the in-game **Music** volume slider
– Short delay before switching, so walking along a region border won’t flicker the music
– When you come back to a region, its playlist continues with the next track

### 🔔 “Now playing” notification
– A small toast styled like the vanilla one shows **Artist – Title** whenever a new track starts
– Titles come from the server config. Vanilla tracks show their in-game names, e.g. “C418 – Sweden”

### 🏰 Region titles
– Set a display name with `/rg flag market symet-title Old Market`
– **First visit:** a pixel-art medieval **ribbon banner** with the region name appears at the top of the screen
– **Later visits:** a small, unobtrusive label in the top-left corner
– Rename a region and every player sees the banner again, as if it were a new place
– Visited regions are remembered **per server** on the client

## For server admins
– Playlists are defined in `plugins/SymetMusic/config.yml` and sent to players automatically
– Uses standard WorldGuard flags, so **priorities, parent regions and `__global__`** all work
– `/sma reload` applies playlist changes to all online players instantly
– Players **without the mod** can still join and play normally. They just don’t get the music and titles

## Requirements
– **Client:** Minecraft 1.21.11, NeoForge 21.11.42+
– **Server:** Paper 1.21.11, WorldGuard 7.x, SymetMusic plugin