Installation and Updates
Table of contents
- Requirements
- Installation with the Godot Asset Library
- Manual installation
- Updating from an earlier version
Requirements
This plugin requires Godot 4.2.0 or later. Earlier versions of Godot 4 will not work because the plugin uses features that were introduced only in Godot 4.2.0. Godot 3 is not supported.
Installation with the Godot Asset Library
The easiest way to install the plugin is to use the Godot Asset Library. Search for “G.U.I.D.E” and install the plugin. You can exclude the guide_examples
folder if you don’t need the examples.
Manual installation
You can also download a ZIP file of this repository and extract it, then copy the addons/guide
folder into your project’s addons
folder.
After you installed it, make sure you enable the plugin in the project settings:
Updating from an earlier version
The asset library currently has no support for plugin updates, therefore in order to update the plugin, perform the following steps:
- Be sure you have a backup of your project or have it under version control, so you can go back in case things don’t work out as intended.
- Check the CHANGES.md for any breaking changes that might impact your project and any special update instructions.
- Download the version you want to install from the Release List (use the Source Code ZIP link).
- Close Godot. It’s important to not have the project opened while running the update.
- In your project locate the
guide
folder within theaddons
folder and delete theguide
folder with all of its contents. - Unpack your downloaded ZIP file somewhere. Inside of the unpacked ZIP file structure, locate the
guide
folder within theaddons
folder. - Move the
guide
folder you located in the previous step into theaddons
folder of your project. - The plugin is now updated. You can now open the project again in Godot and continue working on it.