How blueroseslol/brplugins works
Main Components
• Plugin Module (“BRPlugins”): Represented by the Source/BRPlugins directory, including both Public and Private code.
• Content Assets: Found in the Content folder, including Blueprints for AnimModifiers. These represent in-engine assets and scripting components that complement the plugin’s functionality.
• Shaders: Located under the Shaders folder (with Private shader files such as LensDistortion.usf, SimpleComputeShader.usf, etc.). These provide custom shader implementations that extend the rendering pipeline.
• Resources & Configuration: Including the .uplugin file (BRPlugins.uplugin), which defines the module for UE4, and additional resource files that configure or document plugin behavior.
Component Relationships and Interactions
• The UE4 Engine loads the plugin based on the configuration in BRPlugins.uplugin.
• The Plugin Module (in Source/BRPlugins) contains the core logic that communicates with UE4’s rendering system.
• Within the Plugin Module, there are divisions between Public interfaces (exported headers and API) and Private implementations (including rendering effects and shader examples).
• The Rendering subdirectories (both in Public and Private) highlight that there are specific APIs and examples for custom rendering tasks (using RDG and GlobalShader techniques), which require close cooperation with UE4’s rendering engine.
• The Shaders directory provides the actual shader code that is compiled and utilized by the plugin module during rendering processes.
• Content Blueprints (in the Content folder) are used to expose or drive some functionality (e.g., animation modifiers) within the editor, providing a bridge between visual scripting and C++ code.
Architectural Patterns and Design Principles
• Modularity: The plugin is built as a discrete module that UE4 loads dynamically. Indicate the plugin boundary and how it plugs into the overall engine.
• Integration Patterns: Show how the plugin integrates with UE4 through the .uplugin descriptor, and how the custom shaders and blueprint assets interact with the rendering pipeline and gameplay logic.
Technology and Framework Highlights
• C++ for the Plugin Module, using typical UE4 module structure (with Build.cs files).
• UE4 Blueprints for exposing functionality to the editor, found in the Content/Blueprints directory.
• Custom shader code (HLSL-type files) used in the rendering pipeline.
• Use of global and RDG shader examples, updated for different engine versions (as seen in the README change logs).
Instructing Elements
• UE4 Engine/Project Environment – Indicating where the plugin is loaded.
• Plugin Core (BRPlugins module): Subdivide into Public API, Private Implementation, and Rendering examples.
• Custom Shaders Component: Represent shader files as a distinct block showing dependency on the rendering module.
• Content Assets: A block for Blueprints (animation modifiers, etc.) that use or demonstrate the plugin’s features.