chore: update example readme
This commit is contained in:
parent
dca1d63717
commit
05d755c4f7
1 changed files with 211 additions and 166 deletions
377
README.md
377
README.md
|
|
@ -265,31 +265,61 @@ For example, to disable the bar on DP-1:
|
|||
"enabled": true,
|
||||
"appearance": {
|
||||
"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": {
|
||||
"scale": 1
|
||||
},
|
||||
"spacing": {
|
||||
"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": {
|
||||
"enabled": false,
|
||||
"base": 0.85,
|
||||
|
|
@ -297,7 +327,7 @@ For example, to disable the bar on DP-1:
|
|||
}
|
||||
},
|
||||
"general": {
|
||||
"logo": "caelestia",
|
||||
"logo": "",
|
||||
"showOverFullscreen": false,
|
||||
"mediaGifSpeedAdjustment": 300,
|
||||
"sessionGifSpeed": 0.7,
|
||||
|
|
@ -307,6 +337,25 @@ For example, to disable the bar on DP-1:
|
|||
"playback": ["mpv"],
|
||||
"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": {
|
||||
"warnLevels": [
|
||||
{
|
||||
|
|
@ -330,65 +379,102 @@ For example, to disable the bar on DP-1:
|
|||
}
|
||||
],
|
||||
"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": {
|
||||
"enabled": true,
|
||||
"wallpaperEnabled": true,
|
||||
"desktopClock": {
|
||||
"enabled": false,
|
||||
"scale": 1.0,
|
||||
"position": "bottom-right",
|
||||
"shadow": {
|
||||
"enabled": true,
|
||||
"opacity": 0.7,
|
||||
"blur": 0.4
|
||||
},
|
||||
"invertColors": false,
|
||||
"background": {
|
||||
"enabled": false,
|
||||
"opacity": 0.7,
|
||||
"blur": true
|
||||
},
|
||||
"invertColors": false
|
||||
},
|
||||
"shadow": {
|
||||
"enabled": true,
|
||||
"opacity": 0.7,
|
||||
"blur": 0.4
|
||||
}
|
||||
},
|
||||
"visualiser": {
|
||||
"blur": false,
|
||||
"enabled": false,
|
||||
"autoHide": true,
|
||||
"blur": false,
|
||||
"rounding": 1,
|
||||
"spacing": 1
|
||||
}
|
||||
},
|
||||
"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": {
|
||||
"compact": false,
|
||||
"inverted": false,
|
||||
"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": {
|
||||
"background": false,
|
||||
"showDate": false,
|
||||
"showIcon": true
|
||||
},
|
||||
"dragThreshold": 20,
|
||||
"entries": [
|
||||
{
|
||||
"id": "logo",
|
||||
|
|
@ -427,66 +513,12 @@ For example, to disable the bar on DP-1:
|
|||
"enabled": true
|
||||
}
|
||||
],
|
||||
"persistent": true,
|
||||
"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
|
||||
}
|
||||
"excludedScreens": []
|
||||
},
|
||||
"border": {
|
||||
"thickness": 10,
|
||||
"rounding": 25,
|
||||
"smoothing": 32,
|
||||
"thickness": 10
|
||||
"smoothing": 20
|
||||
},
|
||||
"dashboard": {
|
||||
"enabled": true,
|
||||
|
|
@ -495,11 +527,37 @@ For example, to disable the bar on DP-1:
|
|||
"showMedia": true,
|
||||
"showPerformance": true,
|
||||
"showWeather": true,
|
||||
"mediaUpdateInterval": 500,
|
||||
"resourceUpdateInterval": 1000,
|
||||
"dragThreshold": 50,
|
||||
"mediaUpdateInterval": 500
|
||||
"performance": {
|
||||
"showBattery": true,
|
||||
"showGpu": true,
|
||||
"showCpu": true,
|
||||
"showMemory": true,
|
||||
"showStorage": true,
|
||||
"showNetwork": true
|
||||
}
|
||||
},
|
||||
"launcher": {
|
||||
"enabled": true,
|
||||
"showOnHover": false,
|
||||
"maxShown": 7,
|
||||
"maxWallpapers": 9,
|
||||
"specialPrefix": "@",
|
||||
"actionPrefix": ">",
|
||||
"enableDangerousActions": false,
|
||||
"dragThreshold": 50,
|
||||
"vimKeybinds": false,
|
||||
"favouriteApps": [],
|
||||
"hiddenApps": [],
|
||||
"useFuzzy": {
|
||||
"apps": false,
|
||||
"actions": false,
|
||||
"schemes": false,
|
||||
"variants": false,
|
||||
"wallpapers": false
|
||||
},
|
||||
"actions": [
|
||||
{
|
||||
"name": "Calculator",
|
||||
|
|
@ -533,14 +591,6 @@ For example, to disable the bar on DP-1:
|
|||
"enabled": true,
|
||||
"dangerous": false
|
||||
},
|
||||
{
|
||||
"name": "Transparency",
|
||||
"icon": "opacity",
|
||||
"description": "Change shell transparency",
|
||||
"command": ["autocomplete", "transparency"],
|
||||
"enabled": false,
|
||||
"dangerous": false
|
||||
},
|
||||
{
|
||||
"name": "Random",
|
||||
"icon": "casino",
|
||||
|
|
@ -613,67 +663,53 @@ For example, to disable the bar on DP-1:
|
|||
"enabled": true,
|
||||
"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": {
|
||||
"recolourLogo": false,
|
||||
"recolourLogo": true,
|
||||
"enableFprint": true,
|
||||
"maxFprintTries": 3,
|
||||
"hideNotifs": false
|
||||
},
|
||||
"nexus": {
|
||||
"wallpapersPerRow": 4,
|
||||
"networkRescanInterval": 15000
|
||||
},
|
||||
"notifs": {
|
||||
"actionOnClick": false,
|
||||
"clearThreshold": 0.3,
|
||||
"expire": true,
|
||||
"fullscreen": "on",
|
||||
"defaultExpireTimeout": 5000,
|
||||
"fullscreenExpireTimeout": 2000,
|
||||
"clearThreshold": 0.3,
|
||||
"expandThreshold": 20,
|
||||
"openExpanded": false,
|
||||
"expire": false
|
||||
"actionOnClick": false,
|
||||
"groupPreviewNum": 3,
|
||||
"openExpanded": false
|
||||
},
|
||||
"osd": {
|
||||
"enabled": true,
|
||||
"hideDelay": 2000,
|
||||
"enableBrightness": true,
|
||||
"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"
|
||||
"enableMicrophone": false
|
||||
},
|
||||
"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": "",
|
||||
"useFahrenheit": false,
|
||||
"useFahrenheitPerformance": false,
|
||||
"useTwelveHourClock": false,
|
||||
"gpuType": "",
|
||||
"visualiserBars": 60,
|
||||
"audioIncrement": 0.1,
|
||||
"brightnessIncrement": 0.1,
|
||||
"maxVolume": 1.0,
|
||||
"smartScheme": true,
|
||||
"visualiserBars": 45
|
||||
"defaultPlayer": "Spotify",
|
||||
"playerAliases": [{ "from": "com.github.th_ch.youtube_music", "to": "YT Music" }],
|
||||
"lyricsBackend": "Auto"
|
||||
},
|
||||
"session": {
|
||||
"dragThreshold": 30,
|
||||
"enabled": true,
|
||||
"dragThreshold": 30,
|
||||
"vimKeybinds": false,
|
||||
"icons": {
|
||||
"logout": "logout",
|
||||
|
|
@ -689,28 +725,29 @@ For example, to disable the bar on DP-1:
|
|||
}
|
||||
},
|
||||
"sidebar": {
|
||||
"dragThreshold": 80,
|
||||
"enabled": true
|
||||
"enabled": true,
|
||||
"dragThreshold": 80
|
||||
},
|
||||
"utilities": {
|
||||
"enabled": true,
|
||||
"maxToasts": 4,
|
||||
"toasts": {
|
||||
"audioInputChanged": true,
|
||||
"audioOutputChanged": true,
|
||||
"capsLockChanged": true,
|
||||
"chargingChanged": true,
|
||||
"fullscreen": "off",
|
||||
"configLoaded": true,
|
||||
"dndChanged": true,
|
||||
"chargingChanged": true,
|
||||
"gameModeChanged": true,
|
||||
"dndChanged": true,
|
||||
"audioOutputChanged": true,
|
||||
"audioInputChanged": true,
|
||||
"capsLockChanged": true,
|
||||
"numLockChanged": true,
|
||||
"kbLayoutChanged": true,
|
||||
"kbLimit": true,
|
||||
"numLockChanged": true,
|
||||
"vpnChanged": true,
|
||||
"nowPlaying": false
|
||||
},
|
||||
"vpn": {
|
||||
"enabled": true,
|
||||
"enabled": false,
|
||||
"provider": [
|
||||
{
|
||||
"name": "wireguard",
|
||||
|
|
@ -734,8 +771,8 @@ For example, to disable the bar on DP-1:
|
|||
"enabled": true
|
||||
},
|
||||
{
|
||||
"enabled": true,
|
||||
"id": "settings"
|
||||
"id": "settings",
|
||||
"enabled": true
|
||||
},
|
||||
{
|
||||
"id": "gameMode",
|
||||
|
|
@ -747,9 +784,17 @@ For example, to disable the bar on DP-1:
|
|||
},
|
||||
{
|
||||
"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"
|
||||
}
|
||||
}
|
||||
```
|
||||
|
|
|
|||
Loading…
Add table
Reference in a new issue