https://github.com/romgrk/kui.nvim

UI neovim framework for kitty
https://github.com/romgrk/kui.nvim

Last synced: 3 days ago
JSON representation

UI neovim framework for kitty

• Host: GitHub
• URL: https://github.com/romgrk/kui.nvim
• Owner: romgrk
• License: mit
• Created: 2023-02-03T12:31:40.000Z (almost 2 years ago)
• Default Branch: master
• Last Pushed: 2023-07-14T04:46:35.000Z (over 1 year ago)
• Last Synced: 2024-10-16T07:32:57.260Z (28 days ago)
• Language: C
• Homepage:
• Size: 5.37 MB
• Stars: 185
• Watchers: 8
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# kui.nvim

This project is a neovim UI framework, aiming to use the Kitty graphics protocol to build complex graphical interfaces.

This depends on the user having a terminal with support for the [kitty graphics protocol](https://sw.kovidgoyal.net/kitty/graphics-protocol/)

as well as [libcairo](https://www.cairographics.org/) installed.

See [kirby.nvim](https://github.com/romgrk/kirby.nvim) for a more complex example.

![demo](./assets/kui-demo.gif)

See https://github.com/romgrk/kui-demo.nvim for a template showing how to implement the demo above.

## Plugins

These plugins are based on kui:

 - [kirby.nvim](https://github.com/romgrk/kirby.nvim)

## Status & features

Status: experimental, good enough for small use cases

Features:

 - [x] Container system (transpiled from Pixi.JS via TypescriptToLua)

 - [ ] Images (I don't remember if I implemented it, TBC)

 - [ ] Masks

 - [x] Graphics (lines, rects, ovals, paths)

 - [x] Basic text (size, family, weight, color)

 - [ ] Advanced text (highlighted text (think code syntax), proper layout & rendering)

 - [x] Medium-performance rendering (think 30FPS animations, medium surface)

 - [ ] High-performance rendering (think 60FPS animations, large surface)

## License

MIT

### Includes code from:

 - [pixi.js](https://github.com/pixijs/pixijs): MIT

 - [colord](https://github.com/omgovich/colord): MIT

 - [hologram.nvim](https://github.com/edluffy/hologram.nvim): MIT

 - [tstoluaplugin.nvim](https://github.com/equals03/tstoluaplugin.nvim): MIT