Code Monkey home page Code Monkey logo

mkcast's Introduction

mkcast

A tool for creating GIF screencasts of a terminal, with key presses overlaid.

Dependencies: wmctrl, byzanz-record (slightly patched screenkey already bundled). Only tested on GNOME on Ubuntu so far.

Quickstart

$ sudo ./setup.sh
$ newcast  # opens and casts a new terminal window, finishes recording on exit

How to use

Suggested use: symlink mkcast and newcast in /usr/local/bin (or just run setup.sh), and simply type (in GNOME) Alt+F2 newcast Enter for a quick mini-cast.

This even allows you to set up a gnome-terminal profile called "mkcast," letting you automatically start a command when it opens (such as vim) and finish when the command exits, customize the size or colors of the new terminal that is created, etc.

Usage: ./mkcast WINNAME DURATION [COMMAND (optional)]
Usage: ./newcast [MKCAST ARGS]

Examples:

# cast the window titled "Terminal" for 10 seconds
# (omitting -o will default to out.gif, also supports .webm and .ogg)
./mkcast Terminal 10 -o out.gif

# equivalent to the above, but creates a new terminal for you and finishes
# when the terminal exits instead of after a certain amount of time
./newcast

Why GIF?

I chose GIF because I designed this with the intent that the mini-screencasts be supplemented by text with the full list of keystrokes and an explanation of what's actually happening (specifically, I wrote this with the forthcoming Vim Stack Exchange site in mind).

However, it would be trivial to replace byzanz-record with recordmydesktop and output real video files. That would defeat the original purpose of being a "mini-screencast," though, since it couldn't be ex. easily embedded in ex. a blog post with no extra work for the reader.

What does the name mean?

The name has a double meaning: mini-key-cast, or make cast (like mkdir).

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.