Skip to content

Commit

Permalink
Add html version of the manual
Browse files Browse the repository at this point in the history
  • Loading branch information
NathanLovato committed Feb 7, 2019
1 parent a9bb9de commit 6c0be5e
Showing 1 changed file with 57 additions and 0 deletions.
57 changes: 57 additions & 0 deletions gdquest_art_tools/Manual.html
Original file line number Diff line number Diff line change
@@ -0,0 +1,57 @@
<!DOCTYPE html>
<html xmlns="http://www.w3.org/1999/xhtml" lang="" xml:lang="">
<head>
<meta charset="utf-8" />
<meta name="generator" content="pandoc" />
<meta name="viewport" content="width=device-width, initial-scale=1.0, user-scalable=yes" />
<title>Manual</title>
<style type="text/css">
code{white-space: pre-wrap;}
span.smallcaps{font-variant: small-caps;}
span.underline{text-decoration: underline;}
div.column{display: inline-block; vertical-align: top; width: 50%;}
</style>
</head>
<body>
<h1 id="gdquest-art-tools-krita-plugin-for-game-developers-and-graphic-designers">GDquest Art Tools: Krita Plugin for Game Developers and Graphic Designers</h1>
<p>Free Krita plugin for designers, game artists and digital artists to work more productively:</p>
<ul>
<li>Batch export assets to multiple sizes, file types, and custom paths. Supports <code>jpg</code> and <code>png</code>.</li>
<li>Rename layers quickly with the smart rename tool</li>
</ul>
<h2 id="batch-export-layers">Batch Export Layers</h2>
<p>GDquest Art Tools exports individual layers to image files based on metadata in the layer name. The supported options are:</p>
<ul>
<li><code>[e=jpg,png]</code> - supported export image extensions</li>
<li><code>[s=20,50,100,150]</code> - size in <code>%</code></li>
<li><code>[p=path/to/custom/export/directory]</code> - custom output path. Paths can be absolute or relative to the Krita document.</li>
<li><code>[m=20,30,100]</code> - extra margin in <code>px</code>. The layer is trimmed to the smallest bounding box by default. This option adds extra padding around the layer.</li>
</ul>
<p>A typical layer name with metadata looks like: <code>CharacterTorso e=png m=30 s=50,100</code>. This exports the layer as two images, with an added padding of 30 pixels on each side: <code>CharacterTorso_s100_m030.png</code>, and <code>CharacterTorso_s050_m030.png</code>, a copy of the layer scaled down to half the original size.</p>
<p>All the metadata tags are optional. Each tag can contain one or multiple options separated by comma <code>,</code>. Write <code>e=jpg</code> to export the layer to <code>jpg</code> only and <code>e=jpg,png</code> to export the layer twice, as a <code>jpg</code> and as a <code>png</code> file. Note that the other tag, <code>p=</code> has been left out. Below we describe how the plugin works.</p>
<h2 id="getting-started">Getting Started</h2>
<p>GDquest Art Tools gives two options to batch export layers: <code>Export All Layers</code> or <code>Export Selected Layers</code>.</p>
<p><code>Export All Layers</code> only takes layers with the <code>e=extension[s]</code> tag into account. For example, if the layer name is <code>LeftArm e=png s=50,100</code>, <code>Export All Layers</code> will take it into account. If the layer name is <code>LeftArm s=50,100</code>, it will not be exported with this option.</p>
<p><code>Export Selected Layers</code> exports all selected layers regardless of the tags.</p>
<p>By default, the plugin exports the images in an <code>export</code> folder next to your Krita document. The export follows the structure of your layer stack. The group layers become directories and other layers export as files.</p>
<blockquote>
<p><strong>Supported layer types:</strong> paint, vector, group &amp; file layers.</p>
</blockquote>
<h2 id="smart-layer-rename-tool">Smart Layer Rename tool</h2>
<p>Say we have this Krita document structure:</p>
<pre><code>GodetteGroupLayer
+-- HeadGroupLayer
+-- Hair
+-- Eyes
+-- Rest
+-- Torso
+-- LeftArm
+-- RightArm
Background</code></pre>
<p>If you want to export <code>GodetteGroupLayer</code>, <code>HeadGroupLayer</code>, <code>Torso</code>, <code>LeftArm</code>, and <code>RightArm</code>, but not the other layers, you can select these layers and write the following in the <code>Update Layer Name</code> text box: <code>e=png s=40,100</code> and press <kbd>Enter</kbd>. In this example, Art Tools will export two copies of the selected layers to png at <code>40%</code> and <code>100%</code> scale. This is what <code>s=40,100</code> does.</p>
<p>Say that we made a mistake: we want to export to <code>50%</code> instead of <code>40%</code>. Select the layers once more and write <code>s=50,100</code> in the text box. Press <kbd>Enter</kbd>. This will update the size tag and leave <code>e=png</code> untouched.</p>
<p>The tool can do more than add and update meta tags. If you want to remove <code>GroupLayer</code> from the name on <code>GodetteGroupLayer</code> and <code>HeadGroupLayer</code>, select them and write <code>GroupLayer=</code> in the text box. Press <kbd>Enter</kbd> and the <code>GroupLayer</code> text will disappear from the selected layers.</p>
<p>The <code>=</code> tells the tool to search and replace. <code>this=[that]</code> will replace <code>this</code> with <code>[that]</code>. If you don’t write anything after the equal sign, the tool will erase the text you searched for.</p>
<p>The rename tool is smarter with meta tags. Writing <code>e=</code> will remove the extension tag entirely. For example, <code>Godete e=png s=50,100</code> will become <code>Godette s=50,100</code>.</p>
</body>
</html>

0 comments on commit 6c0be5e

Please sign in to comment.