goome docs

goome docs

Try it in your browser 0.5.2, a game and an app made with goome, running right here.

See-through overlays, normal app windows, game mod menus and engine ui for any C program. One file, no dependencies, Linux, Windows, Mac. Hotkeys, screen grabs, fonts, images and a UI kit are in there too.

One header (goome.h), nothing to link. Linux (X11 and Wayland), Windows 10 / 11 and macOS 14+, from C, C#, Python, Java, Rust, Node, Go, Zig or Lua. Theres a Godot addon and an OBS plugin too.

Getting going

Overlay on top of everything. The default:

goome *g = goome_open(&(goome_opts){.title = "my overlay"}, NULL);

More in Overlay mode.

A normal app 0.2. Resizable window with the UI kit in it:

goome *g = goome_open_app("My app", 960, 640, NULL);

Same call in the bindings: Goome.OpenApp in C#, goome.open_app in Python, Goome.openApp or new App in Java, goome::App::new in Rust, new goome.App in Node, goome.NewApp in Go, Goome.openApp in Zig and goome.app in Lua. Window mode has the rest.

Inside Unity, Godot or another engine 0.2. No OS window, goome draws into a buffer and your engine shows it as a texture:

goome *g = goome_open(&(goome_opts){.mode = GOOME_MODE_OFFSCREEN, .width = 640, .height = 400}, NULL);

See Offscreen mode. For Unity there’s a page. Godot doesnt need any of this by hand, its one node.

Full programs are on Getting started in C, C#, Python, Java, Rust, Node, Go, Zig and Lua. Or skip the setup with goome new, see Templates and goome new 0.4.

The UI builder 0.3 lets you drag widgets around and copy out C, C#, Python, Java, GDScript, Rust, Node, Go, Zig or Lua. Its preview runs real goome now 0.5.

0.5.2

Goome apps run in the browser now, and you can try two of them. goome build --web main.c compiles one to webassembly and goome serve tries it on localhost, no emscripten. The builder exports Rust, Node, Go, Zig and Lua too, and goome_ui_app has a GOOME_WINDOW_NO_TITLEBAR flag.

0.5

The languages and accessibility update, anything with 0.5 on it came here.

And a GNOME fix: an overlay that showed up before it had any hit rects never took clicks, which is also why clicks died after a hotkey brought a hidden overlay back. Both work now.

0.4

The getting started update, anything with 0.4 on it came here. Theres four apps you can just download and use, a template repo for every language, and goome new to make a project from one with your name already in it. The Compare page puts goome next to the other UI libraries, from Dear ImGui to Electron. Discussions and good first issues are on now too, if you want to ask something or help out.

0.3

The mods and customization update, anything with 0.3 on it came here. goome works from Java now, see Getting started in Java, and theres a Godot addon, see Getting started in Godot. It also goes inside games now, on renderer backends, platform backends, native DLL mods, Unity mods, Minecraft, Godot and other engines, with taking input from the game to keep clicks away from it. On the UI side theres custom widgets and the style stack, icons and skins, change anything for config and keys, simple themes, password inputs, reading back a frame and the UI builder.

0.2

Anything with 0.2 on it came here. Mainly window mode, offscreen mode, and a lot more UI kit: menus, modals, toasts, tables, trees, a text editor, plots, split panes and drag and drop. That starts at App mode and menus.

The repos

Repo What it is
c-goome the C library, everything else is built on it
csharp-goome C# bindings for .NET 8
python-goome Python bindings over ctypes
java-goome Java bindings and the Minecraft mods
godot-goome goome as a Godot 4.4+ addon
rust-goome Rust crates, goome and goome-sys, on crates.io 0.5
node-goome a Node N-API addon with TypeScript types 0.5
go-goome Go bindings over cgo 0.5
zig-goome a Zig package 0.5
lua-goome a Lua 5.4 / LuaJIT module, works in LÖVE 0.5
obs-goome the OBS Studio plugin 0.5
vscode-goome the VS Code extension
jetbrains-goome the plugin for Rider, CLion, IntelliJ IDEA and PyCharm
examples bigger example apps, one folder each, and the downloadable apps
goome-cli goome new, makes a project from a template
goome-app-template-* a starting app for each language
docs this site

Found something wrong, open an issue or a PR on the docs repo.