https://github.com/pqml/ae-read-curves
Read After Effects curves exported by ae-export-curves
https://github.com/pqml/ae-read-curves
Last synced: 22 days ago
JSON representation
Read After Effects curves exported by ae-export-curves
- Host: GitHub
- URL: https://github.com/pqml/ae-read-curves
- Owner: pqml
- License: mit
- Created: 2018-03-11T00:52:52.000Z (about 7 years ago)
- Default Branch: master
- Last Pushed: 2018-03-11T19:46:17.000Z (about 7 years ago)
- Last Synced: 2025-03-24T19:45:44.952Z (about 1 month ago)
- Language: JavaScript
- Size: 87.9 KB
- Stars: 8
- Watchers: 0
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
ae-read-curves
Read After Effects curves exported by ae-export-curves
## Example
Example on [https://pqml.github.io/ae-read-curves](https://pqml.github.io/ae-read-curves)
## Features
- Read curves exported by [ae-export-curves](https://github.com/pqml/ae-export-curves)
- Get property values at a precise time, with the `seek()` function
- Tiny module, < 1ko gziped
## Module Installation & Usage
##### Installation from npm
```sh
# using npm
$ npm install --save ae-read-curves
# or using yarn
$ yarn add ae-read-curves
```
##### Usage with a module bundler
```js
// using ES6 module
import readCurves from 'ae-read-curves'
// using CommonJS module
const readCurves = require('ae-read-curves')
const comp = readCurves(json)
console.log(comp.duration) // get duration of the composition
console.log(comp.width) // get width of the composition
console.log(comp.height) // get height of the composition
comp.seek(0.5) // go to the middle of the composition timeline
console.log(comp.values.translateX) // get translateX property value at 0.5 progress
```
##### Usage from a browser
```html
var comp = window.AEReadCurves(json)
comp.seek(0.1)
console.log(comp.values.translateX)
```
## Development commands
- `npm install` - Install all npm dependencies
- `npm run start` - Start the dev server with livereload on the example folder
- `npm run build` - Bundle your library in CJS / UMD / ESM
- `npm run deploy` - Deploy your example folder on a gh-page branch
- `npm run test` - Lint your js inside the src folder
## License
MIT.