{"_id":"@4bitlabs/scipainter","_rev":"2-72729a69c3d259925fd2a4f1fa219e0b","name":"@4bitlabs/scipainter","dist-tags":{"latest":"1.0.1"},"versions":{"1.0.0":{"name":"@4bitlabs/scipainter","version":"1.0.0","author":{"name":"J. Holmes","email":"j@holmes.codes"},"license":"ISC","_id":"@4bitlabs/scipainter@1.0.0","maintainers":[{"name":"32bitkid","email":"32bitkid@gmail.com"}],"bin":{"scipainter":"dist/index.mjs"},"dist":{"shasum":"ace285c3dfd6f10415d6bb0caf0c6d444d05f81a","tarball":"https://registry.npmjs.org/@4bitlabs/scipainter/-/scipainter-1.0.0.tgz","fileCount":34,"integrity":"sha512-w5MT+srYFOWQ6dQo/fS2n1BwA4AGsIjWQWvvgKBRFvV32jFDv+R/bGOGkjBxR5pHvCW8EQYz25hZe+4hJarzWA==","signatures":[{"sig":"MEYCIQD2U3tVKmsfUgf5+FzLS5gtqSdIPlliWRH5vLO/4JXE2wIhAKKsKzPE4DH9S4M+Uz0TTWZD4gxX8JaKIhJ4PIbhqb1P","keyid":"SHA256:DhQ8wR5APBvFHLF/+Tc+AYvPOdTpcIDqOhxsBHRwC7U"}],"unpackedSize":171272},"type":"module","exports":"./dist/index.mjs","gitHead":"1e1c5c71c9ad17b59f7781b1e5446bf3883c5e52","scripts":{"exec":"","lint":"biome check","test":"echo \"Error: no test specified\" && exit 1","build":"tsdown"},"_npmUser":{"name":"32bitkid","email":"32bitkid@gmail.com"},"_npmVersion":"12.0.1","description":"![Space Quest 3 Demo PIC.002](https://raw.githubusercontent.com/32bitkid/4bitlabs.scipainter/main/assets//r.sq3demo.002.webp)","directories":{},"_nodeVersion":"22.23.1","allowScripts":{"fsevents@2.3.3":true},"dependencies":{"roughjs":"^4.6.6","commander":"^15.0.0","pure-rand":"^8.4.2","@4bitlabs/sci0":"^6.1.1","@4bitlabs/color":"^4.0.1","@napi-rs/canvas":"^1.0.2","@4bitlabs/color-space":"^3.0.1","transformation-matrix":"^3.1.0","@watercolorizer/tracer":"^3.2.0","@4bitlabs/sci0-renderer":"^1.2.0","@4bitlabs/resize-filters":"^2.0.1","@watercolorizer/convolution":"^2.1.0","@watercolorizer/watercolorizer":"^2.1.0"},"_hasShrinkwrap":false,"devDependencies":{"tsdown":"^0.22.12","vitest":"^4.1.10","typescript":"^6.0.3","@types/node":"^26.1.1","@biomejs/biome":"^2.5.4"},"_npmOperationalInternal":{"tmp":"tmp/scipainter_1.0.0_1785347558436_0.8228348687345135","host":"s3://npm-registry-packages-npm-production"}},"1.0.1":{"name":"@4bitlabs/scipainter","version":"1.0.1","description":"CLI utility for rendering SCI0/SCI01 pic resources as hand-drawn images","license":"ISC","author":{"name":"J. Holmes","email":"j@holmes.codes"},"type":"module","exports":"./dist/index.mjs","bin":{"scipainter":"dist/index.mjs"},"scripts":{"lint":"biome check","build":"tsdown","exec":"","test":"echo \"Error: no test specified\" && exit 1"},"dependencies":{"@4bitlabs/color":"^4.0.1","@4bitlabs/color-space":"^3.0.1","@4bitlabs/resize-filters":"^2.0.1","@4bitlabs/sci0":"^6.1.1","@4bitlabs/sci0-renderer":"^1.2.0","@napi-rs/canvas":"^1.0.2","@watercolorizer/convolution":"^2.1.0","@watercolorizer/tracer":"^3.2.0","@watercolorizer/watercolorizer":"^2.1.0","commander":"^15.0.0","pure-rand":"^8.4.2","roughjs":"^4.6.6","transformation-matrix":"^3.1.0"},"devDependencies":{"@biomejs/biome":"^2.5.4","@types/node":"^26.1.1","tsdown":"^0.22.12","typescript":"^6.0.3","vitest":"^4.1.10"},"allowScripts":{"fsevents@2.3.3":true},"gitHead":"29c7cc22520e0b6dd125950603f75df1894b8f59","_id":"@4bitlabs/scipainter@1.0.1","_nodeVersion":"22.23.1","_npmVersion":"12.0.1","dist":{"integrity":"sha512-6yxPTUM4AgrJYypKAkjlHP1lViN/YOqzM5VG92GAoq7aP5Xp+864kjEmiLJxxBJ7yhQzLhNaaKUvKNMUnDU8Pw==","shasum":"cbc186f865e49bd8f066c9f481878379d2416be2","tarball":"https://registry.npmjs.org/@4bitlabs/scipainter/-/scipainter-1.0.1.tgz","fileCount":36,"unpackedSize":173008,"signatures":[{"keyid":"SHA256:DhQ8wR5APBvFHLF/+Tc+AYvPOdTpcIDqOhxsBHRwC7U","sig":"MEQCIGMj/KgB8rxoUeZKmMv75SKfLgfwYh8ZOHvGWMtiIlFYAiA14rN+Cyw4PvMZ66SQKDx61H3QHyCjjKjdesZf4Z+f3w=="}]},"_npmUser":{"name":"32bitkid","email":"32bitkid@gmail.com"},"directories":{},"maintainers":[{"name":"32bitkid","email":"32bitkid@gmail.com"}],"_npmOperationalInternal":{"host":"s3://npm-registry-packages-npm-production","tmp":"tmp/scipainter_1.0.1_1785350799206_0.030255322962987607"},"_hasShrinkwrap":false}},"time":{"created":"2026-07-29T17:52:38.229Z","modified":"2026-07-29T18:46:39.580Z","1.0.0":"2026-07-29T17:52:38.587Z","1.0.1":"2026-07-29T18:46:39.399Z"},"author":{"name":"J. Holmes","email":"j@holmes.codes"},"license":"ISC","description":"CLI utility for rendering SCI0/SCI01 pic resources as hand-drawn images","maintainers":[{"name":"32bitkid","email":"32bitkid@gmail.com"}],"readme":"# @4bitlabs/scipainter\n\n[![License][license]][npm]\n[![NPM Version][version]][npm]\n[![Ko-fi][kofibadge]][kofi]\n\n![Space Quest 3 Demo PIC.002](https://raw.githubusercontent.com/32bitkid/4bitlabs.scipainter/main/assets//r.sq3demo.002.webp)\n\n[npm]: https://www.npmjs.com/package/@4bitlabs/scipainter\n[version]: https://img.shields.io/npm/v/%404bitlabs%2Fscipainter\n[license]: https://img.shields.io/npm/l/%404bitlabs%2Fscipainter\n[dl]: https://img.shields.io/npm/dy/%404bitlabs%2Fscipainter\n[kofibadge]: https://shields.io/badge/ko--fi-donate-ff5f5f?logo=ko-fi&style=for-the-badgeKo-fi\n[kofi]: https://ko-fi.com/32bitkid\n\n## Usage\n\n```\nnpx @4bitlabs/scipainter\n```\n\n## Commands\n\n```text \nUsage: scipainter [options] [command]\n\nRender SCI0/SCI01 pic images in a stylized, artistic style\n\nOptions:\n  -V, --version           output the version number\n  -r, --root <path>       sci0/sci01 path (default: \".\")\n  -e, --engine <engine>   SCI engine version (choices: \"sci0\", \"sci01\", default:\n                          \"sci0\")\n  -h, --help              display help for command\n\nCommands:\n  render [options] <pic>\n  help [command]          display help for command\n```\n\n## Rendering a PIC \n\n```text\nUsage: scipainter render [options] <pic>\n\nArguments:\n  pic                         PIC resource number\n\nOptions:\n  -o, --output <file>         output filename. use '-' to output to STDOUT\n  -f, --format <format>       (choices: \"jpeg\", \"webp\", \"png\", default: \"png\")\n  --show-seed                 output the seed to STDERR\n  -s, --seed <seed>           seed to use for pRNG in base36. default: random\n                              number\n  --background-color <color>  background color (default: \"white\")\n  --paper <path>              path to optional paper texture\n  -h, --help                  display help for command\n```\n\nFor example, let's say you have an archive of the Space Quest 3 Demo, which can be found\nfreely online in several archives, in a folder `./sq3demo`. You can render `PIC.002` from with:\n\n```bash\nnpx @4bitlabs/scipainter --root ./sq3demo render 2 \n```\n\n> [!note]\n> _But, how do you know what PIC id to use?_ You can use `@4bitlabs/scibud` to help\n> identify what PIC resources are available for a given game. See the\n> [GitHub documentation](https://github.com/32bitkid/sci.js/tree/main/apps/scibud)\n> for more details.\n\nThis will create a image named `render.png`. You can change the format by using the `--format` option.\n\n```bash\nnpx @4bitlabs/scipainter -r ./sq3demo render 2 --format jpeg\n```\n\nAnd also set the output file:\n\n```bash\nnpx @4bitlabs/scipainter -r ./sq3demo render 2 -f webp --output sq3demo.002.webp\n```\n\n## Randomness and seeds\n\nEvery render will, by default, select a random seed for the pRNG, this results in reach rendering \nbeing unique. Using the same seed should produce the same visual result. Use the `--seed` option to\nmanually set the seed, for reproducible images. When rendering, you can use `--show-seed` to output \nthe current seed, even if its random, so it can be reused later.\n\n```bash\n$ npx @4bitlabs/scipainter -r /path/to/sci/game render 1 --show-seed\nseed: tg609d\n\n$ npx @4bitlabs/scipainter -r /path/to/sci/game render 1 --seed tg609d\n```\n\n> [!warning]\n> At this time, stable image regeneration—from the same seed—is _not_ guaranteed between \n> different versions of this program. So, renderings with `1.1.0` may produce different results\n> than `1.5.0`, even using the same `seed`. This is a short-coming I may address in the future.\n\n## More Examples \n\n<figure>\n    <img src=\"https://raw.githubusercontent.com/32bitkid/4bitlabs.scipainter/main/assets//r.qg1demo.064.webp\" alt=\"Quest for Glory 1 Demo PIC.064\">\n    <figcaption>Quest for Glory 1 Demo <code>PIC.064</code></figcaption>\n</figure>\n\n<figure>\n    <img src=\"https://raw.githubusercontent.com/32bitkid/4bitlabs.scipainter/main/assets//r.cocdemo.012.webp\" alt=\"Conquests of Camelot Demo Demo PIC.012\">\n    <figcaption>Conquests of Camelot Demo <code>PIC.012</code></figcaption>\n</figure>\n\n## Related Projects\n\n- Sierra SCI0/SCI01 parsing: https://github.com/32bitkid/sci.js\n- Procgen watercolor effect: https://github.com/32bitkid/watercolorizer\n","readmeFilename":"README.md"}