# UniGame.ViewSystem MVVM View System for Unity3D **Odin Inspector Asset recommended to usage with this Package (https://odininspector.com)** - [UniGame.ViewSystem](https://github.com/UnioGame/UniGame.ViewSystem/raw/master/#unigameviewsystem) - [Overview](https://github.com/UnioGame/UniGame.ViewSystem/raw/master/#overview) - [Getting Started](https://github.com/UnioGame/UniGame.ViewSystem/raw/master/#getting-started) - [Getting Started](https://github.com/UnioGame/UniGame.ViewSystem/raw/master/#getting-started-1) - [View System Settings](https://github.com/UnioGame/UniGame.ViewSystem/raw/master/#view-system-settings) - [Create Settings](https://github.com/UnioGame/UniGame.ViewSystem/raw/master/#create-settings) - [SetUp Views Locations](https://github.com/UnioGame/UniGame.ViewSystem/raw/master/#setup-views-locations) - [Addressable Support](https://github.com/UnioGame/UniGame.ViewSystem/raw/master/#addressable-support) - [Nested View Sources](https://github.com/UnioGame/UniGame.ViewSystem/raw/master/#nested-view-sources) - [Layouts Control](https://github.com/UnioGame/UniGame.ViewSystem/raw/master/#layouts-control) - [Settings Rebuild](https://github.com/UnioGame/UniGame.ViewSystem/raw/master/#settings-rebuild) - [Skins Support](https://github.com/UnioGame/UniGame.ViewSystem/raw/master/#skins-support) - [Skins via folders](https://github.com/UnioGame/UniGame.ViewSystem/raw/master/#skins-via-folders) - [Skins via component](https://github.com/UnioGame/UniGame.ViewSystem/raw/master/#skins-via-component) - [Custom Views Factory](https://github.com/UnioGame/UniGame.ViewSystem/raw/master/#custom-views-factory) - [Enable Zenject DI Support](https://github.com/UnioGame/UniGame.ViewSystem/raw/master/#enable-zenject-di-support) - [Pooling Support](https://github.com/UnioGame/UniGame.ViewSystem/raw/master/#pooling-support) - [API References](https://github.com/UnioGame/UniGame.ViewSystem/raw/master/#api-references) - [Views \& ViewModels](https://github.com/UnioGame/UniGame.ViewSystem/raw/master/#views--viewmodels) - [Reactive Binding](https://github.com/UnioGame/UniGame.ViewSystem/raw/master/#reactive-binding) - [Bind To UGUI](https://github.com/UnioGame/UniGame.ViewSystem/raw/master/#bind-to-ugui) - [Behaviour bindings](https://github.com/UnioGame/UniGame.ViewSystem/raw/master/#behaviour-bindings) - [Examples](https://github.com/UnioGame/UniGame.ViewSystem/raw/master/#examples) - [Item List View](https://github.com/UnioGame/UniGame.ViewSystem/raw/master/#item-list-view) - [Localization View](https://github.com/UnioGame/UniGame.ViewSystem/raw/master/#localization-view) - [Nested Views Sources](https://github.com/UnioGame/UniGame.ViewSystem/raw/master/#nested-views-sources) - [View Skin loading](https://github.com/UnioGame/UniGame.ViewSystem/raw/master/#view-skin-loading) - [Real Project Demo](https://github.com/UnioGame/UniGame.ViewSystem/raw/master/#real-project-demo) - [License](https://github.com/UnioGame/UniGame.ViewSystem/raw/master/#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 For this module you need to install R3 package, NuGetForUnity and ObservableCollections. ``` ObservableCollections can be installer vai NuGetForUnity In Unity projects, you can installing ObservableCollections with NugetForUnity. If R3 integration is required, similarly install ObservableCollections.R3 via NuGetForUnity. ``` follow the instructions on home pages for these packages: - https://github.com/Cysharp/R3 - https://github.com/GlitchEnzo/NuGetForUnity - https://github.com/Cysharp/ObservableCollections ``` "dependencies": { "com.unity.localization": "1.5.4", "com.unity.addressables": "2.6.0", "com.unigame.addressablestools" : "https://github.com/UnioGame/unigame.addressables", "com.unigame.unicore": "https://github.com/UnioGame/unigame.core.git", "com.unigame.localization": "https://github.com/UnioGame/unigame.localization.git", "com.unigame.rx": "https://github.com/UnioGame/unigame.rx.git", "com.cysharp.unitask" : "https://github.com/Cysharp/UniTask.git?path=src/UniTask/Assets/Plugins/UniTask", "com.cysharp.r3": "https://github.com/Cysharp/R3.git?path=src/R3.Unity/Assets/R3.Unity", "com.github-glitchenzo.nugetforunity": "https://github.com/GlitchEnzo/NuGetForUnity.git?path=/src/NuGetForUnity" }, ``` Add to your project manifiest by path [%UnityProject%]/Packages/manifiest.json new package: ```json { "dependencies": { "com.unigame.viewsystem" : "https://github.com/UnioGame/unigame.viewsystem.git" "com.unigame.localization" : "https://github.com/UnioGame/unigame.localization.git", "com.cysharp.unitask" : "https://github.com/Cysharp/UniTask.git?path=src/UniTask/Assets/Plugins/UniTask" } } ``` ## Getting Started - Create View System Asset ![](https://github.com/UniGameTeam/UniGame.ViewSystem/raw/master/Editor/GitAssets/view_asset_prefab.png) ## View System Settings ### Create Settings ![](https://camo.githubusercontent.com/b553a147696fe97dda6cf42e3dcb4c00e49ad36e111c3ce3593dc5a5edb1b6dc/68747470733a2f2f692e6779617a6f2e636f6d2f31353833336665303031396239353730643638636162366261323064336466362e706e67) ### SetUp Views Locations Here you can initialize locations of views ![](https://github.com/UniGameTeam/UniGame.ViewSystem/raw/master/Editor/GitAssets/views_setup.png) For skinned views. Skin name of view equal to it's parent folder. Your project views prefabs structure involve direct mapping into its skins ![](https://github.com/UniGameTeam/UniGame.ViewSystem/raw/master/Editor/GitAssets/skin-folders-names.png) ### 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 ![](https://github.com/UniGameTeam/UniGame.ViewSystem/raw/master/Editor/GitAssets/view-settings-source-name1.png) You can enable Addressable Group Name override: - Enable "Apply Addressable Group" option - SetUp new views group name ![](https://github.com/UniGameTeam/UniGame.ViewSystem/raw/master/Editor/GitAssets/views-addressable-override.png) ### 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. ![](https://github.com/UniGameTeam/UniGame.ViewSystem/raw/master/Editor/GitAssets/nested-settings-await.png) ### Layouts Control "Layout Flow Control" asset control views behaviours between all layouts. View System support two flow behaviour out from the box. ![](https://github.com/UniGameTeam/UniGame.ViewSystem/raw/master/Editor/GitAssets/views-flow-control.png) - 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 ![](https://github.com/UniGameTeam/UniGame.ViewSystem/raw/master/Editor/GitAssets/view-settings-rebuild.png) - For All Settings ![](https://camo.githubusercontent.com/8d049526d81d6796aebfcc5abb0a78afe05397c5412c94270266429ebad1374f/68747470733a2f2f692e6779617a6f2e636f6d2f64663830336332386138613966656237303263646139393733346362393238382e706e67) - For target settings asset from inspector context menu ![](https://camo.githubusercontent.com/0d378491b62d65f2945718134da5312d15abcb39f2cfd547047337d13b2dc891/68747470733a2f2f692e6779617a6f2e636f6d2f37646638363730643331653737646634633866363962633265376461396439322e706e67) ## 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 ![](https://github.com/UniGameTeam/UniGame.ViewSystem/raw/master/Editor/GitAssets/skin-folders-names.png) ### 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 ![image](https://user-images.githubusercontent.com/72013166/126639139-974d1458-7c14-490d-8b6a-4f3c1de33fa5.png) ![image](https://user-images.githubusercontent.com/72013166/126639300-bcc028a7-5070-4e78-9495-6d76c0ffc3b1.png) ### Custom Views Factory View Factory - provide custom view creation logic. You can create your own factory by implementing: - **IViewFactory** - **IViewFactoryProvider** And select new provider in View System Settings #### Enable Zenject DI Support Add to your project scriptings define symbol "ZENJECT_ENABLED" to enable Zenject DI support ![image](https://github.com/UniGameTeam/UniGame.ViewSystem/raw/master/Editor/GitAssets/viewfactoriessettings.png) Anywhere in your initialization of game pass Zenject DiContainer to ZenjectViewFactoryProvider.Container static field ```csharp public class ZenjectViewFactoryProvider : IViewFactoryProvider { public static DiContainer Container { get; set; } } ``` You can use Zenject DI module as an example to create your own custom DI support in view lines of code. Module is located in ZenjectViewModule directory ```csharp //ZenjectViewFactory example public class ZenjectViewFactory : IViewFactory { public ViewFactory _viewFactory; public DiContainer _container; public ZenjectViewFactory(DiContainer container,AsyncLazy readyStatus, IViewResourceProvider viewResourceProvider) { _container = container; _viewFactory = new ViewFactory(readyStatus, viewResourceProvider); } public async UniTask Create(string viewId, string skinTag = "", Transform parent = null, string viewName = null, bool stayWorldPosition = false) { var view = await _viewFactory.Create(viewId, skinTag, parent, viewName, stayWorldPosition); if (view == null || view.GameObject == null) return view; var viewObject = view.GameObject; _container.InjectGameObject(viewObject); return view; } } ``` ## 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 ![](https://github.com/UniGameTeam/UniGame.UISystem/raw/master/Readme/Assets/ui_list_demo.gif) ### Localization View ![](https://github.com/UniGameTeam/UniGame.UISystem/raw/master/Readme/Assets/localization_example.gif) ### Nested Views Sources ![](https://github.com/UniGameTeam/UniGame.UISystem/raw/master/Readme/Assets/nested_sources.png) ### View Skin loading ![](https://github.com/UniGameTeam/UniGame.UISystem/raw/master/Readme/Assets/skins_views.gif) ### Real Project Demo ![](https://github.com/UniGameTeam/UniGame.ViewSystem/raw/master/Editor/GitAssets/game-hud.gif) ## License MIT