superpowers-game-ftween-plugin/readme.md

Easy tweening (animation of values) for the supGame system for Superpowers, the extensible HTML5 2D+3D game engine.

# Superpowers Game fTween plugin

[![Build Status](https://travis-ci.org/florentpoujol/superpowers-game-ftween-plugin.svg?branch=travis)](https://travis-ci.org/florentpoujol/superpowers-game-ftween-plugin)

Exposes the `fTween` and `FTWEEN` namespaces to the Typescript API of the `Superpowers Game` system of [Superpowers, the extensible HTML5 2D+3D game engine](http://superpowers-html5.com).

`FTWEEN` is the [ftween.js library](https://github.com/florentpoujol/ftween.js), a fork of the popular `tween.js` library.  

`fTween` is a nice wrapper (with mostly the `fTween.Tween` class) around it to make things a lot easier to use in your game code.

Just so that you don't get confused, be aware that the `tweenjs` plugin (by SparklinLabs, Superpowers' devs) exposes the `TWEEN` module (the original tween.js) and the `Sup.Tween` actor component.


## Documentation

[http://florentpoujol.github.io/superpowers-game-ftween-plugin](http://florentpoujol.github.io/superpowers-game-ftween-plugin)

You can also access it offline in Superpowers' client with the [Plugins documentation](https://github.com/florentpoujol/superpowers-common-pluginsdocs-plugin) plugin, or find it directly in the plugin's `public/docs` folder.


## Installation

[Download the latest release](https://github.com/florentpoujol/superpowers-game-ftween-plugin/releases), unzip it, rename the folder to `ftween`, move it inside `app/systems/supGame/plugins/florentpoujol/` then restart your server.

__Advanced:__

Get it via `npm`:

    cd app/systems/supGame/plugins
    npm install superpowers-game-ftween-plugin

The name of the vendors or plugins in the `app/systems/supGame/plugins/` folder don't matter.  
So you can leave the plugin path as `node_modules/superpowers-game-ftween-plugin`.