Minimum Java Version: ________Java 21



Description
Spleef is the iconic Minecraft mini game where players join and 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


The following admin commands require the spleef.setup permission.

Arena Configuration Commands


Console Commands

Additional Commands



Arena Setup Example


Permissions

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

Scoreboard Configuration


Kits
A kit is a set of items, weapons, food and potions that can be allocated to players at the start of a game.
A kit is created with command /spsetup addkit [kitname]

The addkit command adds all the items in your inventory including armour and active potion effects to the kit.
Kits are enabled on a per arena basis using command /spsetup enablekits [arena]
Players joining an arena (with kits enabled) will be allocated a random kit from those that have been created. If there is only one kit, everyone will receive the same kit.

A kit can also be linked to an arena using command /spsetup linkkit {arena} {kit}. Every player joining the arena will then receive the same kit.

If more than one kit is linked to an arena, by default players will receive a random kit from this list. To force all players to receive the same linked kit, set the following in the {arena}.yml file.
The list of available kits can be displayed with command /spleef listkits
The contents of a kit can be displayed with command /spleef listkit [kitname]
A kit can be deleted with command /spsetup deletekit [kitname]

Item slot 9 in the hotbar will always be the configured 'leave' item for the arena unless removed in the config.


Parties
Players are able to create and join parties so that when the party leader joins an arena, the party members will automatically join the same arena at the same time.

Information on creating and using Spleef_reloaded parties can be found in the wiki .

Alternatively, parties created using the AlessioDP Parties plugin are also supported.


Heads
An optional feature is to allow players to purchase different heads to wear during the game. To enable this feature you will need to have the plugin HeadsPlus by Thatsmusic99 installed on your server.

During the arena countdown, players can use a hotbar item to open the HeadsPlus interface and purchase a head to wear during the game. The head is automatically equipped on the player's head when purchased, and removed at the end of the game.

Players will need permission node spleef.heads: true to be able to use this feature.

The price for each head is set in plugins\HeadsPlus\customheads.yml. The default price is 10.0 and is set in the same file, so if you want all heads to be free just change the default price to 0.0.

You may need to explicitly set permission headsplus.bypass.cost: false if players can buy heads at 0 cost even with a price set.



Arena Join Menu
The arena join menu allows Spleef_reloaded arenas to be selected from an inventory menu. This can be disabled by disallowing permission spleef.joinmenu.

The list of arenas can be limited to only show enabled arenas in the config.yml.

The clickable items (TNT by default) and the coloured tiles can be changed in the config.yml file. The menu heading and other text can be changed in the messages.yml file.



Double-Jumps
There is an option (disabled by default) to give players a set number of double-jumps at the beginning of each game.
This avoids the need to purchase double-jumps in the shop. If the free double-jumps option is enabled, then players can still purchase double-jumps in the shop (up to the maximum allowed), but these are stored and not used until the free double-jumps option is disabled. Unlike the shop bought double-jumps, the number of free double-jumps are reset at the start of each game.

The number of double-jumps a player can receive can also be limited using a permission node, spleef.doublejumps.n, where n is a positive integer (>=1).

A player with permission spleef.doublejumps.6: true will be able to receive or buy a maximum of 6 double-jumps, provided the maximum amount allowed in the config is at least 6.

A player should not have more than one doublejump permission set to true as there is no guarantee which one the plugin will match with first.

Doublejumps can be disabled completely in an arena by modifying the 'allowDoublejumps' setting in the arena config file.

The height of the doublejump can be modified in config.yml
The multiplier affects the forward trajectory of the player, while the height affects the vertical height the player can jump.

There is also an admin/console command ( [/trsetup|trconsole] givedoublejumps {player} {amount}) to give players additional doublejumps overriding any maximums set in the config.


Shop Setup
Items to be purchased in-game can be defined in the shop.yml file. The configuration below is the default shop configuration created when the plugin is installed. The description and prices can can be amended, items can removed completely or new items added provided they follow the existing convention.

By default, the permission node spleef.shop is set to true, allowing players to purchase any shop item, provided they have the money to purchase it. Alternatively, each shop item can have its own permission node set (in shop.yml) which a player will need to have in order to purchase that item.

Potions and Splash Potions have a duration and amplifier which can be set using the syntax:
<potion effect>#<duration>#<amplifier>

Setting the amplifier is optional in which case the default value of 1 will apply.

Snowballs have a custom knockback effect. This can be set from 0 (no knockback) to 5 (large knockback). The default is 2.

Items can be bought while waiting in the arena or during the arena countdown, and are given to the player immediately the game starts. Only one shop item can be purchased per game.

Optionally purchases can be removed when the player leaves the arena before the game starts using the config.yml option:
The amount of money a player currently has is displayed using the item in the final slot of the shop GUI. The GOLD_INGOT can be changed to any other item in the config.




Placeholders
All the placeholders listed below work with the current version.


Creating holograms using the placeholders
This information is on the wiki and includes examples on creating holographic leaderboards using HolographicDisplays.


Signs
Each sign is created as in the picture below. The Join sign colours are configurable in config.yml, and the arena name colour can be set when creating the sign, e.g. &farena1 will create the name in white instead of the default black text.

The Leaderboard sign colours and text can be set in messages.yml. The Leaderboard sign will automatically refresh at the end of each game.

The leave and vote signs have largely been superceded by using inventory items but can still be used if required.


If a join sign is placed on a STAINED_GLASS block, the glass colour can be configured to reflect the status of the arena, for example GREEN/waiting, RED/in-game, BLACK/disabled.

Custom Events
Custom events allow developers to hook into Spleef_reloaded.


Languages / Localization
The in-game default language is English (en-GB). The language can be changed by manually replacing the messages.yml with your own translated version of the file.

If you would like to contribute your translations to the project, these are managed via Crowdin.com. Please visit the wiki for details on how to set the language for your server and how to contribute via Crowdin.

If your language is not listed below and if its supported by Crowdin, let me know and it can easily be added.


Metrics
This plugin uses bStats to collect anonymous plugin metrics. The data is collected once every 30mins and is submitted asynchronously to the bStats server. The plugin doesn't collect any custom data, just the default bStats data which is listed on bstats.org. The metrics class is also open source and can be viewed here, or in this plugin's source code on GitHub.

Metrics can of course be disabled on your server but I would appreciate it if it was left enabled as the information it provides gives me an idea of how many servers are using the plugin, what versions are in use, etc. and is an incentive for me to put more of my time into development of the plugin.

Data from the plugin can be viewed here:
https://bstats.org/plugin/bukkit/Spleef_reloaded




Issues and support
Join our Discord server to make it easier to discuss issues and share information.


Any issues or suggestions can be raised on the Issues tab in the GitHub repository, by clicking the big Discord banner above, in the Discussions tab, or even send me a PM.

Please don't use the Review section to ask for help or additional features. Use one of the options listed above and provide as much information as possible. If something's not working, then it probably is a configuration issue, and it's just not possible to diagnose and resolve a problem in the review space. Thank you.