2.1 KiB
kiwmi
A fully programmable Wayland Compositor
kiwmi is a work-in-progress extensive user-configurable Wayland Compositor. kiwmi specifically does not enforce any logic, allowing for the creation of Lua-scripted behaviors, making arduous tasks such as modal window management become a breeze. New users should be aware of the steep learning curve present, however this will be reduced as the project matures.
Documentation
Documentation for the API can be found in lua_docs.md.
Additionally kiwmic can be used to send a single lua string to kiwmi for direct evaluation.
For example:
$ kiwmic 'return kiwmi:focused_view():id()'
94036737803088.0
Getting Started
The dependencies required are:
- wlroots
- lua or luajit
- meson (build)
- ninja (build)
- git (build, optional)
Building
After cloning/downloading the project and ensuring all dependencies are installed, building is as easy as running
$ meson build
$ ninja -C build
If you plan to use luajit instead, use the following commands instead.
$ meson -Dlua-pkg=luajit build
$ ninja -C build
Installing is accomplished with the following command:
# ninja -C build install
Contributing
Contributions are welcomed, especially while the project is in a heavy WIP stage. If you believe you have a valid concern, read the CONTRIBUTING document and please file an issue on the issues page.
For clarifications or suggestions on anything, please don't hesitate to contact me.