Skip to content

Project settings ​

This chapter lists everything that has to be set up once per project. It is best to complete these steps right after installing the package and before opening the demo maps, so you can see the examples exactly as intended. Most of the changes require restarting the editor.

Required plugins ​

Fluid Flux depends on several engine plugins. All of them ship with Unreal Engine – nothing needs to be downloaded, the plugins only need to be enabled:

  1. Open your project and go to Edit → Plugins.
  2. Type the plugin name in the search field at the top of the window.
  3. Check the Enabled box next to the plugin (confirm the beta warning if it appears).
  4. Repeat for every plugin from the table below, then click Restart Now – the editor must be restarted before the plugins become active.

PluginUsed forDescription
FabInstallationLets you browse your Fab library inside the editor and add Fluid Flux to the project. See Installation.
Python Editor Script Plugin (PythonScriptPlugin)Editor toolsRuns the Python scripts behind the editor tools, e.g. OpenSurfaceEditorTab used for editing color presets.
Editor Scripting UtilitiesEditor toolsGives the Fluid Flux editor utility widgets and tools access to assets and actors in the editor, e.g. EUW_FluxBuoyancyEditor or saving baked states and data assets.
Geometry Script (GeometryScripting)Mesh generatorUsed by BP_FluxSurfaceMeshGenerator to bake the simulation surface into an optimized static mesh. Works in the editor only.
Procedural Mesh ComponentProcedural meshesGenerates procedural meshes used by the surface and the editor tools.
NiagaraEffects and readbackReads fluid data back from the GPU (swimming, buoyancy, audio), renders the infinite surface grid and drives the particle effects (bubbles, splashes, plants, rain).

Rendering settings ​

Make sure that the following project settings are configured:

SettingValueDescription
DBufferEnabledIt’s required for proper decal rendering (wetness and caustics). If you don’t want to use those effects, you can disable the decal material in the surface actor.
CustomDepth-Stencil PassEnabledThis feature is required to render underwater depth maps.
Velocity PassWrite During Base PassThis feature improves the motion vector rendering.
Default Renderer Motion VectorPreciseThis feature improves the motion vector rendering.
Mask material only in early Z-passFalseRequired for proper tunnel capturing.
HighQualityTranslucencyReflectionsDisabledThis option can cause a crash when used in conjunction with the substrate.
(config) r.OIT.SortedPixelsDisabledThis option may cause wrong translucent sorting in underwater materials.
(console) r.HairStrands.ComposeAfterTranslucency0Only if you plan to use a grooming system (such as hair) in your project. Ensures the post-process runs after the grooming materials are finished.
Shadow Map MethodVirtual Shadow MapsShadows on water may look a bit blocky. This is a limitation of the single-layer water material in Unreal (improved in UE5.3). Virtual Shadow Maps together with the three settings below make them look better.
(config) r.Water.SingleLayer.DepthPrepass1Add to DefaultEngine.ini – improves shadows on water.
(config) r.Water.SingleLayer.ShadersSupportVSMFiltering1Add to DefaultEngine.ini – improves shadows on water.
(config) r.Water.SingleLayer.VSMFiltering1Add to DefaultEngine.ini – improves shadows on water.

Real-time viewport ​

Ensure that Real-time rendering is active in your viewport, as it is required to simulate fluid motion in the editor.