inkvec / studio /guide /troubleshooting.html
Incorporo-user's picture
Inkvec 0.2: the presentation page, and Inkvec Studio Lite under studio/
c2b84fb verified
Raw
History Blame Contribute Delete
12.9 kB
<!doctype html>
<html lang="en">
<head>
<meta charset="utf-8">
<meta name="viewport" content="width=device-width, initial-scale=1">
<meta name="inkvec-guide" content="studio">
<title>Troubleshooting and questions · Inkvec Studio guide</title>
<link rel="stylesheet" href="guide.css">
</head>
<body>
<div class="shell">
<aside class="side"><a class="guidebrand" href="index.html"><img src="logo-mono.svg" alt=""> <span>Inkvec Studio</span></a><div class="grp"><h4>User guide</h4><a href="index.html">Overview</a><a href="install.html">Install and first launch</a><a href="getting-started.html">Getting started</a><a href="viewer.html">The viewer</a><a href="result.html">Result</a><a href="tune.html">Tune</a><a href="palette.html">Palette and colour groups</a><a href="export.html">Export</a><a href="minify.html">Minify SVG</a><a href="fabricate.html">Fabricate</a><a href="batch.html">Batch</a><a href="settings.html">Settings</a><a href="shortcuts.html">Keyboard and mouse</a><a href="troubleshooting.html" aria-current="page">Troubleshooting</a></div><div class="grp"><h4>Tutorials</h4><a href="tutorials/jpeg-logo.html">Clean up a JPEG logo</a><a href="tutorials/favicon-asset-pack.html">A favicon and an asset pack</a><a href="tutorials/vinyl-htv.html">Layered vinyl and iron-on</a><a href="tutorials/laser.html">Laser: DXF and G-code</a></div><div class="grp"><h4>Online</h4><a href="https://logolabs.github.io/inkvec/">Inkvec documentation</a><a href="https://logolabs.github.io/inkvec/studio/troubleshooting.html">This page on the web</a></div><p class="guidenote">This copy of the guide is part of the app and works without a network.</p></aside>
<main><article><h1 id="troubleshooting-and-questions">Troubleshooting and questions</h1>
<h2 id="installing-and-starting">Installing and starting</h2>
<p><strong>Windows says "Windows protected your PC".</strong> The installer is not code-signed. Choose <strong>More
info</strong>, then <strong>Run anyway</strong>. Check the file's SHA-256 against the release notes first if you want
to be sure it is the published one. See <a href="install.html#opening-the-app-the-first-time">Install</a>.</p>
<p><strong>macOS says the app cannot be opened.</strong> Also unsigned. Control-click the app in Applications,
choose <strong>Open</strong>, then <strong>Open</strong> again. If that is refused too, run
<code>xattr -dr com.apple.quarantine "/Applications/Inkvec Studio.app"</code>.</p>
<p><strong>The Linux package will not install or start.</strong> The app needs glibc 2.38, libstdc++ 13 and
WebKitGTK 4.1 (Ubuntu 23.10, Debian 13, Fedora 39 or newer), because the denoiser's runtime needs
them. On an older system use the command-line archive, which runs on glibc 2.17 and later (without
the denoiser).</p>
<p><strong>The Windows app will not start.</strong> It needs Microsoft WebView2, which the <code>.exe</code> installer
fetches if it is missing. After installing from the <code>.msi</code>, or on a machine where WebView2 was
removed, install the <em>WebView2 Runtime</em> from Microsoft and start the app again.</p>
<h2 id="transparency-and-backgrounds">Transparency and backgrounds</h2>
<p><strong>My logo has a transparent background, and the SVG has a white (or black) box behind it.</strong>
Check that <strong>Trace transparency</strong> (Tune, Colour) is on; it is by default. If the image itself has
a solid background, turn on <strong>Transparent background</strong> (Tune, Output): the shape that covers the
whole canvas is then not painted.</p>
<p><strong>The holes in letters (the middle of an O) are filled in.</strong> Transparency was flattened: turn
<strong>Trace transparency</strong> on. If you must trace with it off, <strong>Holes as cutouts</strong> puts the holes back.</p>
<p><strong>A white logo on a transparent background disappeared.</strong> It is there; a white drawing on a white
page is invisible. With <strong>Trace transparency</strong> on, it is traced as white shapes on a clear ground.
Look at it with the Minify tab's dark <strong>Backdrop</strong>, or in the viewer (the stage is dark).</p>
<p><strong>Soft shadows or glows came back as flat shapes.</strong> With <strong>Trace transparency</strong> on they come back as
translucent fills. Where a shade is a continuous blur, the Result tab says that part is a ramp SVG
cannot hold exactly.</p>
<h2 id="colours">Colours</h2>
<p><strong>Two shades of what should be one colour.</strong> A flat colour measured twice, usually from
anti-aliasing or compression. Accept the <a href="palette.html#suggested-groups">suggested colour groups</a>, or
raise <strong>Colour merging</strong> a little.</p>
<p><strong>More colours than the design has.</strong> Set <strong>Colours</strong> in the palette to the number the design has
and accept the suggestions, or lower <strong>Max colours</strong>.</p>
<p><strong>A small detail took the colour of its neighbour.</strong> Too few colours, or merging too strong. Raise
<strong>Max colours</strong> or lower <strong>Colour merging</strong>, and undo any group that swallowed it.</p>
<p><strong>Does the transparent background use up one of the colours?</strong> No. With <strong>Trace transparency</strong> on
(the default), the clear ground is not counted towards <strong>Max colours</strong>.</p>
<p><strong>The colours are slightly off from the brand's.</strong> The colours written are the ones measured in
the image, and a JPEG or a screenshot changes them. Use the <a href="settings.html#denoiser">denoiser</a>, and
<a href="palette.html#paste-a-brand-palette">paste the brand palette</a> to snap each ink to its real value.</p>
<p><strong>A snapped colour went back to the measured one.</strong> A snap is dropped when its ink is no longer in
the drawing, for example after a colour group merged it into another ink. Snap the merged ink, or
give the group a <strong>Custom…</strong> colour.</p>
<h2 id="the-denoiser">The denoiser</h2>
<p><strong>The download fails.</strong> The app downloads from <code>huggingface.co</code>. A proxy or firewall that blocks it
stops the download; the message says why. You can also fetch the model yourself, from
<code>https://huggingface.co/Logolabs/inkvec-denoiser-001/resolve/main/restorer.onnx</code>, and put it where
the app keeps it (see <a href="settings.html#where-things-are-kept">Settings</a>). The app checks it against the
published SHA-256 and only treats it as installed if it matches.</p>
<p><strong>The download finished but the denoiser says "Not installed".</strong> The file did not match the
published checksum (an interrupted or altered download) and was not kept. Download it again.</p>
<p><strong>"Not in this build".</strong> The Intel macOS build has no denoiser, because its runtime has no package
for that platform.</p>
<p><strong>The denoiser is on and the draft looks no different.</strong> Drafts skip the denoiser. It runs on the
full trace, a moment after you stop moving controls.</p>
<h2 id="speed-and-size">Speed and size</h2>
<p><strong>A trace is slow.</strong> Tracing time grows with the pixel count. Lower <strong>Trace size</strong> (Tune, Detail);
for most logos 1024 or 2048 px loses nothing visible. <strong>Threads</strong> in Settings should be the full
count unless you need the computer for something else.</p>
<p><strong>"The trace would run out of memory".</strong> Press <strong>Retry at</strong> with the size it suggests.</p>
<p><strong>The SVG is huge.</strong> Try the <em>Fewer paths</em> preset, raise <strong>Precision</strong>, accept the colour-group
suggestions, and export the minified copy. A photograph will never make a small SVG; see
<a href="https://logolabs.github.io/inkvec/limitations.html">Limitations</a>.</p>
<p><strong>The trace of an enlarged image is blocky or stepped.</strong> An image that was enlarged from a smaller
one carries the smaller one's pixel steps, and the trace follows them faithfully. Trace the
original, smaller file instead.</p>
<h2 id="the-result">The result</h2>
<p><strong>The lettering is outlines, not text.</strong> Tracing recovers shapes, not the typeface; the Result tab
says so. Re-set the words in a vector editor if they must stay editable.</p>
<p><strong>Lines came back as thin filled shapes.</strong> Try the <em>Line art</em> preset. It only works for lines of one
even width; brush and calligraphic strokes stay as outlines.</p>
<p><strong>The draft and the final look different.</strong> A draft is traced small (512 px) for speed. Wait for
the chip to say <strong>final</strong> before judging or copying.</p>
<p><strong>The favicon has space above and below the logo.</strong> Favicons are square; a wide drawing is
centred in them on a transparent background rather than stretched. Trace a square crop of the mark
for a favicon that fills its square.</p>
<h2 id="integrations">Integrations</h2>
<p><strong>"Vectorize with Inkvec" is not in the right-click menu.</strong> Add it first in
<a href="settings.html#advanced">Settings, Advanced</a>. On Windows 11 it is under <strong>Show more options</strong>. On
macOS use <strong>Open With</strong>, where the app is already listed.</p>
<p><strong><code>inkvec</code> is not found after "Add inkvec to PATH".</strong> Open a new terminal. On macOS, add
<code>~/.local/bin</code> to your <code>PATH</code>.</p>
<p><strong>A cutter imports the file at the wrong size.</strong> In Fabricate, set <strong>The files state their size
in</strong> to the pixel rate the program uses (Cricut and Silhouette: 72/in), and cut the size-check
square to confirm. See <a href="fabricate.html#size">Fabricate</a>.</p>
<h2 id="help-and-settings">Help and settings</h2>
<p><strong>Help says the guide is not bundled with this build.</strong> A development or browser build may not
include it. <strong>Open the online guide</strong> shows the same pages on
<a href="https://logolabs.github.io/inkvec/studio/">logolabs.github.io/inkvec</a>.</p>
<p><strong>How do I start over?</strong> Settings, Advanced, <strong>Reset settings</strong>. It resets your preferences and
clears the recent files, and keeps your saved presets, your files and the denoiser.</p>
<h2 id="studio-lite">Studio Lite</h2>
<p><strong>Where did my file go?</strong> Studio Lite downloads what it saves, into your browser's downloads
folder.</p>
<p><strong>Where are Batch, the command line and the right-click menu?</strong> They need the desktop app. See
<a href="index.html#inkvec-studio-and-inkvec-studio-lite">Inkvec Studio and Inkvec Studio Lite</a>.</p>
<p><strong>The first visit takes a few seconds to start.</strong> The loading screen is the engine arriving
(about 5 MB) and starting; its bar follows the real download. Later visits start from the
browser's cache.</p>
<p><strong>The denoiser is on but the trace looks the same, and the rail says it is downloading.</strong> The
trace shown was made without it while it downloads (about 100 MB, once). It traces again by
itself when the denoiser is ready. If it failed, press <strong>Retry</strong> under the Denoiser buttons or in
the status strip.</p>
<p><strong>Nothing is downloaded in the background.</strong> Your browser asks sites to save data, so Studio
Lite waits until you turn the denoiser on. Inside the Hugging Face frame the denoiser cannot run
at all: use <strong>Open in its own tab</strong>.</p>
<p><strong>My settings are not remembered.</strong> A private window, or a browser set to block site data, gives
the page nowhere to keep them. The app still works, from the defaults each time.</p>
<h2 id="reporting-a-problem">Reporting a problem</h2>
<p>Report bugs on <a href="https://github.com/logolabs/inkvec/issues">GitHub</a>. Include the app version (from
About), your operating system, and, if you can share it, the image. Security problems go through
the <a href="https://logolabs.github.io/inkvec/security.html">security policy</a> instead.</p><nav class="pagenav"><a class="prev" href="shortcuts.html"><span class="dir">Previous</span><span class="lbl">Keyboard and mouse</span></a><a class="next" href="tutorials/jpeg-logo.html"><span class="dir">Next</span><span class="lbl">Clean up a JPEG logo</span></a></nav></article></main>
<aside class="rail"><h5>On this page</h5><ul><ul><li class="l2"><a href="#installing-and-starting">Installing and starting</a></li><li class="l2"><a href="#transparency-and-backgrounds">Transparency and backgrounds</a></li><li class="l2"><a href="#colours">Colours</a></li><li class="l2"><a href="#the-denoiser">The denoiser</a></li><li class="l2"><a href="#speed-and-size">Speed and size</a></li><li class="l2"><a href="#the-result">The result</a></li><li class="l2"><a href="#integrations">Integrations</a></li><li class="l2"><a href="#help-and-settings">Help and settings</a></li><li class="l2"><a href="#studio-lite">Studio Lite</a></li><li class="l2"><a href="#reporting-a-problem">Reporting a problem</a></li></ul></ul></aside>
</div>
</body>
</html>