MapGenerator

• General Info
• Technologies
• Installation Guide

---

General Info

MapGenerator allows to generate simple 2d map and render it on HTML5 canvas element. There is support for scrolling and zooming of the generated map. Several generation parameters can be adjusted.
Path calculation feature allows to find the fastest way between two points using A* search algorithm.

Technologies

TypeScript (typed superset of JavaScript)
Webpack (module bundler)
Sass (css preprocessor)
prando (deterministic pseudo-random number generator)
fastpriorityqueue (fast, heap-based priority queue)
ts-jest (TypeScript preprocessor with sourcemap support for Jest)
jest (JavaScript testing framework)
Biome (linter & formatter for TypeScript/JavaScript)

GitHub Actions (continuous integration service)

Installation Guide

Prerequisites

Download and install nodejs (>= 24, see .nvmrc) with npm via https://nodejs.org/en/download/ or your system's specific package manager. Download and install git via https://git-scm.com/downloads or package manager.

Project installation

Clone this repository using:

git clone https://github.com/Sarratas/MapGenerator

Move to project catalog and run install through npm:

npm install

Local development

To run locally using webpack-dev-server with watch mode:

npm start

Testing

To run unit tests using jest:

npm test

To run linting and formatting checks through Biome:

npm run lint

To auto-fix lint issues and format the code:

npm run lint:fix