Riverology - Setup
Get Riverology up and running in your Unreal Engine project with this comprehensive setup guide.
Prerequisites
| Requirement | Details |
|---|---|
| Unreal Engine | UE5.x (latest release) |
| Operating System | Windows with DirectX 12 capable GPU (GTX 1080 / RTX 3060+) |
| Shader Model | SM6 support recommended |
| Optional | Mesh Distance Fields for shoreline effects |
Use spline points to shape your river. Adjust flow, width, and foam per-segment for varied river characteristics.
Installation Steps
Step 1: Install the Plugin
Install from the FAB Marketplace into your Engine, or copy the plugin folder into <Project>/Plugins/.
If you manually copied files, restart the editor to load the plugin.
Step 2: Enable the Plugin
- Open Edit → Plugins
- Search for Riverology
- Enable the plugin and accept the restart prompt
- After restart, confirm no missing dependencies in Output Log
Step 3: Configure Project Settings
Navigate to Edit → Project Settings and configure:
Required Settings
| Category | Setting | Value |
|---|---|---|
| Platforms → Windows | Default RHI | DirectX 12 |
| Platforms → Windows | D3D12 Shader Model 6 | ✅ Enabled |
| Engine → Rendering | Generate Mesh Distance Fields | ✅ Enabled |
Recommended Settings
| Category | Setting | Value |
|---|---|---|
| Engine → Rendering | Global Illumination | Lumen |
| Engine → Rendering | Reflections | Lumen |
| Engine → Rendering | Shadow Map Method | Virtual Shadow Maps |
Step 4: Open a Demo Map
Verify the installation:
- Open Content Drawer
- Navigate to Plugins → Riverology → Maps
- Open Riverology Demo Map
- Wait for shaders to compile
Step 5: Place the River Spline
Add a river to your own level:
- Open Place Actors panel
- Search for Riverology Spline
- Drag it into your level
- Click to add spline points and shape your river
For expansive maps, use World Partition for optimal streaming performance.
Step 6: Apply Material Instance
Configure the water's appearance:
- Select the river spline actor
- Locate the Material section in Details
- Use the provided material instance
- Customize flow speed, foam, and water color
Step 7: Add Interactions
Enhance your river with gameplay features:
| Feature | Purpose |
|---|---|
| Collision | Enable for physical interaction |
| Niagara Systems | Add splash and foam effects |
| Audio Cues | Water flow and ambient sounds |
Step 8: Test Your Setup
- Save your level (Ctrl+S)
- Click Play In Editor
- Verify the river renders correctly
- Test flow direction and water effects
Troubleshooting
Pink/Preview Materials Shaders are still compiling. Wait for compilation to complete.
No Shoreline Foam Enable Generate Mesh Distance Fields in Project Settings.
DX12/SM6 Errors Verify Project Settings and restart the editor.
Low Performance
- Disable debug views
- Reduce complexity settings
- Profile GPU with
stat gpu
Next Steps
| Guide | Learn About |
|---|---|
| Buoyancy | Add floating objects with flow forces |
| Swimming | Implement character swimming |
| Surface | Configure water rendering |
| Foam | Set up dynamic foam effects |