Updated documentation

Author: SystemXFiles

docs/README.md

@@ -1,28 +1,28 @@
-![Logo Process Governor](images/github-banner-readme.png)
+![Logo Process Governor](images/headers/github-banner-readme.png)
 
 ---
 
 **Process Governor** is a Python utility designed to manage Windows processes and services by adjusting their
 priorities, I/O priorities, and core affinity based on user-defined rules.
 
-<details>
-   <summary>Screenshots</summary>
-
-   >![tray_menu_screenshot.png](images/tray_menu_screenshot.png)
-   > 
-   >![audio_artiacle_rule_configurator_screenshot.png](images/audio_artiacle_rule_configurator_screenshot.png)
-   > 
-   >![rule_configurator_with_error_screenshot.png](images/rule_configurator_with_error_screenshot.png)
-</details>
-
-## Features
+### Features
 
 - Adjust process and service priorities for better performance.
 - Control I/O priorities to optimize resource utilization.
 - Define core affinity for processes.
-- Fine-tune Windows services and processes based on [user-defined rules](ui_rule_configurator.md).
-- Continuous monitoring of the configuration file for rule application.
-- Ability to add ProcessGovernor to autorun.
+- Fine-tune Windows services and processes based on user-defined rules.
+
+### Screenshots
+
+<details>
+    <summary>Click to expand</summary>
+
+> ![process_list.png](images/screenshots/process_list.png)
+>
+> ![process_rules.png](images/screenshots/process_rules.png)
+>
+> ![tray_menu.png](images/screenshots/tray_menu.png)
+</details>
 
 ## Getting started
 
@@ -33,18 +33,19 @@ To get started with **Process Governor**, follow these steps:
 2. Run the `Process Governor.exe` executable with **administrative privileges**.
    This is important to allow the program to make the necessary adjustments to process and service priorities, I/O
    priorities, and core affinity.
-3. [Configure the rules](ui_rule_configurator.md) for processes and services.
+3. Configure the rules for processes and services.
+4. **Optionally**, you can enable auto-start for the program to launch automatically with
+   the system.
 
 You can close the program by accessing the tray icon.
 
 ## Knowledge base
 
-- [Configuring rules](ui_rule_configurator.md)
+- [Process Governor UI](ui_process_governor.md)
+- [Rule Behavior and Tips](rule_behavior_and_tips.md)
 - [Configuration file](configuration_file.md)
 - [Running from source and creating a portable build](run_and_build.md)
-- **Tips and Tricks**
-  - [Optimizing Audio](tips'n'tricks/audio.md)
-  - [Optimizing Games](tips'n'tricks/game_optimization.md)
+
 ## License
 
 This project is licensed under the GNU General Public License v3.0 - see the [LICENSE](../LICENSE) file for details.

docs/configuration_file.md

@@ -4,110 +4,181 @@
 
 ---
 
-The `config.json` configuration file is used to manage the behavior of the **Process Governor** application. It allows
-you to define how the application will regulate the priorities of processes and services, their I/O priorities, and
-correspondence to CPU cores.
+The `config.json` configuration file manages the behavior of the **Process Governor** application. This file allows
+users to define rules for regulating process priorities, I/O priorities, and CPU core affinity, as well as manage
+services with similar settings.
 
-The configuration file is regularly checked by the application and applied if there are changes.
+The application regularly checks the configuration file for changes and applies the updates accordingly.
 
-### Configuration File Example
+---
+## Configuration File Example
+
+Below is an example of the configuration file with several rules defined for processes and services:
 
-In this example, two rules are defined: one for a process and one for a service.
+<details>
+    <summary>See an example</summary>
 
 ```json
 {
   "ruleApplyIntervalSeconds": 1,
-  "logging": {
-    "enable": true,
-    "level": "WARN",
-    "maxBytes": 1024,
-    "backupCount": 1
-  },
-  "rules": [
+  "processRules": [
+    {
+      "selectorBy": "Name",
+      "selector": "aida_bench64.dll",
+      "force": "N"
+    },
+    {
+      "selectorBy": "Name",
+      "selector": "bg3*.exe",
+      "affinity": "0-15",
+      "force": "N",
+      "delay": "30"
+    },
+    {
+      "selectorBy": "Name",
+      "selector": "logioptionsplus_*.exe",
+      "priority": "Idle",
+      "ioPriority": "Low",
+      "affinity": "0-15",
+      "force": "N"
+    },
+    {
+      "selectorBy": "Name",
+      "selector": "discord.exe",
+      "priority": "Normal",
+      "affinity": "0-15",
+      "force": "Y"
+    },
     {
-      "processSelector": "example.exe",
-      "priority": "High",
-      "ioPriority": "Normal",
-      "affinity": "1;3-5"
+      "selectorBy": "Name",
+      "selector": "audiodg.exe",
+      "priority": "Realtime",
+      "affinity": "16-23",
+      "force": "N"
     },
     {
-      "serviceSelector": "Audio*",
+      "selectorBy": "Name",
+      "selector": "*",
+      "affinity": "0-15",
+      "force": "N"
+    }
+  ],
+  "serviceRules": [
+    {
       "priority": "Realtime",
-      "ioPriority": "High",
-      "affinity": "0;2;4"
+      "selector": "*audio*",
+      "force": "N"
     }
-  ]
+  ],
+  "version": 3
 }
 ```
+</details>
+
+---
 
 ## Structure of the `config.json`
 
-The configuration file consists of several key sections:
+The configuration file contains several sections, each serving a specific purpose.
 
 ### `ruleApplyIntervalSeconds`
 
-This parameter defines the interval in seconds at which rules will be applied to processes and services. The default
-value is `1`, which means that rules are applied every second.
+This parameter defines the interval, in seconds, at which the application applies the rules to processes and services.
+The default value is `1`, meaning rules are applied every second.
 
-### `logging`
+### `processRules`
 
-This section contains logging settings. It allows you to enable or disable logging, set the logging level, the maximum
-size of the log file, and the number of backup log files to keep.
+This section lists the rules applied to processes. Each rule object specifies how the application should manage a
+process based on several key parameters:
 
 #### Possible parameters:
 
-- `enable`: Enables or disables logging.
-- `level`: The logging level (`INFO`, `WARN`, etc.).
-- `maxBytes`: The maximum size of the log file in bytes.
-- `backupCount`: The number of backup log files.
-
-### `rules`
-
-This section defines the list of rules by which **Process Governor** will manage processes and services. Each rule is
-defined by an object with a set of parameters.
-
-#### Possible parameters:
+- **`selectorBy`** (string): Determines how the `selector` value is interpreted for process matching.  
+  **Valid values:**
+    - `"Name"`: Match by process name (e.g., `"notepad.exe"`).
+    - `"Path"`: Match by full executable path (e.g., `"C:/Windows/System32/notepad.exe"`).
+    - `"Command line"`: Match by command line (e.g., `"App.exe Document.txt"`).
 
-- `processSelector` (string, optional): Specifies the process name or pattern to match.  
-  You can use wildcards, including `*` and `?`, to match multiple processes.
-    - Example: `"processSelector": "example.exe"`
-    - Example with wildcards: `"processSelector": "logioptionsplus_*.exe"`
 
+- **`selector`** (string): Specifies the name, pattern, or path to the process. 
+  **Supported wildcards:**
+    - `*`: Matches any number of characters.
+    - `?`: Matches a single character.
+    - `**`: Matches any sequence of directories.
 
-- `serviceSelector` (string, optional): Specifies the service name or pattern to match.  
-  You can use wildcards, including `*` and `?`, to match multiple services.
-    - Example: `"serviceSelector": "MyService"`
-    - Example with wildcards: `"serviceSelector": "Audio*"`
+  **Examples:**
+    - `"selector": "name.exe"`
+    - `"selector": "logioptionsplus_*.exe"`
+    - `"selector": "C:/Program Files/**/app.exe --file Document.txt"`
 
 
-- `priority` (string, optional): Sets the process or service priority.  
-  Valid values are:
+- **`priority`** (string, optional): Sets the priority level of the process.  
+  **Valid values:**
     - `"Idle"`
     - `"BelowNormal"`
     - `"Normal"`
     - `"AboveNormal"`
     - `"High"`
     - `"Realtime"`
-    - Example: `"priority": "High"`
+
+  **Example:** `"priority": "High"`
 
 
-- `ioPriority` (string, optional): Sets the I/O priority for the process or service.  
-  Valid values are:
+- **`ioPriority`** (string, optional): Sets the I/O priority of the process.  
+  **Valid values:**
     - `"VeryLow"`
     - `"Low"`
     - `"Normal"`
-    - `"High"`: Setting the I/O priority to "High" may result in an AccessDenied error in most cases.
-    - Example: `"ioPriority": "Normal"`
+
+  **Example:** `"ioPriority": "Low"`
 
 
-- `affinity` (string, optional): Specifies CPU core affinity.  
-  You can define affinity as:
+- **`affinity`** (string, optional): Sets the CPU core affinity for the process.  
+  **Formats:**
     - Range (inclusive): `"affinity": "0-3"`
     - Specific cores: `"affinity": "0;2;4"`
     - Combination: `"affinity": "1;3-5"`
 
-### Validation
 
-Built-in validation prevents the simultaneous assignment of `processSelector` and `serviceSelector` within a single
-rule. If you attempt to set both parameters, the program will notify you of the error and require you to correct the
-rule.
+- **`force`** (string, optional): Forces the application of the settings.  
+  **Valid values:**
+    - `"Y"` for continuous enforcement.
+    - `"N"` for one-time application.
+
+
+- **`delay`** (integer, optional): Delay in seconds before applying the settings.  
+  **Examples:**
+    - If not specified, the settings are applied immediately.
+    - Positive values set a delay in seconds before applying the settings.
+
+### `serviceRules`
+
+This section contains a list of rules applied to services. Unlike `processRules`, the **Service Rule** does not include
+the `selectorBy` field because service rules only match by service name using the `selector` field.
+
+#### Possible parameters:
+
+- **`selector`** (string): Specifies the name or pattern of the service to match.  
+  **Supported wildcards:**
+    - `*`: Matches any number of characters.
+    - `?`: Matches a single character.
+
+  **Examples:**
+    - `"selector": "ServiceName"`
+    - `"selector": "*audio*"`
+
+Other parameters such as `priority`, `ioPriority`, `affinity`, `force`, and `delay` are similar to those
+in `processRules`.
+
+### `version`
+
+This field specifies the version of the configuration. It is required for ensuring proper migration and updates when the
+program configuration changes over time.
+
+---
+
+## Validation
+
+The configuration file undergoes validation to ensure consistency and correctness. If there are any issues, such as
+invalid parameter combinations or missing required fields, the application will notify the user and prevent the
+configuration from being applied until the errors are resolved.