Skip to content

Your language is missing?

Help us translate this documentation!

See how to contribute translations →

Main Configuration

HyDE exposes xdg_config/hyde/config.toml file for users to modify. This lets users have the ability to interact the scripts without using command arguments.

Users are encouraged to use an editor that support schema validation to ensure the configuration file is valid.

"$schema" = "https://raw.githubusercontent.com/HyDE-Project/HyDE/refs/heads/master/Configs/.local/share/hyde/schema/config.toml.json"

batterynotify.sh configuration.

KeyDescriptionDefault
dockDock status for battery notifications.true
intervalInterval for battery notifications.5
notifyNotification threshold.1140
timerTimer for battery notifications.120

Commands to execute for battery notifications.

KeyDescriptionDefault
chargingCommand to execute when charging.
criticalCommand to execute when battery is critical.systemctl suspend
dischargingCommand to execute when discharging.
lowCommand to execute when battery is low.
unplugCommand to execute when unplugged.

Thresholds for battery notifications.

KeyDescriptionDefault
criticalCritical battery threshold.10
fullFull battery threshold.90
lowLow battery threshold.20
unplugUnplug battery threshold.100

brightnesscontrol.sh configuration.

KeyDescriptionDefault
notifyEnable notifications for brightness control.true
stepsNumber of steps to increase/decrease brightness.5

‘cava.sh hyprlock’ configuration.

KeyDescriptionDefault
barBar characters for cava.▁▂▃▄▅▆▇█
max_instancesMaximum number of cava instances.1
rangeNumber of bars minus one.7
standbyStandby character for cava.🎶
widthWidth of the cava output.20

‘cava.sh stdout’ configuration.

KeyDescriptionDefault
barBar characters for cava.▁▂▃▄▅▆▇█
max_instancesMaximum number of cava instances.1
rangeNumber of bars minus one.7
standbyStandby character for cava.🎶
widthWidth of the cava output.20

‘cava.sh waybar’ configuration.

KeyDescriptionDefault
barBar characters for cava.▁▂▃▄▅▆▇█
max_instancesMaximum number of cava instances.1
rangeNumber of bars minus one.7
standbyStandby character for cava.🎶
widthWidth of the cava output.20

Hypr configuration.

KeyDescriptionDefault
sanitizeList of regex to sanitize in the theme.config.[“.rgba(.,.,.,.*)”]

Hyprland configuration.

KeyDescriptionDefault
background_pathLockScreen’s Background path.
barBar.waybar
browserBrowser.firefox
button_layoutButton layout. (gtk only)
color_schemeColor scheme.prefer-dark
cursor_sizeCursor size.24
cursor_themeCursor theme.Bibata-Modern-Ice
document_font_sizeDocument font size.10
editorEditor.code
explorerFile manager.dolphin
fontFont.Canterell
font_antialiasingFont antialiasing.rgba
font_hintingFont hinting.full
font_sizeFont size.10
gtk_themeGTK theme.Wallbash-Gtk
icon_themeIcon theme.Tela-circle-dracula
idleIdle manager.hypridle
lockscreenLockscreen.lockscreen.sh
monospace_fontMonospace font.CaskaydiaCove Nerd Font Mono
monospace_font_sizeMonospace font size.9
quickappsQuick apps.kitty
terminalTerminal.kitty

Hyprland start configuration.

KeyDescriptionDefault
apptray_bluetoothBluetooth applet.blueman-applet
auth_dialogueAuthentication dialogue.polkitkdeauth.sh
barBar.hyde-shell waybar —watch
battery_notifyBattery notification script.batterynotify.sh
dbus_share_pickerDBus share picker.dbus-update-activation-environment —systemd —all
idle_daemonIdle daemon.hypridle
image_clipboardImage clipboard.wl-paste —type image —watch cliphist store
network_managerNetwork manager.nm-applet —indicator
notificationsNotifications.swaync
removable_mediaRemovable media manager.udiskie —no-automount —smart-tray
systemd_share_pickerSystemd share picker.systemctl —user import-environment QT_QPA_PLATFORMTHEME WAYLAND_DISPLAY XDG_CURRENT_DESKTOP
text_clipboardText clipboard.wl-paste —type text —watch cliphist store
wallpaperWallpaper script.$scrPath/wallpaper.sh —global
xdg_portal_resetXDG portal reset script.resetxdgportal.sh

mediaplayer.py configuration.

KeyDescriptionDefault
artist_track_separatorSeparator symbols to display between artist and track. 
max_lengthMax length of song and artist string.70
prefix_pausedPrefix for paused media. 
prefix_playingPrefix for playing media.
standby_textTo display on standby. Music

Notification script configuration.

KeyDescriptionDefault
fontFont for notifications.mononoki Nerd Font
font_sizeFont size for notifications.10

Global rofi configuration.

KeyDescriptionDefault
scaleRofi default scaling.10

‘animation.sh select’ configuration.

KeyDescriptionDefault
scaleScaling for animation.10

cliphist.sh configuration.

KeyDescriptionDefault
scaleScaling for cliphist.10

emoji-picker.sh configuration.

KeyDescriptionDefault
scaleScaling for emoji picker.10
styleStyle for emoji picker.1

glyph-picker.sh configuration.

KeyDescriptionDefault
scaleScaling for glyph picker.10

‘hyprlock.sh select’ configuration.

KeyDescriptionDefault
scaleScaling for hyprlock.10

rofilaunch.sh configuration.

KeyDescriptionDefault
drun_argsAdditional arguments for drun mode.[]
filebrowser_argsAdditional arguments for filebrowser mode.[]
run_argsAdditional arguments for run mode.[]
scaleScaling for launch.5
window_argsAdditional arguments for window mode.[]

themeselect.sh configuration.

KeyDescriptionDefault
scaleScaling for theme selector.6

swwwallselect.sh configuration.

KeyDescriptionDefault
scaleScaling for wallpaper.10

keybind_hint.sh configuration.

KeyDescriptionDefault
delimiterDelimiter for keybind hints.
heightHeight for keybind hints.40em
lineNumber of lines for keybind hints.16
widthWidth for keybind hints.40em

screenshot.sh configuration.

KeyDescriptionDefault
annotation_post_commandPost command for annotation tool.[""]
annotation_pre_commandPre command for annotation tool.[]
annotation_toolAnnotation tool for screenshots.satty

sysmonlaunch.sh configuration.

KeyDescriptionDefault
commandsFallback command options.[""]
executeDefault command to execute.

volumecontrol.sh configuration.

KeyDescriptionDefault
boostEnable volume boost.false
boost_limitVolume boost limit.120
notifyEnable notifications for volume control.true
stepsNumber of steps to increase/decrease volume.5

wallbash configuration.

KeyDescriptionDefault
skip_templateTemplates to skip when using wallbash.[""]

Wallpaper configuration.

KeyDescriptionDefault
backendWallpaper backend, requires ‘wallpaper..sh’ as handler script in $PATHswww
custom_pathsList of paths to search for wallpapers.[]

swwwallselect.sh configuration.

KeyDescriptionDefault
durationTransition duration.1
framerateTransition framerate.60
transition_defaultTransition type for default wallpaper.grow
transition_nextTransition type for next wallpaper.grow
transition_prevTransition type for previous wallpaper.outer

waybar configuration.

KeyDescriptionDefault
fontFont for waybar.JetBrainsMono Nerd Font
icon_sizeIcon size for waybar.10
scaleTotal scaling for waybar.10

Weather configuration.

KeyDescriptionDefault
forecast_daysNumber of days to show forecast (0-3).3
locationLocation/coordinates string for the weather output.
show_iconShow the weather icon in waybar.true
show_locationShow the location in waybar.true
show_todayShow detailed description of today in tooltip.true
temperature_unitTemperature unit (‘c’ or ‘f’).c
time_formatTime format (‘12h’ or ‘24h’).24h
windspeed_unitWindspeed unit (‘km/h’ or ‘mph’).km/h

wlogout configuration.

KeyDescriptionDefault
styleStyle for wlogout.2