Merge branch 'main' of https://github.com/joanroig/swatches-to-ase

README.md

@@ -30,9 +30,16 @@ Be sure to have [Node.js](https://nodejs.org/en/download/) installed, then:
 - Run `npm run convert` to convert the palettes.
 - The converted files should be in the `palette-export` folder.
 
-### Extras
+## Configuration
 
-Run `npm run convert-bw` to add black and white colors to the exported palettes.
+The input, output, color naming and addition of black & white colors can be changed in: [config.json](config.json)
+
+### Configuration parameters
+
+- **inFolder:** folder used to read the swatches.
+- **outFolder:** folder used to output the resulting ase files.
+- **colorNameFormat:** sets the collection of color names to be used. Available namings are: _roygbiv, basic, html, x11, pantone, ntc_. See [color namer](https://github.com/colorjs/color-namer) for reference.
+- **addBlackWhite:** if true, two extra colors will be added:
 
 <p align="center">
   <img src="examples/ps-bw.png" alt="converted palette" width="300px"/>
@@ -48,6 +55,7 @@ https://bardotbrush.com/procreate-color-palettes/
 
 ### Libraries used
 
-https://github.com/szydlovski/procreate-swatches
-https://www.npmjs.com/package/color-convert
-https://github.com/DominikGuzei/node-ase-utils
+- https://github.com/szydlovski/procreate-swatches
+- https://www.npmjs.com/package/color-convert
+- https://github.com/DominikGuzei/node-ase-utils
+- https://github.com/colorjs/color-namer

config.json

@@ -0,0 +1,6 @@
+{
+  "inFolder": "palette-in/",
+  "outFolder": "palette-out/",
+  "colorNameFormat": "pantone",
+  "addBlackWhite": true
+}

nodemon.json

@@ -2,5 +2,5 @@
   "watch": ["src"],
   "ext": ".ts,.js",
   "ignore": [],
-  "exec": "ts-node ./src/index.ts"
+  "exec": "npx tsx ./src/index.ts"
 }