|
6 | 6 |
|
7 | 7 | ## Features |
8 | 8 |
|
9 | | -- **Customizable Appearance:** |
10 | | - Configure dimensions, colors, fonts (including custom font files), and borders. |
11 | | - |
12 | | -- **Input Types & Validation:** |
13 | | - Supports `String`, `Integer`, `Float`, `Letters`, `Alphanumeric`, `Hexadecimal`, `Email`, and a custom mode with allowed characters. |
14 | | - |
15 | | -- **Action Handling:** |
16 | | - Execute custom Rainmeter commands on key events: |
| 9 | +- **Customizable Appearance:**Configure dimensions, colors, fonts (including custom font files), and borders. |
| 10 | +- **Input Types & Validation:**Supports `String`, `Integer`, `Float`, `Letters`, `Alphanumeric`, `Hexadecimal`, `Email`, and a custom mode with allowed characters. |
| 11 | +- **Action Handling:**Execute custom Rainmeter commands on key events: |
| 12 | + |
17 | 13 | - **OnEnterAction:** Triggered when the user submits the input. |
18 | 14 | - **OnESCAction:** Triggered when the user presses the Escape key. |
19 | 15 | - **OnDismissAction:** Triggered when the input overlay loses focus. |
20 | | - |
21 | | -- **Dynamic Placeholder Replacement:** |
22 | | - Replace the placeholder `$UserInput$` with the current text input before executing commands. |
23 | | - <span style="color: red;"><strong>Note:</strong></span> Special characters (e.g., double quotes) are automatically escaped to ensure valid command syntax. |
24 | | - |
25 | | -- **Logging:** |
| 16 | +- **Dynamic Placeholder Replacement:**Replace the placeholder `$UserInput$` with the current text input before executing commands.`<span style="color: red;"><strong>`Note:`</strong>` Special characters (e.g., double quotes) are automatically escaped to ensure valid command syntax. |
| 17 | +- **Logging:** |
26 | 18 | Detailed logging can be enabled for debugging. All logs are printed only when the `Logging` key is set to `1`. |
27 | 19 |
|
28 | 20 | --- |
|
31 | 23 |
|
32 | 24 | ### Installation |
33 | 25 |
|
34 | | -1. **Build the Plugin:** |
35 | | - Compile the C# code into a DLL (e.g., using Visual Studio) and place it into your Rainmeter plugins folder. |
| 26 | +1. **Build the Plugin:**Compile the C# code into a DLL (e.g., using Visual Studio) and place it into your Rainmeter plugins folder. |
| 27 | +2. **Add the Plugin to Your Skin:**Create a Rainmeter skin and add the following measure: |
36 | 28 |
|
37 | | -2. **Add the Plugin to Your Skin:** |
38 | | - Create a Rainmeter skin and add the following measure: |
39 | 29 | ```ini |
40 | 30 | [MeasureInput] |
41 | 31 | Measure=Plugin |
42 | 32 | Plugin=InputTextX.dll |
43 | 33 | ``` |
44 | | - |
45 | | -3. **Configure the Plugin:** |
46 | | - Set the desired configuration keys (see below) in your Rainmeter skin. |
| 34 | +3. **Configure the Plugin:** |
| 35 | + Set the desired configuration keys (see below) in your Rainmeter skin. |
47 | 36 | Example: |
| 37 | + |
48 | 38 | ```ini |
49 | 39 | [MeasureInput] |
50 | 40 | Measure=Plugin |
@@ -281,23 +271,21 @@ The `InputType` key supports the following values: |
281 | 271 |
|
282 | 272 | ## Usage Notes |
283 | 273 |
|
284 | | -> **Note:** |
| 274 | +> **Note:** |
285 | 275 | > The plugin dynamically replaces the placeholder `$UserInput$` in action keys with the current input text. It also escapes special characters (such as double quotes) to ensure the resulting Rainmeter command is valid. |
286 | 276 |
|
287 | | -> **Warning:** |
| 277 | +> **InputTextX** is incompatible with skins set to **Stay Topmost**, or **AlwaysOnTop=2**, as the conflict between the input field, which requires "focus", and the constant attempts by the skin to stay on "top", in front of the input field, will not allow InputTextX to function correctly. |
| 278 | +
|
| 279 | +> **Warning:** |
288 | 280 | > Ensure that your custom commands (especially those using `$UserInput$`) are properly formatted. Improper command syntax may cause unexpected behavior in Rainmeter. |
289 | 281 |
|
290 | 282 | --- |
291 | 283 |
|
292 | 284 | ## Troubleshooting |
293 | 285 |
|
294 | | -- **Crash on Input:** |
295 | | - If Rainmeter crashes when submitting input, enable logging by setting `Logging=1` to view the final command strings in the Rainmeter log. Verify that the commands are correctly formed. |
296 | | - |
297 | | -- **No Command Execution:** |
298 | | - Double-check the action keys (e.g., `OnEnterAction`, `OnESCAction`) in your skin configuration. They must contain valid Rainmeter commands. |
299 | | - |
300 | | -- **Positioning Issues:** |
| 286 | +- **Crash on Input:**If Rainmeter crashes when submitting input, enable logging by setting `Logging=1` to view the final command strings in the Rainmeter log. Verify that the commands are correctly formed. |
| 287 | +- **No Command Execution:**Double-check the action keys (e.g., `OnEnterAction`, `OnESCAction`) in your skin configuration. They must contain valid Rainmeter commands. |
| 288 | +- **Positioning Issues:** |
301 | 289 | If the overlay does not appear in the expected location, adjust the `X` and `Y` offset values. |
302 | 290 |
|
303 | 291 | --- |
|
0 commit comments