emma/Wallman
emma/Wallman
1
0
Fork 0
Code Issues Pull requests Projects Releases 2 Packages Wiki Activity

Adjusted naming for clarity

Browse source
This commit is contained in:
Emma Nora Theuer 2024-05-28 22:53:20 +02:00
parent 50d42ec789
commit 3a0ea09abf
3 changed files with 4 additions and 4 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

2
README.org
View file

@ -42,7 +42,7 @@ This is a short guide on how to correctly configure wallman. Look in the sample
First of all, the config file is structured via different TOML dictionaries. There are two TOML dictionaries: general and changing_times that must be present in every config. Aside from that, further dictionaries are needed depending on how wallman is configured. You need to create a dictionary with the name of each wallpaper set defined in the used_sets list (more on that later). You should probably just configure wallman by editing the sample config as it is by far the easiest way to do it. First of all, the config file is structured via different TOML dictionaries. There are two TOML dictionaries: general and changing_times that must be present in every config. Aside from that, further dictionaries are needed depending on how wallman is configured. You need to create a dictionary with the name of each wallpaper set defined in the used_sets list (more on that later). You should probably just configure wallman by editing the sample config as it is by far the easiest way to do it.
*** general *** general
In general, you need to always define 3 variables and you can optionally add one more: In general, you need to always define 3 variables and you can optionally add one more:
+ enabled: bool + enable_wallpaper_sets: bool
A simple switch that states if you want to use different sets of wallpapers or not. A simple switch that states if you want to use different sets of wallpapers or not.
+ used_sets: list + used_sets: list
A list that includes the names of the wallpaper sets you want to use. If you want to use only one, the list should have one entry. A list that includes the names of the wallpaper sets you want to use. If you want to use only one, the list should have one entry.

4
sample_config.toml
View file

@ -1,10 +1,10 @@
# Here, define if you want to use different sets of wallpapers, and if yes, # Here, define if you want to use different sets of wallpapers, and if yes,
# what those sets are called and how many wallpapers are included per set. # what those sets are called and how many wallpapers are included per set.
[general] [general]
enabled = true enable_wallpaper_sets = true
used_sets = ["anime", "nature"] used_sets = ["anime", "nature"]
wallpapers_per_set = 5 wallpapers_per_set = 5
notify = false notify = False
# Enter the hours at which you want the wallpaper to change. # Enter the hours at which you want the wallpaper to change.
# If the script is called between one of this times, it will go back to the previous time. # If the script is called between one of this times, it will go back to the previous time.

2
wallman_lib.py
View file

@ -33,7 +33,7 @@ class _ConfigLib:
self.config_general: dict = self.config_file["general"] self.config_general: dict = self.config_file["general"]
self.config_changing_times: dict = self.config_file["changing_times"] self.config_changing_times: dict = self.config_file["changing_times"]
# Values in Dicts # Values in Dicts
self.config_wallpaper_sets_enabled: bool = self.config_general["enabled"] self.config_wallpaper_sets_enabled: bool = self.config_general["enable_wallpaper_sets"]
self.config_used_sets: list = self.config_general["used_sets"] self.config_used_sets: list = self.config_general["used_sets"]
self.config_wallpapers_per_set: int = self.config_general["wallpapers_per_set"] self.config_wallpapers_per_set: int = self.config_general["wallpapers_per_set"]
self.config_total_changing_times: int = len(self.config_changing_times) self.config_total_changing_times: int = len(self.config_changing_times)