Install the editor
Install the Vastopia Editor on Windows with the installer or the portable zip, keep it updated, sign in, and point it at server and client source checkouts.
5 min read
Before you start#
The Vastopia Editor is a 64-bit Windows desktop application. It ships two ways:
| Package | File | Best for |
|---|---|---|
| Installer | VastopiaEditorSetup.exe | Most creators. Installs to Program Files, adds a Start menu entry and optional desktop shortcut, and enables in-app updates. Requires administrator rights. |
| Portable zip | Vastopia-Editor-Windows.zip | Running from a folder of your choice without installing. The editor's files sit at the root of the archive. |
Both packages contain the same editor, the bundled starter template, the terrain brush set, the MCP server binary used by AI tools, and the license text.
Install with the installer#
- Run
VastopiaEditorSetup.exe. Windows asks for administrator approval because the editor installs under Program Files. - Read and accept the end-user license agreement.
- Choose whether to create a desktop icon.
- Wait while the installer downloads the current editor package. The installer itself is small; the editor payload is fetched during setup, so you need an internet connection.
- Leave Launch Vastopia Editor checked on the final page, or start it later from the Start menu.
The default install folder is C:\Program Files\Vastopia Editor. An uninstaller is registered under Apps & features as Vastopia Editor.
Use the portable zip#
- Extract
Vastopia-Editor-Windows.zipinto any folder you can write to. - Run the editor executable at the root of that folder.
Keep the extracted files together. The editor resolves the default/ starter template, the terrain brushes and the MCP server relative to its own executable, so moving the .exe on its own breaks project creation.
Automatic updates#
Each time the installed editor starts it checks the platform for a newer release before showing the project hub. While it checks, the loading screen reads Checking for updates....
If a newer version exists, an Update Available card appears: "Vastopia Editor 1.0.x is available. You have 1.0.y."
| Button | What it does |
|---|---|
| Update Now | Downloads the installer into the editor's data folder, verifies its SHA-256 checksum against the value published by the platform, then runs it. The editor quits; the installer swaps the files and relaunches the editor. |
| Later | Skips this update and opens the project hub. You are asked again next start. |
If the download or verification fails, the card shows the reason and the button changes to Retry. When the platform marks a release as mandatory (your version is below the minimum supported), Later is hidden and you must update to continue.
Sign in#
The first screen is the sign-in card.
| Option | What it does |
|---|---|
| Sign in | Opens Vastopia's hosted sign-in page in your browser (Google, Discord or email). The editor shows "Complete sign-in in your browser..." until you return; Cancel aborts. |
| Sign in with API Key | Paste an API key into the field above the button. Keys are created on the dashboard under Account > API Keys. |
| Continue Offline | Opens the project hub without an account. You can create, edit and save projects locally. Publishing and Play Local require an account, so sign in later from the Account button in the top-right corner. |
Once signed in, your username and avatar replace the Account button in the top bar, and the project hub's Games tab lists the games on your account. A Sign Out button sits at the bottom of the hub's left rail.
Where the editor keeps things#
| Item | Location |
|---|---|
| New projects | Documents\VastopiaProjects\<Game Name>\ by default. You can pick another folder when creating a project. |
| Downloaded platform templates | The editor's data folder, under project_templates\<id>\<version>\. The bundled starter never needs downloading. |
| The playtest client used by Play Local | The editor's data folder, under downloaded_client\. See Test your game. |
| Editor settings (theme, keybinds, viewport, source checkouts) | Editor settings, shared by every project on the machine. |
Source checkouts (developers)#
Creators who clone the Vastopia-Server and Vastopia-Client repositories can wire the editor to those checkouts. This is what enables Dev Test, which compiles and runs the game server on your own machine and launches the client from source.
How the paths are found#
The editor auto-detects a sibling checkout the first time it needs one. It probes the folder next to the editor's own folder and Documents\GitHub for:
| Checkout | Folder names tried | Verified by |
|---|---|---|
| Server | Vastopia-Server\Server, Vastopia-Server, EzRealm\Server | RealmServer.csproj present |
| Client | Vastopia-Client | project.godot present |
A detected path is remembered in editor settings. A remembered path whose marker file has disappeared is treated as unset.
Set the paths by hand#
- Open Settings > Editor Settings... from the top menu bar.
- On the Editor tab, scroll to the Source Checkouts section.
- For Server project, click Browse... and choose the folder holding
RealmServer.csproj. For Client project, choose the folder holdingproject.godot. - The status label next to each field reads found or missing. Clear empties a field.
These are editor-wide settings, not project settings. When you create a project, the current paths are stamped into that project's project.vastopia under [server] project_path and [client] project_path. A single project can override them later on the Game Settings tab under Development (Server project path and Client project path).
Requirements for Dev Test#
If you intend to use Dev Test, the editor also needs:
- The .NET 8 SDK on your PATH (
dotnet --versionmust work). The editor compiles the server withdotnet buildthe first time and whenever server sources change. - A free TCP port starting at 7777; the editor picks the first free one.
Neither is needed for Play Local or for publishing.
Next step#
With the editor installed and signed in, continue to Create your first game.