# README
Godot Engine Version Manager (gevm) - README
Welcome to the repository for Godot Engine Version Manager! This tool is built using Go and InnoSetup. It allows for the downloading of Godot Engine from it's godot-builds repository via the terminal. We use it as part of our CI/CD pipeline for game development. It can also be used for personal use but we would recommend Godots for that case.
Table of Contents
Installation
Windows
- Download the latest installer from the latest release page here.
- Run the installer.
- Follow the on screen instructions.
Linux
You can use the very basic helper install script to download and install the Linux binary:
curl -o- https://raw.githubusercontent.com/bashidogames/gevm/master/install.sh | bash
You will need to make sure ~/.local/bin
is in your PATH
environment variable.
Manual
Alternatively you can download the binary and use it manually:
- Download the
zip
file for your system from the release page. - Extract the binary to a location of your choosing.
- Add location to your
PATH
environment variable.
Usage
Below is some very basic usage for the more common commands. You can use gevm --help
to get a full list of commands.
versions
Use the list
command for listing available stable versions for your platform:
gevm versions list --mono --all
Flag | Description |
---|---|
--mono | List the mono versions instead. |
--all | Also list non-stable releases. |
godot
Install a version of godot using the install
command:
gevm godot install 4.3 --include-export-templates --release beta1 --mono --application --desktop
Flag | Description |
---|---|
--include-export-templates | Additionally download and install the export templates for this version. |
--release | Specify a non-stable release to use. |
--mono | Use the mono version. |
--application | Attempt to create an application shortcut (start menu, app menu, etc). |
--desktop | Attempt to create a desktop shortcut. |
Uninstall a version by using the uninstall
command:
gevm godot uninstall 4.3
settings
There are configuration settings you can change such where to put installed versions. Use the list
command to list all the settings you can change and their current values:
gevm settings list
You can then change any of these settings by using the set
command:
gevm settings set godot-root-directory <path>
cache
This tool uses a download cache to making reinstalling versions quicker. You may want to free up space by using the clear
command:
gevm cache clear
Uninstallation
The uninstallation process will not remove any installed versions or cached downloads so you may want to that first to free up space:
gevm godot list
gevm godot uninstall x.x.x.x
...
gevm cache clear
Windows
- Open
Settings -> Apps -> Installed Apps
or search forAdd or remove programs
in the start menu. - Look for
Godot Engine Version Manager (gevm)
and uninstall. - Follow the on screen instructions.
Linux
You can uninstall on Linux by just removing the binary:
rm -f ~/.local/bin/gevm
Contributing
See contributing for more details.
License
This project is licensed under the MIT License.