Skip to content

Commit 57689db

Browse files
authored
Update README.md
1 parent 476eaca commit 57689db

File tree

1 file changed

+32
-1
lines changed

1 file changed

+32
-1
lines changed

README.md

Lines changed: 32 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1 +1,32 @@
1-
# ColorCursor
1+
# PluginColorCursor
2+
3+
Creates the ColorCursor.dll plugin for Rainmeter.
4+
5+
Build in conjunction with the Rainmeter Plugin SDK from:
6+
[Rainmeter Plugin SDK](https://github.com/rainmeter/rainmeter-plugin-sdk)
7+
8+
Documentation for the SDK at:
9+
[Developers Documentation](https://docs.rainmeter.net/developers/#CreatePlugin)
10+
11+
## Options
12+
13+
### Format
14+
`Format=RGB` Returns rrr,ggg,bbb formatted rgb color
15+
16+
`Format=Red` Returns rrr red color element
17+
18+
`Format=Green` Returns ggg green color element
19+
20+
`Format=Blue` Returns bbb blue color element
21+
22+
### RealTime
23+
24+
`RealTime=0` (default) Plugin will do nothing until called with !CommandMeasure
25+
26+
`RealTime=1` Plugin will constantly return the color of the pixel under the mouse cursor
27+
28+
## Commands
29+
30+
`[!CommandMeasure MeasureName "GetColor"]`
31+
32+
When executed in an action, the plugin will return the color of the pixel under the mouse cursor

0 commit comments

Comments
 (0)