Spleef_reloaded | Spleef for 1.20 - 1.21.11 |

Minimum Java Version: ________Java 21

Spleef_reloaded
Run, run, run....

This latest version of this plugin Minecraft/Spigot 1.21.3 - 1.21.10.
Check the Legacy Support section for other versions.

Description
Spleef is the iconic Minecraft mini game where players join an arena and try to break the blocks that other players are standing on causing them to fall and lose the game. The last player standing wins.

Spleef_reloaded is a highly configurable, fully automated minigame. It has been created using the TNTRun_reloaded code base so many of the commands and features are identical between the two plugins.

Players are given a tool (default DIAMOND_SHOVEL) to break blocks and optionally SNOWBALLs with knockback which can be configured to also break blocks if required.

The plugin features a customisable shop where players can buy items such as weapons, armour, double-jumps, splash potion, and commands which run when the game starts. There is an option to enable PVP in arenas, assign kits, and the plugin also interfaces with HeadsPlus (by ThatsMusic99) allowing players to buy/wear custom heads during the game.

Optionally, a fee can be set to join each arena, which can be monetary or any minecraft item such gold_nuggets. Rewards for winning the game can be set to any combination of coins, materials, XP or a command based reward. Scoreboards, leaderboards, placeholders and holograms are fully supported (see the Dependencies section below).

Features
The following list of features applies to the latest release and so not all features will be present in older versions of the plugin.

Legacy Support
If your server is running Minecraft 1.20.6 - 1.21.2, then download version 1.0.

If your server is running a minimum of Java 17 with Minecraft 1.20.x, then download version 0.83 from GitHub here.

Dependencies

Commands
The commands required to create a standard arena are shown below.

Player Commands

/sleef list - list the Spleef arenas
/spleef list {arena} - list the arena configuration
/spleef join {arena} - join arena, needs spleef.join permission (default)
/spleef join - open arena join menu, needs spleef.joinmenu permission (default)
/spleef autojoin {pvp|nopvp} - join arena with most waiting players
/spleef party {option} - Spleef party commands
/spleef leave - leave the current Spleef arena
/spleef vote - vote for the Spleef arena start
/spleef lobby - teleport to the Spleef lobby
/spleef stats - displays your Spleef record
/spleef leaderboard {size} - displays the Spleef leaderboard
/spleef listkit - list the Spleef kits
/spleef listkit {kit} - list the kit configuration
/spleef start {arena} - force-start arena, needs spleef.start permission
/spleef spectate {arena} - join as spectator, needs spleef.spectate
/spleef listrewards {arena} - list arena rewards, needs spleef.listrewards
/spleef info - information about this plugin
/spleef help - lists all the /spleef commands
/spleef cmds - lists all the /spsetup commands

The following admin commands require the spleef.setup permission.

Arena Configuration Commands

/spsetup configure {arena} - open menu to run configuration commands
/spsetup setmaxplayers {arena} {number} - set max players for this arena (default: 15)
/spsetup setminplayers {arena} {number} - set min players for this arena (default: 2)
/spsetup settimelimit {arena} {seconds} - set the arena time limit in seconds (default: 300, no_time_limit: 0)
/spsetup setcountdown {arena} {seconds} - set countdown time for arena (default: 10)
/spsetup setmoneyreward {arena} {amount} - sets a money reward (Vault and economy plugins required for this)
/spsetup setteleport {arena} {previous/lobby} - teleports the player to pre-join location or to lobby when game ends
/spsetup setdamage {arena} {yes/no/zero} - sets pvp state in the arena (yes - full damage, zero - zero damage, no - no attack at all)
/spsetup deletespectate {arena} - deletes spectator spawnpoint
/spsetup setgameleveldestroydelay {arena} {ticks} - add a delay before a block is destroyed after a player steps on it (default: 8)
/spsetup setregenerationdelay {arena} {ticks} - set the time allowed for arena regeneration before players can rejoin (default: 60)
/spsetup setvotepercent {arena} {0<votepercent<1} - set the percentage of votes required to start the game for this arena (default: 0.75)
/spsetup givedoublejumps {player} {amount} - give doublejumps to a player
/spsetup setfee {arena} {amount} - set a fee to join the arena
/spsetup setcurrency {arena} {currency_item} - set the currency item
/spsetup setreward {arena} - start conversation to set Money, Material, XP and Command rewards for arena
/spsetup addtowhitelist {command} - whitelist a command for use in-game
/spsetup linkkit {arena} {kit} - links the named kit to an arena
/spsetup unlinkkit {arena} - removes a linked kit from an arena
/spsetup setP1 - set targetted block as first selection point
/spsetup setP2 - set targetted block as second selection point
/spsetup clear - clear selection points

Console Commands

Additional Commands

/spsetup setlobby - set the Spleef lobby at your current position
/spsetup deletelobby - delete the Spleef lobby
/spsetup setbarcolor {color} - set bar color. Default is RANDOM
/spsetup resetstats {player} - delete a player's Spleef_reloaded stats
/spsetup resetcachedrank {player} - delete a player's rank from cache to force update
/spsetup addkit {kit} - create a kit
/spsetup deletekit {kit} - delete a kit
/spsetup reloadbars - reload configbars.yml
/spsetup reloadmsg - reload messages.yml
/spsetup reloadtitles - reload titles.yml
/spsetup reloadconfig - reload config.yml
/spsetup addspawn {arena} - creates additional arena spawn points
/spsetup deletespawnpoints {arena} - removes all additional points created with addspawn
/spsetup setwaitingspawn {arena} - creates a waiting spawn location from where players will auto-join the arena
/spsetup deletewaitingspawn {arena} - removes the waiting spawn location
/spsetup setlanguage {language-code} - switches messages.yml to one of the supported language options
/spsetup enable {arena} - enable the arena
/spsetup disable {arena} - disable the arena
/spsetup delete {arena} - delete the arena

Arena Setup Example

Permissions

spleef.join:
    description: used to control who can join spleef and from where.
    default: true
spleef.setup:
    description: required to run "/spsetup" commands
    default: op
spleef.version.check:
    description: display new version message on player join
    default: op
spleef.heads:
    description: allow players to use HeadsPlus in game
    default: true
spleef.shop:
    description: allow players to buy any shop item (if they have money)
    default: true
spleef.joinmenu:
    description: allow players to use the join menu
    default: true
spleef.start:
    description: allow players to start an arena before the minimum players is reached
    default: op
spleef.spectate:
    description: allow players to join an arena as a spectator
    default: op
spleef.party:
    description: allow players to use the native party commands
    default: true
spleef.autojoin:
    description: used to control who can use the autojoin command
    default: true
spleef.listrewards:
    description: allow players to list the arena rewards
    default: true
spleef.doublejumps.n:
    description: limit allowed doublejumps using permissions, where n is a positive integer (>= 1)
    default: false

Installation
For upgrading, check the release notes for each release.

1. Download Spleef_reloaded.jar
2. Copy to your 'plugins' folder
3. Restart your server - this will create the default config.yml and other configuration files.

Configuration