https://github.com/lunaristudios/shiroifx
A Unity Game Feel library, made for designers with a big dose of love
https://github.com/lunaristudios/shiroifx
game-feel mit unity unity2d unity3d
Last synced: 6 months ago
JSON representation
A Unity Game Feel library, made for designers with a big dose of love
- Host: GitHub
- URL: https://github.com/lunaristudios/shiroifx
- Owner: LunariStudios
- License: mit
- Created: 2018-08-10T14:31:44.000Z (almost 7 years ago)
- Default Branch: master
- Last Pushed: 2019-03-13T15:37:51.000Z (about 6 years ago)
- Last Synced: 2024-11-10T18:44:47.531Z (7 months ago)
- Topics: game-feel, mit, unity, unity2d, unity3d
- Language: C#
- Size: 5.39 MB
- Stars: 11
- Watchers: 5
- Forks: 1
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
- License: LICENSE.md
Awesome Lists containing this project
README
## A library with Game Feel and ease of use, your designers will love you forever
# ShiroiFX
This library was made to make creating game feel and effects easily.
Licensed under MIT, feel free to use, contribute, make suggestions and critiques!
## Installation
### Direct download
1. Download the latest release available [here](https://github.com/LunariStudios/ShiroiFX/releases).
2. Unzip the files into your Unity project _(The /Plugins/ShiroiFX directory is preferred, but not obligatory)_
3. Wait for Unity to import the library and you're good to go
### Compiling from sources
1. Clone the repository.
2. Install [TsukiSuite](https://github.com/LunariStudios/TsukiSuite) via NuGet.
3. Compile using MSBuild.
4. Include the follow
## Features
* Created to be absurdly easy to use.
* Ever wanted to affect something with multiple different values
and then blend then all together in the final result? We present to you **Services**!
* Documented
## Quick Examples
### Effects
```csharp
public class Projectile : MonoBehaviour {
public Effect OnHit;
public Effect OnShot;
public void Shoot(MonoBehaviour owner) {
// TODO: Execute launch here
// Null safe extension method, only executes if effect is not null
OnShot.PlayIfPresent(this, includePositionFeature: true);
}
// Bla bla bla
private void OnHitSomething(Collision col) {
// TODO: Apply damage somehow
var pos = col.contacts.First().point;
OnHit.PlayIfPresent(this, features: new PositionFeature(pos));
}
}
```
### Services
```csharp
var timeController = new GameObject().AddComponent();
var curve = AnimationCurve.EaseInOut(0, 0, 1, 1);
var serviceA = timeController.RegisterContinualService(meta: new ConstantTimeMeta(2), priority: 10);
var serviceB = timeController.RegisterTimedService(duration: 5, meta: new AnimatedTimeMeta(curve), priority: 20);
/*
* Services A and B are automatically blended by the
* TimeController based on their priorities
*/
```
## Getting Started
Please refer to the [Wiki](https://github.com/DDevilISL/ShiroiFX/wiki) for instructions on how to use ShiroiFX
## License
This project is licensed under the MIT License - see the [LICENSE.md](LICENSE.md) file for details