- Compatible API Versions
- 1.0.1+
Spleef Plugin Documentation
Overview
Spleef Plugin is a mini-game for Nukkit servers where players break snow blocks to make opponents fall through platforms. The last player standing wins the game and receives monetary rewards.
Features
Permissions
Configuration
config.yml
Game Mechanics
Arena Structure
The plugin supports EconomyAPI for monetary rewards:
Tracked Metrics
Common Issues
Overview
Spleef Plugin is a mini-game for Nukkit servers where players break snow blocks to make opponents fall through platforms. The last player standing wins the game and receives monetary rewards.
Features
Multi-platform arena system
Economy integration (EconomyAPI)
Player statistics tracking
BossBar progress indicators
Multi-language support
Lobby system with queue
Configurable rewards and settings
Player data preservation
Command blocking during gameplay
Command | Permission | Description | Usage |
---|---|---|---|
/spleef join | spleef.command.join | Join the spleef game or queue | /spleef join |
/spleef leave | spleef.command.leave | Leave the current game or queue | /spleef leave |
/spleef info | spleef.command.info | View your spleef statistics | /spleef info |
Permission | Default | Description |
---|---|---|
spleef.command.join | true | Allows joining spleef games |
spleef.command.leave | true | Allows leaving spleef games |
spleef.command.info | true | Allows viewing spleef stats |
config.yml
YAML:
lobby-world: world
lobby:
x: 100.0
y: 64.0
z: 100.0
arena-world: world
arena-center:
x: 500.0
y: 100.0
z: 500.0
messages:
game-started: '&6Game started! Break blocks to make opponents fall!'
win-message: '&6{player} won the spleef game and received ${reward}!'
not-in-game: '&cYou are not in a spleef game!'
eliminated: '&cYou have been eliminated!'
countdown-bossbar: '&6Spleef starting in {time}s | Players: {players}/{min_players}'
shovel-name: '&bSpleef Shovel'
stats-format: |-
&6=== Spleef Stats ===
&ePlayer: &f{player}
&eWins: &f{wins}
&eLosses: &f{losses}
&eW/L Ratio: &f{ratio}
joined-lobby: '&aYou joined the lobby! Game will start when there are enough players.'
usage: '&cUsage: /spleef <join|leave|info>'
leave-message: '&aYou have left the spleef game.'
already-in-game: '&cYou are already in the game!'
countdown-message: '&6Game starting in {time} seconds!'
only-players: '&cOnly players can use this command!'
game-bossbar: '&6Players: &a{current}&6/&c{initial}'
join-message: '&a{player} has joined the spleef game! ({players} players)'
welcome-message: '&6Welcome to Spleef! Use &e{leave_command} &6to leave or &e{info_command}
&6for stats.'
no-stats: '&cNo statistics found for player {player}'
command-blocked: '&cYou cannot use other commands while in spleef game!'
waiting-for-players: '&eWaiting for more players to start the game. Current: {current}/{min_players}'
game-in-progress: '&cGame is already in progress!'
death-platform-touched: '&cYou touched the death platform and were eliminated!'
countdown-time: 20
win-reward: 100.0
min-players: 2
Arena Structure
- 4 Platforms stacked vertically with 5-block height difference
- Platform Size: 40-block diameter circles
- Top Platform: Snow blocks (breakable)
- Bottom Platform: Red wool (death platform)
- Safe Spawn: Players spawn randomly on the highest platform
The plugin supports EconomyAPI for monetary rewards:
- Win Reward: Configurable amount (default: 100.0)
- Automatic Distribution: Rewards are given automatically to winners
- Fallback: If EconomyAPI is not found, rewards are disabled with warning
Tracked Metrics
- Wins: Number of games won
- Losses: Number of games lost
- Win/Loss Ratio: Calculated performance metric
- Statistics are saved in data.yml
- Automatic saving on plugin disable
- Player-specific data storage
- Place the plugin JAR in the plugins folder
- Start the server to generate default configuration
- Configure arena and lobby locations in config.yml
- Restart the server or reload the plugin
Common Issues
- "EconomyAPI not found": Install EconomyAPI for monetary rewards
- Arena not generating: Check world names and coordinates in config
- Players can't join: Verify minimum players setting and game state