{"id":20596058,"url":"https://github.com/davidfig/pixi-ease","last_synced_at":"2025-05-08T21:35:07.837Z","repository":{"id":37789580,"uuid":"103220391","full_name":"davidfig/pixi-ease","owner":"davidfig","description":"pixi.js animation library using easing functions","archived":false,"fork":false,"pushed_at":"2022-07-20T10:27:14.000Z","size":12896,"stargazers_count":100,"open_issues_count":18,"forks_count":11,"subscribers_count":3,"default_branch":"master","last_synced_at":"2025-02-02T03:54:09.681Z","etag":null,"topics":["animate","ease","easing","pixi"],"latest_commit_sha":null,"homepage":"","language":"JavaScript","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/davidfig.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null}},"created_at":"2017-09-12T04:01:59.000Z","updated_at":"2025-01-25T04:14:58.000Z","dependencies_parsed_at":"2022-08-18T07:51:19.736Z","dependency_job_id":null,"html_url":"https://github.com/davidfig/pixi-ease","commit_stats":null,"previous_names":[],"tags_count":8,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/davidfig%2Fpixi-ease","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/davidfig%2Fpixi-ease/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/davidfig%2Fpixi-ease/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/davidfig%2Fpixi-ease/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/davidfig","download_url":"https://codeload.github.com/davidfig/pixi-ease/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":238044095,"owners_count":19407128,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["animate","ease","easing","pixi"],"created_at":"2024-11-16T08:14:54.429Z","updated_at":"2025-02-10T02:10:40.866Z","avatar_url":"https://github.com/davidfig.png","language":"JavaScript","funding_links":[],"categories":[],"sub_categories":[],"readme":"# pixi-ease\na simple and powerful pixi.js easing/tweening/animating library\n\n## features\n* ease any pixi.js parameter, including tint (using a blend function or stepped)\n* use any Penner function by name or any user-defined function\n* support for generic number parameters\n* change scale or skew using one parameter (e.g., scale: 5 changes both scale.x and scale.y)\n* set default durations and easing function for all eases\n* uses eventemitter3 for events for both the easing lists and individual eases\n* tracks eases on DisplayObject and cleans up when DisplayObject is destroyed\n* includes a default easing list so you don't have to instantiate for simple cases\n* includes a shake parameter\n* good test coverage\n\n## Live Demo\n[https://davidfig.github.io/pixi-ease/](https://davidfig.github.io/pixi-ease/)\n\n## Migrating to v3\n* changed default update loop to use requestAnimationFrame to remove the dependency on pixi.js\n* to use PIXI.Ticker (like in v2), pass `new Ease({ ticker: PIXI.Ticker.shared })`\n* ordinary usage should be unchanged\n\n## Installation\n\n    yarn add pixi-ease\n\nor [grab the latest release](https://github.com/davidfig/pixi-ease/releases/) and use it:\n\n```html\n\u003cscript src=\"/directory-to-file/pixi.js\"\u003e\u003c/script\u003e\n\u003cscript src=\"/directory-to-file/pixi-ease.js\"\u003e\u003c/script\u003e\n\u003c!-- or \u003cscript type=\"module\" src=\"/directory-to-file/pixi-ease.es.js\"\u003e\u003c/script\u003e --\u003e\n\u003cscript\u003e\n    const ease = new Ease.Ease(options)\n    Ease.add(...)\n    // or Ease.ease.add(...)\n\u003c/script\u003e \n```\n\n## API Documentation\n[https://davidfig.github.io/pixi-ease/jsdoc/](https://davidfig.github.io/pixi-ease/jsdoc)\n\n## Simple Usage\n```js\nimport * as PIXI from 'pixi.js'\nimport { Ease, ease } from 'pixi-ease'\n\nconst app = new PIXI.Application()\nconst test = app.stage.addChild(new PIXI.Sprite(PIXI.Texture.WHITE))\ntest.tint = 0x00ff00\n\nconst example = ease.add(test, { x: 20, y: 15, alpha: 0.25, rotation: 20, scale: 5, skewX: 0.25, blend: 0xff0000 } }, { reverse: true, duration: 2500, ease: 'easeInOutQuad' })\nexample.on('each', () =\u003e console.log('ease updated object during frame using PIXI.Ticker.'))\nexample.once('complete', () =\u003e console.log('move ease complete.'))\n\ntest.generic = 25\nconst generic = ease.add(test, { generic: 0 }, { duration: 1500, ease: 'easeOutQuad' })\ngeneric.on('each', () =\u003e console.log(test.generic))\n\nconst secondEase = new Ease({ duration: 3000, wait: 1500, ease: 'easeInBack', repeat: 3 })\nconst test2 = app.stage.addChild(new PIXI.Sprite(PIXI.Texture.WHITE))\nsecondEase.add(test2, { tint: [0xff0000, 0x00ff00, 0x000ff], scaleX: 2 })\n```\n\n## Build Examples\nI've included a bunch of build examples in the builds directory, including: [browserify](https://github.com/davidfig/pixi-ease/tree/master/builds/browserify), [rollup](https://github.com/davidfig/pixi-ease/tree/master/builds/rollup), [standalone (e.g., cdn)](https://github.com/davidfig/pixi-ease/tree/master/builds/standalone), [standalone (pixi.js v4)](https://github.com/davidfig/pixi-ease/tree/master/builds/standalone-v4), and [typescript](https://github.com/davidfig/pixi-ease/tree/master/builds/typescript).\n  \n## Tests\n\n1. Clone repository\n2. yarn install\n3. yarn test (for Mocha test code)\n4. yarn coverage (for Instanbul coverage)\n\n### To run demo locally:\n1. Clone repository\n2. yarn install\n3. yarn build \n4. yarn dev\n5. open browser to http://localhost:10001\n\n### To run build examples:\n1. Clone repository\n2. yarn install\n3. yarn build\n4. yarn builds\n5. yarn test-builds\n6. open browser to http://localhost:5000\n\n## Other Libraries\nIf you liked pixi-ease, please try my other open source libraries:\n* [pixi-viewport](https://github.com/davidfig/pixi-viewport) - A highly configurable viewport/2D camera designed to work with pixi.js.\n* [pixi-scrollbox](https://github.com/davidfig/pixi-scrollbox) - pixi.js scrollbox: a masked box that can scroll vertically or horizontally with scrollbars (uses pixi-ease)\n* [intersects](https://github.com/davidfig/intersects) - a simple collection of 2d collision/intersects functions. Supports points, circles, lines, axis-aligned boxes, and polygons \n\n## License\nMIT License (c) 2019 [YOPEY YOPEY LLC](https://yopeyopey.com/) by [David Figatner](https://twitter.com/yopey_yopey/)","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fdavidfig%2Fpixi-ease","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fdavidfig%2Fpixi-ease","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fdavidfig%2Fpixi-ease/lists"}