Oceanology Legacy - Setup
Get Oceanology Legacy up and running in your Unreal Engine project with this comprehensive setup guide.
Prerequisites
Before you begin, ensure you have:
| 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 for advanced features |
| Optional | Mesh Distance Fields for shoreline effects |
Oceanology Legacy focuses on classic ocean rendering with streamlined settings, optimized for performance across a wide range of hardware.
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 Oceanology Legacy
- Enable the plugin and accept the restart prompt
- After restart, confirm there are no missing dependencies in the Output Log
Step 3: Configure Project Settings
Navigate to Edit → Project Settings and configure the following:
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 by opening a demo map:
- Open Content Drawer
- Navigate to Plugins → Oceanology Legacy → Maps
- Open Legacy Example Map
- Wait for shaders to compile
This step ensures all assets load correctly and shaders compile for your system.
Step 5: Place the Ocean
Add the ocean to your own level:
- Open Place Actors panel
- Search for Legacy Ocean
- Drag it into your level
- Scale and position to cover your playable area
For expansive maps, use World Partition for optimal streaming performance.
Step 6: Apply Material Instance
Configure the water's appearance:
- Select the ocean actor
- Locate the Material section in Details
- Use the provided material instance from plugin content
- Customize:
- Wave height and length
- Foam thresholds
- Normal intensity
- Water color and transparency
Step 7: Add Interactions
Enhance your ocean with gameplay features:
| Feature | Purpose |
|---|---|
| Collision | Enable if gameplay requires physical interaction |
| Niagara Systems | Add splash and foam particle effects |
| Audio Cues | Implement wave and ambient ocean sounds |
Step 8: Test Your Setup
- Save your level (Ctrl+S)
- Click Play In Editor
- Verify the ocean renders correctly
- Test camera movement above and below water
Troubleshooting
Pink/Preview Materials Shaders are still compiling. Wait for compilation to complete - check the progress in the bottom-right corner of the editor.
No Shoreline Foam Enable Generate Mesh Distance Fields in Project Settings and ensure distance fields are built for your landscape and static meshes.
DX12/SM6 Errors Verify Project Settings are configured correctly and restart the editor after changes.
Low Performance
- Disable expensive debug views
- Reduce wave/spectrum layers
- Profile GPU usage with
stat gpu - Update graphics drivers
Next Steps
Now that Oceanology Legacy is set up, explore these features:
| Guide | Learn About |
|---|---|
| Waves | Configure Gerstner wave parameters |
| Buoyancy | Add floating physics to objects |
| Swimming | Implement character swimming |
| Underwater | Set up underwater effects |