Umi WaterOverviewGetting startedSamplesComponentsScriptingFAQLimitsCore vs ProChangelog

Umi Water — getting started

Water for Unity 6000.0+ with the Universal Render Pipeline (URP 17.0+): Gerstner waves, a water surface to the horizon, voxel buoyancy, wake foam and spray, underwater fog. Pro (separate package) adds an FFT ocean, rivers, shores, ripples and more; Boat Physics (separate package) adds hull hydrodynamics. HDRP and the Built-in pipeline are not supported.

1. Install

  1. Asset Store: open Umi Water and press Add to My Assets (it is free).
  2. In Unity: Window > Package Manager > My Assets, find Umi Water, Download, Import.
  3. Umi Water Pro and Umi Boat Physics are separate products that need Umi Water of the same version. Add Umi Water to your assets first (step 1), install it, then install the add-on. If Package Manager reports a missing dependency (dev.fatalbug.water) or an Asset Store entitlement for the add-on, Umi Water is not in your assets yet: do step 1, press the refresh button in My Assets, and install Umi Water before the add-on.
  4. Update all Umi packages together. When one is a different version, Umi Water names it in one console error and in the Setup Check.

Unity 6000.0 or newer. The packages touch nothing outside themselves: they are read-only in the Package Manager. To customize a material, use Look Preset (it saves a copy in your project) or make your own.

2. Check the project

Open Window > Umi Water > Welcome: it is the start page (fix the project, create water, pick a look, open a demo scene, see what is new). Window > Umi Water > Setup Check lists what the water needs from the project and the open scenes and fixes most of it with a button. The one thing to know: in every URP asset turn on Depth Texture and Opaque Texture (Opaque Downsampling: None); a camera must not turn them off. The Setup Check does it with one button.

3. First water

  1. GameObject > Umi Water > Lake (a finite surface) or Ocean (open sea to the horizon: it adds WaterInfinite). It is a WaterSurface with the Umi Water material and a wave profile.
  2. GameObject > Umi Water > Floating Object: a cube with a Rigidbody and Buoyancy. Press Play: the cube floats.
  3. GameObject > Umi Water > Water Particles, once per scene, for splash and wake foam. Tag the camera MainCamera: the foam is drawn around it.
  4. Pick a look with Look Preset in the WaterSurface inspector (Default, Clear Lake, Tropical, Deep Ocean, Murky, Stylized). The waves come from the surface's Profile (WaveProfile asset: Calm, Moderate, Storm …).
  5. Quality is not set on the surface: the water follows the active Quality Settings level (the lowest third of the levels is Low, the middle Medium, the rest High). The WaterSurface inspector previews a level in the editor, and WaterQuality.Override fixes one from code. Physics is the same at every level.

For the open sea keep the camera's far plane far enough for the horizon (for example 20 000 m).

Float your own object

Add a Collider (any: the voxels are built from it), a Rigidbody and Buoyancy; set Density (kg/m³: wood 400–700, ice 917, a rock above 1000 sinks). A character, paddle or kinematic object that should make waves but not float gets a WaterInteractor instead (foam, spray, splash; ripples with Pro).

Read the water height from your code

using FatalBug.Water;

if (WaterSurface.TrySampleAny(transform.position, out WaterSample sample, out WaterSurface surface))
{
    float height = sample.Height;       // world Y of the water at this point
    Vector3 normal = sample.Normal;
    Vector3 velocity = sample.Velocity; // surface velocity (current, wave motion)
    bool under = transform.position.y < height;
}

It works with every wave model (flat, Gerstner, FFT, shore waves, river) and returns false where there is no water. More in Scripting.

4. Umi Water Pro

Pro components are extensions of a WaterSurface (Add Extension in its inspector, or Add Component > Umi Water > Pro). Adding one to a surface with the Umi Water material switches the material to Umi/Water Pro (Ctrl+Z takes it back).

Details of every component — Umi Water Pro components.

5. Umi Boat Physics

Put your hull mesh on a MeshFilter with a convex MeshCollider, add a Rigidbody and HullHydrodynamics (use it instead of Buoyancy). Turn on Read/Write in the mesh's import settings, or a build uses the hull's bounding box (the Setup Check says so). A closed, watertight hull works best; an open hull (a cockpit) needs a closed proxy for physics and a WaterMask so the water does not show inside. Umi Boat Physics components.

6. Phones and WebGL

Use Umi Water (Core) there: Pro's FFT ocean and ripples need compute shaders, so they are off on WebGL and GLES3, and on Android / iOS unless you turn on Allow On Mobile. Water is Low quality on the Mobile level of the URP template. Lower the URP Render Scale first: it is the biggest lever on a phone. Post processing off.

7. Multiplayer: the same waves for everyone

The wave clock is WaterTime. Push a provider that returns the server's time (WaterTime.Push(provider); WaterTime.Smoothed(provider) removes network jitter; WaterTime.Offset is a shared start phase) and every client sees and floats on the same waves. WaterTimeHold freezes the water (pause, replay scrubbing). Never use Time.time for waves. A server without a GPU (-nographics) has complete Gerstner waves; the FFT ocean and ripples are not simulated there. Water forces run in FixedUpdate only.

Next

If Umi Water helps your project, a review on the Asset Store helps other developers find it.

Samples · Components · Scripting · FAQ · Limits · Core vs Pro