https://github.com/digidem/mapeo-settings-builder
Build presets and sprites for the Mapeo apps
https://github.com/digidem/mapeo-settings-builder
Last synced: about 22 hours ago
JSON representation
Build presets and sprites for the Mapeo apps
- Host: GitHub
- URL: https://github.com/digidem/mapeo-settings-builder
- Owner: digidem
- Created: 2016-08-01T09:23:12.000Z (almost 9 years ago)
- Default Branch: main
- Last Pushed: 2025-04-08T18:04:00.000Z (25 days ago)
- Last Synced: 2025-04-19T13:13:44.398Z (14 days ago)
- Language: JavaScript
- Homepage:
- Size: 683 KB
- Stars: 3
- Watchers: 2
- Forks: 1
- Open Issues: 25
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
Awesome Lists containing this project
- awesome-starred - digidem/mapeo-settings-builder - Build presets and sprites for the Mapeo apps (others)
README
# Mapeo Settings Builder
[![npm version][1]][2]
[![js-standard-style][3]][4]
[1]: https://img.shields.io/npm/v/mapeo-settings-builder.svg
[2]: https://www.npmjs.com/package/mapeo-settings-builder
[3]: https://img.shields.io/badge/code%20style-standard-brightgreen.svg
[4]: http://standardjs.com/
> Build settings file for [Mapeo Desktop](https://github.com/digidem/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](https://github.com/digidem/mapeo-desktop) to configure the application for a particular use-case.
## Table of Contents
- [Installation](#installation)
- [Usage](#usage)
- [Contribute](#contribute)
- [License](#license)
## Install
```
npm install --global mapeo-settings-builder
```
## Usage
```sh
# Lint settings
mapeo-settings lint
# Build settings tar file and output to stdout
mapeo-settings build {OPTIONS}
# Generate a project key
mapeo-settings generate-key
```
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
├── metadata.json
└── style.css
```
Where:
- `imagery.json` is an object that should follow the structure defined by [editor-layer-index](https://github.com/osmlab/editor-layer-index/blob/gh-pages/schema.json)
- `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](https://github.com/openstreetmap/iD/tree/master/data/presets)
- `metadata.json` contains optional properties:
- `projectKey` is a 32 byte (256-bit) random number encoded as a `hex` string (numbers 0-9 and lowercase letters a-f)
- `name` is a human-readable name of these presets (written from `package.json` if it does not already exist)
- `version` is the version number of the presets (written from `package.json` if it does not already exist)
- `syncServer` is the URL of a mapeo-web server to sync to. (written from `package.json` if it does not already exist). For the Digital Democracy server this should be `wss://cloud.mapeo.app`, but the project key will need to be enabled on the server first.
### Options
- `-l, --lang=` - the base language of the settings, defaults to `en`.
- `-o, --output=` - write the settings tarball to this file, if unspecified prints to stdout.
- `-t, --timeout=` - timeout limit (in milliseconds) for icon generation process.
## Contribute
PRs accepted.
Small note: If editing the Readme, please conform to the [standard-readme](https://github.com/RichardLitt/standard-readme) specification.
## License
MIT © Digital Democracy