2.3 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.
Getting Started
The dependencies required are:
- wlroots
- meson (building)
- ninja (building)
- 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.
Using
Since kiwmi does not have any logic in itself, all logic must be provided by lua scripts, specifically the init.lua file. See the lua_docs.md for a ruleset for the lua files. To test a snippet of lua code, you can use the kiwmi client (kiwmic). By default, no lua configuration file is supplied. You can place the file at ~/.config/kiwmi/init.lua If you really want an example, you can look at https://github.com/zena1/kiwmi./blob/master/init.lua