Skip to content

kefniark/Fatina

Repository files navigation

Logo

Fatina

Lighweight Tweening Library for Games / Web

NPM Version NPM Download CDN Download Build Status Coverage Status License

Description

A comprehensive and easy to use animation library for Typescript / Javascript

  • Easy to use, API strongly inspired by Dotween (C# tweening library)
  • Lightweight with no dependencies ( < 20KB )
  • Unit tested + code coverage
  • Compatible with NodeJS & Browser & Deno (ESM and CommonJS)
  • Open source and MIT License

Getting Started

Install

If you use NPM

npm install fatina
// or: yarn add fatina

And load it with

// standard import with typescript
import Fatina from 'fatina'

// OR standard node.js require
const Fatina = require('fatina').default

// OR Deno
import Fatina from 'https://cdn.skypack.dev/fatina'

And if you want to use the CDN version (ESM):

<script type="module">import Fatina from 'https://cdn.jsdelivr.net/npm/fatina' // your code</script>

Usage

Fatina.tween(obj).to(destination, duration).start()

// example
Fatina.tween(sprite).to({ x: 12, y: 25 }, 0.5).start()

Development

Getting Started

If you want to take a look at the code or help, it's quite easy to get started

yarn
yarn dev

This will start a server on http://localhost:8080/ where you can test few samples with the current version

Tests

When you are done with your change, just make sure to run tests yarn test

Other

To make a build (generated in build/)

yarn build