Installation
There are two ways to install Ziva in your Godot project: automatic installation using our installer script, or manual installation like any other Godot plugin.
Automatic Installation (Recommended)
The automatic installer is a script that will guide you through the installation process and let you select which Godot project you want to install Ziva into.
Close the target project in Godot before running the installer.
Linux / macOS
Open your terminal and run:
curl -fsSL https://ziva.sh/install.sh | bashWindows
Open PowerShell and run:
irm https://ziva.sh/install.ps1 | iexThe installer will:
- Download the latest version of Ziva
- Let you select which Godot project to install into
- Automatically set up the plugin in your project
- Open your project in Godot with the Ziva panel when Launch Godot when complete is checked (the default)
Once the installer opens your project, no additional restart is needed. If you uncheck the launch option, open the project in Godot yourself.
Choose a project in the installer
Select Existing project to search recent projects, paste a project folder path, or use Browse. Select New project to choose a name and an empty folder.
Under Installation, you can choose a specific Ziva version or turn off Launch Godot when complete. Leave Advanced options at their defaults unless you need to change how Godot is downloaded or launched.
The installer needs no Ziva account or paid plan. It downloads Ziva and, when needed, Godot; it does not upload your project source files. See our Privacy Policy.
If installation fails, follow the error message and select Try again. For more help, see installation troubleshooting.
Manual Installation
Alternatively, you can download and install Ziva manually like any other Godot plugin.
These steps are for a first-time installation. To replace an existing Ziva installation, close Godot before copying the replacement files, then reopen your project to load the new version. See the Update Guide for the full update steps.
Step 1: Download the Plugin
Download the zip of the latest plugin version from the download page or from GitHub releases .
Step 2: Open Godot
Open your project in Godot and create an addons folder. If you don’t already have one.
Step 3: Extract and Copy the plugin
Extract the downloaded zip file, and copy the addons/ziva_agent folder to your project’s addons folder.
In the end, you should see addons/ziva_agent in the Godot FileSystem.
Step 4: Switch Back to Godot
Switch back to the Godot editor and wait for the Ziva panel to finish loading. A first-time installation does not require a restart. If the panel doesn’t appear, restart Godot.
Troubleshooting
If you don’t see the Ziva panel after following these steps:
- Try restarting Godot completely - Close Godot and reopen your project if the panel doesn’t appear
- Check the Godot console for any error messages - Look in the Output tab for any red error messages
- Verify the folder structure - Make sure you have
addons/ziva_agent/ziva_agent.gdextensionin your project - Check your Godot version - Ziva requires Godot 4.2 or later
Finding the sign-in page
Open https://ziva.sh/login directly to create an account or sign in. Sign-in pages are intentionally excluded from search results; this does not prevent you from using them.
Still having issues?
- Join our Discord for community support and help from other users
- Post an issue on GitHub if you’ve found a bug or need technical assistance
System Requirements
- Godot Version: 4.2 or later
- Operating Systems: Windows, macOS, or Linux
- Internet Connection: Required for AI features
Next Steps
Once installed, you’re ready to start using Ziva!
Sign Up and Start Free
When you create your Ziva account, you’ll start on the free Hobby tier with access to all core features. This gives you a great opportunity to try AI-powered game development before upgrading to a paid plan.
Visit ziva.sh to sign up and start building!
For more information, check out the documentation to learn how to use the AI agent in your projects.