How jackoodesu/aimlabs-minimal works
Main Components
• Assets & Scenes: Include subcomponents such as Assets (game materials, prefabs, shaders, UI Toolkit files, etc.) and ProjectSettings that configure Unity’s runtime (graphics, input, quality settings).
• Mission System:
– Mission Importer/Loader: The game executable auto-imports missions (from the “missions” folder under TsProject or local mission zips).
– Mission Repository & Template: Missions are defined in the TsProject folder with TypeScript/JavaScript scripts, JSON mission definitions, and custom mission actions.
– Crosshair Config: A separate module (using crosshair-config.cjs and a corresponding template) to customize crosshair settings.
• Scripting & Extensibility:
– PuerTs Integration: This module bridges C#/Unity with JavaScript, enabling dynamic mission logic.
– Generated Typings: Note the Assets/Gen/Typing/csharp directory which holds index.d.ts for mission API contract.
– VContainer (dependency injection)
– UniTask (asynchronous tasks)
– Realms (possibly for data persistence)
– Discord RPC (for community/game status updates)
– glTFast (for handling 3D models)
• Build and Deployment Tools:
– GitHub Actions Workflows (auto-release, Windows build)
– TsProject’s Dockerfile, Makefile, and docker-compose.yml (likely managing mission validate/build environment)
Out Relationships and Data Flow
• The Game Core interacts with the Mission System – launching, managing, and updating missions.
• Inside the Mission System, illustrate the interaction between the static Unity C# side and the dynamic JS scripting side (via PuerTs).
• That the Game Core uses external plugins for additional functionalities (dependency injection, async tasks, etc.).
• The Updater component acts as a bridge whenever a user’s database version is outdated – a separate data migration path triggered at game startup.
• For development and deployment, show an “Automation Pipeline” component representing GitHub workflows and additional TypeScript build tasks (from the TsProject folder).
Architectural Patterns and Design Principles
• Separation of Concerns: Different modules for game rendering (Unity/Scenes), mission logic (scripted missions), and system utilities (updater, crosshair config).
• Dependency Injection & Service-Oriented: Use of VContainer indicates modular, testable components; illustrate services like AudioService, DiscordHandler, etc.
• Scripting Extensibility: Represent the PuerTs module as the integration point, highlighting that missions are written in JavaScript/TypeScript and are decoupled from the core game engine.
• Mission Repository & Importer Workflow: Emphasize how missions are dynamically injected and then updated via the mission importer, reflecting an extensible mission repository design.