6.3 KiB
Plugins Guide - Dubai Metaverse
Overview
This document lists all required and optional plugins for the Dubai Metaverse project, along with installation and configuration instructions.
Required Plugins
1. Procedural Content Generation Framework
Status: Built-in (included with UE5.4)
Purpose: Procedural placement of buildings, props, vegetation, and other content.
Installation:
- Edit > Plugins
- Search for "Procedural Content Generation Framework"
- Enable the plugin
- Restart editor
Configuration:
- No additional configuration required
- Create PCG graphs in Content Browser
- See
docs/PCG_WORKFLOW.mdfor usage
Usage:
- Building placement
- Road props (lamp posts, barriers)
- Vegetation placement
- Traffic generation
2. Virtual Production Tools
Status: Built-in (included with UE5.4)
Purpose: Cinematic tools, camera systems, and virtual production features.
Installation:
- Edit > Plugins
- Search for "Virtual Production Tools"
- Enable the plugin
- Restart editor
Configuration:
- No additional configuration required
- Use Sequencer for cinematics
- Use Cine Camera Actors for shots
Usage:
- Cinematic sequences
- Camera systems
- Virtual production workflows
3. Movie Render Queue
Status: Built-in (included with UE5.4)
Purpose: High-quality offline rendering for 8K cinematics.
Installation:
- Edit > Plugins
- Search for "Movie Render Queue"
- Enable the plugin
- Restart editor
Configuration:
- Window > Movie Render Queue
- Create render presets
- Configure output settings (8K EXR, 4K MP4)
- See
docs/CINEMATIC_PIPELINE.mdfor details
Usage:
- 8K EXR cinematic rendering
- 4K MP4 output
- Additional render passes (motion vectors, depth, normals)
Optional Plugins
4. OpenXR
Status: Built-in (included with UE5.4)
Purpose: VR support for immersive exploration (optional).
Installation:
- Edit > Plugins
- Search for "OpenXR"
- Enable the plugin
- Restart editor
Configuration:
- Requires VR headset (Meta Quest, HTC Vive, etc.)
- Configure VR settings in project settings
- See
docs/VR_SETUP.mdfor details
Usage:
- VR exploration mode
- Immersive experience
- Optional feature for demo
5. Houdini Engine
Status: External (requires Houdini installation)
Purpose: Import Houdini Digital Assets (HDAs) for procedural generation.
Installation:
- Install Houdini (SideFX)
- Edit > Plugins
- Search for "Houdini Engine"
- Enable the plugin
- Configure Houdini installation path
- Restart editor
Configuration:
- Set Houdini installation path in plugin settings
- Verify Houdini Engine version compatibility
- See
docs/HOUDINI_PIPELINE.mdfor workflow
Usage:
- Import Houdini HDAs
- Procedural building generation
- Road network generation
- Terrain sculpting
Requirements:
- Houdini installed on system
- Compatible Houdini version (check UE5.4 compatibility)
6. Datasmith
Status: Built-in (included with UE5.4)
Purpose: Import CAD and architectural data.
Installation:
- Edit > Plugins
- Search for "Datasmith"
- Enable the plugin
- Restart editor
Configuration:
- No additional configuration required
- Use Datasmith exporter from source software
- Import .udatasmith files
Usage:
- Import architectural CAD data
- Import building models from Revit, SketchUp, etc.
- Convert to Unreal format
Third-Party Plugins (Optional)
7. Runtime Virtual Texturing
Status: Built-in (included with UE5.4)
Purpose: Virtual texturing for large worlds (optional optimization).
Installation:
- Edit > Plugins
- Search for "Runtime Virtual Texturing"
- Enable the plugin
- Restart editor
Configuration:
- Set up virtual texture volumes
- Configure texture streaming
- See Unreal documentation for details
Usage:
- Large world texture optimization
- Reduced memory usage
- Optional performance optimization
Plugin Management
Enabling/Disabling Plugins
- Edit > Plugins
- Search for plugin name
- Check/uncheck to enable/disable
- Restart editor if required
Plugin Dependencies
Some plugins have dependencies:
- Movie Render Queue may require Virtual Production Tools
- OpenXR requires VR hardware
- Houdini Engine requires Houdini installation
Plugin Updates
- Plugins are updated with engine updates
- Check Epic Games Launcher for engine updates
- Third-party plugins may require separate updates
Validation
Plugin Verification
After enabling plugins, verify:
- No Errors: Check for plugin errors in Output Log
- Features Available: Verify plugin features are accessible
- Performance: Ensure plugins don't cause performance issues
- Compatibility: Verify plugin compatibility with UE5.4
Testing Plugins
- PCG: Create a test PCG graph
- Movie Render Queue: Test render a simple sequence
- Houdini Engine: Import a test HDA (if using)
- OpenXR: Test VR mode (if using)
Troubleshooting
Plugin Won't Enable
- Solution: Check plugin compatibility with UE5.4
- Solution: Verify plugin is not conflicting with other plugins
- Solution: Check for plugin updates
- Solution: Restart editor
Plugin Causing Errors
- Solution: Check Output Log for error messages
- Solution: Disable plugin and re-enable
- Solution: Update plugin or engine version
- Solution: Check plugin documentation
Plugin Not Working
- Solution: Verify plugin is properly installed
- Solution: Check plugin settings/configuration
- Solution: Review plugin documentation
- Solution: Check for known issues in plugin forums
Plugin List Summary
Required Plugins
| Plugin | Status | Purpose |
|---|---|---|
| Procedural Content Generation Framework | Built-in | Procedural content placement |
| Virtual Production Tools | Built-in | Cinematic tools |
| Movie Render Queue | Built-in | 8K cinematic rendering |
Optional Plugins
| Plugin | Status | Purpose |
|---|---|---|
| OpenXR | Built-in | VR support |
| Houdini Engine | External | Houdini integration |
| Datasmith | Built-in | CAD import |
| Runtime Virtual Texturing | Built-in | Texture optimization |
Version: 1.0 Last Updated: [Current Date]