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. The library itself needs nothing but libc, you still need a C compiler to build with it from C, and Go, Rust, Node and Lua compile it for you on install (C#, Java and the Python wheels ship it prebuilt). What CI has and hasnt run is on Where it works and Compare, the CI machines are Ubuntu 24.04, Windows Server 2025 and macOS 15 / 26.
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.
What changed lately
The newest is 0.5.3 for the bindings, and 0.5.4 for goome-cli. Everything that came in a version has a little 0.5-style tag next to it in the menu and on the page, and Versions lists what each release added.
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, tested on LuaJIT which is what LÖVE runs 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, on PyPI (pipx install goome-cli) 0.5.3 |
| 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.