koi — immediate mode UI for Nim

koi is a small (~5 KLOC) immediate mode UI library that uses OpenGL for rendering via NanoVG. It was mainly invented for the dungeon mapping tool Gridmonger (see screenshot below), and then it evolved into a minimalist but feature-rich general-purpose UI library.

GLFW is currently a hard requirement, but it should be easy to adapt it to other frameworks or backends.

There is no documentation yet—check out the examples and Gridmonger for usage.

Support is currently alpha level, meaning that the API or the functionality might change without warning at any moment.

Dependencies

Nim 2.0.2 or later and the following two libraries are required:

• nim-glfw
• nim-nanovg

You can install them with Nimble:

nimble install glfw nanovg

Building

To build the examples (the dependencies will be auto-installed if needed):

nimble test
nimble paneltest

or

nimble testRelease
nimble paneltestRelease

See config.nims on how to link statically koi and GLFW to your program.

License

Copyright © 2019-2024 John Novak <[email protected]>

This work is free. You can redistribute it and/or modify it under the terms of the Do What The Fuck You Want To Public License, Version 2, as published by Sam Hocevar. See the COPYING file for more details.