Installation
From downloading the JAR to handing out the first pickaxe on your server.
The whole installation is one file upload and a server restart. The plugin needs no other plugins and no database.
Before you start
Back up your world
The pickaxe breaks nine blocks at a time. If you set something wrong (radius 5, say), it can make sizeable holes very quickly. Test it on a copy of your world or a separate test server before letting players near it.
Check what you have:
| What | How to check |
|---|---|
| Server version | Type version in the console — it has to be 1.21 or newer |
| Server software | Paper, Spigot or Purpur. Vanilla and Forge do not run Bukkit plugins |
| File access | You need to be able to drop a file into the plugins/ directory |
Step by step
Download the plugin
The JAR is on Modrinth. You can also build it from source — see Building from source below.
Drop the JAR into the plugins directory
Do not unzip the JAR — you upload it whole.
Restart the server
A proper restart, not /reload. On startup the plugin creates
plugins/GrzybcioKilof/ and writes a default config.yml into it.
The console should show the plugin being enabled. If there is an error instead, see Troubleshooting.
Give yourself a pickaxe
Join the server and type:
/grzybcio-kilofThe pickaxe lands in your inventory. By default the command needs the
grzybciokilof.give permission, which operators have.
Check that it works
Mine something in stone. Nine blocks should disappear at once and all drops should fall normally. If only one block breaks, see Troubleshooting.
What appeared after installation
config.yml is the only file you will edit. Every option is described in
Configuration.
Building from source
The project uses Maven.
git clone https://github.com/Grzybcio-plugins/Grzybcio-Kilof.git
cd Grzybcio-Kilof
mvn clean packageThe finished JAR appears in target/. You need a JDK matching your server version and
Maven on your PATH.
Updating
Stop the server.
Copy your config.yml somewhere safe, just in case.
Delete the old JAR from plugins/ and upload the new one. Do not leave two versions
side by side — the server would load both and the plugin would start behaving oddly.
Start the server and check the console for warnings about missing configuration options.