From beab81a3cb31ee886bbc4e781865529df11dc8d9 Mon Sep 17 00:00:00 2001 From: Feo Wu Date: Thu, 9 May 2024 14:42:38 +0800 Subject: [PATCH] chores: update docs about installation --- README.md | 10 ++++++++++ 1 file changed, 10 insertions(+) diff --git a/README.md b/README.md index a1fd6b1..d16bf83 100644 --- a/README.md +++ b/README.md @@ -58,12 +58,16 @@ Since Panku Console is modular, you can easily remove or add features to suit yo # Installation 🚀 +## A. Downloading GitHub `master` branch directly + 1. Download [Latest commit](https://github.com/Ark2000/PankuConsole/archive/refs/heads/master.zip) from Github 📥. 2. Copy the `addons` folder to your project root directory 📂. 3. Enable this addon within the Godot settings ⚙️: `Project > Project Settings > Plugins` +## B. Using mirror repo as git submodule + Or if you prefer to use git(recommended), you can add this [mirror repo](https://github.com/Ark2000/panku_console) as a submodule in your addons folder which will automatically update the addon when you pull the latest changes 🔄. ```bash @@ -72,6 +76,12 @@ cd addons git submodule add https://github.com/Ark2000/panku_console ``` +## C. Downloading from [Godot Asset Library](https://godotengine.org/asset-library/asset/1558) + +Which is the same as downloading `godot4_asset_library` branch (always points to latest stable release version and only contains `addons` folder) + +--- + For more information about plugin installation, you can visit the corresponding [Godot documentation 📚](https://docs.godotengine.org/en/stable/tutorials/plugins/editor/installing_plugins.html). > **Note**: Panku Console currently only supports Godot version 4.x, 3.x support is still in progress.