kdenframe/README.md
2024-08-05 18:39:15 -06:00

55 lines
1.1 KiB
Markdown

# kdenframe
Generate keyframes for kdenlive.
![showcase](visuals.gif)
## Installation
Clone the repo, then run `make`, and optionally
`sudo make install`, otherwise just run `./kdenframe`
## Usage
```shell
kdenframe -m method [OPTIONS]
```
**Example:**
```shell
# Exponential ease-out for 1080p60 canvas
kdenframe -m expo-out -x 1920 -X 0 # Start from offset 1920 to 0 (right to left)
```
Note: Any project settings that don't match the defaults,
have to be specified, like so:
```shell
# Sine ease-in for 3840p24 canvas
kdenframe -m sine-in -w 3840 -h 2160 -f 24 -x 3840 -X 0
# Notice when not given -W and -H (end width and height) it assumes
# the same values as -w and -h (start width and height)
```
**Default values:**
```C
#define FPS 60.0
#define DUR 1.0
#define POS 0
#define WIDTH 1920
#define HEIGHT 1080
#define OPACITY 1.0
```
**Available options:**
```
-m [expo-in|expo-out|sine-in|sine-out]
-x [Start X pos] -X [End X pos]
-y [Start Y pos] -Y [End Y pos]
-w [Start width] -W [End width]
-h [Start height] -H [End height]
-o [Start opacity] -O [End opacity]
```