Skip to content

Commit

Permalink
Merge pull request #54 from Drgabi18/for-completeness-sake
Browse files Browse the repository at this point in the history
A few additions and changes
  • Loading branch information
jsmorley authored Mar 19, 2024
2 parents 21a4f0c + 4d9b9bd commit 348645b
Show file tree
Hide file tree
Showing 17 changed files with 309 additions and 27 deletions.
4 changes: 2 additions & 2 deletions source/developers/index.html
Original file line number Diff line number Diff line change
Expand Up @@ -82,8 +82,8 @@ <h2 id="APIDocumentation">Plugin API Documentation</h2>

<h2 id="SendMessage">Using SendMessage with External Applications</h2>

<p>The Rainmeter window message API can be used to query or control Rainmeter from external applications. The examples are for C++ and <a href="https://www.autoitscript.com/site/autoit/">AutoIt</a>, but similar functionality is available from any programming platform that can send window messages to running applications.</p>

<p>The Rainmeter window message API can be used to query or control Rainmeter from external applications. Documentation for the available queriese, as well as their definitions, can be found <a href="https://github.com/rainmeter/rainmeter/blob/master/Library/RainmeterQuery.h">here</a>.</p>
<p> The examples are for C++ and <a href="https://www.autoitscript.com/site/autoit/">AutoIt</a>, but similar functionality is available from any programming platform that can send window messages to running applications.</p>
<h3>Query</h3>

<p>The following sample demonstrates how to retrieve a running skin's window handle based on the skin config name. Note that the returned handle should only be used to check if the skin is active or not -- do not abuse the handle.</p>
Expand Down
23 changes: 18 additions & 5 deletions source/manual/bangs.html
Original file line number Diff line number Diff line change
Expand Up @@ -16,10 +16,19 @@
<li><a href="#Deprecated"><em>Deprecated bangs</a></em></li>
</ul>

<p>Bangs can also be used from the Windows command line as a parameter to the Rainmeter.exe executable. Example: <code>"C:\Program Files\Rainmeter\Rainmeter.exe" !RefreshApp</code>.</p>

<p><b>Note:</b> Many bangs have a <code>Config</code> parameter. Unless otherwise specified, valid values are the <a href="!skins/#Config">config name</a> of a currently loaded skin to be acted upon or <code>*</code> (asterisk) to act on all currently loaded skins. When optional and not supplied, the parameter defaults to the current config. If executing a bang with a "config" parameter from the Windows command line, the parameter is always required.</p>

<h3>Command Line Arguments</h3>

<p>Bangs can also be used from the Windows command line as a parameter to the Rainmeter.exe executable. Examples:</p>

<ul>
<li><code>"C:\Program Files\Rainmeter\Rainmeter.exe" !RefreshApp</code></li>
<li><code>"C:\Program Files\Rainmeter\Rainmeter.exe" !SetVariable "textSize" "12" "illustro\Clock"</code></li>
</ul>
<p><b>Note:</b> Any variable of any kind, including <a href="manual/variables/built-in-variables/">Built-In Variables</a>, are not executed when calling Rainmeter from the command line. Likewise, the <code>Config</code> parameter is always required in places where it is treated as optional.</p>


<h2 id="OS">Operating System bangs</h2>
<dl>
<dt id="SetClip"><code>!SetClip</code> <small>Parameter: <code><b>String</b></code></small></dt>
Expand Down Expand Up @@ -97,7 +106,9 @@ <h2 id="Application">Application bangs</h2>

<dt id="Quit"><code>!Quit</code></dt>
<dd>
Quits Rainmeter.
Quits Rainmeter.<br>
</br>
<b>Note:</b> This becomes the only bang that can be executed from the command line when <a href="!user-interface/manage/#GameModeTab">Game Mode</a> and <code>Unload all skins</code> is turned on.
</dd>

<dt id="Play"><code>Play</code> <small>Parameter: <code><b>SoundFile</b></code></small></dt>
Expand Down Expand Up @@ -158,9 +169,11 @@ <h2 id="Options">Option and Variable bangs</h2>
<li><code>Section</code> (required): If the section does not exist in the file, a new section will be written at the end of the file.</li>
<li><code>Key</code> (required): If the key does not exist under the section, a new key will be written at the end of the section.</li>
<li><code>Value</code> (required): Value to be written. Any previous value will be overwritten.</li>
<li><code>FilePath</code> (optional): If not specified, the current skin file is used. The file must exist and must be located under either <code>#SKINSPATH#</code> or <code>#SETTINGSPATH#</code>.</li>
<li><code>FilePath</code> (optional*): If not specified, the current skin file is used. The file must exist and must be located under either <code>#SKINSPATH#</code> or <code>#SETTINGSPATH#</code>.</li>
</ul>
<br><b>Example:</b> <code>!WriteKeyValue Variables MyFontName Arial "#@#Variables.inc"</code>

<br><br><p>* <b>Note:</b> This option is required when executing the bang from the command line.</p>
</dd>
</dl>

Expand Down Expand Up @@ -914,7 +927,7 @@ <h3 id="SkinGroupBangs">Skin group bangs</h3>
</dl>

<h2 id="Deprecated">Deprecated bangs</h2>
<dl>
<dl>
<dt id="Execute"><code>!Execute</code></dt>
<dd>
The !Execute bang, used both to indicate multiple bangs in one statement and to execute external applications has been made optional. Do not use it in new skins.
Expand Down
11 changes: 8 additions & 3 deletions source/manual/getting-started/customizing.html
Original file line number Diff line number Diff line change
Expand Up @@ -15,9 +15,14 @@ <h2 id="FindingSkins">Finding Skins</h2>
<li><p><b><a href="https://forum.rainmeter.net/viewforum.php?f=27">Rainmeter Forum</a></b><br>
Other members of the community like to <a href="https://forum.rainmeter.net/viewforum.php?f=27">share their creations</a> on the official boards.</p></li>
<li><p><b><a href="https://www.deviantart.com/rainmeter">DeviantArt</a></b><br>
Probably the biggest and best collection of skins, deviantArt not only has a special <a href="https://www.deviantart.com/rainmeter/gallery/23941137/skins">Rainmeter category</a>, but also a dedicated <a href="https://www.deviantart.com/rainmeter">Rainmeter Group</a>, which is run by members of the community and features a curated stream of skins, screenshots, tutorials, interviews and more. All skins on deviantArt are checked for <a href="#Malware">malware</a> before they are accepted by the group.</p></li>
<li><p><b><a href="http://lifehacker.com/rainmeter/">Lifehacker</a></b><br>
Not only is the Lifehacker community full of Rainmeter users, but Lifehacker's editors frequently post featured desktops and how-to guides for popular skins under the <a href="http://lifehacker.com/rainmeter/">Rainmeter tag</a>. Be sure to browse the <a href="https://www.flickr.com/groups/lifehacker-desktop-showandtell/pool/">Lifehacker Desktop Show &amp; Tell</a> pool on <a href="https://www.flickr.com/">Flickr</a>, as well.</p></li>
Probably the biggest and best collection of skins, deviantArt not only has a special <a href="https://www.deviantart.com/rainmeter/gallery/23941137/skins">Rainmeter category</a>, but also a dedicated <a href="https://www.deviantart.com/rainmeter">Rainmeter Group</a>, which is run by members of the community and features a curated stream of skins, screenshots, tutorials, interviews and more. All skins on deviantArt are checked for <a href="#Malware">malware</a> before they are accepted by the group. <b>Note:</b> An account is needed to download skins.</p></li>
<li><p><b><a href="https://github.com/">GitHub</a></b><br>
Skins can be found under the <code><a href="https://github.com/topics/rainmeter">rainmeter</a></code>,<code><a href="https://github.com/topics/rainmeter-skin">rainmeter-skin</a></code>,<code><a href="https://github.com/topics/rmskin">rmskin</a></code> tags.</p></li>
</ul>
<p>Other places where Rainmeter skins/suites/desktops/inspiration can be found:</p>
<ul>
<li><p><b><a href="https://www.flickr.com/groups/lifehacker-desktop-showandtell/pool/">Lifehacker Desktop Show &amp; Tell</a></b> & <b><a href="https://www.reddit.com/r/Rainmeter/">Reddit</a></b><br>
Be sure to browse the <a href="https://www.flickr.com/groups/lifehacker-desktop-showandtell/pool/">Lifehacker Desktop Show &amp; Tell</a> pool on <a href="https://www.flickr.com/">Flickr</a>, as well as the <a href="https://www.reddit.com/r/Rainmeter/">r/rainmeter</a> and <a href="https://www.reddit.com/r/desktops/">r/desktops</a> subreddit on <a href="https://www.reddit.com/">Reddit</a> for communities full of Rainmeter users.</p></li>
</ul>

<h3 id="Malware">Malware</h3>
Expand Down
10 changes: 5 additions & 5 deletions source/manual/getting-started/setting-up.html
Original file line number Diff line number Diff line change
Expand Up @@ -11,20 +11,20 @@ <h2 id="SystemRequirements">System Requirements</h2>
<p>Rainmeter is not available for non-Windows systems, including Mac OS and Linux, and there are no plans to support these operating systems.</p>

<h2 id="Download">Download</h2>

<p>Start by downloading the Rainmeter installer from <a href="https://www.rainmeter.net">Rainmeter.net</a>.</p>

<div class="exampleprev float-right thumbnail">
<a href="!img/getting-started/gs-installer.png" data-fancybox><img src="!img/getting-started/gs-installer.png"></a>
</div>

<p>Start by downloading the Rainmeter installer from <a href="https://www.rainmeter.net">Rainmeter.net</a>.</p>


<h2 id="Install">Install</h2>

<div class="exampleprev float-right thumbnail full-mobile">
<a href="!img/installing-rainmeter/Install02.png" data-fancybox><img src="!img/installing-rainmeter/Install02.png"></a>
<p>Installing Rainmeter is mostly automatic.</p>
</div>

<h2 id="Install">Install</h2>

<p>To install Rainmeter, run the installer program that you downloaded, and follow the instructions. (See <a href="!installing-rainmeter/">Installing Rainmeter</a> if you need more detailed instructions, including steps for installing Rainmeter as a portable application.)</p>

<p>Rainmeter will run automatically after it has been installed.</p>
Expand Down
4 changes: 3 additions & 1 deletion source/manual/measures/net.html
Original file line number Diff line number Diff line change
Expand Up @@ -34,7 +34,7 @@ <h2>Options</h2>

<dt id="Interface"><code>Interface</code> <small>Default: <code>Best</code></small></dt>
<dd>
<p>Identity of the network interface controller (NIC) to measure.<p>
<p>Identity of the Network Interface Controller (NIC) to measure.<p>
<p>This can be defined in one of several ways:
<ul>
<li>The string value <code>Best</code>, which will automatically detect the active interface.</li>
Expand All @@ -47,6 +47,8 @@ <h2>Options</h2>
<p><b>Notes:</b></p>
<p>When the option is set to <code>Best</code>, the function will select a "wired" network connection in preference to a "wireless" one, if both are active.</p>
<p>When the option is set to <code>Best</code>, <code>DynamicVariables=1</code> must be set on the measure if you want it to automatically react to changes in the active interface. This should be done if for instance you have a laptop or other computer that you switch between wired and wireless connections.</p>

<p>Additional general help with finding your NIC can be found at <a href="/tips/finding-your-network-interface-for-sysInfo-and-net/">Finding your Network Interface for SysInfo and Net</a>.</p>
</dd>

<dt id="Cumulative"><code>Cumulative</code> <small>Default: <code>0</code></small></dt>
Expand Down
1 change: 1 addition & 0 deletions source/manual/measures/nowplaying.html
Original file line number Diff line number Diff line change
Expand Up @@ -109,6 +109,7 @@ <h2>Bangs</h2>
<li><code>SetRepeat <em>n</em></code>: Where <em>n</em> is <code>1</code> (repeat on), <code>0</code> (repeat off), or <code>-1</code> (toggle repeat).</li>
<li><code>SetVolume <em>n</em></code>: Where <em>n</em> is either an absolute value (<code>SetVolume 50</code> to set volume to 50%) or a relative value (<code>SetVolume +20</code> to increase volume by 20% or<code>SetVolume -40</code> to decrease volume by 40%).</li>
</ul>
<p><b>Note:</b> On partially supported players, as well as players not listed here, the <a href="!measures/mediakey/">MediaKey</a> measure can be used to substitute some of the bangs listed above.</p>

<h2 id="playerlist">Fully supported players</h2>
<p>The following players are fully supported. All features should work unless stated otherwise.</p>
Expand Down
14 changes: 11 additions & 3 deletions source/manual/measures/sysinfo.html
Original file line number Diff line number Diff line change
Expand Up @@ -128,18 +128,26 @@ <h4 id="TimeZoneValues">Time Zone values</h4>
<dd>
<p>An additional selector option that can be used to define an instance for some <a href="#SysInfoType">SysInfoType</a> values.</p>

<br>

<p><b>Network Interface Controller</b></p>
<p>For <code>SysInfoType</code> values related to network information, this will identify the network interface controller (NIC) to use.<p>
<p>This can be defined in one of several ways:
<ul>
<li>The string value <code>Best</code>, which will automatically detect the active interface. If not specified, this is the default.</li>
<li>The description (name) of the network interface controller. For example, <code>Qualcomm Wireless Network Adapter</code>.</li>
<li>The name of the network interface controller. For example, <code>Qualcomm AR938x Wireless Network Adapter</code>.</li>
<li>The alias of the network interface. For example, <code>Ethernet</code> or <code>Wi-Fi 3</code>.</li>
<li>The index number of the network interface controller. This number can be found by starting Rainmeter with <a href="https://docs.rainmeter.net/manual/user-interface/manage/#Logging">Debug</a> turned on, but be aware that these numbers can change during normal usage of Windows.</li>
</ul></p>

<p>Example: <code>SysInfoData=Best</code></p>
<p><b>Note:</b> When the option is set to <code>Best</code>, the function will select a "wired" network connection in preference to a "wireless" one, if both are active.</p>
<p>When the option is set to <code>Best</code>, <code>DynamicVariables=1</code> must be set on the measure if you want it to automatically react to changes in the active interface. This should be done if for instance you have a laptop or other computer that you switch between wired and wireless connections, or if you change your connection using a VPN.</p>
<p><b>Notes:</b></p>
<p>When the option is set to <code>Best</code>, the function will select a "wired" network connection in preference to a "wireless" one, if both are active.</p>
<p>When the option is set to <code>Best</code>, <code>DynamicVariables=1</code> must be set on the measure if you want it to automatically react to changes in the active interface. This should be done if for instance you have a laptop or other computer that you switch between wired and wireless connections.</p>

<p>Additional general help with finding your NIC can be found at <a href="/tips/finding-your-network-interface-for-sysInfo-and-net/">Finding your Network Interface for SysInfo and Net</a>.</p>

<br>

<p><b>Monitor number</b></p>
<p>For <code>SysInfoType</code> values related to monitor information, this will identify the monitor number to use.</p>
Expand Down
2 changes: 1 addition & 1 deletion source/manual/meters/general-options/image-options.html
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@
---
<p>Options available for use with all images. These options are to modify the display of an image file, and do not work with square/rectangle Image meters created entirely with SolidColor / SolidColor2, or with any shape created by a Shape meter.</p>

<p><b>Note:</b> Valid image file types in Rainmeter are <b>.png</b>, <b>.jpg</b>, <b>.bmp</b>, <b>.gif</b>, <b>.tif</b> and <b>.ico</b>. If no extension is provided on an image file name, <b>.png</b> is assumed.</p>
<p><b>Note:</b>Supported image formats are <b>.png</b>, <b>.jpg</b>, <b>.bmp</b>, <b>.gif</b> (no <a href="/tips/animated-gif-files">animation</a> supported), <b>.tif</b>, <b>.webP</b> and <b>.ico</b>. If no file extension is included, <b>.png</b> is assumed.</p>

<h2>Options</h2>
<dl>
Expand Down
4 changes: 1 addition & 3 deletions source/manual/meters/image.html
Original file line number Diff line number Diff line change
Expand Up @@ -5,9 +5,7 @@
---
<p><code>Meter=Image</code> displays either an image defined by a measure value, or any named image. If <code>W</code> and/or <code>H</code> are included in the meter options, the image will be scaled to fit the meter size.</p>

<p>Supported image formats are .png, .jpg, .bmp, .gif (no <a href="/tips/animated-gif-files">animation</a> supported), .tif, .webP, and .ico.</p>

<p><b>Note:</b> If no file extension is included, .png is assumed.</p>
<p><b>Note:</b>Supported image formats are <b>.png</b>, <b>.jpg</b>, <b>.bmp</b>, <b>.gif</b> (no <a href="/tips/animated-gif-files">animation</a> supported), <b>.tif</b>, <b>.webP</b> and <b>.ico</b>. If no file extension is included, <b>.png</b> is assumed.</p>

<h2>Options</h2>
<dl>
Expand Down
2 changes: 2 additions & 0 deletions source/manual/skins/option-types.html
Original file line number Diff line number Diff line change
Expand Up @@ -114,6 +114,8 @@ <h2 id="Action">Action options</h2>
LeftMouseUpAction=[!SetWallpaper "#ImageFile#"]
```

<h3 id="ExternalWindowsCommands">External Windows Commands</h3>

<p>External Windows commands can be executed by specifying the path to the executable and any parameters. Enclose the command in square brackets <code>[]</code>, and enclose any values with spaces in quotes.</p>

``` ini
Expand Down
2 changes: 1 addition & 1 deletion source/manual/user-interface/context-menus.html
Original file line number Diff line number Diff line change
Expand Up @@ -56,7 +56,7 @@ <h2 id="SkinContextMenus">Skin context menus</h2>

<div style="clear: both;"></div>

<p>___________<br>
<p><hr><br>
<b>Note for skin authors:</b> Custom skin context menu items can be added using <a href="!skins/rainmeter-section/#Context">Context options</a> in a skin. Details and examples <a href="https://forum.rainmeter.net/viewtopic.php?p=78117#p78117">here</a>.</p>

<h2 id="SkinsSettingsMenu">Skin settings submenu</h2>
Expand Down
Loading

0 comments on commit 348645b

Please sign in to comment.