Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/dergachev/screengif
Create animated gif screencasts.
https://github.com/dergachev/screengif
Last synced: 1 day ago
JSON representation
Create animated gif screencasts.
- Host: GitHub
- URL: https://github.com/dergachev/screengif
- Owner: dergachev
- License: mit
- Created: 2013-02-20T19:58:06.000Z (almost 12 years ago)
- Default Branch: master
- Last Pushed: 2020-07-31T08:09:56.000Z (over 4 years ago)
- Last Synced: 2024-10-29T17:41:29.183Z (2 months ago)
- Language: Ruby
- Size: 4.99 MB
- Stars: 1,316
- Watchers: 15
- Forks: 53
- Open Issues: 16
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- License: LICENSE
Awesome Lists containing this project
- awesome-gif - Screengif - Create animated GIF screencasts. (Utilities)
- awesome-starred - dergachev/screengif - Create animated gif screencasts. (others)
README
# Screengif
A commandline tool to convert SCREENCAST.mov into ANIMATED.gif
Here's what happens when you apply it to [demo.mov](https://raw.github.com/dergachev/screengif/master/demo.mov)
## Usage
```
screengif - Convert your screencast into a gif.
Usage:
screengif [options] [--input FILENAME.mov] [--output OUTPUTFILE.gif]
Examples:
screengif --input demo.mov --output out.gif
cat somefile.gif | screengif --progressbar --framerate 10 --delay 50 --delay-last 5 > out.gif
Specific options:
-i, --input FILENAME.mov Use ffmpeg to convert FILENAME.mov into PPM image stream and process results.
If missing, will process PPM or GIF image stream from STDIN.
-o, --output FILENAME.gif Output resulting GIF data to FILENAME.gif. (defaults to STDOUT).
-p, --progressbar Overlay progress bar on the animation.
-d, --delay MS Animation frame delay, in tens of ms. (default: 10)
--delay-last MS Animation frame delay of last frame, in tens of ms. (default: 50)
-r, --framerate FPS Specify amount of frames per second to keep. (default: 5)
-w, --max-width PIXELS Output image max width, in pixels.
--max-height PIXELS Output image max height, in pixels.
--no-contrast Skip increasing contrast using imagemagick.
-f, --fuzz PERCENT Imagemagick fuzz factor for color reduction. (default: 5%)
--no-coalesce Skip Magick::ImageList#coalesce() if input doesn't need it.
--no-gifsicle Prevent filter the output through gifsicle. Greatly increases output file size.
-h, --help Show this message
-v, --verbose Verbose output
--version Show version
```
## Installation
### Under Docker
If you have docker running, this is the quickest way to get
started with screengif:
```
git clone [email protected]:dergachev/screengif.git
cd screengif
make build # or alternatively, 'docker pull dergachev/screengif'
make docker-convert args="-i demo.mov -o demo-docker.gif"
# input files must be relative to cloned screengif repo
cp /path/to/myMovie.mov .
make docker-convert args="-i myMovie.mov -o myMovie.gif"
```
See Dockerfile and Makefile for how it works.
### With Vagrant
If you have Vagrant and Virtualbox already installed, this is both faster and cleaner than downloading and compiling all the dependencies in OS X. To install, simply do the following:
```
vagrant up
```
The easiest way to use it is to copy your image to screengif project directory (shared in the VM under /vagrant), and run the following:
```
cp ~/screencast.mov ./screencast.mov
vagrant ssh -- '/vagrant/bin/screengif --input /vagrant/screencast.mov --output /vagrant/output/screencast.gif'
ls ./output/screencast.gif # should exist!
# when finished, destroy the VM
vagrant destroy -f
```
### On OSX, with homebrew
The following works with OS X and homebrew, assuming you have ruby 1.9.2+:
You may need to install brew-cask: https://github.com/phinze/homebrew-cask
```bash
# x-quartz is a dependency for gifsicle, no longer installed starting on 10.8
brew cask install xquartz
open /usr/local/Caskroom/xquartz/2.7.11/XQuartz.pkg # runs the XQuartz installer
brew install ffmpeg imagemagick@6 gifsicle pkg-config
gem install screengif # might need sudo
```
To be able to use the `--progressbar` option, you also need to install ghostscript and some fonts for it:
```bash
brew install gs
cd /usr/local/share/ghostscript/
wget https://ghostscript.googlecode.com/files/ghostscript-fonts-std-8.11.tar.gz
tar xzvf ghostscript-fonts-std-8.11.tar.gz
```
If running screengif shows an errror `Library not loaded: libMagickCore-6.Q16.1.dylib`, see [#26](https://github.com/dergachev/screengif/issues/26).
## Tips
See https://gist.github.com/dergachev/4627207#os-x-screencast-to-animated-gif
for a guide on how to use Quicktime Player to record a screencast on OS X.
Keep in mind that other tools (like Screenflow) produce better video quality.
If you install [dropbox-screenshots](https://github.com/dergachev/dropbox-screenshots),
the following will automatically upload your new gif to Dropbox:
cp out.gif ~/Dropbox/Public/screenshots
## Resources
See [DEVNOTES](https://github.com/dergachev/screengif/blob/master/DEVNOTES.md)