pragma Singleton import QtQuick import Quickshell import Quickshell.Io import "../Helpers/QtObj2JS.js" as QtObj2JS import qs.Commons import qs.Commons.Migrations import qs.Modules.OSD import qs.Services.UI Singleton { id: root property bool isLoaded: false property bool directoriesCreated: false property bool shouldOpenSetupWizard: false /* Shell directories. - Default config directory: ~/.config/noctalia - Default cache directory: ~/.cache/noctalia */ readonly property alias data: adapter // Used to access via Settings.data.xxx.yyy readonly property int settingsVersion: 26 readonly property bool isDebug: Quickshell.env("NOCTALIA_DEBUG") === "1" readonly property string shellName: "noctalia" readonly property string configDir: Quickshell.env("NOCTALIA_CONFIG_DIR") || (Quickshell.env("XDG_CONFIG_HOME") || Quickshell.env("HOME") + "/.config") + "/" + shellName + "/" readonly property string cacheDir: Quickshell.env("NOCTALIA_CACHE_DIR") || (Quickshell.env("XDG_CACHE_HOME") || Quickshell.env("HOME") + "/.cache") + "/" + shellName + "/" readonly property string cacheDirImages: cacheDir + "images/" readonly property string cacheDirImagesWallpapers: cacheDir + "images/wallpapers/" readonly property string cacheDirImagesNotifications: cacheDir + "images/notifications/" readonly property string settingsFile: Quickshell.env("NOCTALIA_SETTINGS_FILE") || (configDir + "settings.json") readonly property string defaultLocation: "Tokyo" readonly property string defaultAvatar: Quickshell.env("HOME") + "/.face" readonly property string defaultVideosDirectory: Quickshell.env("HOME") + "/Videos" readonly property string defaultWallpapersDirectory: Quickshell.env("HOME") + "/Pictures/Wallpapers" // Signal emitted when settings are loaded after startupcale changes signal settingsLoaded signal settingsSaved // ----------------------------------------------------- // ----------------------------------------------------- // Ensure directories exist before FileView tries to read files Component.onCompleted: { // ensure settings dir exists Quickshell.execDetached(["mkdir", "-p", configDir]); Quickshell.execDetached(["mkdir", "-p", cacheDir]); Quickshell.execDetached(["mkdir", "-p", cacheDirImagesWallpapers]); Quickshell.execDetached(["mkdir", "-p", cacheDirImagesNotifications]); // Mark directories as created and trigger file loading directoriesCreated = true; // This should only be activated once when the settings structure has changed // Then it should be commented out again, regular users don't need to generate // default settings on every start if (isDebug) { generateDefaultSettings(); } // Patch-in the local default, resolved to user's home adapter.general.avatarImage = defaultAvatar; adapter.screenRecorder.directory = defaultVideosDirectory; adapter.wallpaper.directory = defaultWallpapersDirectory; adapter.ui.fontDefault = Qt.application.font.family; adapter.ui.fontFixed = "monospace"; // Set the adapter to the settingsFileView to trigger the real settings load settingsFileView.adapter = adapter; } // Don't write settings to disk immediately // This avoid excessive IO when a variable changes rapidly (ex: sliders) Timer { id: saveTimer running: false interval: 500 onTriggered: { root.saveImmediate(); } } FileView { id: settingsFileView path: directoriesCreated ? settingsFile : undefined printErrors: false watchChanges: true onFileChanged: reload() onAdapterUpdated: saveTimer.start() // Trigger initial load when path changes from empty to actual path onPathChanged: { if (path !== undefined) { reload(); } } onLoaded: function () { if (!isLoaded) { Logger.i("Settings", "Settings loaded"); // ----------------- // Run versioned migrations from MigrationRegistry runVersionedMigrations(); upgradeSettingsData(); root.isLoaded = true; // Emit the signal root.settingsLoaded(); // Finally, update our local settings version adapter.settingsVersion = settingsVersion; } } onLoadFailed: function (error) { if (error.toString().includes("No such file") || error === 2) { // File doesn't exist, create it with default values writeAdapter(); // Also write to fallback if set if (Quickshell.env("NOCTALIA_SETTINGS_FALLBACK")) { settingsFallbackFileView.writeAdapter(); } // We started without settings, we should open the setupWizard root.shouldOpenSetupWizard = true; } } } // Fallback FileView for writing settings to alternate location FileView { id: settingsFallbackFileView path: Quickshell.env("NOCTALIA_SETTINGS_FALLBACK") || "" adapter: Quickshell.env("NOCTALIA_SETTINGS_FALLBACK") ? adapter : null printErrors: false watchChanges: false } JsonAdapter { id: adapter property int settingsVersion: root.settingsVersion // bar property JsonObject bar: JsonObject { property string position: "top" // "top", "bottom", "left", or "right" property real backgroundOpacity: 1.0 property list monitors: [] // holds bar visibility per monitor property string density: "default" // "compact", "default", "comfortable" property bool showCapsule: true property real capsuleOpacity: 1.0 // Floating bar settings property bool floating: false property real marginVertical: 0.25 property real marginHorizontal: 0.25 // Bar outer corners (inverted/concave corners at bar edges when not floating) property bool outerCorners: true // Reserves space with compositor property bool exclusive: true // Widget configuration for modular bar system property JsonObject widgets widgets: JsonObject { property list left: [ { "icon": "rocket", "id": "CustomButton", "leftClickExec": "qs -c noctalia-shell ipc call launcher toggle" }, { "id": "Clock", "usePrimaryColor": false }, { "id": "SystemMonitor" }, { "id": "ActiveWindow" }, { "id": "MediaMini" } ] property list center: [ { "id": "Workspace" } ] property list right: [ { "id": "ScreenRecorder" }, { "id": "Tray" }, { "id": "NotificationHistory" }, { "id": "Battery" }, { "id": "Volume" }, { "id": "Brightness" }, { "id": "ControlCenter" } ] } } // general property JsonObject general: JsonObject { property string avatarImage: "" property real dimmerOpacity: 0.6 property bool showScreenCorners: false property bool forceBlackScreenCorners: false property real scaleRatio: 1.0 property real radiusRatio: 1.0 property real screenRadiusRatio: 1.0 property real animationSpeed: 1.0 property bool animationDisabled: false property bool compactLockScreen: false property bool lockOnSuspend: true property bool showHibernateOnLockScreen: false property bool enableShadows: true property string shadowDirection: "bottom_right" property int shadowOffsetX: 2 property int shadowOffsetY: 3 property string language: "" property bool allowPanelsOnScreenWithoutBar: true } // ui property JsonObject ui: JsonObject { property string fontDefault: "" property string fontFixed: "" property real fontDefaultScale: 1.0 property real fontFixedScale: 1.0 property bool tooltipsEnabled: true property real panelBackgroundOpacity: 1.0 property bool panelsAttachedToBar: true property bool settingsPanelAttachToBar: false } // location property JsonObject location: JsonObject { property string name: defaultLocation property bool weatherEnabled: true property bool weatherShowEffects: true property bool useFahrenheit: false property bool use12hourFormat: false property bool showWeekNumberInCalendar: false property bool showCalendarEvents: true property bool showCalendarWeather: true property bool analogClockInCalendar: false property int firstDayOfWeek: -1 // -1 = auto (use locale), 0 = Sunday, 1 = Monday, 6 = Saturday } // calendar property JsonObject calendar: JsonObject { property list cards: [ { "id": "calendar-header-card", "enabled": true }, { "id": "calendar-month-card", "enabled": true }, { "id": "timer-card", "enabled": true }, { "id": "weather-card", "enabled": true } ] } // screen recorder property JsonObject screenRecorder: JsonObject { property string directory: "" property int frameRate: 60 property string audioCodec: "opus" property string videoCodec: "h264" property string quality: "very_high" property string colorRange: "limited" property bool showCursor: true property string audioSource: "default_output" property string videoSource: "portal" } // wallpaper property JsonObject wallpaper: JsonObject { property bool enabled: true property bool overviewEnabled: false property string directory: "" property list monitorDirectories: [] property bool enableMultiMonitorDirectories: false property bool recursiveSearch: false property bool setWallpaperOnAllMonitors: true property string fillMode: "crop" property color fillColor: "#000000" property bool randomEnabled: false property int randomIntervalSec: 300 // 5 min property int transitionDuration: 1500 // 1500 ms property string transitionType: "random" property real transitionEdgeSmoothness: 0.05 property string panelPosition: "follow_bar" property bool hideWallpaperFilenames: false // Wallhaven settings property bool useWallhaven: false property string wallhavenQuery: "" property string wallhavenSorting: "relevance" property string wallhavenOrder: "desc" property string wallhavenCategories: "111" // general,anime,people property string wallhavenPurity: "100" // sfw only property string wallhavenResolutionMode: "atleast" // "atleast" or "exact" property string wallhavenResolutionWidth: "" property string wallhavenResolutionHeight: "" } // applauncher property JsonObject appLauncher: JsonObject { property bool enableClipboardHistory: false property bool enableClipPreview: true // Position: center, top_left, top_right, bottom_left, bottom_right, bottom_center, top_center property string position: "center" property list pinnedExecs: [] property bool useApp2Unit: false property bool sortByMostUsed: true property string terminalCommand: "xterm -e" property bool customLaunchPrefixEnabled: false property string customLaunchPrefix: "" // View mode: "list" or "grid" property string viewMode: "list" } // control center property JsonObject controlCenter: JsonObject { // Position: close_to_bar_button, center, top_left, top_right, bottom_left, bottom_right, bottom_center, top_center property string position: "close_to_bar_button" property JsonObject shortcuts shortcuts: JsonObject { property list left: [ { "id": "WiFi" }, { "id": "Bluetooth" }, { "id": "ScreenRecorder" }, { "id": "WallpaperSelector" } ] property list right: [ { "id": "Notifications" }, { "id": "PowerProfile" }, { "id": "KeepAwake" }, { "id": "NightLight" } ] } property list cards: [ { "id": "profile-card", "enabled": true }, { "id": "shortcuts-card", "enabled": true }, { "id": "audio-card", "enabled": true }, { "id": "weather-card", "enabled": true }, { "id": "media-sysmon-card", "enabled": true } ] } // system monitor property JsonObject systemMonitor: JsonObject { property int cpuWarningThreshold: 80 property int cpuCriticalThreshold: 90 property int tempWarningThreshold: 80 property int tempCriticalThreshold: 90 property int memWarningThreshold: 80 property int memCriticalThreshold: 90 property int diskWarningThreshold: 80 property int diskCriticalThreshold: 90 property int cpuPollingInterval: 3000 property int tempPollingInterval: 3000 property int memPollingInterval: 3000 property int diskPollingInterval: 3000 property int networkPollingInterval: 3000 property bool useCustomColors: false property string warningColor: "" property string criticalColor: "" } // dock property JsonObject dock: JsonObject { property bool enabled: true property string displayMode: "auto_hide" // "always_visible", "auto_hide", "exclusive" property real backgroundOpacity: 1.0 property real radiusRatio: 0.1 property real floatingRatio: 1.0 property real size: 1 property bool onlySameOutput: true property list monitors: [] // holds dock visibility per monitor // Desktop entry IDs pinned to the dock (e.g., "org.kde.konsole", "firefox.desktop") property list pinnedApps: [] property bool colorizeIcons: false } // network property JsonObject network: JsonObject { property bool wifiEnabled: true } // session menu property JsonObject sessionMenu: JsonObject { property bool enableCountdown: true property int countdownDuration: 10000 property string position: "center" property bool showHeader: true property list powerOptions: [ { "action": "lock", "enabled": true }, { "action": "suspend", "enabled": true }, { "action": "hibernate", "enabled": true }, { "action": "reboot", "enabled": true }, { "action": "logout", "enabled": true }, { "action": "shutdown", "enabled": true } ] } // notifications property JsonObject notifications: JsonObject { property bool enabled: true property list monitors: [] // holds notifications visibility per monitor property string location: "top_right" property bool overlayLayer: true property real backgroundOpacity: 1.0 property bool respectExpireTimeout: false property int lowUrgencyDuration: 3 property int normalUrgencyDuration: 8 property int criticalUrgencyDuration: 15 property bool enableKeyboardLayoutToast: true } // on-screen display property JsonObject osd: JsonObject { property bool enabled: true property string location: "top_right" property int autoHideMs: 2000 property bool overlayLayer: true property real backgroundOpacity: 1.0 property list enabledTypes: [OSD.Type.Volume, OSD.Type.InputVolume, OSD.Type.Brightness] property list monitors: [] // holds osd visibility per monitor } // audio property JsonObject audio: JsonObject { property int volumeStep: 5 property bool volumeOverdrive: false property int cavaFrameRate: 30 property string visualizerType: "linear" property string visualizerQuality: "high" property list mprisBlacklist: [] property string preferredPlayer: "" property string externalMixer: "pwvucontrol || pavucontrol" } // brightness property JsonObject brightness: JsonObject { property int brightnessStep: 5 property bool enforceMinimum: true property bool enableDdcSupport: false } property JsonObject colorSchemes: JsonObject { property bool useWallpaperColors: false property string predefinedScheme: "Noctalia (default)" property bool darkMode: true property string schedulingMode: "off" property string manualSunrise: "06:30" property string manualSunset: "18:30" property string matugenSchemeType: "scheme-fruit-salad" property bool generateTemplatesForPredefined: true } // templates toggles property JsonObject templates: JsonObject { property bool gtk: false property bool qt: false property bool kcolorscheme: false property bool alacritty: false property bool kitty: false property bool ghostty: false property bool foot: false property bool wezterm: false property bool fuzzel: false property bool discord: false property bool pywalfox: false property bool vicinae: false property bool walker: false property bool code: false property bool spicetify: false property bool telegram: false property bool cava: false property bool emacs: false property bool niri: false property bool enableUserTemplates: false } // night light property JsonObject nightLight: JsonObject { property bool enabled: false property bool forced: false property bool autoSchedule: true property string nightTemp: "4000" property string dayTemp: "6500" property string manualSunrise: "06:30" property string manualSunset: "18:30" } property JsonObject changelog: JsonObject { property string lastSeenVersion: "" } // hooks property JsonObject hooks: JsonObject { property bool enabled: false property string wallpaperChange: "" property string darkModeChange: "" } } // ----------------------------------------------------- // Function to preprocess paths by expanding "~" to user's home directory function preprocessPath(path) { if (typeof path !== "string" || path === "") { return path; } // Expand "~" to user's home directory if (path.startsWith("~/")) { return Quickshell.env("HOME") + path.substring(1); } else if (path === "~") { return Quickshell.env("HOME"); } return path; } // ----------------------------------------------------- // Public function to trigger immediate settings saving function saveImmediate() { settingsFileView.writeAdapter(); // Write to fallback location if set if (Quickshell.env("NOCTALIA_SETTINGS_FALLBACK")) { settingsFallbackFileView.writeAdapter(); } root.settingsSaved(); // Emit signal after saving } // ----------------------------------------------------- // Generate default settings at the root of the repo function generateDefaultSettings() { try { Logger.d("Settings", "Generating settings-default.json"); // Prepare a clean JSON var plainAdapter = QtObj2JS.qtObjectToPlainObject(adapter); var jsonData = JSON.stringify(plainAdapter, null, 2); var defaultPath = Quickshell.shellDir + "/Assets/settings-default.json"; // Encode transfer it has base64 to avoid any escaping issue var base64Data = Qt.btoa(jsonData); Quickshell.execDetached(["sh", "-c", `echo "${base64Data}" | base64 -d > "${defaultPath}"`]); } catch (error) { Logger.e("Settings", "Failed to generate default settings file: " + error); } } // ----------------------------------------------------- // Run versioned migrations using MigrationRegistry function runVersionedMigrations() { const currentVersion = adapter.settingsVersion; const migrations = MigrationRegistry.migrations; // Get all migration versions and sort them const versions = Object.keys(migrations).map(v => parseInt(v)).sort((a, b) => a - b); // Run migrations in order for versions newer than current for (var i = 0; i < versions.length; i++) { const version = versions[i]; if (currentVersion < version) { // Create migration instance and run it const migrationComponent = migrations[version]; const migration = migrationComponent.createObject(root); if (migration && typeof migration.migrate === "function") { const success = migration.migrate(adapter, Logger); if (!success) { Logger.e("Settings", "Migration to v" + version + " failed"); } } else { Logger.e("Settings", "Invalid migration for v" + version); } // Clean up migration instance if (migration) { migration.destroy(); } } } } // ----------------------------------------------------- // Function to clean up deprecated user/custom bar widgets settings function upgradeWidget(widget) { // Backup the widget definition before altering const widgetBefore = JSON.stringify(widget); // Get all existing custom settings keys const keys = Object.keys(BarWidgetRegistry.widgetMetadata[widget.id]); // Delete deprecated user settings from the wiget for (const k of Object.keys(widget)) { if (k === "id" || k === "allowUserSettings") { continue; } if (!keys.includes(k)) { delete widget[k]; } } // Inject missing default setting (metaData) from BarWidgetRegistry for (var i = 0; i < keys.length; i++) { const k = keys[i]; if (k === "id" || k === "allowUserSettings") { continue; } if (widget[k] === undefined) { widget[k] = BarWidgetRegistry.widgetMetadata[widget.id][k]; } } // Compare settings, to detect if something has been upgraded const widgetAfter = JSON.stringify(widget); return (widgetAfter !== widgetBefore); } // ----------------------------------------------------- // If the settings structure has changed, ensure // backward compatibility by upgrading the settings function upgradeSettingsData() { // Wait for BarWidgetRegistry to be ready if (!BarWidgetRegistry.widgets || Object.keys(BarWidgetRegistry.widgets).length === 0) { Logger.w("Settings", "BarWidgetRegistry not ready, deferring upgrade"); Qt.callLater(upgradeSettingsData); return; } const sections = ["left", "center", "right"]; // ----------------- // 1. remove any non existing widget type var removedWidget = false; for (var s = 0; s < sections.length; s++) { const sectionName = sections[s]; const widgets = adapter.bar.widgets[sectionName]; // Iterate backward through the widgets array, so it does not break when removing a widget for (var i = widgets.length - 1; i >= 0; i--) { var widget = widgets[i]; if (!BarWidgetRegistry.hasWidget(widget.id)) { Logger.w(`Settings`, `Deleted invalid widget ${widget.id}`); widgets.splice(i, 1); removedWidget = true; } } } // ----------------- // 2. upgrade user widget settings for (var s = 0; s < sections.length; s++) { const sectionName = sections[s]; for (var i = 0; i < adapter.bar.widgets[sectionName].length; i++) { var widget = adapter.bar.widgets[sectionName][i]; // Check if widget registry supports user settings, if it does not, then there is nothing to do const reg = BarWidgetRegistry.widgetMetadata[widget.id]; if ((reg === undefined) || (reg.allowUserSettings === undefined) || !reg.allowUserSettings) { continue; } if (upgradeWidget(widget)) { Logger.d("Settings", `Upgraded ${widget.id} widget:`, JSON.stringify(widget)); } } } // ----------------- // 3. safety check // if a widget was deleted, ensure we still have a control center if (removedWidget) { var gotControlCenter = false; for (var s = 0; s < sections.length; s++) { const sectionName = sections[s]; for (var i = 0; i < adapter.bar.widgets[sectionName].length; i++) { var widget = adapter.bar.widgets[sectionName][i]; if (widget.id === "ControlCenter") { gotControlCenter = true; break; } } } if (!gotControlCenter) { //const obj = JSON.parse('{"id": "ControlCenter"}'); adapter.bar.widgets["right"].push(({ "id": "ControlCenter" })); Logger.w("Settings", "Added a ControlCenter widget to the right section"); } } } }