> For the complete documentation index, see [llms.txt](https://xavierarpa.gitbook.io/uniflux/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://xavierarpa.gitbook.io/uniflux/getting-started/setup.md).

# Setup

### Install UniFlux

* 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
```

### Generate your Scritps

{% code lineNumbers="true" fullWidth="true" %}

```csharp
using UniFlux;
using UnityEngine;

public class Test : MonoFlux
{
    private void Start()
    {
        // Allows you to call any method subscribe with "0" Key
        "0".Dispatch();
    }
    [MethodFlux("0")] private void Tester()
    {
        Debug.Log("Hello world");
    }
}
```

{% endcode %}

{% code fullWidth="true" %}

```csharp
using UniFlux;
using UnityEngine;

public class Test_2 : MonoFlux
{
    [MethodFlux("0")] private void Tester_2()
    {
        Debug.Log("Hello world 2");
    }
}
```

{% endcode %}

You can put both in a scene and see if they both receive the event

That's all !

Here another sample making subscriptions manually

{% code fullWidth="true" %}

```csharp
using UniFlux;
public class Test : MonoBehaviour
{
  private void Start()
  {
    "KEY".Dispatch();
  }
  private void OnEnable() 
  { 
      "KEY".Store(true, OnExampleMethodIsCalled)
  }
  private void OnDisable() 
  { 
      "KEY".Store(false, OnExampleMethodIsCalled)
  }
  private void OnExampleMethodIsCalled()
  {
    Debug.Log("Hello World");
  }
}

public class Test_2 : MonoBehaviour
{
    private void OnEnable() 
    { 
      "KEY".Store(true, Tester_2)
    }
    private void OnDisable() 
    { 
      "KEY".Store(false, Tester_2)
    }
    private void Tester_2()
    {
      Debug.Log("Hello world 2");
    }
}
```

{% endcode %}
