A quick tutorial on how to setup a locally hosted server using Purpur, which you can use to easily edit Iris packs. You need this over a hosted server to be able to use VSCode autocompletions, GUI-bas
For this tutorial we will use Purpur. You will need to download the latest 1.17 version.
You will also need the latest version of Iris, which you can download from spigot.
You will also need to create some files with some edits, as follows:
Create a new folder anywhere on your pc (not in the downloads folder), and give it any name you like. We will create the server in this folder
Move the downloaded purpur.jar file into that folder (it has a different name when you download it, rename it to purpur.jar)
Create a new folder inside that folder called plugins, and put the downloaded iris.jar file into that folder (you do not have to rename that file)
Create a file in the folder called eula.txt, open it and enter eula=true
Create a file in the folder called run.txt, open it and enter the following:
Save all files and rename the run.txt file to run.bat.
You can now run your server by double-clicking the run.bat file.
Your server will reboot once, because Iris needs to do that. You may have to start your server back up manually if it does not automatically start up again.
You can join your server from your Minecraft client (which you have to run on the same network as the PC on which you run the server, e.g. the PC itself).
You join the server by going to multiplayer, clicking direct connection, entering localhost as address, and clicking join server.
Make sure everything went right by doing /iris version. If that command works, you are good to go!
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
Iris has strong VSCode integration to help you develop Dimensions quickly and easily. All you need to know is in there.
One of the best tools of Iris, probably the single most important one, is VSCode's Auto-completions & Descriptions feature
Start by taking Microsoft's installing VSCode for windows tutorial. They also feature tutorials for macOS and Linux. These tutorials take 5 minutes.
To verify your installation is set-up such that you can continue with the rest of the Engine tutorials:
Start your server (must be localhost, so on your pc. Setup Guide Here)
Download the "empty" dimension with /iris studio download empty
Open the VSCode editor with /iris studio vscode empty
The single most important thing to remember is using ctrl + space anywhere in a file. It shows you all auto-completions possible at that position. Press the up & down arrow keys to navigate through them and show descriptions.
The second most important is that you can hover your mouse over any variable for a description / explanation of that variable.
Note how the title of the window contains (Workspace). If your window does not show this, you have opened the folder, instead of the workspace.
If you have openend the folder, you will have no autocompletions or tooltips, so make sure to open the pack with /iris studio vscode (localhost only)!
If you can do all those steps without trouble, you are good to go! If you find yourself stuck at any point in this tutorial, contact support.
You continue the main tutorial by reading Studio.
<Video will be added here>
