{"id":28925814,"url":"https://github.com/ho11ow1/flowkit","last_synced_at":"2026-05-21T05:02:07.803Z","repository":{"id":299900842,"uuid":"1004554920","full_name":"Ho11ow1/FlowKit","owner":"Ho11ow1","description":"A lightweight and flexible animation toolkit for Unity UI and visual effects","archived":false,"fork":false,"pushed_at":"2025-07-08T14:42:48.000Z","size":99,"stargazers_count":1,"open_issues_count":0,"forks_count":0,"subscribers_count":1,"default_branch":"master","last_synced_at":"2025-07-08T15:45:16.568Z","etag":null,"topics":["animation-library","shaderlab","shaders","tween","ui-library","uikit","unity","unity-package"],"latest_commit_sha":null,"homepage":"","language":"C#","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"apache-2.0","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/Ho11ow1.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":"ROADMAP.md","authors":null,"dei":null,"publiccode":null,"codemeta":null,"zenodo":null}},"created_at":"2025-06-18T20:13:23.000Z","updated_at":"2025-07-08T14:42:52.000Z","dependencies_parsed_at":"2025-07-08T15:33:02.799Z","dependency_job_id":"4af206c4-095d-4ebb-a554-a15bbf594b64","html_url":"https://github.com/Ho11ow1/FlowKit","commit_stats":null,"previous_names":["ho11ow1/flowkit"],"tags_count":2,"template":false,"template_full_name":null,"purl":"pkg:github/Ho11ow1/FlowKit","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Ho11ow1%2FFlowKit","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Ho11ow1%2FFlowKit/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Ho11ow1%2FFlowKit/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Ho11ow1%2FFlowKit/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/Ho11ow1","download_url":"https://codeload.github.com/Ho11ow1/FlowKit/tar.gz/refs/heads/master","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Ho11ow1%2FFlowKit/sbom","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":266413524,"owners_count":23924745,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","status":"online","status_checked_at":"2025-07-22T02:00:09.085Z","response_time":66,"last_error":null,"robots_txt_status":null,"robots_txt_updated_at":null,"robots_txt_url":"https://github.com/robots.txt","online":true,"can_crawl_api":true,"host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["animation-library","shaderlab","shaders","tween","ui-library","uikit","unity","unity-package"],"created_at":"2025-06-22T11:10:43.319Z","updated_at":"2026-05-21T05:02:07.797Z","avatar_url":"https://github.com/Ho11ow1.png","language":"C#","funding_links":[],"categories":[],"sub_categories":[],"readme":"# FlowKit\n[![Version: 2.0.0](https://img.shields.io/badge/Version-2.0.0-blue.svg)](https://github.com/Ho11ow1/FlowKit)\n[![License: Apache-2-0](https://img.shields.io/badge/License-Apache%202.0-green.svg)](https://opensource.org/license/apache-2-0)\u003cbr/\u003e\n**A lightweight, high-performance animation and effects toolkit for Unity TMPro.**\u003cbr/\u003e\nFlowKit provides a clean, flexible API for driving UI animations, text effects, and visual feedback — \nwith support for both component-based and monolith-style workflows.\n\n---\n\n## Features\n- **Dual Workflow Support**\n  - **Component mode** — attach `FKText`, `FKVisibility`, etc. directly to your GameObjects\n  - **Monolith mode** — drive animations on any `RectTransform` reference from a single controller, safe against dynamically created UI\n\n- **Core Animation Modules**\n  - **Movement**: UI positioning and directional transitions\n  - **Rotation**: Rotation animations\n  - **Scale**: Size and scale animations\n  - **Visibility**: Fade and display state control\n  - **Text**: Text-specific animations and effects\n\n- **Text Effects**\n  - Typewriter animation — configurable by characters per second or total duration\n  - Color cycling with a smooth lerp between any number of colors\n  - Wave and shake per-character vertex effects\n\n- **Animation Handles**\n  - Fire-and-forget or handle-based control over every animation\n  - Play, stop, and chain animations via `FKHandle`\n\n- **Event System**\n  - Subscribe to start and end events per animation instance\n  - Custom `FKEventData` carries target, duration, and identity per invocation\n\n- **Custom Logging**\n  - Internal `FKLogger` with contextual null and missing component warnings\n\n- **Editor Utilities**\n  - Menu item to instantly scaffold a `FlowKitController` object in your scene\n\n---\n\n## Installation\n### Option 1: Unity Package Manager (via Git)\n1. Open **Unity** and go to **Window \u003e Package Manager**\n2. Click the **+** button and choose **\"Add package from Git URL...\"**\n3. Paste in:\n```text\nhttps://github.com/Ho11ow1/FlowKit.git\n```\n\n### Option 2: Manual Installation\n1. Download or clone this repository\n2. Drag the `FlowKit/` folder into your `Assets/` directory\n\n---\n\n## Usage\n\n### Monolith Mode — via FKEngine\nDrive all animations through a single `FKEngine` controller object:\n```csharp\nusing UnityEngine;\n\nusing FlowKit;\n\npublic class Sample : MonoBehaviour\n{\n    [SerializeField] private RectTransform dialogueBox;\n    [SerializeField] private RectTransform scoreLabel;\n\n    [SerializeField] private FKEngine engine;\n\n    void Start()\n    {\n        engine.Text.TypeWrite(dialogueBox, 2f);\n        engine.Movement.Move(dialogueBox, Direction.FromLeft, 300f, 3f);\n        engine.Text.Wave(scoreLabel, 0.3f, 3f, 2f);\n    }\n}\n\n```\n\n### Monolith Mode — via Component Reference\nCall directly on an `FK*` component, passing any `RectTransform` as the target:\n```csharp\nusing UnityEngine;\n\nusing FlowKit;\n\npublic class Sample : MonoBehaviour\n{\n    [SerializeField] private RectTransform dialogueBox;\n    [SerializeField] private RectTransform scoreLabel;\n\n    [SerializeField] private FKText fkText;\n\n    void Start()\n    {\n        fkText.TypeWrite(dialogueBox, 2f);\n        fkText.Wave(scoreLabel, 0.3f, 3f, 2f);\n    }\n}\n\n```\n\n### Component Mode\nAttach an `FK*` component to a GameObject and animate it directly — no target reference needed:\n```csharp\nusing UnityEngine;\n\nusing FlowKit;\nusing FlowKit.Events;\n\npublic class Sample : MonoBehaviour\n{\n    [SerializeField] private FKText fkText;\n    [SerializeField] private FKVisibility fkVisibility;\n\n    void Start()\n    {\n        FlowKitEvents.OnAnimationStart += OnAnimationStart;\n        FlowKitEvents.OnAnimationEnd += OnAnimationEnd;\n\n        fkText.TypeWrite(2f);\n        fkText.ColorCycle(Color.red, Color.blue, 0.5f, 4f);\n        fkVisibility.Fade(0f, 1f, 1f);\n    }\n\n    void OnAnimationStart(FKEventData data) =\u003e Debug.Log($\"{data.Target.name} started.\");\n    void OnAnimationEnd(FKEventData data) =\u003e Debug.Log($\"{data.Target.name} ended.\");\n\n    void OnDestroy()\n    {\n        FlowKitEvents.OnAnimationStart -= OnAnimationStart;\n        FlowKitEvents.OnAnimationEnd -= OnAnimationEnd;\n    }\n}\n\n```\n\n### Handle-Based Control\nEvery animation has a `Handle` variant that lets you control playback after the fact:\n```csharp\nusing UnityEngine;\n\nusing FlowKit;\n\npublic class Sample : MonoBehaviour\n{\n    [SerializeField] private FKText fkText;\n\n    private FKHandle titleHandle;\n\n    void Awake()\n    {\n        titleHandle = fkText.WaveHandle(amplitude: 0.4f, frequency: 2f);    \n    }\n\n    void Start()\n    {\n        titleHandle.Play();\n    }\n\n    void OnDisable()\n    {\n        titleHandle.Stop();\n    }\n}\n\n```\n\n---\n\n## Requirements\n- Unity 6 or higher\n- TextMeshPro package\n\n---\n\n## License\nAPACHE-2.0 License - see [LICENSE](LICENSE) \n\n---\n\nIf you find any issues during usage, please create a github Issue [Here](https://github.com/Ho11ow1/FlowKit/issues)\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fho11ow1%2Fflowkit","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fho11ow1%2Fflowkit","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fho11ow1%2Fflowkit/lists"}