Configuration Overview

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

Configuration Files

The plugin uses two main configuration files:

• config.yml - Main plugin configuration (database, orders, economy, features)
• messages.yml - All user-facing messages and GUI text

Both files are located in plugins/SigmaOrders/ and are auto-generated on first run.

Configuration Structure

# Database settings
database:
  type: SQLITE  # or MYSQL
  mysql: { ... }

# Order settings
orders:
  order-life: 10080  # minutes
  max-orders-per-player: 10
  max-items-per-order: 54
  # ... more settings

# Economy settings
economy:
  payment-method: ESCROW

# Payment system
payment:
  charge-on-creation: true
  pay-on-delivery: true
  # ... refund settings

# Features
features:
  shulker-box-support: true
  order-priority: true
  # ... more features

Auto-Update System

The plugin automatically updates configuration files:

• New options are added with defaults
• Existing settings are preserved
• No manual migration needed

Configuration Sections

• Database - Database type and connection settings
• Orders - Order limits, expiration, pricing
• Economy - Payment methods and escrow settings
• Notifications - Messages, sounds, announcements
• Features - Feature toggles
• Blacklist - Player and item blacklists
• Performance - Caching and async settings

Editing Configuration

Method 1: Direct File Edit

1. Stop server (recommended for safety)
2. Edit plugins/SigmaOrders/config.yml
3. Start server
4. Changes take effect immediately

Method 2: Reload Command

1. Edit plugins/SigmaOrders/config.yml
2. Run /orders reload (admin only)
3. Changes apply without restart

warning

Some settings require a server restart to take effect (e.g., database type changes).

Configuration Validation

The plugin validates configuration on startup:

• Invalid values are corrected automatically
• Warnings appear in console for issues
• Defaults are used for missing keys

Best Practices

1. Backup Before Changes: Always backup config.yml before major changes
2. Test Changes: Test configuration changes on a development server first
3. Use Comments: YAML comments (#) help document your settings
4. Incremental Changes: Make small changes and test, rather than bulk changes

Quick Reference

Setting	File	Section	Default
Database type	config.yml	database.type	SQLITE
Order expiration	config.yml	orders.order-life	10080 (7 days)
Max orders/player	config.yml	orders.max-orders-per-player	10
Payment method	config.yml	economy.payment-method	ESCROW
Charge on creation	config.yml	payment.charge-on-creation	true

Next Steps

• Database Configuration - Configure database
• Order Settings - Configure order behavior
• Economy Settings - Configure payments