BuildersWand
  • Introduction
    • Getting Started
    • Quick Start Guide
    • Installation Guide
    • First Steps
  • Core Features and Usage
    • Understanding Wands
    • Selection Modes
    • Settings GUI
    • Storage System
    • Durability and Repair
  • Configuration and Customization
    • Configuration Overview
    • Main Configuration (config.yml)
    • Wands Configuration (wands.yml)
    • Languages and Messages
    • Permissions Setup
    • Plugin Integrations
    • Performance Tuning
  • Commnds and administration
    • Commands Usage
Powered by GitBook
On this page
  1. Configuration and Customization

Configuration Overview

PreviousDurability and RepairNextMain Configuration (config.yml)

Last updated 1 month ago

CtrlK
  • Configuration Overview
  • Configuration Files and Folders
  • Configuration Structure
  • Key Configuration Concepts
  • Configuration Management
  • Best Practices
  • Configuration Reloading
  • Troubleshooting Configuration

Configuration Overview

BuildersWand uses a comprehensive configuration system with two main files: config.yml for plugin settings and wands.yml for wand definitions. Understanding how these work together will help you customize the plugin to fit your server's needs.

Configuration Files and Folders

config.yml - Controls plugin behavior, permissions, performance, and integrations

wands.yml - Defines all available wands and their properties

lang - Folder containing all language files which contain the messages sent to users.

Configuration Structure

The configuration system is organized into sections:

Plugin Settings (config.yml)

  • General: Debug mode, language, version tracking

  • Wand: Rendering, physics, undo settings

  • Restrictions: Usage limits, permissions, world restrictions

  • Performance: Anti-lag, memory management, optimization

  • UI: Messages, sounds, visual feedback

  • Admin: Logging, monitoring, statistics

  • Integrations: Third-party plugin hooks

Wand Definitions (wands.yml)

  • Global Defaults: Base settings for all wands

  • Individual Wands: Specific configurations for each wand tier

  • Validation: Configuration validation rules

  • Migration: Settings for config updates

Key Configuration Concepts

Inheritance: Wands can inherit properties from other wands using inherit_from

Validation: Automatic checking of configuration values

Migration: Automatic updates when configuration versions change

Fallbacks: Default values when configuration is missing or invalid

Configuration Management

The plugin automatically:

  • Creates default configuration files on first run

  • Validates all settings and reports errors

  • Migrates old configurations to new formats

  • Provides detailed logging for configuration issues

Best Practices

  1. Backup Before Changes: Always backup your config files before making changes

  2. Test Incrementally: Make small changes and test before proceeding

  3. Monitor Logs: Check server logs for configuration warnings or errors

Configuration Reloading

You can reload the configuration without restarting the server using:

  • /bw reload - Reloads both config.yml and wands.yml

  • Configuration changes take effect immediately

  • Wand properties are updated for all existing wands

Troubleshooting Configuration

If you encounter configuration issues:

  1. Check the server console for error messages

  2. Verify YAML syntax (proper indentation, quotes)

  3. Ensure all required fields are present

  4. Check that material names are valid for your server version

  5. Use the validation system to identify problems

The configuration system is designed to be robust and user-friendly, with extensive error checking and helpful feedback to guide you through any issues.