MapLibre Sprite Generator

A command-line tool for generating sprite sheets from SVG icons for use with MapLibre GL / Mapbox GL map styles.

Features

• Converts SVG icons to sprite sheets (regular and retina/2x)
• Optimizes SVGs before processing
• Generates sprite metadata in MapLibre/Mapbox GL format
• Supports custom input/output directories
• Configurable sprite sheet prefix

Installation

# Clone the repository
git clone [repository-url]
cd maplibre-sprite-generator

# Install dependencies
yarn install

Usage

Basic usage:

yarn start --input=./icons --output=./sprites

Command Line Options

• --input, -i: Input directory containing SVG icons (default: ./icons)
• --output, -o: Output directory for sprite sheets and metadata (default: ./sprites)
• --optimize, -z: Enable/disable SVG optimization (default: true)
• --prefix, -p: Prefix for sprite filenames (default: sprite)
• --help, -h: Show help information

Output Files

The tool generates the following files in the output directory:

• sprite.png - Regular sprite sheet
• sprite@2x.png - Retina (2x) sprite sheet
• sprite.json - Metadata for regular sprite sheet
• sprite@2x.json - Metadata for retina sprite sheet

Development

Project Structure

.
├── lib/
│   ├── spriteGenerator.js  # Core sprite generation logic
│   ├── svgOptimizer.js     # SVG optimization utilities
│   └── utils.js           # Common utilities and logging
├── index.js               # CLI entry point
└── package.json

Dependencies

• fs-extra: Enhanced file system operations
• glob: File pattern matching
• potpack: Rectangle packing algorithm
• sharp: Image processing
• spritesmith: Sprite sheet generation
• svgo: SVG optimization
• yargs: Command line argument parsing

License

MIT