maimai 0.1.0

Markup-based meme generator
Documentation 
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

# maimai

[![Build Status](https://codeberg.org/d-k-bo/maimai/badges/workflows/rust.yml/badge.svg)][__link0]
[![crates.io](https://img.shields.io/crates/v/maimai)][__link1]
[![Documentation](https://img.shields.io/docsrs/maimai)][__link2]
[![License](https://img.shields.io/crates/l/maimai)][__link3]
[![Repository](https://img.shields.io/badge/Source%20Code-on%20Codeberg-blue?logo=Codeberg)][__link4]

*maimai* (\['maɪ̯maɪ̯\], Zangendeutsch for “meme”) provides a command-line
application and a Rust library to generate [Memes][__link5] based on a declarative
text format.

This is intended to be an alternative to popular [WYSIWYG][__link6] meme editors,
that don’t give you much control and often have problems creating
reproducable, high quality content.

![](examples/creating-memes.webp)

***All image templates used in this project were hand-drawn by [Gee][__link7] for
[Framamèmes][__link8] and published under the the terms of the [CC-0][__link9] License.***

## Usage

In many cases, a meme is created from 3 “layers”:

* the base image (often taken from a popular TV show or from stock images)
* the text layout that defines, where text is placed on the base image and
  how it is formatted
* the text content

The first two “layer” are usually shared between different memes and the
text content is replaced for a different joke.

A `maimai` meme definition is written as a [TOML][__link10] document that can extend
other meme definions. This allows implementing the pattern described
above.

<table>
    <tr>
        <th>Source</th>
        <th>Result</th>
    </tr>
    <tr>
<td>

```toml
# examples/templates/sophie-no-yes.toml

image = "sophie-no-yes.png"

[text.no]
text = "Bad text"
position = [420, 20]
size = [360, 360]
color = "black"
font-size = 60

[text.yes]
text = "Good text"
position = [420, 420]
size = [360, 360]
color = "black"
font-size = 60

```

</td>
<td>

<img src="https://codeberg.org/d-k-bo/maimai/media/branch/main/examples/templates/sophie-no-yes.webp" height="400"/>

</td>
    </tr>
    <tr>
<td>

```toml
# examples/reuse.toml

extends = "templates/sophie-no-yes.toml"

[text]
no = "Creating everything from scratch"
yes = "Reusing your work"

```

</td>
<td>

<img src="https://codeberg.org/d-k-bo/maimai/media/branch/main/examples/reuse.webp" height="400"/>

</td>
    </tr>
</table>

## License

This project is licensed under the GNU Affero General Public License version 3 or (at your option) any later version (AGPL-3.0-or-later).


 [__link0]: https://codeberg.org/d-k-bo/maimai/actions?workflow=rust.yml
 [__link1]: https://lib.rs/crates/maimai
 [__link10]: https://toml.io/
 [__link2]: https://docs.rs/maimai
 [__link3]: https://codeberg.org/d-k-bo/maimai/src/branch/main/COPYING
 [__link4]: https://codeberg.org/d-k-bo/maimai/
 [__link5]: https://en.wikipedia.org/wiki/Internet_meme
 [__link6]: https://en.wikipedia.org/wiki/WYSIWYG
 [__link7]: https://ptilouk.net/
 [__link8]: https://framamemes.org/
 [__link9]: https://creativecommons.org/publicdomain/zero/1.0/