Giter Site home page Giter Site logo

animationpro's Introduction

Animation Pro

view

AnimationPro is a UI and other animation system for Unity. It provides you with a simple API to add smooth animations to your project with ease.

NPM Package openupm Licence Codacy Badge npm

Switch Language

Installation

To install this package via NPM to your Unity project, follow these steps:

Install from a Git URL

You can install the UPM package via directly Git URL. To load a package from a Git URL:

  • Open Unity Package Manager window.
  • Click the add + button in the status bar.
  • The options for adding packages appear.
  • Select Add package from git URL from the add menu. A text box and an Add button appear.
  • Enter the https://github.com/Matuyuhi/AnimationPro.git Git URL in the text box and click Add.
  • You may also install a specific package version by using the URL with the specified version.
    • https://github.com/Matuyuhi/AnimationPro.git#X.Y.Z
    • Please note that the version X.Y.Z stated here is to be replaced with the version you would like to get.
    • You can find all the available releases here.
    • The latest available release version is Last Release

For more information about what protocols Unity supports, see Git URLs.

Install from NPM

  • Navigate to the Packages directory of your project.
  • Adjust the project manifest file manifest.json in a text editor.
  • Ensure https://registry.npmjs.org/ is part of scopedRegistries.
    • Ensure com.matuyuhi is part of scopes.
    • Add com.matuyuhi.animationpro to the dependencies, stating the latest version.

A minimal example ends up looking like this. Please note that the version X.Y.Z stated here is to be replaced with the latest released version, which is currently NPM Package.

{
  "scopedRegistries": [
    {
      "name": "npmjs",
      "url": "https://registry.npmjs.org/",
      "scopes": [
        "com.matuyuhi"
      ]
    }
  ],

  "dependencies": {
    "com.matuyuhi.animationpro": "X.Y.Z"
  }
}
  1. Save and close the manifest.json file.
  2. Open the Unity editor. The package manager should automatically install the AnimationPro package.

Usage

Simple animations that can be easily used by adding them to components

  • In Playing
  • In Setting

Here's a basic example of how to use AnimationPro:

public class SampleAnimation : AnimationBehaviour
{
  // onClick method attach button
  public void OnClick()
  {
    Animation(
      this.SlideOutHorizontal(AnimationAPI.DirectionHorizontal.Right, Easings.CircIn(0.8f)) +
      this.FadeOut(Easings.CircIn(0.5f, 0.2f)),
      new AnimationListener()
      {
        OnFinished = () =>
        {
            gameObject.SetActive(false);
            // imp animation finished callback
        }
      }
    );
  }
}

Contributing

We welcome bug reports and feature requests. Please feel free to make a pull request if you believe you can improve the code.

License

This project is licensed under the MIT license. For more information, please see the LICENSE file.

Author

This project was created by Matuyuhi.

Support or Contact Information

If you have any questions, issues, or want to contribute, feel free to open an issue in this repository or contact me directly.

animationpro's People

Contributors

matuyuhi avatar

Stargazers

Shinedo avatar youchienji avatar  avatar

Watchers

 avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    🖖 Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. 📊📈🎉

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google ❤️ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.