goome docs

Rider

The goome plugin

jetbrains-goome works in Rider, CLion, IntelliJ IDEA and PyCharm, 2024.3 or newer. Its on the JetBrains Marketplace as goome (io.github.goomeui.goome): Settings > Plugins > Marketplace, search goome, Install.

Or install it from disk: grab jetbrains-goome-x.y.z.zip from the releases, dont unzip it, then Settings > Plugins > gear > Install Plugin from Disk and restart.

The tool window 0.5. The goome icon on the left stripe, right by Project. It has:

The rest:

The preview needs JCEF, which every JetBrains IDE has unless you turned it off. Settings are in Settings > Tools > goome.

The plugin only needs the base platform, so it should load in RustRover, GoLand and WebStorm too, just without templates for those languages. Nobody tried that yet.

C# in Rider

Rider can open CMake projects but for C just use CLion.

Open csharp-goome

  1. Build the native lib once: ./build.sh in the csharp-goome folder (Git Bash with mingw gcc on Windows, or ./build.sh win from Linux).
  2. File > Open, csharp-goome.sln.
  3. Hello, Grab and UiDemo run configs are already there.

Your own project

  1. File > New Solution, Console, .NET 8 or newer.
  2. Add goome:
    • right click the project, Manage NuGet Packages, search GoomeSharp on nuget.org and install it
    • or from a csharp-goome clone, right click the solution, Add > Existing Project, src/GoomeSharp/GoomeSharp.csproj, then reference it from your app
  3. Paste the overlay from Getting started in C# into Program.cs and run.

Add GOOME_BACKEND=test and GOOME_TEST_SHOTS=shots/ to the run config’s environment to get every frame as a .ppm in shots/ without touching your screen (Testing without a screen).

Debugging

Rider only debugs the managed side. For the C side build the native lib with CC="gcc -g" ./build.sh and attach gdb or lldb next to Rider.

If something breaks

DllNotFoundException is almost always the native lib never getting built. It gets copied from runtimes/<rid>/native/ on build, so run build.sh then rebuild. GOOME_NATIVE points it at another folder.

On a Mac its Rider that macOS asks about for grabs and hotkeys (details).