refactor: update overlay config fetching to only include the overlay config

Author: jacobtread

overlay/src/main.ts

@@ -1,13 +1,16 @@
 import "./styles/app.css";
 import "./vtftk/events";
 import "./vtftk/calibration";
-import { getAppData } from "./vtftk/appData";
 import { RuntimeAppData } from "./vtftk/types";
 import { subscribeEvent } from "./vtube-studio/event";
 import { attemptAuthorization } from "./vtube-studio/auth";
 import { VTubeStudioWebSocket } from "./vtube-studio/socket";
 import { EventSourceData, createEventSource } from "./vtftk/events";
-import { updateRuntimeData, getCalibrationData } from "./vtftk/api";
+import {
+  getOverlayConfig,
+  updateRuntimeData,
+  getCalibrationData,
+} from "./vtftk/api";
 import {
   requestCurrentModel,
   createModelParameters,
@@ -22,10 +25,10 @@ async function load() {
     vtube_studio_auth: false,
   });
 
-  const appData = await getAppData();
+  const overlayConfig = await getOverlayConfig();
 
   const eventSourceData: EventSourceData = {
-    appData,
+    overlayConfig: overlayConfig,
     modelCalibration: new Map(),
     vtSocket: undefined,
     modelParameters: undefined,
@@ -40,8 +43,8 @@ async function load() {
   const eventSource = createEventSource(eventSourceData);
 
   const vtSocket = new VTubeStudioWebSocket(
-    appData.vtube_studio_config.host,
-    appData.vtube_studio_config.port,
+    overlayConfig.vtube_studio_config.host,
+    overlayConfig.vtube_studio_config.port,
   );
 
   eventSourceData.vtSocket = vtSocket;

overlay/src/vtftk/api.ts

@@ -1,7 +1,13 @@
 import { BACKEND_HTTP } from "../constants";
 import { base64ArrayBuffer } from "../utils/base64";
-import { ModelData, RuntimeAppData } from "./types";
 import { CalibrationStepData } from "./calibration-types";
+import { ModelData, OverlayConfig, RuntimeAppData } from "./types";
+
+export async function getOverlayConfig(): Promise<OverlayConfig> {
+  const response = await fetch(new URL("/overlay/config", BACKEND_HTTP));
+  const json: OverlayConfig = await response.json();
+  return json;
+}
 
 export async function notifyProgressCalibration(body: CalibrationStepData) {
   const response = await fetch(new URL("/calibration", BACKEND_HTTP), {

overlay/src/vtftk/appData.ts

@@ -16,8 +16,8 @@ import {
   executeInterval,
 } from "../utils";
 import {
-  AppData,
   ModelId,
+  OverlayConfig,
   ItemWithSounds,
   ThrowItemConfig,
   ModelCalibration,
@@ -27,7 +27,7 @@ import {
 } from "./types";
 
 export type EventSourceData = {
-  appData: AppData;
+  overlayConfig: OverlayConfig;
   vtSocket: VTubeStudioWebSocket | undefined;
   modelCalibration: Map<ModelId, ModelCalibration>;
   modelParameters: ModelParameters | undefined;
@@ -58,7 +58,7 @@ async function onMessage(data: EventSourceData, event: any) {
     case "ThrowItem": {
       if (data.vtSocket && data.modelParameters) {
         onThrowItemEvent(
-          data.appData,
+          data.overlayConfig,
           data.vtSocket,
           data.modelCalibration,
           data.modelParameters,
@@ -92,22 +92,22 @@ async function onMessage(data: EventSourceData, event: any) {
 
     case "PlaySound": {
       if (data.vtSocket) {
-        onPlaySoundEvent(data.appData, event.config);
+        onPlaySoundEvent(data.overlayConfig, event.config);
       }
 
       break;
     }
 
     case "PlaySoundSeq": {
       if (data.vtSocket) {
-        onPlaySoundSeqEvent(data.appData, event.configs);
+        onPlaySoundSeqEvent(data.overlayConfig, event.configs);
       }
 
       break;
     }
 
-    case "AppDataUpdated": {
-      onAppDataUpdatedEvent(data, event.app_data);
+    case "ConfigUpdated": {
+      onConfigUpdatedEvent(data, event.config);
       break;
     }
 
@@ -135,11 +135,14 @@ async function onMessage(data: EventSourceData, event: any) {
   }
 }
 
-function onAppDataUpdatedEvent(data: EventSourceData, appData: AppData) {
-  data.appData = appData;
+function onConfigUpdatedEvent(
+  data: EventSourceData,
+  overlayConfig: OverlayConfig,
+) {
+  data.overlayConfig = overlayConfig;
 
   // Recreate the physics engine
-  const { fps, gravity_multiplier } = appData.physics_config;
+  const { fps, gravity_multiplier } = overlayConfig.physics_config;
   setPhysicsEngineConfig({
     fps: fps,
     gravityMultiplier: gravity_multiplier,
@@ -159,14 +162,17 @@ async function onUpdateHotkeysEvent(vtSocket: VTubeStudioWebSocket) {
   return hotkeys;
 }
 
-async function onPlaySoundEvent(appData: AppData, config: PartialSoundModel) {
+async function onPlaySoundEvent(
+  overlayConfig: OverlayConfig,
+  config: PartialSoundModel,
+) {
   const audio = await loadAudio(config.src);
-  audio.volume = config.volume * appData.sounds_config.global_volume;
+  audio.volume = config.volume * overlayConfig.sounds_config.global_volume;
   audio.play();
 }
 
 async function onPlaySoundSeqEvent(
-  appData: AppData,
+  appData: OverlayConfig,
   configs: PartialSoundModel[],
 ) {
   const sounds = await loadSounds(configs);
@@ -252,7 +258,7 @@ async function onMoveModelEvent(
 }
 
 async function onThrowItemEvent(
-  appData: AppData,
+  overlayConfig: OverlayConfig,
   vtSocket: VTubeStudioWebSocket,
   modelCalibration: Map<ModelId, ModelCalibration>,
   modelParameters: ModelParameters,
@@ -267,7 +273,7 @@ async function onThrowItemEvent(
   if (config.type === ThrowItemConfigType.All) {
     await throwItemMany(
       vtSocket,
-      appData,
+      overlayConfig,
       modelCalibration,
       modelParameters,
       items.items,
@@ -280,7 +286,7 @@ async function onThrowItemEvent(
       async () => {
         return throwItemMany(
           vtSocket,
-          appData,
+          overlayConfig,
           modelCalibration,
           modelParameters,
           items.items,
@@ -341,7 +347,7 @@ function pickRandomItem(items: ItemWithSoundIds[], images: LoadedItemMap) {
 
 function throwRandomItem(
   socket: VTubeStudioWebSocket,
-  appData: AppData,
+  overlayConfig: OverlayConfig,
   modelCalibration: Map<ModelId, ModelCalibration>,
   modelParameters: ModelParameters,
 
@@ -366,7 +372,7 @@ function throwRandomItem(
 
   return throwItem(
     socket,
-    appData,
+    overlayConfig,
     modelCalibration,
 
     modelParameters,
@@ -379,7 +385,7 @@ function throwRandomItem(
 
 async function throwItemMany(
   socket: VTubeStudioWebSocket,
-  appData: AppData,
+  overlayConfig: OverlayConfig,
   modelCalibration: Map<ModelId, ModelCalibration>,
   modelParameters: ModelParameters,
 
@@ -391,7 +397,7 @@ async function throwItemMany(
   if (amount === 1) {
     return throwRandomItem(
       socket,
-      appData,
+      overlayConfig,
       modelCalibration,
       modelParameters,
       items,
@@ -404,7 +410,7 @@ async function throwItemMany(
     Array.from(Array(amount)).map(() =>
       throwRandomItem(
         socket,
-        appData,
+        overlayConfig,
         modelCalibration,
         modelParameters,
         items,

overlay/src/vtftk/events.ts

@@ -11,8 +11,8 @@ import {
 } from "./physics";
 import {
   MinMax,
-  AppData,
   ModelId,
+  OverlayConfig,
   ThrowDirection,
   ItemImageConfig,
   ModelCalibration,
@@ -35,7 +35,7 @@ export function setPhysicsEngineConfig(config: PhysicsEngineConfig) {
  * Throws an item
  *
  * @param socket Socket for getting model position and sending impact flinches to VTube studio
- * @param appData Global app data settings
+ * @param overlayConfig Global app data settings
  * @param modelCalibration Calibration data for available models
  * @param modelParameters Parameters for the current model
  * @param config Configuration for the thrown item
@@ -46,7 +46,7 @@ export function setPhysicsEngineConfig(config: PhysicsEngineConfig) {
  */
 export async function throwItem(
   socket: VTubeStudioWebSocket,
-  appData: AppData,
+  overlayConfig: OverlayConfig,
   modelCalibration: Map<ModelId, ModelCalibration>,
   modelParameters: ModelParameters,
   config: ItemWithSoundIds,
@@ -64,7 +64,7 @@ export async function throwItem(
   // Model is not available
   if (!modelPosition) return;
 
-  const { throwables_config: throwables } = appData;
+  const { throwables_config: throwables } = overlayConfig;
 
   // Determine scale of the model relative to the calibrated minimum and maximum sizes
   const modelScale =
@@ -96,7 +96,7 @@ export async function throwItem(
     if (windupAudio !== null) {
       try {
         windupAudio.sound.volume =
-          appData.sounds_config.global_volume * windupAudio.config.volume;
+          overlayConfig.sounds_config.global_volume * windupAudio.config.volume;
         windupAudio.sound.play();
       } catch (err) {
         console.error("failed to play windup audio", err);
@@ -149,7 +149,7 @@ export async function throwItem(
   // Handle point of impact
   handleThrowableImpact(
     socket,
-    appData,
+    overlayConfig,
     modelParameters,
     config,
     impactAudio,
@@ -158,7 +158,7 @@ export async function throwItem(
   );
 
   // No physics to apply
-  if (!appData.physics_config.enabled) {
+  if (!overlayConfig.physics_config.enabled) {
     // Wait remaining duration before removing
     await sleep(throwables.duration / 2);
     // Remove after complete
@@ -169,7 +169,7 @@ export async function throwItem(
 
   // Initialize the physics engine
   if (physicsEngine === null) {
-    const { fps, gravity_multiplier } = appData.physics_config;
+    const { fps, gravity_multiplier } = overlayConfig.physics_config;
 
     physicsEngine = createPhysicsEngine({
       fps: fps,
@@ -182,7 +182,8 @@ export async function throwItem(
   pivot.style.transform = "";
   thrown.style.transform = "";
 
-  const { horizontal_multiplier, vertical_multiplier } = appData.physics_config;
+  const { horizontal_multiplier, vertical_multiplier } =
+    overlayConfig.physics_config;
 
   const randomVelocity = Math.random();
 
@@ -245,7 +246,7 @@ function isRandomDirectionLeft(
  * Handles the point of impact for a throwable hitting the model
  *
  * @param socket Socket for sending impact flinches to VTube studio
- * @param appData Global app data settings
+ * @param overlayConfig Global app data settings
  * @param modelParameters Parameters for the current model
  * @param config Configuration for the thrown item
  * @param impactAudio Audio element to play when the item impacts the target
@@ -254,7 +255,7 @@ function isRandomDirectionLeft(
  */
 function handleThrowableImpact(
   socket: VTubeStudioWebSocket,
-  appData: AppData,
+  overlayConfig: OverlayConfig,
   modelParameters: ModelParameters,
   config: ItemWithSoundIds,
   impactAudio: LoadedSoundData | null,
@@ -265,7 +266,7 @@ function handleThrowableImpact(
   if (impactAudio !== null) {
     try {
       impactAudio.sound.volume =
-        appData.sounds_config.global_volume * impactAudio.config.volume;
+        overlayConfig.sounds_config.global_volume * impactAudio.config.volume;
 
       impactAudio.sound.play();
     } catch (err) {
@@ -278,7 +279,7 @@ function handleThrowableImpact(
   // Make the VTuber model flinch from the impact
   flinch(socket, modelParameters, {
     angle,
-    eyeState: appData.model_config.eyes_on_hit,
+    eyeState: overlayConfig.model_config.eyes_on_hit,
     magnitude: image.weight,
     leftSide,
     returnSpeed: 0.3,

overlay/src/vtube-studio/throw-item.ts

@@ -54,8 +54,8 @@ pub async fn set_app_data(
     let model = AppDataModel::set(db.inner(), app_data).await?;
 
     // Inform the overlay of the new app data
-    _ = event_sender.send(OverlayMessage::AppDataUpdated {
-        app_data: Box::new(model.data),
+    _ = event_sender.send(OverlayMessage::ConfigUpdated {
+        config: Box::new(model.data.overlay),
     });
 
     Ok(true)

src-tauri/src/commands/data.rs

@@ -1,8 +1,5 @@
 use crate::{
-    database::entity::{
-        app_data::{AppData, AppDataModel},
-        vt_access::{SetVTAccess, VTAccessModel},
-    },
+    database::entity::vt_access::{SetVTAccess, VTAccessModel},
     http::{
         error::{DynHttpError, HttpResult},
         models::{GetAuthTokenResponse, SetAuthTokenRequest},
@@ -20,16 +17,6 @@ use reqwest::header::{CACHE_CONTROL, CONTENT_TYPE};
 use sea_orm::{DatabaseConnection, ModelTrait};
 use tauri::{path::BaseDirectory, AppHandle, Manager};
 
-/// GET /app-data
-///
-/// Obtain the current app data configuration. Contains stored
-/// state such as calibration and throwables configuration
-pub async fn get_app_data(Extension(db): Extension<DatabaseConnection>) -> HttpResult<AppData> {
-    let data = AppDataModel::get_or_default(&db).await?;
-
-    Ok(Json(data))
-}
-
 /// GET /content/:folder/:name  
 ///
 /// Retrieve the contents of a file from one of the content folders