Skip to content

README.md

Latest commit

 

History

History
91 lines (61 loc) · 3.36 KB

README.md

File metadata and controls

91 lines (61 loc) · 3.36 KB

MonoGame TerrainGeneration2D

Build and Test .NET Version MonoGame License

This repository contains a 2D terrain generation sample built with MonoGame, featuring chunked tilemaps, heightmaps, and Wave Function Collapse.

Tech Stack & Versions

  • .NET: 10.0
  • MonoGame (DesktopGL): 3.8.5 (runtime: app/benchmarks), 3.8.4.1 (tests)
  • Gum.MonoGame: 2025.12.9.1

Features

  • Chunked tilemap (64×64 chunks) with save/load (gzipped) per chunk
  • Advanced WFC algorithm with multiple entropy heuristics (Shannon, domain size, most constraining variable)
  • AC-3 constraint propagation with precomputed rule tables
  • Seamless chunk boundaries with constraint-based seam consistency
  • Full backtracking support with change logging for contradiction recovery
  • Runtime configuration via appsettings.json and F10 debug panel
  • Camera pan/zoom, tooltip, and debug overlay (F12)
  • EventSource-based diagnostics and optional benchmarks

Getting Started

Prerequisites

  • .NET 10 SDK

Build

dotnet build TerrainGeneration2D.slnx

Run

dotnet run --project TerrainGeneration2D/TerrainGeneration2D.csproj

Test

dotnet test TerrainGeneration2D.Tests/TerrainGeneration2D.Tests.csproj

Docs

  • See the index at docs/README.md

WFC Implementation Status

✅ Phase 0: Array Migration - Converted to jagged arrays for 10-30% performance improvement
✅ Phase 1: Core Algorithm Enhancement - AC-3 propagation + precomputed rule tables (70% faster)
✅ Phase 2: Chunk Seam Consistency - Boundary constraints for seamless terrain

Roadmap

  • Phase 3: Performance Optimization - Cached height sampling, memory reduction (60%), time budgets
  • Phase 4: Library Abstraction - Generic WFC solver for non-tile domains, plugin architecture
  • Phase 5: Comprehensive Testing - Property-based tests, performance regression, ≥95% coverage
  • Phase 6: Documentation & Onboarding - Developer guides, 2-week onboarding materials

See WFC Completion Plan for detailed implementation status.

Troubleshooting

  • Content not updating after asset changes: re-run a full solution build to rebuild the Content pipeline.
  • Blank window or GL errors: update GPU drivers; ensure DesktopGL dependencies are installed.
  • Missing saves/regeneration: delete TerrainGeneration2D.Core/Content/saves to force new generation.
  • Debug overlay not visible: toggle with F12 (see GameController bindings).

CI & Quality

  • GitHub Actions builds and runs tests on push/PR (Windows).
  • Docs link lint runs in CI to prevent broken in-repo links.

License

This project is licensed under the MIT License. See LICENSE for details.

Quick Links

  • Start with the docs index: docs/README.md
  • Build: dotnet build TerrainGeneration2D.slnx
  • Run: dotnet run --project TerrainGeneration2D/TerrainGeneration2D.csproj
  • Test: dotnet test TerrainGeneration2D.Tests/TerrainGeneration2D.Tests.csproj