-
Notifications
You must be signed in to change notification settings - Fork 0
Getting started
To get started using Realm Renderer, download the latest version here.
When you open the app you will be presented with the map selection screen.
Here you can open a map or create a new one by clicking the New button.
When you create a new map it will be created with a few folders for audio and images by default.

After creating or opening you map, you can start editing it. You can add images to your level by adding them via the files dock at the bottom of the app. After that, you can select an image from the dock to add it to the canvas. Right-click or press escape to deselect the previously selected image.
Tip
You can import images with the correct grid size by adding @<gridsize>pps to the back of the filename. EG map@120pps.png.
To manipulate an image, you start by double clicking it to select it or you can select it in the outliner on the left side of the app.
The image will get highlighted on the canvas and in the outliner to indicate that you have selected it.

After selecting the image, you can move it by dragging it across the canvas.
Tip
You can hold down ctrl to snap the image to the grid while dragging.
Rotating can be done by holding down shift and scrolling up or down.
From the outliner you can hide images from the players or lock them so you can't move them accidentally. The last one is especially handy for the main map image.
You can add notes to your level by adding them via the files dock at the bottom of the app. After that, you can select a note from the dock to add it to the canvas.
Right-click or press escape to deselect the previously selected image.
To read the note, you need to lock it from the outliner, after this clicking on the note will open a popup with it's contents. You can drag this popup around the canvas to place it anywhere you want.

To activate the Player's view, open the session menu in the top-left, and click on Player's view in the drop-down menu. After this, you will be prompted to select the display you want to use as your Player's view.

After enabling the Player's view, it will be opened full-screen on the selected display, but not show any content. This is because the Player's visibility is disabled by default. To show the map to your players click on the Player's view visibility button in the session menu.
Now that your players can see the map, you have a few tools at your disposal to change what they see. You can move the Player's view by clicking and dragging the header of the preview. When you click on the gear icon in the Player's view top-right corner a few buttons will appear allowing you to change the following:
- Horizontal scale (drag or scroll the bottom slider)
- Vertical scale (drag or scroll the right slider)
- Player's desk (drag inside the Player's view)
- Player's desk color (Pick a color using the color picker in the bottom-right corner)
