---

📋 What is SnakeRoyale?

SnakeRoyale is a competitive survival minigame where movement is your greatest weapon and your deadliest mistake. Every step you take leaves a trail of colorful concrete. If a player touches any trail—including their own—they are instantly eliminated. With shrinking borders and a programmatically generated world, it's a fast-paced battle for survival.

Why SnakeRoyale?

• ⚡ Ultra-Lightweight – Optimized for high-performance gameplay on PaperMC servers.
• ⚔️ Multi-Arena Support – Host up to 5 concurrent matches (configurable) in independent, programmatically generated worlds.
• 📊 Persistent Statistics – Track wins, games played, losses, and kills for every player on your server.
• 🛡️ WorldGuard Integration – Respects build permissions, ensuring trails only spawn where they are allowed.
• 🌍 Custom Seeds – Dynamic world generation with support for predefined seeds to ensure interesting terrain every game.
• 🎨 Modern Aesthetics – Fully customizable messages and sound effects with support for modern text formatting.
• 📂 Safe Spawn Logic – Built-in protection to ensure players never spawn in water or hazards.
• 👩‍🔧 Auto-Migration – Seamlessly updates your config.yml with new options whenever the plugin is updated.
• 🚫 Block Blacklist – Prevents trails from spawning on forbidden surfaces (Air, Water, Lava, etc.).
• ⏳ Trail Decay – Customizable timer for trails to revert back to their original block state.

---

Soft-Dependencies: WorldGuard

---

✨ Features

Gameplay Mechanics

• Dynamic Player Trails: Every step leaves a permanent trail. Crossing a trail results in instant elimination.
• Shrinking World Border: Matches start with a large arena that shrinks dynamically to a final showdown size, forcing player encounters.
• Border Grace Period: Integrated BossBar system warns players when they are outside the border, with a configurable countdown.
• Live Spectator Mode: Eliminated players gracefully transition into spectators to watch the rest of the chaos unfold.
• Programmatic Worlds: Arenas are created on-demand and deleted automatically after the match ends to keep your server clean.

Customization

• Sound Effects: Toggleable sounds for join, countdown, elimination, and victory.
• Rich Messaging: Every message sent to the player is configurable in config.yml.
• Seed Support: List an array of seeds in the config to randomize or specify the terrain of your battlefields.

---

📦 How to Install

Requirements

• Paper (Minecraft 1.21.x)
• Java 21 or newer

Quick Start Guide

1. Download:
   • Get the latest snakeroyale-1.0.0.jar from your build directory or project page.
2. Install:
   • Place the .jar file into your server’s plugins/ directory.
3. Start Your Server:
   • Start your server to generate the default configuration files.
4. Configure:
   • Edit plugins/SnakeRoyale/config.yml to set seeds, max players, and match settings.
5. Reload & Play:
   • Use /snake reload to apply changes and /snake join to enter the battle!

---

🎮 Commands

Base command: /snakeroyale (or /snake)

Command	What it does	Who can do it
/snake join	Join an available lobby	snakeroyale.play
/snake leave	Leave current match	snakeroyale.play
/snake spectate <id>	Spectate a specific match	snakeroyale.spectate
/snake status	Show arena status	snakeroyale.play
/snake forcestart	Force-start your lobby	snakeroyale.admin
/snake stop <id>	Force-stop a specific match	snakeroyale.admin
/snake reload	Reload configuration	snakeroyale.admin

Permissions

Permission	Description	Default
snakeroyale.admin	Access to admin commands	OP
snakeroyale.play	Join and leave matches	true
snakeroyale.spectate	Spectate matches	true

---

👨‍💻 Developers

Building from Source

git clone https://github.com/itzzjustmateo/SnakeRoyale.git
cd SnakeRoyale
mvn clean package

---

📝 License

Apache License 2.0 — see LICENSE.

---

🤝 Support

• Issues? GitHub Issues
• Discord: Join our Discord