About this project

# Realtime Mesh Component (Core) for Unreal Engine 5 This is the free, MIT-licensed **Core** edition of the Realtime Mesh Component. It renders runtime-generated and runtime-modified geometry in Unreal Engine 5, serving as a high-performance replacement for the ProceduralMeshComponent (PMC) and DynamicMeshComponent. Built around an efficient stream-based mesh data layer and a copy-on-write render proxy, it scales from loading models at runtime to live mesh editing and procedural world generation. ## What's Included in Core - **RealtimeMeshComponent**: Core runtime with stream-based mesh data, LODs, sections and section groups, materials, copy-on-write render proxy, collision, and full Blueprint + C++ APIs. - **RealtimeMeshExamples**: Canonical usage examples (HelloTriangle, basic shapes, collision, async build, LODs, fast updates, and more). - **RealtimeMeshEditor**: Editor integration and details-panel tooling. ## Pro Edition Adds Mesh providers and the Constructed mesh system, dynamic mesh (UDynamicMesh) integration, static-mesh/OBJ conversion, GPU + CPU mesh→SDF generation with Lumen card support, compute-shader mesh generation, spatial streaming, a runtime Nanite builder, and meshoptimizer-based mesh optimization. ## Installation 1. Clone or copy this repository into your project's `Plugins/` folder (e.g., `MyProject/Plugins/RealtimeMeshComponent/`), or install from Fab. 2. Regenerate project files and build (C++ project required for source builds). 3. Enable the *Realtime Mesh Component* plugin in the editor if it isn't enabled automatically. **Supported engine versions:** UE 5.5 – 5.8 ## Getting Started The examples module is the best starting point — see `Source/RealtimeMeshExamples/`, starting with `RealtimeMeshExample_Simple_HelloTriangle`. Full guides, key concepts, and API documentation live at [triaxis.games/realtime-mesh](https://triaxis.games/realtime-mesh/). ## Community & Support - [Discord](https://discord.gg/WCgffd3h6r) — active community support - [Issue tracker](https://github.com/TriAxis-Games/RealtimeMeshComponent/issues) - Contributions welcome — see CONTRIBUTING.md ## License The Core edition is licensed under the MIT License. Copyright © TriAxis Games, L.L.C.