Skip to content

Latest commit

 

History

History
69 lines (46 loc) · 4.75 KB

README.org

File metadata and controls

69 lines (46 loc) · 4.75 KB

Mapgen4

http://unmaintained.tech/badge.svg

Mapgen4 is a procedural wilderness map generator I wrote during 2017 and 2018, and updated in 2023. It’s written in JavaScript/TypeScript and designed to:

  • run fast enough to regenerate in real time as you paint terrain
  • look pretty instead of generating realistic terrain

https://www.redblobgames.com/maps/mapgen4/blog/screenshot15-small.jpg

Install

With npm or pnpm:

npm install -g esbuild
npm install
./build.sh

Run python3 -m http.server 8000, then visit http://localhost:8000/embed.html in your browser.

Background

I have a series of blog posts about how I made these maps:

It’s a continuation of ideas I developed for mapgen2 back in 2010, but at a much larger scale. The underlying code can support 1 million+ Voronoi cells (change spacing in config.js to 0.7), including a very detailed river network, but the rendering code and other parameters are designed to look prettiest around 25k cells.

There’s plenty more that could be done to make it even faster and prettier. There are plenty of features that could be added, such as drawing your own rivers, sphere output, natural resources, towns, forests, names, roads, and nations, but I’m leaving those for a future project.

Code

The entry point is mapgen4.ts. The main data structures are in the dual-mesh/ folder. The map generation algorithms are in map.ts. The input painting is in painting.ts. The output rendering is in render.ts. Calculations are in worker.ts. Calculations shared between the worker and renderer are in geometry.ts.

Although the code is TypeScript, I’m using esbuild for building, which does not check the types. Instead, I have type checking in the IDE only.

License

Mapgen4 and helper libraries I wrote (dual-mesh, prng) are licensed under Apache v2. You can use this code in your own project, including commercial projects.

The map generator uses these libraries:

The rendering code uses these libraries:

  • regl from Mikola Lysenko is licensed under the MIT license.
  • gl-matrix from Brandon Jones, Colin MacKenzie IV is licensed under the MIT license.

The build step uses esbuild from Evan Wallace, licensed under the MIT license