Introduction

A quick and easy-to-read introduction to the engine and setup of the wiki

Suggested reading

To get your Iris education going efficiently we suggest the following order of reading pages before doing anything else:

1. The first page you should definitely take a look at is the VSCode installation page.

2. The second page you should also read, is the Command System page.

3. Read Iris Studio since you will use & need it.

File storing and referencing

Referring to other files within configuration settings goes as follows:

• Project folder

  • Dimensions

    • your-dimension.json

  • Regions

    • boring-region.json

    • epic

      • epic-region.json

If you now want to add the boring-region and epic-region to your dimension regions, you set the following:

"regions": [
    "boring-region",
    "epic/epic-region"
]

Iris supports sub-folders to around 5 deep, but you probably will never exceed 2.

If a folder is missing when you are about to create a new element that should go in that folder, create it.

Structure

This section of the wiki was designed specifically such that you can find what you need quickly, while also teaching you how to teach yourself. In the left navigation bar, you find an index of the pages on this wiki.

If you are making a new dimension, we advise you to copy the Empty dimension pack and work from there, to get a better feel for the settings. You are free to use the objects from the Overworld pack as long as you do not sell the pack.

The pages are designed minimalist. This means they give you explanations of the standard tools & knowledge you need to edit things, but they are not a full mastery tutorial.

We believe that, with the Command System, your newly learned VSCode auto-completions & suggestions knowledge, and the help of our support, you can manage to learn many other features, including new ones, on your own.

Of course, whenever you are running into something you have a hard time understanding, support is always ready to lend a hand.

Open source

Iris' Overworld is open source.

Iris the Dimension Engine (plugin) is also open source.