Tools¶

SigmaTools provides four specialized tools, each with unique abilities. This page explains how each tool works and how to configure them.

Tool Overview¶

Tool	Function	Default Material	Key Feature
Pickaxe	Area mining (3x3)	Diamond Pickaxe	Breaks 9 blocks at once
Axe	Tree chopping	Diamond Axe	Chops entire trees
Bucket	Infinite liquids	Bucket	Unlimited water/lava
Hoe	Auto-replanting	Diamond Hoe	Automatically replants crops

Pickaxe Tool¶

Functionality¶

The SigmaTools Pickaxe breaks blocks in a 3x3 area (9 blocks total) centered on the target block.

How it works: 1. Player breaks a block with the pickaxe 2. Plugin detects the tool and target block 3. Scans a 3x3 area around the target 4. Breaks all valid blocks in the area 5. Applies durability, cooldown, economy, and protection checks

Configuration¶

tools:
  pickaxe:
    enabled: true
    nbt-key: "sigmatools:pickaxe"
    item-material: DIAMOND_PICKAXE
    display-name: "&6SigmaTools Pickaxe"

    # Area mining settings
    radius: 1  # 1 = 3x3, 2 = 5x5, 3 = 7x7
    max-blocks-per-use: 80
    per-tick-limit: 20
    per-player-concurrent-ops: 1
    check-protection: true

    # Allowed worlds
    worlds:
      - world
      - world_nether
      - world_the_end

    # Cooldown system
    cooldown:
      enabled: true
      max-charges: 3
      charge-duration: 2  # seconds

    # Durability system
    durability:
      type: "custom"
      max: 1500
      drain-per-block: 1
      drain-per-use: 0
      break-on-empty: true
      prevent-repair: true

    # Visual effects
    visuals:
      particles: true
      sound: true
      particle-type: "EXPLOSION_NORMAL"
      particle-count: 5
      particle-spread: 0.5
      sound-type: "BLOCK_STONE_BREAK"
      sound-volume: 1.0
      sound-pitch: 1.0

Key Settings¶

radius - Mining radius (1 = 3x3, 2 = 5x5, 3 = 7x7)
max-blocks-per-use - Maximum blocks broken per use
per-tick-limit - Blocks processed per server tick
per-player-concurrent-ops - Max concurrent operations per player

Use Cases¶

Efficient mining in survival servers
Fast resource gathering
Area clearing for building

Axe Tool¶

Functionality¶

The SigmaTools Axe automatically chops entire trees by detecting connected logs.

How it works: 1. Player breaks a log with the axe 2. Plugin scans for connected logs (up to max-logs) 3. Breaks all connected logs in the tree 4. Stops at leaves or non-log blocks 5. Applies durability, cooldown, economy, and protection checks

Configuration¶

tools:
  axe:
    enabled: true
    nbt-key: "sigmatools:axe"
    item-material: DIAMOND_AXE
    display-name: "&6SigmaTools Axe"

    # Tree chopping settings
    max-logs: 100
    per-tick-limit: 15
    per-player-concurrent-ops: 2
    check-protection: true

    # Allowed worlds
    worlds:
      - world
      - world_nether
      - world_the_end

    # Cooldown system
    cooldown:
      enabled: true
      max-charges: 1
      charge-duration: 3  # seconds

    # Durability system
    durability:
      type: "custom"
      max: 1500
      drain-per-block: 1
      drain-per-use: 0
      break-on-empty: true
      prevent-repair: true

    # Visual effects
    visuals:
      particles: true
      sound: true
      particle-type: "CRIT_MAGIC"
      particle-count: 5
      particle-spread: 0.5
      sound-type: "BLOCK_WOOD_BREAK"
      sound-volume: 0.2
      sound-pitch: 1.0

Key Settings¶

max-logs - Maximum logs to break per tree
per-tick-limit - Blocks processed per server tick
per-player-concurrent-ops - Max concurrent operations per player

Use Cases¶

Efficient tree farming
Forest clearing
Wood resource gathering

Bucket Tool¶

Functionality¶

The SigmaTools Bucket provides infinite water and lava placement without consuming the bucket.

How it works: 1. Player uses bucket to place/collect liquid 2. Plugin detects the tool 3. Allows infinite placement without consuming bucket 4. Applies cooldown, economy, and protection checks

Configuration¶

tools:
  bucket:
    enabled: true
    nbt-key: "sigmatools:bucket"
    item-material: BUCKET
    display-name: "&6SigmaTools Bucket"

    # Liquid settings
    allow-water: true
    allow-lava: false
    per-player-concurrent-ops: 1
    check-protection: true

    # Allowed worlds
    worlds:
      - world
      - world_nether
      - world_the_end

    # Cooldown system (disabled by default)
    cooldown:
      enabled: false
      max-charges: 0
      charge-duration: 0

    # Durability system
    durability:
      type: "custom"
      max: 500
      drain-per-block: 0
      drain-per-use: 1
      break-on-empty: false
      prevent-repair: true

    # Visual effects
    visuals:
      particles: true
      sound: true
      particle-type: "WATER_SPLASH"
      particle-count: 40
      particle-spread: 1.2
      sound-type: "ENTITY_EXPERIENCE_ORB_PICKUP"
      sound-volume: 0.2
      sound-pitch: 1.0

Key Settings¶

allow-water - Allow infinite water placement
allow-lava - Allow infinite lava placement
per-player-concurrent-ops - Max concurrent operations per player

Use Cases¶

Infinite water for farms
Lava placement for mob farms
Building with liquids

Hoe Tool¶

Functionality¶

The SigmaTools Hoe automatically replants crops after harvesting.

How it works: 1. Player breaks a crop with the hoe 2. Plugin detects the tool and crop type 3. Harvests the crop 4. Automatically replants if seeds are available 5. Applies durability, cooldown, economy, and protection checks

Configuration¶

tools:
  hoe:
    enabled: true
    nbt-key: "sigmatools:hoe"
    item-material: DIAMOND_HOE
    display-name: "&6SigmaTools Hoe"

    # Replanting settings
    replant:
      consume-seed: true
      auto-replant: true

    per-player-concurrent-ops: 1
    check-protection: true

    # Allowed worlds
    worlds:
      - world
      - world_nether
      - world_the_end

    # Cooldown system
    cooldown:
      enabled: true
      max-charges: 64
      charge-duration: 2  # seconds

    # Durability system
    durability:
      type: "custom"
      max: 2000
      drain-per-block: 0
      drain-per-use: 1
      break-on-empty: true
      prevent-repair: true

    # Visual effects
    visuals:
      particles: true
      sound: true
      particle-type: "HEART"
      particle-count: 2
      particle-spread: 0.5
      sound-type: "ENTITY_EXPERIENCE_ORB_PICKUP"
      sound-volume: 0.2
      sound-pitch: 1.0

Key Settings¶

replant.consume-seed - Consume seeds from inventory when replanting
replant.auto-replant - Automatically replant after harvesting
per-player-concurrent-ops - Max concurrent operations per player

Supported Crops¶

Wheat
Carrots
Potatoes
Beetroot
Nether Wart

Use Cases¶

Automated farming
Efficient crop harvesting
Farm management

Common Tool Settings¶

All tools share these common configuration sections:

Cooldown System¶

Controls charge-based usage:

cooldown:
  enabled: true  # Enable/disable cooldown
  max-charges: 3  # Maximum charges
  charge-duration: 2  # Seconds to recharge one charge
  message: "&cNo charges remaining! &fRecharging..."

Durability System¶

Controls tool durability:

durability:
  type: "custom"  # custom, vanilla, none
  max: 1500  # Maximum durability
  drain-per-block: 1  # Durability lost per block
  drain-per-use: 0  # Additional durability per use
  break-on-empty: true  # Break tool when empty
  prevent-repair: true  # Prevent repairing

Visual Effects¶

Controls particles and sounds:

visuals:
  particles: true  # Enable particles
  sound: true  # Enable sounds
  particle-type: "EXPLOSION_NORMAL"  # Particle type
  particle-count: 5  # Number of particles
  particle-spread: 0.5  # Spread radius
  sound-type: "BLOCK_STONE_BREAK"  # Sound type
  sound-volume: 1.0  # Volume (0.0-2.0)
  sound-pitch: 1.0  # Pitch (0.5-2.0)

Tool Identification¶

Tools are identified via NBT data (PersistentDataContainer), not item names. This means:

Tools cannot be duplicated by renaming
Tools are uniquely identified by NBT key
Tools work even if display name is changed

Next Steps¶

Configuration Guide - Detailed tool configuration
Economy System - Economy integration
Protection Integration - Protection compatibility