在 Windows、macOS 和 Linux 上使用命令行管理 Godot 版本和插件。
[![Chickensoft Badge][chickensoft-badge]][chickensoft-website] [][discord]
GodotEnv is a command-line tool that makes it easy to switch between Godot versions and manage addons in your projects.
GodotEnv can do the following:
GODOT environment variable that always points to the active version of Godot.addons.json file. No more fighting with git submodules! Just run godotenv addons install whenever your addons.json file changes..gitignore, addons.json, and addons/.editorconfig in your project to make it easy to manage addons.GodotEnv is a .NET command line tool that runs on Windows, macOS, and Linux.
dotnet tool install --global Chickensoft.GodotEnvIf you encounter the error No NuGet sources are defined or enabled, add a Nuget source or enable one and try installing GodotEnv again.
List the current sources and see which are enabled.
dotnet nuget list sourceIf no sources are listed, add a new one.
dotnet nuget add source https://api.nuget.org/v3/index.json -n nuget.orgOtherwise, make sure one is enabled.
dotnet nuget enable source GodotEnv uses the local git installation and other processes available from the shell, so make sure you've installed git and [configured your local shell environment][ssh-github] correctly.
[!NOTE] Windows Users
Certain operations may require administrator privileges, such as managing symlinks or editing certain files. GodotEnv should prompt you in these cases for your approval, and certain operations will cause a command line window to pop open for a moment before disappearing — this is normal.
In some cases, enabling Developer Mode may be required for GodotEnv to correctly manage symlinks.
We'll walk through the commands in depth below, but if you prefer to get started right away you can use the --help flag with any command to get more information.
# Overall help
godotenv --help
# Help for entire categories of commands
godotenv godot --help
godotenv addons --help
# Help for a specific godot management command
godotenv godot install --help
# etc...GodotEnv can automatically manage Godot versions on your local machine for you.
♀️ Using GodotEnv to install Godot works best for local development. If you want to install Godot directly on a GitHub actions runner for CI/CD purposes, consider using Chickensoft's [setup-godot] action — it caches Godot installations between runs, installs the Godot export templates, and also works on Windows, macOS, and Ubuntu GitHub runners.
To get started managing Godot versions with GodotEnv, you'll need to first instruct GodotEnv to install a version of Godot.
godotenv godot install 4.0.1
# or a non-stable version:
godotenv godot install 4.1.1-rc.1Versions should match the format of the versions shown on the [GodotSharp nuget package][godot-sharp-nuget]. Downloads are made from [GitHub Release Builds][github-release-downloads].
By default, GodotEnv installs .NET-enabled versions of Godot.
If you really must install the boring, non-.NET version of Godot, you may do so .
godotenv godot install 4.0.1 --no-dotnetWhen installing a version of Godot, GodotEnv performs the following steps:
GODOT environment variable points to the active Godot version symlink.[!IMPORTANT] To run Godot, simply type
$GODOTin a shell to execute the active version of Godot. The Godot executable should also be in your path after restarting your shell.Windows users: the first time you install Godot, you may need to log out and log back in on Windows for the
$GODOTvariable to be picked up by your shell and other applications.
GodotEnv can show you a list of the Godot versions you have installed.
godotenv godot listWhich might produce something like the following, depending on what you have installed:
4.0.1
4.0.1 *dotnet
4.1.1-rc.1
4.1.1-rc.1 *dotnetGodotEnv also supports showing a list of remote Godot versions available to install using the -r option.
godotenv godot list -rYou can change the active version of Godot by instructing GodotEnv to update the symlink to one of the installed versions. By default, it only looks for the .NET-enabled version of Godot. To use a non-.NET version of Godot, specify --no-dotnet.
# uses dotnet version
godotenv godot use 4.0.1
# uses non-dotnet version
godotenv godot use 4.0.1 --no-dotnetYou may want to install or use the version of Godot that is appropriate for the project you're currently working on. GodotEnv can infer the correct version for your project from files in your directory tree. To do so, run the godot install or godot use commands without a version argument:
# installs version inferred from project files
godotenv godot install
# uses version inferred from project files
godotenv godot useGodotEnv will walk up the directory tree and use the following files, in order of precedence:
global.json specifying a Godot.NET.Sdk value in msbuild-sdks.*.csproj specifying a versioned Godot.NET.Sdk as its Project SDK..godotrc with a Godot version string as its first line.A global.json file at any directory level above the working directory will take precedence over all csproj files, even those closer to the working directory; likewise, any csproj file in the tree will take precedence over all .godotrc files. Files of the same type that are fewer steps up the directory tree will take precedence over ones that are further up the tree.
Versions from global.json or a csproj file are assumed to be .NET-enabled. A .godotrc file may specify a non-.NET Godot by appending a space and the string no-dotnet to the version string. For instance, a .godotrc file containing the value 4.0.1 no-dotnet indicates the non-.NET version of Godot 4.0.1.
[!IMPORTANT] Remember to run
godotenv godot installandgodotenv godot useas necessary after setting up or modifying a version file, and whenever returning to your project from some other project that may have used a different Godot version.
To enable the version-free godotenv godot install and godotenv godot use commands without hand-authoring a version-specifying file for your project, you can use the godotenv godot pin command. This command will locate the top-level directory of your project and place a version-specifying file in it, indicating your active Godot version as the preferred version for the project.
sln files, the command will use the topmost directory containing a sln file.sln files, the command will use the topmost directory containing a project.godot file.Godot.NET.Sdk value in an existing global.json in the top-level project directory, or create a new global.json with the value if one does not exist..godotrc file in the top-level project directory, overwriting any existing .godotrc file in that location.Once the version-specifying file is created or updated with the preferred Godot version, you can commit it to source control for use by others on your team.
Uninstalling works the same way as installing and switching versions does.
# uninstalls .NET version
godotenv godot uninstall 4.0.1
# uninstalls non-dotnet version
godotenv godot uninstall 4.0.1 --no-dotnetGodotEnv can provide the path to the symlink that always points to the active version of Godot.
godotenv godot env pathGodotEnv will provide you with the path to the active version of Godot that the symlink it uses is currently pointing to.
godotenv godot env targetYou can use GodotEnv to set the GODOT user environment variable to the symlink that always points to the active version of Godot.
# Set the GODOT environment variable to the symlink that GodotEnv maintains.
godotenv godot env setup
# Print the value of the GODOT environment variable.
godotenv godot env getOn Windows, this adds the
GODOTenvironment variable to the current user's environment variable config.On macOS, this adds the
GODOTenvironment variable to the current user's default shell configuration file. In case the user's shell isn't compatible, defaults tozsh.On Linux, this adds the
GODOTenvironment variable to the current user's default shell configuration file. In case the user's shell isn't compatible, defaults tobash.After making changes to environment variables on any system, be sure to close any open terminals and open a new one to ensure the changes are picked up. If changes are not picked up across other applications, you may have to log out and log back in. Fortunately, since the environment variable points to a symlink which points to the active Godot version, you only have to do this once! Afterwards, you are free to switch Godot versions without any further headache as often as you like.
GodotEnv caches the Godot installation zip archives it downloads in a cache folder. You can ask GodotEnv to clear the cache folder for you.
godotenv godot cache clearGodotEnv allows you to install [Godot addons][asset-library]. A Godot addon is a collection of Godot assets and/or scripts that can be copied into a project. [By convention][godot-addons-structure], these are stored in a folder named addons relative to your Godot project. Check out the [Dialogue Manager][godot-dialogue-manager] addon to see how a Godot addon itself is structured.
Besides copying addons from remote git repositories or zip files, GodotEnv allows you to install addons from a local git repository or symlink to local directories on your machine so that you can use an addon across multiple Godot projects while it is still in development.
Using GodotEnv to manage addons can prevent some of the headaches that occur when using git submodules or manually managing symlinks.
Additionally, GodotEnv will check for accidental modifications made to addo
暂无开放 Issues,或尚未同步最近议题。