---

Overview

SnakeRoyale is a competitive survival minigame built around a simple rule: never touch a trail.

Every step leaves a trail of colored concrete behind the player. Touching any trail, including your own, results in instant elimination. As the world border gradually shrinks, the available space disappears, forcing players into increasingly intense encounters until only one survivor remains.

Each match takes place in a dynamically generated arena, keeping games isolated and reducing unnecessary world clutter after a match ends.

Why SnakeRoyale?

• Fast-Paced Survival — Every movement becomes a tactical decision, rewarding awareness, positioning, and precision.
• Concurrent Arenas — Host multiple independent matches simultaneously, with a configurable limit of up to five arenas.
• Dynamic World Borders — Progressively shrink the playable area to maintain pressure and deliver decisive endgames.
• Persistent Statistics — Track wins, losses, games played, and kills across player sessions.
• Custom World Generation — Use configurable seeds to shape the terrain of your arenas.
• WorldGuard Integration — Respect protected-region build permissions when placing trails.
• Customizable Gameplay — Configure messages, sounds, trail behavior, and match settings.
• Automated Arena Lifecycle — Generate arenas when needed and clean them up after matches finish.

---

Features

Trail-Based Combat

Every step leaves a trail of colored concrete, turning the arena into a constantly evolving obstacle course. Players must anticipate their opponents, manage their movement, and avoid trapping themselves.

• Instant elimination upon touching a trail.
• Configurable trail behavior and decay.
• Block blacklisting to prevent trails from appearing on unsuitable surfaces.
• Support for restoring original block states when trails expire.

Dynamic Arena & Border System

Keep matches engaging with arenas that evolve throughout the game.

• Dynamically generated worlds for individual matches.
• Configurable world seeds for varied terrain.
• A shrinking world border that drives players toward the final showdown.
• BossBar warnings and a configurable grace period for players outside the border.
• Safe spawn selection to avoid water and hazardous locations.

Multi-Arena Management

Run multiple matches without forcing every player into the same game.

• Independent arenas and match states.
• Configurable concurrent arena limits, up to five by default or as configured.
• Live spectator mode for eliminated players.
• Automatic arena cleanup after a match ends.
• Administrative controls for starting and stopping matches.

Customization & Integration

Adapt SnakeRoyale to your server's gameplay style and existing infrastructure.

• Fully configurable player messages through config.yml.
• Toggleable sounds for joining, countdowns, eliminations, and victories.
• Configurable world seeds and match settings.
• WorldGuard compatibility for protected regions.
• Automatic configuration migration when new options are introduced.
• A configurable block blacklist for restricting trail placement.

---

Installation

Requirements

• Minecraft: 1.21.x
• Server Software: Paper or compatible Purpur
• Java: 21 or newer
• Optional Dependency: WorldGuard

Setup

1. Download the latest SnakeRoyale release or obtain the built JAR from your project build.
2. Install snakeroyale-1.0.0.jar in your server's plugins/ directory.
3. Start your server to allow SnakeRoyale to generate its default configuration.
4. Configure your settings in plugins/SnakeRoyale/config.yml.
5. Join the action using /snake join.

To apply configuration changes, use /snake reload.

Note: The filename above corresponds to version 1.0.0. Use the actual JAR filename if you install a different release.

---

Commands

Base command: /snakeroyale
Alias: /snake

Command	Description	Permission
/snake join	Join an available match	snakeroyale.play
/snake leave	Leave your current match	snakeroyale.play
/snake spectate <id>	Spectate a specific match	snakeroyale.spectate
/snake status	Display 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 the plugin configuration	snakeroyale.admin

Permissions

Permission	Description	Default
snakeroyale.admin	Access administrative commands	OP
snakeroyale.play	Join and leave matches; view status	true
snakeroyale.spectate	Spectate matches	true

---

Configuration

SnakeRoyale uses plugins/SnakeRoyale/config.yml to control its gameplay and presentation.

The configuration supports customization of:

Setting	Purpose
World Seeds	Specify or randomize arena terrain
Arena Limits	Control the maximum number of concurrent matches
Match Settings	Adjust supported gameplay parameters
Messages	Customize player-facing text
Sounds	Toggle supported gameplay sound effects
Trail Decay	Control how long trails remain before restoration
Block Blacklist	Restrict surfaces where trails can be placed
Border Behavior	Configure supported shrinking-border settings
Spawn Safety	Configure supported safe-spawn behavior

Configuration options may vary by release. Refer to the generated config.yml for the settings available in your installed version.

---

Developers

Build from Source

Build SnakeRoyale locally using Git, Java 21+, and Maven.

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