Plugin System & Registry Specifications

The Plugin Contract#

Every feature, telemetry engine, and section generator in MonoForge is implemented as a Plugin. A plugin is a plain TypeScript object that adheres strictly to the Plugin interface defined in src/lib/plugins/types.ts.

Plugin Zod Schema#

Every plugin must validate against the official Zod schema:

export interface Plugin {
  id: string;               // Unique alphanumeric identifier
  name: string;             // Human-readable title
  description: string;      // 1-2 sentence description
  category: PluginCategory; // 'stats' | 'socials' | 'tech' | 'visual' | 'media'
  author?: string;          // Author attribution
  badge?: string;           // Optional visual badge (e.g., '60FPS CAMO')
  defaultConfig: any;       // Default section configuration
  render: (config: any, user: UserProfile) => string; // Pure markdown generator
}

Registration Lifecycle#

To register a new plugin:

1. Create a dedicated module inside src/lib/plugins/wrappers/<plugin-id>.ts.
2. Implement the render function returning valid GitHub Flavored Markdown.
3. Import and append the plugin to pluginRegistry inside:

src/lib/plugins/registry.ts

1. Once registered, the plugin automatically surfaces in the Developer Studio, Visual Studio, and Telemetry Arsenal without manual UI wiring.