Umi Water — samples
How to start, then what each sample shows. The first steps with your own scene are in Getting started; trouble — FAQ.
1. Which samples you get
11 scenes in four samples: Package Manager > the package > Samples > Import (or Welcome > Import samples); they land in Assets/Samples/<package>/<version>/. Umi Water's Common sample holds the free camera, the sample look (sky, post), the lit materials, the sounds and tuned PC / Mobile URP assets every scene uses: importing any other Umi sample imports it too. Each folder has its own assembly: a Core-only project compiles the Core samples without Pro or Boats.
| Module | Scene | Shows | Start here if you want |
|---|---|---|---|
| Common | — | FreeCamera, SampleLook, DemoSpawner, WaveProfileSwitcher, materials, sky | (imported with any sample) |
| Core | IslandLake | island, lake and infinite sea, voxel floaters | the first look at the asset |
| Core | WaveProfiles | Gerstner waves, three profiles, floaters, buoys | tune waves, see buoyancy |
| Core | FloatingObjects | floaters of different density, beach, a wader | buoyancy on your own objects |
| Core | Underwater | underwater fog, a boat with a WaterMask cockpit | a camera below the surface |
| Pro | OpenOcean | FFT ocean, four sea states | a realistic ocean |
| Pro | RiverAndLake | spline river, waterfall, rapids, muddy water, sound | rivers |
| Pro | InteractiveRipples | ripples from a swimmer and thrown objects | characters in water |
| Pro | UnderwaterEffects | caustics, light shafts, particles, lens drops | underwater look |
| Pro | Reflections | screen-space + planar reflection (P) | reflections |
| Pro | Shoreline | waves fading on a beach, shore waves, foam | beaches |
| Boats | BoatSeaTrial | drivable speedboat, mesh vs voxel hulls | boats |
Requirements: Unity 6000.0+, URP with Depth Texture and Opaque Texture on (Window > Umi Water > Setup Check fixes it), the Input System or the old Input Manager (both work). Pro's FFT ocean and ripples need compute shaders: desktop, not WebGL / GLES3; on phones they are off by default (Allow On Mobile).
2. Controls (every scene)
| Key | Does | Where |
|---|---|---|
| RMB + mouse | look | every scene (free camera) |
| W A S D, Q / E, Shift | move, down / up, fast | free camera |
| F | throw a floating object from the camera | every scene (in BoatSeaTrial it is a mesh-model object) |
| 1 2 3 (4) | switch wave profile / sea state | scenes with a switcher |
| N, B | night (torch); the foam's bioluminescence (on its own) | IslandLake |
| P | planar reflection on / off | Reflections |
| G | drop an object at the river's source | RiverAndLake |
| ↑ ↓ ← → (W S A D) | throttle / steer | BoatSeaTrial (WASD only while the free camera is off) |
| X, R, C | engine idle, reset boat, chase / free camera | BoatSeaTrial |
The sample panels and labels are drawn with IMGUI (OnGUI), which allocates garbage every frame: it is fine for a demo, not a pattern to copy into a game (use uGUI or UI Toolkit there). The scene selector in the main toolbar (and Welcome > Open a demo scene…) opens any imported sample.
3. The samples
Format: Hierarchy object → component → the setting that matters (why).
Core
IslandLake — a lake in an island's hills and an infinite sea around it, both on Core's material (Umi/Water).
Sea→WaterSurface(profileCalm, density 1025) +WaterInfinite: water to the horizon; the camera far plane is 20 000 so the sea meets the sky. Keys 2 / 3 loadModerate (Coast)/Storm (Coast)(Samples/Core/Profiles: Steepness Scale 0.5 / 0.35): Core's waves do not fade in shallow water, at full height they climb the beach and bare the sea floor. For a real coast — waves that slow, rise and break — use Pro'sWaterShore(Shorelinesample).Lake→WaterSurface(size 125 × 85, resolution 320 = ~0.4 m cells, profileLake): a finite surface whose edges hide under the ground; resolution = 8 or more cells per shortest wave.Island→DemoTerrain(sample code: a procedural mesh; the sea floor drops steeply off the beach, Sea Floor Slope 0.5),Reflection Probe(baked: reflections of the hills).- Floaters (
Crate,Plank,Log,Ball,Ice,Stone,Boat) →Rigidbody+Buoyancy(Density in kg/m³ decides float or sink: 250 floats high, 917 ice sits low, 2500 sinks). Buoys on the sea. Water Particles→ spray / foam where floaters hit the water. Main Camera →FreeCamera,DemoSpawner,WaveProfileSwitcher,DemoNight.- Try: F (throw), 1 / 2 / 3 (sea waves), N (night), B (the foam's bioluminescence, on its own); fly under the lake and look up.
WaveProfiles — one surface, three Gerstner profiles. Water → WaterSurface (resolution 320; profile Moderate).
WaveProfileassets (Calm,Moderate,Storm) are lists of waves: direction, wavelength, steepness, phase. Open one and edit it in Play: the shader and the physics change together.- Two pillars are fixed references; floaters and a ring of buoys show how a wave passes through a group.
- Try: 1 / 2 / 3 — the buoys' ring heaves; watch the crate and the boat pitch.
FloatingObjects — flat water, a tilted beach, floaters of different density.
Water→WaterSurface(resolution 100: flat water needs no fine grid; no profile = still).Wader→WaterInteractor+DemoWalker: a kinematic capsule that walks through the water; WaterInteractor gives it wake foam, spray and a splash, without making it float (Foam Amount 4, Spray Amount 3: at walking speed the default leaves a dotted trail). In Core it leaves a foam trail only; ripples need Pro (WaterRipples).- Try: the stone sinks, the plank floats flat, the ice sits low; F throws more.
Underwater — Core's underwater fog, no add-on. Shallow seabed with sunken crates and pillars.
Skiff→Buoyancy+WaterMask(mesh = the closed box inside the cockpit): the cockpit floor is below the waterline, and without the mask water would show inside the boat. The mask hides water, not physics.- Try: the Underwater View menus (above, skiff, waterline, below, looking up); fly through the surface with the camera.
Pro
OpenOcean — Ocean → WaterSurface + WaterInfinite + WaterOcean (FFT; Spectrum asset) + WaterEffects.
- Spectra
Sea Calm,Sea Moderate,Sea Storm(JONSWAP, wind 5 / 10 / 15 m/s) andSea Phillips: wind, fetch, choppiness, foam threshold. MaterialOceanhas weak detail normals because the FFT carries the small waves. - Floaters and a line of buoys use Core's
Buoyancy: the same physics code as with Gerstner waves.OceanSpectrumSwitcherblends the change. - Try: 1–4; F (the thrown object splashes:
WaterInteractor);Open Ocean View/Top Down (Levels Of Detail).
RiverAndLake — Water → WaterSurface + WaterShore (water depth baked into a water map asset, so the scene does not bake when it loads) + WaterEffects.
River→WaterRiver(aSplineContainer: select it, Edit Splines; per-knot width / speed / height; Add Branch for a tributary). Steep knots make a waterfall (>45°) or rapids; the current carries floaters and the waves.River Audio(WaterRiverAudio: flow and waterfall loops, sound grows near the river; the clips are placeholders: use your own).Weedy Bay→WaterColorZone; the river'sTurbidity/Water Colorcolour the water where it enters the lake.River Spawnerdrops objects at the source; G drops one more. Boulders catch things.- Try:
River and Lake View/Waterfall,Rapids,River Mouth; edit a knot and let go: the river re-bakes once.
InteractiveRipples — still water: every wave is made by something. Water → WaterSurface (profile Flat) + WaterInfinite + WaterRipples (a height-field simulation around the camera) + WaterEffects.
Swimmer→WaterInteractor+DemoWalker: a kinematic capsule crossing the water, its wake is ripples.- Two rings of floaters (planks, balls, buoys) around the drop zone: rings from a thrown object rock them.
- Try: F at the drop zone, 1–3 (add Gerstner waves under the ripples);
Interactive Ripples View/Swimmer Path.
UnderwaterEffects — the same scene as Underwater with WaterEffects: caustics on the seabed, light shafts, underwater particles, lens drops when the camera leaves the water. The skiff's WaterMask still works with them.
- Try: the Underwater View menus; fly up through the surface (drops on the lens).
Reflections — a row of tall pillars, a jetty, a far island.
- Screen-space reflection and the baked probe are always on.
Water→WaterPlanarReflection(opt-in, per surface) adds what the screen does not show: objects above the top edge, behind the camera. Costs GPU time, off in Low. - Try: P toggles it;
Reflections View/JettyandLow Over The Water.
Shoreline — Water → WaterSurface (profile Moderate) + WaterShore (Shore Adaptation: depth baked from the ground; Shore Waves on: height 0.8 m, period 6 s, start depth 6 m).
- Waves fade in shallow water, a low swell rises, breaks and runs up the beach; foam gathers on the line and around
Shore Rock A / B. The physics sees the same swell (floaters ride it up the beach). - Try:
Shoreline View/Along The Beach; 1 / 2 / 3 (profiles); raiseShore Wave Heightin the inspector.
Boats
BoatSeaTrial — infinite sea, a drivable speedboat on HullHydrodynamics (the mesh model: buoyancy per triangle, planing, drag, wake, spray). Core + Boats only.
Speedboat→Rigidbody,MeshCollider,HullHydrodynamics(Separate Wake on: a long hull is not rocked by its own wake),BoatController(sample code: throttle, steering outboard, propeller thrust only while under water).- Twin hulls and twin boxes ("MESH model" / "VOXEL model", same mass): compare the mesh model with Core's voxel
Buoyancy. Open boat→HullHydrodynamics+WaterMask: an open cockpit without water inside.- Camera →
ChaseCamera(C toggles the free camera),BoatDemoSpawner(F),WaveProfileSwitcher(1–4: flat … storm). - Try: full throttle and turn; drive over the storm waves; reset with R.