Skip to main content

goome

🪄 goome-cli 🪄

goome new makes you a new goome project, already named and ready to build. C, C#, Python, Java, Godot, Rust, Node, Go, Zig or Lua.

Python 3.8+ one file GPL-3.0

It grabs one of the goome app templates from GitHub, puts your name in everywhere and tells you how to run it. Its one Python file with nothing to install besides Python itself.

Do you like this project? If so, please let me know! Discord

Docs  ·  goome  ·  Examples

To see goome before you start, the ready made apps are on the examples release.
Questions go in Discussions, and the good first issues on c-goome are small ones if you want to help.

goome new my-overlay --lang python
cd my-overlay
pip install -r requirements.txt
python main.py
⬇️ Get It ⬇️
pipx install goome-cli
goome --version

Its on PyPI as goome-cli, and the command it gives you is goome. pipx keeps it away from your other Python stuff, pip install goome-cli works too.
Not the same as pip install goome, that one is python-goome, the library.

Or skip installing and just download the file, it runs the same way:

curl -fsSL -o goome.py https://raw.githubusercontent.com/goome-ui/goome-cli/main/goome.py
python goome.py new my-app --lang c

On windows thats irm https://raw.githubusercontent.com/goome-ui/goome-cli/main/goome.py -OutFile goome.py in powershell, then python goome.py new ....

For a certain version use pip install goome-cli==0.5.4, or put the tag after an @ to get it from git, like pip install git+https://github.com/goome-ui/goome-cli@v0.5.4.

🚀 How To Use 🚀
goome new <name> --lang c|csharp|python|java|godot|rust|node|go|zig|lua [--template app|overlay|mod-menu|hud]
goome list
goome update [--check]
goome --version

--lang - which language, theres a template repo for each one
--template - which starting point, app if you leave it out
--dir - the folder to make it in, the name if you leave it out
--ref - a branch, tag or commit of the template repo
--from - a template folder or .tar.gz you already have, nothing gets downloaded

The templates:

app - a normal window, and a toggle that turns it into an overlay
overlay - a see-through overlay, only the window takes clicks
mod-menu - a menu over the game, a hotkey opens and closes it
hud - a little info panel in the corner, clicks go straight through it

It downloads the template that matches this version of goome-cli, and the newest one on main if theres no tag for it yet.
The name can be anything with letters and numbers. cool hud turns into "Cool Hud" in titles, cool-hud for the binary, CoolHud for the C# project and coolhud for the Java package.
It wont touch a folder that already has stuff in it.

goome update updates goome-cli. If you installed it with pip or pipx it runs the right upgrade for that, if its the loose goome.py it downloads the newest one from the releases and swaps itself, keeping the old one as goome.py.bak. --check only prints the newest version. About once a day it says on stderr when a new version is out, GOOME_NO_UPDATE_CHECK=1 turns that off.

🌐 Run It In The Browser 🌐
goome build --web [file.c] [--out web] [--goome DIR] [--ref REF] [--more a.c b.c]
goome serve [web] [--port 8000] [--bind 127.0.0.1]

Compiles a goome C app to webassembly and puts a page around it. You get index.html, goome.js and goome.wasm in the out folder, drop it on any static host.

file.c - your app, main.c or src/main.c if you leave it out
--out - where it goes, web if you leave it out
--goome - a c-goome checkout to build with, otherwise it looks next to your app and then downloads one
--ref - a branch or tag of c-goome to download
--more - more .c files that belong to the app

You need clang with the wasm32 target and wasm-ld (sudo apt install clang lld, brew install llvm lld, winget install LLVM.LLVM) and bash. It says so if they are missing, CLANG and WASM_LD point it at ones in odd places.

Only apps work, a normal window, since the page is the window. Overlays and mod menus get an error that says why, and the app has no title bar of its own in the page. The loop in main has to be split in goome_web_init and goome_web_frame, a browser cant wait inside a loop. The details and the two examples are in wasm/web.

🧩 The Templates 🧩

Each one is a normal GitHub template repo too, so Use this template works without the cli:

goome-app-template-c
goome-app-template-csharp
goome-app-template-python
goome-app-template-java
goome-app-template-godot
goome-app-template-rust
goome-app-template-node
goome-app-template-go
goome-app-template-zig
goome-app-template-lua

The other starting points live in variants/ in each one, the cli copies the one you picked over the app.

🛠 Pull Requests 🛠

Want to help with goome-cli? Make A pull request to dev!
It has to stay one file and only use what comes with Python. Template fixes go to the template repos.

As long as it works, and doesnt vary off too far from the main idea its very likely it get accepted!
Read CONTRIBUTING.md before you send one.

⚖️ License ⚖️

goome-cli is under the GPL-3.0.

• You can use it, change it and share it
• If you share something made with it, you have to share your source too, under the same license
• Keep the credits


In short: play fair, keep it open, and give credit where it's due.

🩷 Donate 🩷

Ko-fi (Preferred)
Patreon
Throne

🫶 Contributors 🫶
Thanks to everyone who helped out!

contributors

Metadata

Release files for goome-cli 0.5.4

For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.

Source distribution (sdist)

Source distribution for goome-cli 0.5.4
File Size Uploaded Provenance Actions
goome_cli-0.5.4.tar.gz 23.8 kB With provenance Details for goome_cli-0.5.4.tar.gz

Built distribution (wheel)

Table of built distributions (wheels) for goome-cli 0.5.4
File Interpreter ABI Platform Actions
goome_cli-0.5.4-py3-none-any.whl Python 3 none any Details for goome_cli-0.5.4-py3-none-any.whl

Total release size: 48.3 kB

Release files / goome_cli-0.5.4.tar.gz

Download URL goome_cli-0.5.4.tar.gz
Size 23.8 kB
Tags Source
SHA-256 checksum
How to use checksums
9b613454a3c9097a4d2188261b2d2886c4041950601676d290ac3bb6ab1663d7
BLAKE2b-256 checksum
How to use checksums
38c310755e26bded1c29aace68b3c2662d6d21de73e0963ce70b3e3fde318a15
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
Yes
Uploaded via twine/7.0.0 CPython/3.13.16

Provenance

Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.

PyPI Publish Attestation

PyPI verified that this artifact, at this checksum, originated from the publisher listed below.

Signed by GitHub Actions, verified by PyPI on Nov 17, 2026.

Transparency log

Release files / goome_cli-0.5.4-py3-none-any.whl

Download URL goome_cli-0.5.4-py3-none-any.whl
Size 24.5 kB
Tags Python 3
SHA-256 checksum
How to use checksums
7078b5e14e95546a0371c4589371bad28e0dbf6822f93031245b0c934811d306
BLAKE2b-256 checksum
How to use checksums
ab3eb89154ee7270ad99f892c894fe026f77f6e3b60a5d045e2e6210995d00a1
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
Yes
Uploaded via twine/7.0.0 CPython/3.13.16

Provenance

Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.

PyPI Publish Attestation

PyPI verified that this artifact, at this checksum, originated from the publisher listed below.

Signed by GitHub Actions, verified by PyPI on Nov 17, 2026.

Transparency log

Security for goome-cli 0.5.4

Provenance

Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.

Full provenance

Both files in this release have been uploaded with provenance metadata.

Select from 2 files

Attestation for goome_cli-0.5.4.tar.gz

PyPI Publish Attestation

PyPI verified that this artifact, at this checksum, originated from the publisher listed below.

Signed by GitHub Actions, verified by PyPI on Nov 17, 2026.

Transparency log

A note on package security

PyPI is a repository for distributing packages, not a service for auditing them. While third-party security researchers and our staff do their best to detect and remove malicious packages, PyPI cannot guarantee the quality, security or suitability of any given package.

To learn more about protecting yourself from malicious actors, visit our package security documentation.

Release history Release notifications | RSS feed

This release

0.5.4 This release

2 release files Full provenance

Anthropic, PBC Visionary sponsor Bloomberg Visionary sponsor Hudson River Trading Visionary sponsor Meta Visionary sponsor NVIDIA Visionary sponsor Microsoft Sustainability sponsor Depot Continuous Integration AWS Cloud computing and Security Sponsor Datadog Monitoring Fastly CDN Google Download Analytics Sentry Error logging StatusPage Status page