islaApocalypse/Tools/Scripts/RiverPlanTool.cs
beezm ae97e48229 feat: drainage-network promotion analysis — the river PLAN (terrain-water task 21, C0b part 1)
Pure analysis over the ERODED render map: changes zero terrain, adds zero water.
Priority-flood (task-03 family, Barnes heap+pit, 8-connected) with a one-ulp
epsilon so every filled pit keeps a strictly descending routing path — the ~16.5k
erosion pits route through; depressions >= 2 m deep and >= 10k px survive as
terminal basins (70 on the working seed). D8 flow directions on that routing
surface (D8 as a COMPUTATION, not the reverted carving use), Kahn-propagated flow
accumulation, then promotion: TRUE-ocean outlets (WBID 1 only — two of the first
draft's three 'sea-reaching' trunks actually ended in enclosed lagoons, which is
exactly the overclaim the gate must not inherit) ranked by drainage area, top ~3
with outlet separation become trunks; max-accumulation stems; mountain-exit from
sustained along-stem grade; lean deduped tributaries; lean endorheic terminals
credited with per-basin TOTAL inflow (acc at the deepest cell undercounts flat
lagoon beds 10x — measured).

Output: console report + a JSON plan sidecar next to the source blueprint —
deliberately NOT a blueprint section, so the plan cannot masquerade as realized
water. The source .dat is never written (md5-verified). Headless tool, ~21 s
analysis on 8K; RIVERPLAN_* env dials.

Seed 1280587109 findings for the gate: 3 ocean trunks spread west/north/east
(436k/409k/325k px); the island's five LARGEST systems (1.1M-2.3M px) are all
endorheic — three end in big enclosed lagoons (classify lakes, 19-20 m basins),
two in dry pans; 62.9% of land does not drain to the open ocean, the drainage
restatement of task 18's 'erosion cannot cut the lowlands'. The 2.27M-px giant
terminates in the SE lagoon ~1.1k px from the southernmost town (filed south
report, not enforced).

Co-Authored-By: Claude Fable 5 <noreply@anthropic.com>
2026-08-11 18:06:21 -04:00

225 lines
10 KiB
C#

using Godot;
using System.Collections.Generic;
using System.Globalization;
using System.Text;
using IslaApocalypse.Core;
/// <summary>
/// The river-plan tool (C0b part 1, terrain-water task 21). Headless, harness-style:
///
/// 1. load an EROSION-ON blueprint through the real parser,
/// 2. run DrainageAnalysis over its (eroded) heightmap — pure analysis,
/// 3. print the full plan report to the console,
/// 4. write the plan as a JSON SIDECAR next to the source file.
///
/// It never writes the blueprint. The sidecar is deliberately NOT a blueprint
/// section: sections are for realized world data, and this is a PLAN the developer
/// gates before part 2 carves anything — a plan that read as actual water would be
/// exactly the masquerade task 21 forbids. Part 2 owns the durable representation.
///
/// Run: Godot --headless --path <repo> res://Tools/Scenes/RiverPlanTool.tscn
/// Env: RIVERPLAN_SRC (source .dat; default user://MapData_Seed_1280587109.dat),
/// RIVERPLAN_OUT (sidecar path; default <src dir>/RiverPlan_Seed_<seed>.json),
/// RIVERPLAN_* dial overrides (see ReadParams).
/// Exit 0 = plan written, 1 = failure.
/// </summary>
public partial class RiverPlanTool : Node
{
public override void _Ready()
{
bool ok = false;
try { ok = RunPlan(); }
catch (System.Exception e) { GD.PrintErr($"[RiverPlan] EXCEPTION: {e}"); }
GD.Print(ok ? "[RiverPlan] RESULT: PLAN WRITTEN" : "[RiverPlan] RESULT: FAIL");
GetTree().Quit(ok ? 0 : 1);
}
private static float EnvF(string k, float d) =>
float.TryParse(OS.GetEnvironment(k), NumberStyles.Float, CultureInfo.InvariantCulture, out var v) ? v : d;
private static int EnvI(string k, int d) =>
int.TryParse(OS.GetEnvironment(k), out var v) ? v : d;
private static DrainageAnalysis.Params ReadParams()
{
var p = new DrainageAnalysis.Params();
p.EndorheicMinDepthM = EnvF("RIVERPLAN_ENDO_MIN_DEPTH_M", p.EndorheicMinDepthM);
p.EndorheicMinAreaPx = EnvI("RIVERPLAN_ENDO_MIN_AREA_PX", p.EndorheicMinAreaPx);
p.EndorheicMinInflowPx = EnvI("RIVERPLAN_ENDO_MIN_INFLOW_PX", p.EndorheicMinInflowPx);
p.EndorheicMaxCount = EnvI("RIVERPLAN_ENDO_MAX_COUNT", p.EndorheicMaxCount);
p.TrunkCount = EnvI("RIVERPLAN_TRUNK_COUNT", p.TrunkCount);
p.MinOutletSeparationPx = EnvI("RIVERPLAN_OUTLET_SEPARATION_PX", p.MinOutletSeparationPx);
p.StemMinAccPx = EnvI("RIVERPLAN_STEM_MIN_ACC_PX", p.StemMinAccPx);
p.TributaryMinAccPx = EnvI("RIVERPLAN_TRIB_MIN_ACC_PX", p.TributaryMinAccPx);
p.TributaryMaxPerTrunk = EnvI("RIVERPLAN_TRIB_MAX_PER_TRUNK", p.TributaryMaxPerTrunk);
p.ExitGradeMin = EnvF("RIVERPLAN_EXIT_GRADE_MIN", p.ExitGradeMin);
p.ExitWindowPx = EnvI("RIVERPLAN_EXIT_WINDOW_PX", p.ExitWindowPx);
p.SeaLevel = EnvF("RIVERPLAN_SEA_LEVEL", p.SeaLevel);
return p;
}
private bool RunPlan()
{
string src = OS.GetEnvironment("RIVERPLAN_SRC");
if (string.IsNullOrEmpty(src))
src = ProjectSettings.GlobalizePath("user://MapData_Seed_1280587109.dat");
GD.Print($"[RiverPlan] source blueprint: {src}");
ulong t0 = Time.GetTicksMsec();
WorldBlueprint bp = MapDataParser.LoadMapDataFromPath(src);
if (bp == null) { GD.PrintErr("[RiverPlan] blueprint load failed."); return false; }
if (bp.Erosion == null)
GD.PrintErr("[RiverPlan] ⚠ source carries no EROS section — analysing an UNERODED " +
"surface; the plan will still compute but is not the C0b input the task means.");
ulong t1 = Time.GetTicksMsec();
GD.Print($"[RiverPlan] loaded in {(t1 - t0) / 1000.0:F1}s " +
$"(seed {bp.Params?.WorldSeed}, {bp.MapSize}², erosion {(bp.Erosion != null ? $"v{bp.Erosion.Version}" : "ABSENT")}).");
if (bp.WaterBodyIds == null)
{ GD.PrintErr("[RiverPlan] source carries no WBID — cannot identify THE OCEAN; refusing."); return false; }
// THE OCEAN body (WBID == 1) is the only water that counts as "the sea":
// enclosed lagoons are depressions a river may legitimately END in, not
// destinations that make a trunk "sea-reaching".
int nn = bp.MapSize;
bool[] isOcean = new bool[nn * nn];
for (int x = 0; x < nn; x++)
for (int y = 0; y < nn; y++)
isOcean[x * nn + y] = bp.WaterBodyIds[x, y] == 1;
var p = ReadParams();
var plan = DrainageAnalysis.Run(bp.HeightMap, bp.MapSize, isOcean, p);
ulong t2 = Time.GetTicksMsec();
GD.Print($"[RiverPlan] analysis in {(t2 - t1) / 1000.0:F1}s.");
// ---- console report ----
GD.Print($"[RiverPlan] routing: {plan.LandCells} land cells; " +
$"{plan.SeaReachingCells} drain to sea ({100.0 * plan.SeaReachingCells / plan.LandCells:F1}%), " +
$"{plan.EndorheicCells} endorheic ({100.0 * plan.EndorheicCells / plan.LandCells:F1}%), " +
$"{plan.UnroutedCells} unrouted (should be ~0).");
GD.Print($"[RiverPlan] depressions: {plan.PitsFilledCount} pits filled through for routing, " +
$"{plan.TerminalBasinCount} qualified as terminal basins " +
$"(depth ≥ {p.EndorheicMinDepthM} m and area ≥ {p.EndorheicMinAreaPx} px).");
GD.Print("[RiverPlan] top outlets by drainage area (pre-separation):");
foreach (var (x, y, a) in plan.AllOutletsTop)
GD.Print($"[RiverPlan] ({x},{y}) {a} px");
int ti = 0;
foreach (var t in plan.Trunks)
{
ti++;
GD.Print($"[RiverPlan] TRUNK {ti}: outlet ({t.Outlet.x:F0},{t.Outlet.y:F0}), " +
$"drainage {t.DrainageAreaPx} px, stem {t.Course.Count * 4} px, " +
(t.ExitFound
? $"mountain-exit ({t.MountainExit.x:F0},{t.MountainExit.y:F0}) at {t.MountainExitElevM:F0} m"
: "mountain-exit NOT FOUND (stem never sustains the exit grade)") +
$", {t.Tributaries.Count} tributaries.");
foreach (var tr in t.Tributaries)
GD.Print($"[RiverPlan] trib: joins near head ({tr.Course[0].x:F0},{tr.Course[0].y:F0}), " +
$"drainage {tr.DrainageAreaPx} px");
}
foreach (var e in plan.Endorheics)
{
ushort wb = bp.WaterBodyIds[(int)e.Terminal.x, (int)e.Terminal.y];
GD.Print($"[RiverPlan] ENDORHEIC terminal ({e.Terminal.x:F0},{e.Terminal.y:F0}): " +
$"drainage {e.DrainageAreaPx} px into a basin {e.BasinDepthM:F1} m deep, {e.BasinAreaPx} px" +
(wb > 1 ? $" — terminates IN classify lake/lagoon WBID {wb} (river-feeds-lake)" : " — dry closed basin") + ".");
}
// ---- the southern-town report (filed fact, not a constraint) ----
if (bp.Towns.Count > 0)
{
TownLocation south = bp.Towns[0];
foreach (var t in bp.Towns)
if (t.Position.Y > south.Position.Y) south = t;
GD.Print($"[RiverPlan] southernmost town: tier {south.Tier} at " +
$"({south.Position.X:F0},{south.Position.Y:F0}).");
ti = 0;
foreach (var t in plan.Trunks)
{
ti++;
float best = float.MaxValue;
foreach (var (x, y) in t.Course)
{
float dx = x - south.Position.X, dy = y - south.Position.Y;
float d2 = dx * dx + dy * dy;
if (d2 < best) best = d2;
}
GD.Print($"[RiverPlan] SOUTH REPORT trunk {ti}: outlet y={t.Outlet.y:F0} " +
$"({(t.Outlet.y > bp.MapSize * 0.55f ? "southern" : t.Outlet.y < bp.MapSize * 0.45f ? "northern" : "central")} coast); " +
$"course passes {Mathf.Sqrt(best):F0} px from the southernmost town.");
}
}
// ---- JSON sidecar ----
string outPath = OS.GetEnvironment("RIVERPLAN_OUT");
if (string.IsNullOrEmpty(outPath))
outPath = System.IO.Path.Combine(System.IO.Path.GetDirectoryName(src) ?? ".",
$"RiverPlan_Seed_{bp.Params?.WorldSeed}.json");
System.IO.File.WriteAllText(outPath, ToJson(bp, plan));
GD.Print($"[RiverPlan] plan sidecar written: {outPath}");
return true;
}
// Hand-rolled, invariant-culture JSON for a fixed schema — deterministic output,
// no serializer reflection surprises.
private static string ToJson(WorldBlueprint bp, DrainageAnalysis.Plan plan)
{
var ci = CultureInfo.InvariantCulture;
var sb = new StringBuilder(1 << 20);
void Pt(StringBuilder b, (float x, float y) v) =>
b.Append('[').Append(v.x.ToString("F1", ci)).Append(',').Append(v.y.ToString("F1", ci)).Append(']');
void Course(List<(float x, float y)> c)
{
sb.Append('[');
for (int i = 0; i < c.Count; i++) { if (i > 0) sb.Append(','); Pt(sb, c[i]); }
sb.Append(']');
}
sb.Append("{\n\"_WARNING\": \"RIVER *PLAN* — analysis output for the task-21 gate. ");
sb.Append("Nothing here is realized water or terrain. Part 2 (task 22) consumes this; ");
sb.Append("nothing at runtime may read it as water.\",\n");
sb.Append($"\"seed\": {bp.Params?.WorldSeed ?? 0}, \"mapSize\": {bp.MapSize},\n");
var p = plan.P;
sb.Append($"\"params\": {{\"endoMinDepthM\": {p.EndorheicMinDepthM.ToString(ci)}, ");
sb.Append($"\"endoMinAreaPx\": {p.EndorheicMinAreaPx}, \"endoMinInflowPx\": {p.EndorheicMinInflowPx}, ");
sb.Append($"\"endoMaxCount\": {p.EndorheicMaxCount}, \"trunkCount\": {p.TrunkCount}, ");
sb.Append($"\"minOutletSeparationPx\": {p.MinOutletSeparationPx}, \"stemMinAccPx\": {p.StemMinAccPx}, ");
sb.Append($"\"tribMinAccPx\": {p.TributaryMinAccPx}, \"tribMaxPerTrunk\": {p.TributaryMaxPerTrunk}, ");
sb.Append($"\"exitGradeMin\": {p.ExitGradeMin.ToString(ci)}, \"exitWindowPx\": {p.ExitWindowPx}, ");
sb.Append($"\"seaLevel\": {p.SeaLevel.ToString(ci)}}},\n");
sb.Append($"\"routing\": {{\"landCells\": {plan.LandCells}, \"seaReaching\": {plan.SeaReachingCells}, ");
sb.Append($"\"endorheic\": {plan.EndorheicCells}, \"unrouted\": {plan.UnroutedCells}, ");
sb.Append($"\"pitsFilled\": {plan.PitsFilledCount}, \"terminalBasins\": {plan.TerminalBasinCount}}},\n");
sb.Append("\"trunks\": [\n");
for (int i = 0; i < plan.Trunks.Count; i++)
{
var t = plan.Trunks[i];
sb.Append(" {\"outlet\": "); Pt(sb, t.Outlet);
sb.Append($", \"drainageAreaPx\": {t.DrainageAreaPx}, \"exitFound\": {(t.ExitFound ? "true" : "false")}, ");
sb.Append("\"mountainExit\": "); Pt(sb, t.MountainExit);
sb.Append($", \"mountainExitElevM\": {t.MountainExitElevM.ToString("F1", ci)},\n \"course\": ");
Course(t.Course);
sb.Append(",\n \"tributaries\": [");
for (int j = 0; j < t.Tributaries.Count; j++)
{
var tr = t.Tributaries[j];
if (j > 0) sb.Append(',');
sb.Append($"\n {{\"drainageAreaPx\": {tr.DrainageAreaPx}, \"course\": ");
Course(tr.Course);
sb.Append('}');
}
sb.Append("]\n }");
if (i < plan.Trunks.Count - 1) sb.Append(',');
sb.Append('\n');
}
sb.Append("],\n\"endorheics\": [");
for (int i = 0; i < plan.Endorheics.Count; i++)
{
var e = plan.Endorheics[i];
if (i > 0) sb.Append(',');
sb.Append("\n {\"terminal\": "); Pt(sb, e.Terminal);
sb.Append($", \"drainageAreaPx\": {e.DrainageAreaPx}, ");
sb.Append($"\"basinDepthM\": {e.BasinDepthM.ToString("F2", ci)}, \"basinAreaPx\": {e.BasinAreaPx}, ");
sb.Append($"\"terminalWbid\": {bp.WaterBodyIds[(int)e.Terminal.x, (int)e.Terminal.y]}}}");
}
sb.Append("\n]\n}\n");
return sb.ToString();
}
}