snapmatic-converter

GTA Snapmatic to JPEG converter

Usage no npm install needed!

<script type="module">
  import snapmaticConverter from 'https://cdn.skypack.dev/snapmatic-converter';
</script>

README

GTA Snapmatic image converter

CircleCI codecov npm version

Description

Scan for Snapmatic images in a source directory, convert them into JPEG format and place them into the destination source.

Installation

You can install it as a global NPM package:

$ sudo yarn global add snapmatic-converter

Or you can install it locally to a project:

$ yarn add snapmatic-converter

Usage

$ snapmatic-converter <source-dir> <destination-dir>

Also you can use as an usual module:

import { SnapConverter } from 'snapmatic-converter';
const snapToJpg = new SnapConverter('srcdir','dstdir')
snapToJpg.convertAllFiles()
snapToJpg.processSingleFile('PGTA51876361281')
snapToJpg.convertSomeFiles(['PGTA52078400596','PGTA51370982198','PGTA5916100621'])

Tests

If you're using this software from NPM, it's already tested. You can pass the tests with:

$ yarn install
$ yarn test:unit
# To see coverage, add the proper flag
$ yarn test:unit --coverage

Contribute

If you want to contribute to this project please don't hesitate to send a pull request. You can also open new issues to ask questions and participate in discussions.

Software and libraries used

Copyright & License

This program is free software; you can redistribute it and/or modify it under the terms of the MIT license. Find more information about this on the LICENSE file.

Upload to NPM

$ yarn install
$ yarn publish