Skip to content

Developer Setup

realstuffie edited this page Mar 16, 2026 · 2 revisions

Developer Setup

QML module packaging

ProxMon uses a native QML plugin exposed as org.kde.plasma.proxmox.

Required install layout

For Plasma 6, the plugin must be placed under:

contents/qml/org/kde/plasma/proxmox/qmldir
contents/qml/org/kde/plasma/proxmox/libproxmoxclientplugin.so

contents/lib is not a reliable QML import root and can cause module "org.kde.plasma.proxmox" is not installed.

Verification

After install confirm these files exist under:

~/.local/share/plasma/plasmoids/org.kde.plasma.proxmox/contents/qml/org/kde/plasma/proxmox/

Restart Plasma after changes:

kquitapp6 plasmashell && kstart plasmashell

Install script flags

Flag Effect
(none) Full install with best-effort dependency detection
--no-deps Skip dependency install, build and install only
--install-standalone-qml-module Also copy QML module to user-local Qt6 path as fallback

Build policy

Build output is not committed to the repository. install.sh builds the native plugin in a temporary directory and stages the .so into the plasmoid package. No secondary standalone QML module install is performed unless --install-standalone-qml-module is passed.

Manual installation

git clone https://github.com/realstuffie/ProxMon.git
cd ProxMon
kpackagetool6 -t Plasma/Applet -i .
mkdir -p ~/.local/share/icons/hicolor/scalable/apps/
cp contents/icons/*.svg ~/.local/share/icons/hicolor/scalable/apps/
gtk-update-icon-cache ~/.local/share/icons/hicolor/ 2>/dev/null || true

Manual uninstall

kpackagetool6 -t Plasma/Applet -r org.kde.plasma.proxmox
rm -f ~/.local/share/icons/hicolor/scalable/apps/proxmox-monitor.svg
rm -f ~/.local/share/icons/hicolor/scalable/apps/lxc.svg
rm -rf ~/.config/proxmox-plasmoid/

Clone this wiki locally