Skip to main content

Quick Start Guide

This guide will help you start generating chunks with Voxy World Gen V2 in just a few minutes.

First Launch

1

Start Minecraft

Launch Minecraft with your Fabric profile and load into a world (singleplayer or multiplayer).On first launch, the mod will automatically create a configuration file with sensible defaults based on your system resources.
2

Verify Mod Is Active

Press F3 to open the debug screen.In the bottom-right corner, you should see the Voxy World Gen V2 status overlay:
[voxy worldgen v2] running
completed: 0
skipped: 0
remaining: <number> (<eta>)
active: 0
rate: 0.0 c/s
voxy: enabled
If you don’t see this overlay, ensure showF3MenuStats is enabled in the config (it’s on by default).
3

Watch Chunks Generate

The mod will automatically start generating chunks around your position.You’ll see the statistics update:
  • completed: Number of chunks successfully generated
  • rate: Chunks generated per second
  • remaining: Chunks left to generate within your configured radius
  • active: Currently generating chunks

Accessing Configuration

Voxy World Gen V2 uses ModMenu for in-game configuration (if installed).
1

Open Mod Menu

From the main menu or pause menu, click Mods.
If you don’t have ModMenu installed, you’ll need to edit the config file manually at config/voxyworldgenv2.json.
2

Find Voxy World Gen V2

Scroll through the mod list and find Voxy World Gen V2.Click on it to select it.
3

Open Config Screen

Click the Configure button (gear icon) on the right side.This opens the Cloth Config-powered configuration screen.

Essential Configuration Options

Here are the most important settings you’ll want to configure:

Enable/Disable Generation

enabled
boolean
default:"true"
Master switch for chunk generation.
  • Enable: Chunks generate in the background
  • Disable: All generation stops immediately
Useful for temporarily pausing generation without uninstalling the mod.

Generation Radius

generationRadius
integer
default:"128"
How far from players (in chunks) to generate terrain.
  • 64 chunks: Small radius, fast completion (~4096 chunks total)
  • 128 chunks: Balanced default (~16,384 chunks total)
  • 256 chunks: Large radius for distant horizons (~65,536 chunks total)
  • 512 chunks: Maximum radius, takes considerable time
Larger radii require significantly more time and disk space. A 512-chunk radius generates over 262,000 chunks.

Max Active Tasks

maxActiveTasks
integer
default:"20"
Number of chunks that can generate concurrently.
  • Lower values (5-10): Less CPU usage, slower generation
  • Default (20): Balanced for most systems
  • Higher values (40-64): Faster generation on powerful hardware
Set this to roughly half your CPU core count for optimal performance.

Save Normal Chunks

saveNormalChunks
boolean
default:"true"
Whether to save generated chunks to disk.
  • Enable (default): Chunks are saved normally
  • Disable: LOD-only chunks skip disk saves (reduces I/O)
When disabled, only chunks used for Voxy LOD rendering skip saves. Player-visited chunks are always saved to prevent data loss.
When you disable this option, the F3 overlay will show:
lod suppressed: <count>
This indicates how many chunks skipped disk saves.

F3 Debug Stats

showF3MenuStats
boolean
default:"true"
Shows generation statistics in the F3 debug screen.Disable this if you want a cleaner debug screen.

Understanding the F3 Overlay

The bottom-right corner of your screen (when F3 is open) shows real-time statistics:

Singleplayer Display

[voxy worldgen v2] running
completed: 1.2K
skipped: 45
remaining: 14.8K (2m 30s)
active: 20
rate: 98.5 c/s
voxy: enabled
  • Status Line: Shows current state
    • running: Actively generating
    • throttled (low tps): Paused due to low server TPS
    • done: All chunks in radius completed
  • completed: Successfully generated chunks
  • skipped: Already-existing chunks that didn’t need generation
  • lod suppressed: Chunks that skipped disk saves (only shown when saveNormalChunks is disabled)
  • remaining: Chunks left to generate with estimated time
  • active: Chunks currently being generated
  • rate: Generation speed in chunks per second
  • voxy: Whether Voxy integration is active

Multiplayer Display

On multiplayer servers running Voxy World Gen V2:
[voxy worldgen v2] connected
rate: 45.2 c/s
bandwidth: 2.3 MB/s
received: 3.4K (128.5 MB)
voxy: enabled
  • rate: LOD chunks received per second
  • bandwidth: Network transfer rate
  • received: Total chunks and data received from server
The mod includes a client-server protocol to synchronize LOD data in multiplayer. Players receive generated chunks automatically.

Performance Monitoring

TPS-Based Throttling

The mod automatically monitors server TPS (ticks per second):
  • TPS >= 19: Normal generation speed
  • TPS < 19: Generation pauses to avoid impacting gameplay
When throttled, the status shows:
[voxy worldgen v2] throttled (low tps)
If you frequently see throttling, consider reducing maxActiveTasks to lighten the load.
CPU: 4-6 cores, RAM: 8GB
{
  "generationRadius": 64,
  "maxActiveTasks": 5,
  "maxQueueSize": 10000
}

Working with Tellus Worlds

If you have Tellus installed, the mod automatically detects Tellus worlds and enables optimized generation.
When a Tellus world is detected, you’ll see:
[INFO] tellus world detected for minecraft:overworld, enabling fast generation
Tellus integration features:
  • Fast Generation: Bypasses vanilla chunk generator entirely
  • Direct Voxy Ingestion: Writes terrain directly into Voxy format
  • Biome-Aware Terrain: Realistic surface blocks based on biome data
  • Procedural Features: Trees and vegetation placed based on real-world data
Tellus worlds enforce a minimum generation radius of 128 chunks regardless of your config setting.

Manual Configuration

If you don’t have ModMenu, you can edit the config file directly.
1

Locate Config File

Navigate to your Minecraft directory and open:
config/voxyworldgenv2.json
The file is created automatically on first launch.
2

Edit Settings

The file uses JSON format:
config/voxyworldgenv2.json
{
  "enabled": true,
  "showF3MenuStats": true,
  "generationRadius": 128,
  "update_interval": 20,
  "maxQueueSize": 20000,
  "maxActiveTasks": 20,
  "saveNormalChunks": true
}
Edit values as needed. All settings are described in the Configuration Reference.
3

Reload Config

Changes take effect when you:
  • Restart Minecraft
  • Reload the world
  • Change any setting via ModMenu (triggers a reload)

Verifying Generation

To confirm chunks are generating correctly:
1

Check F3 Stats

Watch the completed counter increase and rate show a positive value (e.g., 50.0 c/s).
2

Verify Voxy Integration

If Voxy is installed, you should see distant terrain appear as chunks generate.Voxy’s LOD system will render these chunks at lower detail from far away.
3

Monitor Console Logs

Check the game console for any error messages.Successful operation shows minimal logging. Errors will be clearly marked with [ERROR].

Common Issues

Symptoms: rate: 0.0 c/s, active: 0, no progressSolutions:
  • Ensure enabled is true in config
  • Check if status shows throttled (low tps) - if so, server performance is too low
  • Verify you’re in a supported dimension (Overworld, Nether, End)
  • Try increasing maxActiveTasks if it’s set very low
Symptoms: rate is very low (< 10 c/s)Solutions:
  • Increase maxActiveTasks for more concurrent generation
  • Check CPU usage - if at 100%, your system may be the bottleneck
  • Reduce generationRadius to generate fewer total chunks
  • Ensure no other heavy mods are running
Symptoms: Chunks generate but no distant terrain appearsSolutions:
  • Verify Voxy is installed and enabled
  • Check F3 stats shows voxy: enabled
  • Ensure Voxy’s render distance is set high enough in video settings
  • Try reloading the world
Symptoms: Low TPS, gameplay stutteringSolutions:
  • The mod should automatically throttle when TPS < 19
  • Reduce maxActiveTasks to 10 or lower
  • Reduce generationRadius to generate fewer chunks
  • Allocate more RAM to the server

Next Steps

Configuration Reference

Learn about all available configuration options

Advanced Usage

Explore advanced features and optimization

Build docs developers (and LLMs) love