README.md
1seq2gif
2=======
3[![Build Status](https://travis-ci.org/saitoha/seq2gif.svg?branch=master)](https://travis-ci.org/saitoha/seq2gif)
4[![Coverage Status](https://img.shields.io/coveralls/saitoha/seq2gif.svg)](https://coveralls.io/r/saitoha/seq2gif)
5
6
7Description
8------------
9
10This software converts a sequences record file generated by [ttyrec](https://github.com/mjording/ttyrec)
11into a gif animation directly(without taking screenshots),
12by using portable built-in terminal emulation engine originated
13from [yaft](https://github.com/uobikiemukot/yaft).
14[yaft](https://github.com/uobikiemukot/yaft) provides rare terminal emulation
15features such as SIXEL/DRCS.
16
17
18Demo
19----
20
21Play [sl](https://github.com/mtoyoda/sl).
22
23![img2sixel](https://raw.githubusercontent.com/saitoha/seq2gif/master/images/sl.gif)
24
25
26Show SIXEL animation with [img2sixel](https://github.com/saitoha/libsixel#img2sixel).
27
28![img2sixel](https://raw.githubusercontent.com/saitoha/seq2gif/master/images/sixel.gif)
29
30
31The following demo plays [sl](https://github.com/mtoyoda/sl) and records it with [ttyrec](https://github.com/mjording/ttyrec), and
32converts that record into a GIF animation using seq2gif,
33and converts that GIF into a SIXEL animation and plays it with [img2sixel](https://github.com/saitoha/libsixel#img2sixel).
34Furthermore, generates the log record of above experience using [ttyrec](https://github.com/mjording/ttyrec), and
35converts that log into the following GIF animation.
36
37![ttyrec](https://raw.githubusercontent.com/saitoha/seq2gif/master/images/ttyrec.gif)
38
39
40Download
41--------
42Source package and Windows binary is [available](https://github.com/saitoha/seq2gif/releases/).
43
44
45Build and Install
46-----------------
47
48This software works in Windows, Linux, BSDs and OSX.
49If you want to build windows native build, [MinGW](http://www.mingw.org/) is required.
50
51```
52 $ ./configure
53 $ make
54 # make install
55```
56
57Usage
58-----
59
60```
61Usage: seq2gif [Options] < ttyrecord > record.gif
62 seq2gif [Options] -i ttyrecord -o record.gif
63
64Options:
65-w WIDTH, --width=WIDTH specify terminal width in cell size.
66 (default: 80)
67-h HEIGHT, --height=HEIGHT specify terminal height in cell size.
68 (default: 24)
69-l DELAY, --last-frame-delay=DELAY specify delay in msec which is added
70 to the last frame. (default: 300)
71-f COLORNO --foreground-color=COLORNO specify foreground color palette.
72 number.
73-b COLORNO --background-color=COLORNO specify background color palette
74 number.
75-c COLORNO --cursor-color=COLORNO specify cursor color palette
76 number.
77-t TABSTOP --tabstop=TABSTOP specify hardware tabstop(default: 8)
78-j --cjkwidth treat East Asian Ambiguous width
79 characters (UAX#11) as wide.
80-r COUNT --repeat=COUNT specify animation repeat count. loop
81 infinitely if 0 is given. (default: 0)
82-i FILE --input=FILE specify input file name. use STDIN
83 if '-' is given. (default: '-')
84-o FILE --output=FILE specify output file name. use STDOUT
85 if '-' is given. (default: '-')
86-V, --version show version and license information.
87-H, --help show this help.
88```
89
90
91Acknowledgements
92----------------
93
94### recterm
95
96This program is derived from [recterm](https://github.com/uobikiemukot/recterm)
97written by haru <uobikiemukot at gmail dot com> ([@uobikiemukot](https://github.com/uobikiemukot/))
98
99### yaft
100
101Some part of glyph data generator(glyph/*) is imported from [yaft](http://uobikiemukot.github.io/yaft/)
102written by haru <uobikiemukot at gmail dot com> ([@uobikiemukot](https://github.com/uobikiemukot/))
103
104### gifsave89
105
106GIF encoder (gifsave89.c) is imported from [gifsave89](http://www.forkosh.com/gifsave90.html)
107distributed under GPLv3+ by [John Forkosh Associates, Inc.](http://www.forkosh.com)(john@forkosh.com)
108
109### milkjf
110This package includes a milkjf font and its derivative(gryph/milkjf.h).
111Original milkjf font was designed by japanfarm (Nihon-Nouen) and used on Sharp X68000 series.
112Chisato Yamauchi converted milkjf font to bdf for X Window System.
113haru([@uobikiemukot](https://github.com/uobikiemukot/)) converted it to a C-styled header file.
114
115### M+ BITMAP FONTS
116This package includes [M+ Bitmap Font](http://mplus-fonts.sourceforge.jp/mplus-bitmap-fonts/index.html)
117and its derivative(gryph/mplus.h).
118
119License:
120
121```
122M+ BITMAP FONTS Copyright 2002-2005 COZ <coz@users.sourceforge.jp>
123
124LICENSE
125
126These fonts are free softwares.
127Unlimited permission is granted to use, copy, and distribute it, with
128or without modification, either commercially and noncommercially.
129THESE FONTS ARE PROVIDED "AS IS" WITHOUT WARRANTY.
130```
131
132### GNU Unifont
133This package includes [GNU Unifont Glyphs](http://unifoundry.com/unifont.html)
134and its derivative(gryph/unifont.h).
135
136License: GPLv2+
137http://unifoundry.com/LICENSE.txt
138
139
140```
141M+ BITMAP FONTS Copyright 2002-2005 COZ <coz@users.sourceforge.jp>
142
143LICENSE
144
145These fonts are free softwares.
146Unlimited permission is granted to use, copy, and distribute it, with
147or without modification, either commercially and noncommercially.
148THESE FONTS ARE PROVIDED "AS IS" WITHOUT WARRANTY.
149```
150
151### M+ BITMAP FONTS
152This package includes a C header file derived from M+ font(gryph/mplus.h).
153
154
155### Markus Kuhn's wcwidth
156This package includes Markus Kuhn's wcwidth(mk_wcwidth)
157
158```
159Markus Kuhn -- 2007-05-26 (Unicode 5.0)
160
161Permission to use, copy, modify, and distribute this software
162for any purpose and without fee is hereby granted. The author
163disclaims all warranties with regard to this software.
164
165Latest version: http://www.cl.cam.ac.uk/~mgk25/ucs/wcwidth.c
166```
167
168Contributors
169-------------
170
171- [@arakiken](https://bitbucket.org/arakiken/profile/repositories)
172- [IWAMOTO Kouichi(@ttdoda)](https://github.com/ttdoda)
173
174
175Similar Software
176----------------
177
178### [sugyan/ttyrec2gif](https://github.com/sugyan/ttyrec2gif)
179
180This also generates GIF animation without taking screenshots, written in [Go](http://golang.org/).
181Using [j4k.co/terminal](http://godoc.org/j4k.co/terminal) as terminal emulation engine().
182It is derived from [sugyan/ttygif](https://github.com/sugyan/tty2gif).
183
184
185### [uobikiemukot/recterm/tools/rec2gif.c](https://github.com/uobikiemukot/recterm/blob/master/tools/rec2gif.c)
186
187Additional tools which uses [yaft](https://github.com/uobikiemukot/yaft) terminal emulation engine,
188distributed with [uobikiemukot/recterm](https://github.com/uobikiemukot/recterm/).
189
190
191References
192----------
193
194### [ttyrec](http://0xcc.net/ttyrec/index.html.en)
195
196A tty recorder.
197
198### [ttyrec4windows](https://github.com/mattn/ttyrec4windows)
199
200A Windows port for [ttyrec](http://0xcc.net/ttyrec/index.html.en) written in [Go](http://golang.org/).
201
202
203License
204-------
205
206![GPLv3](https://raw.githubusercontent.com/saitoha/seq2gif/master/images/gplv3.png)
207
208
README.milkjf
README.mplus
1-
2M+ BITMAP FONTS Copyright 2002-2005 COZ <coz@users.sourceforge.jp>
3-
4
5README
6
7
8
9
10M+ BITMAP FONTS were designed to be simple and highly readable.
11It incorporates all Kanji (Chinese character in Japanese) until
12level 2 (the one described in JISX0208).
13
14With the increasing availability of powerful PCs, scalable fonts and
15anti-aliasing, one could question the need of such fonts nowadays,
16slow PCs and the increasing popularity of mobile phone with limited resources
17etc. are still in need of such font,
18and I have there started creating this font foundry at my own pace.
19
20
21
22
23Through the provided shell script "install_mplus_fonts", the following
24fonts will be installed.
25
26
27Latin fonts
28
29+ mplus-fxd (10, 12 dots)
30 Created as an alternative to the "fixed" font.
31 -
32 mplus_f10r
33 mplus_f10r-euro *1
34 mplus_f12r
35 mplus_f12r-euro *1
36 mplus_f10b
37 mplus_f10b-euro *1
38 mplus_f12b
39 mplus_f12b-euro *1
40
41+ mplus-hlv (10, 12 dots)
42 Created as an alternative to the "helvetica" font.
43 -
44 mplus_h10r
45 mplus_h10r-euro *1
46 mplus_h12r
47 mplus_h12r-euro *1
48 mplus_h10b
49 mplus_h10b-euro *1
50 mplus_h12b
51 mplus_h12b-euro *1
52
53+ mplus-hlvw (10, 12 dots)
54 The space between character compared with "mplus-hlv (h12r)" being slightly
55 increased the readibility of small fonts on large displays increases.
56 -
57 mplus_h12rw
58 mplus_h12rw-euro *1
59
60+ mplus-sys (10 dots)
61 Prepared for display in window titles and menu.
62 -
63 mplus_s10r
64 mplus_s10r-euro *1
65 mplus_s10b
66 mplus_s10b-euro *1
67
68+ mplus-qub (6 dots)
69 Minimum 6 dot size font.
70 -
71 mplus_q06r
72 mplus_q06r-euro *1
73
74*1 Euro symbol (iso8859-15)
75
76
77Japanese Fonts
78
79+ Aliases are set for future mappings of the fonts (mplus_j10*,mplus_j12*).
80 "jisx0208.1983-0" -> "jisx0208.1990-0"
81
82+ mplus-gothic (10, 12 dots)
83 -
84 mplus_j10r (*1)
85 mplus_j10r-jisx
86 mplus_j10r-iso
87 mplus_j10b (*1)
88 mplus_j10b-jisx
89 mplus_j10b-iso
90 mplus_j12r
91 mplus_f12r-jisx
92 mplus_f12r-iso
93 mplus_j12b
94 mplus_f12b-jisx
95 mplus_f12b-iso
96
97+ mplus-goth_p (10, 12 dots)
98 This font is the "mplus-gothic" fonts described up here with the
99 roman characters set as proportional.
100 In browsers like Mozilla, it might be difficult to read though.
101 Please set your browser preferences with
102 pref("font.scale.aa_bitmap.enable",false).
103 -
104 mplus_h10r-jisx
105 mplus_h10r-iso
106 mplus_h10b-jisx
107 mplus_h10b-iso
108 mplus_h12r-jisx
109 mplus_h12r-iso
110 mplus_h12b-jisx
111 mplus_h12b-iso
112
113*1 Incorporates level 1 Kanji characters.
114 Now, I'm working to finish all level 2 Kanji characters.
115
116
117M+ cursors
118
119+ mplus_cursors.bdf
120 You will need to edit shell script "install_mplus_fonts" to install it.
121 Please read the explanations in the provided file INSTALL_E.
122
123
124
125
126Anonymous CVS Access
127
128
129M+ BITMAP FONTS CVS repository can be checked out through
130anonymous (pserver) CVS with the following instruction set.
131
1321. "cvs -d:pserver:anonymous@cvs.sourceforge.jp:/cvsroot/mplus-fonts login"
133
1342. When prompted for a password like "CVS password: ",
135 simply press the Enter key.
136
1373. "cvs -z3 -d:pserver:anonymous@cvs.sourceforge.jp:/cvsroot/mplus-fonts \
138 co mplus_bitmap_fonts"
139
140To update, hit the following command in "mplus_bitmap_fonts" directory.
141
1424. "cvs update -dP"
143
144You will need to run install script "install_mplus_fonts" again.
145
146
147Latest informations can be found at the following project address.
148
149M+ BITMAP FONTS
150http://mplus-fonts.sourceforge.jp/mplus-bitmap-fonts/index.html
151
152
153
154
155M+ OUTLINE FONTS
156
157Free Japanese outline fonts project "M+ OUTLINE FONTS", start working!
158See. also,
159
160http://mplus-fonts.sourceforge.jp/mplus-outline-fonts/index.html
161(Japanese)
162
163
164
165
166[ Special thanks to Mr.Guillaume Proux ]
167