Back to mods
River Flow Control project artwork

Vintage Story Mod DB · Vintage Story mod

River Flow Control

Running a dedicated or hosted server? Use River Flow Control (Server) instead: https://mods.vintagestory.at/riverflowserver . Rivers keeps pushing parked boats on the server even when flow is off, and only the Server version stops that. Players don't need to i

Choose a version Pick your version below, then grab the matching file.

Quick answer

Which River Flow Control release should I use?

Updated last month
Latest stable file 0.1.0
Game version 1.22.6
Loader Built-in Vintage Story mod system

River Flow Control 0.1.0 targets 1.22.6. It must be installed on the client. Installation on the dedicated server is optional. All 1 required mods have matching files.

Where it goes

Is River Flow Control required on the client, server, or both?

It must be installed on the client. Installation on the dedicated server is optional.

Client Required
Dedicated server Optional
Loader for this release Built-in Vintage Story mod system
Required install it here Optional supported, not mandatory Not supported do not install here Source doesn’t say do not assume

This release supports both sides, but the source does not require it on the server.

What else does River Flow Control 0.1.0 need?

0.1.0. Change the file and its required mods may change too.

All 1 required mods have matching files

Install Rivers first. We found matching files for this game-version and loader setup.

Rivers Needed by River Flow Control 0.1.0
required
Matching file found Matched file: 5.0.3

We only count dependency files that match this setup. A file for another loader does not fill the gap.

Before you install it

Add River Flow Control without breaking your instance.

Built for River Flow Control 0.1.0. Pick another file and the loader, install side or required mods may change.

  1. 01

    Stick to this file

    Use 0.1.0. It targets 1.22.6; another release may have different loader, side or dependency requirements.

  2. 02

    Bring the mods it needs

    Install Rivers first. We found matching files for this game-version and loader setup.

  3. 03

    Put it on the correct side

    It must be installed on the client. Installation on the dedicated server is optional.

  4. 04

    Pick the file you checked

    Use the “Get this file” button beside 0.1.0. It opens that exact file at the source.

About this project

What does River Flow Control add?

Running a dedicated or hosted server? Use River Flow Control (Server) instead: https://mods.vintagestory.at/riverflowserver . Rivers keeps pushing parked boats on the server even when flow is off, and only the Server version stops that. Players don't need to install anything. This version works on the client side only.

 

A companion mod for Rivers. Requires Rivers to be installed.

 

The problem: Rivers reads disableFlow from each player's own ModConfig/rivers.json. The server broadcasts its own flowDisabled value, but in practice the client's local file wins. So on a server that turned the current off, every player who has never edited that file still gets pushed downstream, and boats will not stay put. There is no server-side setting that fixes this, which leaves an operator telling every new player to go and edit a JSON file by hand.

 

This mod settles it. Install it on the server alongside Rivers and joining players receive it automatically like any other required mod. On each client it forces the flow state to whatever the config says, re-applying on a timer because Rivers recomputes flow from its own config on several code paths, so setting it once at startup does not stick.

 

Config, written to ModConfig/riverflow.json on first run:

ForceFlowDisabled - true for no current, false to leave Rivers alone. Default true.

EnforceIntervalMs - how often to re-apply. Default 2000.

VerboseLogging - log every time it re-applies rather than only the first.

 

Note on how it works: Rivers holds this state in a static field behind a property with a non-public setter, so this mod sets it by reflection and then calls Rivers' own public RePatchFlow to apply it. Nothing is referenced at compile time, so if a future Rivers version renames that field this mod still loads and simply logs that it could not take effect, rather than breaking anything. If that happens, the fallback is the manual edit it was written to avoid.

 

Not affiliated with the Rivers author. If the underlying sync gets fixed upstream, this mod stops being necessary and can be removed.

Project description from Vintage Story Mod DB.

Pick your setup

River Flow Control releases for each Vintage Story version.

Choose the version and loader you play, then open the matching release.

1 available setups

Check the dependencies, then try the file in a copied instance before changing a world you care about.

Recent files

River Flow Control versions and loaders

1 of 1 releases match

Looking for an older file? The official Vintage Story Mod DB project page is in Resources.