How h4tch/moddoc works
Core Components
a) Parser Layer:
• TOML Parser component
• Custom TOML extension parser (as mentioned in the README)
b) Definition Modules:
• Component Definition Handler
• System Definition Handler
• Entity Definition Handler
• Metadata Handler
• Dependency Manager
c) Runtime Layer:
• Dynamic Shared Object Loading System (mentioned as a future consideration)
• Namespace Manager
• Symbol Export/Import System
• [Input Layer]
• → .dm files
• → TOML definitions
• [Processing Layer]
• → Parser Components
• → Definition Handlers
• → Validation System
• [Runtime Layer]
• → Dynamic Loading
• → Namespace Management
• → Symbol Resolution
Key Relationships to Highlight
a) Data Flow:
• How .dm files flow through the TOML parser
• How parsed definitions are processed by respective handlers
• Demonstrate dependency resolution paths
b) Component Interactions:
• How Components, Systems, and Entities interact
• Namespace isolation
• Symbol export/import paths
Implementation Details to Note
• Clear labels for TOML extension points
External Integration Points
• Integration with game engine components
• Lua script integration
• Dynamic shared object loading interfaces
Remember to include a small example workflow showing how a typical mod definition would flow through the system, from .dm file to runtime implementation.
This design should emphasize the declarative nature of the system while showing how it handles the complexity of mod management in game development.