Development

Development Requirements

On top of the system requirements, following software is required to build Krohnkite:

• Typescript (version at least 3.1)
• GNU Make
• p7zip (7z command)

Following tools are used by the author of the script:

• Visual Studio Code: provides the best Typescript development environment.
• Qt Designer (designer-qt5): a GUI editor for .ui files, used for configuration dialog.
• TSLint

Debugging the script

An unfortunate truth about KWin script development is lack of debugging tools, so, one must rely on Printf Debugging method.

To see the debug print,

1. Enable Print debug messages option in Krohnkite configuration.
2. Restart KWin from a terminal (kwin_x11 --replace)

If more information is needed than currently provided, you can insert calls to console.log from anywhere in the source code - either in Typescript code or the generated Javascript code.

Useful Development Resources

• KWin Scripting Tutorial
• KWin Scripting API 4.9 Reference
• KDE API Reference
  • KWin::Workspace Class
  • KWin::Toplevel Class
  • KWin::Client Class
• Adding configuration dialog
  • Development/Tutorials/Plasma/JavaScript/ConfigDialog
  • Development/Tutorials/Using KConfig XT
• *.ui files can be edited with Qt Designer. It's very straight-forward, if you're used to UI programming.