-
Notifications
You must be signed in to change notification settings - Fork 0
2. Setup & FAQ
Refer to Installation and Extension for instructions on installing WallRizz and obtaining the required extensions.
- If you are using the Kitty terminal, launch it with remote control enabled
(kitty -o allow_remote_control=yes)
, as this is necessary for fullscreen image previews and terminal auto-scaling to fit all images. - For other terminals, the UI is limited to list view, and timg is required to display images.
- Run the command:
WallRizz -d [path to your wallpaper directory]
- WallRizz will scan the wallpapers, extract colors, generate, and cache application themes using theme extensions. This process occurs only during the first execution, when a new wallpaper is added to the wallpaper directory, or when any theme extension script has been modified.
- WallRizz will then display the wallpapers in a grid (by default) within the terminal, allowing you to select a wallpaper.
- The selected wallpaper will be applied along with the corresponding application themes.
Refer to Usage for more information on additional features and usage instructions.
No, WallRizz is a self-contained binary, written in QuickJS. It doesn't require any external runtime to function.
Yes, you can specify a custom color extraction command using the -c
argument.
Example:
WallRizz -c "magick {} -colors 16 -unique-colors txt:-"
WallRizz -c "sh -c 'matugen image {} -j hex | jq -r .colors.dark[],.colors.light[]'"
Note: To ensure the new command takes effect, delete the ~/.cache/WallRizz/colours.json
file.
Yes, you can disable the wallpaper setting functionality by adding a return
statement within the setWallpaper
function in your wallpaper handler script located at ~/.config/WallRizz/
.
Example:
Create a script named temp.js
at ~/.config/WallRizz/
with the following content:
export function setWallpaper() {
return;
}
Yes, you can remove all theme extension scripts from the ~/.config/WallRizz/themeExtensionScripts
directory.