README.template.md

yeetgif

Composable GIF effects CLI, with reasonable defaults. Made for custom Slack/Discord emoji :)

• Get it
  • Alternative 1: go get
  • Alternative 2: just download the binary
  • Alternative 3: docker
• Use it
• Hall of Fame
• Usage
  • Conventions & tips
  • roll
  • wobble
  • pulse
  • zoom
  • shake
  • woke
  • fried
  • hue
  • tint
  • resize
  • crop
  • optimize
  • compose
  • crowd
  • erase
  • chop
  • text
  • emoji
  • rain
  • cat
  • meta
• Licensing

Get it

Alternative 1: go get

go get -u github.com/sgreben/yeetgif/cmd/gif

Alternative 2: just download the binary

Either from the releases page, or from the shell:

# Linux
curl -L https://github.com/sgreben/yeetgif/releases/download/${VERSION}/gif_${VERSION}_linux_x86_64.tar.gz | tar xz

# OS X
curl -L https://github.com/sgreben/yeetgif/releases/download/${VERSION}/gif_${VERSION}_osx_x86_64.tar.gz | tar xz

# Windows
curl -LO https://github.com/sgreben/yeetgif/releases/download/${VERSION}/gif_${VERSION}_windows_x86_64.zip
unzip gif_${VERSION}_windows_x86_64.zip

NOTE: To use the optimize command, you'll also need the giflossy fork of gifsicle installed:

brew install giflossy

You'll likely also want to have the binary in your $PATH. You can achieve this by adding this to your .bashrc (or .zshrc, ...):

export PATH=<directory-containing-the-gif-binary>:$PATH

Alternative 3: docker

docker pull quay.io/sergey_grebenshchikov/yeetgif
docker tag quay.io/sergey_grebenshchikov/yeetgif gif # (optional)

Use it

<doc/yeet.png gif fried | gif wobble  >doc/yeet.gif

gif emoji aubergine | gif wobble >doc/eggplant_wobble.gif

Hall of Fame

Post a GIF made using yeetgif with either the

• #yeetgif Twitter hashtag
• and/or the #yeetgif Giphy hashtag
• and/or the #yeetgif Imgur hashtag

Best Most utterly demented ones end up below!

No entries yet. Be the first :)

Usage

${USAGE}

Conventions & tips

• To find out how a given example was made, try running gif meta show on it (e.g. <yeet.gif gif meta show -p will print the shell pipe of gif effects used to create yeet.gif).
• Use the --raw (-r) option for intermediate pipe steps -- this is faster than re-encoding as GIF every time. Also it's lossless.
• Options with bracketed default values (e.g. --noise of fried) can take comma-separated values - the points will be spread over the animation length, with intermediate values linearly interpolated.
• To figure out what a parameter does, try out some values around its default value, as well as much larger/smaller ones.
• To reduce GIF size, try specifying a smaller number of duplicates for static images (e.g. gif -n 20), gif optimize, and dropping frames gif chop drop every <N>.

roll

${USAGE_roll}

wobble

${USAGE_wobble}

pulse

${USAGE_pulse}

zoom

${USAGE_zoom}

shake

${USAGE_shake}

woke

${USAGE_woke}

fried

${USAGE_fried}

hue

${USAGE_hue}

tint

${USAGE_tint}

resize

${USAGE_resize}

crop

${USAGE_crop}

optimize

${USAGE_optimize}

compose

${USAGE_compose}

crowd

${USAGE_crowd}

erase

${USAGE_erase}

chop

${USAGE_chop}

text

woke | text | fried

${USAGE_text}

emoji

emoji | compose <(emoji) | compose <(emoji) | wobble | fried

${USAGE_emoji}

rain

emoji | rain

emoji | roll | rain <(emoji) <(emoji)

emoji | pulse | rain <(emoji) | compose | fried

${USAGE_rain}

cat

${USAGE_cat}

meta

$ <doc/yeet.gif gif meta show

[2018-10-05T13:08:57+02:00] gif fried
[2018-10-05T13:08:58+02:00] gif wobble
[2018-10-05T13:08:58+02:00] gif crop
[2018-10-05T13:08:58+02:00] gif optimize -x 0

$ <doc/yeet.gif gif meta show -p

gif fried | gif wobble | gif crop | gif optimize -x 0

$ <doc/yeet.gif gif meta show --raw

{"appName":"gif","timestamp":"2018-10-05T13:08:57+02:00","args":["fried"],"version":"1.0.0-244bcd73467a0979cb872f0e90ba8a69d4764410"}
{"appName":"gif","timestamp":"2018-10-05T13:08:58+02:00","args":["wobble"],"version":"1.0.0-244bcd73467a0979cb872f0e90ba8a69d4764410"}
{"appName":"gif","timestamp":"2018-10-05T13:08:58+02:00","args":["crop"],"version":"1.0.0-244bcd73467a0979cb872f0e90ba8a69d4764410"}
{"appName":"gif","timestamp":"2018-10-05T13:08:58+02:00","args":["optimize","-x","0"],"version":"1.0.0-244bcd73467a0979cb872f0e90ba8a69d4764410"}

${USAGE_meta}

Licensing

• yeetgif itself & any original code: MIT License
• Modified copy of github.com/disintegration/imaging: MIT License
• Modified copy of github.com/fogleman/gg: MIT License
• Roboto Regular TrueType Font: Apache License 2.0
• Twemoji by Twitter: CC BY 4.0
• Modified portion of github.com/ByteArena/box2d by ByteArena (Go port)/Erin Catto (C++ original): MIT License