SlimeVR Server Documentation

SlimeVR Server is the central orchestration application for the SlimeVR ecosystem. It manages communication between various hardware sensors and software integrations.

Supported Sensor Implementations

• SlimeVR Tracker for ESP: Supports ESP microcontrollers and multiple IMUs.
• owoTrack Mobile App: Allows using mobile phones as trackers (note: limited functionality and compatibility).
• SlimeVR Wrangler: Allows using Nintendo Switch Joycon controllers as trackers.

Software Integrations

• SteamVR: Use the SlimeVR OpenVR Driver to integrate with SteamVR.
• VRChat / PCVR / Standalone: Use built-in OSC Trackers support for Full Body Tracking (FBT).
• VSeeFace & Other Apps: Use built-in VMC support to send and receive tracking data.
• 3D Applications (e.g., Blender): Export recordings as .BVH files to import motion capture data.

The openapi-codegen.config.ts file defines how the OpenAPI schema for the firmware tool is transformed into TypeScript types and React Query components.

It uses defineConfig from @openapi-codegen/cli and relies on the following configuration structure:

• firmwareTool.from.source: Set to 'url' to indicate the schema is fetched from a remote endpoint.
• firmwareTool.from.url: The URL of the OpenAPI JSON schema. This is pulled from the FIRMWARE_TOOL_SCHEMA_URL environment variable, defaulting to http://localhost:3000/api-json.
• firmwareTool.outputDir: The directory where generated files are stored (src/firmware-tool-api).
• firmwareTool.to: An asynchronous function that executes the generation logic using @openapi-codegen/typescript utilities:
  1. generateSchemaTypes: Generates TypeScript schema types using a specified filenamePrefix (set to firmwareTool).
  2. generateReactQueryComponents: Generates React Query hooks/components using the same prefix and the files produced by generateSchemaTypes.

export default defineConfig({
  firmwareTool: {
    from: {
      source: 'url',
      url: process.env.FIRMWARE_TOOL_SCHEMA_URL ?? 'http://localhost:3000/api-json',
    },
    outputDir: 'src/firmware-tool-api',
    to: async (context) => {
      const filenamePrefix = 'firmwareTool';
      const { schemasFiles } = await generateSchemaTypes(context, {
        filenamePrefix,
      });
      await generateReactQueryComponents(context, {
        filenamePrefix,
        schemasFiles,
      });
    },
  },
});

The useProvideAppContext hook is a provider-level hook responsible for initializing the application's core lifecycle. It performs several critical background tasks:

1. Data Feed Initialization: When connected to the websocket, it sends a StartDataFeed packet containing dataFeedConfig and bonesDataFeedConfig.
2. Data Synchronization: It listens for DataFeedUpdate packets to update the global datafeedAtom and bonesAtom stores.
3. Firmware Polling: It polls the server every 1000ms using fetchCurrentFirmwareRelease(config.uuid) to keep the currentFirmwareRelease state up to date.
4. Localization: It synchronizes the application locale with the user's config.lang.
5. Error Tracking: It initializes Sentry error tracking based on the config.errorTracking setting.
6. Audio Feedback: It handles reset sounds via RpcMessage.ResetResponse if config.feedbackSound is enabled.

It returns an AppContext object containing the currentFirmwareRelease state.

import { useProvideAppContext, useAppContext } from './hooks/app';

function App() {
  // This hook sets up the providers and background processes
  const appContext = useProvideAppContext();

  return (
    <AppContextC value={appContext}>
      <MainContent />
    </AppContextC>
  );
}

When building custom hooks or components that interface with the Firmware Tool API, you can use useFirmwareToolContext to access configuration for fetchers and query behavior. This context is designed to be used within React Query wrappers to standardize how headers, query parameters, and query keys are handled.

Context Properties

• fetcherOptions: Configuration for the underlying fetcher.
  • headers: An object of headers to inject into requests.
  • queryParams: An object of query parameters to inject into requests.
• queryOptions:
  • enabled: A boolean to control automatic refetching. Defaults to true. Set to false to disable automatic refetching when the query mounts or when query keys change.
• queryKeyFn: A function used to generate a unique QueryKey based on a QueryOperation.

// Example of how the context structure is defined
const context: FirmwareToolContext = {
  fetcherOptions: {
    headers: { 'Authorization': 'Bearer token' },
    queryParams: { 'version': '1.0' }
  },
  queryOptions: {
    enabled: true
  },
  queryKeyFn: (operation) => queryKeyFn(operation)
};