Unclaimed Package Is this your package? Claim it to unlock full analytics and manage your listing.
Claim This Package

Install via UPM

Add to Unity Package Manager using this URL

https://www.pkglnk.dev/flowkit.git

README Markdown

Copy this to your project's README.md

Style
Preview
pkglnk installs badge
## Installation

Add **FlowKit** to your Unity project via Package Manager:

1. Open **Window > Package Manager**
2. Click **+** > **Add package from git URL**
3. Enter:
```
https://www.pkglnk.dev/flowkit.git
```

[![pkglnk](https://www.pkglnk.dev/badge/flowkit.svg?style=pkglnk)](https://www.pkglnk.dev/pkg/flowkit)

Dependencies (1)

README

FlowKit

Status: Work In Progress Version: 1.3.0 License: Apache-2-0
Unity
A lightweight and flexible animation toolkit for Unity UI and visual effects.
Supports smooth fade, transition, scale, rotate, and typewriter animations, along with custom shaders and editor tools.

Features

  • Unified FlowKit API
    • Animate UI with a single entry point (FlowKitEngine.cs)
    • Modular backend, internal-only animation components
  • Core Animation Module split
    • Visibility: Handles opacity and display state
    • Movement: Controls UI positioning and movement
    • Text: Manages text specific animations and effects
    • Scale: Handles size animations
    • Rotation: Controls rotation animations
  • Text Effects
    • Typewriter animation with configurable speed and character delay
    • Easy to use colorCycling effect
  • Editor Utilities
    • Visual animation preview window
  • Shader Support (W.I.P)
    • Expandable 2D/3D shader folders included

Installation

Option 1: Unity Package Manager (via Git)

  1. Open Unity and go to Window > Package Manager
  2. Click the + button and choose "Add package from Git URL..."
  3. Paste in:
https://github.com/Ho11ow1/FlowKit.git

Option 2: Manual Installation

  1. Download or clone this repository
  2. Drag the FlowKit/ folder into your Assets/ directory

Usage

using FlowKit;
using FlowKit.Common;

public class PopupController : MonoBehaviour
{
    [SerializeField] private FlowKitEngine popupFK;

    void Start()
    {
        // Hide panel on load
        popupFK.Visibility.SetPanelVisibility(false);

        // Subscribe to animation events
        FlowKitEvents.FadeStart += () => Debug.Log("Fade started.");
        FlowKitEvents.FadeEnd += () => Debug.Log("Fade ended.");
    }

    public void ShowPopup()
    {
        popupFK.Visibility.FadeFrom0To1(AnimationTarget.Panel, 1, 0.5f);
        popupFK.Movement.MoveFromLeft(AnimationTarget.Image, 1, 300f, 0.75f, EasingType.EaseInOut);
    }

    public void HidePopup()
    {
        popupFK.Visibility.FadeFrom1To0(AnimationTarget.Panel, 1, 0.5f);
    }

    void OnDestroy()
    {
        // Clean up
        FlowKitEvents.FadeStart -= () => Debug.Log("Fade started.");
        FlowKitEvents.FadeEnd -= () => Debug.Log("Fade ended.");
    }
}

Requirements

  • Unity 2022.3.10f1 or higher
  • TextMeshPro package

Roadmap

  • Take a look at planned & up coming features Here

License

APACHE-2.0 License - see LICENSE

Comments

No comments yet. Be the first!