Skip to content
This repository was archived by the owner on Nov 18, 2025. It is now read-only.

Getting Started

Jakob Schlanstedt edited this page Dec 30, 2021 · 9 revisions

Welcome to Japokwm. The windowmanager that gives you the user the ability to quickly create layouts.

Start

To start out please copy the file at /etc/japokwm/init.lua -> ~/.config/japokwm/init.lua.

Now you can start/restart your window manager by either typing japokwm into the tty or logging in via lightdm/the login screen you have.

Now open the file ~/.config/japokwm/init.lua with your texteditor of choice.

You will find a bunch of stuff that you can change. These don't represent all features present in japokwm but a small subset to not overwhelm the user.

You can try changing some variables if you want to get comfortable. To apply those changes you have to press mod-r where mod is the alt key by default.

To change the mod key to super you have to change opt.mod=1 to opt.mod=4

Creating your first layout

Copy the contents of /etc/japokwm/layouts to ~/.config/japokwm/layouts you may have to create the directory ~/.config/japokwm/layouts yourself.

Next go to ~/.config/japokwm/layouts/user1/init.lua. This is the user1 layout.

You can find a 3d array there that is saved into local variable layout_data. Try changing some variables and reloading the window manager. You will see these changes apply as soon as you switch the layout.

You can also play around with some of the layouts here.

HOW TO CONTINUE

Now that you have the basic things setup try reading through man 5 japokwm or through man 1 japokwm for further info for the basic things. After that you can do whatever you want.

Plugins

WIP (planned for 0.5) may already work though

Clone this wiki locally