-
-
Notifications
You must be signed in to change notification settings - Fork 33
Getting Started
This page walks you through installing GodotHub, the first-run setup, and what to do once everything is configured.
Download the .msi or .exe installer from the releases page, or install with winget:
winget install Ryko.GodotHubTo update a winget install later:
winget upgrade Ryko.GodotHubWinget can lag behind the latest release, since the package update isn't always merged right away. If you want the newest version, download it from the releases page instead.
Download the .dmg or .app bundle from the releases page.
Download the .deb, .AppImage, or .rpm package from the releases page.
Two things to know about Linux:
- The AppImage doesn't work on most distros right now. It's an upstream
linuxdeployissue that affects nearly all Tauri apps, so it can't be fixed from this project. Use the.debor.rpminstead where possible. - GodotHub is currently tested on Windows, Arch Linux (Hyprland) / Fedora KDE 44, and the newest macOS. Other distros are untested. If you hit a problem on yours, please open an issue.
Prerequisites:
| Dependency | Purpose |
|---|---|
| Bun >= 1.0 | JavaScript runtime and package manager |
| Rust (latest stable) | Backend compilation |
| Tauri 2 prerequisites | Platform-specific build tools |
git clone https://github.com/RykoTheDev/godothub.git
cd godothub
bun install
# Development mode with hot-reload
bun tauri dev
# Production build
bun tauri buildThe built app ends up in src-tauri/target/release/bundle/.
When GodotHub starts for the first time, the onboarding wizard walks you through the basic setup. You can skip any step and configure it later from Settings.
| Step | What it asks |
|---|---|
| Welcome | A quick overview of what GodotHub does. |
| Projects | Add folders GodotHub should scan for existing Godot projects. Star one to make it the default save location for new projects. |
| Godot versions | Add folders that contain installed Godot executables. Star one to set it as the download location for new versions. |
| Templates | Optionally set a folder of reusable project templates. Any subfolder inside it is imported as a template. |
| Categories | Set up folders for organizing your project list, or skip and manage them later. |
| Customize | Pick an accent color, background color, and corner radius to start. |
| Setting up | GodotHub scans your chosen folders and finishes. |
You can reopen the wizard anytime from Settings → Advanced → Run Setup Wizard Again. Settings you already saved are kept, and you can skip any step you don't need to change.
- Projects: import existing Godot projects or create new ones, pin favorites, and organize them with categories and tags.
- Versions: browse and download official Godot builds, or import executables you already have.
- Templates: save any project as a template and start new projects from it.
- Asset Store: install assets from the old Asset Library or the new Asset Store straight into a project or template.
- Git: clone, commit, push, and manage branches for any project from inside the app.
- Appearance: switch to the Custom CSS in the New UI page when you want to restyle things the built-in settings can't.
GodotHub Wiki
- Home · Getting Started · Keyboard Shortcuts · Settings Reference · Custom CSS in the New UI · FAQ / Troubleshooting
Community
GodotHub is not affiliated with the Godot Engine project.