termsketch 0.1.0

A command-line image to text conversion tool
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145

# termsketch

[![Build Status](https://github.com/ulyssa/termsketch/workflows/CI/badge.svg)](https://github.com/ulyssa/termsketch/actions?query=workflow%3ACI+)
[![License: Apache 2.0](https://img.shields.io/crates/l/termsketch.svg?logo=apache)](https://crates.io/crates/termsketch)
[![Latest Version](https://img.shields.io/crates/v/termsketch.svg?logo=rust)](https://crates.io/crates/termsketch)
[![Docs Status](https://docs.rs/termsketch/badge.svg)](https://docs.rs/crate/termsketch/)

## About

This is a tool for converting images to text. It supports two different conversion modes:

- `grayscale`, a typical conversion onto a map of light to dark characters to produce a grayscale image.
- `outline`, a conversion onto visually similar characters done region-by-region, to help produce output that makes better use of negative space than the grayscale conversion.

## Examples

You can see the visual difference between the two modes on this [image][witch-hat]:

```
% termsketch outline ./witch-hat-2.png






                                           ⠃⠁⠁⠁⠇
                                          ⠃      ⠁
                                         ⠃    ⡀⡄⡄⡄⡀⡁
                                        ⠃    ⡂
                                       ⠃     ⠅
                                      ⠇      ⠁
                                     ⡇        ⡃
                                    ⡃         ⠁
                                   ⡇           ⡃
                                   ⠃
                                  ⡇             ⠁
                                 ⡇               ⠃
                                 ⠁
                                ⡇                 ⠁
                               ⡇                   ⠁
                               ⠃                    ⡃
                              ⡇                                ⡇⠇⠃⡇⠃⠃⠃⠇
                             ⡇                      ⡀⡁    ⠇⠃⠁⠃
                     ⠇⠃⠃⠇⠁⠁  ⠇                   ⡀⡄⡅  ⠃⠁⠁               ⡅
                ⠇⠃⠁⠇      ⡂ ⡇                 ⡀⡄⡅     ⡇⡆⡄⡀⡀           ⡀⡆
             ⠃⠁⠁            ⠁               ⡀⡆              ⡆⡆⡄⡇⡄⡇⡄⡆⡆
           ⠃⠁            ⡂ ⡇             ⡀⡄
         ⠃⠁             ⡀  ⡄⡀⡆⡀⡀⡀⡀⡀⡀⡀⡀⡄⡆
        ⡃                ⠁⠇⠃⠃⠇⠇⠅
       ⡇                         ⡀⡆
       ⡇                     ⡀⡄⡆
        ⡆               ⡀⡀⡄⡆
          ⡆⡄⡀⡆⡆⡆⡆⡀⡄⡄⡄⡆







% termsketch outline --charset="/\\|" ./witch-hat-2.png






                                           /|||/
                                          \      \
                                         \    ||||\|
                                        \    \
                                       \     /
                                      /      /
                                     \        |
                                    /         /
                                   /           \
                                   \
                                  \             /
                                 /               |
                                 \
                                \                 /
                               /                   |
                               \                    \
                              \                                ||||||||
                             /                      \|    |/|\
                     /|||||  /                   \||  //\               /
                /||\      \ /                 \||     ||||            \|
             ||          \                  |\              \|||||||\
           |             | \             ||
         /              \  \||||    |||\
        \               /|||||||
       /                         ||
       |                     |||
        |               |||\
          |||||||||||||






% termsketch grayscale ./witch-hat-2.png






                                           .cl;.
                                          :XMMMXx'
                                         oMMM0:..'.
                                        dMMMW.
                                       oMMMMW.
                                      cMMMMMM:
                                     ,WMMMMMM0
                                    .XMMMMMMMM:
                                    OMMMMMMMMMX.
                                   lMMMMMMMMMMMx
                                  'WMMMMMMMMMMMW;
                                  KMMMMMMMMMMMMMX.
                                 dMMMMMMMMMMMMMMMk
                                ,WMMMMMMMMMMMMMMMMc
                                KMMMMMMMMMMMMMMMMMN'
                               oMMMMMMMMMMMMMMMMMMM0
                              'WMMMMMMMMMMMMMMMMMMMMd           ...'...
                              OMMMMMMMMMMMMMMMMMMMMXd     .,lk0XNWMMMWNd
                      .';c'  cMMMMMMMMMMMMMMMMMMXd,    ,xKWMMMMMMMMMMMM0
                .'cx0NWMMN. .NMMMMMMMMMMMMMMMNx,       .;oOKNWMMMMWWN0o.
             .cONMMMMMMMMl  xMMMMMMMMMMMMMWO:.              ...'''..
           ,kNMMMMMMMMMMK  ,WMMMMMMMMMMW0l.
         .kMMMMMMMMMMMMM;  'loxkkOOkdl;.
        'XMMMMMMMMMMMMMMk:,'....
        0MMMMMMMMMMMMMMMMMMMWWX0o'
        XMMMMMMMMMMMMMMMMMMNOo,.
        ;KWMMMMMMMMMMWX0d:'.
          .,cloolc:,..
```

## License

`termsketch` is released under the [Apache License, Version 2.0][APLV2].

[APLV2]: https://github.com/ulyssa/iamb/blob/master/LICENSE
[witch-hat]: https://openclipart.org/detail/245968/wizards-white-hat