update README

This commit is contained in:
remek 2026-03-23 22:52:57 +01:00 committed by GitHub
parent 0ad8ae7603
commit c8b66a9e97
No known key found for this signature in database
GPG key ID: B5690EEEBB952194

View file

@ -10,14 +10,14 @@ by adding animated or static backgrounds to your notes.
## Features
### General
- **Configurations** two types of settings are available:
- **Configurations:** two types of settings are available:
- *Global configuration* applies to all wallpapers
- *Individual configuration* applies to each wallpaper separately
- **Reposition** adjusts the size and placement of your background
- **Visual Effects** adjust opacity, blur, brightness, contrast, etc
- **Visual Effects** adjust opacity, blur, brightness, contrast, etc.
- **Wallpaper History** lets you easily switch back to previously used wallpapers
- **Full-Resolution Wallpapers** use images in their original size without downscaling
- **Reset Options** reset all settings to default for the current or global configuration (all settings in the General section)
> **Important:** In this version, the old `wallpaper` folder has been replaced with a new `wallpapers` folder.
> Any unused files in the old folder **may have been automatically removed** during the migration process.
@ -33,10 +33,14 @@ by adding animated or static backgrounds to your notes.
- **Weekly Mode**
Assign a different wallpaper for each day of the week.
Wallpapers are automatically changed based on the current weekday.
- **Auto-Rotate Mode**
Automatically cycles through wallpapers at a configurable time interval.
---
## Transparency settings
## Transparency Settings
*Advanced customization may require CSS knowledge.*
- **Advanced Transparency**
@ -46,18 +50,18 @@ by adding animated or static backgrounds to your notes.
- `--background-primary`
- `--col-bckg-mainpanels`
- **Custom Background Color**
- Pick any color to use in the plugins styling logic
> **Note:** The built-in CSS editor has been removed in recent versions of the plugin to prevent accidental overwriting of user styles during updates. For full control, please use the snippet method described above.
- Pick a color used for blur effects
- Adjust blur intensity and dim opacity with sliders
- **Modal Background Effects**
Customize how modals look.
- Choose from blur, dim, or combined effects
- Adjust blur intensity and dim opacity with sliders
> **Note:** The built-in CSS editor has been removed in recent versions of the plugin to prevent accidental overwriting of user styles during updates. For full control, please use the snippet method described above.
---
### Optional: UI-based CSS customization
## Optional: UI-based CSS Customization
If you're looking for a graphical interface to tweak theme/plugin variables, try these community plugins:
@ -66,12 +70,19 @@ If you're looking for a graphical interface to tweak theme/plugin variables, try
> **Tip:** You may need to use developer tools (Ctrl + Shift + I) to inspect selectors and variables in your theme.
---
## Screenshots
![](https://github.com/remememe/Live-Wallpaper/blob/main/Assets/sc4.png)
![](https://github.com/remememe/Live-Wallpaper/blob/main/Assets/sc2.png)
![](https://github.com/remememe/Live-Wallpaper/blob/main/Assets/sc1.gif)
![](https://github.com/remememe/Live-Wallpaper/blob/main/Assets/sc3.png)
---
## Installation
## From Git
1. Download the latest release from the Releases page.
2. Copy the files `main.js`, `manifest.json`, and `styles.css` to the following directory:
@ -82,18 +93,13 @@ If you're looking for a graphical interface to tweak theme/plugin variables, try
## From within Obsidian
You can also install the plugin directly through the Community Plugins section in Obsidian.
![](https://github.com/remememe/Live-Wallpaper/blob/main/Assets/sc4.png)
![](https://github.com/remememe/Live-Wallpaper/blob/main/Assets/sc2.png)
![](https://github.com/remememe/Live-Wallpaper/blob/main/Assets/sc1.gif)
![](https://github.com/remememe/Live-Wallpaper/blob/main/Assets/sc3.png)
**Dark Theme Recommended**
*Requires version 1.1.0+ and works on both desktop (Windows/macOS/Linux) and mobile*
> **Note:** The plugin now supports mobile devices in addition to desktop platforms.
## Contribution
Contributions are welcome! If you'd like to help improve the plugin whether by fixing bugs, adding new features, or optimizing performance feel free to:
@ -110,4 +116,4 @@ npm install
npm run build
```
Your contributions are greatly appreciated!!
Your contributions are greatly appreciated!!