From d9a37e9b056bf9321c50bf92267f06de6c05d4ec Mon Sep 17 00:00:00 2001 From: Emma Nora Theuer Date: Sat, 28 Dec 2024 00:17:26 +0100 Subject: [PATCH] Add Documentation for Wallpaper behavior config option, remove done TODO. --- README.org | 11 ++++++++++- 1 file changed, 10 insertions(+), 1 deletion(-) diff --git a/README.org b/README.org index 6baacbf..e54fee0 100644 --- a/README.org +++ b/README.org @@ -92,6 +92,15 @@ In general, you need to always define 3 variables and you can optionally add thr Loglevel to be used by wallman. Defaults to INFO. Choices MUST be DEBUG, INFO, WARNING, ERROR or CRITICAL. Using any capitalization is valid, all caps is reccomended. Wallman will crash if a value is specified that is not one of the specified ones. + Optional: systray: bool This defaults to "true". This enables support for a systray that has the features to re-set your wallpaper (Mostly useful if feh shits itself or if you want to set the correct wallpaper for a specific time of day after your device was suspended) without rerolling the wallpaper set used, a button to reroll and then re-set the wallpaper, as well as a Quit button. Disable this to save a very tiny amount of memory. ++ Optional: behavior: string + This defaults to ~--bg-fill~. This is also the value that will be used when an invalid configuration option has been set. This supports 6 different modes, each mode has 2 possible keywords, resulting in 12 total valid keywords. + ~--bg~, ~pure~. What happens when feh is used with the ~--bg~ flag. Sets a wallpaper without any scaling. + ~--bg-tile~, ~tile~. Sets the wallpaper only on one monitor, the other ones get filled with black or white. Mostly useful for Xinerama setups with overlapping monitors. Equivalent to ~--bg-tile~ in feh. + ~--bg-center~, ~center~. Sets a wallpaper with the center of the wallpaper centered on the middle of the screen. Crops edges. Equivalent to ~--bg-center~ in feh. + ~--bg-fill~, ~fill~ (Default). Fills the whole screen with the wallpaper and zooms to preserve the original aspect ratio. Equivalent to ~--bg-fill~ in feh. + ~--bg-max~, ~max~. Scales the image to the maximum possible size. Equivalent to ~--bg-max~ in feh. + ~--bg-scale~, ~scale~. Scales the wallpaper to fill the screen, but does not preserve the original aspect ratio. Leads to squishing if aspect ratio of screen and wallpaper don't match. Equivalent to ~--bg-scale~ in feh. + *** changing_times The changing_times dictionary is used to specify the times of the day when your wallpaper is switched. The names of the keys do not matter here, the values must always be strings in the "XX:YY:ZZ" 24 hour time system. use 00:00:00 for midnight. Note that XX should be in the range of 00-23 and YY and ZZ should be in the range of 00-59. @@ -105,6 +114,7 @@ The keys in the dictionary once again do not matter, the names of the keys in ea ** Structuring + Write unittests + Add documentation for developers ++ Add more type annotations! ** Technical Details + Improve Modularity (Partially done) @@ -112,7 +122,6 @@ The keys in the dictionary once again do not matter, the names of the keys in ea + Drop the feh dependecy and set wallpapers using pywlroots or python-xlib ** Features -+ *URGENT*: Add support for changing the wallpaper setting behavior in the config file. *THIS RUINS MY EXPERIENCE OTHERWISE!* + Add support for wallpapers that dynamically change with the time of day (Morning, noon, evening, night or light levels) rather than to times set in the config + Add support for wallpapers that change by the weather + Add support for live wallpapers