Skip to content

Latest commit

 

History

History
30 lines (27 loc) · 6.33 KB

File metadata and controls

30 lines (27 loc) · 6.33 KB

Module reference

This table follows MODULE_CATALOG order. “On” and “off” are the GSettings defaults for a fresh schema. Every current module uses desktop role and session scope; none declares a runtime capability requirement. A module may still wait for an optional Shell surface or service before attaching UI.

Key Setting and default Behavior and dependency Implementation and primary test
no-overview module-no-overview: on Opens the desktop instead of Overview at Shell startup. src/patches/noOverview.ts; tests/shell/patches/noOverview.test.js
pip-on-top module-pip-on-top: on Keeps detected picture-in-picture windows above other windows across workspaces. src/patches/pipOnTop.ts; tests/shell/patches/pipOnTop.test.js
focus-launched-windows module-focus-launched-windows: on Activates any window that emits Shell's window-demands-attention signal instead of leaving its attention notification. src/patches/focusLaunchedWindows.ts; registry/schema tests
capture-tools module-capture-tools: on Adds annotation and export controls to GNOME's screenshot UI. Optional OCR invokes local Tesseract only after the user requests it; web search uses the configured provider. src/capture/; tests/shell/capture/captureTools.test.js
theme-changer module-theme-changer: on Watches and synchronizes GNOME's color-scheme state. src/theme/themeChanger.ts; tests/shell/theme/themeChanger.test.js
dock module-dock: on Replaces the overview dash presentation with a configurable edge dock, auto-hide/intellihide, optional previews, Trash, and removable storage. Depends on GNOME Shell dash, layout, window, and volume APIs. src/dock/; tests/shell/dock/dock.test.js
aurora-menu module-aurora-menu: on Adds a panel menu for recent items, system locations, applications, and user-configured commands. Commands run only when selected. src/panel/auroraMenu.ts; tests/shell/panel/auroraMenu.test.js
power-menu-avatar module-power-menu-avatar: on Adds the current user's avatar and name to the existing Quick Settings power menu. Waits for the private Shell menu surface. src/panel/powerMenuAvatar.ts; tests/shell/panel/powerMenuAvatar.test.js
volume-mixer module-volume-mixer: on Adds per-application audio streams to Quick Settings and opens GNOME Sound Settings on request. Depends on Shell audio controls. src/panel/volumeMixer/; tests/shell/panel/volumeMixer/volumeMixer.test.js
low-battery-percentage module-low-battery-percentage: on Enables GNOME's native percentage display while a battery is discharging below 30%, then restores only the value it managed. Depends on UPower and org.gnome.desktop.interface. src/panel/lowBatteryPercentage.ts; registry/schema tests
lock-key-indicators module-lock-key-indicators: on Shows Caps Lock and Num Lock state in the panel. Depends on Shell keyboard state. src/panel/lockKeyIndicators.ts; registry/schema tests
xwayland-indicator module-xwayland-indicator: on Adds an X11 badge to XWayland windows in Alt+Tab. src/patches/xwaylandIndicator.ts; tests/shell/patches/xwaylandIndicator.test.js
privacy module-privacy: on Optionally enables Do Not Disturb and hides panel content while screen sharing. Depends on Shell screen-sharing state and GNOME notification settings. src/privacy/; tests/shell/privacy/
icon-weave module-icon-weave: on Matches untracked windows to installed applications in memory to repair missing icons. src/patches/iconWeave.ts; unit scoring/registry tests and tests/shell/patches/iconWeave.test.js
app-search-tooltip module-app-search-tooltip: on Shows an application's name when its overview search result is hovered. src/patches/appSearchTooltip.ts; tests/shell/patches/appSearchTooltip.test.js
vela-vpn-quick-settings module-vela-vpn-quick-settings: off Routes VPN toggle activation through Vela's D-Bus control API. GNOME Shell fallback is separately opt-in and is used only when the Vela service or API is unavailable. src/patches/velaVpnQuickSettings.ts; tests/shell/patches/velaVpnQuickSettings.test.js
auto-theme-switcher module-auto-theme-switcher: off Changes the configured color scheme at the light and dark times. src/theme/autoThemeSwitcher.ts; tests/shell/theme/autoThemeSwitcher.test.js
bluetooth-menu module-bluetooth-menu: on Adds battery levels and animated device icons to Bluetooth Quick Settings. Depends on Shell's Bluetooth indicator and device data. src/panel/bluetoothMenu/; tests/shell/panel/bluetoothMenu/bluetoothMenu.test.js
weather-clock module-weather-clock: on Places GNOME Weather beside the panel clock. It remains inactive when the GNOME Weather schema or data is unavailable. src/panel/clock/weatherClock/; unit logic test and tests/shell/panel/clock/weatherClock/weatherClock.test.js
calendar-reminders module-calendar-reminders: on Shows upcoming calendar events beside the clock and delivers configured Evolution reminders with Open Calendar and Snooze actions. Optional forced reminders also notify at the start of timed events, even after an earlier reminder. All-day filtering applies to the panel; forced reminders exclude all-day events. Depends on Shell calendar sources and Evolution for configured reminders. src/panel/clock/calendarReminders/; unit logic tests and tests/shell/panel/clock/calendarReminders/calendarReminders.test.js
tray-icons module-tray-icons: on Adds SNI and background-app icons with limits, attention handling, deduplication, recoloring, and optional Quick Settings hiding. Depends on Shell status notifier and background-app surfaces. src/desktop/trayIcons/; unit state/layout tests and tests/shell/desktop/trayIcons/
clipboard-history module-clipboard-history: on Stores clipboard entries locally for search, pinning, and restoration. Auto-paste requires a focused Wayland text-input-v3 field; the open shortcut is unset by default. src/clipboard/; tests/shell/clipboard/clipboardHistory.test.js

Option types, defaults, and labels live in each manifest and the GSettings schema. Use the module guide when changing them; the documentation test requires this table's keys to match the catalog exactly.