Skip to content

Configuration Overview

SigmaTools uses YAML configuration files for all settings. This guide explains the configuration structure and how to customize the plugin.

Configuration Files

SigmaTools uses two main configuration files:

  1. config.yml - Main plugin settings (tools, economy, performance, debug)
  2. messages.yml - Message templates and translations

Both files are located in plugins/SigmaTools/ and are created automatically on first run.

Configuration Structure

config.yml
├── general (Global settings)
├── economy (Economy integration)
├── performance (Performance limits)
└── tools (Tool-specific settings)
    ├── pickaxe
    ├── axe
    ├── bucket
    └── hoe
        ├── cooldown
        ├── durability
        └── visuals

messages.yml
├── general (General messages)
└── economy (Economy messages)

Quick Configuration Guide

Basic Settings

Enable/Disable Tools: 

tools:
  pickaxe:
    enabled: true  # Set to false to disable

Enable Economy: 

economy:
  enabled: true
  currency: "vault"  # or "coins"

Adjust Tool Costs: 

economy:
  costs:
    pickaxe: 10.0  # Cost per use

Reloading Configuration

After editing configuration files:

  1. Save the file
  2. Run /sigmatools reload in-game
  3. Changes take effect immediately

Note: Invalid YAML syntax will prevent reloading. Check server logs for errors.

Configuration Sections

Global Settings

General plugin settings including: - Unbreakable materials list - Integration toggles - Protection settings - Global performance limits

Tool Settings

Per-tool configuration including: - Enable/disable tools - Tool properties (material, display name) - Operation limits - World restrictions - Cooldown system - Durability system - Visual effects

Economy Settings

Economy integration settings: - Enable/disable economy - Currency selection - Tool costs - Tool rewards - Economy messages

Performance Settings

Performance optimization settings: - Per-tick limits - Thread pool size - Dynamic throttling - Queue management

Debug Settings

Debug logging configuration: - Master debug toggle - Category-specific logging - Output settings - File logging

Configuration Best Practices

  1. Backup First - Always backup config.yml before making changes
  2. Test Changes - Test configuration changes on a test server first
  3. Use Comments - The default config includes helpful comments
  4. Validate YAML - Use an online YAML validator to check syntax
  5. Reload Carefully - Test after reloading to ensure everything works

Common Configuration Tasks

Disable a Tool

tools:
  bucket:
    enabled: false

Change Tool Costs

economy:
  enabled: true
  costs:
    pickaxe: 5.0
    axe: 3.0
    bucket: 1.0
    hoe: 2.0

Adjust Cooldown

tools:
  pickaxe:
    cooldown:
      max-charges: 5  # Increase from 3 to 5
      charge-duration: 1  # Reduce from 2 to 1 second

Change Durability

tools:
  pickaxe:
    durability:
      max: 2000  # Increase from 1500
      drain-per-block: 2  # Increase from 1

Enable Debug Logging

debug:
  enabled: true
  operations: true
  protection: true

Configuration Validation

SigmaTools validates configuration on load:

  • Missing keys - Default values are used
  • Invalid types - Errors are logged, defaults used
  • Invalid values - Errors are logged, defaults used

Check server logs after reloading for validation messages.

Configuration Examples

See individual configuration pages for detailed examples:

Next Steps