{"id":13397952,"url":"https://github.com/Anemy/svgurt","last_synced_at":"2025-03-14T00:32:52.032Z","repository":{"id":65503735,"uuid":"127025783","full_name":"Anemy/svgurt","owner":"Anemy","description":"Image -\u003e SVG Vectorizing Tool - Live at:","archived":false,"fork":false,"pushed_at":"2023-02-06T09:35:16.000Z","size":24703,"stargazers_count":183,"open_issues_count":3,"forks_count":15,"subscribers_count":7,"default_branch":"main","last_synced_at":"2024-10-20T05:23:07.050Z","etag":null,"topics":["converter","javascript","npm-package","png","svg","vectorization"],"latest_commit_sha":null,"homepage":"https://svgurt.com","language":"JavaScript","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/Anemy.png","metadata":{"files":{"readme":"README.md","changelog":"CHANGELOG.md","contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null}},"created_at":"2018-03-27T17:56:17.000Z","updated_at":"2024-10-04T13:27:43.000Z","dependencies_parsed_at":"2023-02-19T06:15:27.536Z","dependency_job_id":null,"html_url":"https://github.com/Anemy/svgurt","commit_stats":null,"previous_names":[],"tags_count":4,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Anemy%2Fsvgurt","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Anemy%2Fsvgurt/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Anemy%2Fsvgurt/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Anemy%2Fsvgurt/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/Anemy","download_url":"https://codeload.github.com/Anemy/svgurt/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":243505147,"owners_count":20301559,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["converter","javascript","npm-package","png","svg","vectorization"],"created_at":"2024-07-30T18:01:57.246Z","updated_at":"2025-03-14T00:32:50.258Z","avatar_url":"https://github.com/Anemy.png","language":"JavaScript","readme":"# [Svgurt](http://svgurt.com) \u0026middot; [![GitHub license](https://img.shields.io/badge/license-MIT-blue.svg)](https://github.com/Anemy/svgurt/blob/main/LICENSE) [![NPM](https://img.shields.io/npm/v/svgurt.svg)](https://www.npmjs.com/package/svgurt)\n\nSvgurt is a configurable, interactive image to SVG converting tool.\n\n\u003cimg src=\"https://i.imgur.com/HLDuuqS.png\" width=\"60%\" /\u003e\n\n## Usage\n\n### Installation\n\nInstall svgurt using [NPM](https://nodejs.org/en/download), and add it to your package.json dependencies:\n\n`npm install svgurt --save`\n\nSvgurt can then be used from the command line or programmatically as a module.\n\n### Using Svgurt Programatically\n\nSvgurt can be used with node js.\n\nES5 module:\n\n`const svgurt = require('svgurt');`\n\nES6 module:\n\n`import svgurt from 'svgurt';`\n\nNext call svgurt with a [config](https://github.com/Anemy/svgurt#config) object:\n\n```js\nconst config = {\n  input: \"someImage.jpg\",\n  output: \"output file name\",\n  blur: 2\n};\n\nsvgurt(config);\n```\n\n### CLI\n\nFull docs can be found in the [CLI Documentation](http://svgurt.com/#/cli).\n\nTo run svgurt from command line, navigate to the folder where you have installed it using npm (or anywhere if you use the `-g` flag). Then run svgurt by supplying a config file:\n`svgurt config.json`.\n[Config documentation](https://github.com/Anemy/svgurt#config).\n\n### Default Config\n\nWhen using Svgurt programatically or through the command line, you need to supply a config. Any fields in your configuration that are omitted will default to the following:\n\n```js\n{\n  input: 'image.jpg', // This can be an array of input file names as well. jpg and png are both supported.\n  output: 'svgurt-output', // This is the name of the file svgurt will save to if 'returnSVGString' is 'false'. It will also accept an array sequentially coupled with 'input'.\n  returnSVGString: false, // When true the cli or module will return the svg output as a string instead of saving to a file.\n  \n  // Image Controls\n  blur: 0,\n  grayscale: false,\n  invert: false,\n  'Edge Detection': false,\n  postBlur: 0,\n  posterize: false,\n  posterizeLevels: 5,\n  lowThreshold: 20,\n  highThreshold: 50,\n  applyFractalField: false,\n  fieldOpacity: 0.5,\n  fieldRatioX: 0.01,\n  fieldRatioY: 0.01,\n  fieldRandomSeed: 9661,\n\n  // SVG Controls\n  amplitude: 5,\n  amplitudeRandomness: 0.5,\n  amountOfLines: 150,\n  continuous: false,\n  crossHatch: true,\n  direction: 30,\n  directionRandomness: 0.01,\n  displaceOrigin: false,\n  lineLength: 6,\n  lengthOnColor: true,\n  lengthRandomness: 0.2,\n  minColorRecognized: 50,\n  maxColorRecognized: 200,\n  maxRecursiveDepth: 150,\n  minLineLength: 1,\n  randomSeed: 1011,\n  radius: 1.5,\n  radiusOnColor: true,\n  radiusRandomness: 0.25,\n  recursiveAlgorithm: 'fifth', // One of 'first', 'second', 'third', 'fourth', or 'fifth'.\n  renderEveryXPixels: 5,\n  renderEveryYPixels: 5,\n  scale: 1,\n  startAtCenterOfShapes: false,\n  strokeColor: 'rgb(28, 32, 38)',\n  strokeWidth: 1,\n  strokeWidthRandomness: 0.1,\n  svgRenderType: 'RECURSIVE', // One of: 'CIRCLE', 'CURVE', 'LINE', 'RECURSIVE', or 'CONCENTRIC'.\n  wavelength: 3,\n  wavelengthRandomness: 0.5,\n  waves: 3,\n  wavesRandomness: 0.5,\n  applyFractalDisplacement: false,\n  displacementAmount: 5,\n  fractalRatioX: 0.01,\n  fractalRatioY: 0.01,\n  fractalRandomSeed: 9996,\n  autoColor: false,\n  circleArcs: 200,\n  intensityWeight: 100000,\n  radiusStep: '5'\n}\n```\n\n## Local Development of Svgurt\n\n### Installation\n\nInstall node js from https://nodejs.org/en/download/\n\n```bash\n$ # Clone this repo and navigate to the cloned folder.\n$ npm install\n```\n\n### Development\n\n```bash\n$ npm start\n$ browser https://localhost:3000\n```\n\n\nIf you'd like to see something added, create an issue or make a PR! 🚀\n\n### License\n\nSvgurt is [MIT licensed](./LICENSE).\n","funding_links":[],"categories":["JavaScript"],"sub_categories":[],"project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2FAnemy%2Fsvgurt","html_url":"https://awesome.ecosyste.ms/projects/github.com%2FAnemy%2Fsvgurt","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2FAnemy%2Fsvgurt/lists"}