Introduction
A quick and easy-to-read introduction to the engine and setup of the wiki
We are happy to see you have interest in using the Iris Dimension Engine (Iris).

VSCode

The first page you should definitely take a look at is the VSCode installation page. Thank us later.

Command System

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

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:
1
"regions": [
2
"boring-region",
3
"epic/epic-region"
4
]
Copied!
Iris supports sub-folders to around 5 deep, but you probably will never exceed 2.

Iris Studio

Apart from when using the Scripts and Objects sections, read Iris Studio since you will likely use & need it.

Missing folders

If a folder is missing when you are about to create a new element that goes 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. Below here, you find an index of the pages on this wiki.
If you want to take a full course on Iris and/or make a dimension from scratch, go through all of them in the order here. You can skip Scripts, it is only for hard-core Iris developers.
We advise you to copy the Empty dimension pack and work from there, to get a better feel for the settings.
These 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 new Command System and your newly learned VSCode auto-completions & suggestions knowledge, 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.
Good luck and, more importantly, have fun!

Open source

Last modified 24d ago