mirror-ghostty/example/c-vt-encode-key
Mitchell Hashimoto 996ce03f0b
example: rename some examples
2026-03-17 17:39:26 -07:00
..
src example: rename some examples 2026-03-17 17:39:26 -07:00
README.md example: rename some examples 2026-03-17 17:39:26 -07:00
build.zig example: rename some examples 2026-03-17 17:39:26 -07:00
build.zig.zon example: rename some examples 2026-03-17 17:39:26 -07:00

README.md

Example: ghostty-vt C Key Encoding

This example demonstrates how to use the ghostty-vt C library to encode key events into terminal escape sequences.

This example specifically shows how to:

  1. Create a key encoder with the C API
  2. Configure Kitty keyboard protocol flags (this example uses KKP)
  3. Create and configure a key event
  4. Encode the key event into a terminal escape sequence

The example encodes a Ctrl key release event with the Ctrl modifier set, producing the escape sequence \x1b[57442;5:3u.

Usage

Run the program:

zig build run