​
Installing LilChunks

Get LilChunks up and running on your Minecraft server in just a few minutes.

​
Requirements

Before installing LilChunks, ensure your server meets these requirements:

Java Version

Java 17 or higher

Minecraft Version

1.16.5 to 1.21.5

Server Software

Bukkit, Spigot, or Paper
LilChunks requires Java 17 or higher. Older Java versions are not supported.

​
Download

1

Get the Latest Release

Download the latest version of LilChunks from the official sources:

GitHub Releases

Download from GitHub releases page

Hydr4 Plugins

Download from official plugin hub
2

Verify Download

Ensure you downloaded the correct file:
  • File name: lilchunks-x.x.x.jar
  • File size: ~150KB
  • No additional dependencies required

​
Installation Process

1

Stop Your Server

Before installing any plugin, it’s recommended to stop your Minecraft server:
# In server console
stop
You can also install LilChunks while the server is running using a plugin manager, but stopping is safer.
2

Upload the Plugin

Place the lilchunks-x.x.x.jar file in your server’s plugins directory:
your-server/
├── plugins/
│   ├── lilchunks-1.1.0.jar  ← Place here
│   └── other-plugins.jar
├── world/
└── server.jar
3

Start Your Server

Start your Minecraft server to load LilChunks:
# Start your server
java -jar server.jar
You should see LilChunks initialization messages in the console.
4

Verify Installation

Check that LilChunks loaded successfully:
# In server console
plugins
You should see LilChunks listed in green, indicating it’s enabled.

​
First Launch

When LilChunks starts for the first time, you’ll see colorful initialization messages: 
[INFO] ╭─────────────────────────────────╮
[INFO] │        LilChunks Pre-Init       │
[INFO] ╰─────────────────────────────────╯

[INFO] ╭─────────────────────────────────╮
[INFO] │      LilChunks v1.1.0           │
[INFO] │                                 │
[INFO] │ » Status: ENABLED               │
[INFO] │ » Server: 1.20.4-R0.1-SNAPSHOT │
[INFO] │ » Author: Hydr4                 │
[INFO] ╰─────────────────────────────────╯
The colorful boxes indicate that LilChunks has loaded successfully and is ready to use!

​
Configuration Files

After the first launch, LilChunks will create its configuration files: 
plugins/
└── LilChunks/
    ├── config.yml      ← Main configuration
    └── data/           ← Plugin data storage

​
Default Configuration

LilChunks creates a config.yml file with sensible defaults: 
# Debug mode - enables additional logging
debug: false

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

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

# Logging settings
logging:
  log-progress: true
  progress-interval: 5
  detailed-logs: false
The default configuration is optimized for most servers. You can customize it later based on your needs.

​
Verification

​
Test Basic Commands

Verify the installation by testing basic commands: 
/lilchunks help
/lc help
/chunks help

​
Check Permissions

Ensure permissions are working correctly: 
# Check if you have admin permissions
/lilchunks reload

# Check basic permissions
/lilchunks status

​
Troubleshooting Installation

​
Alternative Installation Methods

​
Plugin Managers

If you’re using a plugin manager, you can install LilChunks without stopping the server: 
/plugman load LilChunks

​
Docker Installations

For Docker-based servers, mount the plugins directory: 
# In your Dockerfile or docker-compose.yml
volumes:
  - ./plugins:/opt/minecraft/plugins
  - ./lilchunks-config:/opt/minecraft/plugins/LilChunks

​
Next Steps

Now that LilChunks is installed, you’re ready to start using it:

Quick Start Guide

Learn the basics and start your first pregeneration

Configuration

Customize LilChunks for your server
Join our community for support and updates! Check the main documentation page for Discord and GitHub links.