goome

Versions

The getting started pages get you the newest goome. If you want one exact version instead, so it doesnt change under you, this is how.

Version Whats in it
0.5.4 goome-cli only, a newer cli on PyPI, everything else stays at 0.5.3
0.5.3 every binding was released at 0.5.3. Drawing is the same on newer gcc now (FMA contraction used to change pixels, CMake builds hash identical to the reference), the modal width clamp, the browser demos, and the benchmark and verify tooling on the Compare page is in the release. The VS Code extension stays at 0.5.2
0.5.2 goome apps run in the browser (goome build --web), the builder exports Rust, Node, Go, Zig and Lua, the GOOME_WINDOW_NO_TITLEBAR flag. Every binding was updated to c-goome 0.5.2
0.5.1 fixed install steps: Python, C# and Java come from PyPI, NuGet and Maven Central, Node and Lua from their release files, the editor plugins from their marketplaces, plus a Windows installer for the OBS plugin
0.5 Rust, Node, Go, Zig and Lua, animations, emoji and RTL, IME, screen readers, the OBS plugin, real goome in the builder, the GNOME late hit rect fix
0.4 apps to download, template repos and goome new, the Compare page, Discussions and good first issues
0.3 the mods and customization update: Java and Godot, goome inside games, custom widgets, icons and skins, simple themes, the UI builder
0.2 window mode and offscreen mode, Unity, menus, modals, tables, trees, a text editor, plots and drag and drop
0.1 the first one: overlay mode, drawing, the ui kit basics, screen capture and hotkeys, from C, C# and Python

Pages and functions that came in 0.2, 0.3, 0.4 or 0.5 have a little 0.2, 0.3, 0.4 or 0.5 next to them, so if you stay on an older version skip those. The commands below use the newest one, swap in the one you want.

What each version brought

0.5.4

goome-cli 0.5.4 is out, the rest stays at 0.5.3.

0.5.3

Every binding is at 0.5.3. Drawing is the same on newer gcc now, FMA contraction used to change pixels and CMake builds hash identical to the reference, and modals dont get wider than the window. The browser demos and the benchmark and verify tooling from Compare are in the release.

goome-cli is on PyPI now, pipx install goome-cli and you have goome. goome update keeps it current and it says when a newer one is out, GOOME_NO_UPDATE_CHECK=1 turns that off. More on Templates and goome new.

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.

C

Linux or Mac, put the version on the end:

curl -fsSL https://raw.githubusercontent.com/goome-ui/c-goome/main/get.sh | sh -s 0.5.3
curl -fsSL https://raw.githubusercontent.com/goome-ui/c-goome/main/get.sh | GOOME_VERSION=0.5.3 sh

Windows, in PowerShell:

& ([scriptblock]::Create((irm https://raw.githubusercontent.com/goome-ui/c-goome/main/get.ps1))) -Version 0.5.3

If you already have the script, its just ./get.sh 0.5.3, GOOME_VERSION=0.5.3 ./get.sh or .\get.ps1 -Version 0.5.3. Without a version it gets the newest release.

Or download goome.h for that version straight from the releases:

https://github.com/goome-ui/c-goome/releases/download/v0.5.3/goome.h

Theres also goome-backends-0.5.3.zip there (from 0.3.0 on), thats the backends/ folder for mods.

C

NuGet has 0.4.0 and up, and the same package is on the release too:

dotnet add package GoomeSharp --version 0.5.3

For 0.2.0 and 0.3.0 grab the .nupkg from the releases, it has the native lib for every OS inside, and add it from a folder:

mkdir goome-pkgs
curl -fsSL -o goome-pkgs/GoomeSharp.0.3.0.nupkg https://github.com/goome-ui/csharp-goome/releases/download/v0.3.0/GoomeSharp.0.3.0.nupkg
dotnet add package GoomeSharp --version 0.3.0 --source ./goome-pkgs

Unity

The package is there from 0.2.0 on. Add package from git URL, with the tag on the end:

https://github.com/goome-ui/csharp-goome.git?path=/unity/com.goome-ui.goome#v0.5.3

Or grab com.goome-ui.goome-0.5.3.tgz from the 0.5.3 release and use Add package from tarball.

Python

PyPI has 0.4.0 and up:

pip install goome==0.5.3

Older ones come from the tag, that builds the lib with your C compiler:

pip install git+https://github.com/goome-ui/[email protected]

Java

Java starts at 0.3.0. Maven Central has 0.4.0 and up:

dependencies {
    implementation 'io.github.goome-ui:goome:0.5.3'
}

For 0.3.0 download goome-0.3.0.jar from the release, it has the native lib for every OS inside, and use implementation files('libs/goome-0.3.0.jar').

The rest of the Gradle and Maven setup is on Getting started in Java. Every release has goome-fabric-<version>.jar and goome-neoforge-<version>.jar too, those are the Minecraft mods.

Godot

Godot starts at 0.3.0. Download godot-goome-0.5.3.zip from the release and unzip it into your project, you get res://addons/goome/ with the libs for every OS in bin/.

Rust

Rust starts at 0.5.0 and is on crates.io, so goome = "0.5" is all you need. For one exact version put the tag on the git dependency:

[dependencies]
goome = { git = "https://github.com/goome-ui/rust-goome", tag = "v0.5.3" }

Node

Node starts at 0.5.0. Its not on npm, install the package from the release, it has the addon built already:

npm install https://github.com/goome-ui/node-goome/releases/download/v0.5.3/goome-0.5.3.tgz

Or from git with the tag after a #, that builds the addon with node-gyp:

npm install github:goome-ui/node-goome#v0.5.3

Go

Go starts at 0.5.0:

go get github.com/goome-ui/[email protected]

Zig

Zig starts at 0.5.0. The tag goes after the #:

zig fetch --save git+https://github.com/goome-ui/zig-goome#v0.5.3

Or the tarball from the release, it ends up with the same hash:

zig fetch --save https://github.com/goome-ui/zig-goome/releases/download/v0.5.3/zig-goome-0.5.3.tar.gz

For 0.5.3 build.zig.zon gets .hash = "goome-0.5.3-JM4gI7miFwD5fDN7M_WUseh3Y6LFk1kTDdz7xjhUU9b5", if yours says something else you got a different version.

Lua

Lua starts at 0.5.0. Its not on luarocks.org, LuaRocks takes the rock from the release:

luarocks install https://github.com/goome-ui/lua-goome/releases/download/v0.5.3/goome-0.5.3-1.src.rock

OBS

The plugin starts at 0.5.0. Every file is on the 0.5.3 release, with the version in the name like obs-goome-0.5.3-windows-x64.zip. From 0.5.1 Windows also gets obs-goome-0.5.3-windows-x64-installer.exe. Install steps are on the OBS plugin page.

goome new

The cli is there from 0.4.0 on, and on PyPI from 0.5.3:

pipx install goome-cli==0.5.4

Older ones come from git:

pip install git+https://github.com/goome-ui/[email protected]

Or the one file from the release, then python goome.py new my-app --lang c.

Templates

The templates pin one goome version each, the template README says where. goome new --ref v0.5.0 gets the template from that tag. The templates are not on the 0.5.3 bindings yet, they still pin 0.5.2 or older, so a project from goome new can be a version behind what this page lists.

How the bindings stay up to date

Every binding repo has a little workflow, update-native.yml, that checks once a day if c-goome has a newer release. If it does it opens a PR that re-vendors the new goome.h (and the libs where a repo has them). I look at it, merge it and tag the binding, so a new c-goome shows up in the bindings in a day or two instead of whenever i remember. If you want to help, those PRs are fine to review too.

Which version do I have

Where How
C GOOME_VERSION in goome.h, a string like "0.5.3"
C# Goome.Version
Python goome.VERSION, or goome.__version__
Java Goome.VERSION
Unity the version next to goome in the Package Manager
Godot version in addons/goome/plugin.cfg
Rust goome::VERSION
Node goome.VERSION
Go goome.Version
Zig goome.version
Lua goome.VERSION
goome-cli goome --version
OBS Help > Log Files, the plugin says its version when OBS loads it

Edit this page on GitHub