feat(pishock): add dynamic intensity cap

Author: DASPRiD

Cargo.lock

@@ -13,6 +13,7 @@ async-osc = "0.2.0"
 cfg-if = "1.0.0"
 chrono = "0.4.24"
 clap = { version = "4.1.4", features = ["derive"] }
+debounced = "0.1.0"
 directories = "5.0.1"
 file-rotate = "0.7.4"
 log = "0.4.17"

Cargo.toml

@@ -75,11 +75,14 @@ VRChat parameters:
 | `PS_ShockLeft_Pressed`  | `bool`  | Left shock button pressed                                                                         |
 | `PS_ShockRight_Pressed` | `bool`  | Right shock button pressed                                                                        |
 | `PS_Intensity`          | `float` | Intensity going from 0.0 to 1.0                                                                   |
+| `PS_IntensityCap`       | `float` | Intensity cap going from 0.0 to 1.0                                                               |
 | `PS_QuickShock`         | `float` | Triggers a short shock with the given intensity once. Reset it by setting it to a negative value. |
 | `PS_ShockActive`        | `bool`  | Set to true while a shock is active, then automatically reset to false.                           |
 
-You can configure the duration (default 4) and an intensity cap (default 1.0) through the configuration file. You must
-also set your credentials in there.
+You can configure the duration (default 4) through the configuration file. You must also set your credentials in there.
+
+The intensity and intensity cap are periodically saved after 10 seconds of being changed. When an avatar loads in, it
+will automatically be populated with the last values.
 
 Quick shocks are always send with a duration of 1 second. You can trigger these with your own contact receivers, e.g.
 by driving the variable through an animation controller.

README.md

@@ -1,7 +1,7 @@
 use anyhow::{Context, Result};
 use directories::BaseDirs;
 use serde::{Deserialize, Serialize};
-use tokio::fs::File;
+use tokio::fs::{metadata, File};
 use tokio::io::{AsyncReadExt, AsyncWriteExt};
 
 #[derive(Debug, Clone, Serialize, Deserialize)]
@@ -28,7 +28,6 @@ pub struct PiShockConfig {
     pub api_key: String,
     pub code: String,
     pub duration: u8,
-    pub intensity_cap: f32,
 }
 
 impl Default for PiShockConfig {
@@ -38,7 +37,6 @@ impl Default for PiShockConfig {
             api_key: "".to_string(),
             code: "".to_string(),
             duration: 4,
-            intensity_cap: 1.,
         }
     }
 }
@@ -57,7 +55,7 @@ pub async fn load_config() -> Result<Config> {
     let config_dir = base_dirs.config_dir();
     let path = config_dir.join("vrc-osc-manager.toml");
 
-    if !path.exists() {
+    if metadata(&path).await.is_err() {
         let config: Config = Default::default();
         let mut file = File::create(&path)
             .await

src/config.rs

@@ -19,6 +19,7 @@ use file_rotate::suffix::{AppendTimestamp, FileLimit};
 use file_rotate::{ContentLimit, FileRotate, TimeFrequency};
 use log::{debug, error, info, LevelFilter};
 use simplelog::{ColorChoice, CombinedLogger, TermLogger, TerminalMode, WriteLogger};
+use std::path::PathBuf;
 use std::sync::Arc;
 use std::time::Duration;
 use sysinfo::{ProcessRefreshKind, RefreshKind, System, SystemExt};
@@ -83,6 +84,7 @@ impl VrChatActivity {
 async fn run_plugins(
     subsys: SubsystemHandle,
     config: Arc<Config>,
+    data_dir: PathBuf,
     receiver_tx: broadcast::Sender<OscMessage>,
     sender_tx: mpsc::Sender<OscMessage>,
 ) -> Result<()> {
@@ -99,7 +101,7 @@ async fn run_plugins(
         let sender_tx = sender_tx.clone();
         let receiver_rx = receiver_tx.subscribe();
         subsys.start("PluginPiShock", |subsys| {
-            plugins::pishock::PiShock::new(sender_tx, receiver_rx, config).run(subsys)
+            plugins::pishock::PiShock::new(sender_tx, receiver_rx, config, data_dir).run(subsys)
         });
     }
 
@@ -110,6 +112,7 @@ async fn run_plugins(
 struct Launcher {
     rx: mpsc::Receiver<bool>,
     config: Arc<Config>,
+    data_dir: PathBuf,
     receiver_tx: broadcast::Sender<OscMessage>,
     sender_tx: mpsc::Sender<OscMessage>,
     dark_mode_icons: bool,
@@ -119,13 +122,15 @@ impl Launcher {
     fn new(
         rx: mpsc::Receiver<bool>,
         config: Arc<Config>,
+        data_dir: PathBuf,
         receiver_tx: broadcast::Sender<OscMessage>,
         sender_tx: mpsc::Sender<OscMessage>,
         dark_mode_icons: bool,
     ) -> Self {
         Self {
             rx,
             config,
+            data_dir,
             receiver_tx,
             sender_tx,
             dark_mode_icons,
@@ -151,9 +156,10 @@ impl Launcher {
                                 let config = self.config.clone();
                                 let receiver_tx = self.receiver_tx.clone();
                                 let sender_tx = self.sender_tx.clone();
+                                let data_dir = self.data_dir.clone();
 
                                 maybe_plugin_subsys = Some(subsys.start("Plugins", move |subsys| {
-                                    run_plugins(subsys, config, receiver_tx, sender_tx)
+                                    run_plugins(subsys, config, data_dir, receiver_tx, sender_tx)
                                 }));
                             }
                         }
@@ -171,9 +177,10 @@ impl Launcher {
                             let config = self.config.clone();
                             let receiver_tx = self.receiver_tx.clone();
                             let sender_tx = self.sender_tx.clone();
+                            let data_dir = self.data_dir.clone();
 
                             maybe_plugin_subsys = Some(subsys.start("Plugins", move |subsys| {
-                                run_plugins(subsys, config, receiver_tx, sender_tx)
+                                run_plugins(subsys, config, data_dir, receiver_tx, sender_tx)
                             }));
                         }
                     } else if !vrchat_running {
@@ -226,8 +233,8 @@ async fn main() -> Result<()> {
     let args = Args::parse();
 
     let base_dirs = BaseDirs::new().context("Base directories not available")?;
-    let data_dir = base_dirs.data_dir();
-    let log_dir = data_dir.join("vrc-osc-manager/logs/log");
+    let data_dir = base_dirs.data_dir().join("vrc-osc-manager");
+    let log_dir = data_dir.join("logs/log");
 
     let log_file = FileRotate::new(
         log_dir,
@@ -274,6 +281,7 @@ async fn main() -> Result<()> {
             Launcher::new(
                 rx,
                 config,
+                data_dir,
                 launcher_receiver_tx,
                 sender_tx,
                 args.dark_mode_icons,