sankalp
3a81ab1212
- Plugin API (plugin.py, context.py, result.py) - Core engine (search.py, manager.py, registry.py, loader.py) - Built-in plugins: app, calculator, clipboard, emoji, power_menu, query, wallpapers - Spotlight docs and example plugins - Spotlight CSS styling
Modus Documentation
Welcome to the official documentation for Modus!
Modus is a highly customizable, hackable shell environment designed specifically for Hyprland on Wayland, built using Python and the Fabric framework.
Table of Contents
-
- Automated installation via
install.sh. - Manual installation and compiling C-extensions.
- Post-installation steps and recommended themes.
- Automated installation via
-
- How to configure the shell using
config.toml. - Setting up custom panel buttons with
mods.toml. - Pinning apps to the dock via
dock.toml.
- How to configure the shell using
-
- How Matugen dynamically generates colors based on your wallpaper.
- Customizing CSS components in
src/shared/styles/.
-
- Deep dive into how Modus is built.
- The Wayland Window Switcher C-Backend (
AppCapture). - The Global Menu DBus implementation.
-
- Troubleshooting common issues (Dock occlusion, CPU usage, OSD).
- Pro tips for keyboard shortcuts and live-reloading.
Contributing
Modus is open-source and hackable by design. If you want to contribute to the project:
- Familiarize yourself with the Architecture Overview.
- Write Python code using the Fabric framework widgets.
- Ensure you test your changes by running
uv run startbefore opening a pull request.