Umi Water — FAQ
Answers for Umi Water, Umi Water Pro and Umi Boat Physics. Run Window > Umi Water > Setup Check first: it finds most of these problems and fixes them with a button.
The water looks wrong
The water is pink, invisible, or has no refraction. URP only. In every URP asset turn on Depth Texture and Opaque Texture (and do not turn them off on the camera), and turn off URP Compatibility Mode (Project Settings > Graphics > Render Graph). The Setup Check lists each of these as an Error with a Fix button.
It does not look like the screenshots: flat, no reflections. Water quality follows the active Quality Settings level. With an Android or iOS build target the editor's Play uses the mobile level, which is Low (no refraction, no SSR, no caustics). Check Water Quality in the Water Surface inspector, switch the build profile to desktop, or use Preview to see another level; the Setup Check also tells you when Play is Low. The screenshots also use the samples' sky and post processing. For reflections add a baked Reflection Probe (or Pro's WaterPlanarReflection).
The water disappears for a few seconds after I change the quality or a shader. The editor compiles the new shader variant in the background. Wait a moment; a player does not do this.
Glass, particles or my transparent shader look wrong in or under the water. The water refracts the opaque scene only: transparent objects are not seen through the surface and get no underwater fog. Draw them after the water (render queue) or make them opaque / alpha-tested.
Water shows inside my boat's cabin. Add a WaterMask with a closed mesh that fills the cockpit. Physics ignores the mask.
The material cannot be edited. Package materials are read-only. A Look Preset saves a copy in your project; or make your own material with the Umi/Water (or Umi/Water Pro) shader.
Waves climb the beach and bare the sea floor. Core's waves do not know the depth. Use lower waves or a steeply dropping floor (the samples' … (Coast) profiles), or Umi Water Pro's WaterShore: waves fade in shallow water and shore waves break.
Floating objects and boats
My object sinks, shoots out of the water, or keeps bobbing. Density below 1000 floats. With Mass From Density off, the Rigidbody's mass must match the volume. Raise Resolution for long or tilted shapes. Bobbing dies out in 2–3 swings by default (Radiation Damping); raise Water Linear / Angular Damping to settle faster. Make sure the collider is not a trigger and the Rigidbody is not kinematic.
In the editor my hull works, in a build it is a box. Turn on Read/Write in the mesh's import settings (the Setup Check has the button). Without it a player cannot read the mesh and uses its bounds.
My boat or character makes no waves, only foam. Ripples and wake waves on the surface are Umi Water Pro (WaterRipples). Umi Water and Boat Physics alone give foam and spray.
No foam, spray or splash. Add one Water Particles to the scene and tag the camera MainCamera. Foam is drawn within about 64 m of that camera, and a splash needs an entry faster than 2 m/s.
Code
How do I know whether the player or camera is under water? How do I get the water height?
if (WaterSurface.TrySampleAny(p, out WaterSample s, out _)) bool under = p.y < s.Height;
It works with every wave model; for many points use WaterSurface.SampleAny. Never read the mesh or the shader. More in Scripting.
Multiplayer: the same waves on every client? A dedicated server? Push the server's time with WaterTime.Push. A headless server (-nographics) has no GPU: Gerstner waves are complete there; the FFT ocean and ripples are not simulated. Water forces run in FixedUpdate only (not inside your own Physics.Simulate). Ripples, foam and the particle fluid are local to each client.
Does it support floating origin? Can I rotate or scale the water? No floating origin: the waves are tied to world X / Z. Rotate the water around Y only and set its Size instead of scaling (the Setup Check fixes tilt and scale).
Platforms
HDRP, Built-in, VR / XR? URP only (Unity 6000.0+, URP 17.0+). XR is not supported.
On my phone the ocean is gone, or it is slow. Umi Water Pro's FFT ocean and ripples are off on Android / iOS unless you turn on Allow On Mobile, and they do not run on WebGL or OpenGL ES 3. Phones run Umi Water (Core) at Low quality; the URP Render Scale is the biggest lever. A cheap phone runs the water at Low only.
It is slow. On an RTX 4070 SUPER at 1080p, High quality, the water's forward pass measured 0.24–0.35 ms (Umi Water) and 0.33–0.60 ms (Pro) in our test scenes; Pro's extras (SSR, caustics, light shafts) add 0.02–0.3 ms each. Planar reflection renders the scene a second time and costs more. Switch to Medium or Low, lower the mesh Resolution / raise Cell Size, and turn off what you do not need. These are measurements of our scenes, not a promise for yours.
Pro: shores and rivers
The game freezes when I move or raise the water (a tide, a lock). A WaterShore map is baked from the ground, and moving the water bakes it again (about 0.15 s in the Shoreline sample). The game warns once and the inspector shows how often. Keep the water still, or disable WaterShore on water that moves all the time. Bake in the editor saves the map next to the scene, so loading it does not bake.
A river has no bank, or water shows on the land. The banks must be ground (colliders) above the water's surface. Rivers need a WaterShore on the surface (adding a WaterRiver adds one).
Install and updates
Package Manager cannot install Umi Water Pro or Umi Boat Physics (a missing dependency or an Asset Store entitlement). Both need the free Umi Water. Add Umi Water to your assets on the Asset Store, refresh My Assets in Package Manager, install Umi Water, then the add-on.
I get compile errors in Pro or Boats after an update. Update all Umi packages together: the add-ons work only with Umi Water of the same version. Umi Water names the mismatch in one console error and in the Setup Check.
The Welcome window does not list the sample scenes. Import them first: Welcome > Import samples, or Package Manager > the package > Samples > Import. Samples land in Assets/Samples/Umi …/<version>/. A sample looks dark or the sky is black when its Common sample is missing (importing any Umi sample imports it).
Samples do not compile. They use the Input System package or the old Input Manager (both are handled); import Common before the other samples.