Skip to content

Commit

Permalink
Browse files Browse the repository at this point in the history
  • Loading branch information
Matthew Brown committed Apr 2, 2024
2 parents aa4fb27 + 3f1e13e commit 82902ac
Show file tree
Hide file tree
Showing 6 changed files with 25 additions and 35 deletions.
9 changes: 0 additions & 9 deletions Assets/Mushakushi.MenuFramework/LICENSE.md

This file was deleted.

7 changes: 0 additions & 7 deletions Assets/Mushakushi.MenuFramework/LICENSE.md.meta

This file was deleted.

Empty file.
7 changes: 0 additions & 7 deletions Assets/Mushakushi.MenuFramework/README.md.meta

This file was deleted.

22 changes: 11 additions & 11 deletions Assets/Mushakushi.MenuFramework/package.json
Original file line number Diff line number Diff line change
@@ -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"
}
}
}
15 changes: 14 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand All @@ -11,6 +13,16 @@ 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}
```

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
Expand All @@ -28,7 +40,8 @@ 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
Expand Down

0 comments on commit 82902ac

Please sign in to comment.