https://github.com/xavierarpa/UniFlux
Handle Events and States in Unity, Really Easy to Use and High Performant, We are now in Asset Store ! https://assetstore.unity.com/packages/slug/250332
https://github.com/xavierarpa/UniFlux
csharp event-driven eventbus flux game-development unity unity-game unity3d
Last synced: 5 months ago
JSON representation
Handle Events and States in Unity, Really Easy to Use and High Performant, We are now in Asset Store ! https://assetstore.unity.com/packages/slug/250332
- Host: GitHub
- URL: https://github.com/xavierarpa/UniFlux
- Owner: xavierarpa
- License: mit
- Created: 2023-03-19T13:34:29.000Z (over 2 years ago)
- Default Branch: main
- Last Pushed: 2024-10-04T08:19:28.000Z (about 1 year ago)
- Last Synced: 2025-04-24T04:13:14.842Z (6 months ago)
- Topics: csharp, event-driven, eventbus, flux, game-development, unity, unity-game, unity3d
- Language: C#
- Homepage: https://xavierarpa.gitbook.io/uniflux
- Size: 1.69 MB
- Stars: 72
- Watchers: 2
- Forks: 5
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- Contributing: CONTRIBUTING.md
- Funding: .github/FUNDING.yml
- License: LICENSE
Awesome Lists containing this project
README
UniFlux - Flexible Event Driven and Flux for Unity
===
[](https://unity3d.com/pt/get-unity/download/archive)
[](https://choosealicense.com/licenses/mit/)
[](https://ci.appveyor.com/project/kingdox/uniflux)
[](https://makeapullrequest.com)
[](https://github.com/xavierarpa/UniFlux/releases)
[](https://openupm.com/packages/com.xavierarpa.uniflux/)
[](https://www.codefactor.io/repository/github/xavierarpa/uniflux)
⚠️ Please read [Documentation](https://xavierarpa.gitbook.io/uniflux)
[Contact Me](mailto:arpaxavier@gmail.com)
# Installation
- You can Download at [Unity Asset Store](https://assetstore.unity.com/packages/slug/250332)
- 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/xavierarpa/UniFlux.git
```
- You can install via openupm CLI
```bash
openupm add com.xavierarpa.uniflux
```
- You can install via npm
```bash
npm i com.xavierarpa.uniflux
```
# Performance
| Name | Iterations | GC | Time |
|-----------|--------------:|------:|-----:|
| UniFlux (Dispatch) | 10.000 | 0B | 1ms |
| UniFlux (ADD Store) | 10.000 | 1.2MB | ~3ms |
| UniFlux (REMOVE Store) | 10.000 | 1.2MB | ~30ms |
Note: Storing (ADD and REMOVE) by design is planned to do it once so there's no problem in performance.
# License
[MIT](https://choosealicense.com/licenses/mit/)
MIT License
Copyright (c) 2023 Xavier Thomas Peter Arpa Lopez
Permission is hereby granted, free of charge, to any person obtaining a copy
of this software and associated documentation files (the "Software"), to deal
in the Software without restriction, including without limitation the rights
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
copies of the Software, and to permit persons to whom the Software is
furnished to do so, subject to the following conditions:
The above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software.
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
SOFTWARE.