Description

Goals

• Provide a scalable, modular architecture for distributed TypeScript system development.
• Support strong typing and shared validation schemas across server, client, and shared logic.
• Improve developer experience with tooling, automation, and structured service boundaries.

• Fournir une architecture modulaire et scalable pour le développement de systèmes TypeScript distribués.
• Prendre en charge un typage fort et des schémas de validation partagés entre serveur, client et logique commune.
• Améliorer l'expérience développeur avec l'outillage, l'automatisation et des frontières de service structurées.

Features

• Monorepo architecture: Built with Turborepo and PNPM, the workspace separates concerns between applications, shared libraries, configuration, scripts, and service definitions.
• Resource-based application modules: Each application module (e.g., rc) includes client, server, and shared folders with support for command handlers, event bindings, and service controllers.
• Decorator-based service exposure: Public methods within services are exposed to FiveM’s global runtime using custom decorators and TypeScript metadata reflection.
• Dynamic runtime exports: Server classes dynamically introspect and export services and methods to the FiveM global context for use across modules.

• Architecture monorepo: Construit avec Turborepo et PNPM, l'espace de travail sépare les préoccupations entre applications, bibliothèques partagées, configuration, scripts et définitions de services.
• Modules d'application basés sur les ressources: Chaque module (ex. rc) inclut des dossiers client, serveur et partagé, avec prise en charge des gestionnaires de commandes, liaisons d'événements et contrôleurs de service.
• Exposition de services par décorateurs: Les méthodes publiques sont exposées au runtime global via des décorateurs personnalisés et la réflexion de métadonnées TypeScript.
• Exports dynamiques à l'exécution: Les classes serveur inspectent et exportent dynamiquement les services et méthodes vers le contexte global pour une utilisation entre les modules.

Usage

• // Example service method export
  @ExportedMethod()
  kickPlayer(reason: string) {
    // Implementation
  }
  
  // Auto-registered and exposed to <NX>.kickPlayer
  

• // Usage example
  const NX = exports.NX.useServer()
  
  const nxPlayer = NX.Players.Get(1)
  
  nxPlayer.kickPlayer(reason)
  

Learning outcomes

• Designed a modular, service-based framework targeting game server infrastructure.
• Built runtime-safe service exports using decorators and reflection metadata.
• Applied modern monorepo practices to manage application topologies.

• Conception d'un framework modulaire et orienté services.
• Construction d'exports de services sécurisés à l'exécution avec décorateurs et réflexion de métadonnées.
• Application des pratiques monorepo modernes pour gérer les topologies d'application.