Getting Started

Welcome to The Snake. This guide covers the server requirements, installation flow, generated files, permissions, and the shortest path to a playable arena.

---

Prerequisites

Before installing the plugin, make sure the server meets these requirements:

• Java Version: Java 21 or newer.
• Server Software: Paper or a compatible Paper fork.
• PlaceholderAPI Optional : Required for %snake_...% placeholders and the internal leaderboard cache.
• Permissions Plugin Optional : A plugin such as LuckPerms is recommended for arena administration.

Note

The current build uses Paper’s player input event for WASD controls. Use Paper or a compatible fork instead of relying on plain Spigot behavior.

---

Installation

1. Download the latest The Snake build from SpigotMC.
2. Stop the server and place the-snake-x.x.x.jar in the plugins/ directory.
3. Install PlaceholderAPI if the server will use Snake placeholders in scoreboards, holograms, menus, or chat.
4. Start the server and wait for the plugin to finish initialization.
5. Join the server and run /snake to verify that the root command is registered.

---

Generated Files

The first startup creates /plugins/Snake/ with these main files:

File	Purpose
config.yml	Messages, sounds, placeholder fallbacks, storage selection, saving, and update checks.
arena.yml	Arena locations and per-arena game options.
mysql.yml	JDBC connection and statistics table settings.
stats.yml	Flat-file player statistics when MySQL is not selected.

The plugin can also create temporary inventory backup data while a player is playing or editing an arena. Do not delete those backups while players are active.

---

Essential Permissions

Permission	Purpose	Default
snake.*	Grants all declared Snake administration permissions.	Operators
snake.arena.create	Allows /snake create <arena id>.	Through snake.*
snake.arena.delete	Allows /snake delete <arena id>.	Through snake.*
snake.arena.edit	Allows /snake edit <arena id>.	Through snake.*
snake.tabcompleter	Shows Snake subcommands and arena IDs in tab completion.	Through snake.*

The player commands /snake join and /snake leave do not declare separate permission requirements.

---

Recommended First Setup

1. Build a flat vertical or horizontal two-dimensional board.
2. Run /snake create <arena id> to enter the editor.
3. Set the start location and end location.
4. Use the board setter to select two opposite corners on the same 2D plane.
5. Open Options and configure movement, win conditions, and board blocks.
6. Use Save, then Stop Editing.
7. Test the arena with /snake join <arena id>.

Caution

An arena becomes ready only after all four locations are saved: start, end, first board corner, and second board corner.