How ellanjiang/unitygameframework works
Core Project Components
• Editor vs. Runtime: Notice from the file structure the Scripts directory is divided into “Editor” (tools to assist during development like custom inspectors, resource analyzers, build settings, and resource editors) as well as “Runtime” (the actual game modules used during game execution). Mark these two as separate blocks.
• Libraries and Prefab: There’s a “Libraries” directory (which may include core XML libraries and link configuration files) and a “GameFramework.prefab” which likely serves as a pre-configured Unity asset to bootstrap the framework.
Built-in Modules (as per the README’s 19 modules)
Module mentioned in the README to its corresponding implementation in the file tree structure under the “Scripts/Runtime” directory. They include:
• Config
• Data Node
• Data Table
• Debugger
• Download
• Entity
• Event
• File System
• FSM (Finite State Machine)
• Localization
• Network
• Object Pool
• Procedure
• Resource
• Scene
• Setting
• Sound
• UI
• Web Request
Architectural Patterns and Key Design Principles
• Modular and Extensible Structure: Every module is designed to plug into the central framework, following the dependency inversion and decoupling principles.
• Editor vs. Runtime Separation: Clearly demarcate areas of the framework meant for tool support (Editor) versus the code deployed in runtime.
Incorporate Technical Details
• Labels for file types or assets (e.g., “Prefab” for GameFramework.prefab, “XML” under Libraries) to provide context.
• Framework’s integration with Unity: tag elements that are specific to the Unity engine (such as Inspector tools in Editor or asynchronous resource loaders in Runtime).