{"id":21343953,"url":"https://github.com/lunaristudios/shiroifx","last_synced_at":"2025-07-12T15:31:53.003Z","repository":{"id":126343768,"uuid":"144296610","full_name":"LunariStudios/ShiroiFX","owner":"LunariStudios","description":"A Unity Game Feel library, made for designers with a big dose of love","archived":false,"fork":false,"pushed_at":"2019-03-13T15:37:51.000Z","size":5649,"stargazers_count":11,"open_issues_count":1,"forks_count":1,"subscribers_count":5,"default_branch":"master","last_synced_at":"2024-11-10T18:44:47.531Z","etag":null,"topics":["game-feel","mit","unity","unity2d","unity3d"],"latest_commit_sha":null,"homepage":null,"language":"C#","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/LunariStudios.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE.md","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null}},"created_at":"2018-08-10T14:31:44.000Z","updated_at":"2024-08-03T06:28:47.000Z","dependencies_parsed_at":"2023-03-13T11:39:53.341Z","dependency_job_id":null,"html_url":"https://github.com/LunariStudios/ShiroiFX","commit_stats":null,"previous_names":[],"tags_count":0,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/LunariStudios%2FShiroiFX","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/LunariStudios%2FShiroiFX/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/LunariStudios%2FShiroiFX/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/LunariStudios%2FShiroiFX/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/LunariStudios","download_url":"https://codeload.github.com/LunariStudios/ShiroiFX/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":225824593,"owners_count":17529906,"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","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":["game-feel","mit","unity","unity2d","unity3d"],"created_at":"2024-11-22T01:16:29.801Z","updated_at":"2024-11-22T01:16:30.531Z","avatar_url":"https://github.com/LunariStudios.png","language":"C#","funding_links":[],"categories":[],"sub_categories":[],"readme":"\u003ch1 align=\"center\"\u003e\n    \u003cimg src=\"https://raw.githubusercontent.com/BrunoSilvaFreire/ShiroiFX/master/ShiroiFX-Assets/Logo.png\" alt=\"ShiroiFX\" width=\"400\"\u003e\n\u003c/h1\u003e\n\n\u003cp align=\"center\"\u003e\n    \u003cimg src=\"https://img.shields.io/github/license/BrunoSilvaFreire/ShiroiFX.svg\"\u003e\n    \u003cimg src=\"https://img.shields.io/github/last-commit/BrunoSilvaFreire/ShiroiFX.svg\"\u003e\n\u003c/p\u003e  \n\u003cp align=\"middle\"\u003e\n    \u003cimg src=\"https://unity3d.com/profiles/unity3d/themes/unity/images/company/brand/logos/primary/unity-master-black.svg\" width=\"200\"\u003e\n\u003c/p\u003e  \n\n## A library with Game Feel and ease of use, your designers will love you forever   \n# ShiroiFX\nThis library was made to make creating game feel and effects easily.\n  \nLicensed under MIT, feel free to use, contribute, make suggestions and critiques!\n## Installation\n### Direct download\n1. Download the latest release available [here](https://github.com/LunariStudios/ShiroiFX/releases).\n2. Unzip the files into your Unity project _(The /Plugins/ShiroiFX directory is preferred, but not obligatory)_\n3. Wait for Unity to import the library and you're good to go\n### Compiling from sources \n1. Clone the repository.\n2. Install [TsukiSuite](https://github.com/LunariStudios/TsukiSuite) via NuGet.\n3. Compile using MSBuild.\n4. Include the follow\n## Features\n* Created to be absurdly easy to use.\n* Ever wanted to affect something with multiple different values \nand then blend then all together in the final result? We present to you **Services**!\n* Documented \n## Quick Examples\n### Effects\n```csharp\npublic class Projectile : MonoBehaviour {\n    public Effect OnHit;\n    public Effect OnShot;\n\n    public void Shoot(MonoBehaviour owner) {\n        // TODO: Execute launch here\n        // Null safe extension method, only executes if effect is not null\n        OnShot.PlayIfPresent(this, includePositionFeature: true);\n    }\n\n    // Bla bla bla\n        \n    private void OnHitSomething(Collision col) {\n        // TODO: Apply damage somehow\n        var pos = col.contacts.First().point;\n        OnHit.PlayIfPresent(this, features: new PositionFeature(pos));\n    }\n}\n```\n### Services\n```csharp\nvar timeController = new GameObject().AddComponent\u003cTimeController\u003e();\nvar curve = AnimationCurve.EaseInOut(0, 0, 1, 1);\nvar serviceA = timeController.RegisterContinualService(meta: new ConstantTimeMeta(2), priority: 10);\nvar serviceB = timeController.RegisterTimedService(duration: 5, meta: new AnimatedTimeMeta(curve), priority: 20);\n/* \n * Services A and B are automatically blended by the   \n * TimeController based on their priorities\n */\n```\n## Getting Started  \n\nPlease refer to the [Wiki](https://github.com/DDevilISL/ShiroiFX/wiki) for instructions on how to use ShiroiFX\n\n## License\n\nThis project is licensed under the MIT License - see the [LICENSE.md](LICENSE.md) file for details","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Flunaristudios%2Fshiroifx","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Flunaristudios%2Fshiroifx","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Flunaristudios%2Fshiroifx/lists"}