https://github.com/JoshFlash/ZenTween

https://github.com/JoshFlash/ZenTween

Last synced: 3 months ago
JSON representation

• Host: GitHub
• URL: https://github.com/JoshFlash/ZenTween
• Owner: JoshFlash
• License: mit
• Created: 2021-05-31T09:16:13.000Z (over 3 years ago)
• Default Branch: master
• Last Pushed: 2021-06-12T01:17:04.000Z (over 3 years ago)
• Last Synced: 2024-08-03T23:13:04.627Z (6 months ago)
• Language: C#
• Size: 1.29 MB
• Stars: 3
• Watchers: 2
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • License: LICENSE.txt

Awesome Lists containing this project

• Awesome-Stride - Tweening library

README

        


**ZenTween** is an easy-to-use C# *tweening* library designed to be used in the Stride Game engine. It aims to be as simple as possible while also being flexible enough for any scenario. ZenTween includes a tweening timeline and multiple helper methods to make tweens simple and easy to work with.

## Installation

**Zip**

1. Download the repository as a .zip file and extract it somewhere.

2. Copy all files into your project.

3. Add the namespace to any files using it and you're ready to go!

## Usage

1. Add the namespace: `using ZenTween;`

2. Create a keyframe: `var keyFrame = new TweenKeyFrame(4000, new Vector3(2, 5, 2), Easing.GetEasingFunction(EasingType.CubicInOut));`

3. Initiate the tween: `Tweening.Tween(Entity.Transform, "Position", keyFrame, LerpFunctions.Vector3);`

4. Call Update every frame: `Tweening.Update(gameTime);`

5. Voila!

You may also use the extension methods such as `Entity.Transform.TweenMove(new Vector3(2, 5, 2), 4f);`

**Wiki**

Coming soon

## Credits

Derived from the Monogame tweening library [Pleasing](https://github.com/franknorton/Pleasing) written by Frank Norton.

Authors:

* Josh Flash

* Frank Norton - Pleasing

## License

ZenTween is under the MIT license (2021). A copy of the license is found in the root of the repository.