Configuration

Configuration Basics

Most DeltaPlugins can be customized through configuration files. Understanding how to properly configure your plugins is essential for getting the most out of them.

Configuration Files

After installing a plugin, a configuration file (usually config.yml) will be generated in the plugin's folder. This file contains all the settings you can modify to customize the plugin's behavior.

your-server/
├── plugins/
│   ├── YourDeltaPlugin/
│   │   ├── config.yml
│   │   └── ... (other plugin files)
│   └── ... (other plugins)
└── ... (other server files)

YAML Format

Most configuration files use the YAML format. Here are some basic rules to follow when editing YAML files:

• Indentation matters - use spaces (not tabs) for indentation
• Use colons to separate keys and values: key: value
• Lists are denoted with hyphens: - item1
• Comments start with the # symbol: # This is a comment

Advanced Configuration

Beyond the basic settings, many plugins offer advanced configuration options that allow for deeper customization.

Multiple Configuration Files

Some plugins use multiple configuration files to organize different aspects of their functionality:

• config.yml - Main configuration
• messages.yml - Customizable messages and text
• data.yml - Stored data and information
• permissions.yml - Permission settings

Variables and Placeholders

Many plugins support variables or placeholders in their configuration files. These are special text markers that get replaced with dynamic content when the plugin runs.

# Example of placeholders in a message configuration
welcome-message: "Welcome, %player_name%! Your rank is %player_rank%."

Common placeholders include:

• %player_name% - The player's username
• %server_name% - Your server's name
• %online_players% - Number of players currently online
• %date% - Current date
• %time% - Current time

Conditional Configuration

Some advanced plugins allow for conditional settings that activate only under certain circumstances:

# Example of conditional configuration
events:
  player-join:
    conditions:
      is-new-player: true
    actions:
      - give-starter-kit
      - teleport-to-spawn
      - send-welcome-message

Example Configurations

Below are some example configurations for common DeltaPlugins to help you understand how to structure your own configurations.

Economy Plugin Example

# DeltaEconomy configuration example
settings:
  currency-name: "Coins"
  currency-symbol: "$"
  starting-balance: 100
  max-balance: 1000000

transactions:
  log-to-file: true
  log-path: "logs/economy/"

interest:
  enabled: true
  rate: 0.5
  interval: 24 # hours
  min-balance-for-interest: 1000

Permissions Plugin Example

# DeltaPerms configuration example
groups:
  admin:
    prefix: "&c[Admin] "
    permissions:
      - "*"
  moderator:
    prefix: "&6[Mod] "
    permissions:
      - "deltaplugins.mod.*"
      - "deltaplugins.teleport"
      - "deltaplugins.kick"
  default:
    prefix: "&7[Player] "
    permissions:
      - "deltaplugins.basic.*"

inheritance:
  moderator:
    - default
  admin:
    - moderator

Chat Plugin Example

# DeltaChat configuration example
chat:
  format: "%prefix%%player_name%&f: %message%"
  range: 0 # 0 for global chat, any other number for local chat radius
  cooldown: 3 # seconds between messages

filters:
  enabled: true
  blocked-words:
    - "badword1"
    - "badword2"
  replacement: "****"

channels:
  global:
    prefix: "&7[G] "
    permission: "deltachat.channel.global"
  staff:
    prefix: "&c[Staff] "
    permission: "deltachat.channel.staff"

Best Practices

Follow these best practices to ensure your configurations work correctly and are easy to maintain:

Organization

• Keep your configuration files organized and well-commented
• Use descriptive names for custom items, permissions, and groups
• Group related settings together

Testing

• Test your configuration changes on a development server before applying them to your live server
• Make one change at a time and test it before moving on to the next
• Use the plugin's reload command (if available) to apply changes without restarting the server

Maintenance

• Regularly back up your configuration files
• Document any custom changes you make
• Keep track of which plugins depend on each other
• Update your configurations when updating plugins

Next Steps

Now that you understand how to configure your plugins, you might want to:

• Explore tutorials for specific configuration scenarios
• Learn about API integration for developers
• Check out our plugin marketplace for more plugins to enhance your server