Quick Start Guide

How to install, open, edit rooms, create actions, and export your first game

1. Download & Extract

Download the ZIP file and extract it anywhere on your computer. Inside the extracted folder you will find:

a .exe launcher in the main directory
a resources/app/ folder containing all engine files

The engine can be launched in two ways:

By running the .exe
By opening engine.html (recommended: Chrome)

If Windows warns you that the .exe is “unsafe”, don’t worry — it simply has no digital signature. If the .exe fails to run, just use the HTML version, which is always safe.

2. Opening the Tool

Once opened, you will see:

Right Side

JSON Editor viewport – the core of the engine
Buttons for editing rooms, actions, and exporting

Left Side

Live Preview of your game

Below the JSON panel you will also find the Export Runtime section.

Important: The JSON inside the editor must always be pure JSON (no JavaScript or comments). If you try to import JSON containing JS logic, the engine will show an error.

3. Editing the Current Room

Click Edit Room to modify the room you are currently viewing. The editor allows you to change:

Room Name
Room ID
Exits (north, south, east, west)
Log description text
Main action text
Default “scan” text

3.1 Advanced Action Fields

You can also configure the room’s main action logic:

onEnter[] – actions executed when entering the room
action.conditions[] – requirements that must be true
action.actions[] – what happens if conditions succeed
action.onFail[] – what happens if conditions fail

When done, press Create Room. The JSON will update automatically.

Use the Fullscreen button in the JSON editor for a better view, then click Apply JSON to restart and test your changes in the preview.

4. Adding a New Room

Click Add Room to create a new empty room. The same window appears, but now focus on:

Edit Room Action / Commands

This opens the Action Editor, where you can add as many commands as you want.

4.1 Types of Commands You Can Create

log: simple text output
system / error: system-style messages
set / modify flags
move to room: teleport the player to another room ID
set viewport: change the image in the viewport
end game: stops input and ends the session
local_timer: trigger an action after X seconds (advanced — avoid if you're new)

After editing, press Create Room, then Apply JSON, and test the result.

Congratulations! You have created your first custom room.

5. Exporting Your Game

When your project is ready, click Export. The engine will generate a ready-to-play ZIP containing:

index.html
style.css
engine.js
game_data.json
assets/

Open index.html to start your standalone game, or upload the whole ZIP to itch.io as an HTML game.

6. Final Notes

Take your time experimenting with rooms, flags, actions, and conditions. The editor is designed to let you build a complete interactive experience even without writing any code.

If something doesn't work, check the JSON for missing commas, invalid IDs, or non-JSON content.