diff --git a/.npmpackagejsonlintrc.json b/.npmpackagejsonlintrc.json new file mode 100644 index 0000000..776d532 --- /dev/null +++ b/.npmpackagejsonlintrc.json @@ -0,0 +1,3 @@ +{ + "extends": "npm-package-json-lint-config-default" +} diff --git a/README.md b/README.md new file mode 100644 index 0000000..a879eee --- /dev/null +++ b/README.md @@ -0,0 +1,21 @@ +# GoPro Telemetry Exporter + +A cli tool to export GoPro metadatas from video files. + +## Usage + +`gopro-telemetry-exporter --input GPX010001.MP4 --output GPX010001.gpx --GPS5Fix 3 --preset gpx --groupTimes 200` + +* `--input` is the path of the GoPro video file +* `--output` is the path to metadatas output file ( can be gpx, kml, +geojson, csv, mgjson, virb, and other format that can be supported by +[GoPro Telemetry Presets](https://www.npmjs.com/package/gopro-telemetry#user-content-presets)) +* All other options will be pass directly to [GoPro Telemetry](), you + can check the list + +## TODO + +* Check all the presets +* Implement progress + +https://www.npmjs.com/package/gopro-telemetry diff --git a/gopro-telemetry-exporter b/bin/gopro-telemetry-exporter.js similarity index 96% rename from gopro-telemetry-exporter rename to bin/gopro-telemetry-exporter.js index 6560a78..c9c09fb 100755 --- a/gopro-telemetry-exporter +++ b/bin/gopro-telemetry-exporter.js @@ -1,4 +1,7 @@ -#!/bin/node +#!/usr/bin/env node + +'use strict'; + const gpmfExtract = require('gpmf-extract'); const goproTelemetry = require(`gopro-telemetry`); const fs = require('fs'); diff --git a/package-lock.json b/package-lock.json index 98f266b..c9f0cfd 100644 --- a/package-lock.json +++ b/package-lock.json @@ -1,5 +1,5 @@ { - "name": "gopro-extract", + "name": "gopro-telemetry-exporter", "version": "1.0.0", "lockfileVersion": 1, "requires": true, @@ -3166,6 +3166,12 @@ } } }, + "npm-package-json-lint-config-default": { + "version": "3.0.0", + "resolved": "https://registry.npmjs.org/npm-package-json-lint-config-default/-/npm-package-json-lint-config-default-3.0.0.tgz", + "integrity": "sha512-1eOHUSg4Pg1lDp75NJ/pTnYU3/vn7WIL+3MG5KWtrUEFtIuBX/yLGABTFZ4+sP73bQYu/Nla07icJjezQP6SnA==", + "dev": true + }, "rfc4648": { "version": "1.4.0", "resolved": "https://registry.npmjs.org/rfc4648/-/rfc4648-1.4.0.tgz", diff --git a/package.json b/package.json index d1fa2b3..964e502 100644 --- a/package.json +++ b/package.json @@ -1,18 +1,46 @@ { - "name": "gopro-extract", + "name": "gopro-telemetry-exporter", "version": "1.0.0", - "description": "", - "main": "gpx-extract.js", + "description": "A cli tool to parse telemetry from the GPMF track in GoPro cameras (Hero5 and later).", + "keywords": [ + "GoPro", + "GPS", + "GPMF", + "mgjson", + "GPX", + "CSV", + "KML", + "geojson", + "accelerometer", + "gyroscope", + "telemetry", + "metadata", + "sensors", + "converter", + "parser", + "cli" + ], + "repository": { + "type": "git", + "url": "https://home.hugopoi.net/gitea/hugopoi/gopro-telemetry-exporter.git" + }, + "homepage": "https://home.hugopoi.net/gitea/hugopoi/gopro-telemetry-exporter", + "bin": "./bin/gopro-telemetry-exporter.js", "dependencies": { "gopro-telemetry": "^1.1.34", "gpmf-extract": "^0.1.21", "lodash": "^4.17.20", "minimist": "^1.2.5" }, - "devDependencies": {}, + "devDependencies": { + "npm-package-json-lint-config-default": "^3.0.0" + }, "scripts": { "test": "echo \"Error: no test specified\" && exit 1" }, - "author": "", - "license": "ISC" + "author": { + "name": "HugoPoi", + "url": "https://blog.hugopoi.net/" + }, + "license": "GPL-3.0-or-later" }