package miaou-driver-matrix

  1. Overview
  2. Docs
Miaou high-performance terminal driver with diff rendering

Install 

dune-project
 Dependency

github.com Edit opam file Versions (1)

Authors

  1. N
    Nomadic Labs <contact@nomadic-labs.com>

Maintainers

  1. N
    Nomadic Labs <contact@nomadic-labs.com>

Sources

v0.5.2.tar.gz
md5=60a3b9f181f24572a06a9492532bfdda
sha512=fcc35a275066be2900e6201782faf47503076fa4640f08cf78067835a6f447b74613009e55b2ac799adb7ca46f1bffa261fc5971753f2cc3c6bef327511c7ef6

doc/miaou-driver-matrix.driver/Miaou_driver_matrix/Matrix_config/index.html

Module Miaou_driver_matrix.Matrix_configSource

Configuration for the Matrix driver.

Settings can be configured via environment variables:

  • MIAOU_MATRIX_FPS: Frame rate cap for rendering (default: 60)
  • MIAOU_MATRIX_TPS: Tick rate for effects/input (default: 60)
  • MIAOU_MATRIX_SCRUB_FRAMES: Full redraw interval in frames (default: 30, set 0 to disable)
  • MIAOU_MATRIX_DEBUG: Enable debug logging (default: false)
  • MIAOU_ENABLE_MOUSE: Enable mouse tracking (default: true, set to 0/false/no to disable for easier copy/paste)
  • MIAOU_INLINE_MODE: Run inline (no alt-screen). The TUI renders over the current terminal contents and its final frame stays in scrollback after exit. Mouse tracking is forced off in this mode for sane copy/paste. Default: false. Set to 1/true/yes to enable.
Sourcetype t = {
  1. fps_cap : int;
    (*

    Maximum frames per second for render domain (1-120)

    *)
  2. frame_time_ms : float;
    (*

    Minimum time between frames in ms

    *)
  3. tps_cap : int;
    (*

    Maximum ticks per second for effects domain (1-120)

    *)
  4. tick_time_ms : float;
    (*

    Minimum time between ticks in ms

    *)
  5. scrub_interval_frames : int;
    (*

    Perform a full clear+redraw every N frames (0 disables)

    *)
  6. debug : bool;
    (*

    Enable debug logging

    *)
  7. enable_mouse : bool;
    (*

    Enable mouse tracking (set to false for easier copy/paste)

    *)
  8. handle_sigint : bool;
    (*

    If false, SIGINT (Ctrl+C) is not intercepted, allowing the app to receive it as a key event. Default: true

    *)
  9. inline_mode : bool;
    (*

    When true, the matrix driver skips the alternate-screen sequences. The TUI renders over the current terminal contents and its final frame stays in scrollback after exit. Mouse tracking is suppressed. Default: false.

    *)
}
Sourceval default : t

Default configuration: 60 FPS, 60 TPS, no debug.

Sourceval load : unit -> t

Load configuration from environment variables.

Sourceval time_of_rate : int -> float

Minimum time in ms for given rate.

Sourceval with_mouse_disabled : t -> t

Create a custom config with mouse tracking disabled. Useful for applications that want to allow terminal copy/paste.