https://github.com/xyaman/mibu

Pure Zig library for low-level terminal manipulation.
https://github.com/xyaman/mibu

ansi color console cursor terminal zig

Last synced: 3 months ago
JSON representation

Pure Zig library for low-level terminal manipulation.

• Host: GitHub
• URL: https://github.com/xyaman/mibu
• Owner: xyaman
• License: mit
• Created: 2021-10-03T17:08:47.000Z (over 3 years ago)
• Default Branch: main
• Last Pushed: 2024-09-08T02:27:42.000Z (5 months ago)
• Last Synced: 2024-09-08T03:35:28.902Z (5 months ago)
• Topics: ansi, color, console, cursor, terminal, zig
• Language: Zig
• Homepage:
• Size: 39.1 KB
• Stars: 58
• Watchers: 2
• Forks: 8
• Open Issues: 1
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

• awesome-zig - mibu🗒️Pure Zig library for low-level terminal manipulation

README

        
#  mibu

**mibu** is pure Zig library for low-level terminal manipulation.

> Tested with zig version `0.13.0`

## Features

- Allocation free.

- UTF-8 support.

- Style (bold, italic, underline, etc).

- Termios / Raw mode.

- 8-16 colors.

- True Color (24-bit RGB).

- Cursor controls.

- Clear(Erase) functions.

- Key events.

- Partial Mouse events. (Click, Scroll, Release)

## How to use

First we add the library as a dependency in our `build.zig.zon` file.

```zig

.dependencies = .{

    .string = .{

        .url = "https://github.com/xyaman/mibu/archive/refs/heads/main.zip",

        //the correct hash will be suggested by the zig compiler, you can copy it from there

    }

}

```

And we add it to `build.zig` file.

```zig

const mibu_dep = b.dependency("mibu", .{

    .target = target,

    .optimize = optimize,

});

exe.root_module.addImport("mibu", mibu_dep.module("mibu"));

```

Now we can use the library in our code.

```zig

const std = @import("std");

const mibu = @import("mibu");

const color = mibu.color;

pub fn main() void {

    std.debug.print("{s}Hello World in purple!\n", .{color.print.bgRGB(97, 37, 160)});

}

```

## Getting Started

See the [examples directory](examples/)

You can run the examples with the following command:

```bash

# Prints text with different colors

zig build color

# Prints what key you pressed, until you press `q` or `ctrl+c`

zig build event

```

## TODO

- Mouse events

    - [x] Left, middle, right click

    - [x] Scroll up, down

    - [x] Release

    - [x] Modifiers (shift, ctrl, alt)

    - [x] Move 

    - [ ] Click and move (drag)

- Support all keys events