Repository files navigation

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 toolGridmonger (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 theexamples and Gridmonger for usage.

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

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

• nim-glfw
• nim-nanovg

You can install them withNimble:

nimble install glfw nanovg

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

nimble testnimble paneltest

or

nimble testReleasenimble paneltestRelease

Seeconfig.nims on how to link staticallykoi andGLFW to your program.

Copyright © 2019-2024 John Novak <john@johnnovak.net>

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