How eazuooz/yamyam_engine works
And represent the main components
• Engine Core Subsystem – Represented by the YamYamEngine_SOURCE folder. This subsystem will include:
• Rendering Engine (yaRenderer, yaGraphicDevice_DX11, yaShader, yaMaterial, shader constant buffers and HLSL files)
• Audio System (yaFmod, yaAudioSource, yaAudioClip and integration of FMOD libraries from the External/Library/Fmod directory)
• Physics & Collision (yaCollider, yaCollisionManager, yaBoxCollider2D, yaCircleCollider2D, yaRigidbody)
• Scene & Entity Management (yaScene, yaSceneManager, yaEntity, yaComponent, yaGameObject)
• Input & Event Handling (yaInput, yaEventQueue, yaKeyEvent, yaMouseEvent)
• UI Subsystem (yaUIBase, yaUIButton, yaUIHUD, yaUIManager)
• Other utilities (yaMath, resource management modules)
• Editor and GUI Tools – Taken from Editor_SOURCE and Editor_Window:
• Editor GUI Elements (such as guiEditor, guiInspectorWindow, guiHierarchyWindow, guiGameWindow, guiTransform, etc.)
• ImGui-based components (imgui files including imgui_demo, imgui_impl_dx11, and imgui_impl_win32)
• Windowing components and additional editor functionality (Editor_Window main.cpp, framework.h)
• Shaders – Located in Shaders_SOURCE:
• HLSL shader programs (sprite and wireframe vertex/pixel shaders) and shared shader headers (ConstantBuffers.hlsli, Samplers.hlsli, Textures.hlsli)
• External Libraries:
• FMOD libraries and include files (for audio handling)
• Resources:
• Asset management including images and sound files, which the engine loads and uses during runtime.
Out the relationships and interactions
• Link the Audio System with External Libraries (FMOD), indicating dependency on those external libraries.
• That the Input, Event, and Scene Management modules interact to control game object behavior and UI updates.
Important design principles and patterns
• Modularity: Make sure each subsystem (Rendering, Audio, Physics, etc.) is clearly separated — this indicates adherence to separation of concerns.
• Component-Based Design: Within the engine, entities and game objects are handled in a component-oriented way (yaEntity, yaComponent, yaScript, etc.).
• Editor-Engine Decoupling: Although tightly integrated in this project, visually separate the editor modules from the engine core to clarify responsibilities.
Components you must include
▪ Engine Core (with submodules: Rendering, Audio, Physics, Scene/Entity, Input/Events, UI)
▪ Editor Tools (GUI, ImGui-based interfaces, Editor windows)
▪ Shaders (vertex and pixel shaders, shared shader headers)
▪ External Dependencies (FMOD and other libraries)
▪ Resources (images, sounds, textures)