Giter VIP home page Giter VIP logo

uniflux's Introduction

Logo

UniFlux - Flexible Event Driven and Flux for Unity

Unity MIT License Build status PRs Welcome

Releases UPM NPM version

GitHub all releases npm

CodeFactor

Modules
Module Description
Unity (Recomended👍) Manage the scenes and emit messages
Unity Manage "Input items" and then dispatch if conditions is right
Unity Manage Player Click interaction
Unity (Recomended👍) Manage Player Swipe interaction (Mouse and Mobile)
Unity Manage Player UI Drag interaction
Unity (Recomended👍) Save/Load Files in Binary
Unity (Recomended👍) Subscribe and Unsubscribe Actions/Methods in a concrete framerate
Unity (Experimental🧪) Manages Addressables with primitive types
Unity Firebase Core of other UniFlux's modules
Unity Manages Firebase Cloud Firestore simplified
Unity Manages Firebase Realtime Database simplified
Unity (Working ! 🔨) Manages OpenAI API
Unity Manages OWO API
Unity (Working ! 🔨) Handle Network States, allowing netcode Rollback
Workflow

Here you can find a Unity Project to take a try => https://github.com/kingdox/UniFluxShowcaseProject

Example_1 Event Bus

Example_2 States

Advanced Workflow

WorkFlow

Architecture

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
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
}
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)
  {
    // ...
  }
"1".Dispatch();
int _2 = "2".Dispatch<int>();
"3".Dispatch<int>(42);
int _4 = "4".Dispatch<int,int>(42);
"9".IEnumerator();
"10".Task();
// #define UNIFLUX_UNITASK_SUPPORT
"123".UniTask();

Advanced features

using Kingdox.UniFlux.Core;
//...
Flux<byte>.Dispatch(13); //byte as key
string _14 = Flux<bool,string>.Dispatch(true); //bool as key
float _16 = Flux<double,string, float>.Dispatch(Math.PI, "PI"); //double as key
"42".Store(()=>{}, true); // Anonimous Subscriptions
Installation
https://github.com/kingdox/UniFlux.git
  • You can install via openupm CLI
openupm add com.kingdox.uniflux
  • You can install via npm
npm i com.kingdox.uniflux
Special Content

To enable special content you must #define

Definition Description
UNIFLUX_UNITASK_SUPPORT Enable Cysharp/UniTask integration
Author Info

@kingdox

For support, email [email protected]

Twitter LinkedIn

License

MIT

MIT License

Copyright (c) [year] [fullname]

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.

uniflux's People

Contributors

github-actions[bot] avatar xavierarpa avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    🖖 Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. 📊📈🎉

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google ❤️ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.