mirror of
https://github.com/AvengeMedia/DankMaterialShell.git
synced 2026-01-29 16:02:51 -05:00
Update README
This commit is contained in:
37
PLUGINS/WallpaperWatcherDaemon/README.md
Normal file
37
PLUGINS/WallpaperWatcherDaemon/README.md
Normal file
@@ -0,0 +1,37 @@
|
|||||||
|
# Wallpaper Watcher Daemon
|
||||||
|
|
||||||
|
Run a script whenever your wallpaper changes.
|
||||||
|
|
||||||
|
## What it does
|
||||||
|
|
||||||
|
This daemon monitors wallpaper changes and executes a script you specify. The new wallpaper path gets passed as the first argument to your script.
|
||||||
|
|
||||||
|
## Setup
|
||||||
|
|
||||||
|
1. Enable the plugin in Settings → Plugins
|
||||||
|
2. Configure the script path in the plugin settings
|
||||||
|
3. Make sure your script is executable (`chmod +x /path/to/script.sh`)
|
||||||
|
|
||||||
|
## Example script
|
||||||
|
|
||||||
|
```bash
|
||||||
|
#!/bin/bash
|
||||||
|
echo "New wallpaper: $1"
|
||||||
|
# Do something with the wallpaper path
|
||||||
|
```
|
||||||
|
|
||||||
|
Save this to a file, make it executable, and point the plugin to it.
|
||||||
|
|
||||||
|
## Use cases
|
||||||
|
|
||||||
|
- Generate color schemes from the new wallpaper
|
||||||
|
- Update theme files based on wallpaper colors
|
||||||
|
- Send notifications when wallpaper changes
|
||||||
|
- Sync wallpaper info to other devices
|
||||||
|
- Log wallpaper history
|
||||||
|
|
||||||
|
## Notes
|
||||||
|
|
||||||
|
- Script errors show up as toast notifications
|
||||||
|
- Script output goes to console logs
|
||||||
|
- The daemon runs invisibly in the background
|
||||||
@@ -645,9 +645,14 @@ echo "include dank-theme.conf" >> ~/.config/kitty/kitty.conf
|
|||||||
|
|
||||||
dms features a plugin system - meaning you can create your own widgets and load other user widgets.
|
dms features a plugin system - meaning you can create your own widgets and load other user widgets.
|
||||||
|
|
||||||
More comprehensive details available in the [PLUGINS](PLUGINS/README.md) - and example [Emoji Plugin](PLUGINS/ExampleEmojiPlugin) is available for reference.
|
More comprehensive details available in the [PLUGINS](PLUGINS/README.md) - and examples [Emoji Plugin](PLUGINS/ExampleEmojiPlugin) and [Wallpaper Change Hook](PLUGINS/WallpaperWatcherDaemon) are available for reference.
|
||||||
|
|
||||||
The example plugin can be installed by `cp -R ./PLUGINS/ExampleEmojiPlugin ~/.config/DankMaterialShell/plugins` - then it will appear in dms settings.
|
Install an example plugin by:
|
||||||
|
|
||||||
|
```bash
|
||||||
|
mkdir ~/.config/DankMaterialShell/plugins
|
||||||
|
cp -R ./PLUGINS/ExampleEmojiPlugin ~/.config/DankMaterialShell/plugins
|
||||||
|
```
|
||||||
|
|
||||||
**Only install plugins from TRUSTED sources.** Plugins execute QML and javascript at runtime, plugins from third parties should be reviewed before enabling them in dms.
|
**Only install plugins from TRUSTED sources.** Plugins execute QML and javascript at runtime, plugins from third parties should be reviewed before enabling them in dms.
|
||||||
|
|
||||||
|
|||||||
Reference in New Issue
Block a user