Please disclose if any significant portion of your mod was created using AI tools by adding the 'AI Generated' category. Failing to do so may result in the mod being removed from Thunderstore.
Straumr
Living water: flowing rivers with a surface that moves, white-water rapids, sea currents, tides that rise and fall, whirlpools, seasons and snowmelt, and an API for other mods. Works on its own; detects Riverheim and Rivers and Lakes. Beta.
| Date uploaded | 2 weeks ago |
| Version | 0.1.2 |
| Download link | Wackah-Straumr-0.1.2.zip |
| Downloads | 317 |
| Dependency string | Wackah-Straumr-0.1.2 |
This mod requires the following mods to function
denikson-BepInExPack_Valheim
BepInEx pack for Valheim. Preconfigured with the correct entry point for mods and preferred defaults for the community.
Preferred version: 5.4.2360README
Straumr
Living water for Valheim. Rivers flow downstream, rapids run white, the sea has currents and tides, and whirlpools turn off the ends of tidal straits. Swimmers, boats and floating things all ride it.
Straumr is Old Norse for "current". This is a beta (0.1): it works, it's been played on, and it's still being tuned. Feedback welcome.
New in 0.1.2
- Truer river flow: far fewer spots where water pours out of a point or vanishes into one (see How it was checked); lakes now drain through their real way out; the long way round a loop, or a lake's second way out, drifts along instead of standing dead.
- Ripples that move with the current: a thin sheet on the water carries ripples and sun glints along with the current. New, and still being tuned (see The water's surface below).
- Foam fades where it meets a bank or a rock instead of ending on a hard line.
- Rocks bend the current by the part of them that's in the water, not by their whole size: a big rock leaning on a bank no longer stills the river across all of it.
- Wind drifts lakes and broad slow reaches too, not only the sea, and a storm pushes harder than a breeze (
[Currents] StormDrift). - Storm surge: a storm raises the sea a little on top of the tide, up to 0.3 m in a full storm (
[Currents] StormSurge). - Waves carry floating things the way they run, turning in toward the beach over the shallows, so with the wind onshore driftwood, wreckage and felled logs wash up (
[Currents] WaveDrift). - Felled logs float and drift with the current and the waves: timber can be floated down a river (
[Currents] LogDrift). - Wading: the current pushes you downstream as you wade, more the deeper and faster it runs (
[Currents] Wading). - Undertow: where a river runs fast and smooth through a deep, narrow slot, it now and then pulls swimmers under for a moment (
[Currents] Undertow). - Swimming effort, optional and off by default:
[Currents] SwimWithCurrentandSwimAgainstCurrentmake swimming with or against the current cost less or more stamina. - A boat left to drift in a river slowly swings round to lie along the current (
[Currents] BoatYaw). - A boat left empty (not moored) rides as if at anchor: it stops where it was left, swings a couple of metres either way, and in a river turns to lie along the current; board it and it's free (
[Currents] AnchorEmptyBoats). - Steering in a bend is easier: the current's turn on a boat is halved while someone is at the helm.
- Boat speed under the minimap while you're aboard: through the water, over the ground, and what the current adds or takes (
[Hud] BoatSpeed). - Fixed: in a blow, the current dropped out on every wave crest more than 30 cm above the still sea (Straumr took the crest for another mod's water). Swimmers, boats, floating things and foam lost the current there, and the API's
StraumrApi.Velocityread zero. - River sound starts at slower water and grows fuller the deeper the river, so a big river sounds like one.
straumr herenames the nearest rocks, logs, posts or walls bending the current where you stand.
What it does
Rivers
- Every river flows from source to mouth, faster where it narrows, slow where it widens into a lake, and slower near the banks than mid-stream. Creeks run about 1 m/s and great rivers about 1.3 m/s (you swim about 2).
- Water slides along the banks and round islands instead of running into them, and carries on out past a river's mouth before it fades.
- Where several rivers share the same water (Riverheim often runs a few through one channel, sometimes in opposite directions), that water gets one way down: its shortest way to the sea. Rivers keep the direction Riverheim drew unless the other way is less than half as long, so they rarely run back toward the hills.
- A river that ends in a lagoon or bay runs out through it to the sea.
- White water where fast water runs shallow, worked out from the Froude number (how fast the water runs for how deep it is), the way real rapids form. White water shoves swimmers about, now and then pulls them under for a moment, and wears them out.
- Undertow: where a river runs fast through a slot, a channel deep for its width, its surface stays smooth while the water below now and then pulls a swimmer under for half a second or so, with at least 15 s between pulls in the worst slot (40 s in a mild one). Only true slots: from three times as wide as deep, 2 m deep and 1 m/s, in full at one and a half times as wide as deep, 3 m deep and 2 m/s. It fades out as the water turns white, which handles swimmers its own way. It costs no stamina and never takes anyone more than 1.5 m below where they swim.
- Wading: walking in a current over your ankles, the water pushes you downstream, more the deeper it is and with the speed squared. At a usual river's 1.2 m/s your feet hold up to about 0.6 m deep, and a metre deep carries you about 0.2 m/s; in a 2 m/s run, half a metre deep carries you 0.2 m/s and three quarters of a metre 0.6 m/s. Walking upstream is slower going. It never takes more than half your slowest walking pace, so you can always walk out.
- Swimming costs the usual stamina whichever way you swim, as in real water: the current changes where a stroke takes you, not what it costs.
SwimWithCurrentandSwimAgainstCurrentcan change that (0.85 makes going with a river a little easier, 1.25 fighting it a little harder). - Rocks, logs, posts and walls that break the surface bend the current, with slack water and a small back-eddy behind them; the water stalls against their upstream face. A rock counts only as big as the part of it the water meets at the surface, so a big rock leaning on a bank turns the water round its toe, not across its whole bulk. A stone just under the surface doesn't stop it. A wall or dam across a channel stops the flow, and the water above it lies still.
- Bends push surface water to the outside bank, shallow rivers alternate pools and riffles, and side rivers meet in a swirling seam.
- Weather and seasons: rain swells the creeks first and the big rivers later; a storm swells them more. With Seasonality, spring snowmelt runs high and winter runs low (or freezes, if Seasonality freezes the water).
- Dig a channel below the water line between two waters and the current runs through it.
The sea
- Wind-driven currents run along the coasts, through the sounds and between islands; shallow swamps and marshes stay mostly calm, apart from the wind's drift on their broader pools. Rips run out from open beaches, and longshore drift runs along them.
- Wind drifts the surface of the sea, and of lakes and broad slow reaches too: from about 8 m off the shore, fully from about 60 m out. Running channels don't take it. A storm pushes harder than a breeze.
- Waves carry floating things slowly the way they run: downwind on open water, turning in toward the beach over the shallows, so with the wind onshore driftwood, wreckage and felled logs wash up. In a full gale that's about 0.05 m/s far out, up to 0.3 m/s over about 10 m of water and 0.07 to 0.1 m/s in the last metre or two; a quarter of that at half wind. Small boats with someone aboard take a share of it, a longship none. In a strong wind the shallows turn to surf, which pushes swimmers the way the waves run. None in a river's channel.
- Tides: the sea rises and falls up to 0.6 m either side of its usual level twice a game day (0.8 m at spring tides). Bays behind narrow mouths rise less and later, and their mouths race in and out (about 1.5 m/s, 2 m/s at spring tides). Up river mouths the flood pushes against the river and the ebb speeds it out. Slack water comes at high and low tide, a little later each day, and the moon sets the size: spring tides at full and new moon, gentle neaps between. With Seasonality, each season is one lunar month. A storm raises the sea a little more on top (up to 0.3 m in a full storm), as far up rivers as the tide reaches.
- What Valheim checks against the water follows the tide: swimming, boats, floating things, building damage under water, placing water pieces, fires going out, and creatures deciding where the water is.
- Whirlpools spin up off the ends of tidal straits near the peak of each tide. Mind the eye.
- A line under the minimap tells you the tide near any coast: "Flood tide · full · high water in 6 min · +0.1 m".
The water's surface (new in 0.1.2, still being tuned)
- Ripples and sun glints on the water move with the current. Straumr lays a thin see-through sheet on the water round you, drawn with its own shader: it rises and falls with the game's waves and the tide, and the current carries its ripples along. It only adds glints and the sky's light on the ripples; it paints nothing white. Still water doesn't show it, a slow river (from 0.05 m/s) shows it faintly and water running 0.5 m/s or more shows it in full; on open water in a wind it fades to half, leaving most of the sea to the game's own waves; and it fades out by about 60 m from you.
- The shader is built into
Straumr.dllfor each platform: Windows (which also covers Proton), Linux and Mac. - It switches itself off where it can't run (no shader for your platform, or a graphics card that can't run it), when NorgerWater is installed, while Seasonality has the water frozen, on Rivers and Lakes' water, and toward the Deep North, where the game calms its big waves.
straumr overlayin the console turns it off and on in your game, to compare, and says whether it's on, and why if it couldn't start at all. Its settings are under[Surface].
Life on the water
- Foam shows which way and how fast the water goes: a few scraps on all water (still water too), much more where it runs, shears and meets, in rafts, lace and strands drawn out by the current, and white water with streaks and spray. It fades where it meets a bank or a rock instead of ending on a hard line (
[Flecks] SoftEdges), and[Flecks] Liftsets how high it floats. Rivers murmur, fuller the deeper they run, and rapids roar (sounds made from the physics of bubbles, with no recordings), and mist lies on the water at dawn. - Driftwood washes up in bends, and fish hold in the pools.
- Felled logs float, about two thirds under, and drift with the current and the waves: rolled into a river, a log is carried off downstream, pivoting round an end that grounds and lining up with the stream. Logs don't jam or change the water.
- Boats feel the current while someone's aboard but always keep some headway, and a boat stopped against a bank or dock stays moored.
- A boat left to drift in a river (someone aboard, no one at the helm, sail furled and oars shipped, not moored) slowly swings round to lie along the current, bow or stern downstream, whichever is nearer: across a 1 m/s current it comes round in about half a minute to a minute, quicker in faster water. It fades out on open water.
- A line under the minimap while you're aboard a boat gives its speed through the water and over the ground, and what the current does along its heading: "Boat 2.4 m/s through water", "3.1 m/s over ground", "current +0.7 (helping), running NE", one under the other. The current there is the share of it that carries boats (
[Currents] Boats), so the numbers match what the boat does. Valheim's own boats only, so far. - Ruins and other stonework the world placed don't crumble where a steep world leaves their edge hanging (
[World] StandingRuins).
Works with
Straumr runs on its own, on Valheim's own worlds, and detects these automatically when they're installed. None is required.
- Riverheim: worlds built around big river networks, which Straumr sets flowing.
- Rivers and Lakes: streams, lakes and waterfalls above sea level. Works side by side with Straumr today: Straumr leaves its water to it. With its next update, its streams carry on as jets into still water and its bigger lakes drift with the wind.
- Seasonality: seasons, snowmelt and freezing.
- ValheimRAFT: its vehicles ride the current too.
NorgerWater: when it's installed, Straumr's moving surface switches itself off and leaves the water's surface to it. Straumr hasn't been tested with it in game yet.
For mod makers
Straumr has a public API for other mods (water wheels, mills, fishing, sailing AI, current charts): it reports the water's physical properties and leaves the gameplay to you. StraumrApi.Sample(position) gives the current, depth, tide and more in one call. Soft-depend on wackah.straumr and your mod works with or without Straumr installed. The full guide, with examples and its limits, is API.md in the download.
Multiplayer
Install Straumr on the server and on every player's game. The server's physics settings are sent to everyone who joins, and players get their own back when they leave: all of [Currents] and [Stage], the white-water thresholds (WhiteFroude, WhiteFroudeFull, WhiteMinSpeed) and [World] StandingRuins. How the water looks and sounds stays each player's own choice. Tides run off the server's clock, so everyone has the same tide.
The flow map and seed atlas
straumr atlasin the console (F5) opens a page from your own game athttp://localhost:8765.- Type any seed: your game builds that world in memory (nothing is saved) and shows its rivers, sea currents, tides and whirlpools.
- It starts whole-world, and fills in real detail as you zoom. Press D for a debug view of why the water does what it does at any spot, and T for the tide.
- It shows the whole map, so don't type a seed you want to keep a surprise (or list it in
[Atlas] HiddenSeeds). - Only that page can read it (a key it gets from the game), and it closes a few seconds after you close the page.
straumr mapwrites the world you're in to a file the same page can open.
Console (F5)
| Command | What it does |
|---|---|
straumr here |
the water at your feet, each part of the current (river, tide, sea, rocks...), what nearby is bending it, and its way to the sea |
straumr report |
writes a file describing the water where you stand, including what's standing in it, for bug reports |
straumr selftest |
checks Straumr is working right where you stand (each check PASS, WAIT, SKIP, NOTE for a known limit, or FAIL) |
straumr waterlevel |
the sea level here: the usual level, the tide, and the water's actual surface |
straumr perf |
how hard Straumr is working (turn on [Diagnostics] PerfCounters) |
straumr overlay |
turns the moving surface off and on in your game, to compare, and says whether it's running |
straumr atlas |
the seed atlas in your browser (works from the main menu too) |
straumr tide |
how the tide is running and when it turns* |
straumr tide flood |
hold the tide (flood, ebb, high, low, spring, neap) in your game; straumr tide auto lets go* |
straumr races |
the strongest tidal races and whirlpools within 4 km* |
straumr map |
write this world's flow map to a file* |
straumr waterstep |
a test: steps the water up zone by zone near you; straumr waterstep off undoes it* |
* needs devcommands first, or admin rights on a server.
Settings
Everything is in BepInEx/config/wackah.straumr.cfg, and most settings apply within a couple of seconds. Shared settings come from the server when you join one (yours apply again when you leave); the rest are each player's own. Settings marked server only do anything on the server.
[Currents] (shared): the water's physics.
| Setting | Default | What it does |
|---|---|---|
Enabled |
true | All of Straumr's currents. |
Speed |
1.2 | The typical river's current (m/s). Creeks and great rivers scale from it. |
MaxSpeed |
3 | No river runs faster than this (m/s). |
VanillaSpeed |
0.7 | Worlds without Riverheim: Valheim's own rivers, times the usual. |
OceanSpeed |
0.8 | The typical open-sea current (m/s). 0 = none. |
Tides |
1.5 | How fast the tide races through narrow sea channels (m/s). 0 = no tidal streams. |
TideRange |
0.6 | How far the sea rises and falls either side of its usual level (m). 0 = no tide. |
StormSurge |
0.3 | How far a full storm raises the sea on top of the tide (m), growing with the wind squared. 0 = off. |
SpringNeap |
0.35 | How much bigger spring tides are, and neaps smaller (0 = every day alike). |
TidalMonth |
16 | Without Seasonality: game days from one full moon to the next. |
Whirlpools |
1 | How hard whirlpools spin (0 = none). |
Rapids |
1 | How hard white water handles swimmers (0 = not at all, up to 2). |
Undertow |
1 | How hard a river's slot pulls swimmers under now and then: above 1 harder, not more often (0 = never, up to 2). |
Rips, Longshore |
0.8, 0.5 | Rip currents off open beaches, and drift along them. |
WindDrift |
0.5 | Surface drift downwind at full wind (m/s), on roomy slack water: the sea, a lake's middle, a broad slow reach. |
StormDrift |
0.3 | Extra drift in a storm (m/s at full wind), on the same water, growing with the wind squared: a breeze adds almost nothing. |
WaveDrift |
1 | How strongly the waves carry floating things, small boats a little, and swimmers in the surf (1 = the drift Valheim's own waves would carry; 0 = none, up to 3). |
Players, Mobs, Items, Boats |
1, 1, 1, 0.6 | How strongly the current carries each (0 = not at all). |
Wading |
1 | How hard the current pushes players wading in it, never more than half your slowest walking pace (0 = off, up to 2). |
SwimWithCurrent, SwimAgainstCurrent |
1, 1 | Swimming with or against the current costs this times the usual stamina, in full swimming straight along a current as fast as you swim (1 = the same; 0 to 3). |
LogDrift |
true | Felled logs float and drift with the current and the waves (off = logs as Valheim has them). |
BoatMinSpeed |
3 | A boat under sail or oar always keeps this much headway (m/s). |
BoatTurn |
0.35 | How much differing currents turn a boat (0 = never; half that while someone steers). |
BoatYaw |
1 | How readily a boat drifting free swings round to lie along the current (0 = never, up to 3). |
AnchorEmptyBoats |
true | A boat left empty (not moored) holds where it was left, swinging a couple of metres, and in a river turns along the current; boarding frees it. |
MooringReach |
2.5 | A stopped boat this close to a bank, dock or rock stays moored (m). |
Obstacles, Bends, Riffles, Seams, Boils, Windrows, Inflows |
true | The individual effects: rocks bending the water, bend flow, pools and riffles, junction seams, boils, foam lines in the wind, Rivers and Lakes stream jets. |
CreaturesFollowTide |
true | Creatures find the water's edge where the tide has it now. |
[Stage] (shared): rivers rising and falling.
| Setting | Default | What it does |
|---|---|---|
Seasons |
true | With Seasonality, the rivers follow the seasons. |
Spring, Summer, Fall, Winter |
1.4, 1, 0.8, 0.7 | How fast rivers run mid-season, times usual. |
Snowmelt |
0.35 | In spring, how much faster snow-fed rivers run at the afternoon peak than at dawn. |
Weather |
true | Rain swells the rivers: creeks at once, big rivers later and longer. |
RainSwell, StormSwell |
0.3, 0.6 | How much faster after a good rain, and after a storm. |
IceFreeSpeed |
0 | With Seasonality's freeze: water at least this fast (m/s) stays open. 0 = off. |
[Flecks] (your own; the three White... thresholds are shared): the foam.
| Setting | Default | What it does |
|---|---|---|
Enabled |
true | Foam on the water. |
Rate |
240 | How much foam (how often the water round you is looked at). |
MaxFlecks |
1500 | Most flecks at once. |
Radius |
60 | Foam within this distance of the camera (m). |
Size |
0.4 | Typical fleck size (m). |
Lifetime |
5 | How long a fleck lasts (s): longer drifts and gathers, shorter reads as strokes of current. |
CalmSpeed |
0.3 | Foam thickens from this speed up (m/s). While the moving surface shows, slow water (below twice this) and slow open water get half the foam their speed would make. |
Opacity, Brightness |
0.6, 2 | How solid and how bright the foam looks. |
Rafts |
1.5 | How many flecks gather in each raft (0 = single flecks). |
WhiteWater |
true | Fast water looks white (only the look). |
Spray |
0.3 | How often spray kicks up off the fastest white water. |
SoftEdges |
true | Foam fades where it meets a bank or a rock instead of ending on a hard line (Straumr's own foam shader, only where the game already draws the scene's depth). |
Lift |
0.04 | How far the foam floats above the water's surface (m). Raise it a little if waves hide the foam. |
WhiteFroude, WhiteFroudeFull, WhiteMinSpeed |
0.45, 0.9, 0.8 | When water turns white: from this Froude number, fully white at this one, never below this speed (m/s). |
[Surface] (your own): the moving surface.
| Setting | Default | What it does |
|---|---|---|
FlowOverlay |
true | The water's ripples and glints move with the current. Off by itself where it can't run, and under NorgerWater. |
Ripples |
0.55 | How steep the moving ripples are (0 = flat, 1 = choppy). |
Glints |
0.5 | How bright the sun's glints on them are (0 = none). |
SkyLight |
0.4 | How much the ripples show the sky's light (0 = none). |
RippleSize |
5 | How big the ripple pattern is before it repeats (m). |
FlowPeriod |
1.8 | How long each copy of the ripples is carried before it fades and restarts (s): longer stretches them more on fast water, shorter pulses more. |
Lift |
0.04 | How far the sheet sits above the game's water (m), so the two don't flicker through each other. |
SoftEdges |
true | Fade the sheet where it meets banks and rocks (only where the game already draws the scene's depth; turn it off if the sheet vanishes). |
[Hud] (your own): lines under the minimap.
| Setting | Default | What it does |
|---|---|---|
TideClock |
true | While you're by tidal water: how the tide runs and when it turns. |
BoatSpeed |
true | While you're aboard a boat: its speed through the water and over the ground, and how much the current adds to it or takes from it along its heading. |
Your own, the rest of the look: [Sound] Enabled, Volume; [Mist] Enabled, Amount.
What the world gets (server): [Driftwood] Enabled, EveryMinutes, Prefab; [Fish] Enabled, EveryMinutes, PerSpot, Kinds; [Rocks] the rocks set at swallow holes and river sources.
Admin and tools: [World] StandingRuins (shared) and NewWorldSeed (every new world this game creates gets this seed; made for dedicated servers, which can't be given one); [Atlas] Port, HiddenSeeds; [Diagnostics] CurrentProbe, PerfCounters, LocationCheck, WorldGenCommand (testing tools, off by default).
Upgrading from 0.1.0: if your foam settings are still 0.1.0's untouched defaults, they move to the new ones by themselves; anything you changed stays as you set it.
Known limits (beta)
- Valheim's own water surface doesn't move with the current. Straumr's moving surface lays ripples and glints on it within about 60 m of you, mostly on running water; beyond that, on slack water, and wherever the moving surface is off, the foam and the things floating on it show the flow.
- In a wide bay or sea arm with several river lines far apart, the current can swirl oddly between them, or drift across toward a river a couple of hundred metres off instead of along the one on the map.
- Where two ways to the sea through the same water are nearly equal, the water splits between them and lies slack where they part (a faint spring there is now rare).
- A lake no river runs into lies still apart from the wind, and so can broad water far from any river.
- Damming a river: ground raised across it with the hoe stills the water above it, but the river below keeps running as before (Straumr doesn't yet know how much water a river carries), and the water doesn't rise behind it. Built walls and stones bend the water like rocks and leave calm water behind them, but don't dam it.
- A few things Valheim keeps at its fixed sea level don't move with the tide: mist, embers, the beach's shading, and where the world placed things.
- The sea is one flat sheet per 64 m zone, raised as a whole, so neighbouring zones can differ by a few centimetres.
- Rivers and Lakes' own streams and lakes move as that mod draws them. Straumr adds its stream jets and the wind's drift on its lakes once Rivers and Lakes shares its water with other mods (its next update).
- ValheimRAFT's vehicles ride the current, but the boat speed line, the current turning a boat (
BoatTurn,BoatYaw), the anchor for empty boats and the waves' drift on boats cover Valheim's own boats only so far. - Worlds much bigger than Valheim's standard size aren't supported yet.
Roadmap
Plans, not promises; the next steps depend on what players find.
- Next: rivers that carry the water their land drains, so side rivers add up and a river that splits shares its water by what each branch can carry.
- Later: stones just under the surface showing a riffle, river levels rising, not only running faster, after storms and in spring, fish that hold in seams and behind rocks.
- Further on: water that remembers what happened: lakes filling and draining, a log jam backing a river up and then bursting.
- Not planned: new models or textures (water wheels, mills, nets). Those belong to other mods, built on the API.
How it was checked
0.1.2 was measured against 0.1.1 on one Riverheim world, in 214 squares of 256 m along its rivers, lakes and junctions (about 370,000 wet 4 m cells), and on Valheim's own world for the same seed, with the same scripts on the same night (Valheim's own world in brackets):
- springs (water pouring out of one point with nothing feeding it): 182 to 71 (121 to 59), none of them at lakes any more
- spots where the current meets itself head-on: 187 to 116 (573 to 353)
- spots where the current turns right round from one 4 m cell to the next: 1229 to 887 (2784 to 2054)
- drains (water running in from every side with nowhere to go): 19 to 18 (17 to 6)
- bank water with the current running mostly into the land: 1.1% to 0.9%
- water faster than 2.2 m/s: 0.8% to 0.6%; river speeds by size unchanged (creeks about 1.0 m/s, great rivers about 1.3)
- more water now lies still where nothing feeds it: river water under 0.05 m/s 11% to 15% (36% to 39%), mostly broad water off to the side of the rivers and the slack where water parts, which only moved before because of a flaw in the old calculation
Problems or ideas?
Message me on Discord. straumr report writes everything I need to reproduce what you saw; please send that file and say which other mods you run.
Thanks
Inspired by the river worlds of Riverheim and the streams and waterfalls of Rivers and Lakes. Go give them a look:
- Riverheim: Thunderstore · Discord
- Rivers and Lakes: Thunderstore · Discord
Built with help from Claude, Anthropic's AI.
CHANGELOG
0.1.6
A hotfix for Worldhalla 1.0.1 (13 November 2026). Worldhalla 1.0.1 no longer has the property through which 0.1.5 found Riverheim's world. With 0.1.5 on Worldhalla 1.0.1, Straumr said "couldn't read Riverheim" at start and used Valheim's own rivers for the session, so Riverheim's rivers didn't flow. 0.1.6 finds Riverheim's world on Worldhalla 1.0.0 and 1.0.1. Checked on a dedicated server with Riverheim 1.3.1: the same rivers and flows read on both.
- Driftwood: a list.
[Driftwood] Prefabtakes several prefab names separated by commas. Each spot gets one of them at random, and a name given twice comes twice as often. A name the game doesn't know is named in the status line and left out; if none is known, nothing washes up. Any networked prefab is taken, as before, not only pickables: a creature or a building piece would come at every spot along every river, and again whenever it's gone. The setting's description now says so. - Docs: the README's line on dug cuts said a cut lower than the dam's crest is found. A cut dug round a dam's end back into the river just below the wall is not found yet: the pond rises over the crest, and the dug ground shows dry.
Nothing else changed from 0.1.5.
0.1.5
0.1.5 redraws how built water looks, fixes how it comes back after a crash and what a ring's breach does to the pond above it, and reads worlds of any size with Expand World Size. The water's behaviour (levels, storage, flows) is the same as 0.1.4's apart from those fixes; what else changed is where Straumr draws water the server has already decided on. The drawing was played by one player on a dedicated server through successive builds, each fixing what the last one showed (see Known issues for what is still open). Still Standalone: requires only BepInEx. No setting was added, renamed, removed or given a new default.
-
After a crash, ponds come back as at the last world save. The server now writes the dams' file (
BepInEx/config/Straumr-water/<world>.dams.txt) only with the world's save, as it does the kept pools'. In 0.1.3 and 0.1.4 it was also written between saves, every 30 s while a dam changed; after a crash or a kill that file was newer than the world, was moved back onto the world's clock, and ran the minutes in between a second time, so a pond came back ahead of the world, with water made or lost. A clean stop was never affected. A pond's saved state is now the world's, like every other object: what happened after the last save is gone with it. -
Water over a wall follows the wall's own top. The top is drawn as a height surface: water runs across it as it would over ground, a sheet across a flat top at its critical depth, a drop at every step down, a hollow in the top filling and leaving by its lowest gap, and the fall to the water or ground below starting at the top's real downstream edge. A wall several pieces thick (four stone walls side by side), a stepped wall and an uneven top draw their overflow across the top instead of a waterfall hanging in the air over it, and the last metres of a long wall past what the dam's record covers are poured too. A level shelf below a wall carries the water across it to its edge and over. Water leaves by every edge it reaches, the sides too, not only the downstream one.
-
Falls that join up. Stretches of one wall face in line meet, with no gap between them and no dry strip between falls; falls are joined across a wall's joins; a fall's foot is fanned where a column goes into the water a row later; a wall's end is followed on past a stub and poured where the dam's record holds no wall.
-
Falls that land on dry ground run on down it. A fall that lands on a bank and never reaches the water carries its water on from where it landed, down the ground the steepest way to the water it reaches, a stream's width. None runs where water already stands within 3 m of the fall's foot, where it reaches none, or where the fall was under a metre, and a run never climbs a step of more than 0.5 m. Water running on what's under it is milky by its speed, at most 0.15 white.
-
Spills beside a dam are drawn. Where a pond rises over a low point beside its wall or goes round the wall's end, the spill now runs over the land from the pond's edge to where it joins the river (or to a hollow's floor), at the flow the dam's record sends round at the pond's level. It is drawn from edges within 32 m of the way the record sends it, where the edge stands up to 1.5 m over the ground, and not at all while the pond stands under its level.
-
Fewer seams. A big pond's pieces beside one that is worked out again are worked out and swapped in with it, so a seam no longer shows while you build at it (checked on a scripted pond: 0 of 32 border points unshared, 7 before). A pond piece built in the tick its zone loads no longer cuts a hole round the sea's level in the pond.
-
A pond is full when you join. Built water is drawn at its level from the moment a game sees it. Before, a game joining a server drew a pond at the river's level for about half a minute to a minute, and then it rose (in play, 53 s and 8.9 m on a big pond). This changes only what is drawn.
-
Expand World Size: any world size. Straumr no longer assumes a 10 km world. It reads Expand World Size's live radius, edge and stretch by name (nothing of it is needed), and the sea's currents are solved out to the world's own edge; before, nothing past 10.5 km was solved and everything past 10.4 km counted as open sea. On a default world nothing changes: the same field, byte for byte. Limits are under Known issues.
-
The atlas's
@hereworks on a dedicated server (its admin starts it with[Diagnostics] WorldGenCommand=atlas; the key is written toBepInEx/config/Straumr-atlas-key.txtwhile it runs): the server's own world, for looking at the water of a live world. -
Mod makers: on a dedicated server a pond's lift is now part of
StraumrApi'sSample, river rise and river state (before, it counted as 0 there). The server's own river levels stay at the sea's level.ApiVersionstays 1. -
A ring's breach no longer leaves a pond rising over it. In 0.1.4, after a ring (a closed ring of walls between two dams) was breached, the pond above it could stay held together with the pool below, on out-of-date figures, and rise over the ring's crest for ever: in the lab a pond of about 4 ha drawn 3 m over the river, and the ring's inside about 1.1 m over its stone. Now the pool is judged again from the walls as they stand, finds the river going round the ring at its own level, and its water leaves round the ring at the river's level, at the water's own pace. The lab's water accounting balanced through it: 0 m³ made or lost. Also fixed, mostly: taking a ring away while its pond was held made the whole pond vanish at once in 0.1.4 (113,514 m³ in the lab's first case); now the pond drains round the gap in about 10 s and its last ~8 cm goes at once (see Known issues). On 0.1.4 the only thing found that clears the first fault was removing the ring, which deleted the pond's water. The one-edit lab scenario for it is
fuzzmut-20261110-3-MF. -
Expand World Size's "Stretch world" works. Riverheim's rivers were read at their original size, so on a world stretched to 2 every river line lay at half its distance from the middle, and the currents were pulled toward lines on dry land, which showed as springs and drains in the water (a player's report). Now Straumr reads the rivers' lines and widths at the world's stretch. On that player's setup (radius 21 km, edge 22 km, stretch 2, water depth 0.75, Riverheim 1.3.1) in the lab: the share of river-line points on water went from 34% to 99.4%, and the rivers with no way out from 110 (of 325) to 0. The worst step between neighbouring river levels fell from 49 m to 32 m (at one river mouth). Counted over the same land, 6 springs and 0 drains against 25 and 0 on a default world (8 m cells). A default world is unchanged, byte for byte. A dam built in the lab on that setup holds, spills and breaches. Limits are under Known issues.
-
The atlas no longer undoes Expand World Size in the world you play. Opening the atlas for another seed, in a world with non-default Expand World Size settings, used to undo its changes for the world you were playing until a restart: all of the ground changed (265 m on average), and new zones saved their trees, rocks and locations on the wrong ground. The atlas's seed worlds are now built beside the played world with Expand World Size's patch left alone, and the live ground measured 0% changed (it was 100%). A seed world built while you play takes the played world's radius, edge and stretch. If Expand World Size's inside differs from the version Straumr was written against (1.45), the atlas builds no seed world while you play rather than risk yours. The atlas page now reads the world's edge, so a bigger world shows whole, with its stretched rivers, and the detail squares reach the edge.
Upgrading to 0.1.5 from 0.1.3 or 0.1.4: no setting was added, renamed, removed or given a new default. Upgrading from 0.1.2: [Currents] Undertow is now [Currents] Strid and your value carries over once. No other setting was renamed, removed or given a new default. Upgrading from 0.1.0: if your foam settings are still 0.1.0's untouched defaults, they move to the new ones by themselves; anything you changed stays as you set it.
Checked: the release build's md5 is e2d1adbbd137a51e78f71e5d1743fcd2. Against the build of the drawing rounds every method difference is classified and no drawing code differs; a default world gives the same water (214 of 214 squares byte-identical); restart 0 of 88 comparisons different; worlds saved on 0.1.3 and on 0.1.4 load unchanged (43 comparisons each, 0 different) and a 0.1.5 save resumes on 0.1.4 unchanged; the closed-form tests pass; no slower than 0.1.4, and the stall from writing the dams' file between saves is gone. Mixed versions: neither direction is refused and each side is told the versions differ; a live 0.1.4 client joining a 0.1.5 server was not tried. Expand World Size is lab-tested, not played.
Known issues (GUIDE.md lists each by tier). No Breaking issues are open. Noticeable: springs and drains in the currents; with Seasonality, a pond drawn at the frozen river's level. 11 Situational and 4 Minor issues are listed there, with what is not built yet (dirt alone is not a dam, no backwater above a pond, dug cuts). Still not tested with a group of players.
0.1.4
A hotfix for hitches when hosting big, heavily built worlds. Nothing about the water changes.
- Fewer hitches on big bases. When you host (or play single-player, or run a server) with a large base, the server's check for dams, cofferdams, kept pools and log barriers read every piece in a zone the first time it looked there, which could freeze the game for a fraction of a second when you walked or teleported into a big base. It now reads ahead in spare moments, at most 1 ms a frame, so the check finds the zone already read. On a lab base of about 3,500 pieces, the hitch on walking in fell from about 46 ms to about 10 ms, and the log drive's barrier checks from up to 38 ms to under 2 ms.
- The very first check after a world loads can still take a few tens of milliseconds while its code warms up.
- A player on 0.1.3 joining a 0.1.4 server is told the versions differ; the water is the same, but updating is recommended.
0.1.3
Standalone: BepInEx only. Straumr still needs only BepInEx. Riverheim, Rivers and Lakes and Worldhalla are read by reflection when they're there, and never required.
0.1.2 let you see the current and feel it; 0.1.3 gives the rivers height, lets players change the water, and works with Riverheim 1.3. Rivers stand above the sea, climb gently toward their sources, and rise and fall with the seasons and the rain. Dams, cofferdams and kept pools are new, experimental and on by default (turn each off in the config if you don't want it); floods are new and off by default. The currents were checked against 0.1.2 on the same Riverheim world.
Multiplayer*: tested on a dedicated server with lab clients and the join, config-sync and restart tests; not yet tested with a group of players.
Riverheim: 1.2.x and 1.3.x both work (1.3.x is read through Worldhalla). 0.1.2 doesn't work with Riverheim 1.3. Worlds made with Riverheim_Config's settings need Riverheim_Config 3.1.1 or later on Riverheim 1.3.x, or their terrain changes. Old Riverheim 1.2 worlds convert one way the first time 1.3.x saves them, so back up the .fwl and .db first.
Upgrading with dams on by default: walls you already built across a river become dams, and rings you already closed start to drain, as soon as Straumr 0.1.3 loads a world. A dam standing with no record is taken as long closed, its pool full. To keep the world as it was, set [Dams] Enabled, [Cofferdams] Enabled and [Pools] Enabled to false (on a server, in the server's config). A dedicated server also needs [Currents] RiverLevels on, which is the default.
Highlights
- Rivers stand above the sea. Each river's surface climbs toward its source (up to 1.34 m in an ordinary season on the test world), stands lower where the banks can't hold it, and slopes smoothly across the 64 m squares of water, with no steps.
- Seasons, rain and snowmelt move the levels, not only the speed: higher in spring (with Seasonality), spreading over flood plains, snow-fed rivers rising on spring afternoons, rain raising them a little. The rain is Valheim's lowland weather rebuilt from the server's clock, the same for every player.
- Dams (
[Dams] Enabled, on by default): a wall across a river raises a pool that fills on the clock and spills over its lowest part; the river below carries only what comes over; doors in the wall are sluice gates. The pond is drawn as a body of water of its own. - Breaches and surges. Break a dam's wall and the pool drains through the gap, its water running down the river as a front you can watch. A hole broken low in the wall pulls swimmers toward it.
- Cofferdams (
[Cofferdams] Enabled, on by default): wall off a patch of water, and it drains to a bare bed; break the ring and it comes back, or, under a breaking dam, fills from that dam's pond at a pace you can watch. - Kept pools (
[Pools] Enabled, on by default): a basin you dig and cut off from the river keeps its water. - Floods (
[Floods] Enabled, off by default): rain raises each river's level by its own size's rain, with backwater where a high river meets a smaller one. - Built water is the server's and survives restarts: the server decides each dam, cofferdam and kept pool, every game follows it, and the server keeps them with the world.
- Riverheim 1.3 works, through Worldhalla, with Straumr still needing only BepInEx.
- Chutes, carried water and eddies: white, faster water where a river runs down into a stretch its banks hold lower; rivers that know how much water they carry and share it at splits; eddies behind bars, islands and points.
- Whirlpools that take hold, and a dry Deep North: whirlpools draw swimmers to the eye and the sea dips into a funnel there; the tide fades out over the Deep North's ice so water no longer stands on it.
- Breakwaters and log drives: calmer waves behind what you build; logs and floating items carried down rivers by the server until a wall, dam or screen catches them.
- Strid: the river "Undertow" is renamed so it isn't mistaken for the sea mod; your setting carries over.
Everything
Rivers and levels
- Rivers stand above the sea. Running water needs a slope to push it, so each river's surface climbs gently toward its source, worked out from the speed the river shows. On the Riverheim world it was checked on, the banks let rivers stand up to 1.34 m above the sea in an ordinary season.
- The banks decide how high: where a 64 m square's water can't rise to the river's full height without spilling over land away from the river or leaving ponds in hollows, it stands lower there, and the river runs down into it at up to 3 cm a metre.
- No steps between squares: the water slopes smoothly from one to the next. Swimming, boats and floating things meet the same surface you see.
- With Seasonality the rivers stand higher in spring and lower in winter. How high goes with the speed squared, so mid-spring's 1.4 times the speed stands about twice as high where the banks allow. In spring the rivers may spread over more of the low ground beside them, and the flood plains dry out again as the season turns. In spring, snow-fed rivers rise in the afternoons as the melt peaks. In Seasonality's freeze the rivers, ponds and kept pools settle to the sea's level.
- Rain follows the lowlands' weather (Meadows, Black Forest, Plains, Mistlands) as Valheim draws it for each weather spell, worked out again from the server's clock: the same rivers for every player wherever they stand, and for anyone joining late. Swamp rain doesn't count (it always rains there), nor does snow. A creek fills in about two minutes and drains in about eight; a great river's flood comes about ten minutes later, fills over some 25 minutes and drains over about 45. Rain raises the levels a little too, following the great rivers.
- Rivers know how much water they carry: from the land draining into each river on Riverheim worlds, from the length of channel above on Valheim's own. A river sounds as full as the water it carries, so a big river sounds big.
- A loop's far side or a lake's second way out runs at its share of the water, from how easily each way runs, instead of a flat 30% of the river's speed (
[Currents] Splits). About 0.3% of the water runs differently. On Riverheim's rivers, where the water parts both ways (a divide), it drifts at 60% of the river's speed instead of 30%. - Chutes: where a river runs down into a stretch its banks hold lower, it looks and sounds white and runs faster along the river, up to the typical river's speed at the steepest (
[Currents] Chutes; 0 = only the look and the sound). - Eddies behind the ground: behind a sand bar, an island or a point the water curls back into the lee while it stands out of the water, fading as the tide, the river and the waves cover it (
[Currents] LeeEddies,LeeEddyCover). - The current at a bend below a dam follows the channel instead of running into the bank.
- Driftwood washes up just above each river's spring high water: a strandline that shows how high the water can come. Branches left from before at spots that no longer exist are taken away where nobody sees.
- Rivers and Lakes: where one of its streams comes down a fall, the jet starts at the foot of the fall, and the plunge drives it out faster (up to half again for a fall of 10 m or more). Streams pouring into a raised river meet it at the river's level. Where a stream runs into Straumr's water at the sea's level, Straumr's water is the water there. A pond drawn over Rivers and Lakes' water covers it. As before, the jets need the Rivers and Lakes update that shares its water with other mods.
Water bodies and dams (experimental, on by default)
- Pieces you build across a river from bank to bank, 10 cm or more over its ordinary level, dam it: the water backs up behind them over the ground joined to it, at the river's own flow (an hour's filling takes an in-game hour), until it spills over the dam's lowest part or finds a way round it. Below, the river carries only what comes over, and runs lower while the pool fills.
- A pool stands up to
[Dams] Ceilingover the sea (60 m by default); Valheim's own water ends 10 m over the sea, and above that Straumr's own water volumes carry it. - A dam's pond is drawn as a body of water of its own: one wet footprint on the ground's own shoreline and the wall, one continuous surface, with the game's water look (
[Pools] OwnSurface). It follows the pieces you built round it as well as the wall, so a hand-built wall no longer leaves a hole in the pond or an edge hanging in the air. Where it pours over the wall or through a breach, the water hangs off the pond's edge down the wall ([Dams] SpillSheets). A hole flush with the ground behind its wall is drawn as a chute rather than a hanging pour. Water over the crest falls as far as the water or ground below it, however tall the drop (a fixed length used to leave tall drops hanging short of what's below: 12 m of fall over dry ground, 30 m over water), and is drawn again once the ground below it loads, so it no longer falls through a river whose ground hadn't loaded. The back of a long wall seen past the end of its face no longer cuts the pond short or draws water past the wall.[Dams] SpillRampdraws the pool's level down a 2-4 m ramp below the crest instead of a step. - Doors in a dam's wall are sluice gates (up to 8 a dam): a weir over the sill and an orifice under the lintel, both ways, opening and shutting over 5 in-game minutes. A mod can set one with
SetGateOpening. - Two walls found together become two dams, and two dams close together no longer confuse which one is upstream. Two dams in a row: the water between them is a cofferdam while nothing flows into it, and fills as the lower dam's pond once the upper pours into it. Where an upper dam's breach opens straight into the lower pond's water, the two are one water held by the lower wall.
- A pond open to other water (the river above it round the wall's end, another channel of a braided river, or the river above through a broken upper wall) can't stand above that water by more than its flow needs to get through the opening; where the water can go round, the dam lets it go round at the river's own level. (Found in play on a sea-level delta, where ponds stood 1-3 m over the river beside them; lab replays of those spots now go round at the river's level.)
- Two dams in a row where the upper dam's water goes round it and comes back into the river below the lower dam: the lower pond no longer takes the whole river (in play it filled the short reach between to its crest in 2 s and stood 1.2 m over it).
- Breaking the upper of two walls opens the water between them to the river above: the lower pond falls to that water instead of standing as if the upper wall were whole.
- A wall built across a broken dam's water closes it again.
- A new dam's pond is worked out on the server's background threads (a quarter of its cores at most), so a big pond's first flood, about a second for a 1 km stretch, doesn't stall the game.
- A wall in a river's tidal reach is a dam when its crest stands above the highest tide and a full storm's surge there; otherwise the tide tops it and it isn't judged.
- A pond handed to the pool below makes and loses no water, and no longer jumps (lab routine scene: the lower pond had jumped 3.7 m; it now moves no more than half a metre at a time).
straumr damlists the dams near you;straumr dam showmarks where each one within 1 km would spill, with a beam, a ring, a label and a map pin, including the way round.
Breaches and drawdown
- Break a wall and the pool drains through the gap as over a weir, fast at first and slowing as the head falls, its water running down the river as a surge: a front at real speed, the river standing higher behind it. A pool below takes the surge into its own pool. Overtopping never breaks a dam.
- A pour never runs faster than water can at its depth (critical flow), so a breach doesn't drain a pond faster than it could.
- Widths are measured along the wall: a breach, a hole or a gap in a ring on a diagonal wall counts its true length (a 6 m cut on a 45-degree wall now passes 6.36 m, not 4.50 m), and stone taken down beside a break widens it (one lab case: a 9 m breach became 26.2 m for 28.5 m of lowered stone).
- Crest runs are measured along the wall too: diagonal dams used to spill about 1.3 to 1.4 times too easily.
- A pond that spills round the end of its wall stands the weir's head over the col's real width, not the width of all the water behind it, so a pond built higher collects higher.
- A hole in the wall with pieces still standing over it, or an open gate under its lintel, pulls swimmers within one and a half times its height toward it, and through if it is a metre or more each way (
[Dams] DragUnder). - The lower dam's water now reaches the line of an upper wall that's gone, so no wall of water is left standing after you delete a wall.
- When the corner of a wall is broken while a ring below it fills, the pond no longer holds back most of its outflow, so it falls at its openings' rate; a reshaped wall carries its water, not its old level, so no water is made in the new hollow. A rebuilt corner's pond is drawn. (Lab corner scene: pieces taken off, rebuilt, volume kept.)
Cofferdams and kept pools (experimental, on by default)
- A patch of river, lake or sea walled off on every side by pieces standing 10 cm above the highest water outside (with the highest spring tide and a full storm's surge where the tide reaches) drains at
[Cofferdams] DrainRate, 0.5 m a real minute, laying the bed bare; break the ring and it comes back through the gap. Ground or a bank may close the ring too. Rings at most 128 m across. [Cofferdams] WaterMaskhides the game's water over a drained cofferdam, so from past 128 m the pit shows its bed instead of flat water.- A ring breaches only the dam whose wall broke, and a cofferdam takes the pool between two dams by its cells. A cofferdam breached from several sides fills from all round, with no jet from its middle.
- Kept pools: water you cut off from the river with ground alone keeps its own water instead of following the river. It keeps its water, not its level: dig it deeper or wider and it stands lower, throw earth in and it rises. A gap dug in its rim lets it fill or drain to the water outside; a door in its rim is a gate; two kept pools joined by digging come level.
The timing curve
- A dry cofferdam below a dam that breaks fills from that dam's pond through the opening, by the head across it. Dams run on Valheim's day (48 times faster than the water's own time with a 30-minute day), which would make a short fill over before you saw it. Now a short fill plays near its own length and a long one is sped up only as much as it needs, never past the clock's own 48 times: 5 s of the water's own time plays in about 5 s, 30 s in about 24 s, 1 minute in about 36 s, 5 minutes in about 68 s, 20 minutes in about 96 s, 80 minutes in about 2 minutes. This pacing applies to that fill, and to a ring refilled by its own river when no dam above pours into it (that used to come back at the clock's 48 times: a lab ring of about 1,100 m³ fed 27 m³/s refilled in about a second, and now takes about 29 s); ponds, spills and surges keep the clock's pace and the surge's own speed.
- When the ring is full, the pace eases up to the clock's over 10 seconds and the two dams come level.
Surges and floods
- Floods (
[Floods] Enabled, off by default): rain raises each river's level by its own size's rain: creeks within an in-game hour of a storm, great rivers about a day later. A high river holds the rivers running into it up (backwater). Stretches whose low banks hold the river down spill over them in a flood (FloodRoom,FloodPonds). The levels step every in-game hour (75 real seconds). Without floods, the levels follow only the great rivers' rain. - A server-wide test rain: an admin's
straumr rainon a server sends every game a rain, so every game's rivers rise, it ends at the same moment everywhere, and late joiners get it.
Restarts kept
- The server keeps dams and cofferdams in
BepInEx/config/Straumr-water/<world>.dams.txt(kept pools in<world>.txt), written when the world saves, and (in 0.1.3 and 0.1.4 only) a dam's record also between saves, at most every half minute while it changes. 0.1.5 writes it only with the world's save. After a restart a pond resumes filling, spilling or draining where the world was saved (0.1.5; 0.1.3 and 0.1.4 resumed it where the file was), and a ring resumes draining, or filling from a breach, from there. The clock doesn't advance while the server is off, so nothing finishes during downtime. - A dam standing with no record there (a world from before, or
[Dams]just turned on) is taken as long closed, its pool full. - Restart tests on the lab server: a restart in the middle of a filling pond, a spill, a drained cofferdam, a ring of two dams and a breach left no differences in any of the five scenes, and was run again at each later build.
- A file from an older build is still read, and an older build reads what it knows and passes over the new parts.
Network
- The server's settings now include
[Floods],[Dams],[Pools],[Cofferdams]and[LogDrive](see Changed settings), and the records of its dams, cofferdams, kept pools and log-drive barriers. - The settings package is built in tagged, length-prefixed blocks: a game reads the blocks it knows and skips the rest, so a damaged or newer block costs only itself. Bodies over 8 KB are compressed. Packages go only to players through the game's own handshake, and wait while a player's send queue is full; one over 400 KB goes without the water block rather than stall the connection. Nothing is sent to a connection the server has turned away.
- A 0.1.3 game answers the first package with a hello. The server tells a player whose game has an older Straumr, or none, on screen that their water will differ. A player is told when the server has no Straumr, or an older one.
- A shared setting the server doesn't send is held at its default, not the player's own. A 0.1.2 server's
Undertowis taken asStrid. - Late joiners and players coming back after being far away get the same pond, surge and levels.
Riverheim 1.3 and Worldhalla
- Riverheim 1.2.x and 1.3.x both work. Riverheim 1.3 is a Worldhalla plugin; Straumr reaches its world through Worldhalla's public API by reflection, with no reference to Worldhalla. Straumr still needs only BepInEx.
- Every call into Riverheim now fails soft: the first failure is said once in the log, and from then on Straumr uses Valheim's own rivers instead of throwing. (0.1.2 read Riverheim 1.2's internals, which 1.3 removed, so its rivers break on Riverheim 1.3.)
- Checked on a lab server with Riverheim 1.3.1 and Worldhalla 1.0.0: a new world and a converted 1.2.1 world both read all their rivers (325) with their flow.
straumr selftesthas a new line that says how Riverheim was read. - The seed atlas binds a Riverheim seed through Worldhalla on 1.3. (Not yet checked live.)
- Old 1.2 worlds keep their terrain, but the upgrade is one way: the first save in 1.3.x writes Worldhalla's format, which Riverheim 1.2 can't read. A player's game asks first, and a dedicated server just does it. Back up the
.fwland.dbfirst. Riverheim's own notes cover it too. - Worlds made with Riverheim_Config's settings need Riverheim_Config 3.1.1 or later on Riverheim 1.3.x, or their terrain changes (in the lab test, 325 rivers instead of 657).
Whirlpools and tide
- A turning whirlpool draws swimmers in gently at the rim of its core and faster than you can swim within 0.4 of it, carrying you into the eye, where it pulls you under for a second every 4 s and costs stamina until after 6 s it lets go (
[Currents] WhirlpoolGrip). Boats and floating things aren't gripped. - The sea dips into a funnel at the eye, deeper as the spin is faster; you swim, float and sail in the dip (
[Currents] WhirlpoolFunnel). - Over the Deep North's ice the tide and the storm surge fade to nothing (back to the full tide over about a kilometre), and tidal streams and whirlpools fade there too, so water no longer stands on the game's ice.
- Breakwaters: walls and other built pieces standing in the water, and ground raised above it, calm the waves in their lee (
[Currents] Breakwaters, andNaturalShelterfor the land as the world made it). Boats ride the same calmer waves that are drawn.
Building and the kit
- Log drives: a wall or dam across a river catches what floats down against it; still water backed up against it drifts toward it. Pieces with gaps at the waterline (a lattice, a table's legs, an open frame) pass water and catch what is thicker than their gaps, and never close a cofferdam or make a dam (
[LogDrive] Screens). On the server, logs and floating items in a river with nobody near are carried on down it until a barrier catches them (ServerDrive,Items); caught things count as inside a base (CaughtIsBase). - Test scenes for dams, breaches, holes, gates, kept pools and logs, built and cleared with
straumr kit(needsdevcommands); walls follow the hammer's 22.5-degree steps.
Performance
- The rivers' levels are planned on a worker thread.
- A dam's record is stamped about half a second after the last change to a piece in it, instead of every two to four seconds.
- Straumr's own per-frame work was trimmed: the foam's current grid and drops are batched, the moving surface re-bends only the zones that changed, the sea's sheets skip bends that change nothing, and the Rivers and Lakes seam is planned one at a time and kept when nothing changed.
- The server's look at its dams, rings and pools took about 4 ms every 2 seconds in the lab with two dams standing.
Diagnostics, console and the lab
- New:
straumr weather,flood,dam,dam show/off,gate,pools,cofferdam,work,drift,drive,seam,rain,ownwater,mask,kit,scenedump, and the closed-form testsdamtest,pooltest,spilltest,drivetest,seamtest. straumr hereadds the river's level and state (how full it runs and why, what it carries, its next four hours, who has the upper hand at a mouth, and which river the water finally joins) and, near a Rivers and Lakes stream mouth, how far the stream falls.waterlevelshows the tide and the river's rise separately and whether they agree.selftestchecks the river outlook and the levels' own consistency; it gains live checks of the sea's sheets, the foam's grid, the current and the ground, and of how Riverheim was read.perfnames the longest game frame a minute and the slow parts, andreportadds the settings package's size.- Atlas: layers for River levels, Fords, Water power and Built water, and a Drift tool; point at a spot for its levels.
straumr scenedumpwrites the world round you to a file for a bug report. The rest of the author's lab (scripted and fuzzed scenes, replays of recorded play, restart and join tests) is how each build was checked; players don't need it.
API (see API.md; ApiVersion stays 1)
FlowSamplegainsDischarge,RiverRise,RiverRiseUsual,RiverRiseHigh,FloodPlain,RiverStage,SurfaceFall,FloodedandFloodDepth.SurfaceHeight,WaterLevelandDepthinclude a river's rise, and dams' pools and surges.- New members:
Outlook(andRiverOutlook),LevelsChanged,DriftPath,WaveShelter,WaveFactor,TestRain,StartTestRain,StopTestRain,TestRainChanged,Cofferdam,CofferdamChanged,Dam,Dams,DamChanged,Head,HydraulicPower,Work,BestDrop,SetGateOpening. - Where the Deep North's ice lies,
TideHeight,TidalStreamandFloodStreamfade to zero.
Fixes
- Water standing on the Deep North's ice (the tide put it there).
- The river "Undertow" no longer shares a name with the sea mod's (renamed Strid).
- A dam's pond, cofferdam and kept pool no longer show seams, stacked surfaces or edges hanging in the air in the cases found in testing: dams in series (including past an upper wall's stub end), a breach right after a wall is built, hand-built walls, and a corner broken and rebuilt.
- The sheet under a pond beside its wall no longer zigzags through the pond.
- Rain used to follow the weather in your own sky; it now follows the lowlands' weather rebuilt from the server's clock, the same for every player.
- Riverheim 1.3: Straumr no longer throws where Riverheim 1.2's internal names are gone.
Known issues in 0.1.3
- The overflow over a low point beside a dam isn't drawn yet: where a pond spills round its wall's end, the water spills but the surface ends in a short edge hanging in the air.
- Two dams built very close together (about 10 m) with a tiny ring between them can draw water past a wall's end.
- Occasional one-frame waterfall glitches right after a wall changes, and a big pond's surface can show a seam for a few seconds while it is redrawn; both fix themselves. A surge follows the river's own line down, not into side channels, round islands or into bays beside it, and can show the edges of the 64 m tiles the water is drawn in; its front can look as if it stalls in places and then catches up.
- Very big dams can still look odd in places: a huge dam's pond that spills over a low saddle into a neighbouring channel is drawn over that channel at its own height instead of pouring into it; thick, stepped or uneven walls may not draw their overflow correctly across the top; a wall several pieces thick (four stone walls side by side, in play) draws its pour hanging over the top and can draw the surface short of its back; the last few metres of a long wall can show no waterfall. Breaking the dam puts it back to normal. Skipping time with a console command jumps the water's clock too, so ponds can change in one step.
- A pond doesn't back the river up above it yet. Where a dam's water is open to the river above it, the river above doesn't rise and spread with the pond: the dam lets the water go round at the river's level instead. A dam across one branch of a river that splits round an island still takes the whole river's flow, and the current just above a bypassed wall still runs into the wall instead of turning into the way round.
- Dam behaviour, overflow and rendering will be a main focus of the next patch.
- The latest dam fixes were checked in the lab and played by one player on a dedicated server. Roofs, fences and docks in a pond haven't been checked in play.
- Multiplayer has been tested on a dedicated server with lab clients, not with a group of players.
GUIDE.md has the full list of known faults.
Changed settings
- Renamed:
[Currents] Undertowis now[Currents] Strid. Your setting carries over once, and is shared like the rest of[Currents]. A 0.1.2 server'sUndertowis read asStridby a 0.1.3 game. Old configs keep working. - New, shared from the server (default):
[Currents] RiverLevels(true),RiverLevelScale(1),RiverFlooding(0.5),SpringFlooding(4),Splits(true),Chutes(1),LeeEddies(1),LeeEddyCover(0.4),Breakwaters(1),NaturalShelter(false),WhirlpoolGrip(1),WhirlpoolFunnel(3);[Dams]Enabled(true),Ceiling(60),DragUnder(true),SpillRamp(false: the server's value is now everyone's);[Cofferdams]Enabled(true),DrainRate(0.5);[Pools]Enabled(true);[Floods]Enabled(false),FloodScale(1),FloodRoom(8),FloodPonds(256);[LogDrive]Screens(true),ScreenPiecesandWallPieces(empty),DamApproach(true),ServerDrive(true),Items(true),CaughtIsBase(true),ThroughUnexplored(false). - New, each player's own:
[Dams] SpillSheets(true),[Pools] OwnSurface(true),[Cofferdams] WaterMask(true). - Removed: none. Defaults changed: none; every 0.1.2 setting keeps its default. (
[Dams] Enabled,[Pools] Enabledand[Cofferdams] Enabledare new in 0.1.3 and default to true;[Floods] Enableddefaults to false.) Riverheim 1.3 support, the timing curve and the dam fixes added no settings.
0.1.2
0.1.1 made the current trustworthy; 0.1.2 lets you see it and feel it. Checked against 0.1.1 on a Riverheim world and on Valheim's own world.
The water's surface
- Ripples and sun glints move with the current: a thin sheet with its own shader that rides the game's waves and the tide (
[Surface]). It shows from 0.05 m/s, in full from 0.5, and fades to half on windy open water. It steps aside under NorgerWater, on frozen water, on Rivers and Lakes' water and toward the Deep North.straumr overlayturns it off and on. - Foam fades where it meets a bank or a rock instead of ending on a hard line (
[Flecks] SoftEdges). Where the ripples show, slow water carries less foam; still water keeps all of its. - River sound starts at slower water and grows fuller the deeper the river.
Rivers and lakes
- Far fewer springs and drains. On the Riverheim world: springs 182 to 71 (none left at lakes), spots where the current meets itself head-on 187 to 116, reversals 1,229 to 887.
- Lakes drain through their real way out, and a lake's outlets no longer pour water back into it.
- The long way round a loop, or a lake's second way out, drifts along instead of standing dead.
- Rocks bend the water by the part of them that's in the water, measured at the waterline, not by their whole size. A rock whose shape the game carries twice is counted once.
- Water nothing feeds lies still where it used to move only because of a flaw in the old calculation (river water under 0.05 m/s: 11% to 15%).
Weather
- Wind drifts lakes and broad slow reaches too, not only the sea, and a storm pushes harder than a breeze (
[Currents] StormDrift). - Storm surge: a storm raises the sea up to 0.3 m on top of the tide (
[Currents] StormSurge). - Fixed: the current dropped out on every wave crest more than 30 cm above the still sea.
In the water
- Wading: the current pushes you downstream as you wade (
[Currents] Wading). - Undertow: fast water through a deep, narrow slot now and then pulls swimmers under for a moment (
[Currents] Undertow). - Swimming effort with or against the current, optional and off by default (
SwimWithCurrent,SwimAgainstCurrent). - Waves carry floating things the way they run, in toward the beach over the shallows, and in a gale the surf pushes swimmers (
[Currents] WaveDrift). - Felled logs float and drift with the current and the waves (
[Currents] LogDrift).
Boats
- A boat drifting free in a river swings round to lie along the current (
[Currents] BoatYaw), and the current's turn on a boat is halved while someone steers. - A boat left empty rides as if at anchor (
[Currents] AnchorEmptyBoats). Jumping off into a river no longer lets the current carry the boat away from you. - Boat speed under the minimap while you're aboard: through the water, over the ground, and what the current adds or takes (
[Hud] BoatSpeed).
For mod makers
WaterLevelandSample'sSurfaceHeightgive the water as it stands, tide and storm surge easing in;TideHeightis where it's heading.SampleandVelocityagree on another mod's water, and another mod's lakes never run white.
Diagnostics
straumr herenames the rocks bending the current where you stand, and says when a stretch of river carries no source's water (a divide, or draining one way).straumr selftestchecks the current's consistency near you (PASS, or a NOTE where rivers meet across wide water).
0.1.1
Most of this release makes the water more correct, then measures it: a whole Riverheim world was checked before and after.
Rivers
- Where several rivers share the same water (Riverheim often runs a few through one channel, sometimes in opposite directions), that water gets one way down: its shortest way to the sea. The rivers in it agree instead of pouring sideways into each other, and the drains and springs along their lines are gone. A river keeps the way Riverheim drew it unless the other way to the sea is less than half as long.
- Where several of Riverheim's river lines run through the same water, the one nearest the sea owns it, so currents no longer come out in stripes running opposite ways.
- River ends that reach the sea only through a narrow or shallow passage count as reaching it (they used to count as closed lakes, and drew water toward them).
- A river ending in a lagoon or bay runs out through it, instead of the lagoon draining back into the river.
- Lakes no longer have pits where a river's lake and channel stretches alternated.
- A river's distance to the sea is worked out properly through lakes and confluences, so lakes no longer run backwards from their outlet.
- Creeks no longer outrun great rivers: each river's speed comes from the water it usually holds, not from Riverheim's designed channel.
- Water slides along banks and round islands instead of running into them, and narrows speed the water up instead of stalling it.
- The current carries on past a river's mouth instead of stopping (or turning back) at it.
- Riffles only in shallow rivers; seams follow the river round bends; a river's lines no longer hold the water still across a lake.
- A wall or dam across a channel stops the flow; the water above it lies still.
- Rivers and Lakes' water is left to it: Straumr's river currents no longer push in its lakes and streams.
The sea and tides
- Narrow mouths on big bays and inner seas race as they should (before, any sea wider than ~700 m counted as open ocean).
- Currents flow between islands.
- The tide's stream, the tide line and whirlpools follow the local tide's timing (later behind straits).
- Water levels ease to a new tide instead of jumping (on login, after a settings change, at a freeze).
- Longshore drift no longer adds up several times on ragged coasts; windrows and boils hold steady over long sessions.
- The tide line shows near any coast, not only by tidal races.
- Creatures (their water checks, path-finding, spawn heights) follow the tide:
[Currents] CreaturesFollowTide. - Shallow swamps and marshes no longer count as open sea (the sea's currents there were far too strong).
Things in the water
- Rowing against a current is no longer faster than in still water.
- Rivers and Lakes stream jets stop at the far bank and get carried off by a river they pour into, sized by the stream.
- Swallow holes only pull the water in their own pool, never through a bank, and never faster than you can swim.
- Rocks, walls and docks: walls block the water, the wake fits the object, and debris gathers in a small back-eddy behind them.
- Only what breaks the surface bends the current: a stone just under it no longer stops the water dead. A creature standing in the water is never taken for a rock.
- White water pulls swimmers under for a moment, then lets them be for a while.
- Moored boats: shallow water no longer counts as a bank.
- Driftwood and fish stay out of rocks and banks, and stay with the world they belong to.
Foam, sound and mist
- Foam redesigned: a few scraps on all water (still water too), much more where the water runs, shears and meets; nine kinds of foam (packed bubbles, lace, strands drawn out by the current); lit by the scene so it doesn't glow. New
[Flecks]settings:CalmSpeed,Opacity,Brightness,Lifetime,Rafts,Spray. - Water sounds are placed at the water (not at your height), stop in menus, and have a smoother rumble.
- Mist no longer shrinks as you walk into it.
New
- A public API for other mods (
Straumr.Api, see API.md): the water's current, depth, tide, white water and actual surface height at any point, river paths, power density, tide and flood events. - Console:
straumr here(the current split into its parts, and its way to the sea),straumr report(a file for bug reports, naming what stands in the water nearby),straumr selftest(PASS/FAIL checks where you stand),straumr waterlevel,straumr perf,straumr waterstep(a test). - Atlas: a debug view (D) showing why the water does what it does at any spot. In the whole-world view, rivers carry as much foam as the sea, follow the water, and no longer loop round inside lakes. The atlas now only answers its own page and closes a few seconds after the page does.
[World] StandingRuinsmakes visible an existing feature: world stonework doesn't crumble where a steep world leaves its edge hanging.
Changed defaults
[Diagnostics] LocationCheckis now off (it's a tool for screening new worlds).[Flecks]:Radius45 to 60,Rate60 to 240 (it now counts how often the water is looked at, not flecks made),MaxFlecks500 to 1500,Size0.25 to 0.4. A config still holding all four of 0.1.0's defaults moves to the new ones by itself; anything you changed stays.
0.1.0: first beta
- Rivers that flow, from Valheim's own rivers and streams, or from Riverheim's river networks when it's installed.
- Froude-number white water, rapids that tumble swimmers, obstacles with wakes and eddies, bend flow, pools and riffles, confluence seams, boils.
- Sea currents, wind drift, rips and longshore drift.
- Tides that rise and fall, with tidal races at bay mouths, whirlpools off the straits, and the tide pushing up river mouths on the flood.
- A lunar month: spring tides at full and new moon, neaps between, high water a little later each day (one month per season with a seasons mod).
- A tide line under the minimap.
- Rain, seasons (with Seasonality) and spring snowmelt.
- Optional with Seasonality's winter freeze: fast water stays open (
[Stage] IceFreeSpeed, off by default). - ValheimRAFT vehicles drift with the current.
- Foam flecks on the water, synthesised water sounds, mist, driftwood and fish.
- Server settings sent to every player; weather swell replayed for late joiners.
- Flow map and seed atlas in the browser (
straumr atlas), with a tide view (T): currents flooding and ebbing, the water rising and falling, a tide gauge.