Configuration

Complete configuration guide for LilChunks

Configuration Guide

Customize LilChunks to perfectly fit your server’s needs with our comprehensive configuration options.

Configuration File Location

The main configuration file is located at:

plugins/LilChunks/config.yml

After making changes to the configuration, use /lilchunks reload to apply them without restarting the server.

Default Configuration

Here’s the complete default configuration with explanations:

# LilChunks Configuration

# Debug mode - enables additional logging
debug: false

# Chunk generation settings
chunk-generation:
  # Maximum chunks to generate per tick
  chunks-per-tick: 4
  
  # Whether to use async chunk generation (1.17+)
  use-async: true
  
  # Whether to generate structures
  generate-structures: true
  
  # Whether to generate caves
  generate-caves: true
  
  # Whether to generate features (trees, ores, etc.)
  generate-features: true

# World settings
world-settings:
  # Default world height (1.17+)
  min-height: -64
  max-height: 320
  
  # Whether to respect world-specific height settings
  respect-world-height: true

# Performance settings
performance:
  # Maximum memory usage in MB (0 for unlimited)
  max-memory-usage: 0
  
  # Whether to use parallel chunk generation
  use-parallel: true
  
  # Number of threads to use for chunk generation (0 for auto)
  thread-count: 0

# Logging settings
logging:
  # Whether to log chunk generation progress
  log-progress: true
  
  # Progress update interval in seconds
  progress-interval: 5
  
  # Whether to log detailed chunk information
  detailed-logs: false

Configuration Sections

Debug Settings

debug

Type: boolean
Default: false
Description: Enables detailed debug logging for troubleshooting

debug: true  # Enable debug mode

Debug mode generates extensive logs. Only enable when troubleshooting issues.

Chunk Generation Settings

chunks-per-tick

Type: integer
Default: 4
Range: 1-20
Description: Maximum number of chunks to generate per server tick

chunk-generation:
  chunks-per-tick: 4  # Balanced performance

Performance Impact:

• Lower values (1-2): Minimal lag, slower generation
• Medium values (3-6): Balanced performance
• Higher values (7-20): Faster generation, potential lag

Start with the default value and adjust based on your server’s performance.

use-async

Type: boolean
Default: true
Description: Use asynchronous chunk generation (Minecraft 1.17+)

chunk-generation:
  use-async: true  # Recommended for 1.17+

Benefits:

• Reduces main thread blocking
• Improves server performance
• Better player experience

Async generation is only available on Minecraft 1.17 and higher. On older versions, this setting is ignored.

generate-structures

Type: boolean
Default: true
Description: Whether to generate structures (villages, dungeons, etc.)

chunk-generation:
  generate-structures: true

Impact:

• true: Full world generation with all structures
• false: Faster generation, but no structures

generate-caves

Type: boolean
Default: true
Description: Whether to generate cave systems

chunk-generation:
  generate-caves: true

Impact:

• true: Complete underground generation
• false: Faster generation, solid underground

generate-features

Type: boolean
Default: true
Description: Whether to generate world features (trees, ores, decorations)

chunk-generation:
  generate-features: true

Impact:

• true: Full world decoration and resources
• false: Faster generation, minimal decoration

World Settings

min-height / max-height

Type: integer
Default: -64 / 320
Description: Default world height limits for generation

world-settings:
  min-height: -64   # Deepslate level
  max-height: 320   # Build limit

Version Compatibility:

• 1.17+: Supports extended height (-64 to 320)
• 1.16 and below: Limited to 0-256

respect-world-height

Type: boolean
Default: true
Description: Use world-specific height settings instead of config defaults

world-settings:
  respect-world-height: true

Behavior:

• true: Use each world’s individual height settings
• false: Use config values for all worlds

Performance Settings

max-memory-usage

Type: integer
Default: 0 (unlimited)
Unit: Megabytes
Description: Maximum memory usage for chunk generation

performance:
  max-memory-usage: 1024  # 1GB limit

Values:

• 0: No memory limit (default)
• >0: Memory limit in MB

Setting a memory limit may slow down generation but prevents out-of-memory errors.

use-parallel

Type: boolean
Default: true
Description: Enable parallel chunk generation processing

performance:
  use-parallel: true

Benefits:

• Utilizes multiple CPU cores
• Faster generation on multi-core systems
• Better resource utilization

thread-count

Type: integer
Default: 0 (auto)
Description: Number of threads for chunk generation

performance:
  thread-count: 4  # Use 4 threads

Values:

• 0: Auto-detect (recommended)
• 1-16: Specific thread count

Auto-detection typically uses CPU cores - 1 to leave resources for the main server thread.

Logging Settings

log-progress

Type: boolean
Default: true
Description: Enable progress logging during generation

logging:
  log-progress: true

Output Example:

[LilChunks] Generation progress: 150/441 chunks (34%)

progress-interval

Type: integer
Default: 5
Unit: Seconds
Description: How often to log progress updates

logging:
  progress-interval: 10  # Every 10 seconds

Recommended Values:

• Fast generation: 5-10 seconds
• Slow generation: 15-30 seconds

detailed-logs

Type: boolean
Default: false
Description: Enable detailed chunk-by-chunk logging

logging:
  detailed-logs: true

Detailed logs can generate massive log files. Only enable for debugging specific issues.

Performance Profiles

Here are pre-configured profiles for different server types:

High-Performance Server

For powerful dedicated servers:

chunk-generation:
  chunks-per-tick: 8
  use-async: true
  generate-structures: true
  generate-caves: true
  generate-features: true

performance:
  max-memory-usage: 0
  use-parallel: true
  thread-count: 0

logging:
  log-progress: true
  progress-interval: 3
  detailed-logs: false

Balanced Server

For most shared hosting and VPS:

chunk-generation:
  chunks-per-tick: 4
  use-async: true
  generate-structures: true
  generate-caves: true
  generate-features: true

performance:
  max-memory-usage: 2048
  use-parallel: true
  thread-count: 0

logging:
  log-progress: true
  progress-interval: 5
  detailed-logs: false

Low-Resource Server

For budget hosting or limited resources:

chunk-generation:
  chunks-per-tick: 2
  use-async: true
  generate-structures: true
  generate-caves: true
  generate-features: true

performance:
  max-memory-usage: 1024
  use-parallel: false
  thread-count: 1

logging:
  log-progress: true
  progress-interval: 10
  detailed-logs: false

Speed-Optimized

For fastest generation (may cause lag):

chunk-generation:
  chunks-per-tick: 12
  use-async: true
  generate-structures: false
  generate-caves: false
  generate-features: false

performance:
  max-memory-usage: 0
  use-parallel: true
  thread-count: 0

logging:
  log-progress: true
  progress-interval: 2
  detailed-logs: false

Configuration Validation

LilChunks validates your configuration on startup and reload:

Valid Configuration

[LilChunks] Configuration loaded successfully
[LilChunks] Using 4 chunks per tick with async generation

Invalid Configuration

[LilChunks] WARNING: Invalid chunks-per-tick value: 25 (max: 20)
[LilChunks] Using default value: 4

Advanced Configuration

Environment-Specific Settings

You can create different configurations for different environments:

Development

debug: true
chunk-generation:
  chunks-per-tick: 1
logging:
  detailed-logs: true
  progress-interval: 1

Configuration Management

1. Backup Configuration

   Always backup your configuration before making changes:

   cp plugins/LilChunks/config.yml plugins/LilChunks/config.yml.backup
   

2. Test Changes

   Test configuration changes on a development server first.

3. Apply Changes

   Use the reload command to apply changes:

   /lilchunks reload
   

4. Monitor Performance

   Watch server performance after configuration changes.

Troubleshooting Configuration

Configuration Not Loading

Symptoms: Changes don’t take effect after reload

Solutions:

• Check YAML syntax with a validator
• Verify file permissions (readable by server)
• Check for hidden characters or encoding issues
• Restart the server if reload fails

Performance Issues

Symptoms: Server lag after configuration changes

Solutions:

• Reduce chunks-per-tick value
• Disable parallel processing temporarily
• Set memory limits
• Check server resources (CPU, RAM)

Generation Errors

Symptoms: Chunk generation fails or produces errors

Solutions:

• Enable debug mode temporarily
• Check detailed logs
• Verify world compatibility settings
• Reset to default configuration

Configuration Best Practices

Start Conservative

Begin with lower performance settings and gradually increase based on server capacity.

Monitor Resources

Watch CPU, memory, and TPS during generation to find optimal settings.

Test Changes

Always test configuration changes on a development server first.

Document Settings

Keep notes about what settings work best for your server setup.

Next Steps

Commands Reference

Learn all available commands and their options

Performance Tuning

Optimize LilChunks for maximum performance