Crystals

Crystals are items with a type and tier that give bonuses while socketed in the pickaxe. They can fail when applied, merge into higher tiers and be removed for a fee. They make great crate and boss rewards.


Configuration	`crystals.yml`
Menu	`menus/crystals.yml`
Command	`/crystals` (aliases `/crystal`, `/cristales`)
Module	`crystals`

How they are used

Action	Result
Right click with a crystal	Tries to put it in a free pickaxe socket, with its tier's `apply-chance`
Sneak + right click with a crystal	Merges `merge-amount` equal crystals of the same tier into one of the next tier
`/crystals`	Shows the sockets; clicking a crystal removes it for `remove-cost`

If applying fails and destroy-on-fail is on, the crystal is lost.

Configuration

yaml

settings:
  slots: "1 + floor({pickaxe_level} / 25)"   # unlocked sockets
  max-slots: 6
  remove-cost: "tokens:5000"                  # empty: free
  return-on-remove: true                      # gives the crystal back when removed
  merge-amount: 3                             # 0 disables merging

crystals:
  wealth:
    enabled: true
    name: "@crystals.names.wealth"
    icon: EMERALD
    max-tier: 5
    apply-chance: "100 - ({tier} - 1) * 10"   # 100% at tier 1, 60% at tier 5
    destroy-on-fail: true
    item:
      material: EMERALD
      name: "@crystals.item.name"
      lore:
        - "@crystals.item.lore"
      glow: true
    bonuses:
      sell: "{tier} * 0.03"

Option	Does
`max-tier`	Highest tier
`apply-chance`	Chance in %, formula of `{tier}`
`destroy-on-fail`	Lose the crystal on failure
`item`	Crystal item. Placeholders: `{crystal}`, `{tier}`, `{max_tier}`, `{chance}`, `{bonuses}`, `{merge_amount}`
`bonuses`	Stats, formulas of `{tier}`

Included crystals: wealth (selling), fortune (tokens), wisdom (pickaxe and level experience) and luck (enchant chance).

Commands

Command	Permission	Does
`/crystals`	everyone	Socket menu
`/crystals give <player> <crystal> <tier> [amount]`	`pulseprison.crystals.admin`	Gives crystals
`/crystals clear <player>`	`pulseprison.crystals.admin`	Empties a player's sockets
`/crystals reload`	`pulseprison.crystals.admin`	Reloads `crystals.yml`