chore: add README

README.md

@@ -0,0 +1,107 @@
+# Godot Plugin Updater
+
+[![License](https://img.shields.io/github/license/myyk/godot-plugin-updater)](https://github.com/myyk/godot-plugin-updater/blob/main/LICENSE)
+[![GitHub release badge](https://badgen.net/github/release/myyk/godot-plugin-updater/stable)](https://github.com/myyk/godot-plugin-updater/releases/latest)
+
+Godot Plugin Updater a Godot plugin for Godot plugin makers to give their plugins an easy in-editor updating. 
+
+## Why was this made?
+
+Publishing new versions of your plugin to the Godot Asset library is slow and not easily automated. There's also no official or mature dependency management system for Godot. There are a few plugins that use similar updating approaches but their update mechanisms aren't easily reusable by other plugin makers.
+
+There is a [proposal (#8451)](https://github.com/godotengine/godot-proposals/issues/8451) to solve this missing of functionality in Godot, but it is understandably difficult to pick a solution because there are a lot of trade-offs.
+
+Having no obligation to make everyone happy, this tool was made to solve the pain for some projects with simple needs. 
+
+## Features
+
+* Small amount of code to integrate into your project.
+* Shows the release diff in the editor if there's an update available.
+* godot-plugin-updater can easily be updated in the editor through itself.
+* Uses semantic versioning.
+
+## How does it work?
+
+The plugin installs the updater into your plugin under a folder it creates: `res://asset/<your_plugin>/generated/updater`
+
+This code must be supplied with your release.
+
+## Installation
+
+### Create
+
+It's not necessary to create this config before installing the plugin, but you will have to deactivate/reactivate your plugin after creating it.
+
+In the root of your project create a file called `plugin-updater.json`. (It should be here `"res://plugin-updater.json"`)
+
+It needs these settings:
+
+```
+{
+	"plugin_name": "your_plugin_director_name",
+	"github_repo": "user_or_org/your_plugin_repo_name",
+	"editor_plugin_meta": "PluginYourPluginNameEditorPlugin"
+}
+```
+
+### Install the plugin
+
+You can install it via the Asset Library or [downloading a copy](https://github.com/myyk/godot-plugin-updater/archive/refs/heads/main.zip) from GitHub.
+
+### Edit your main plugin script
+
+In your main plugin script that extends `EditorPlugin` you need to add the update panel that will check for updates and show them to the user when available. Replace `YourEditorPlugin` with what you put into `editor_plugin_meta` and `your_plugin` with what you put in `plugin_name`
+
+    func _enter_tree():
+        Engine.set_meta("YourEditorPlugin", self)
+        var update_tool: Node = load("res://addons/your_plugin/generated/updater/download_update_panel.tscn").instantiate()
+        Engine.get_main_loop().root.call_deferred("add_child", update_tool)
+
+    func _exit_tree():
+        if Engine.has_meta("YourEditorPlugin"):
+            Engine.remove_meta("YourEditorPlugin")
+
+## plugin-updater.json
+
+### Parameters
+
+#### plugin_name
+
+This needs to exactly match your plugin name in `res://addons/`.
+
+Required, Type: String
+
+#### github_repo
+
+This needs to exactly match your github repo name. Ex: This project is `myyk/godot-plugin-updater`
+
+Required, Type: String
+
+#### editor_plugin_meta
+
+This needs to be any unique string to identify your plugin vs another that may also be using the godot-update-plugin.
+
+Required, Type: String
+
+#### secs_before_check_for_update
+
+The amount of time after editor startup before the plugin check for updates.
+
+Optional, Type: Float, Default: 5
+
+## Special Thanks
+
+This project heavily borrowed code and design from [MikeSchulze/gdUnit4](https://github.com/MikeSchulze/gdUnit4). Thank you for you're awesome testing tool!
+
+There was more code taken from [nathanhoad/godot_dialogue_manager](https://github.com/nathanhoad/godot_dialogue_manager) and his video https://www.youtube.com/watch?v=oepTYOMoMmc explaining how to build that was helpful too! This is also a great plugin to check out for Character Dialogs!
+
+## Requirements
+
+* Your project is in a public Github repo.
+
+* You use Semantic Versioning tags like: v1.2.3.
+
+* Godot Plugin Updater **requires at least Godot 4.0**.
+
+## License
+This project is licensed under the terms of the [MIT license](https://github.com/myyk/godot-plugin-updater/blob/main/LICENSE).

addons/plugin_updater/core/download_update_panel.gd

@@ -4,7 +4,6 @@ extends Window
 ## Updater heaviliy inspired by GDUnit4's updater, but decoupled completely from GDUnit. Also did not
 ## include all the patching that included since it seemed to complicated to include for most projects.
 
-#TODO: read this from somewhere
 var config = UpdaterConfig.get_user_config()
 
 var spinner_icon = "res://addons/%s/generated/updater/spinner.tres" % config.plugin_name
@@ -29,6 +28,7 @@ func _ready():
 	hide()
 	_http_client.github_repo = config.github_repo
 
+	title = "%s Plugin Update" % config.plugin_name
 	var plugin :EditorPlugin = Engine.get_meta(config.editor_plugin_meta)
 
 	# wait a bit to allow the editor to initialize itself
@@ -43,7 +43,7 @@ func _check_for_updater():
 		return
 	var latest_version := extract_latest_version(response)
 	var current_version := extract_current_version()
-	
+
 	# if same version exit here no update need
 	if latest_version.is_greater(current_version):
 		_download_zip_url = extract_zip_url(response)

addons/plugin_updater/plugin_updater.gd

@@ -2,6 +2,7 @@
 extends EditorPlugin
 
 const UpdaterConfig = preload("res://addons/plugin_updater/core/updater_config.gd")
+const DEBUG_MODE = false
 
 func _enter_tree():
 	var config = UpdaterConfig.get_repo_config()
@@ -51,14 +52,16 @@ func _recursive_copy(from: String, to: String, chmod_flags: int = -1) -> Error:
 		var file_name = from_dir.get_next()
 		while file_name != "":
 			if from_dir.current_is_dir():
-				print("Copying directory: " + file_name)
+				if DEBUG_MODE:
+					print("Copying directory: " + file_name)
 				if !to_dir.dir_exists(file_name):
 					to_dir.make_dir(file_name)
 				var err = _recursive_copy(from+file_name+"/", to+file_name+"/")
 				if err != OK:
 					return err
 			else:
-				print("Copying file: %s -> %s" % [from+file_name, to+file_name])
+				if DEBUG_MODE:
+					print("Copying file: %s -> %s" % [from+file_name, to+file_name])
 				var err = DirAccess.copy_absolute(from+file_name, to+file_name)
 				if err != OK:
 					return err