Configuration

Every option in config.yml — the pickaxe's looks, mining radius, excluded blocks and messages.

The file lives at plugins/GrzybcioKilof/config.yml. After every change run /grzybcio-kilof reload or restart the server — otherwise the new settings do not take effect.

Already-issued pickaxes do not change

A pickaxe a player already has in their inventory will not change when you edit the configuration. Appearance changes (name, lore, enchantments) only apply to pickaxes handed out after the reload. Behaviour changes (radius, excluded blocks) apply immediately to all of them.

The full default file

plugins/GrzybcioKilof/config.yml

kilof-nazwa: "&#7ED4E6&lKil&#BCDECE&lof &#FAE7B5&lDusz"

kilof-lore:
  - ""
  - "&#AAAAAA► &#FFFFFFKopie bloki 3x3"
  - "&#AAAAAA► &#FFFFFFSpecjalny kilof GrzybcioMC"
  - ""

kilof-typ: NETHERITE_PICKAXE
kilof-glow: true

kilof-enchantmenty:
  EFFICIENCY: 5
  UNBREAKING: 3
  FORTUNE: 3

kopanie-promien: 1
wymagaj-uprawnienia: false

wiadomosci:
  otrzymano-kilof: "..."
  dano-kilof: "..."
  gracz-offline: "..."
  brak-uprawnien: "..."
  tylko-gracz: "..."
  przeladowano: "..."

bloki-wykluczone:
  - BEDROCK

The option names are Polish

The plugin's configuration keys are in Polish and that is how they appear in the file. Do not translate them — kopanie-promien is the key the plugin reads, and renaming it means the plugin falls back to the default.

The pickaxe's appearance

`kilof-nazwa`

The display name on the item. Supports colours — both legacy codes (&a, &c) and full HEX.

kilof-nazwa: "&#7ED4E6&lSoul Pickaxe"

HEX colour formats that work:

Format	Example
`&#RRGGBB`	`&#7ED4E6`
`<#RRGGBB>`	`<#7ED4E6>`

Plus the standard formatting codes: &l bold, &o italic, &n underline, &r reset.

`kilof-lore`

The description under the item name. Each list entry is one line. An empty "" gives a blank line — the simplest way to stop the description hugging the name.

kilof-lore:
  - ""
  - "&#AAAAAA► &#FFFFFFMines 3x3 blocks"
  - "&#AAAAAA► &#FFFFFFSpecial GrzybcioMC pickaxe"
  - ""

`kilof-typ`

Which item the pickaxe is based on. Use a Minecraft material name in capitals.

kilof-typ: NETHERITE_PICKAXE

Most used: NETHERITE_PICKAXE, DIAMOND_PICKAXE, IRON_PICKAXE, GOLDEN_PICKAXE, STONE_PICKAXE, WOODEN_PICKAXE.

The name has to be a valid Bukkit material. A typo, or a name from a newer game version than your server, ends in an error when the pickaxe is handed out.

`kilof-glow`

Whether the item gets the purple enchanted-item shimmer.

kilof-glow: true

`kilof-enchantmenty`

A list of enchantments and their levels. The key is the enchantment name, the value is the level.

kilof-enchantmenty:
  EFFICIENCY: 5
  UNBREAKING: 3
  FORTUNE: 3

Levels may exceed the in-game caps (EFFICIENCY: 10, for instance) — that is normal for items handed out by a plugin.

Mining behaviour

`kopanie-promien`

The radius measured from the block you hit. This is the most important option in the file.

Value	Area	Blocks per swing
`1`	3×3	9
`2`	5×5	25
`3`	7×7	49

kopanie-promien: 1

Do not crank this up without thinking

Radius 3 is 49 blocks per swing. With a few players mining at once that can noticeably load the server, and holes appear in the world very fast. Leave it at 1 unless you know why you need more.

`wymagaj-uprawnienia`

Whether 3×3 mining requires the grzybciokilof.use permission.

wymagaj-uprawnienia: false

false (default) — the pickaxe works for anyone holding it. The permission is not checked.
true — the pickaxe only mines 3×3 for players with grzybciokilof.use. Everyone else breaks single blocks with it, like a normal pickaxe.

Set it to true if you want the pickaxe restricted to a specific group (VIPs, say), even when it ends up in someone else's hands.

`bloki-wykluczone`

A list of blocks the pickaxe will not break. Everything not on the list gets destroyed.

bloki-wykluczone:
  - BEDROCK
  - OBSIDIAN
  - SPAWNER
  - CHEST

This is an exclusion list, not an allowlist

By default the pickaxe touches everything. If you do not want it accidentally destroying full chests or spawners, you have to add them yourself.

Messages

The wiadomosci section holds six texts sent to players. All of them support the same colour codes as the pickaxe name.

Key	When it shows	Placeholders
`otrzymano-kilof`	The player gave themselves a pickaxe	—
`dano-kilof`	The player gave a pickaxe to someone else	`%player%`
`gracz-offline`	The named player is not online	—
`brak-uprawnien`	Missing permission for the command	—
`tylko-gracz`	The command was used from the server console	—
`przeladowano`	After `/grzybcio-kilof reload`	—

Example:

wiadomosci:
  dano-kilof: "&#7ED4E6&lGrzybcio&fMC &#AAAAAA» &#FFFFFFYou gave a pickaxe to &#7ED4E6%player%&#FFFFFF!"

After changes

/grzybcio-kilof reload

The command needs the grzybciokilof.reload permission. If the file has a YAML syntax error the reload fails — check the server console, it prints the line number.

The most common YAML mistake

Indentation has to be spaces, never tabs. Most editors can be told to insert spaces for Tab — worth doing before you edit config files.

On this page