How mrsinho/sidera works
Main Components
• Data Input & Configuration:
• Core Engine & Simulation:
• The “sidera/src” files (gaia-sim.c and sidera.c) implement the logic for simulation and management of celestial bodies.
• Graphics Rendering:
• The rendering pipeline is encapsulated in the “sidera/shaders” directory. There are shader sources (GLSL) that are compiled to SPIR-V for the Vulkan API.
• Integration with external libraries (shvulkan, shengine, glfw, cglm) is used to interface with the Vulkan API and manage windowing, math operations, and other engine functionalities.
• Build and Cross-Platform Support:
• The “.shci” folder contains continuous integration/build scripts for different platforms (Linux and Windows), ensuring consistent builds and logging.
• Documentation & External Dependencies:
• The “docs” directory contains developer documentation (using Doxygen) that outlines API details and build instructions.
• The “externals” directory includes repositories such as gaia-archive-tools and shengine used to further support Sidera’s functionality.
Relationships and Interactions
• Data Flow:
• Configuration files (.smd) → Configuration Loader → Core Engine.
• Gaia data (loaded separately via gaia-archive-tools and possibly fetched using scripts or external utilities) → Core Engine.
• Rendering Pipeline:
• Core engine modules (sidera.c, gaia-sim.c) process simulation data and interact with the graphics rendering pipeline.
• Shader code (under sidera/shaders) is compiled and fed into the Vulkan-based renderer (via shvulkan) to produce the actual 3D graphics.
• External Dependencies Integration:
• Incorporate libraries such as glfw (for window management), cglm (for math operations), and shengine (for additional engine logic) as supportive layers that interact with the core engine.
• Build & Deployment:
• Continuous integration (under .shci) ensures builds for both Linux and Windows are carried out through separate scripts, feeding into the overall release process.
Architectural Patterns and Design Principles
• Separation of Concerns:
• Clear separation between data/configuration loading, simulation logic, and rendering.
• Modularity:
• The structure supports replacing or updating individual components (for example, swapping out shader modules or updating the graphics engine via shengine).
• Cross-Platform Build Strategy:
• The presence of platform-specific build scripts under .shci demonstrates a modular and maintainable build system.