# WorldCompass - Documentation

## Installation
1. Download the latest `WorldCompass.jar`
2. Drop it into your `/plugins` folder
3. Restart or reload your server
4. Edit `/plugins/WorldCompass/config.yml` to match your worlds and menu layout
5. Restart or `/reload` again to apply changes

---

## Commands & Permissions
| Command | Permission | Default | Description |
|-----------------|----------------------|---------|--------------------------------------------------|
| /givecompass | worldcompass.give | OP | Gives the World Compass to the player |

---

## ⚙️ Configuration
- **spawn-on-join** *(true/false)* — Teleport players to `spawn-world` when they join
- **spawn-world** *(string)* — The world name to teleport to if `spawn-on-join` is enabled
- **give-compass-on-join** *(true/false)* — Automatically give the compass to players when they join
- **menu-title** *(string)* — Title shown at the top of the compass GUI
- **worlds** — List of teleport options in the GUI

Each entry in `worlds` contains:
- **name** — Item display name in GUI (supports color codes with `§` or `&`)
- **lore** — List of text lines under the item
- **material** — The Minecraft Material for the icon
- **target-world** — Bukkit world name to teleport to

---

## Example Config
```yaml
spawn-on-join: true
spawn-world: "lava-spawn"
give-compass-on-join: true

menu-title: "§8§l➤ Choose Your World"

worlds:
lobby:
name: "§6§lLobby"
lore:
- "§7Return to the central hub,"
- "§7where all journeys begin."
- ""
- "§eClick to teleport."
material: MAGMA_BLOCK
target-world: "lava-spawn"

prison:
name: "§c§lPrison"
lore:
- "§7Enter the prison dimension,"
- "§7where survival is earned."
- ""
- "§eClick to teleport."
material: IRON_BARS
target-world: "world"