A CLI utility to create string art.
Create your string art here
This repo contains two crates:
strandifycrate contains the string art library.strandify-clicrate provides the command line interface.
And one npm package:
strandify-wasmprovides the wasm bindings and allowsstrandifyto be used in the browser.
To use the strandify binary to generate string art, install the strandify-cli crate:
cargo install strandify-cliOnce installed, you can use the strandify binary.
Something like:
strandify input_img.png output_img.pngIf in doubt see the help:
$ strandify -h
CLI utility to generate string art
Usage: strandify [OPTIONS] <INPUT> [OUTPUT]
Arguments:
<INPUT> Input image or blueprint json file
[OUTPUT] Output file, either image format, svg or json
Options:
-i, --iterations <ITERATIONS>
Number of iterations [default: 4000]
-t
Transparent background
-c, --yarn-color <YARN_COLOR>
Yarn color [default: "0 0 0"]
--project-to-yarn-color
Project image to yarn color
-S, --peg-shape <SHAPE>
Peg distribution shape [default: circle] [possible values: circle, square, border]
-n, --peg-number <PEG_NUMBER>
Number of pegs. Depending on the shape, can be slightly off [default: 288]
-m, --peg-margin <PEG_MARGIN>
Margin between pegs and image edge [0, 1] [default: 0.05]
-j, --peg-jitter <PEG_JITTER>
Add jitter to the peg position
-s, --peg-skip-within <PEG_SKIP_WITHIN>
Don't connect pegs within pixel distance
-O, --yarn-opacity <YARN_OPACITY>
Yarn opacity to use to render the image [0, 1] [default: 0.2]
-W, --yarn-width <YARN_WIDTH>
Yarn width to use to render the image [default: 1]
-o, --line-opacity <LINE_OPACITY>
Line opacity to use when computing the path, controls how much to lighten the pixels at each line pass, low values encourage more line overlap [0, 1] [default: 0.1]
-w, --line-width <LINE_WIDTH>
Line width to use when computing the path [default: 2]
-b, --beam-width <BEAM_WIDTH>
Beam search width, a value of 1 results in a purely greedy algorithm [default: 1]
-e, --early-stop-threshold <EARLY_STOP_THRESHOLD>
If provided, early stop pathing when consecutive path losses are greater than threshold
-E, --early-stop-count <EARLY_STOP_COUNT>
Number of consecutive iterations with path losses above threshold to allow [default: 100]
--output-scale <OUTPUT_SCALE>
Output scale [default: 1]
--save-pegs <PEG_SAVE_FILE>
Write pegs to file
--load-pegs <PEG_LOAD_FILE>
Read pegs from file
-v, --verbose...
Increase logging verbosity
-q, --quiet...
Decrease logging verbosity
-h, --help
Print helpTo use the library as a dependency in your project, add the strandify crate:
cargo add strandifySee the docs for usage.
To use the wasm bindings in your project, add the strandify-wasm npm package:
npm add strandify-wasmI would recommend taking a look at the demo page's source code to see how to use it.
See the examples folder.