termcinema-engine 0.1.0

🧠 Core typewriter-style terminal animation engine (SVG renderer) for termcinema
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

# 🧱 termcinema-engine

Low-level rendering engine for [TermCinema](../README.md) —  
turn terminal-style text into **animated SVG** with fine-grained control over fonts, layout, cursor, and animation timing.

> **Note:** This is the rendering **core**. For end-user usage, see [`termcinema-cli`](../cli/README.md)

---


## ✨ What It Does

`termcinema-engine` provides programmatic APIs to:

- 🖋 Render multi-line terminal text with **typing animations**
- 🎨 Style output with custom **fonts, colors, alignment, and layout**
- 🧑‍🎨 Animate cursors with blinking and movement trails
- 📜 Support both **free-form text** and **structured REPL/script** formats
- 🧩 Export to **SVG strings** — suitable for embedding in web or docs


## 🔧 Usage (as a library)

Add to your `Cargo.toml`:

```toml
termcinema-engine = "0.1"
```

Basic usage example:

```rust
use termcinema_engine::{
    StyleSpec, LayoutSpec, CursorSpec, ControlSpec,
    render_svg_from_input,
};

fn main() {
    let svg = render_svg_from_input(
        "echo hello",        // input text
        false,               // is script-style? false = typing mode
        &StyleSpec::default(),
        &LayoutSpec::default(),
        &CursorSpec::default(),
        &ControlSpec::default(),
    );   
}
```

Output is a full `<svg>...</svg>` string — ready to embed or save to file.


## 📦 Features

- ✅ Minimal dependencies
- ✅ No I/O: pure in → SVG string out
- 🧱 Designed for integration into:
  - WASM frontends 
  - Static site generators 
  - Code documentation pipelines 
  - Terminal recording tools


## 🪄 Advanced Control

Use the structured API for precise layout, animation, and output control:

```rust
use termcinema_engine::{
    render_typing_from_text,
    StyleSpec, LayoutSpec, CursorSpec, ControlSpec,
    ContentSpec,
};

fn main() {
    let svg = render_typing_from_text(
        &ContentSpec { text: "Hello\nWorld!".into() },
        &StyleSpec {
            font_family: "Fira Code".into(),
            font_size: 18,
            text_color: Some("#00ffcc".into()),
            background_color: Some("#000000".into()),
            ..Default::default()
        },
        &LayoutSpec::default(),
        &CursorSpec::default(),
        &ControlSpec {
            frame_delay: 80,
            fade_duration: 120,
            ..Default::default()
        },
    );
}
```


## 🔗 See Also

- [Back to Project Overview](../README.md)
- [docs.rs/termcinema-engine](https://docs.rs/termcinema-engine)
- [Changelog](./CHANGELOG.md)
- [License](./LICENSE)