Zellij plugins in Zig!
Go to file
2022-08-17 00:03:19 +02:00
example docs: add example zellzig dependency to example 2022-06-12 13:31:16 +02:00
src chore: simplify deserialization code 2022-08-17 00:03:19 +02:00
.gitignore Initial Commit! 2022-06-11 23:52:21 +02:00
build.zig Initial Commit! 2022-06-11 23:52:21 +02:00
gyro.zzz chore: port to new zellij API! 2022-08-03 00:06:37 +02:00
LICENSE chore: add GPL-3 license 2022-06-12 00:02:16 +02:00
README.md docs: add list of projects to readme 2022-06-28 20:49:01 +02:00

zellzig

A zig framework for writing zellij plugins.

Zellzig is currently used by these project (if you use this library, please submit a PR!):

usage

For an example of how to use it, see the example directory. Also note that you'll need a master version of the zig compiler to use zellzig.

Here's a quick overview:

const std = @import("std");
const zz = @import("zellzig");

comptime {
    // register plugin
    zz.createPlugin(@This());
}

pub fn init() void {
    // do initialization stuff
}

pub fn update(ev: zz.Event) void {
    // handle events
}

pub fn render(rows: i32, cols: i32) void {
    // draw UI
}

development

PRs are always welcome if you feel that something needs improvement/fixing! Make sure to follow Conventional Commits and to run tests first, though.

Run tests using gyro build test. Note that tests are run on the native target, not WASM.