https://github.com/tckmn/mkcast

[OBSOLETE - see readme] A tool for creating GIF screencasts of a terminal, with key presses overlaid.
https://github.com/tckmn/mkcast

Last synced: 6 days ago
JSON representation

[OBSOLETE - see readme] A tool for creating GIF screencasts of a terminal, with key presses overlaid.

• Host: GitHub
• URL: https://github.com/tckmn/mkcast
• Owner: tckmn
• License: other
• Created: 2015-01-08T03:02:10.000Z (almost 10 years ago)
• Default Branch: master
• Last Pushed: 2019-08-28T01:14:50.000Z (over 5 years ago)
• Last Synced: 2024-11-28T14:43:41.052Z (14 days ago)
• Language: Python
• Homepage:
• Size: 692 KB
• Stars: 3,114
• Watchers: 53
• Forks: 46
• Open Issues: 11
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

• my-awesome-github-stars - tckmn/mkcast - [OBSOLETE - see readme] A tool for creating GIF screencasts of a terminal, with key presses overlaid. (Python)
• awesome-github-repos - tckmn/mkcast - [OBSOLETE - see readme] A tool for creating GIF screencasts of a terminal, with key presses overlaid. (Python)

README

        
# OBSOLETE

mkcast is no longer being maintained (by me, at any rate). It's really just a bundle of hackiness and kludges, so I've essentially rewritten it from scratch: [KeyboardFire/xscast](https://github.com/KeyboardFire/xscast).

xscast's goal is to be usable with any desktop environment. Instead of the buggy screenkey, it uses a dzen2 box to display keys. There are no external Python dependencies; it's written entirely in Bash. It can record any window, instead of relying on moving it to the bottom so that screenkey displays on top of it.

Basically, it's much better. Don't use mkcast.

---

# mkcast

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

![](demo.gif)

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

    $ sudo apt-get install wmctrl byzanz

## Quickstart

    $ sudo make install

    $ 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 `make install`), 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: **m**ini-**k**ey-**cast**, or **m**a**k**e cast (like mkdir).