Skip to content
Build presets and sprites for the Mapeo apps
JavaScript
Branch: master
Clone or download
Fetching latest commit…
Cannot retrieve the latest commit at this time.

Files

Permalink
Type Name Latest commit message Commit time
Failed to load latest commit information.
bin
schema
scripts
CHANGELOG.md
README.md
package-lock.json
package.json

README.md

Mapeo Settings Builder

npm version js-standard-style

Build settings file for Mapeo Desktop

When run in a folder of configuration, icon files and imagery definitions will create a single settings tarball which can be imported into Mapeo Desktop to configure the application for a particular use-case.

Table of Contents

Install

npm install --global mapeo-settings-builder

Usage

# Lint settings
mapeo-settings lint

# Build settings tar file and output to stdout
mapeo-settings build {OPTIONS}

Mapeo Presets Builder expects the following file structure in the current directory:

├── categories
│   ├── a_category.json
│   ├── other_category.json
│   └── ...
├── fields
│   ├── a_field.json
│   ├── other_field.json
│   └── ...
├── presets
│   ├── preset_category
│   │   ├── a_preset.json
│   │   ├── other_preset.json
│   │   └── ...
│   ├── other_preset_category
│   │   ├── a_preset.json
│   │   ├── other_preset.json
│   │   └── ...
│   ├── uncategorized_preset.json
│   ├── other_uncategorized_preset.json
│   └── ...
├── icons
│   ├── a_icon.svg
│   ├── other_icon.svg
│   └── ...
├── defaults.json
├── imagery.json
└── style.css

Where:

  • imagery.json is an object that should follow the structure defined by editor-layer-index
  • style.css is custom css to override iD css.
  • icons is a folder of svg images to build a sprite for preset icons
  • categories, fields, presets, defaults.json see iD presets

Options

  • -l, --lang=<langCode> - the base language of the settings, defaults to en.
  • -o, --output=<filename> - write the settings tarball to this file, if unspecified prints to stdout.

Contribute

PRs accepted.

Small note: If editing the Readme, please conform to the standard-readme specification.

License

MIT © Digital Democracy

You can’t perform that action at this time.