Quickstart
Get SigmaTools up and running on your server in 5 minutes. This guide covers the absolute essentials to get you started.
Prerequisites
- Minecraft server running Spigot/Paper 1.17+
- Java 17 or higher
- Admin access to your server
Step 1: Download and Install
- Download
SigmaTools-1.0.3.jarfrom the releases page - Place the JAR file in your server's
plugins/folder - Start or restart your server
The plugin will create a plugins/SigmaTools/ folder with default configuration files.
Step 2: Give Yourself a Tool
Once the server has started, give yourself a tool to test:
/sigmatools give pickaxe YourName
Replace YourName with your Minecraft username. You should receive a SigmaTools Pickaxe in your inventory.
Step 3: Test the Tool
- Equip the SigmaTools Pickaxe in your main hand
- Break any block (stone, dirt, etc.)
- You should see a 3x3 area of blocks break around the target block
- Check the action bar - it shows your charges, durability, and economy stats
Step 4: Basic Configuration (Optional)
The default configuration works out of the box, but you can customize it:
- Edit
plugins/SigmaTools/config.yml - Make your changes
- Reload the plugin:
/sigmatools reload
Common First-Time Configurations
Disable a tool:
tools:
bucket:
enabled: false # Disable the bucket tool
Change economy currency:
economy:
enabled: true
currency: "coins" # Use CoinsEngine instead of Vault
Adjust tool costs:
economy:
costs:
pickaxe: 10.0 # Cost 10 currency per use
Step 5: Verify Everything Works
Run the debug command to see plugin status:
/sigmatools debug status
You should see:
- Master Debug status
- Enabled categories
- Integration status
Common First-Time Issues
Tool doesn't work
- Check you have the tool in your main hand (not off-hand)
- Verify you have permission:
sigmatools.use.pickaxe(default: true) - Check if the tool is enabled in config:
tools.pickaxe.enabled
Economy not working
- Ensure Vault or CoinsEngine is installed and working
- Check
economy.enabled: truein config - Verify currency setting matches your economy plugin
Protection plugins blocking tool
- Check protection integration is enabled in config
- Verify you have permission to break blocks in the area
- Use bypass permission:
sigmatools.bypass.protection(default: op)
Next Steps
Now that you have SigmaTools working, explore the full documentation:
- Configuration Guide - Customize all settings
- Commands Reference - All available commands
- Permissions Guide - Set up permissions for players
- Features Guide - Learn about all features
Quick Reference
| Task | Command |
|---|---|
| Give tool | /sigmatools give <tool> <player> |
| Reload config | /sigmatools reload |
| Debug status | /sigmatools debug status |
| Debug info | /sigmatools debug info |
Available tools: pickaxe, axe, bucket, hoe
Congratulations! You've successfully set up SigmaTools. For detailed configuration and advanced features, continue reading the documentation.