Configuration Overview

Jails and Jails+ have a comprehensive configuration system with one main file: config.yml For plugin settings and discord.yml For discord integration settings. Understanding how these components work together will help you customize the plugin to meet your server's specific needs.

Configuration Files and Folders

config.yml - Controls plugin behavior, settings, and integrations

discord.yml - Controls discord integration settings. (Jails+ only feature)

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

Configuration Structure

The configuration system is organized into sections:

Plugin Settings (config.yml) [Includes components from both Jails+ and Jails plugins]:

• General: Language, broadcast message, and integration

• Jail Settings: Inventory, Escape consequences, and Skin

• Handcuff Settings: Movement, Placement, and screen visuals

• Blocked Commands: List of blocked commands

• Jail Restriction: Attack, Placement, and Interaction

Discord Integration (discord.yml) [Jails+ only feature]:

• Bot: Configuration of the Discord bot, which includes the token and name(for display purposes)

• Channel: Channel ID in which the messages and embeds will be sent

• Messages: Events, and Message format

• Embeds: Advanced separate event messages

• Error Handling: Retry limits, delay, and logging

Key Configuration Concepts

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 back up 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:

• /jails reload - Reloads both config.yml and discord.yml

• Configuration changes take effect immediately

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 that may arise.