1.2.0 - Wildcard and Regex Rules

Author: ShayBox

Cargo.lock

@@ -1,7 +1,7 @@
 [package]
 name = "wooting-profile-switcher"
 description = "Automatically switch Wooting keyboard profiles based on focused window"
-version = "1.1.0"
+version = "1.2.0"
 authors = ["Shayne Hartford <shaybox@shaybox.com>"]
 edition = "2021"
 readme = "README.md"
@@ -14,8 +14,10 @@ license = "MIT"
 active-win-pos-rs = "0.8"
 anyhow = "1"
 clap = { version = "4.3", features = ["derive"] }
+regex = "1.8"
 serde = { version = "1", features = ["derive"] }
 serde_json = "1"
+wildflower = "0.3"
 wooting-rgb-sys = "0.2"
 
 # https://github.com/johnthagen/min-sized-rust

Cargo.toml

@@ -10,3 +10,69 @@
 # WootingProfileSwitcher
 
 Automatically switch Wooting keyboard profiles based on focused window
+
+## Installation
+
+You can [Download] and Extract the latest release for your operating system  
+You can also install via cargo:  
+`$ cargo install --git https://github.com/ShayBox/WootingProfileSwitcher`
+
+## Configuration
+
+The config file is generated on first run with the following format
+
+```json
+{
+    "loop_sleep_ms": 250,
+    "send_sleep_ms": 250,
+    "rules": [
+        {
+            "app_name": null,
+            "process_name": "Isaac",
+            "process_path": null,
+            "profile_index": 1,
+            "title": null
+        },
+        {
+            "app_name": null,
+            "process_name": "isaac-ng.exe",
+            "process_path": null,
+            "profile_index": 2,
+            "title": null
+        }
+    ]
+}
+```
+
+The `sleep_ms` variables allow you to customize the duration between checking the active process, and duration between sending Wooting USB commands.  
+The `rules` variable is a list of rules that supports [Wildcard] and [Regex] for `app_name`, `process_name`, `process_path` and `title` variables.
+
+### Examples:
+
+#### Matching a window title with a date variable
+
+```json
+{
+    "app_name": null,
+    "process_name": null,
+    "process_path": null,
+    "profile_index": 0,
+    "title": "VRCX ????.??.??"
+}
+```
+
+#### Matching a window title with a version variable
+
+```json
+{
+    "app_name": null,
+    "process_name": null,
+    "process_path": null,
+    "profile_index": 0,
+    "title": "Minecraft [\d]+.[\d]+.[\d]+"
+}
+```
+
+[Download]: https://github.com/ShayBox/WootingProfileSwitcher/releases/latest
+[Wildcard]: https://crates.io/crates/wildflower
+[Regex]: https://crates.io/crates/regex

README.md

@@ -10,31 +10,40 @@ use serde::{Deserialize, Serialize};
 const CARGO_CRATE_NAME: &str = env!("CARGO_CRATE_NAME");
 
 #[derive(Clone, Debug, Default, Deserialize, Serialize)]
-pub struct Process {
-    pub process_name: String,
+pub struct Rule {
+    pub app_name: Option<String>,
+    pub process_name: Option<String>,
+    pub process_path: Option<String>,
     pub profile_index: u8,
+    pub title: Option<String>,
 }
 
 #[derive(Clone, Debug, Deserialize, Serialize)]
 pub struct Config {
     pub loop_sleep_ms: u64,
     pub send_sleep_ms: u64,
-    pub process_list: Vec<Process>,
+    pub rules: Vec<Rule>,
 }
 
 impl Default for Config {
     fn default() -> Self {
         Self {
             loop_sleep_ms: 250,
             send_sleep_ms: 250,
-            process_list: vec![
-                Process {
-                    process_name: String::from("Isaac"),
+            rules: vec![
+                Rule {
+                    app_name: None,
+                    process_name: Some(String::from("Isaac")),
+                    process_path: None,
                     profile_index: 1,
+                    title: None,
                 },
-                Process {
-                    process_name: String::from("isaac-ng.exe"),
+                Rule {
+                    app_name: None,
+                    process_name: Some(String::from("isaac-ng.exe")),
+                    process_path: None,
                     profile_index: 2,
+                    title: None,
                 },
             ],
         }