rm : Pointer to the plugin measure.type : Log level (LOG_ERROR, LOG_WARNING, LOG_NOITICE, or LOG_DEBUG)format : Formatted message to be logged, follows printf syntax.format : Formatted message to be logged, follows printf syntax.args : Comma separated list of arguments referenced in the formatted message.
type : Log level (API.LogType.Error, API.LogType.Warning, API.LogType.Notice, or API.LogType.Debug)format : Formatted message to be logged, follows composite formatting.format : Formatted message to be logged, follows composite formatting.args : Comma separated list of arguments referenced in the formatted message.Rainmeter.data file for laterYou may have some data that needs to persist across multiple measures or skins and need a place to save it for later use. You may use the Rainmeter.data file to save this data if needed.
You can retrieve the full path of the Rainmeter.data file by calling the RmGetSettingsFile function.
-Use a unique key so other plugins will not overwrite your data. Keeping track of all the measures that reference your plugin may be necessary in order to prevent other measures of your plugin to overwrite the data. To store data in the settings file, use WritePrivateProfileString. To retrieve data, use GetPrivateProfileString.
+Use a unique key so other plugins will not overwrite your data. Keeping track of all the measures that reference your plugin may be necessary in order to prevent other measures of your plugin to overwrite the data. To store data in the settings file, use WritePrivateProfileString. To retrieve data, use GetPrivateProfileString.
There may be times when you want to return a custom value from your plugin that is independent from the string or number value of the measure. In these cases, you can export a custom function that will be called via section variables. Skin authors will be able to call this custom function "on demand" in any option that supports section variables. DynamicVariables=1 will be required.
When making C# plugins you may notice references to IntPtr's and Marshal functions. Since Rainmeter is written in C++, variables are encoded differently, but don't be intimidated by them.
-An IntPtr is basically an integer that represents a pointer to some data, which is why you must deallocate data in finalize as well as recast it in every function. Also since strings are formatted differently in C++, you should pass your string to Marshal.StringToHGlobalUni before returning it in GetString or custom section variables.
+When making C# plugins you may notice references to IntPtr's and Marshal functions. Since Rainmeter is written in C++, variables are encoded differently, but don't be intimidated by them.
+An IntPtr is basically an integer that represents a pointer to some data, which is why you must deallocate data in finalize as well as recast it in every function. Also since strings are formatted differently in C++, you should pass your string to Marshal.StringToHGlobalUni before returning it in GetString or custom section variables.
Also the MarshalAs in ExecuteBang and SectionVariable examples just makes sure that you get a C# style string or string array out of the box.
Disabled and Paused options do in a plugin?You can install or upgrade to the latest version of Rainmeter from a cmd.exe or PowerShell command prompt window using the Windows Package Manager with the WinGet command.
You can install or upgrade to the latest version of Rainmeter from a cmd.exe or PowerShell command prompt window using the Windows Package Manager with the WinGet command.
If the cmd.exe or PowerShell command prompt window is run "As Administrator", the installation will be entirely "silent". If not, Windows will display a UAC (User Account Control) confirmation dialog when executed.
diff --git a/source/manual/measures/sysinfo.html b/source/manual/measures/sysinfo.html index 744fdbc3a..e30d828d8 100644 --- a/source/manual/measures/sysinfo.html +++ b/source/manual/measures/sysinfo.html @@ -59,7 +59,7 @@DOMAIN_WORKGROUP : [String] The computer's network domain or workgroup name.DNS_SERVER : [String] The computer's network primary DNS server IP address.ADAPTER_DESCRIPTION : [String] The description (name) of the network adapter specified by SysInfoData.ADAPTER_TYPE : [String and Number] The type of network adapter specified by SysInfoData.Ethernet, Wireless or Other. The number value will be one of 6 (Ethernet), 71 (Wireless), or some other number in the range 0-280 (Other). The meaning of numeric codes other than 6 and 71 can be found at: docs.microsoft.com Adapter Info.ADAPTER_TYPE : [String and Number] The type of network adapter specified by SysInfoData.Ethernet, Wireless or Other. The number value will be one of 6 (Ethernet), 71 (Wireless), or some other number in the range 0-280 (Other). The meaning of numeric codes other than 6 and 71 can be found at: learn.microsoft.com Adapter Info.ADAPTER_ALIAS : [String] The network interface connected to by the network adapter specified by SysInfoData. Examples are Ethernet 1 or WiFi 3.ADAPTER_GUID : [String] The GUID of the network adapter specified by SysInfoData.ADAPTER_STATE : [String and Number] Gets the "media connected state" of the network adapter specified by SysInfoData. This works for physical and non-physical adapters. The number value will return 1 for connected, and -1 for disconnected. The string value will return Connected or Disconnected. Any other state returns 0 and Unknown.If Format is not defined, the string value returned is in the default format %H:%M:%S, however the number value will be a Windows timestamp. If Format is defined, the number value will be the value defined by the format, or zero if the format does not define a numeric value.
If Format is not defined, the string value returned is in the default format %H:%M:%S, however the number value will be a Windows timestamp. If Format is defined, the number value will be the value defined by the format, or zero if the format does not define a numeric value.
Note: If a Format option is defined, the Windows timestamp value of the measure can still be retrieved and used with the [MeasureName:Timestamp] section variable measure modifier.
@@ -36,7 +36,7 @@If TimeStamp is a numeric Windows timestamp or a formula defining a Windows timestamp, then this number, in one-second increments since January 1, 1601, will be used as the basis for measuring the date and time.
+If TimeStamp is a numeric Windows timestamp or a formula defining a Windows timestamp, then this number, in one-second increments since January 1, 1601, will be used as the basis for measuring the date and time.
TimeStampFormat=%A, %d. %b %Y %H:%M:%STimeStampLocale=de-DE
- The values for this option can be found at [MS-LCID]: Windows Language Code Identifier (LCID) Reference. The values in the columns "Culture Name" or "Language Name Abbreviation" or "Language" can be used. Be sure to select your Windows version from the pull-down on the top left to get the most accurate information.
+
The values for this option can be found at [MS-LCID]: Windows Language Code Identifier (LCID) Reference. The values in the columns "Culture Name" or "Language Name Abbreviation" or "Language" can be used. Be sure to select your Windows version from the pull-down on the top left to get the most accurate information.
Hint: In addition, a combination of "Language", an "_" underscore, "Country" (from inside the parentheses in the "Locale" column) a "." dot and the value of the "ANSI Codepage" column can be used to be very specific.
diff --git a/source/manual/measures/webparser.html b/source/manual/measures/webparser.html index 52cf362d4..3fd1ae2e9 100644 --- a/source/manual/measures/webparser.html +++ b/source/manual/measures/webparser.html @@ -198,7 +198,7 @@
In addition, there are times when an external local file to be parsed with URL=file:// will be encoded in other than the ANSI (really ASCII plus "extended ASCII" specific to the locale of the computer) encoding used as the default in most Windows-based text editors. Primarily this will be in Unicode UFT-16 LE. In this case, the CodePage=1200 option must be used to tell WebParer how to interpret the resource being read.
Codepage definitions and more information can be found at Code Page Identifiers.
+Codepage definitions and more information can be found at Code Page Identifiers.
Additional general help with Unicode encoding in Rainmeter can be found at Unicode in Rainmeter.
diff --git a/source/manual/plugins/audiolevel.html b/source/manual/plugins/audiolevel.html index 41b1391d4..fad480c3e 100644 --- a/source/manual/plugins/audiolevel.html +++ b/source/manual/plugins/audiolevel.html @@ -9,7 +9,7 @@This can be used to create a volume level VU Meter for defined channels, or optionally can filter the audio stream into distinct frequency bands to create a Spectrum Analyzer.
-The plugin monitors the amplitude of the post-mixer signal at a Windows audio endpoint. (i.e. sound card speaker output, USB audio interface, headphone port, microphone input) It does this by creating a WASAPI capture client in loopback mode. The capture client streams audio data to the plugin where it can be filtered and measured. The resulting volume level is returned by the plugin for use in Rainmeter measures and meters.
+The plugin monitors the amplitude of the post-mixer signal at a Windows audio endpoint. (i.e. sound card speaker output, USB audio interface, headphone port, microphone input) It does this by creating a WASAPI capture client in loopback mode. The capture client streams audio data to the plugin where it can be filtered and measured. The resulting volume level is returned by the plugin for use in Rainmeter measures and meters.
Plugin=PerfMon retrieves infromation from the Windows Performance Monitor.
Plugin=PerfMon retrieves infromation from the Windows Performance Monitor.
ACLine: 0 for battery or 1 when plugged in.Status: 0 for no battery, 1 for charging, 2 for critical, 3 for low, or 4 for above low.Status2: Equal to BatteryFlag in SYSTEM_POWER_STATUS.Status2: Equal to BatteryFlag in SYSTEM_POWER_STATUS.Lifetime: Battery lifetime.Percent: Battery lifetime as a percentage.Hz: CPU rated frequency in Hz.Plugin=UsageMonitor retrieves information from the Windows Performance Monitor.
Plugin=UsageMonitor retrieves information from the Windows Performance Monitor.
The Windows Performance Monitor exposes counters, which monitor various kinds of system metrics in different categories, and tracks their usage. All available counters can be viewed using the Performance Monitor application. To open it, run Perfmon.exe.
diff --git a/source/manual/settings/rainmeter-section.html b/source/manual/settings/rainmeter-section.html index 592707f2e..fc29a06ae 100644 --- a/source/manual/settings/rainmeter-section.html +++ b/source/manual/settings/rainmeter-section.html @@ -32,7 +32,7 @@DesktopWorkAreaDefines the area for maximized windows.
With multiple monitors, use DesktopWorkArea@N (where N is the number of the monitor) to set the work area of a specifc monitor. DesktopWorkArea and DesktopWorkArea@0 both represent the primary monitor.
Note: Moving the taskbar will reset the workarea to Windows' default, as will changing screen resolution.
Defines the area for maximized windows.
With multiple monitors, use DesktopWorkArea@N (where N is the number of the monitor) to set the work area of a specifc monitor. DesktopWorkArea and DesktopWorkArea@0 both represent the primary monitor.
Note: Moving the taskbar will reset the workarea to Windows' default, as will changing screen resolution.
DesktopWorkAreaType Default: 0Language Default: 1033LCID language code by the Rainmeter dialogs to display text in different languages. Visit the Localization page for a list of languages that Rainmeter supports.
+LCID language code by the Rainmeter dialogs to display text in different languages. Visit the Localization page for a list of languages that Rainmeter supports.
HardwareAcceleration Default: 0Path to the tray icon bitmap file for TrayMeter=Bitmap. Defines the name of the bitmap used when Bitmap is chosen for TrayMeter. The bitmap can have any number of 16x16 frames.
It is possible to use separate icon files as the tray bitmap. %i can be used in the filename to define an increasing number from 1. E.g. TrayBitmap=tray-%i.ico would read the icons files tray-1.ico, tray-2.ico, tray-3.ico and so on as long as it can find them. The format is like printf. (e.g. TrayBitmap=tray-%02i.ico will load tray-01.ico, tray-02.ico, ...)
It is possible to use separate icon files as the tray bitmap. %i can be used in the filename to define an increasing number from 1. E.g. TrayBitmap=tray-%i.ico would read the icons files tray-1.ico, tray-2.ico, tray-3.ico and so on as long as it can find them. The format is like printf. (e.g. TrayBitmap=tray-%02i.ico will load tray-01.ico, tray-02.ico, ...)
A simple Measure that returns a single value, combined with a TrayBitmap path and name of a single 16x16 .ico file can be used to replace the default tray icon with a custom one.
@N directive from WindowX/WindowY settings.@0 represents "The Virtual Screen".@0 represents "The Virtual Screen".@N settings are made automatically based on the position of the meter's window. This setting will be unchecked when a specific monitor is selected.
If you want to know more about it, you can check out the docs.microsoft.com for an excellent explanation on this topic in relation to the usage of the ColorMatrix object. [Source from Code Project]
+If you want to know more about it, you can check out the learn.microsoft.com for an excellent explanation on this topic in relation to the usage of the ColorMatrix object. [Source from Code Project]
Get-NetAdapter command: Get-NetAdapter command: Get-NetAdapter | format-table -property "InterfaceDescription", "InterfaceIndex" -HideTableHeaders
diff --git a/source/tips/launching-windows-special-folders.html b/source/tips/launching-windows-special-folders.html
index 6ed2b4d4f..3c5f48f56 100644
--- a/source/tips/launching-windows-special-folders.html
+++ b/source/tips/launching-windows-special-folders.html
@@ -358,7 +358,7 @@ To launch the Settings app and tabs within it, use the ms-settings: URI scheme. All the URIs can be found here.
To launch the Settings app and tabs within it, use the ms-settings: URI scheme. All the URIs can be found here.
Formatting. Some measures return a formatted string value that is meant for display, but not for calculations. For example, the Time measure gives a string value with hours, minutes and seconds ("HH:MM:SS"), which is how a real person would want to see the time, but which makes no sense in a math equation. The number value gives the raw Windows timestamp, which can be used by a Calc measure, e.g. to calculate the difference between two dates.
+Formatting. Some measures return a formatted string value that is meant for display, but not for calculations. For example, the Time measure gives a string value with hours, minutes and seconds ("HH:MM:SS"), which is how a real person would want to see the time, but which makes no sense in a math equation. The number value gives the raw Windows timestamp, which can be used by a Calc measure, e.g. to calculate the difference between two dates.
There may be cases in which you would want to use a formatted string value in a Calc formula, but these would likely be rare and unorthodox.