Skip to content
Download
Gobu guide

Getting started

Gobu Engine is a game engine forked from Godot. It keeps the actor tree and most of the API, but changes the way you work:

  • Its own language, Grost (see The Grost language).
  • Documents with embedded code: scenes, prefabs and UIs (chapter 2).
  • Managers for game flow: changing scenes, spawning entities, showing UIs, playing sounds (chapter 3).
  • Physics with Box2D and Box3D, Enhanced Input–style input and its own renderer on top of bgfx.
  • An MCP server so an AI assistant can work inside the editor (chapter 10).

Each version is on the releases page with two ways to get the Windows editor:

  • gobu-setup-windows.exe, the installer. It installs Gobu for your user, without administrator rights, in %LOCALAPPDATA%\Programs\Gobu, with a Start menu entry and an uninstaller.
  • gobu-editor-windows.zip, the same editor to unzip in any folder you can write to.

Either way the editor tells you when a newer version is out and updates itself. The export templates of each platform are installed from the editor when you need them (Install Module…, see chapter 9).

When Gobu starts you see the project manager: the list of your projects, each one tagged 2d or 3d. From there you create a new project, import an existing one or open one from the list.

When you create a project you choose whether it is 2D or 3D:

  • 2D: optimized for 2D games and applications; uses 2D physics and rendering by default.
  • 3D: optimized for 3D games; uses 3D physics and rendering by default. Meant for first-person, third-person and 3D simulations.

The choice is stored in the project setting application/config/is_2d_project (when it’s missing, the project counts as 2D). It decides which modules the editor loads: a 2D project doesn’t list Spatial3D-derived actors when creating actors, and a 3D project doesn’t list Spatial2D ones. The viewport’s select mode is also only the one for the project’s type.

Project Settings > Application > Config with Is 2D Project turned on

Folder or fileWhat it holds
project.gobuThe project settings
resources/Your assets: scenes, prefabs, textures, sounds, scripts. This is res://
plugins/The project’s plugins, a folder each. It lives outside resources/, but is reached as res://plugins/...
config/Project configuration, also outside resources/ (res://config/...)
.cache/Data the editor generates; no need to put it under version control

So res://player.prefab is the file <project>/resources/player.prefab. In the files panel the plugins folder is shown on its own, as a top-level “Plugins” folder.

The Assets panel: res:// holds the folders of resources/, and Plugins is shown on its own

The editor’s run bar launches the game. You can run the project’s main scene (run/main_scene) or the scene you are editing. What the game prints (print, errors) shows up in the Output tab of the Debugger (chapter 1).

The run bar in the viewport header, and the Debugger's Output tab with a line the game printed

If a document’s code has a syntax error, the game doesn’t run it and the error shows up in Output.

If you get stuck, ask in the Gobu Discord: open a thread in #help, or report a bug in #bugs.