Adds OSC settings view

Adds a new settings view for configuring OSC targets, allowing users to specify custom targets (e.g., Resonite) or disable sending OSC messages to VRChat.

Author: Raphiiko

CHANGELOG.md

@@ -7,6 +7,12 @@ and this project (now) adheres to [Calendar Versioning](https://calver.org/#sche
 
 ## [Unreleased]
 
+## Added
+
+- OSC Settings view
+  - Custom target for OSC messages (e.g. for use with Resonite, OSC routers, or when OSCQuery is not available)
+  - VRChat (OSCQuery) target (allows for disabling OSC messages being sent to VRChat)
+
 ## [25.6.10]
 
 ### Fixed

src-ui/app/app-routing.module.ts

@@ -29,6 +29,7 @@ import { SettingsIntegrationsViewComponent } from './views/dashboard-view/views/
 import { SettingsAdvancedViewComponent } from './views/dashboard-view/views/settings-advanced-view/settings-advanced-view.component';
 import { SettingsHotkeyViewComponent } from './views/dashboard-view/views/settings-hotkey-view/settings-hotkey-view.component';
 import { SettingsStatusInfoViewComponent } from './views/dashboard-view/views/settings-status-info-view/settings-status-info-view.component';
+import { SettingsOscViewComponent } from './views/dashboard-view/views/settings-osc-view/settings-osc-view.component';
 import { HmdAutomationsViewComponent } from './views/dashboard-view/views/hmd-automations-view/hmd-automations-view.component';
 import { JoinNotificationsViewComponent } from './views/dashboard-view/views/join-notifications-view/join-notifications-view.component';
 import { VRChatAvatarAutomationsViewComponent } from './views/dashboard-view/views/vrchat-avatar-automations-view/vrchat-avatar-automations-view.component';
@@ -154,6 +155,10 @@ const routes: Routes = [
             path: 'hotkeys',
             component: SettingsHotkeyViewComponent,
           },
+          {
+            path: 'osc',
+            component: SettingsOscViewComponent,
+          },
           {
             path: 'updates',
             component: SettingsUpdatesViewComponent,

src-ui/app/app.module.ts

@@ -154,6 +154,7 @@ import { AudioDeviceAutomationsService } from './services/audio-device-automatio
 import { WindowsService } from './services/windows.service';
 import { SettingsAdvancedViewComponent } from './views/dashboard-view/views/settings-advanced-view/settings-advanced-view.component';
 import { SettingsNotificationsViewComponent } from './views/dashboard-view/views/settings-notifications-view/settings-notifications-view.component';
+import { SettingsOscViewComponent } from './views/dashboard-view/views/settings-osc-view/settings-osc-view.component';
 import { SettingsGeneralViewComponent } from './views/dashboard-view/views/settings-general-view/settings-general-view.component';
 import { SettingsUpdatesViewComponent } from './views/dashboard-view/views/settings-updates-view/settings-updates-view.component';
 import { StartWithSteamVRHowToModalComponent } from './views/dashboard-view/views/settings-general-view/start-with-steamvr-how-to-modal/start-with-steamvr-how-to-modal.component';
@@ -319,6 +320,7 @@ export function createTranslateLoader(http: HttpClient) {
     LanguageSelectModalComponent,
     SettingsGeneralViewComponent,
     SettingsNotificationsViewComponent,
+    SettingsOscViewComponent,
     SettingsUpdatesViewComponent,
     SettingsAdvancedViewComponent,
     VRChatLoginModalComponent,

src-ui/app/components/dashboard-navbar/dashboard-navbar.component.html

@@ -120,6 +120,7 @@
           'settings/vrchat',
           'settings/notifications',
           'settings/hotkeys',
+          'settings/osc',
           'settings/updates',
           'settings/integrations',
           'settings/advanced',
@@ -346,6 +347,12 @@
         </div>
         <div class="menu-item-label" translate>comp.dashboard-navbar.settings.hotkeys</div>
       </div>
+      <div class="menu-item" [routerLinkActive]="'active'" [routerLink]="['settings', 'osc']">
+        <div class="menu-item-icon-prefix">
+          <i class="material-icons-round">sync_alt</i>
+        </div>
+        <div class="menu-item-label" translate>comp.dashboard-navbar.settings.osc</div>
+      </div>
       <div class="menu-item" [routerLinkActive]="'active'" [routerLink]="['settings', 'updates']">
         <div class="menu-item-icon-prefix">
           <i class="material-icons-round">update</i>

src-ui/app/models/settings.ts

@@ -8,34 +8,39 @@ export interface AppSettings {
   // General Settings
   userLanguage: string;
   userLanguagePicked: boolean;
-  lighthouseConsolePath: string;
   askForAdminOnStart: boolean;
   exitInSystemTray: boolean;
   startInSystemTray: boolean;
   sleepModeStartupBehaviour: 'PERSIST' | 'ACTIVE' | 'INACTIVE';
-  notificationProvider: NotificationProvider;
-  notificationsEnabled: { types: NotificationType[] };
   quitWithSteamVR: QuitWithSteamVRMode;
-  generalNotificationVolume: number;
-  v1LighthouseIdentifiers: {
-    [deviceId: string]: string;
-  };
   hotkeys: { [hotkeyId: string]: string[] };
-  oscServerEnabled: boolean;
   playerListPresets: PlayerListPreset[];
   hideSnowverlay: boolean;
   openVrInitDelayFix: boolean;
   oneTimeFlags: OneTimeFlag[];
   eventLogTypesHidden: EventLogType[];
+  // Notifications
+  notificationProvider: NotificationProvider;
+  notificationsEnabled: { types: NotificationType[] };
+  generalNotificationVolume: number;
+  // OSC
+  oscServerEnabled: boolean;
+  oscTargets: OSCTarget[];
+  oscCustomTargetHost: string;
+  oscCustomTargetPort: number;
   // Message center
   hiddenMessageIds: string[];
   // Overlay
   overlayMenuEnabled: boolean;
   overlayGpuAcceleration: boolean;
   overlayMenuOnlyOpenWhenVRChatIsRunning: boolean;
   // Lighthouse
+  lighthouseConsolePath: string;
   lighthousePowerControl: boolean;
   lighthousePowerOffState: LighthouseDevicePowerState;
+  v1LighthouseIdentifiers: {
+    [deviceId: string]: string;
+  };
   // Discord Rich Presence
   discordActivityMode: DiscordActivityMode;
   discordActivityOnlyWhileVRChatIsRunning: boolean;
@@ -60,6 +65,8 @@ export type DiscordActivityMode = 'ENABLED' | 'ONLY_ASLEEP' | 'DISABLED';
 
 export type QuitWithSteamVRMode = 'DISABLED' | 'IMMEDIATELY' | 'AFTERDELAY';
 
+export type OSCTarget = 'VRCHAT_OSCQUERY' | 'CUSTOM';
+
 export type HotkeyId =
   | 'HOTKEY_TOGGLE_SLEEP_MODE'
   | 'HOTKEY_ENABLE_SLEEP_MODE'
@@ -83,46 +90,59 @@ export type NotificationType = (typeof NotificationTypes)[number];
 
 export const APP_SETTINGS_DEFAULT: AppSettings = {
   version: 10,
+  // General Settings
   userLanguage: 'en',
   userLanguagePicked: false,
   askForAdminOnStart: false,
-  lighthouseConsolePath:
-    'C:\\Program Files (x86)\\Steam\\steamapps\\common\\SteamVR\\tools\\lighthouse\\bin\\win64\\lighthouse_console.exe',
   exitInSystemTray: false,
   startInSystemTray: false,
-  lighthousePowerControl: true,
-  lighthousePowerOffState: 'sleep',
   sleepModeStartupBehaviour: 'PERSIST',
+  quitWithSteamVR: 'DISABLED',
+  hotkeys: {},
+  playerListPresets: [],
+  hideSnowverlay: false,
+  openVrInitDelayFix: false,
+  oneTimeFlags: [],
+  eventLogTypesHidden: [],
+  // Notifications
   notificationProvider: 'OYASUMIVR',
   notificationsEnabled: { types: [...NotificationTypes] as NotificationType[] },
-  quitWithSteamVR: 'DISABLED',
+  generalNotificationVolume: 100,
+  // OSC
+  oscServerEnabled: true,
+  oscTargets: ['VRCHAT_OSCQUERY'],
+  oscCustomTargetHost: '127.0.0.1',
+  oscCustomTargetPort: 9000,
+  // Message center
+  hiddenMessageIds: [],
+  // Overlay
   overlayMenuEnabled: true,
   overlayGpuAcceleration: true,
   overlayMenuOnlyOpenWhenVRChatIsRunning: false,
-  generalNotificationVolume: 100,
+  // Lighthouse
+  lighthouseConsolePath:
+    'C:\\Program Files (x86)\\Steam\\steamapps\\common\\SteamVR\\tools\\lighthouse\\bin\\win64\\lighthouse_console.exe',
+  lighthousePowerControl: true,
+  lighthousePowerOffState: 'sleep',
   v1LighthouseIdentifiers: {},
-  hotkeys: {},
-  hideSnowverlay: false,
-  oscServerEnabled: true,
-  valveIndexMaxBrightness: 160,
-  bigscreenBeyondMaxBrightness: 150,
-  bigscreenBeyondUnsafeBrightness: false,
-  bigscreenBeyondBrightnessFanSafety: true,
+  // Discord Rich Presence
   discordActivityMode: 'ENABLED',
   discordActivityOnlyWhileVRChatIsRunning: true,
-  playerListPresets: [],
+  // MQTT
   mqttEnabled: false,
   mqttHost: null,
   mqttPort: null,
   mqttUsername: null,
   mqttPassword: null,
   mqttSecureSocket: false,
-  openVrInitDelayFix: false,
+  // Brightness & CCT
   cctControlEnabled: true,
   cctSoftwareMode: false,
-  oneTimeFlags: [],
-  eventLogTypesHidden: [],
-  hiddenMessageIds: [],
+  // HW Specific
+  valveIndexMaxBrightness: 160,
+  bigscreenBeyondMaxBrightness: 150,
+  bigscreenBeyondUnsafeBrightness: false,
+  bigscreenBeyondBrightnessFanSafety: true,
 };
 
 export type ExecutableReferenceStatus =

src-ui/app/services/osc.service.ts

@@ -184,35 +184,36 @@ export class OscService {
   }
 
   async send_command(address: string, parameters: OscParameter[]) {
-    const addr = this._vrchatOscAddress.value;
-    if (!addr) return;
-    // Replace spaces with underscores in address (This is default VRC behaviour for parameters, and spaces aren't supported in addresses according to the OSC spec anyways)
-    address = address.trim().replace(/\s+/g, '_');
+    const targetAddresses = this.getOscTargetAddresses();
+    for (let targetAddr of targetAddresses) {
+      // Replace spaces with underscores in address (This is default VRC behaviour for parameters, and spaces aren't supported in addresses according to the OSC spec anyways)
+      address = address.trim().replace(/\s+/g, '_');
 
-    const _parameters = structuredClone(parameters); // copy parameter array because some parameters may be modified before sending
-    _parameters.forEach((parameter) => {
-      // handle "\n" in string values to insert newlines
-      if (parameter.type === 'String') {
-        parameter.value = parameter.value.replace(/\\n/g, '\n');
-      }
-    });
+      const _parameters = structuredClone(parameters); // copy parameter array because some parameters may be modified before sending
+      _parameters.forEach((parameter) => {
+        // handle "\n" in string values to insert newlines
+        if (parameter.type === 'String') {
+          parameter.value = parameter.value.replace(/\\n/g, '\n');
+        }
+      });
 
-    const parametersString = _parameters
-      .map((parameter) => `${parameter.type} => ${parameter.value}`)
-      .join(', ');
+      const parametersString = _parameters
+        .map((parameter) => `${parameter.type} => ${parameter.value}`)
+        .join(', ');
 
-    const addresses = [...this.getAddressAliasesForAvatarContext(address)];
-    if (!addresses.length) addresses.push(address);
+      const oscAddresses = [...this.getAddressAliasesForAvatarContext(address)];
+      if (!oscAddresses.length) oscAddresses.push(address);
 
-    for (const oscAddr of addresses) {
-      info(`[OSC] Sending {${parametersString}} to ${oscAddr}`);
+      for (const oscAddr of oscAddresses) {
+        info(`[OSC] Sending {${parametersString}} on ${oscAddr} to ${targetAddr}`);
 
-      await invoke('osc_send_command', {
-        addr,
-        oscAddr,
-        types: _parameters.map((parameter) => parameter.type),
-        values: _parameters.map((parameter) => parameter.value),
-      });
+        await invoke('osc_send_command', {
+          addr: targetAddr,
+          oscAddr,
+          types: _parameters.map((parameter) => parameter.type),
+          values: _parameters.map((parameter) => parameter.value),
+        });
+      }
     }
   }
 
@@ -278,4 +279,17 @@ export class OscService {
     if (this.avatarContext.type !== 'VRCHAT') return [];
     return this.avatarContext.parameters.find((p) => p.address === address)?.modularAliases ?? [];
   }
+
+  private getOscTargetAddresses(): string[] {
+    const targets: string[] = [];
+    if (this.appSettings.settingsSync.oscTargets.includes('VRCHAT_OSCQUERY')) {
+      targets.push(this._vrchatOscAddress.value ?? '');
+    }
+    if (this.appSettings.settingsSync.oscTargets.includes('CUSTOM')) {
+      targets.push(
+        `${this.appSettings.settingsSync.oscCustomTargetHost}:${this.appSettings.settingsSync.oscCustomTargetPort}`
+      );
+    }
+    return targets.filter(Boolean);
+  }
 }

src-ui/app/utils/cached-value.ts

@@ -64,12 +64,12 @@ export class CachedValue<T> {
       value: this.value,
       lastSet: this.lastSet,
       ttl: this.ttl,
-    })
+    });
   }
 
   private async clearFromDisk() {
     if (!this.persistenceKey) return;
-    await CACHE_STORE.delete(this.persistenceKey)
+    await CACHE_STORE.delete(this.persistenceKey);
   }
 
   private async loadFromDisk() {

src-ui/app/views/dashboard-view/views/settings-advanced-view/settings-advanced-view.component.html

@@ -23,22 +23,6 @@ <h2 translate>settings.advanced.application.title</h2>
               </label>
             </div>
           </div>
-          <div class="setting-row">
-            <div class="setting-row-label" translate>
-              <span translate>settings.advanced.application.oscServerEnabled.title</span>
-              <span translate>settings.advanced.application.oscServerEnabled.description</span>
-            </div>
-            <div class="setting-row-action">
-              <label class="switch-toggle">
-                <input
-                  type="checkbox"
-                  [checked]="oscServerEnabled"
-                  (change)="setOscServerEnabled(!oscServerEnabled)"
-                />
-                <span class="switch-toggle-slider"></span>
-              </label>
-            </div>
-          </div>
           <div class="setting-row">
             <div class="setting-row-label" translate>
               <span translate>settings.advanced.application.openVrInitDelayFix.title</span>

src-ui/app/views/dashboard-view/views/settings-advanced-view/settings-advanced-view.component.ts

@@ -56,7 +56,6 @@ export class SettingsAdvancedViewComponent {
   ];
   checkedPersistentStorageItems: string[] = [];
   memoryWatcherActive = FLAVOUR === 'DEV';
-  oscServerEnabled = true;
   overlayGpuAcceleration = true;
   openVrInitDelayFix = false;
 
@@ -66,11 +65,10 @@ export class SettingsAdvancedViewComponent {
     private modalService: ModalService,
     private eventLogService: EventLogService,
     private ipcService: IPCService,
-    protected openvr: OpenVRService,
-    private settingsService: AppSettingsService
+    private settingsService: AppSettingsService,
+    protected openvr: OpenVRService
   ) {
     this.settingsService.settings.pipe(takeUntilDestroyed()).subscribe((settings) => {
-      this.oscServerEnabled = settings.oscServerEnabled;
       this.overlayGpuAcceleration = settings.overlayGpuAcceleration;
       this.openVrInitDelayFix = settings.openVrInitDelayFix;
     });
@@ -295,12 +293,6 @@ export class SettingsAdvancedViewComponent {
     await invoke('open_dev_tools');
   }
 
-  setOscServerEnabled(enabled: boolean) {
-    this.settingsService.updateSettings({
-      oscServerEnabled: enabled,
-    });
-  }
-
   setOverlayGpuAcceleration(enabled: boolean) {
     this.settingsService.updateSettings({ overlayGpuAcceleration: enabled });
   }