277 lines
6.3 KiB
Markdown
277 lines
6.3 KiB
Markdown
# 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**:
|
|
1. **Edit > Plugins**
|
|
2. Search for "Procedural Content Generation Framework"
|
|
3. Enable the plugin
|
|
4. Restart editor
|
|
|
|
**Configuration**:
|
|
- No additional configuration required
|
|
- Create PCG graphs in Content Browser
|
|
- See `docs/PCG_WORKFLOW.md` for 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**:
|
|
1. **Edit > Plugins**
|
|
2. Search for "Virtual Production Tools"
|
|
3. Enable the plugin
|
|
4. 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**:
|
|
1. **Edit > Plugins**
|
|
2. Search for "Movie Render Queue"
|
|
3. Enable the plugin
|
|
4. Restart editor
|
|
|
|
**Configuration**:
|
|
1. **Window > Movie Render Queue**
|
|
2. Create render presets
|
|
3. Configure output settings (8K EXR, 4K MP4)
|
|
4. See `docs/CINEMATIC_PIPELINE.md` for 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**:
|
|
1. **Edit > Plugins**
|
|
2. Search for "OpenXR"
|
|
3. Enable the plugin
|
|
4. Restart editor
|
|
|
|
**Configuration**:
|
|
- Requires VR headset (Meta Quest, HTC Vive, etc.)
|
|
- Configure VR settings in project settings
|
|
- See `docs/VR_SETUP.md` for 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**:
|
|
1. Install Houdini (SideFX)
|
|
2. **Edit > Plugins**
|
|
3. Search for "Houdini Engine"
|
|
4. Enable the plugin
|
|
5. Configure Houdini installation path
|
|
6. Restart editor
|
|
|
|
**Configuration**:
|
|
- Set Houdini installation path in plugin settings
|
|
- Verify Houdini Engine version compatibility
|
|
- See `docs/HOUDINI_PIPELINE.md` for 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**:
|
|
1. **Edit > Plugins**
|
|
2. Search for "Datasmith"
|
|
3. Enable the plugin
|
|
4. 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**:
|
|
1. **Edit > Plugins**
|
|
2. Search for "Runtime Virtual Texturing"
|
|
3. Enable the plugin
|
|
4. 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
|
|
|
|
1. **Edit > Plugins**
|
|
2. Search for plugin name
|
|
3. Check/uncheck to enable/disable
|
|
4. 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:
|
|
|
|
1. **No Errors**: Check for plugin errors in Output Log
|
|
2. **Features Available**: Verify plugin features are accessible
|
|
3. **Performance**: Ensure plugins don't cause performance issues
|
|
4. **Compatibility**: Verify plugin compatibility with UE5.4
|
|
|
|
### Testing Plugins
|
|
|
|
1. **PCG**: Create a test PCG graph
|
|
2. **Movie Render Queue**: Test render a simple sequence
|
|
3. **Houdini Engine**: Import a test HDA (if using)
|
|
4. **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]
|
|
|