Docs

Getting started

Install Hexaliz Engine, let it set up its runtimes, and make a first project you can play.

Install on Windows

  1. Download the Windows x64 installer (.exe) from the download page.
  2. Run it. It installs for your Windows user account and sets up Microsoft WebView2 if it is missing. If SmartScreen says “Windows protected your PC”, select More info, then Run anyway.
  3. Open Hexaliz. The first launch downloads Hexaliz’s own Python and Node runtimes, so stay online until setup completes.

Settings, generated assets, downloaded models and runtimes live in %USERPROFILE%\.hexaliz. Uninstalling keeps that folder and your projects.

Install on Linux

One AppImage for 64-bit x86 Linux. It needs a Vulkan or OpenGL graphics driver; Mesa’s software renderers work on machines without a GPU.

  1. Download the .AppImage from the download page.
  2. Check for missing system packages. This prints what is missing and the matching apt command:
    shell
    chmod +x HexalizEngine_*_x86_64.AppImage
    ./HexalizEngine_*_x86_64.AppImage --check-system
  3. Run the AppImage. The first launch installs the app and sets up its runtimes (stay online):
    shell
    ./HexalizEngine_*_x86_64.AppImage
    Without FUSE, run it with APPIMAGE_EXTRACT_AND_RUN=1 in front.

Where it goes

  • The app installs to ~/.local/share/hexaliz-engine/app and gets a menu entry.
  • The hexaliz command is linked at ~/.local/bin/hexaliz (add ~/.local/bin to your PATH if your shell lacks it).
  • Your data (settings, generated assets, models, runtimes) lives in ~/.hexaliz.
  • Updates replace the AppImage file; the next launch installs the new version.

Uninstall

shell
./HexalizEngine_*_x86_64.AppImage --uninstall

This removes the install, the hexaliz link and the menu entry. It keeps ~/.hexaliz and your projects; delete that folder yourself only if you no longer need it.

Your first project

  1. Choose File → New Project, pick a parent folder and a name.
  2. Pick a starting point: Blank project (camera, ground and a cube), Game + system stubs (adds Python component and system stubs) or one of the editable sample games, and a scene.
  3. The project opens in Game Mode. Press Play to run it, and Stop to return to editing.

From a terminal, the same project is one command:

shell
hexaliz project init --path ~/games/sky-raid --template game

A project is ordinary files: project.toml, assets/scenes/scene.toml (the scene), scripts/main.pyand an assets/ folder. New projects also get a .cursor/mcp.json, so Cursor can use Hexaliz’s tools in that folder (see Connect your AI IDE).

Hexaliz also opens existing projects as they are: web games, Godot projects and games with their own run command. Use File → Open Folder; nothing is converted.

AI generation

Image, audio, video and 3D generation run locally or in the cloud, and you choose which. Local models download from inside the app the first time you pick one, together with the runtime packages they need; see local AI model downloads. Cloud generation uses your own provider key or a Hexaliz plan (pricing).