Log inGet started
Package

waterfx.effect

README.md

waterfx: Tidewater water effects

Every small water effect of the Tidewater kit, each drawn in any of the five Tidewater looks (look input: realistic, painted, cartoon, lowpoly, pixel). Particles are GPU-simulated (sim.particles) and drawn as instanced cards through shaders/fx_particle, which stands each card facing the camera, streaked along its velocity, or flat on the water.

Entries (one-shots finish by themselves; continuous ones run until stopped):

  • plop (a pebble): a small crown of droplets, a centre jet, a ring. Input size.
  • body (a person jumping in): wide crown, tall column, spray puffs, foam patch, three rings. size.
  • droplets: a burst of droplets thrown along dir. size, dir.
  • spray: one gust of spray blown downwind. size, wind.
  • bow: continuous bow spray off both sides of a hull. at, dir, speed, width.
  • spindrift: continuous spray torn off crests by the wind. at, wind, width, rate.
  • mist: continuous rising mist with sunlit sparkles (waterfalls). at, width, rate, rise, wind, sparkle.
  • drips: continuous drips from an edge with tiny plops and rings below. at, width, fall, rate.
  • bubbles: continuous rising, wobbling bubbles that stop at the surface. at, depth, rate, width, size.
  • wake: a V of foam laid on the water behind a mover, fading over fade s. at, dir, speed, width, fade.

Looks: realistic draws lit water beads with sun glints and soft scattering spray; painted draws brush-wobbled dabs in colour bands with paper grain; cartoon draws solid white blobs with an inked outline and a hard highlight; lowpoly draws flat-shaded octahedron droplets and hexagonal faceted puffs and foam; pixel draws square-pixel sprites in two tones with a stepped fade.

Gameplay plays these through tidewater.modules.fx (Fx.splash, Fx.emitter, Fx.mist, the Wake and Splashes components), which also rings the water and syncs splashes to every peer. fx_graph.module holds the drawing helpers the graphs share.