nosignal/nosignal-shell
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity

chore: update example readme

Browse source
This commit is contained in:
2 * r + 2 * t 2026-06-07 22:47:46 +10:00
parent dca1d63717
commit 05d755c4f7
1 changed files with 211 additions and 166 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

377
README.md
View file

@ -265,31 +265,61 @@ For example, to disable the bar on DP-1:
"enabled": true, "enabled": true,
"appearance": { "appearance": {
"deformScale": 1, "deformScale": 1,
"anim": {
"durations": {
"scale": 1
}
},
"font": {
"family": {
"clock": "Rubik",
"material": "Material Symbols Rounded",
"mono": "CaskaydiaCove NF",
"sans": "Rubik"
},
"size": {
"scale": 1
}
},
"padding": {
"scale": 1
},
"rounding": { "rounding": {
"scale": 1 "scale": 1
}, },
"spacing": { "spacing": {
"scale": 1 "scale": 1
}, },
"padding": {
"scale": 1
},
"font": {
"scale": 1,
"clock": "Rubik",
"headline": {
"family": "GoogleSansFlex",
"large": { "size": 32, "weight": 500, "italic": false, "vaxes": { "ROND": 25 } },
"medium": { "size": 28, "weight": 500, "italic": false, "vaxes": { "ROND": 25 } },
"small": { "size": 24, "weight": 500, "italic": false, "vaxes": { "ROND": 25 } }
},
"title": {
"family": "GoogleSansFlex",
"large": { "size": 22, "weight": 500, "italic": false, "vaxes": { "ROND": 25 } },
"medium": { "size": 16, "weight": 500, "italic": false, "vaxes": { "ROND": 25 } },
"small": { "size": 14, "weight": 500, "italic": false, "vaxes": { "ROND": 25 } }
},
"body": {
"family": "GoogleSansFlex",
"large": { "size": 16, "weight": 400, "italic": false, "vaxes": { "ROND": 25 } },
"medium": { "size": 14, "weight": 400, "italic": false, "vaxes": { "ROND": 25 } },
"small": { "size": 12, "weight": 400, "italic": false, "vaxes": { "ROND": 25 } }
},
"label": {
"family": "GoogleSansFlex",
"large": { "size": 14, "weight": 500, "italic": false, "vaxes": { "ROND": 25 } },
"medium": { "size": 12, "weight": 500, "italic": false, "vaxes": { "ROND": 25 } },
"small": { "size": 11, "weight": 400, "italic": false, "vaxes": { "ROND": 25 } }
},
"mono": {
"family": "CaskaydiaCove NF",
"large": { "size": 16, "weight": 400, "italic": false, "vaxes": {} },
"medium": { "size": 14, "weight": 400, "italic": false, "vaxes": {} },
"small": { "size": 12, "weight": 400, "italic": false, "vaxes": {} }
},
"icon": {
"family": "Material Symbols Rounded",
"extraLarge": { "size": 36, "weight": 400, "italic": false, "vaxes": {} },
"large": { "size": 24, "weight": 400, "italic": false, "vaxes": {} },
"medium": { "size": 18, "weight": 400, "italic": false, "vaxes": {} },
"small": { "size": 15, "weight": 400, "italic": false, "vaxes": {} }
}
},
"anim": {
"durations": {
"scale": 1
}
},
"transparency": { "transparency": {
"enabled": false, "enabled": false,
"base": 0.85, "base": 0.85,
@ -297,7 +327,7 @@ For example, to disable the bar on DP-1:
} }
}, },
"general": { "general": {
"logo": "caelestia", "logo": "",
"showOverFullscreen": false, "showOverFullscreen": false,
"mediaGifSpeedAdjustment": 300, "mediaGifSpeedAdjustment": 300,
"sessionGifSpeed": 0.7, "sessionGifSpeed": 0.7,
@ -307,6 +337,25 @@ For example, to disable the bar on DP-1:
"playback": ["mpv"], "playback": ["mpv"],
"explorer": ["thunar"] "explorer": ["thunar"]
}, },
"idle": {
"lockBeforeSleep": true,
"inhibitWhenAudio": true,
"timeouts": [
{
"timeout": 180,
"idleAction": "lock"
},
{
"timeout": 300,
"idleAction": "dpms off",
"returnAction": "dpms on"
},
{
"timeout": 600,
"idleAction": ["systemctl", "suspend-then-hibernate"]
}
]
},
"battery": { "battery": {
"warnLevels": [ "warnLevels": [
{ {
@ -330,65 +379,102 @@ For example, to disable the bar on DP-1:
} }
], ],
"criticalLevel": 3 "criticalLevel": 3
},
"idle": {
"lockBeforeSleep": true,
"inhibitWhenAudio": true,
"timeouts": [
{
"timeout": 180,
"idleAction": "lock"
},
{
"timeout": 300,
"idleAction": "dpms off",
"returnAction": "dpms on"
},
{
"timeout": 600,
"idleAction": ["systemctl", "suspend-then-hibernate"]
}
]
} }
}, },
"background": { "background": {
"enabled": true,
"wallpaperEnabled": true,
"desktopClock": { "desktopClock": {
"enabled": false, "enabled": false,
"scale": 1.0, "scale": 1.0,
"position": "bottom-right", "position": "bottom-right",
"shadow": { "invertColors": false,
"enabled": true,
"opacity": 0.7,
"blur": 0.4
},
"background": { "background": {
"enabled": false, "enabled": false,
"opacity": 0.7, "opacity": 0.7,
"blur": true "blur": true
}, },
"invertColors": false "shadow": {
"enabled": true,
"opacity": 0.7,
"blur": 0.4
}
}, },
"enabled": true,
"visualiser": { "visualiser": {
"blur": false,
"enabled": false, "enabled": false,
"autoHide": true, "autoHide": true,
"blur": false,
"rounding": 1, "rounding": 1,
"spacing": 1 "spacing": 1
} }
}, },
"bar": { "bar": {
"persistent": true,
"showOnHover": true,
"dragThreshold": 20,
"scrollActions": {
"workspaces": true,
"volume": true,
"brightness": true
},
"popouts": {
"activeWindow": true,
"tray": true,
"statusIcons": true
},
"workspaces": {
"shown": 5,
"activeIndicator": true,
"occupiedBg": false,
"showWindows": true,
"showWindowsOnSpecialWorkspaces": true,
"maxWindowIcons": 5,
"activeTrail": false,
"perMonitorWorkspaces": true,
"label": " ",
"occupiedLabel": "󰮯",
"activeLabel": "󰮯",
"capitalisation": "preserve",
"specialWorkspaceIcons": [
{
"name": "steam",
"icon": "sports_esports"
}
],
"windowIcons": [
{
"regex": "steam(_app_(default|[0-9]+))?",
"icon": "sports_esports"
}
]
},
"activeWindow": { "activeWindow": {
"compact": false, "compact": false,
"inverted": false, "inverted": false,
"showOnHover": true "showOnHover": true
}, },
"tray": {
"background": false,
"recolour": false,
"compact": false,
"iconSubs": [],
"hiddenIcons": []
},
"status": {
"showAudio": false,
"showMicrophone": false,
"showKbLayout": false,
"showNetwork": true,
"showWifi": true,
"showBluetooth": true,
"showBattery": true,
"showLockStatus": true
},
"clock": { "clock": {
"background": false, "background": false,
"showDate": false, "showDate": false,
"showIcon": true "showIcon": true
}, },
"dragThreshold": 20,
"entries": [ "entries": [
{ {
"id": "logo", "id": "logo",
@ -427,66 +513,12 @@ For example, to disable the bar on DP-1:
"enabled": true "enabled": true
} }
], ],
"persistent": true, "excludedScreens": []
"popouts": {
"activeWindow": true,
"statusIcons": true,
"tray": true
},
"scrollActions": {
"brightness": true,
"workspaces": true,
"volume": true
},
"showOnHover": true,
"status": {
"showAudio": false,
"showBattery": true,
"showBluetooth": true,
"showKbLayout": false,
"showMicrophone": false,
"showNetwork": true,
"showWifi": true,
"showLockStatus": true
},
"tray": {
"background": false,
"compact": false,
"iconSubs": [],
"recolour": false
},
"workspaces": {
"activeIndicator": true,
"activeLabel": "󰮯",
"activeTrail": false,
"label": " ",
"occupiedBg": false,
"occupiedLabel": "󰮯",
"perMonitorWorkspaces": true,
"showWindows": true,
"shown": 5,
"specialWorkspaceIcons": [
{
"name": "steam",
"icon": "sports_esports"
}
],
"windowIcons": [
{
"regex": "steam(_app_(default|[0-9]+))?",
"icon": "sports_esports"
}
]
},
"excludedScreens": [""],
"activeWindow": {
"inverted": false
}
}, },
"border": { "border": {
"thickness": 10,
"rounding": 25, "rounding": 25,
"smoothing": 32, "smoothing": 20
"thickness": 10
}, },
"dashboard": { "dashboard": {
"enabled": true, "enabled": true,
@ -495,11 +527,37 @@ For example, to disable the bar on DP-1:
"showMedia": true, "showMedia": true,
"showPerformance": true, "showPerformance": true,
"showWeather": true, "showWeather": true,
"mediaUpdateInterval": 500,
"resourceUpdateInterval": 1000,
"dragThreshold": 50, "dragThreshold": 50,
"mediaUpdateInterval": 500 "performance": {
"showBattery": true,
"showGpu": true,
"showCpu": true,
"showMemory": true,
"showStorage": true,
"showNetwork": true
}
}, },
"launcher": { "launcher": {
"enabled": true,
"showOnHover": false,
"maxShown": 7,
"maxWallpapers": 9,
"specialPrefix": "@",
"actionPrefix": ">", "actionPrefix": ">",
"enableDangerousActions": false,
"dragThreshold": 50,
"vimKeybinds": false,
"favouriteApps": [],
"hiddenApps": [],
"useFuzzy": {
"apps": false,
"actions": false,
"schemes": false,
"variants": false,
"wallpapers": false
},
"actions": [ "actions": [
{ {
"name": "Calculator", "name": "Calculator",
@ -533,14 +591,6 @@ For example, to disable the bar on DP-1:
"enabled": true, "enabled": true,
"dangerous": false "dangerous": false
}, },
{
"name": "Transparency",
"icon": "opacity",
"description": "Change shell transparency",
"command": ["autocomplete", "transparency"],
"enabled": false,
"dangerous": false
},
{ {
"name": "Random", "name": "Random",
"icon": "casino", "icon": "casino",
@ -613,67 +663,53 @@ For example, to disable the bar on DP-1:
"enabled": true, "enabled": true,
"dangerous": false "dangerous": false
} }
], ]
"dragThreshold": 50,
"vimKeybinds": false,
"enableDangerousActions": false,
"maxShown": 7,
"maxWallpapers": 9,
"specialPrefix": "@",
"useFuzzy": {
"apps": false,
"actions": false,
"schemes": false,
"variants": false,
"wallpapers": false
},
"showOnHover": false,
"favouriteApps": [],
"hiddenApps": []
}, },
"lock": { "lock": {
"recolourLogo": false, "recolourLogo": true,
"enableFprint": true,
"maxFprintTries": 3,
"hideNotifs": false "hideNotifs": false
}, },
"nexus": {
"wallpapersPerRow": 4,
"networkRescanInterval": 15000
},
"notifs": { "notifs": {
"actionOnClick": false, "expire": true,
"clearThreshold": 0.3, "fullscreen": "on",
"defaultExpireTimeout": 5000, "defaultExpireTimeout": 5000,
"fullscreenExpireTimeout": 2000,
"clearThreshold": 0.3,
"expandThreshold": 20, "expandThreshold": 20,
"openExpanded": false, "actionOnClick": false,
"expire": false "groupPreviewNum": 3,
"openExpanded": false
}, },
"osd": { "osd": {
"enabled": true, "enabled": true,
"hideDelay": 2000,
"enableBrightness": true, "enableBrightness": true,
"enableMicrophone": false, "enableMicrophone": false
"hideDelay": 2000
},
"paths": {
"mediaGif": "root:/assets/bongocat.gif",
"sessionGif": "root:/assets/kurukuru.gif",
"noNotifsPic": "root:/assets/dino.png",
"lockNoNotifsPic": "root:/assets/dino.png",
"wallpaperDir": "~/Pictures/Wallpapers",
"lyricsDir": "~/Music/lyrics"
}, },
"services": { "services": {
"audioIncrement": 0.1,
"brightnessIncrement": 0.1,
"maxVolume": 1.0,
"defaultPlayer": "Spotify",
"gpuType": "",
"playerAliases": [{ "from": "com.github.th_ch.youtube_music", "to": "YT Music" }],
"weatherLocation": "", "weatherLocation": "",
"useFahrenheit": false, "useFahrenheit": false,
"useFahrenheitPerformance": false, "useFahrenheitPerformance": false,
"useTwelveHourClock": false, "useTwelveHourClock": false,
"gpuType": "",
"visualiserBars": 60,
"audioIncrement": 0.1,
"brightnessIncrement": 0.1,
"maxVolume": 1.0,
"smartScheme": true, "smartScheme": true,
"visualiserBars": 45 "defaultPlayer": "Spotify",
"playerAliases": [{ "from": "com.github.th_ch.youtube_music", "to": "YT Music" }],
"lyricsBackend": "Auto"
}, },
"session": { "session": {
"dragThreshold": 30,
"enabled": true, "enabled": true,
"dragThreshold": 30,
"vimKeybinds": false, "vimKeybinds": false,
"icons": { "icons": {
"logout": "logout", "logout": "logout",
@ -689,28 +725,29 @@ For example, to disable the bar on DP-1:
} }
}, },
"sidebar": { "sidebar": {
"dragThreshold": 80, "enabled": true,
"enabled": true "dragThreshold": 80
}, },
"utilities": { "utilities": {
"enabled": true, "enabled": true,
"maxToasts": 4, "maxToasts": 4,
"toasts": { "toasts": {
"audioInputChanged": true, "fullscreen": "off",
"audioOutputChanged": true,
"capsLockChanged": true,
"chargingChanged": true,
"configLoaded": true, "configLoaded": true,
"dndChanged": true, "chargingChanged": true,
"gameModeChanged": true, "gameModeChanged": true,
"dndChanged": true,
"audioOutputChanged": true,
"audioInputChanged": true,
"capsLockChanged": true,
"numLockChanged": true,
"kbLayoutChanged": true, "kbLayoutChanged": true,
"kbLimit": true, "kbLimit": true,
"numLockChanged": true,
"vpnChanged": true, "vpnChanged": true,
"nowPlaying": false "nowPlaying": false
}, },
"vpn": { "vpn": {
"enabled": true, "enabled": false,
"provider": [ "provider": [
{ {
"name": "wireguard", "name": "wireguard",
@ -734,8 +771,8 @@ For example, to disable the bar on DP-1:
"enabled": true "enabled": true
}, },
{ {
"enabled": true, "id": "settings",
"id": "settings" "enabled": true
}, },
{ {
"id": "gameMode", "id": "gameMode",
@ -747,9 +784,17 @@ For example, to disable the bar on DP-1:
}, },
{ {
"id": "vpn", "id": "vpn",
"enabled": true "enabled": false
} }
] ]
},
"paths": {
"wallpaperDir": "~/Pictures/Wallpapers",
"lyricsDir": "~/Music/lyrics/",
"sessionGif": "root:/assets/kurukuru.gif",
"mediaGif": "root:/assets/bongocat.gif",
"noNotifsPic": "root:/assets/dino.png",
"lockNoNotifsPic": "root:/assets/dino.png"
} }
} }
``` ```