Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/UnioGame/UniGame.ViewSystem
MVVM Views System for Unity3D
https://github.com/UnioGame/UniGame.ViewSystem
mvvm unity unity3d
Last synced: 3 months ago
JSON representation
MVVM Views System for Unity3D
- Host: GitHub
- URL: https://github.com/UnioGame/UniGame.ViewSystem
- Owner: UnioGame
- License: mit
- Created: 2020-03-10T07:48:18.000Z (almost 5 years ago)
- Default Branch: master
- Last Pushed: 2024-10-24T05:22:53.000Z (3 months ago)
- Last Synced: 2024-11-07T23:02:59.543Z (3 months ago)
- Topics: mvvm, unity, unity3d
- Language: C#
- Homepage:
- Size: 17.9 MB
- Stars: 108
- Watchers: 6
- Forks: 6
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# UniGame.ViewSystem
MVVM View System for Unity3D
**Odin Inspector Asset recommended to usage with this Package (https://odininspector.com)**
- [Overview](#overview)
- [Getting Started](#getting-started)
- [View System Settings](#view-system-settings)
- [SetUp Views Locations](#setup-views-locations)
- [Addressable Support](#addressable-support)
- [Nested View Sources](#nested-view-sources)
- [Layouts Control](#layouts-control)
- [Settings Rebuild](#settings-rebuild)
- [Skins Support](#skins-support)
- [Pooling Support](#skins-support)
- [API References](#api-references)
- [Views & ViewModels](#views-&-viewmodels)
- [Reactive Binding](#reactive-binding)
- [Context Views](#context-views)
- [Examples](#examples)
- [License](#license)
## Overview
- support base principles of MVVM concepts.
- support ui skins out of the box
- based on Unity Addressables Resources
- handle Addressables Resource lifetime
## Getting Started
Add to your project manifiest by path [%UnityProject%]/Packages/manifiest.json new Scope:
```json
{
"dependencies": {
"com.unigame.viewsystem" : "https://github.com/UnioGame/UniGame.ViewSystem.git"
"com.unigame.localization": "https://github.com/UnioGame/UniGame.Localization.git",
"com.unigame.coremodules": "https://github.com/UnioGame/UniGame.CoreModules.git",
"com.cysharp.unitask" : "https://github.com/Cysharp/UniTask.git?path=src/UniTask/Assets/Plugins/UniTask"
}
}
```
and now install via Package Manager
## Getting Started
- Create View System Asset
## View System Settings
### Create Settings
### SetUp Views Locations
Here you can initialize locations of views
For skinned views. Skin name of view equal to it's parent folder. Your project views prefabs structure involve direct mapping into its skins
### Addressable Support
For now All views load at runtime through Unity Addressable Asset system
By default if your views not registered as Addressable Asset when View System automatically register it into new Addressable Group With name equal to its ViewsSettings Source Name
You can enable Addressable Group Name override:
- Enable "Apply Addressable Group" option
- SetUp new views group name
### Nested View Sources
View System Support additional "nested" view settings sources. All view from that sources will be registered into main View System when it loaded. All nested view settings loads async. If that't source must be loaded before the View System will be available its possible activate "Await Loading" option.
### Layouts Control
"Layout Flow Control" asset control views behaviours between all layouts. View System support two flow behaviour out from the box.
- DefaultFlow
Base flow controller with auto closing screens/windows when active scene changed
- SingleViewFlow
More complex flow with support 'IScreenSuspendingWindow' api. If View with 'IScreenSuspendingWindow' is open, when all current screens wills suspend and resume after it closed.
### Settings Rebuild
You can manualy trigger rebuild:
- Rebuild Command
- For All Settings
- For target settings asset from inspector context menu
## Skins Support
Different flavours of the same view type can be created by utilizing skins. When a skin tag is provided on view creation the corresponding skin is instantiated (if it's been registered prior to it). Skin tag can be provided as a string or a variable of SkinId type (which allows choosing one of the registered tags from a dropdown list and implicitly converts it to a string)
```cs
void ExampleFunc(SkinId largeDemoView) {
await gameViewSystem.OpenWindow(ViewModel, "SmallDemoView");
await gameViewSystem.OpenWindow(ViewModel, largeDemoView);
}
```
### Skins via folders
Place views of the same type in separate folders and add them to the UI Views Skin Folders list in view system settings. After rebuilding the views will be added to the views registry with folder names as their skin tags
### Skins via component
Add View Skin Component to a prefab to turn it into a skin. To add a new skin tag enter it into Skin Tag Name field and press Invoke, an existing tag can be chosen from the Skin Tag dropdown list. No need to specify skin folders in view system settings
## Pooling Support
## API References
### Views & ViewModels
### Reactive Binding
All base Bind extensions use ViewModelLifetime" thats allow auto disconnect from data streams when ViewModel changed
Binding extensions allow you easy connect you view and data sources with rich set flow syntax and support Rx method and async/await semantics
#### Bind To UGUI
Help methods to direct bind unity UGUI types to data streams
- Button methods
Bind Button to model action
```cs
public Button openChest;
[Serializable]
public class WindowViewModel : ViewModelBase
{
public ReactiveCommand checkAction = new ReactiveCommand();
public IReactiveCommand ChestAction => checkAction;
}
protected override UniTask OnViewInitialize(WindowViewModel model)
{
this.Bind(openChest,model.ChestAction);
return UniTask.CompletedTask;
}
```
Bind Model to Button invoke
```cs
public Button openChest;
[Serializable]
public class WindowViewModel : ViewModelBase
{
public ReactiveCommand checkAction = new ReactiveCommand();
public IReactiveCommand ChestAction => checkAction;
}
protected override UniTask OnViewInitialize(WindowViewModel model)
{
this.Bind(model.ChestAction,openChest);
return UniTask.CompletedTask;
}
```
- TextMeshPro methods
```cs
[Serializable]
public class WindowViewModel : ViewModelBase
{
public ReactiveProperty label = new ReactiveProperty();
public ReactiveProperty value = new ReactiveProperty();
public IObservable Label => label;
public IObservable Value => value;
}
public TextMeshProUGUI label;
public TextMeshProUGUI value;
protected override UniTask OnViewInitialize(WindowViewModel model)
{
this.Bind(model.Label,label)
.Bind(model.Value,value);
return UniTask.CompletedTask;
}
```
- Image methods
- LocaliztionString methods
#### Behaviour bindings
Allow you call show/hide/close and another actions with when views/data streams events occurs
## Examples
All examples can be found here:
https://github.com/UniGameTeam/UniGame.ViewSystem.Examples
### Item List View
### Localization View
### Nested Views Sources
### View Skin loading
### Real Project Demo
## License