Skip to content

Your language is missing?

Help us translate this documentation!

See how to contribute translations →

Main Configuration


Currently, HyDE exposes ~/.local/share/hyde/schema/config.toml file for users to modify. This lets users have the ability to interact with 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.

Key Description Default
dock Dock status for battery notifications. true
interval Interval for battery notifications. 5
notify Notification threshold. 1140
timer Timer for battery notifications. 120

Commands to execute for battery notifications.

Key Description Default
charging Command to execute when charging.
critical Command to execute when battery is critical. systemctl suspend
discharging Command to execute when discharging.
low Command to execute when battery is low.
unplug Command to execute when unplugged.

Thresholds for battery notifications.

Key Description Default
critical Critical battery threshold. 10
full Full battery threshold. 90
low Low battery threshold. 20
unplug Unplug battery threshold. 100

brightnesscontrol.sh configuration.

Key Description Default
notify Enable notifications for brightness control. true
steps Number of steps to increase/decrease brightness. 5

Cava visualizer configuration.

Key Description Default
channels Audio channels: stereo or mono. stereo
range Bar sensitivity 8
reverse Reverse spectrum movement (0 or 1). 1

‘cava.sh hyprlock’ configuration.

Key Description Default
bar Bar characters for cava. ▁▂▃▄▅▆▇█
bar_array Bar array for hyprlock preset. [“▁”, “▂”, “▃”, “▄”, “▅”, “▆”, “▇”, “█”]
range Number of bars minus one. 7
standby Standby character for cava. 🎶
width Width of the cava output. 20

‘cava.sh stdout’ configuration.

Key Description Default
bar Bar characters for cava. ▁▂▃▄▅▆▇█
bar_array Bar array for stdout preset. [“░”, “▒”, “▓”, “█”]
range Number of bars minus one. 7
standby Standby character for cava. 🎶
width Width of the cava output. 20

‘cava.sh waybar’ configuration.

Key Description Default
bar Bar characters for cava. ▁▂▃▄▅▆▇█
bar_array Bar array for waybar preset. [“◜”, “◝”, “◞”, “◟”, “◠”, “◡”, “◢”, “◣”]
range Number of bars minus one. 7
standby Standby character for cava. 🎶
width Width of the cava output. 20

Hyprland configuration.

Key Description Default
background_path LockScreen’s Background path.
bar Bar. waybar
browser Browser. firefox
button_layout Button layout. (gtk only)
color_scheme Color scheme. prefer-dark
cursor_size Cursor size. 24
cursor_theme Cursor theme. Bibata-Modern-Ice
document_font_size Document font size. 10
editor Editor. code
explorer File manager. dolphin
font Font. Canterell
font_antialiasing Font antialiasing. rgba
font_hinting Font hinting. full
font_size Font size. 10
gtk_theme GTK theme. Wallbash-Gtk
icon_theme Icon theme. Tela-circle-dracula
idle Idle manager. hypridle
lockscreen Lockscreen. lockscreen.sh
monospace_font Monospace font. CaskaydiaCove Nerd Font Mono
monospace_font_size Monospace font size. 9
quickapps Quick apps. kitty
terminal Terminal. kitty

Hyprland start configuration.

Key Description Default
apptray_bluetooth Bluetooth applet. blueman-applet
auth_dialogue Authentication dialogue. polkitkdeauth.sh
bar Bar. hyde-shell waybar –watch
battery_notify Battery notification script. batterynotify.sh
dbus_share_picker DBus share picker. dbus-update-activation-environment –systemd –all
idle_daemon Idle daemon. hypridle
image_clipboard Image clipboard. wl-paste –type image –watch cliphist store
network_manager Network manager. nm-applet –indicator
notifications Notifications. swaync
removable_media Removable media manager. udiskie –no-automount –smart-tray
systemd_share_picker Systemd share picker. systemctl –user import-environment QT_QPA_PLATFORMTHEME WAYLAND_DISPLAY XDG_CURRENT_DESKTOP
text_clipboard Text clipboard. wl-paste –type text –watch cliphist store
wallpaper Wallpaper script. $scrPath/wallpaper.sh –global
xdg_portal_reset XDG portal reset script. resetxdgportal.sh

mediaplayer.py configuration.

Key Description Default
artist_track_separator Separator symbols to display between artist and track.  
max_length Max length of song and artist string. 70
prefix_paused Prefix for paused media.  
prefix_playing Prefix for playing media.
standby_text To display on standby.  Music

Notification script configuration.

Key Description Default
font Font for notifications. mononoki Nerd Font
font_size Font size for notifications. 10

Global rofi configuration.

Key Description Default
scale Rofi default scaling. 10

‘animation.sh select’ configuration.

Key Description Default
scale Scaling for animation. 10

hyde-shell rofi.bookmarks.sh configuration.

Key Description Default
args Additional arguments for bookmarks. []
font Font for bookmarks. JetBrainsMono Nerd Font
scale Scaling for bookmarks. 10
style Style for rofi bookmarks.

cliphist.sh configuration.

Key Description Default
scale Scaling for cliphist. 10

emoji-picker.sh configuration.

Key Description Default
args Additional arguments for emoji picker. [“-multi-select”]
scale Scaling for emoji picker. 10
style Style for emoji picker. 1

glyph-picker.sh configuration.

Key Description Default
args Additional arguments for glyph picker. [“-multi-select”]
scale Scaling for glyph picker. 10

‘hyprlock.sh select’ configuration.

Key Description Default
scale Scaling for hyprlock. 10

rofilaunch.sh configuration.

Key Description Default
drun_args Additional arguments for drun mode. []
drun_style Style for drun mode. style_1
filebrowser_args Additional arguments for filebrowser mode. []
filebrowser_style Style for filebrowser mode. style_1
run_args Additional arguments for run mode. []
run_style Style for run mode. style_1
scale Scaling for launch. 5
window_args Additional arguments for window mode. []
window_style Style for window mode. style_1

themeselect.sh configuration.

Key Description Default
scale Scaling for theme selector. 6

swwwallselect.sh configuration.

Key Description Default
scale Scaling for wallpaper. 10

hyde-shell rofi.websearch.sh configuration.

Key Description Default
args Additional arguments for websearch. []
font Font for websearch. JetBrainsMono Nerd Font
scale Scaling for websearch. 10
style Style for rofi websearch.

keybind_hint.sh configuration.

Key Description Default
delimiter Delimiter for keybind hints.
height Height for keybind hints. 40em
line Number of lines for keybind hints. 16
width Width for keybind hints. 40em

screenshot.sh configuration.

Key Description Default
annotation_post_command Post command for annotation tool. [“”]
annotation_pre_command Pre command for annotation tool. []
annotation_tool Annotation tool for screenshots. satty

OCR configuration.

Key Description Default
tesseract_languages Place desired languages to use for text recognition. To see installed languages run tesseract --list-langs. [“eng”]

sysmonlaunch.sh configuration.

Key Description Default
commands Fallback command options. [“”]
execute Default command to execute.

volumecontrol.sh configuration.

Key Description Default
boost Enable volume boost. false
boost_limit Volume boost limit. 120
notify Enable notifications for volume control. true
steps Number of steps to increase/decrease volume. 5

wallbash configuration.

Key Description Default
skip_template Templates to skip when using wallbash. [“”]

Wallpaper configuration.

Key Description Default
backend Wallpaper backend, requires ‘wallpaper..sh’ as handler script in $PATH swww
custom_paths List of paths to search for wallpapers. []

swwwallselect.sh configuration.

Key Description Default
duration Transition duration. 1
framerate Transition framerate. 60
transition_default Transition type for default wallpaper. grow
transition_next Transition type for next wallpaper. grow
transition_prev Transition type for previous wallpaper. outer

waybar configuration.

Key Description Default
font Font for waybar. JetBrainsMono Nerd Font
icon_size Icon size for waybar. 10
position A fallback position of the waybar. top
scale Total scaling for waybar. 10

Weather configuration.

Key Description Default
forecast_days Number of days to show forecast (0-3). 3
location Location/coordinates string for the weather output.
show_icon Show the weather icon in waybar. true
show_location Show the location in waybar. true
show_today Show detailed description of today in tooltip. true
temperature_unit Temperature unit (‘c’ or ‘f’). c
time_format Time format (‘12h’ or ‘24h’). 24h
windspeed_unit Windspeed unit (‘km/h’ or ‘mph’). km/h

wlogout configuration.

Key Description Default
style Style for wlogout. 2