Search
K
Links

Getting Started

A quick start to get you generating Iris worlds in no-time!
Iris is version Dependent. That means X.X.X-1.19.2 only runs on 1.19.2 Servers and not on other Minecraft versions, like 1.19.3!
This tutorial was made using Purpur. We strongly recommend using it. Paper is also supported. Spigot is supported, but lacks some key features, especially in terms of performance. Please use paper or a fork of paper for all the beautiful features!
Iris updates are released frequently. Unlike most plugins, updating Iris may cause more issues than that it resolves.
In general, you should only update the plugin or pack when you are ready to create a new world, and delete old ones.
This means that if you want to update your server to a new Minecraft version, it is usually a good idea to uninstall Iris and just use the world as it is currently pregenerated, with a border around it (since any further chunks will no longer be Iris)
Do not use Aikar's flags with Iris, especially while pre-generating. Care to know why? Ask in our Discord.

Preparation

Of course, only use the latest Iris version available for your server version.
  • Start the server.
  • Wait. Iris will restart the server to install the pack. You may need to manually start it again.
  • Make sure it all went right, by reading above the Iris logo in the console, and making sure the number of loaded Custom Biomes is at least 70. This number can vary, but less is likely a problem.

Creating new Worlds

Simple! Run /iris create

Replacing your Main World

  1. 1.
    Stop the server
  2. 2.
    Navigate to the folder of your main world (usually just the world folder)
  3. 3.
    Move the datapacks folder from that folder -> to the folder with the name of the world you created with /iris create
  4. 4.
    Next, open your server.properties file and search for level-name=world
  5. 5.
    Replace world with the name of your Iris world (where you just moved the datapacks folder to)
  6. 6.
    If you want to keep your current end or nether, you need to rename the world_nether and world_the_end folders to be newname_nether and newname_the_end (replacing newname with the name of the world you created with /iris create). Otherwise, a new nether and end will be generated.
  7. 7.
    Start the server

Accessing the World

There are multiple options to access and manage worlds. We suggest Essentials or MyWorlds.
Multiverse is not supported. Multiverse uses outdated methods to initialize worlds, and does not allow developers to run code before initializing the world, which is in conflict with the way Iris has to generate worlds. MyWorlds is our suggested alternative.

Prefabs

If you are having issues setting up your worlds, we provide a server prefab for 1.19.2 with Iris. For both options, it is required to install Iris 2.3.9-1.19.2 before you start the server.

Support

We offer support on our Discord. You can ask questions there if you run into an error, for example, and want to know how to fix it. Thank you for using Iris!
  • The Volmit Software Team