docs: update documentation for reorganized config.toml
- Update configuration.md with new section-based format - Update architecture.md with new config key paths - Update faqs_tips.md with new config key paths - Update README.md to mention config sections
This commit is contained in:
4 files changed
+33
-24
No files matched your search
@@ -76,7 +76,7 @@ Python DBus polling is too slow, so Modus uses a C-extension at
|
||||
from Hyprland
|
||||
- Compiled to `libappcapture.so`, exposed to Python via GObject Introspection
|
||||
- Framerate throttled by Python using `invoke_repeater`, controlled by
|
||||
`switcher_live_preview_delay_ms` in `config.toml`
|
||||
`switcher.live_preview_delay_ms` in `config.toml`
|
||||
|
||||
## 4. Global Menu (DBus)
|
||||
|
||||
|
||||
+25
-18
@@ -35,34 +35,34 @@ fabric-cli exec modus "settings.toggle()"
|
||||
|
||||
Auto-generated on first run with sensible defaults. Most changes require restarting Modus (`uv run start`).
|
||||
|
||||
### General
|
||||
Config is organized into sections. Values are accessed via dot notation (e.g. `panel.battery`).
|
||||
|
||||
### `[general]`
|
||||
|
||||
| Key | Type | Default | Description |
|
||||
|-----|------|---------|-------------|
|
||||
| `debug` | bool | `false` | Enable verbose logging |
|
||||
| `weather_location` | string | `""` | City for weather widget (e.g., `"London, UK"`) |
|
||||
| `keyboard_layouts` | array | `["us"]` | Active keyboard layouts |
|
||||
| `night_light_temperature` | int | `4500` | Night light color temp in Kelvin |
|
||||
| `wallpapers_dir` | string | `"src/assets/wallpaper_example/"` | Path to wallpapers folder |
|
||||
| `switcher_live_preview` | bool | `true` | Live window previews in switcher |
|
||||
| `switcher_live_preview_delay_ms` | int | `200` | Preview framerate delay (lower = smoother) |
|
||||
|
||||
### Dock
|
||||
### `[dock]`
|
||||
|
||||
| Key | Type | Default | Description |
|
||||
|-----|------|---------|-------------|
|
||||
| `dock_enabled` | bool | `true` | Show the dock |
|
||||
| `dock_auto_hide` | bool | `true` | Hide when windows overlap |
|
||||
| `dock_always_occluded` | bool | `false` | Keep dock behind windows |
|
||||
| `dock_icon_size` | int | `52` | Icon size in pixels |
|
||||
| `dock_hide_special_workspace_apps` | bool | `true` | Hide special workspace apps |
|
||||
| `enabled` | bool | `true` | Show the dock |
|
||||
| `auto_hide` | bool | `true` | Hide when windows overlap |
|
||||
| `always_occluded` | bool | `false` | Keep dock behind windows |
|
||||
| `icon_size` | int | `52` | Icon size in pixels |
|
||||
| `hide_special_workspace_apps` | bool | `true` | Hide special workspace apps |
|
||||
|
||||
### Panel Widgets
|
||||
### `[panel]`
|
||||
|
||||
| Key | Type | Default | Description |
|
||||
|-----|------|---------|-------------|
|
||||
| `imac_button` | bool | `true` | Apple logo button |
|
||||
| `systray` | bool | `true` | System tray |
|
||||
| `systray_ignore` | array | `["blueman", "network"]` | Icons hidden from system tray |
|
||||
| `control_center` | bool | `true` | Control center widget |
|
||||
| `search` | bool | `true` | Search/spotlight button |
|
||||
| `global_menu` | bool | `true` | App menus in panel |
|
||||
@@ -73,19 +73,26 @@ Auto-generated on first run with sensible defaults. Most changes require restart
|
||||
| `workspace_indicator` | bool | `true` | Workspace indicator |
|
||||
| `notification_center` | bool | `true` | Notification center |
|
||||
| `notch` | bool | `true` | Center notch (player, indicators, recording) |
|
||||
| `custom_mods` | bool | `true` | Custom panel buttons from `mods.toml` |
|
||||
| `window_switcher` | bool | `true` | Alt-Tab window switcher |
|
||||
| `osd` | bool | `true` | Volume/brightness on-screen display |
|
||||
| `night_light_temperature` | int | `4500` | Night light color temp in Kelvin |
|
||||
| `hide_special_workspace` | bool | `true` | Hide special workspace from indicators |
|
||||
| `custom_mods` | bool | `true` | Custom panel buttons from `mods.toml` |
|
||||
|
||||
### Notifications
|
||||
### `[switcher]`
|
||||
|
||||
| Key | Type | Default | Description |
|
||||
|-----|------|---------|-------------|
|
||||
| `notification_timeout` | string | `"5s"` | Auto-dismiss duration |
|
||||
| `notification_ignored_apps` | array | `["Hyprshot"]` | Apps with suppressed notifications |
|
||||
| `notification_limited_apps_history` | array | `["Spotify"]` | Apps with limited history |
|
||||
| `systray_ignore` | array | `["blueman", "network"]` | Icons hidden from system tray |
|
||||
| `live_preview` | bool | `true` | Live window previews in switcher |
|
||||
| `live_preview_delay_ms` | int | `200` | Preview framerate delay (lower = smoother) |
|
||||
| `window_switcher` | bool | `true` | Alt-Tab window switcher |
|
||||
|
||||
### `[notification]`
|
||||
|
||||
| Key | Type | Default | Description |
|
||||
|-----|------|---------|-------------|
|
||||
| `timeout` | string | `"5s"` | Auto-dismiss duration |
|
||||
| `ignored_apps` | array | `["Hyprshot"]` | Apps with suppressed notifications |
|
||||
| `limited_apps_history` | array | `["Spotify"]` | Apps with limited history |
|
||||
|
||||
---
|
||||
|
||||
|
||||
+5
-5
@@ -15,22 +15,22 @@ export GTK menus over DBus.
|
||||
|
||||
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_ms` in `config.toml` (e.g., `200`
|
||||
for ~5 FPS) or set `switcher_live_preview = false` to disable previews entirely
|
||||
- **Fix**: Increase `switcher.live_preview_delay_ms` in `config.toml` (e.g., `200`
|
||||
for ~5 FPS) or set `switcher.live_preview = false` to disable previews entirely
|
||||
|
||||
### 3. Dock covering fullscreen games/videos?
|
||||
|
||||
Set `dock_auto_hide = true` in `config.toml`. The dock hides automatically
|
||||
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
|
||||
Set `panel.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
|
||||
Update `general.weather_location` in `config.toml` (e.g., `"London, UK"` or
|
||||
`"Patan, Nepal"`).
|
||||
|
||||
### 6. Spotlight plugin isn't showing up?
|
||||
|
||||
Reference in new issue
Block a user