# img-to-map

> Generate GPX files from images with GPS data by using ExifTool

Latest version **0.1.0** (published 2023-08-18) · MIT license · 0 weekly downloads

## Install

```sh
npm install img-to-map
pnpm add img-to-map
yarn add img-to-map
bun add img-to-map
```

Provides the command `img-to-map`.

## Health

**Score 15/100 (F)** — status: abandoned.

Positive: no vulnerabilities.

Warnings: low downloads; no types; no esm support; pre 1.0.

Negative: abandoned; low maintenance score.

## Facts

| | |
|---|---|
| Version | 0.1.0 |
| Published | 2023-08-18 |
| First published | 2023-08-04 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | none |
| Module format | CommonJS |
| Dependencies | 0 |
| Unpacked size | 198.3 KB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| Maintainers | husky-dev |
| Keywords | map, gpx, exiftool, cli |

## Links

- npm: https://www.npmjs.com/package/img-to-map
- npm.io page: https://npm.io/package/img-to-map

## Alternatives

- [@salesforce/cli](https://npm.io/package/@salesforce/cli.md) — 389.7K weekly downloads
- [@mintlify/cli](https://npm.io/package/@mintlify/cli.md) — 208.9K weekly downloads
- [@grafana/e2e-selectors](https://npm.io/package/@grafana/e2e-selectors.md) — 128.7K weekly downloads
- [mintlify](https://npm.io/package/mintlify.md) — 112.0K weekly downloads
- [@intlayer/cli](https://npm.io/package/@intlayer/cli.md) — 22.8K weekly downloads

## Recent versions

- 0.1.0 (latest) — 2023-08-18
- 0.0.0 — 2023-08-04

## README

# Img to Map CLI Tool

![Lint](https://github.com/husky-dev/craft-content/workflows/Lint/badge.svg)
![Test](https://github.com/husky-dev/craft-content/workflows/Test/badge.svg)

`img-to-map` is a command line tool for generating GPX (GPS Exchange Format) files from images that contain GPS data. The tool uses [ExifTool](https://exiftool.org/) to extract the geographical coordinates from your photos and create a GPX track from them.

![img-to-map result example](docs/example.jpg)

GPX is a widely accepted data format that allows for the sharing and visualizing of GPS data across a variety of platforms and services. Once you've generated a GPX file with `img-to-map`, you can upload it to platforms such as [Strava](https://strava.com/) or [Google Maps](https://www.google.com/maps), or use other tracking services or map software that supports the GPX format. This opens a plethora of possibilities, including analyzing your journey, sharing your travel routes with others, or re-living your adventures.

## Installation

Before using `img-to-map`, you need to have [ExifTool](https://exiftool.org/) installed on your system.

Installation:

```bash
npm install -g img-to-map
```

Or by using [npx](https://www.npmjs.com/package/npx):

```bash
npx img-to-map
```

## Usage

```bash
img-to-map [options]
```

The tool is configurable with the following options:

| Option                               | Description                                                 | Default Value |
|--------------------------------------|-------------------------------------------------------------|---------------|
| `-v, --version`                      | Output the current version                                  | N/A           |
| `-n, --name`                         | Set the track name                                          | "My Track"    |
| `-t, --type`                         | Set the track type                                          | "hiking"      |
| `-f, --folder`                       | Specify the folder with photos                              | N/A           |
| `-o, --output`                       | Specify the output file                                     | "track.gpx"   |
| `-vp, --viewpoints <viewpoints>`     | Path to JSON file with viewpoints                           | N/A           |
| `-e, --extend <extend...>`           | Paths to JSON files to extend with the track                | N/A           |
| `--split-by-days`                    | Split each day into a separate file                         | N/A           |
| `--debug`                            | Output extra debugging information                          | N/A           |
| `-h, --help`                         | Display help for command                                    | N/A           |


## Examples

### Generate a GPX track with default settings:

To generate a GPX track file with the default settings, you only need to specify the folder with your photos:

```bash
img-to-map --folder /path/to/photos
```

The tool will generate a GPX file named `track.gpx` in the current directory. The track will have the name "My Track" and the type `hiking`.

### Generate a GPX track with custom settings:

To customize the output, you can use any of the available options. For example, you can set a custom track name and output file:

```bash
img-to-map --name "My Vacation" --folder /path/to/photos --output "vacation.gpx"
```

This will generate a file named `vacation.gpx` with the track name "My Vacation".

### Split tracks by days:

If you have photos from multiple days and you want to generate a separate track for each day, you can use the `--split-by-days` option:

```bash
img-to-map --folder /path/to/photos --split-by-days
```

The tool will generate a separate GPX file for each day.

### Extend your GPX track with multiple additional data segments

Sometimes, your journey may be spread across several GPX files, be it from different devices or different parts of your adventure. The `--extend` option offers flexibility by allowing you to merge multiple GPX files into your primary track, ensuring that your final track is comprehensive.

For instance, if you have two additional GPX files named `segment1.gpx` and `segment2.gpx` that contain different parts of your journey, you can integrate both into your main track.

Use the command:

```bash
img-to-map --folder /path/to/photos --extend /path/to/segment1.gpx --extend /path/to/segment2.gpx
```

This command takes the primary track data from your photos and successively merges it with the tracks from `segment1.gpx` and `segment2.gpx`. The final output is a consolidated GPX file that seamlessly connects the segments from all sources, giving a holistic view of your entire adventure.

Remember, you can use the `--extend` flag multiple times in a single command to incorporate as many additional GPX files as needed.

### Add viewpoints to your GPX track

To enhance your GPX track with specific viewpoints from a JSON file, use the `--viewpoints` option. This option allows you to provide additional context or highlight specific locations on your journey.

Given a `viewpoints.json` file structured as:

```json
[
  {
    "lat": 48.0908777777778,
    "lon": 24.5844305555556,
    "elevation": 1897,
    "name": "Camp, day 1",
    "symbol": "Campground"
  },
  {
    "lat": 48.1230055555556,
    "lon": 24.5399694444444,
    "elevation": 1755.3,
    "name": "Camp, day 2",
    "symbol": "Campground"
  }
]
```

Use the command:

```bash
img-to-map --folder /path/to/photos --viewpoints /path/to/viewpoints.json
```

This will generate a GPX track that includes the specified viewpoints, marking "Camp, day 1" and "Camp, day 2" with the symbol for "Campground". These can be visualized as points of interest when you upload the GPX file to platforms that support such features.

### Debugging:

If you encounter any problems or need to get more information about what the tool is doing, you can enable debugging output with the `--debug` option:

```bash
img-to-map --folder /path/to/photos --debug
```

## Help

For more information about the available options, you can use the `--help` command:

```bash
img-to-map --help
```

This will display a summary of the available options and their descriptions.

## Contacts

Jaroslav Khorishchenko

[hello@husky-dev.me](mailto:hello@husky-dev.me)

---
_Source: https://npm.io/package/img-to-map · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._