Skip to main content
Represents an iris region. Regions are placed inside dimensions and contain biomes. Regions group biomes together and define regional placement styles, generators, and features.

​
Core Properties

​
name
string
required
The name of the regionConstraints: Minimum length 2
​
rarity
integer
default:"1"
The rarity of the regionConstraints: 1-128
​
color
string
A color for visualizing this region with a color. I.e. #F13AF5. This will show up on the map.

​
Biome Lists

​
landBiomes
array<string>
required
A list of root-level biomes in this region. Don’t specify child biomes of other biomes here. Just the root parents.Constraints: Minimum 1 item
​
seaBiomes
array<string>
required
A list of root-level sea biomes in this region. Don’t specify child biomes of other biomes here. Just the root parents.Constraints: Minimum 1 item
​
shoreBiomes
array<string>
required
A list of root-level shore biomes in this region. Don’t specify child biomes of other biomes here. Just the root parents.Constraints: Minimum 1 item
​
caveBiomes
array<string>
default:"[]"
A list of root-level cave biomes in this region. Don’t specify child biomes of other biomes here. Just the root parents.

​
Biome Zoom

​
landBiomeZoom
number
default:"1"
How large land biomes are in this regionConstraints: Minimum 0.0001
​
seaBiomeZoom
number
default:"1"
How large sea biomes are in this regionConstraints: Minimum 0.0001
​
shoreBiomeZoom
number
default:"1"
How large shore biomes are in this regionConstraints: Minimum 0.0001
​
caveBiomeZoom
number
default:"1"
How large cave biomes are in this regionConstraints: Minimum 0.0001

​
Shore Configuration

​
shoreHeightMin
number
default:"1.2"
The min shore heightConstraints: Minimum 0
​
shoreHeightMax
number
default:"3.2"
The max shore heightConstraints: Minimum 0
​
shoreHeightZoom
number
default:"3.14"
The variance of the shore heightConstraints: Minimum 0.0001

​
Fluid Bodies

​
riverStyle
IrisGeneratorStyle
default:"VASCULAR_THIN zoomed 7.77"
The style of rivers
​
lakeStyle
IrisGeneratorStyle
default:"CELLULAR_IRIS_THICK"
The style of lakes
​
fluidBodies
IrisFluidBodies
default:"{}"
Configuration of fluid bodies such as rivers & lakes

​
Objects & Placement

​
objects
array<IrisObjectPlacement>
default:"[]"
Objects define what schematics (iob files) iris will place in this region

​
World Features

​
carving
IrisCarving
default:"{}"
Carving configuration for the region (caves, ravines, etc)
​
deposits
array<IrisDepositGenerator>
default:"[]"
Define regional deposit generators that add onto the global deposit generators
​
ores
array<IrisOreGenerator>
default:"[]"
Collection of ores to be generated

​
Structures

​
jigsawStructures
array<IrisJigsawStructurePlacement>
default:"[]"
Jigsaw structures

​
Effects & Ambience

​
effects
array<IrisEffect>
default:"[]"
Effects are ambient effects such as potion effects, random sounds, or even particles around each player. All of these effects are played via packets so two players won’t see/hear each others effects. Due to performance reasons, effects will play around the player even if where the effect was played is no longer in the biome the player is in.

​
Entities

​
entitySpawners
array<string>
default:"[]"
Spawn Entities in this region over time. Iris will continually replenish these mobs just like vanilla does.

​
Loot & Block Drops

​
loot
IrisLootReference
default:"{}"
Reference loot tables in this area
​
blockDrops
array<IrisBlockDrops>
default:"[]"
Define custom block drops for this region

​
JSON Example

{
  "name": "Temperate",
  "rarity": 1,
  "color": "#4CAF50",
  "landBiomes": [
    "plains",
    "forest",
    "birch-forest"
  ],
  "seaBiomes": [
    "ocean",
    "deep-ocean"
  ],
  "shoreBiomes": [
    "beach",
    "stony-shore"
  ],
  "caveBiomes": [
    "lush-caves"
  ],
  "landBiomeZoom": 1.0,
  "seaBiomeZoom": 1.0,
  "shoreBiomeZoom": 1.0,
  "caveBiomeZoom": 1.0,
  "shoreHeightMin": 1.2,
  "shoreHeightMax": 3.2,
  "shoreHeightZoom": 3.14,
  "riverStyle": {
    "style": "VASCULAR_THIN",
    "zoom": 7.77
  },
  "lakeStyle": {
    "style": "CELLULAR_IRIS_THICK"
  },
  "objects": [],
  "ores": [],
  "deposits": []
}

Build docs developers (and LLMs) love

Get started for freeTalk to us