Unidux is practical application architecture for Unity3D UI. It's inspired by Redux. # Install ## UPM Add following two lines to `Pacakges/manifest.json`. ``` { "com.neuecc.unirx": "https://github.com/neuecc/UniRx.git?path=Assets/Plugins/UniRx/Scripts", "me.mattak.unidux": "https://github.com/mattak/Unidux.git?path=Assets/Plugins/Unidux/Scripts", // ... } ``` ## Unity package No longer supported. If you need older versions, import unitypackage from [latest releases](https://github.com/mattak/Unidux/releases). # Usage 1) Create your Unidux singleton and place it to unity scene. ```csharp using UniRx; using Unidux; public sealed class Unidux : SingletonMonoBehaviour, IStoreAccessor { public TextAsset InitialStateJson; private Store _store; public IStoreObject StoreObject { get { return Store; } } public static State State { get { return Store.State; } } public static Subject Subject { get { return Store.Subject; } } private static State InitialState { get { return Instance.InitialStateJson != null ? JsonUtility.FromJson(Instance.InitialStateJson.text) : new State(); } } public static Store Store { get { return Instance._store = Instance._store ?? new Store(InitialState, new Count.Reducer()); } } public static object Dispatch(TAction action) { return Store.Dispatch(action); } void Update() { Store.Update(); } } ``` _Note: `ReplaySubject` is a [ReactiveX concept](http://reactivex.io/documentation/subject.html) provided by [UniRx](https://github.com/neuecc/UniRx) in this example._ 2) Create state class to store application state. ```csharp using System; [Serializable] public class State : StateBase { public int Count = 0; } ``` 3) Define action to change state. Define Reducer to move state. ```csharp public static class Count { // specify the possible types of actions public enum ActionType { Increment, Decrement } // actions must have a type and may include a payload public class Action { public ActionType ActionType; } // ActionCreators creates actions and deliver payloads // in redux, you do not dispatch from the ActionCreator to allow for easy testability public static class ActionCreator { public static Action Create(ActionType type) { return new Action() {ActionType = type}; } public static Action Increment() { return new Action() {ActionType = ActionType.Increment}; } public static Action Decrement() { return new Action() {ActionType = ActionType.Decrement}; } } // reducers handle state changes public class Reducer : ReducerBase { public override State Reduce(State state, Action action) { switch (action.ActionType) { case ActionType.Increment: state.Count++; break; case ActionType.Decrement: state.Count--; break; } return state; } } } ``` 4) Create Renderer to display state and attach it to Text GameObject. ```csharp [RequireComponent(typeof(Text))] public class CountRenderer : MonoBehaviour { void OnEnable() { var text = this.GetComponent(); Unidux.Subject .TakeUntilDisable(this) .StartWith(Unidux.State) .Subscribe(state => text.text = state.Count.ToString()) .AddTo(this) ; } } ``` 5) Create dispatcher to update count and attach it to GameObject. ```csharp [RequireComponent(typeof(Button))] public class CountDispatcher : MonoBehaviour { public Count.Action Action = Count.ActionCreator.Increment(); void Start() { this.GetComponent