1
Fork 0
mmkr/README.md

43 lines
1.1 KiB
Markdown
Raw Permalink Normal View History

2021-04-13 16:06:13 -04:00
# mmkr
2021-04-13 20:42:07 -04:00
_It's just my handle but shorter_
2021-04-13 16:06:13 -04:00
2021-04-13 20:42:07 -04:00
> This project was created thanks to the help of [create-expression-lib](https://github.com/motiondeveloper/create-expression-lib)!
2021-04-13 16:06:13 -04:00
2021-04-13 20:42:07 -04:00
## Overview
2021-04-13 16:06:13 -04:00
2021-04-13 20:42:07 -04:00
This expressions library is mostly a collection of tools I find personally useful. Some pertain to general tasks and others more specific, i.e. YTPMV/音MAD.
2021-04-13 16:06:13 -04:00
2021-04-13 20:42:07 -04:00
## Usage
2021-04-13 16:06:13 -04:00
2021-04-13 21:11:50 -04:00
1. [Download the latest version of `mmkr.jsx` from the releases page.](https://github.com/stysmmaker/mmkr/releases)
2021-04-13 20:42:07 -04:00
2. Import `mmkr.jsx` into your After Effects project.
3. Reference the library in your expressions like so:
2021-04-13 16:06:13 -04:00
2021-04-13 20:42:07 -04:00
```js
const MMKR = footage('mmkr.jsx').sourceData.get_functions();
2021-04-13 16:06:13 -04:00
```
2021-04-13 20:42:07 -04:00
Functions will now be usable from the `MMKR` object:
```js
const MMKR = footage('mmkr.jsx').sourceData.get_functions();
MMKR.inertial_bounce(5, 2, 4); // Apply a bounce to the current property
2021-04-13 16:06:13 -04:00
```
2021-04-13 20:42:07 -04:00
You can also destructure the returned object:
```js
2021-04-13 22:33:56 -04:00
const { inertial_bounce } = footage('mmkr.jsx').sourceData.get_functions();
2021-04-13 20:42:07 -04:00
inertial_bounce(5, 2, 4);
2021-04-13 16:06:13 -04:00
```
2021-04-13 20:42:07 -04:00
## Development
2021-04-13 16:06:13 -04:00
```sh
2021-04-13 20:42:07 -04:00
# Automatically refresh .jsx output file
npm run watch
2021-04-13 16:06:13 -04:00
2021-04-13 20:42:07 -04:00
# Once off build
npm run build
2021-04-13 16:06:13 -04:00
2021-04-13 20:42:07 -04:00
# Distribute release
npm run release
```