Skip to content

Commit

Permalink
Update README.md
Browse files Browse the repository at this point in the history
  • Loading branch information
ozone10 committed Jun 14, 2022
1 parent 401e7fc commit 1158962
Showing 1 changed file with 33 additions and 14 deletions.
47 changes: 33 additions & 14 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,15 +2,15 @@

[![Build status](https://img.shields.io/github/workflow/status/ozone10/Rainmeter-DarkContextMenu/Build/master?logo=Github)](https://github.com/ozone10/Rainmeter-DarkContextMenu)
[![Build status](https://img.shields.io/appveyor/ci/ozone10/Rainmeter-DarkContextMenu/master?logo=Appveyor)](https://ci.appveyor.com/project/ozone10/rainmeter-darkcontextmenu/branch/master)
[![Codacy Badge](https://img.shields.io/codacy/grade/ab209215919e4b2ca6b87b1a81a83b41?logo=Codacy)](https://www.codacy.com/manual/ozone10/Rainmeter-DarkContextMenu?utm_source=github.com&utm_medium=referral&utm_content=ozone10/Rainmeter-DarkContextMenu&utm_campaign=Badge_Grade)
[![Latest release](https://img.shields.io/github/v/release/ozone10/Rainmeter-DarkContextMenu?include_prereleases)](https://github.com/ozone10/Rainmeter-DarkContextMenu/releases/latest)
[![Total downloads](https://img.shields.io/github/downloads/ozone10/Rainmeter-DarkContextMenu/total.svg)](https://github.com/ozone10/Rainmeter-DarkContextMenu/releases)
[![Licence](https://img.shields.io/github/license/ozone10/Rainmeter-DarkContextMenu?color=9cf)](https://www.gnu.org/licenses/gpl-3.0.en.html)

[Rainmeter](https://www.rainmeter.net) plugin that allows to use Windows 10 dark theme for every context menu in Rainmeter (not only skins but also Rainmeter program itself) and on skin tooltips.

Minimal requirements are Windows 10 build 10.0.17763, 1809 (October 2018 update), and enabled dark theme for apps.
Since Windows 10 build 10.0.18362, 1903 (May 2019 update) it is possible to use dark theme ignoring system wide theme for apps.
Since Windows 10 build 10.0.18362, 1903 (May 2019 update) it is possible to use dark theme ignoring system wide theme for apps.
Windows 11 build 22000, first stable build allow to apply dark mode on skin, this can affect Window 11 transparency style. Windows 11 transparency (e.g. Mica) need to be enabled elsewhere (e.g. plugin [TranslucentRM](https://github.com/ozone10/Rainmeter-TranslucentRM))

For more information, check the [Rainmeter forum](https://forum.rainmeter.net/viewtopic.php?f=128&t=33028).

Expand All @@ -28,26 +28,33 @@ Check my other Rainmeter plugin [TranslucentRM](https://github.com/ozone10/Rainm

## Options

- **DarkMode** - Option to choose theme.
- **DarkMode** - Option to choose theme.

- Value **0** - light theme, default value.
- Value **1** - dark theme.
- Value **0** - light theme, default value.
- Value **1** - dark theme.

- **Force** - Option to force theme.
- **Force** - Option to force theme.
Require at least Windows 10 build 10.0.18362, 1903 (May 2019 update).

- Value **0** - rely on system wide theme for apps, default value.
- Value **1** - force to use selected theme.
- Value **0** - rely on system wide theme for apps, default value.
- Value **1** - force to use selected theme.

- **Tooltips** - Option to use theme on skin tooltips.
- Value **0** - use theme on every Rainmeter context menu, default value.
- Value **1** - use theme on skin tooltips, will ignore `Force` option.
- **Tooltips** - Option to use theme on skin tooltips.
- Value **0** - use theme on every Rainmeter context menu, default value.
- Value **1** - use theme on skin tooltips, will ignore `Force` option.

- **Win11DM** - Option to enable Windows 11 style dark mode support on skin.
Require at least Windows 11 build 22000, first stable build.
Currently only affect Windows 11 transparency style (Mica).

- Value **0** - don't use Windows 11 style dark mode, default value.
- Value **1** - allow to use Windows 11 style dark mode on current skin, will depend on `DarkMode` option.

* * *

## Examples

- **Example 1:**
- **Example 1:**
Always use dark theme.

```ini
Expand All @@ -58,7 +65,7 @@ DarkMode=1
Force=1
```

- **Example 2:**
- **Example 2:**
Use theme based on system wide theme for apps.
Need to restart Rainmeter, if system wide theme for apps is changed.

Expand All @@ -70,7 +77,7 @@ DarkMode=1
Force=0
```

- **Example 3:**
- **Example 3:**
Use dark theme on current skin tooltips.

```ini
Expand All @@ -80,3 +87,15 @@ Plugin=DarkContextMenu
DarkMode=1
Tooltips=1
```

- **Example 4:**
Use dark theme on current skin tooltips and allow to use Windows 11 style dark mode on current skin.

```ini
[DarkTooltips]
Measure=Plugin
Plugin=DarkContextMenu
DarkMode=1
Tooltips=1
Win11DM=1
```

0 comments on commit 1158962

Please sign in to comment.