Uyanide/WallReel
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases 7 Wiki Activity

🐛 fix: remove unused config 'printPreview'

Browse Source
This commit is contained in:
Uyanide
2026-04-03 08:50:28 +02:00
parent 0524f26f97
commit 5db3650184
7 changed files with 68 additions and 88 deletions
Download Patch File Download Diff File Expand all files Collapse all files
README.md
-1
View File
@@ -117,7 +117,6 @@ Configures system commands to execute on specific events mapping to your window
| :-------------------- | :--------------- | :------ | :------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| `previewDebounceTime` | Integer | `300` | Debounce time (ms) for triggering the preview action. |
| `printSelected` | Boolean | `true` | Print selected wallpaper path to stdout on confirm. |
| `printPreview` | Boolean | `false` | Print previewed wallpaper path to stdout on preview. |
| `onSelected` | String | `""` | Command to execute when a wallpaper is confirmed. |
| `onPreview` | String | `""` | Command to execute when a wallpaper is previewed. |
| `saveState` | Array of Objects | `[]` | Commands to fetch system states before changing wallpapers. Each object defines: `key`, `fallback` (fallback value), `command` (stdout mapping), and `timeout` (ms). |
WallReel/Assets/man/man.1
+9 -9
View File
@@ -1,4 +1,4 @@
.\" Automatically generated by Pandoc 3.5
.\" Automatically generated by Pandoc 3.9.0.2
.\"
.TH "WALLREEL" "1" "2026\-03\-24" "WallReel 2.0.2" "User Commands"
.SH NAME
@@ -42,20 +42,20 @@ In this mode, the configuration is still parsed.
Action placeholders are resolved from the selected image and any
captured state values.
.SH BEHAVIOR NOTES
.IP \[bu] 2
.IP \(bu 2
CLI options are generally optional; configuration is the preferred
customization path.
.IP \[bu] 2
.IP \(bu 2
Some options are mutually exclusive (for example \f[CR]\-\-verbose\f[R]
and \f[CR]\-\-quiet\f[R]).
.IP \[bu] 2
.IP \(bu 2
With \f[CR]\-\-apply\f[R], WallReel executes configured selection
actions without opening the UI.
.SH FILES
\f[CR]\[ti]/.config/wallreel/config.json\f[R] : Default configuration
\f[CR]\(ti/.config/wallreel/config.json\f[R] : Default configuration
file location.
.PP
\f[CR]\[ti]/.cache/wallreel/\f[R] : Runtime cache location.
\f[CR]\(ti/.cache/wallreel/\f[R] : Runtime cache location.
.SH EXAMPLES
Run with default configuration:
.IP
@@ -66,19 +66,19 @@ wallreel
Use a custom configuration file:
.IP
.EX
wallreel \-\-config\-file \[ti]/.config/wallreel/config.json
wallreel \-\-config\-file \(ti/.config/wallreel/config.json
.EE
.PP
Append additional search directories:
.IP
.EX
wallreel \-\-append\-dir \[ti]/Pictures/Wallpapers \-\-append\-dir \[ti]/Art
wallreel \-\-append\-dir \(ti/Pictures/Wallpapers \-\-append\-dir \(ti/Art
.EE
.PP
Apply a wallpaper and exit:
.IP
.EX
wallreel \-\-apply \[ti]/Pictures/wallpaper.jpg
wallreel \-\-apply \(ti/Pictures/wallpaper.jpg
.EE
.SH EXIT STATUS
Returns \f[CR]0\f[R] on success.
WallReel/Assets/man/man.5
+59 -62
View File
@@ -1,22 +1,22 @@
.\" Automatically generated by Pandoc 3.5
.\" Automatically generated by Pandoc 3.9.0.2
.\"
.TH "WALLREEL" "5" "2026\-03\-24" "WallReel 2.0.2" "File Formats Manual"
.SH NAME
wallreel\-config \- configuration format for wallreel
.SH SYNOPSIS
\f[CR]\[ti]/.config/wallreel/config.json\f[R]
\f[CR]\(ti/.config/wallreel/config.json\f[R]
.SH DESCRIPTION
WallReel reads configuration from a JSON document.
The root object is divided into five sections:
.IP \[bu] 2
.IP \(bu 2
\f[CR]wallpaper\f[R]
.IP \[bu] 2
.IP \(bu 2
\f[CR]theme\f[R]
.IP \[bu] 2
.IP \(bu 2
\f[CR]action\f[R]
.IP \[bu] 2
.IP \(bu 2
\f[CR]style\f[R]
.IP \[bu] 2
.IP \(bu 2
\f[CR]cache\f[R]
.PP
For complete machine\-readable validation details, refer to
@@ -25,7 +25,7 @@ For complete machine\-readable validation details, refer to
Defines where WallReel looks for images and what to exclude.
.PP
If both \f[CR]paths\f[R] and \f[CR]dirs\f[R] are empty or omitted,
WallReel defaults to recursively scanning the user\[aq]s Pictures
WallReel defaults to recursively scanning the user\(aqs Pictures
directory and treating all supported image files as wallpaper
candidates.
.PP
@@ -36,9 +36,9 @@ to specific image files.
to scan for images.
.PP
Each item has:
.IP \[bu] 2
.IP \(bu 2
\f[CR]path\f[R] (string)
.IP \[bu] 2
.IP \(bu 2
\f[CR]recursive\f[R] (boolean)
.PP
\f[CR]excludes\f[R] (array of string, default: \f[CR][]\f[R]) : Exclude
@@ -54,16 +54,16 @@ the primary color.
palette definitions.
.PP
Each palette has:
.IP \[bu] 2
.IP \(bu 2
\f[CR]name\f[R] (string)
.IP \[bu] 2
.IP \(bu 2
\f[CR]colors\f[R] (array)
.PP
Each color item has:
.IP \[bu] 2
.IP \(bu 2
\f[CR]name\f[R] (string)
.IP \[bu] 2
\f[CR]value\f[R] (hex string, for example \f[CR]\[dq]#89b4fa\[dq]\f[R])
.IP \(bu 2
\f[CR]value\f[R] (hex string, for example \f[CR]\(dq#89b4fa\(dq\f[R])
.SH ACTION SECTION
Configures commands executed for preview, selection, and restore
behavior.
@@ -74,29 +74,26 @@ Debounce interval in milliseconds for preview actions.
\f[CR]printSelected\f[R] (boolean, default: \f[CR]true\f[R]) : Print
selected wallpaper path to stdout on confirmation.
.PP
\f[CR]printPreview\f[R] (boolean, default: \f[CR]false\f[R]) : Print
previewed wallpaper path to stdout on preview.
.PP
\f[CR]onSelected\f[R] (string, default: \f[CR]\[dq]\[dq]\f[R]) : Command
\f[CR]onSelected\f[R] (string, default: \f[CR]\(dq\(dq\f[R]) : Command
executed when a wallpaper is confirmed.
.PP
\f[CR]onPreview\f[R] (string, default: \f[CR]\[dq]\[dq]\f[R]) : Command
\f[CR]onPreview\f[R] (string, default: \f[CR]\(dq\(dq\f[R]) : Command
executed when a wallpaper is previewed.
.PP
\f[CR]saveState\f[R] (array of object, default: \f[CR][]\f[R]) :
Commands for capturing system values before changing wallpaper.
.PP
Each item has:
.IP \[bu] 2
.IP \(bu 2
\f[CR]key\f[R] (placeholder key)
.IP \[bu] 2
.IP \(bu 2
\f[CR]fallback\f[R] (default value)
.IP \[bu] 2
.IP \(bu 2
\f[CR]command\f[R] (stdout\-mapped command)
.IP \[bu] 2
.IP \(bu 2
\f[CR]timeout\f[R] (milliseconds)
.PP
\f[CR]onRestore\f[R] (string, default: \f[CR]\[dq]\[dq]\f[R]) : Command
\f[CR]onRestore\f[R] (string, default: \f[CR]\(dq\(dq\f[R]) : Command
executed on restore.
Saved state keys are usable as placeholders.
.PP
@@ -117,13 +114,13 @@ The following placeholders are available in \f[CR]onSelected\f[R],
wallpaper.
.PP
\f[CR]{{ palette }}\f[R] : Selected palette name
(\f[CR]\[dq]null\[dq]\f[R] if none).
(\f[CR]\(dqnull\(dq\f[R] if none).
.PP
\f[CR]{{ colorName }}\f[R] : Chosen primary color name
(\f[CR]\[dq]null\[dq]\f[R] if none).
(\f[CR]\(dqnull\(dq\f[R] if none).
.PP
\f[CR]{{ colorHex }}\f[R] : Chosen primary color hex
(\f[CR]\[dq]null\[dq]\f[R] if none).
(\f[CR]\(dqnull\(dq\f[R] if none).
.PP
\f[CR]{{ domColorHex }}\f[R] : Dominant color hex extracted from the
wallpaper.
@@ -162,54 +159,54 @@ Older entries are evicted.
.IP
.EX
{
\[dq]$schema\[dq]: \[dq]https://raw.githubusercontent.com/Uyanide/WallReel/refs/heads/master/config.schema.json\[dq],
\[dq]wallpaper\[dq]: {
\[dq]paths\[dq]: [\[dq]/home/user/Pictures/favorite.jpg\[dq]],
\[dq]dirs\[dq]: [
\(dq$schema\(dq: \(dqhttps://raw.githubusercontent.com/Uyanide/WallReel/refs/heads/master/config.schema.json\(dq,
\(dqwallpaper\(dq: {
\(dqpaths\(dq: [\(dq/home/user/Pictures/favorite.jpg\(dq],
\(dqdirs\(dq: [
{
\[dq]path\[dq]: \[dq]/home/user/Pictures/Wallpapers\[dq],
\[dq]recursive\[dq]: \f[B]true\f[R]
\(dqpath\(dq: \(dq/home/user/Pictures/Wallpapers\(dq,
\(dqrecursive\(dq: \f[B]true\f[R]
}
],
\[dq]excludes\[dq]: [\[dq]\[rs]\[rs].gif$\[dq]]
\(dqexcludes\(dq: [\(dq\(rs\(rs.gif$\(dq]
},
\[dq]theme\[dq]: {
\[dq]palettes\[dq]: [
\(dqtheme\(dq: {
\(dqpalettes\(dq: [
{
\[dq]name\[dq]: \[dq]Dark\[dq],
\[dq]colors\[dq]: [
{ \[dq]name\[dq]: \[dq]blue\[dq], \[dq]value\[dq]: \[dq]#89b4fa\[dq] },
{ \[dq]name\[dq]: \[dq]red\[dq], \[dq]value\[dq]: \[dq]#f38ba8\[dq] }
\(dqname\(dq: \(dqDark\(dq,
\(dqcolors\(dq: [
{ \(dqname\(dq: \(dqblue\(dq, \(dqvalue\(dq: \(dq#89b4fa\(dq },
{ \(dqname\(dq: \(dqred\(dq, \(dqvalue\(dq: \(dq#f38ba8\(dq }
]
}
]
},
\[dq]action\[dq]: {
\[dq]previewDebounceTime\[dq]: 500,
\[dq]quitOnSelected\[dq]: \f[B]true\f[R],
\[dq]onPreview\[dq]: \[dq]swww img {{ path }}\[dq],
\[dq]onSelected\[dq]: \[dq]cp {{ path }} \[ti]/.config/wallpaper/current/ && swww img {{ path }}\[dq],
\[dq]saveState\[dq]: [
\(dqaction\(dq: {
\(dqpreviewDebounceTime\(dq: 500,
\(dqquitOnSelected\(dq: \f[B]true\f[R],
\(dqonPreview\(dq: \(dqswww img {{ path }}\(dq,
\(dqonSelected\(dq: \(dqcp {{ path }} \(ti/.config/wallpaper/current/ && swww img {{ path }}\(dq,
\(dqsaveState\(dq: [
{
\[dq]key\[dq]: \[dq]current_wp\[dq],
\[dq]fallback\[dq]: \[dq]/home/user/Pictures/default.jpg\[dq],
\[dq]command\[dq]: \[dq]find \[ti]/.config/wallpaper/current \-type f | head \-n 1\[dq],
\[dq]timeout\[dq]: 1000
\(dqkey\(dq: \(dqcurrent_wp\(dq,
\(dqfallback\(dq: \(dq/home/user/Pictures/default.jpg\(dq,
\(dqcommand\(dq: \(dqfind \(ti/.config/wallpaper/current \-type f | head \-n 1\(dq,
\(dqtimeout\(dq: 1000
}
],
\[dq]onRestore\[dq]: \[dq]swww img {{ current_wp }}\[dq]
\(dqonRestore\(dq: \(dqswww img {{ current_wp }}\(dq
},
\[dq]style\[dq]: {
\[dq]image_width\[dq]: 640,
\[dq]image_height\[dq]: 400,
\[dq]image_focus_scale\[dq]: 1.2,
\[dq]window_width\[dq]: 1280,
\[dq]window_height\[dq]: 720
\(dqstyle\(dq: {
\(dqimage_width\(dq: 640,
\(dqimage_height\(dq: 400,
\(dqimage_focus_scale\(dq: 1.2,
\(dqwindow_width\(dq: 1280,
\(dqwindow_height\(dq: 720
},
\[dq]cache\[dq]: {
\[dq]saveSortMethod\[dq]: \f[B]true\f[R],
\[dq]savePalette\[dq]: \f[B]true\f[R],
\[dq]maxImageEntries\[dq]: 300
\(dqcache\(dq: {
\(dqsaveSortMethod\(dq: \f[B]true\f[R],
\(dqsavePalette\(dq: \f[B]true\f[R],
\(dqmaxImageEntries\(dq: 300
}
}
.EE
WallReel/Core/Config/data.hpp
-2
View File
@@ -27,7 +27,6 @@
//
// action.previewDebounceTime number 300 Debounce time for preview action in milliseconds
// action.printSelected boolean true Whether to print the selected wallpaper path to stdout on confirm
// action.printPreview boolean false Whether to print the previewed wallpaper path to stdout on preview
// action.onSelected string "" Command to execute on confirmation
// action.onPreview string "" Command to execute on preview
// action.saveState array [] Useful for restore command
@@ -126,7 +125,6 @@ struct ActionConfigItems {
QString onRestore;
int previewDebounceTime = 300; // milliseconds
bool printSelected = true;
bool printPreview = false;
bool quitOnSelected = false;
bool restoreOnClose = true;
};
WallReel/Core/Config/manager.cpp
-6
View File
@@ -203,12 +203,6 @@ void Manager::_loadActionConfig(const QJsonObject& root) {
m_actionConfig.printSelected = val.toBool();
}
}
if (config.contains("printPreview")) {
const auto& val = config["printPreview"];
if (val.isBool()) {
m_actionConfig.printPreview = val.toBool();
}
}
if (config.contains("saveState") && config["saveState"].isArray()) {
const QJsonArray& arr = config["saveState"].toArray();
for (const auto& item : arr) {
config.schema.json
-5
View File
@@ -96,11 +96,6 @@
"default": true,
"description": "Whether to print the selected wallpaper path to stdout on confirm"
},
"printPreview": {
"type": "boolean",
"default": false,
"description": "Whether to print the previewed wallpaper path to stdout on preview"
},
"onSelected": {
"type": "string",
"default": "",
docs/man/man.5.md
-3
View File
@@ -79,9 +79,6 @@ Configures commands executed for preview, selection, and restore behavior.
`printSelected` (boolean, default: `true`)
: Print selected wallpaper path to stdout on confirmation.
`printPreview` (boolean, default: `false`)
: Print previewed wallpaper path to stdout on preview.
`onSelected` (string, default: `""`)
: Command executed when a wallpaper is confirmed.