Skip to main content

Documentation Index

Fetch the complete documentation index at: https://mintlify.com/VolmitSoftware/Iris/llms.txt

Use this file to discover all available pages before exploring further.

Iris provides a public API for plugin developers to interact with Iris worlds, create new worlds, and access generation data.

​
Main Components

​
IrisToolbelt

The primary entry point for the Iris API. This class provides utility methods for working with Iris worlds. Package: com.volmit.iris.core.tools

​
Key Features

  • World Detection - Check if a world is using Iris
  • World Creation - Programmatically create new Iris worlds
  • Data Access - Access generation engines and dimension data
  • Pregeneration - Start and manage chunk pregeneration tasks
  • Player Management - Evacuate players from worlds
  • Mantle Data - Store and retrieve custom data at specific coordinates

​
Common Use Cases

​
Check if a World Uses Iris

World world = Bukkit.getWorld("myworld");
if (IrisToolbelt.isIrisWorld(world)) {
    // This is an Iris world
}

​
Access Iris Generator

PlatformChunkGenerator generator = IrisToolbelt.access(world);
if (generator != null) {
    // Access the engine
    Engine engine = generator.getEngine();
    
    // Get dimension data
    IrisDataManager data = generator.getCompound().getData();
}

​
Get Dimension Information

// Load a dimension by name or GitHub repo
IrisDimension dimension = IrisToolbelt.getDimension("overworld");

// Also supports GitHub repos:
// IrisToolbelt.getDimension("IrisDimensions/overworld")
// IrisToolbelt.getDimension("IrisDimensions/overworld/main")

​
API Stability

The public API is designed to remain stable across minor versions. Methods marked with @ApiStatus.Internal should not be used as they may change without notice.

​
Next Steps

Integration Guide

Add Iris as a dependency to your project

IrisToolbelt Reference

Complete method reference for IrisToolbelt

Build docs developers (and LLMs) love

Get started for freeTalk to us