maimai 0.1.1

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

//! [![Build Status](https://codeberg.org/d-k-bo/maimai/badges/workflows/rust.yml/badge.svg)](https://codeberg.org/d-k-bo/maimai/actions?workflow=rust.yml)
//! [![crates.io](https://img.shields.io/crates/v/maimai)](https://lib.rs/crates/maimai)
//! [![Documentation](https://img.shields.io/docsrs/maimai)](https://docs.rs/maimai)
//! [![License](https://img.shields.io/crates/l/maimai)](https://codeberg.org/d-k-bo/maimai/src/branch/main/COPYING)
//! [![Repository](https://img.shields.io/badge/Source%20Code-on%20Codeberg-blue?logo=Codeberg)](https://codeberg.org/d-k-bo/maimai/)
//!
//! *maimai* (\[\'maɪ̯maɪ̯\], Zangendeutsch for “meme”) provides a command-line
//! application and a Rust library to generate [Memes] based on a declarative
//! text format.
//!
//! This is intended to be an alternative to popular [WYSIWYG] meme editors,
//! that don't give you much control and often have problems creating
//! reproducable, high quality content.
//!
//! ![](https://codeberg.org/d-k-bo/maimai/media/branch/main/examples/creating-memes.webp)
//!
//! _**All image templates used in this project were hand-drawn by [Gee] for
//! [Framamèmes] and published under the the terms of the [CC-0] 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] 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
//!
#![doc = include_str!("../examples/templates/sophie-no-yes.toml")]
//! ```
//!
//! </td>
//! <td>
//!
//! <img src="https://codeberg.org/d-k-bo/maimai/media/branch/main/examples/templates/sophie-no-yes.webp" height="400" width="400"/>
//!
//! </td>
//!     </tr>
//!     <tr>
//! <td>
//!
//! ```toml
//! # examples/reuse.toml
//!
#![doc = include_str!("../examples/reuse.toml")]
//! ```
//!
//! </td>
//! <td>
//!
//! <img src="https://codeberg.org/d-k-bo/maimai/media/branch/main/examples/reuse.webp" height="400" width="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).
//!
//! [Memes]: https://en.wikipedia.org/wiki/Internet_meme
//! [WYSIWYG]: https://en.wikipedia.org/wiki/WYSIWYG
//! [Gee]: https://ptilouk.net/
//! [Framamèmes]: https://framamemes.org/
//! [CC-0]: https://creativecommons.org/publicdomain/zero/1.0/
//! [TOML]: https://toml.io/

#![cfg_attr(not(feature = "cli"), allow(dead_code))]
#![cfg_attr(not(feature = "cli"), allow(unused_imports))]
#![cfg_attr(docsrs, feature(doc_auto_cfg))]

mod error;
#[cfg(feature = "read")]
mod files;
mod meme;
#[cfg(feature = "render")]
mod render;
#[cfg(feature = "render")]
mod text;

pub use self::{
    error::{Error, ErrorKind, IncompleteMemeDefinition, Result},
    meme::{Color, HAlign, Meme, MemeBase, PartialMeme, TextBox, TextOutline, VAlign, partial},
};

#[cfg(feature = "read")]
pub use self::files::{FileProvider, FsFileProvider};