Merge pull request lonelyicer#11 from lonelyicer/dev

feat: allow forced disabling of expression or eye tracking

Author: lonelyicer

README.md

@@ -38,3 +38,13 @@ Done! You have successfully installed the module.
 > [!NOTE]  
 > To manual change protocol version,
 > you will need change the value of `faceTrackingTransferProtocol` in the `settings.json` file located in the `%AppData%/PICO Connect/` directory to `2` or `1`.
+
+## Configuration  
+
+To selectively disable eye or facial expression tracking, please follow these steps:  
+
+### 1.Navigate to the module's configuration directory (path can be found in module logs)
+### 2.Create corresponding files:
+   - Create `.disable_eye` to disable eye tracking
+   - Create `.disable_expression` to disable facial expression tracking
+### 3.Restart the VRCFaceTracking for changes to take effect

README.zh.md

@@ -38,3 +38,13 @@ VRCFTPicoModule 是一个为 VRCFaceTracking 添加了对 PICO 4 Pro / Enterpris
 > [!NOTE]  
 > 要手动更改协议版本，
 > 你需要修改位于 `%AppData%/PICO Connect/` 目录下的 `settings.json` 文件内的 `faceTrackingTransferProtocol` 键对应的值为 `2` 或者 `1`。
+
+## 配置  
+
+如需单独禁用眼部或表情追踪功能，请按以下步骤操作：  
+
+### 1.打开模块的配置文件目录（路径可在模块日志中查看）
+### 2.在目录中创建对应文件：
+   - 创建 `.disable_eye` 文件关闭眼部追踪
+   - 创建 `.disable_expression` 文件关闭表情追踪
+### 3.重启 VRCFaceTracking 使配置生效

VRCFTPicoModule.sln.DotSettings

@@ -0,0 +1,2 @@
+<wpf:ResourceDictionary xml:space="preserve" xmlns:x="http://schemas.microsoft.com/winfx/2006/xaml" xmlns:s="clr-namespace:System;assembly=mscorlib" xmlns:ss="urn:shemas-jetbrains-com:settings-storage-xaml" xmlns:wpf="http://schemas.microsoft.com/winfx/2006/xaml/presentation">
+	<s:String x:Key="/Default/CodeStyle/Naming/CSharpNaming/Abbreviations/=VRCFT/@EntryIndexedValue">VRCFT</s:String></wpf:ResourceDictionary>

VRCFTPicoModule/Assets/Locales/en-US.json

@@ -1,5 +1,8 @@
 {
   "start-init": "Starting Initialization...",
+  "config-path": "The configuration file will be in {0}",
+  "force-disable-eye": "Eye tracking is force disabled",
+  "force-disable-expression": "Expression tracking is force disabled",
   "initializing-udp-clients": "Initializing UDP Clients on ports: {0}",
   "using-port": "Using port: {0}",
   "eye-tracking-disabled": "Eye tracking is disabled",

VRCFTPicoModule/Assets/Locales/zh-CN.json

@@ -1,5 +1,8 @@
 {
   "start-init": "正在开始初始化...",
+  "config-path": "配置文件将位于 {0}",
+  "force-disable-eye": "眼部追踪已强制关闭",
+  "force-disable-expression": "表情追踪已强制关闭",
   "initializing-udp-clients": "正在端口 {0} 上初始化 UDP 客户端",
   "using-port": "使用端口：{0}",
   "eye-tracking-disabled": "眼部追踪已停用",

VRCFTPicoModule/VRCFTPicoModule.cs

@@ -1,6 +1,7 @@
 using System.Globalization;
 using Microsoft.Extensions.Logging;
 using System.Net.Sockets;
+using System.Reflection;
 using VRCFaceTracking;
 using VRCFTPicoModule.Utils;
 using static VRCFTPicoModule.Utils.Localization;
@@ -22,7 +23,13 @@ public override (bool eyeSuccess, bool expressionSuccess) Initialize(bool eyeAva
     {
         Localization.Initialize(CultureInfo.CurrentUICulture.Name);
         Logger.LogInformation(T("start-init"));
-        _trackingAvailable = (eyeAvailable, expressionAvailable);
+        
+        var config = ReadConfiguration();
+        _trackingAvailable = (
+            !config.Item1 && eyeAvailable,
+            !config.Item2 && expressionAvailable
+        );
+        
         var initializationResult = InitializeAsync().GetAwaiter().GetResult();
         UpdateModuleInfo(initializationResult);
 
@@ -50,6 +57,35 @@ public override (bool eyeSuccess, bool expressionSuccess) Initialize(bool eyeAva
         return _trackingAvailable;
     }
 
+    private (bool, bool) ReadConfiguration()
+    {
+        var currentDirectory = Path.GetDirectoryName(Assembly.GetExecutingAssembly().Location);
+        Logger.LogInformation(T("config-path"), currentDirectory);
+        
+        if (!Directory.Exists(currentDirectory))
+            return (false, false);
+        
+        var disableEye = false;
+        var disableExpression = false;
+        
+        var eyeFilePath = Path.Combine(currentDirectory, ".disable_eye");
+        if (File.Exists(eyeFilePath))
+        {
+            disableEye = true;
+            Logger.LogInformation(T("force-disable-eye"));
+        }
+
+        var expressionFilePath = Path.Combine(currentDirectory, ".disable_expression");
+        // ReSharper disable once InvertIf
+        if (File.Exists(expressionFilePath))
+        {
+            disableExpression = true;
+            Logger.LogInformation(T("force-disable-expression"));
+        }
+        
+        return (disableEye, disableExpression);
+    }
+
     private void UpdateModuleInfo((bool, bool) initializationResult)
     {
         var moduleProtocol = _port == Ports[1] ? $" [{T("legacy-protocol")}]" : "";