termgrid-core 1.5.4

Deterministic terminal grid state engine with invariant enforcement and backend decoupling.
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

![termgrid-core](docs/assets/termgrid-core-banner.webp)

# termgrid-core

[![Crates.io](https://img.shields.io/crates/v/termgrid-core.svg)](https://crates.io/crates/termgrid-core)
[![Docs](https://img.shields.io/badge/docs-site-blue)](https://termgrid.entropy.quest)
[![MSRV](https://img.shields.io/badge/MSRV-1.82-blue)](#msrv)
[![License](https://img.shields.io/badge/license-AGPL%20%2B%20commercial-informational)](#license)

`termgrid-core` is a deterministic terminal grid state engine.

It provides a canonical grid model with invariant enforcement, explicit Unicode width policy via a glyph registry, and damage tracking for incremental redraw. The output surface is backend-decoupled: you apply render operations to a grid, then render the grid through whatever backend you choose (terminal, xterm.js, headless tests, etc.).

## Why this exists

Modern “terminal-ish” rendering is frequently stream-oriented (ANSI output) and environment-dependent (Unicode width behavior varies across terminals). For systems that need correctness, replayability, and consistent layout, treating rendering as deterministic state mutation is materially simpler to test and reason about.



## Quick start

```rust
use termgrid_core::{Grid, Renderer};

let mut grid = Grid::new(80, 25);
let mut r = Renderer::new();

r.draw_text(&mut grid, 0, 0, "Hello, termgrid.");
let damage = r.take_damage();

// Backend renders (&grid, damage)
```

## Documentation

- Documentation site: https://termgrid.entropy.quest
- Rust API (docs.rs): https://docs.rs/termgrid-core
- Wire format v1 (contract): `docs/contracts/wire-format-v1.md`

Local docs build (includes rustdoc under `site/api/`):

```bash
./scripts/docs_build.sh
python -m http.server -d site 8000
```

## MSRV

Minimum supported Rust version: **1.82**.

CI enforces MSRV via a dedicated test lane.

## What this crate does not do

- Parse arbitrary ANSI input streams
- Implement a terminal emulator
- Provide IPC/protocol layers (belongs above this crate)

## License

Licensed under **AGPL-3.0-or-later** by default.

A paid commercial license (**LicenseRef-VaranidWorks-Commercial-1.0**) is available to allow use without AGPL obligations.

See `LICENSE` and `LICENSES/`.