- Expand architecture overview with plugin system details - Update configuration guide with new spotlight settings - Improve FAQs with troubleshooting tips - Remove docs/README.md (content merged into main README)
3.3 KiB
FAQs & Tips
Frequently Asked Questions
1. The Global Menu isn't showing up for some apps?
Modus uses a custom libmenu_button_shim.so with appmenu-gtk-module to
export GTK menus over DBus.
- Ensure
appmenu-gtk-moduleis installed - Ensure the shim was compiled correctly during installation
- Non-GTK apps (Electron, Qt) may need flags like
export QT_QPA_PLATFORMTHEME=appmenu-qt5
2. High CPU usage when App Switcher is open?
The App Switcher uses a custom C-backend to capture live window previews.
- 4K windows with many open can spike CPU
- Fix: Increase
switcher_live_preview_delay_msinconfig.toml(e.g.,200for ~5 FPS) or setswitcher_live_preview = falseto disable previews entirely
3. Dock covering fullscreen games/videos?
Set dock_auto_hide = true in config.toml. The dock hides automatically
when a window is maximized or fullscreen.
4. Volume/Brightness OSD not showing?
Set osd = true in config.toml. Requires brightnessctl for brightness and
Pipewire/Wireplumber for audio.
5. Weather widget shows wrong location?
Update weather_location in config.toml (e.g., "London, UK" or
"Patan, Nepal").
6. Spotlight plugin isn't showing up?
- Check the file is in
config/plugins/(notexamples/plugins/) - Check
config/plugins/is NOT in.gitignorefor your own repos - Run
journalctl --user -f -t modusand look for[PluginLoader]errors - Make sure the file has
PLUGIN = YourClassNameat the bottom - If using dependencies, ensure
uvis installed - After editing, run
fabric-cli exec modus1 'deep_reload your_plugin_id'
7. Plugin has dependencies but they aren't installed?
- Check
uvis installed (which uv) - Check
requirements.txtis next to your.pyfile or inside your package dir - The venv lives at
config/plugins/.venvs/<plugin_name>/ - Delete that directory to force re-install on next load
Pro Tips
-
Live Reload for Mods:
config/mods.tomlis monitored for changes. Edits apply instantly — no restart needed -
Pinning Apps: Use exact
.desktopfilename indock.toml(e.g.,"org.gnome.Nautilus", not"Files") -
Custom Scripts:
on-clickedinmods.tomlcan point to bash scripts in your home directory -
Theme Updates: Modus uses Matugen tied to your wallpaper. Set a new wallpaper and the shell recolors automatically
-
Spotlight Keyboard Shortcuts (from
config/hypr/modus.lua):Key Action Super + DOpen spotlight search Super + EOpen emoji picker Super + VOpen clipboard history Super + WOpen wallpaper browser -
Deep Reload a Plugin: After editing
config/plugins/hello.py:fabric-cli exec modus1 'deep_reload hello'No Modus restart required. Works with all plugins.
-
Test a Plugin from Terminal:
fabric-cli exec modus1 'wth london'Routes to the weather plugin's
search()and prints results to the Modus log. -
Check Plugin Load Log:
journalctl --user -f -t modusFilters to Modus messages only. Shows plugin discovery, load errors, and search crashes.
-
Wayland Screencapture: Toggle from panel or bind in Hyprland:
bind = SUPER, S, exec, fabric-cli exec modus 'screencapture.toggle()'