From dadd328eb71a110a5287c55e49efcf0f095fe8c7 Mon Sep 17 00:00:00 2001 From: Matthew Brown <60948236+Mushakushi@users.noreply.github.com> Date: Mon, 1 Apr 2024 14:03:04 -0400 Subject: [PATCH 1/9] Update README.md --- README.md | 4 ++++ 1 file changed, 4 insertions(+) diff --git a/README.md b/README.md index c6fb26b..93c4dda 100644 --- a/README.md +++ b/README.md @@ -11,6 +11,10 @@ https://github.com/Mushakushi/UIToolkitMenuFramework.git?path=Assets/Mushakushi. If you are specifying a version, append #{VERSION} to the end of the git URL. +```bash +https://github.com/Mushakushi/UIToolkitMenuFramework.git?path=Assets/Mushakushi.MenuFramework#{VERSION#} +``` + ## Usage ### Setup the Menu Controller From ba0119e9d95d350cfba48f4abe1727669d3429f0 Mon Sep 17 00:00:00 2001 From: Matthew Brown <60948236+Mushakushi@users.noreply.github.com> Date: Mon, 1 Apr 2024 14:03:18 -0400 Subject: [PATCH 2/9] Update README.md --- README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/README.md b/README.md index 93c4dda..80bbdc2 100644 --- a/README.md +++ b/README.md @@ -12,7 +12,7 @@ https://github.com/Mushakushi/UIToolkitMenuFramework.git?path=Assets/Mushakushi. If you are specifying a version, append #{VERSION} to the end of the git URL. ```bash -https://github.com/Mushakushi/UIToolkitMenuFramework.git?path=Assets/Mushakushi.MenuFramework#{VERSION#} +https://github.com/Mushakushi/UIToolkitMenuFramework.git?path=Assets/Mushakushi.MenuFramework#{VERSION} ``` ## Usage From 67c51181568e72f5b88142d92ab92f319014b222 Mon Sep 17 00:00:00 2001 From: Matthew Brown <60948236+Mushakushi@users.noreply.github.com> Date: Mon, 1 Apr 2024 14:04:45 -0400 Subject: [PATCH 3/9] Update package.json --- Assets/Mushakushi.MenuFramework/package.json | 22 ++++++++++---------- 1 file changed, 11 insertions(+), 11 deletions(-) diff --git a/Assets/Mushakushi.MenuFramework/package.json b/Assets/Mushakushi.MenuFramework/package.json index c7f829f..9a3840a 100644 --- a/Assets/Mushakushi.MenuFramework/package.json +++ b/Assets/Mushakushi.MenuFramework/package.json @@ -1,17 +1,17 @@ { - "name": "com.mushakushi.menusystem", + "name": "com.mushakushi.menuframework", "version": "1.0.0", - "displayName": "Menu System", - "description": "Menu system for Unity.", + "displayName": "Menu Framework", + "description": "A framework for expediting the creation of menus using UI toolkit. ", "unity": "2022.3", - "keywords": [ "UI", "UI Toolkit", "Input", "Framework" ], - "dependencies": { - "com.unity.ui": "1.0.0", - "com.unity.input": "1.0.0" - }, + "keywords": [ "UI Toolkit", "UI", "Input System", "Menus", "Utility" ], + "dependencies": { + "com.unity.ui": "1.0.0", + "com.unity.inputsystem": "1.7.0" + }, "author": { "name": "Mushakushi", - "email": "info@mushakushi.com", - "url": "https://www.mushakushi.com" + "email": "info@mushakushi.com", + "url": "https://www.mushakushi.com" } -} \ No newline at end of file +} From 03984420d26906926e55e330d6a492d295d71e85 Mon Sep 17 00:00:00 2001 From: Matthew Brown <60948236+Mushakushi@users.noreply.github.com> Date: Mon, 1 Apr 2024 14:05:10 -0400 Subject: [PATCH 4/9] Delete Assets/Mushakushi.MenuFramework/README.md --- Assets/Mushakushi.MenuFramework/README.md | 0 1 file changed, 0 insertions(+), 0 deletions(-) delete mode 100644 Assets/Mushakushi.MenuFramework/README.md diff --git a/Assets/Mushakushi.MenuFramework/README.md b/Assets/Mushakushi.MenuFramework/README.md deleted file mode 100644 index e69de29..0000000 From 34cc88badd0eb03402b80b646b84f4c8b0fa124c Mon Sep 17 00:00:00 2001 From: Matthew Brown <60948236+Mushakushi@users.noreply.github.com> Date: Mon, 1 Apr 2024 14:05:17 -0400 Subject: [PATCH 5/9] Delete Assets/Mushakushi.MenuFramework/README.md.meta --- Assets/Mushakushi.MenuFramework/README.md.meta | 7 ------- 1 file changed, 7 deletions(-) delete mode 100644 Assets/Mushakushi.MenuFramework/README.md.meta diff --git a/Assets/Mushakushi.MenuFramework/README.md.meta b/Assets/Mushakushi.MenuFramework/README.md.meta deleted file mode 100644 index 286f1a4..0000000 --- a/Assets/Mushakushi.MenuFramework/README.md.meta +++ /dev/null @@ -1,7 +0,0 @@ -fileFormatVersion: 2 -guid: f4549ae05b1f4aa41813b31e7684e6e7 -TextScriptImporter: - externalObjects: {} - userData: - assetBundleName: - assetBundleVariant: From de165ac7e7546fecd1b31342b5843c1c29767aa5 Mon Sep 17 00:00:00 2001 From: Matthew Brown <60948236+Mushakushi@users.noreply.github.com> Date: Mon, 1 Apr 2024 14:06:15 -0400 Subject: [PATCH 6/9] Delete Assets/Mushakushi.MenuFramework/LICENSE.md --- Assets/Mushakushi.MenuFramework/LICENSE.md | 9 --------- 1 file changed, 9 deletions(-) delete mode 100644 Assets/Mushakushi.MenuFramework/LICENSE.md diff --git a/Assets/Mushakushi.MenuFramework/LICENSE.md b/Assets/Mushakushi.MenuFramework/LICENSE.md deleted file mode 100644 index 4e07aa3..0000000 --- a/Assets/Mushakushi.MenuFramework/LICENSE.md +++ /dev/null @@ -1,9 +0,0 @@ -MIT License - -Copyright (c) 2024 Matthew Brown - -Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions: - -The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software. - -THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE. \ No newline at end of file From dc93f66f16018203902fe749d27c6d1826ff7d1b Mon Sep 17 00:00:00 2001 From: Matthew Brown <60948236+Mushakushi@users.noreply.github.com> Date: Mon, 1 Apr 2024 14:06:23 -0400 Subject: [PATCH 7/9] Delete Assets/Mushakushi.MenuFramework/LICENSE.md.meta --- Assets/Mushakushi.MenuFramework/LICENSE.md.meta | 7 ------- 1 file changed, 7 deletions(-) delete mode 100644 Assets/Mushakushi.MenuFramework/LICENSE.md.meta diff --git a/Assets/Mushakushi.MenuFramework/LICENSE.md.meta b/Assets/Mushakushi.MenuFramework/LICENSE.md.meta deleted file mode 100644 index 53e3d4f..0000000 --- a/Assets/Mushakushi.MenuFramework/LICENSE.md.meta +++ /dev/null @@ -1,7 +0,0 @@ -fileFormatVersion: 2 -guid: b41345734e830674e8a86235749338f5 -TextScriptImporter: - externalObjects: {} - userData: - assetBundleName: - assetBundleVariant: From 3bb2daac06a6a6bd7c30a280b35350b8352dbeb4 Mon Sep 17 00:00:00 2001 From: Matthew Brown <60948236+Mushakushi@users.noreply.github.com> Date: Mon, 1 Apr 2024 14:11:23 -0400 Subject: [PATCH 8/9] Update README.md --- README.md | 6 +++++- 1 file changed, 5 insertions(+), 1 deletion(-) diff --git a/README.md b/README.md index 80bbdc2..17c7305 100644 --- a/README.md +++ b/README.md @@ -15,6 +15,10 @@ If you are specifying a version, append #{VERSION} to the end of the git URL. https://github.com/Mushakushi/UIToolkitMenuFramework.git?path=Assets/Mushakushi.MenuFramework#{VERSION} ``` +When using the git URL, install the following upm dependencies: +https://openupm.com/packages/com.mackysoft.serializereference-extensions/ +https://openupm.com/packages/com.rotaryheart.serializabledictionarylite/ + ## Usage ### Setup the Menu Controller @@ -32,7 +36,7 @@ A basic setup would look something like this: ### Basic Usage Just use the `Menu Event Channel` to subscribe and invoke menu events. Example usage can be found in the [Example folder](https://github.com/Mushakushi/UIToolkitMenuFramework/tree/main/Assets/Example). -#### About Extensions +**About Extensions** An extension is some piece of code that is called when an UXML menu is attached to the Menu Controller's root document. For example, a `MenuConnectionButtonExtension` will trigger a menu to be populated on the screen based on a query, to which multiple From 3f1e13e7833b2c36a84cc45a66c013a03dbde8cc Mon Sep 17 00:00:00 2001 From: Matthew Brown <60948236+Mushakushi@users.noreply.github.com> Date: Mon, 1 Apr 2024 14:11:37 -0400 Subject: [PATCH 9/9] Update README.md --- README.md | 5 +++++ 1 file changed, 5 insertions(+) diff --git a/README.md b/README.md index 17c7305..c1de04a 100644 --- a/README.md +++ b/README.md @@ -2,7 +2,9 @@ A framework for expediting the creation of menus using UI toolkit. ## Installation + **Install via git URL** + from the Add package from git URL option, enter: ```bash @@ -16,7 +18,9 @@ https://github.com/Mushakushi/UIToolkitMenuFramework.git?path=Assets/Mushakushi. ``` When using the git URL, install the following upm dependencies: + https://openupm.com/packages/com.mackysoft.serializereference-extensions/ + https://openupm.com/packages/com.rotaryheart.serializabledictionarylite/ ## Usage @@ -37,6 +41,7 @@ A basic setup would look something like this: Just use the `Menu Event Channel` to subscribe and invoke menu events. Example usage can be found in the [Example folder](https://github.com/Mushakushi/UIToolkitMenuFramework/tree/main/Assets/Example). **About Extensions** + An extension is some piece of code that is called when an UXML menu is attached to the Menu Controller's root document. For example, a `MenuConnectionButtonExtension` will trigger a menu to be populated on the screen based on a query, to which multiple