How redblobgames/mapgen2 works
Project Type and Purpose
• This is an open-source JavaScript library (with demo UI code) for procedural polygonal map generation.
• Core algorithms: point distribution, mesh construction (Voronoi/Delaunay), dual‐mesh augmentation, elevation/rivers/biomes assignment.
File Structure Analysis
• Top-level:
• dual-mesh/ — standalone TypeScript package for constructing and augmenting meshes
• .js, biomes.js, moisture.js, rivers.js, water.js — modules implementing WorldMap data generation
• build.sh, package.json, pnpm-lock.yaml — build and dependency config
• dual-mesh subpackage:
• create.ts, index.ts — APIs to generate boundary points and wrap Delaunator output into TriangleMesh
• dist/ — compiled JavaScript/TypeScript declarations
• tests.js, tsconfig.json, package.json — standalone build/test config
README Insights
• Core data structures:
• Mesh (struct-of-arrays) for connectivity (points, edges, triangles, cells)
• WorldMap for map attributes (elevation, rivers, biomes)
• Extensibility points:
• Custom point generators (jittered grid, Poisson disc)
• Plug-in noise functions (SimplexNoise or user-provided)
• Seeded RNG (makeRandInt / makeRandFloat)
• Execution pipeline spelled out in sample code.
a. Main Components
– Input Generators: boundary-point generator, Poisson-disc sampler
– Mesh Engine: Delaunator (external) → dual-mesh (TriangleMesh)
– WorldMap Generator: elevation, drainage, rivers, biome assignment modules
– Data Structures: Mesh, WorldMap
– External Libraries: SimplexNoise, Delaunator, poisson-disk-sampling, prng module
b. Relationships & Data Flow
1. Input Generators produce point set
2. Delaunator consumes points → raw triangles
3. dual-mesh augments triangles with ghost cells and builds connectivity
4. WorldMap consumes Mesh + noise + RNG → populates r_elevation, r_water, r_biome, lines_s arrays
5. Rendering module reads WorldMap → draws polygons/triangles on HTML canvas/SVG
c. Architectural Patterns / Principles
– Pipeline architecture: discrete steps chained (point gen → mesh → map gen → render)
– Modular design: dual-mesh packaged separately for reuse
– Struct-of-arrays for performance and cache locality
– Open-closed for extensibility (swap noise, RNG, point source)
d. Key Technologies & Libraries
– JavaScript/TypeScript
– Delaunator for triangulation
– dual-mesh library for Voronoi connectivity
– SimplexNoise for heightmap noise
– Poisson-disk sampling for point distribution
– @redblobgames/prng for seeded randomness