From 90dcdddce93aa05d03a1747334f103ba8a24a188 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Matthias=20St=C3=B6ckli?= Date: Sun, 6 Aug 2017 00:25:04 +0200 Subject: [PATCH] Moved content one hierarchy higher --- README.md | 13 ++++++------- addons/{ => godot_data_editor}/class_overview.gd | 0 addons/{ => godot_data_editor}/class_overview.tscn | 0 addons/{ => godot_data_editor}/class_properties.gd | 0 .../{ => godot_data_editor}/class_properties.tscn | 0 .../{ => godot_data_editor}/custom_properties.gd | 0 .../{ => godot_data_editor}/custom_properties.tscn | 0 addons/{ => godot_data_editor}/data.gd | 0 addons/{ => godot_data_editor}/data_editor.gd | 0 addons/{ => godot_data_editor}/data_editor_gui.gd | 0 .../{ => godot_data_editor}/data_editor_gui.tscn | 0 addons/{ => godot_data_editor}/data_item.gd | 0 addons/{ => godot_data_editor}/fonts/DroidSans.ttf | Bin .../fonts/DroidSerif-Bold.ttf | Bin .../fonts/DroidSerif-BoldItalic.ttf | Bin .../fonts/DroidSerif-Italic.ttf | Bin .../fonts/droid_sans_title.tres | 0 .../fonts/droid_serif_bold.tres | 0 .../fonts/droid_serif_bolditalic.tres | 0 .../fonts/droid_serif_italic.tres | 0 addons/{ => godot_data_editor}/icons/empty.png | Bin addons/{ => godot_data_editor}/icons/gom.png | Bin addons/{ => godot_data_editor}/icons/icon_add.png | Bin addons/{ => godot_data_editor}/icons/icon_copy.png | Bin .../icons/icon_display-name.png | Bin .../icons/icon_duplicate.png | Bin addons/{ => godot_data_editor}/icons/icon_edit.png | Bin .../{ => godot_data_editor}/icons/icon_empty.png | Bin addons/{ => godot_data_editor}/icons/icon_load.png | Bin .../icons/icon_move_down.png | Bin .../{ => godot_data_editor}/icons/icon_move_up.png | Bin .../icons/icon_multi_line.png | Bin .../{ => godot_data_editor}/icons/icon_options.png | Bin .../icons/icon_reload_small.png | Bin .../{ => godot_data_editor}/icons/icon_remove.png | Bin .../{ => godot_data_editor}/icons/icon_rename.png | Bin addons/{ => godot_data_editor}/icons/icon_save.png | Bin .../{ => godot_data_editor}/icons/icon_script.png | Bin addons/{ => godot_data_editor}/input_dialog.gd | 0 addons/{ => godot_data_editor}/input_dialog.tscn | 0 addons/{ => godot_data_editor}/item_manager.gd | 0 addons/{ => godot_data_editor}/item_tree.gd | 0 addons/{ => godot_data_editor}/item_tree.tscn | 0 addons/{ => godot_data_editor}/no_classes.tscn | 0 addons/{ => godot_data_editor}/options.gd | 0 addons/{ => godot_data_editor}/options.tscn | 0 addons/{ => godot_data_editor}/plugin.cfg | 0 addons/{ => godot_data_editor}/property_item.gd | 0 addons/{ => godot_data_editor}/property_item.tscn | 0 .../{ => godot_data_editor}/screenshots/class.png | Bin .../{ => godot_data_editor}/screenshots/editor.png | Bin .../style/light_gray_panel.tres | 0 addons/{ => godot_data_editor}/warn.gd | 0 53 files changed, 6 insertions(+), 7 deletions(-) rename addons/{ => godot_data_editor}/class_overview.gd (100%) rename addons/{ => godot_data_editor}/class_overview.tscn (100%) rename addons/{ => godot_data_editor}/class_properties.gd (100%) rename addons/{ => godot_data_editor}/class_properties.tscn (100%) rename addons/{ => godot_data_editor}/custom_properties.gd (100%) rename addons/{ => godot_data_editor}/custom_properties.tscn (100%) rename addons/{ => godot_data_editor}/data.gd (100%) rename addons/{ => godot_data_editor}/data_editor.gd (100%) rename addons/{ => godot_data_editor}/data_editor_gui.gd (100%) rename addons/{ => godot_data_editor}/data_editor_gui.tscn (100%) rename addons/{ => godot_data_editor}/data_item.gd (100%) rename addons/{ => godot_data_editor}/fonts/DroidSans.ttf (100%) rename addons/{ => godot_data_editor}/fonts/DroidSerif-Bold.ttf (100%) rename addons/{ => godot_data_editor}/fonts/DroidSerif-BoldItalic.ttf (100%) rename addons/{ => godot_data_editor}/fonts/DroidSerif-Italic.ttf (100%) rename addons/{ => godot_data_editor}/fonts/droid_sans_title.tres (100%) rename addons/{ => godot_data_editor}/fonts/droid_serif_bold.tres (100%) rename addons/{ => godot_data_editor}/fonts/droid_serif_bolditalic.tres (100%) rename addons/{ => godot_data_editor}/fonts/droid_serif_italic.tres (100%) rename addons/{ => godot_data_editor}/icons/empty.png (100%) rename addons/{ => godot_data_editor}/icons/gom.png (100%) rename addons/{ => godot_data_editor}/icons/icon_add.png (100%) rename addons/{ => godot_data_editor}/icons/icon_copy.png (100%) rename addons/{ => godot_data_editor}/icons/icon_display-name.png (100%) rename addons/{ => godot_data_editor}/icons/icon_duplicate.png (100%) rename addons/{ => godot_data_editor}/icons/icon_edit.png (100%) rename addons/{ => godot_data_editor}/icons/icon_empty.png (100%) rename addons/{ => godot_data_editor}/icons/icon_load.png (100%) rename addons/{ => godot_data_editor}/icons/icon_move_down.png (100%) rename addons/{ => godot_data_editor}/icons/icon_move_up.png (100%) rename addons/{ => godot_data_editor}/icons/icon_multi_line.png (100%) rename addons/{ => godot_data_editor}/icons/icon_options.png (100%) rename addons/{ => godot_data_editor}/icons/icon_reload_small.png (100%) rename addons/{ => godot_data_editor}/icons/icon_remove.png (100%) rename addons/{ => godot_data_editor}/icons/icon_rename.png (100%) rename addons/{ => godot_data_editor}/icons/icon_save.png (100%) rename addons/{ => godot_data_editor}/icons/icon_script.png (100%) rename addons/{ => godot_data_editor}/input_dialog.gd (100%) rename addons/{ => godot_data_editor}/input_dialog.tscn (100%) rename addons/{ => godot_data_editor}/item_manager.gd (100%) rename addons/{ => godot_data_editor}/item_tree.gd (100%) rename addons/{ => godot_data_editor}/item_tree.tscn (100%) rename addons/{ => godot_data_editor}/no_classes.tscn (100%) rename addons/{ => godot_data_editor}/options.gd (100%) rename addons/{ => godot_data_editor}/options.tscn (100%) rename addons/{ => godot_data_editor}/plugin.cfg (100%) rename addons/{ => godot_data_editor}/property_item.gd (100%) rename addons/{ => godot_data_editor}/property_item.tscn (100%) rename addons/{ => godot_data_editor}/screenshots/class.png (100%) rename addons/{ => godot_data_editor}/screenshots/editor.png (100%) rename addons/{ => godot_data_editor}/style/light_gray_panel.tres (100%) rename addons/{ => godot_data_editor}/warn.gd (100%) diff --git a/README.md b/README.md index c0d1563..865a046 100644 --- a/README.md +++ b/README.md @@ -16,13 +16,12 @@ This repository hosts a plugin for the [Godot Engine]. It allows users to enter ![class_screenshot] # Installation +* Download/clone this repository * Open your project folder, e.g. "../MyGame/" -* Create a folder named "addons" (if not already present) -* In addons, create a folder named "godot_data_editor" -* Copy the content of this repository into it. You may remove the "sceenshots" ;) +* Copy the "addons" folder into your project folder * Open your project in the editor and navigate to the plugin (Scene -> Project Settings -> Plugins) * The plugin "godot_data_editor" should now appear, change the status from "Inactive" to "Active" -* Restart the editor to make sure that the _data_ singleton is loaded properly +* Restart the editor to make sure that the _data_ singleton is loaded properly. If _data_ was not added, add a [singleton] to the class "addons/godot_data_editor/data.gd". I intend to upload the plugin to the AssetLib, once I feel it is stable enough. @@ -30,8 +29,8 @@ I intend to upload the plugin to the AssetLib, once I feel it is stable enough. The plugin was written for version *2.1.3* of the Godot Engine. Upcoming minor versions should be supported as well. It is very likely that a number of changes will be necessary, once Godot 3 is released. -# API / Tutorial -I created a little video which shows how to use the plugin to create a simple shop system: [[Link to video which does not exist yet :) ]] +# API / Demo +There is a demo project available which shows how the plugin could be used in practice. Either download the file "DataEditorDemo.zip" or all content of the "demo" folder. It should be possible to simply import it. Working with data is rather simple, use the provided _data_ class to access the items. The following code snippets demonstrates item retrieval as well as the observation feature: ```gdscript @@ -101,7 +100,6 @@ Please feel free to contribute. Unfortunately, the code base still is not docume * There is no support for undo/redo * Pressing Ctrl+S will not save the data items but the current scene * The _data_ singleton is only visible in the editor when the project is being restarted. This seems to be a limitation of the engine which does not allow reload the engine.cfg file -* The "class overview" screen is lacking any kind of useful content # HALP! Something went wrong! Stay calm, most issues can be resolved by either pressing the "Reload" button or activating and deactivating the plugin. If the problem persists, there is likely an issue with your data. Check if the name of the class (which are stored in the "classes" folder by default) is the same as the folder name of your instances (by default called "data"). If this is the case, there might be a conflict with duplicate IDs or the like. Please post an issue here if this happened without any external influence (e.g. you edited the files manually in another editor). @@ -109,6 +107,7 @@ Stay calm, most issues can be resolved by either pressing the "Reload" button or [Godot Engine]: +[singleton]: [export property hints]: [editor_screenshot]: https://github.com/Stoeoeoe/godot_data_editor/blob/master/screenshots/editor.png "The Godot Data Editor" [class_screenshot]: https://github.com/Stoeoeoe/godot_data_editor/blob/master/screenshots/class.png "Example Class" \ No newline at end of file diff --git a/addons/class_overview.gd b/addons/godot_data_editor/class_overview.gd similarity index 100% rename from addons/class_overview.gd rename to addons/godot_data_editor/class_overview.gd diff --git a/addons/class_overview.tscn b/addons/godot_data_editor/class_overview.tscn similarity index 100% rename from addons/class_overview.tscn rename to addons/godot_data_editor/class_overview.tscn diff --git a/addons/class_properties.gd b/addons/godot_data_editor/class_properties.gd similarity index 100% rename from addons/class_properties.gd rename to addons/godot_data_editor/class_properties.gd diff --git a/addons/class_properties.tscn b/addons/godot_data_editor/class_properties.tscn similarity index 100% rename from addons/class_properties.tscn rename to addons/godot_data_editor/class_properties.tscn diff --git a/addons/custom_properties.gd b/addons/godot_data_editor/custom_properties.gd similarity index 100% rename from addons/custom_properties.gd rename to addons/godot_data_editor/custom_properties.gd diff --git a/addons/custom_properties.tscn b/addons/godot_data_editor/custom_properties.tscn similarity index 100% rename from addons/custom_properties.tscn rename to addons/godot_data_editor/custom_properties.tscn diff --git a/addons/data.gd b/addons/godot_data_editor/data.gd similarity index 100% rename from addons/data.gd rename to addons/godot_data_editor/data.gd diff --git a/addons/data_editor.gd b/addons/godot_data_editor/data_editor.gd similarity index 100% rename from addons/data_editor.gd rename to addons/godot_data_editor/data_editor.gd diff --git a/addons/data_editor_gui.gd b/addons/godot_data_editor/data_editor_gui.gd similarity index 100% rename from addons/data_editor_gui.gd rename to addons/godot_data_editor/data_editor_gui.gd diff --git a/addons/data_editor_gui.tscn b/addons/godot_data_editor/data_editor_gui.tscn similarity index 100% rename from addons/data_editor_gui.tscn rename to addons/godot_data_editor/data_editor_gui.tscn diff --git a/addons/data_item.gd b/addons/godot_data_editor/data_item.gd similarity index 100% rename from addons/data_item.gd rename to addons/godot_data_editor/data_item.gd diff --git a/addons/fonts/DroidSans.ttf b/addons/godot_data_editor/fonts/DroidSans.ttf similarity index 100% rename from addons/fonts/DroidSans.ttf rename to addons/godot_data_editor/fonts/DroidSans.ttf diff --git a/addons/fonts/DroidSerif-Bold.ttf b/addons/godot_data_editor/fonts/DroidSerif-Bold.ttf similarity index 100% rename from addons/fonts/DroidSerif-Bold.ttf rename to addons/godot_data_editor/fonts/DroidSerif-Bold.ttf diff --git a/addons/fonts/DroidSerif-BoldItalic.ttf b/addons/godot_data_editor/fonts/DroidSerif-BoldItalic.ttf similarity index 100% rename from addons/fonts/DroidSerif-BoldItalic.ttf rename to addons/godot_data_editor/fonts/DroidSerif-BoldItalic.ttf diff --git a/addons/fonts/DroidSerif-Italic.ttf b/addons/godot_data_editor/fonts/DroidSerif-Italic.ttf similarity index 100% rename from addons/fonts/DroidSerif-Italic.ttf rename to addons/godot_data_editor/fonts/DroidSerif-Italic.ttf diff --git a/addons/fonts/droid_sans_title.tres b/addons/godot_data_editor/fonts/droid_sans_title.tres similarity index 100% rename from addons/fonts/droid_sans_title.tres rename to addons/godot_data_editor/fonts/droid_sans_title.tres diff --git a/addons/fonts/droid_serif_bold.tres b/addons/godot_data_editor/fonts/droid_serif_bold.tres similarity index 100% rename from addons/fonts/droid_serif_bold.tres rename to addons/godot_data_editor/fonts/droid_serif_bold.tres diff --git a/addons/fonts/droid_serif_bolditalic.tres b/addons/godot_data_editor/fonts/droid_serif_bolditalic.tres similarity index 100% rename from addons/fonts/droid_serif_bolditalic.tres rename to addons/godot_data_editor/fonts/droid_serif_bolditalic.tres diff --git a/addons/fonts/droid_serif_italic.tres b/addons/godot_data_editor/fonts/droid_serif_italic.tres similarity index 100% rename from addons/fonts/droid_serif_italic.tres rename to addons/godot_data_editor/fonts/droid_serif_italic.tres diff --git a/addons/icons/empty.png b/addons/godot_data_editor/icons/empty.png similarity index 100% rename from addons/icons/empty.png rename to addons/godot_data_editor/icons/empty.png diff --git a/addons/icons/gom.png b/addons/godot_data_editor/icons/gom.png similarity index 100% rename from addons/icons/gom.png rename to addons/godot_data_editor/icons/gom.png diff --git a/addons/icons/icon_add.png b/addons/godot_data_editor/icons/icon_add.png similarity index 100% rename from addons/icons/icon_add.png rename to addons/godot_data_editor/icons/icon_add.png diff --git a/addons/icons/icon_copy.png b/addons/godot_data_editor/icons/icon_copy.png similarity index 100% rename from addons/icons/icon_copy.png rename to addons/godot_data_editor/icons/icon_copy.png diff --git a/addons/icons/icon_display-name.png b/addons/godot_data_editor/icons/icon_display-name.png similarity index 100% rename from addons/icons/icon_display-name.png rename to addons/godot_data_editor/icons/icon_display-name.png diff --git a/addons/icons/icon_duplicate.png b/addons/godot_data_editor/icons/icon_duplicate.png similarity index 100% rename from addons/icons/icon_duplicate.png rename to addons/godot_data_editor/icons/icon_duplicate.png diff --git a/addons/icons/icon_edit.png b/addons/godot_data_editor/icons/icon_edit.png similarity index 100% rename from addons/icons/icon_edit.png rename to addons/godot_data_editor/icons/icon_edit.png diff --git a/addons/icons/icon_empty.png b/addons/godot_data_editor/icons/icon_empty.png similarity index 100% rename from addons/icons/icon_empty.png rename to addons/godot_data_editor/icons/icon_empty.png diff --git a/addons/icons/icon_load.png b/addons/godot_data_editor/icons/icon_load.png similarity index 100% rename from addons/icons/icon_load.png rename to addons/godot_data_editor/icons/icon_load.png diff --git a/addons/icons/icon_move_down.png b/addons/godot_data_editor/icons/icon_move_down.png similarity index 100% rename from addons/icons/icon_move_down.png rename to addons/godot_data_editor/icons/icon_move_down.png diff --git a/addons/icons/icon_move_up.png b/addons/godot_data_editor/icons/icon_move_up.png similarity index 100% rename from addons/icons/icon_move_up.png rename to addons/godot_data_editor/icons/icon_move_up.png diff --git a/addons/icons/icon_multi_line.png b/addons/godot_data_editor/icons/icon_multi_line.png similarity index 100% rename from addons/icons/icon_multi_line.png rename to addons/godot_data_editor/icons/icon_multi_line.png diff --git a/addons/icons/icon_options.png b/addons/godot_data_editor/icons/icon_options.png similarity index 100% rename from addons/icons/icon_options.png rename to addons/godot_data_editor/icons/icon_options.png diff --git a/addons/icons/icon_reload_small.png b/addons/godot_data_editor/icons/icon_reload_small.png similarity index 100% rename from addons/icons/icon_reload_small.png rename to addons/godot_data_editor/icons/icon_reload_small.png diff --git a/addons/icons/icon_remove.png b/addons/godot_data_editor/icons/icon_remove.png similarity index 100% rename from addons/icons/icon_remove.png rename to addons/godot_data_editor/icons/icon_remove.png diff --git a/addons/icons/icon_rename.png b/addons/godot_data_editor/icons/icon_rename.png similarity index 100% rename from addons/icons/icon_rename.png rename to addons/godot_data_editor/icons/icon_rename.png diff --git a/addons/icons/icon_save.png b/addons/godot_data_editor/icons/icon_save.png similarity index 100% rename from addons/icons/icon_save.png rename to addons/godot_data_editor/icons/icon_save.png diff --git a/addons/icons/icon_script.png b/addons/godot_data_editor/icons/icon_script.png similarity index 100% rename from addons/icons/icon_script.png rename to addons/godot_data_editor/icons/icon_script.png diff --git a/addons/input_dialog.gd b/addons/godot_data_editor/input_dialog.gd similarity index 100% rename from addons/input_dialog.gd rename to addons/godot_data_editor/input_dialog.gd diff --git a/addons/input_dialog.tscn b/addons/godot_data_editor/input_dialog.tscn similarity index 100% rename from addons/input_dialog.tscn rename to addons/godot_data_editor/input_dialog.tscn diff --git a/addons/item_manager.gd b/addons/godot_data_editor/item_manager.gd similarity index 100% rename from addons/item_manager.gd rename to addons/godot_data_editor/item_manager.gd diff --git a/addons/item_tree.gd b/addons/godot_data_editor/item_tree.gd similarity index 100% rename from addons/item_tree.gd rename to addons/godot_data_editor/item_tree.gd diff --git a/addons/item_tree.tscn b/addons/godot_data_editor/item_tree.tscn similarity index 100% rename from addons/item_tree.tscn rename to addons/godot_data_editor/item_tree.tscn diff --git a/addons/no_classes.tscn b/addons/godot_data_editor/no_classes.tscn similarity index 100% rename from addons/no_classes.tscn rename to addons/godot_data_editor/no_classes.tscn diff --git a/addons/options.gd b/addons/godot_data_editor/options.gd similarity index 100% rename from addons/options.gd rename to addons/godot_data_editor/options.gd diff --git a/addons/options.tscn b/addons/godot_data_editor/options.tscn similarity index 100% rename from addons/options.tscn rename to addons/godot_data_editor/options.tscn diff --git a/addons/plugin.cfg b/addons/godot_data_editor/plugin.cfg similarity index 100% rename from addons/plugin.cfg rename to addons/godot_data_editor/plugin.cfg diff --git a/addons/property_item.gd b/addons/godot_data_editor/property_item.gd similarity index 100% rename from addons/property_item.gd rename to addons/godot_data_editor/property_item.gd diff --git a/addons/property_item.tscn b/addons/godot_data_editor/property_item.tscn similarity index 100% rename from addons/property_item.tscn rename to addons/godot_data_editor/property_item.tscn diff --git a/addons/screenshots/class.png b/addons/godot_data_editor/screenshots/class.png similarity index 100% rename from addons/screenshots/class.png rename to addons/godot_data_editor/screenshots/class.png diff --git a/addons/screenshots/editor.png b/addons/godot_data_editor/screenshots/editor.png similarity index 100% rename from addons/screenshots/editor.png rename to addons/godot_data_editor/screenshots/editor.png diff --git a/addons/style/light_gray_panel.tres b/addons/godot_data_editor/style/light_gray_panel.tres similarity index 100% rename from addons/style/light_gray_panel.tres rename to addons/godot_data_editor/style/light_gray_panel.tres diff --git a/addons/warn.gd b/addons/godot_data_editor/warn.gd similarity index 100% rename from addons/warn.gd rename to addons/godot_data_editor/warn.gd