From f4ec8d890fc2a212c89d628958ec0e8164b1e63b Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Jan=20Thom=C3=A4?= Date: Wed, 14 Feb 2024 18:46:29 +0100 Subject: [PATCH] docs: add update instructions --- manual/manual.md | 13 +++++++++++++ 1 file changed, 13 insertions(+) diff --git a/manual/manual.md b/manual/manual.md index 1d28c75..254117a 100644 --- a/manual/manual.md +++ b/manual/manual.md @@ -42,6 +42,19 @@ After you installed the plugin as described above, you may need to initialize yo > ⚠️ **Note**: the C# API is currently experimental and may change in the future. Please give it a try and let me know if you encounter any issues. +### 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](https://github.com/derkork/godot-statecharts/blob/main/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](https://github.com/derkork/godot-statecharts/releases) (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 `godot_state_charts` folder within the `addons` folder and delete the `godot_state_charts` folder with all of its contents. +- Unpack your downloaded ZIP file somewhere. Inside of the unpacked ZIP file structure, locate the `godot_state_charts` folder within the `addons` folder. +- Move `godot_state_charts` folder you located in the previous step into the `addons` folder of your project. +- The plugin is now updated. You can now open the project again in Godot and continue working on it. + ## Usage The plugin adds a new node type called _State Chart_. This node represents your state chart and is the only node that your code will directly interact with.