# com.kingdox.uniflux > Provides Flux flow integration to Unity. Latest version **1.3.1** (published 2023-04-30) · MIT license · 0 weekly downloads ## Install ```sh npm install com.kingdox.uniflux pnpm add com.kingdox.uniflux yarn add com.kingdox.uniflux bun add com.kingdox.uniflux ``` ## Health **Score 25/100 (F)** — status: abandoned. Positive: no vulnerabilities. Warnings: low downloads; no types; no esm support. Negative: abandoned. ## Facts | | | |---|---| | Version | 1.3.1 | | Published | 2023-04-30 | | First published | 2023-04-09 | | Weekly downloads | 0 | | License | MIT | | TypeScript types | none | | Module format | CommonJS | | Dependencies | 0 | | Unpacked size | 642.5 KB | | Known vulnerabilities | 0 | | Install scripts | no | | GitHub stars | 92 | | Author | Kingdox | | Maintainers | ch4b13r | | Keywords | flux, unity, uniflux | ## Links - npm: https://www.npmjs.com/package/com.kingdox.uniflux - Repository: https://github.com/kingdox/UniFlux - Homepage: https://github.com/kingdox/UniFlux#readme - Issues: https://github.com/kingdox/UniFlux/issues - npm.io page: https://npm.io/package/com.kingdox.uniflux ## Recent versions - 1.3.1 (latest) — 2023-04-30 - 1.3.0 — 2023-04-23 - 1.2.2 — 2023-04-20 - 1.1.1 — 2023-04-09 ## README ![Logo](https://kingdox.github.io/assets/img/uniflux.png) UniFlux - Event Bus with Flux Integration for Unity === Created by Xavier Arpa ([kingdox](https://github.com/kingdox/)) #### Provides an efficient Event Bus with Flux integration for Unity. [![Unity](https://img.shields.io/badge/Unity-2019+-black.svg)](https://unity3d.com/pt/get-unity/download/archive) [![MIT License](https://img.shields.io/badge/License-MIT-green.svg)](https://choosealicense.com/licenses/mit/) [![Build status](https://ci.appveyor.com/api/projects/status/712fvbpoio49ee91?svg=true)](https://ci.appveyor.com/project/kingdox/uniflux) [![PRs Welcome](https://img.shields.io/badge/PRs-welcome-blueviolet)](https://makeapullrequest.com) [![Releases](https://img.shields.io/github/release/kingdox/UniFlux.svg)](https://github.com/kingdox/UniFlux/releases) [![UPM](https://img.shields.io/npm/v/com.kingdox.uniflux?label=openupm®istry_uri=https://package.openupm.com)](https://openupm.com/packages/com.kingdox.uniflux/) NPM version ![GitHub all releases](https://shields.io./github/downloads/kingdox/UniFlux/total?logo=github) ![npm](https://shields.io./npm/dt/com.kingdox.uniflux?logo=npm) [![CodeFactor](https://www.codefactor.io/repository/github/kingdox/uniflux/badge)](https://www.codefactor.io/repository/github/kingdox/uniflux) ## Table of Contents - [Introduction](#intro) - [Modules](#modules) - [Performance](#performance) - [Examples](#examples) - [Installation](#installation) - [Special Content](#special-content) - [Contributing](#contributing) - [Author Info](#author-info) - [Special Thanks](#special-thanks) - [License](#license) ## Introduction Soon ![WorkFlow](https://www.websequencediagrams.com/files/render?link=lpHvFEnOec3XJH2t8AnKG2yrZDncSgC2IVJ8WIoVqDWCdvF7PThHRiEAVR7UBgRJ) ![Example_1](https://www.websequencediagrams.com/files/render?link=4t7a1KKbQLUGYJlwuv6r58a63GbmFoMJtwsVLS60scZNp1nlcxElJg1Ch6pfLypQ)
Architecture ![Architecture](https://github.com/kingdox/UniFlux/blob/main/Contents/Architecture.drawio.png)
## Modules
Modules [![Unity](https://img.shields.io/badge/Module-UniFlux.Scene-black.svg)](https://github.com/kingdox/UniFlux.Scene) [![Unity](https://img.shields.io/badge/Module-UniFlux.Input-black.svg)](https://github.com/kingdox/UniFlux.Input) [![Unity](https://img.shields.io/badge/Module-UniFlux.Scene-black.svg)](https://github.com/kingdox/UniFlux.Scene) [![Unity](https://img.shields.io/badge/Module-UniFlux.Binary-black.svg)](https://github.com/kingdox/UniFlux.Binary) [![Unity](https://img.shields.io/badge/Module-UniFlux.Updates-black.svg)](https://github.com/kingdox/UniFlux.Updates) [![Unity](https://img.shields.io/badge/Module-UniFlux.Addressables-black.svg)](https://github.com/kingdox/UniFlux.Addressables) [![Unity](https://img.shields.io/badge/Module-UniFlux.Firebase-black.svg)](https://github.com/kingdox/UniFlux.Firebase) [![Unity](https://img.shields.io/badge/Module-UniFlux.Firebase.Firestore-black.svg)](https://github.com/kingdox/UniFlux.Firebase.Firestore) [![Unity](https://img.shields.io/badge/Module-UniFlux.Firebase.Database-black.svg)](https://github.com/kingdox/UniFlux.Firebase.Database)
## Performance
Performance Compared methods of UniFlux | Name | Iterations | GC | Time | |-----------|--------------:|------:|-----:| | UniFlux (Dispatch int ) | 10.000 | 0B | 0ms | | UniFlux (Dispatch string ) | 10.000 | 0B | 1ms | | UniFlux (Store int ADD) | 10.000 | 1.2MB | ~3ms | | UniFlux (Store string ADD) | 10.000 | 1.2MB | ~3ms | | UniFlux (Store int REMOVE) | 10.000 | 1.2MB | ~30ms | | UniFlux (Store string REMOVE) | 10.000 | 1.2MB | ~30ms |
## Examples
Examples ```csharp using Kingdox.UniFlux; // 1 public sealed class StarterFlux : MonoFlux // 2 { private void Start() => "StarterFlux.CastTest".Dispatch(); // 3 } //... public sealed class TestFlux : MonoFlux { [Flux("StarterFlux.CastTest")] private void CastTest() => Debug.Log("Hello World"); // 4 } ``` ```cs using Kingdox.UniFlux; float _life; public float Life { [Flux("Get_Life")] get => _life; [Flux("Set_Life")] set { _life = value; "OnChange_Life".Dispatch(value); } } //... [Flux("OnChange_Life")] private void OnChange_Life(float value) { // ... } ``` ```cs "1".Dispatch(); int _2 = "2".Dispatch(); "3".Dispatch(42); int _4 = "4".Dispatch(42); ``` ```cs "9".IEnumerator(); "10".Task(); ``` ```cs // #define UNIFLUX_UNITASK_SUPPORT "123".UniTask(); ``` #### Advanced features ```cs using Kingdox.UniFlux.Core; //... Flux.Dispatch(13); //byte as key string _14 = Flux.Dispatch(true); //bool as key float _16 = Flux.Dispatch(Math.PI, "PI"); //double as key ``` ```cs "42".Store(()=>{}, true); // Anonimous Subscriptions ```
## Installation
Installation - You can use the *.unityPackage* in releases - You can use the *.tzg in releases and add in PackageManager - You can add in PackageManager ([How to install package from git URL](https://docs.unity3d.com/Manual/upm-ui-giturl.html)) ```bash https://github.com/kingdox/UniFlux.git ``` - You can install via openupm CLI ```bash openupm add com.kingdox.uniflux ``` - You can install via npm ```bash npm i com.kingdox.uniflux ```
## Special Content
Special Content To enable special content you must #define | Definition | Description | | :-------- | :------------------------- | | `UNIFLUX_UNITASK_SUPPORT` | Enable [Cysharp/UniTask]("https://github.com/Cysharp/UniTask") integration |
## Contributing Contributions are always welcome! ## Author Info [@kingdox](https://github.com/kingdox/) For support, email arpaxavier@gmail.com [![Twitter](https://img.shields.io/twitter/follow/_kingdox_.svg?label=Follow&style=social)](https://twitter.com/intent/follow?screen_name=_kingdox_) [![LinkedIn](https://img.shields.io/badge/Linkedin-%0332301a0.svg?style=for-the-badge&logo=linkedin&logoColor=white)](https://www.linkedin.com/in/xavier-arpa-0332301a0/) ## Special Thanks [@Quinowl](https://github.com/Quinowl) ## License [MIT](https://choosealicense.com/licenses/mit/) --- _Source: https://npm.io/package/com.kingdox.uniflux · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._