ig-animator
v0.0.52
Published
Immutable games animation system
Downloads
60
Readme
Immutable Games Animator
Warning IMMUTABLE GAMES ANIMATOR IS UNSTABLE Since it has not hit the version 1.0 yet, its public interface should not be considered final. Future releases may include breaking changes without further notice. We will do our best to keep this documentation updated providing visibility on breaking changes planned.
An animation framework that combines several libraries together (lottie / gsap / pixi / threejs). Ig-Animator helps to orchestrate syncing multiple animations from After Effects (exported via Bodymovin) and GLTF models in a 3D environment using threeJS.
Installation and configuration
Clone repo
Prerequisites:
- Your Node version needs to be
16.x
. If you've already installed a later version, you'll need to switch to16.x
with a tool like n or nvm.
To install this repository:
git clone [email protected]:immutable/ig-animator.git
cd ig-animator
nvm install && nvm use
(set expected node version)npm install
npm run start
Building
Run npm run build
to build the library or nx build ig-animator
.
Running unit tests
Run nx test ig-animator
to execute the unit tests via Jest.