|
[Tuxpaint-cvs] tuxpaint-website/docs/html
ADVANCED-STAMPS-HOWTO.html, NONE, 1.1 EXTENDING.html, NONE,
1.1 FAQ.html, 1.1, 1.2 OPTIONS.html, 1.2, 1.3 README.html, 1.2, 1.3
From: William Kendrick <wkendrick@us...> - 2006-10-23 19:25
|
Update of /cvsroot/tuxpaint/tuxpaint-website/docs/html In directory sc8-pr-cvs10.sourceforge.net:/tmp/cvs-serv15539/html Modified Files: FAQ.html OPTIONS.html README.html Added Files: ADVANCED-STAMPS-HOWTO.html EXTENDING.html Log Message: Updated docs on website to match 0.9.16's docs. Index: README.html =================================================================== RCS file: /cvsroot/tuxpaint/tuxpaint-website/docs/html/README.html,v retrieving revision 1.2 retrieving revision 1.3 diff -u -d -r1.2 -r1.3 --- README.html 31 Dec 2005 20:29:15 -0000 1.2 +++ README.html 23 Oct 2006 19:25:47 -0000 1.3 @@ -12,23 +12,18 @@ version -0.9.15 +0.9.16 </h1> <h3>A simple drawing program for children</h3> -<p>Copyright 2005 by Bill Kendrick and others<br> +<p>Copyright 2002-2006 by Bill Kendrick and others<br> New Breed Software</p> <p><a href="mailto:bill@...> <a href="http://www.newbreedsoftware.com/tuxpaint/">http://www.newbreedsoftware.com/tuxpaint/</a></p> -<p>June 14, 2002 - November 12, 2005 - -<br> -(Last correction: December 31, 2005) - -</p> +<p>June 14, 2002 - September 9, 2006</p> </center> <hr size=2 noshade> @@ -174,8 +169,8 @@ <blockquote> <p>When Tux Paint first loads, a title/credits screen will appear.</p> - <center><img src="images/tuxpaint-title.jpg" width=324 height=254 - alt="[Title Screenshot]"></center> + <p align=center><img src="images/tuxpaint-title.jpg" width=324 height=254 + alt="[Title Screenshot]"></p> <p>Once loading is complete, press a key or click on the mouse to continue. (Or, after about 30 seconds, the title screen will go away @@ -194,9 +189,9 @@ <dd> <p>The toolbar contains the drawing and editing controls.</p> - <center><img src="images/tools.jpg" width=324 height=254 + <p align=center><img src="images/tools.jpg" width=324 height=254 alt="[Tools: Paint, Stamp, Lines, Shapes, Text, Magic, Undo, Redo, - Eraser, New, Open, Save, Print, Quit]"></center> + Eraser, New, Open, Save, Print, Quit]"></p> </dd> <dt>Middle: Drawing Canvas</dt> @@ -204,8 +199,8 @@ <p>The largest part of the screen, in the center, is the drawing canvas. This is, obviously, where you draw!</p> - <center><img src="images/canvas.jpg" width=324 height=254 - alt="[(Canvas)]"></center> + <p align=center><img src="images/canvas.jpg" width=324 height=254 + alt="[(Canvas)]"></p> </dd> @@ -216,8 +211,8 @@ the various brushes available. When the Rubber Stamp tool is selected, it shows the different shapes you can use.</p> - <center><img src="images/selector.jpg" width=324 height=254 - alt="[Selectors - Brushes, Letters, Shapes, Stamps]"></center> + <p align=center><img src="images/selector.jpg" width=324 height=254 + alt="[Selectors - Brushes, Letters, Shapes, Stamps]"></p> </dd> @@ -226,9 +221,13 @@ <p>A palette of available colors are shown near the bottom of the screen.</p> - <center><img src="images/colors.jpg" width=324 height=254 + <p align=center><img src="images/colors.jpg" width=324 height=254 alt="[Colors - Black, White, Red, Pink, Orange, Yellow, Green, Cyan, - Blue, Purple, Brown, Grey]"></center> + Blue, Purple, Brown, Grey]"></p> + + <p>(NOTE: You can define your own colors for Tux Paint. + See the "<a href="OPTIONS.html"><i>Options</i></a>" + documentation.)</p> </dd> @@ -237,10 +236,10 @@ <p>At the very bottom of the screen, Tux, the Linux Penguin, provides tips and other information while you draw.</p> - <center><img src="images/tips.jpg" width=324 height=254 + <p align=center><img src="images/tips.jpg" width=324 height=254 alt="(For example: 'Pick a shape. Click to pick the center, drag, then let go when it is the size you want. Move around to rotate it, and - click to draw it.)"></center> + click to draw it.)"></p> </dd> </dl> </blockquote> @@ -269,8 +268,8 @@ <br clear=all> - <center><img src="images/ex_paint.png" width=120 height=95 - alt=""></center> + <p align=center><img src="images/ex_paint.png" width=120 height=95 + alt=""></p> <hr size=1> </dd> @@ -302,8 +301,8 @@ <br clear=all> - <center><img src="images/ex_stamps.png" width=182 height=156 - alt=""></center> + <p align=center><img src="images/ex_stamps.png" width=182 height=156 + alt=""></p> <hr size=1> </dd> @@ -325,8 +324,8 @@ <br clear=all> - <center><img src="images/ex_lines.png" width=76 height=103 - alt=""></center> + <p align=center><img src="images/ex_lines.png" width=76 height=103 + alt=""></p> <hr size=1> </dd> @@ -369,8 +368,8 @@ <br clear=all> - <center><img src="images/ex_shapes.png" width=177 height=104 - alt=""></center> + <p align=center><img src="images/ex_shapes.png" width=177 height=104 + alt=""></p> <hr size=1> </dd> @@ -392,8 +391,8 @@ <br clear=all> - <center><img src="images/ex_text.png" width=139 height=69 - alt=""></center> + <p aling=center><img src="images/ex_text.png" width=139 height=69 + alt=""></p> <hr size=1> </dd> @@ -470,18 +469,6 @@ This makes the picture blocky looking ("pixelated") wherever you drag the mouse. </dd> - - <dt><b>Thick</b></dt> - <dd> - This makes the darker colors in the picture become thicker - wherever you drag the mouse. - </dd> - - <dt><b>Thin</b></dt> - <dd> - Similar to "Thick," except dark colors become thinner - (light colors become thicker). - </dd> <dt><b>Negative</b></dt> <dd> @@ -607,8 +594,8 @@ <br clear=all> - <center><img src="images/open_dialog.jpg" width=194 height=152 - alt=""></center> + <p align=center><img src="images/open_dialog.jpg" width=194 height=152 + alt=""></p> <p>Click a picture to select it, then...</p> @@ -636,6 +623,16 @@ <br clear=all> + <li> + <img src="images/open_slides.png" width=48 height=48 alt="" + align=right> + + <p>Click the blue "Slides" (slide projector) button at the lower + left to go to slideshow mode. See "<a href="#slides">Slides</a>", + below, for details.</p> + + <br clear=all> + <li> <img src="images/open_back.png" width=48 height=48 alt="" align=right> @@ -695,8 +692,8 @@ whether you want to save over the old version, or create a new entry (a new file).</p> - <center><img src="images/saveover.png" width=177 height=110 - alt=""></center> + <p align=center><img src="images/saveover.png" width=177 height=110 + alt=""></p> <p>(NOTE: If either the "<code>saveover</code>" or "<code>saveovernew</code>" options are set, it won't ask before saving @@ -806,7 +803,8 @@ file ("<code>tuxpaint.cfg</code>").</p> <p>If the "printcfg" option is used, printer settings will - be loaded from the file "<code>userdata/print.cfg</code>". + be loaded from the file "<code>print.cfg</code>" in your + personal folder (see below). Any changes will be saved there as well.</p> <p>See the "<a href="OPTIONS.html"><i>Options</i></a>" @@ -838,6 +836,46 @@ <hr size=1> </dd> + <dt><a name="slides"><b>Slides</b></a></dt> + <dd> + <img src="images/open_slides.png" width=48 height=48 alt="" + align=right> + + <p>The "Slides" button is available in the "Open" dialog. + It displays a list of your saved files, similar to the "Open" dialog, + but without listing 'Starter' images.</p> + + <p>Click each of the images you wish to display in a slideshow-style + presentation, one by one. A digit will appear over each image, + letting you know in which order they will be displayed.</p> + + <p>You can click a selected image to unselect it (take it out of your + slideshow).</p> + + <p>A sliding scale at the lower left of the screen (next to the "Play" + button) can be used to adjust the speed of the slideshow, from slowest + to fastest. Choose the leftmost setting to disable automatic + advancement — you will need to press a key or click to go to + the next slide (see below).</p> + + <p>When you're ready, click the "Play" button to begin the slideshow. + (Note: If you hadn't selected ANY images, then ALL images will be + played in the slideshow.)</p> + + <p>During the slideshow, press <b>[Space]</b>, <b>[Enter]</b> or + <b>[Return]</b> or the <b>[Right Arrow]</b>, or click the "Next" + button at the lower left, to manually advance to the next slide. + Press <b>[Left]</b> to go back to the previous slide.</p> + + <p>Press <b>[Escape]</b>, or click the "Back" button at the + lower right, to exit the slideshow and return to the slideshow + image selection screen.</p> + + <p>Click "Back" in the slideshow image selection screen to return to + the "Open" dialog.</p> + + <br clear=all> + </dd> <dt><b>Quit</b></dt> <dd> @@ -904,20 +942,22 @@ <p>To do so, you simply need to convert the picture into a PNG (Portable Network Graphic) image file, and place it in Tux Paint's - "saved" directory. ("<code>~/.tuxpaint/saved/</code>" under Linux and Unix, - - <!-- begin fix -- after 0.9.15-2 release, 2005.12.31 --> - - the user's "Application Data" folder - (e.g., "<code>C:\Documents and Settings\<i>(user name)</i>\Application - Data\TuxPaint\saved\</code>") - - <!-- end fix --> - - under Windows, - "<code>Library/Preferences/tuxpaint/saved/</code>" under Mac OS X.) - </p> + "saved" directory:</p> + <dl> + <dt>Windows</dt> + <dd>Inside the user's "<code>Application Data</code>" folder, + e.g.: <code>"C:\Documents and Settings\<i>(user name)</i>\Application + Data\TuxPaint\saved\</code>"</dd> + + <dt>Mac OS X</dt> + <dd>Inside the user's "<code>Library</code>" folder: + <code>"/Users/<i>(user name)</i>/Library/Application Support/Tux Paint/saved/</code>"</dd> + + <dt>Linux/Unix</dt> + <dd>Inside a hidden "<code>.tuxpaint</code>" directory, in the user's + home directory: "<code>$(HOME)/.tuxpaint/saved/</code>"</dd> + </dl> <h2>Using '<code>tuxpaint-import</code>'</h2> <blockquote> @@ -997,476 +1037,6 @@ <p>Place this PNG file in your Tux Paint '<code>saved</code>' directory. (See above.)</p> - - <p>Under Windows, this is in the "<code>userdata</code>" folder. - Under Mac OS X, this is in - "<code>Library/Application Support/tuxpaint/</code>" - in your home directory.</p> - </blockquote> -</blockquote> - -<hr size=2 noshade> - - -<h1>Extending Tux Paint</h1> -<blockquote> - <p>If you wish to add or change things like Brushes and Rubber Stamps - used by Tux Paint, you can do it fairly easily by simply putting - or removing files on your hard disk.</p> - - <p>Note: You'll need to restart Tux Paint for the changes to take - effect.</p> - - <h2>Where Files Go</h2> - <blockquote> - <h3>Standard Files</h3> - <blockquote> - <p>Tux Paint looks for its various data files in its - 'data' directory.</p> - - <h4>Linux and Unix</h4> - <blockquote> - <p>Where this directory goes depends on what value was set for - "<code>DATA_PREFIX</code>" when Tux Paint was built. See - INSTALL.txt for details.</p> - - <p>By default, though, the directory is:</p> - - <blockquote><code> - /usr/local/share/tuxpaint/ - </code></blockquote> - - <p>If you installed from a package, it is more likely to be:</p> - - <blockquote><code> - /usr/share/tuxpaint/ - </code></blockquote> - - </blockquote> - - - <h4>Windows</h4> - <blockquote> - <p>Tux Paint looks for a directory called 'data' in the same - directory as the executable. This is the directory that the - installer used when installing Tux Paint e.g.:</p> - - <blockquote><code> - C:\Program Files\TuxPaint\data - </code></blockquote> - - </blockquote> - - - <h4>Mac OS X</h4> - <blockquote> - <p>Tux Paint stores files in your account's - "Libraries" folder, under "Preferences", e.g.:</p> - - <blockquote><code> - /Users/Joe/Library/Preferences/ - </code></blockquote> - - </blockquote> - - </blockquote> - - <hr size=1 noshade> - - - <h3>Personal Files</h3> - <blockquote> - <p>You can also create brushes, stamps, fonts and 'starters' in your - own directory for Tux Paint to find.</p> - - <h4>Linux and Unix</h4> - <blockquote> - <p>Your personal Tux Paint directory is - "<code>~/.tuxpaint/</code>".</p> - - <p>That is, if your home directory is "<code>/home/karl</code>", then - your Tux Paint directory is - "<code>/home/karl/.tuxpaint/</code>".</p> - - <p>Don't forget the period ("<code>.</code>") before the - '<code>tuxpaint</code>'!</p> - </blockquote> - - - <h4>Windows</h4> - <blockquote> - <p>Your personal Tux Paint directory is named "userdata" and - is in the same directory as the executable e.g.:</p> - - <blockquote><code> - C:\Program Files\TuxPaint\userdata - </code></blockquote> - - </blockquote> - - - <p>To add brushes, stamps fonts, and 'starters,' create subdirectories - under your personal Tux Paint directory named - "<code><b>brushes</b></code>", "<code><b>stamps</b></code>", - "<code><b>fonts</b></code>" and - "<code><b>starters</b></code>" respectively.</p> - - <p>(For example, if you created a brush named "<code>flower.png</code>", - you would put it in "<code>~/.tuxpaint/brushes/</code>" under Linux or - Unix.)</p> - </blockquote> - </blockquote> - - <hr size=1 noshade> - - - <h2>Brushes</h2> - <blockquote> - <p>The brushes used for drawing with the 'Brush' and 'Lines' tools in - Tux Paint are simply greyscale PNG images.</p> - - <img src="images/brush_edit.png" width=123 height=147 alt="" align=right> - - <p>The alpha (transparency) of the PNG image is used to determine the shape - of the brush, which means that the shape can be 'anti-aliased' and even - partially-transparent!</p> - - <p>Brush images should be no wider than 40 pixels across and - no taller than 40 pixels high. (i.e., the maximum size - can be 40 x 40.)</p> - - <p>Just place them in the "<code><b>brushes</b></code>" directory.</p> - - <p>Note: If your new brushes all come out as solid squares or rectangles, - it's because you forgot to use alpha transparency! See the documentation - file "PNG.txt" for more information and tips.</p> - - <br clear=all> - </blockquote> - - <hr size=1 noshade> - - - <h2>Stamps</h2> - <blockquote> - <p>All stamp-related files go in the "<code><b>stamps</b></code>" directory. - It's useful to create subdirectories and sub-subdirectories - there to organize the stamps. (For example, you can have a - "<code>holidays</code>" folder with "<code>halloween</code>" and - "<code>christmas</code>" sub-folders.)</p> - - <h3>Images</h3> - <blockquote> - <p>Rubber Stamps in Tux Paint can be made up of a number of separate - files. The one file that is required is, of course, the picture - itself.</p> - - <img src="images/stamp_edit.png" width=128 height=147 alt="" align=right> - - <p>The Stamps used by Tux Paint are PNG pictures. They can be - full-color or greyscale. The alpha (transparency) of the PNG is - used to determine the actual shape of the picture (otherwise you'll - stamp a large rectangle on your drawings).</p> - - <p>The PNGs can be any size, but in practice, a 100 pixels wide by - 100 pixels tall (100 x 100) is quite large for - Tux Paint.</p> - - <p>Note: If your new stamps all have solid rectangular-shaped outlines - of a solid color (e.g., white or black), it's because you forgot to use - alpha transparency! See the documentation file "PNG.txt" for more - information and tips.</p> - - <br clear=all> - </blockquote> - - <hr size=1 noshade> - - <h3>Description Text</h3> - <blockquote> - <p>Text (".TXT") files with the same name as the PNG. - (e.g., "<code>picture.png</code>"'s description is stored in - "<code>picture.txt</code>" in the same directory.)</p> - - <p>The first line of the text file will be used as the US English - description of the stamp's image. It must be encoded in UTF-8.</p> - - <h4>Language Support</h4> - <blockquote> - <p>Additional lines can be added to the text file to provide - translations of the description, to be displayed when Tux Paint - is running in a different locale (like French or Spanish).</p> - - <p>The beginning of the line should correspond to the language code - of the language in question (e.g., "<code>fr</code>" for French, and - "<code>zh_tw</code>" for Traditional Chinese), followed by - "<code>.utf8=</code>" and the translated description (encoded - in UTF-8).</p> - - <p>There are scripts in the "<code>po</code>" directory for converting - the text files to PO format (and back) for easy translation to - different languages. Therefore you should never add or change translations - in the .txt files directly.</p> - - <p>If no translation is available for the language Tux Paint - is currently running in, the US English text is used.</p> - </blockquote> - - <h4>Windows Users</h4> - <blockquote> - <p>Use NotePad or WordPad to edit/create these files. - Be sure to save them as Plain Text, and make sure they have - "<code>.txt</code>" at the end of the filename...</p> - </blockquote> - </blockquote> - - <hr size=1 noshade> - - <h3>Sound Effects</h3> - <blockquote> - <p>WAVE (".WAV") files with the same name as the PNG. - (e.g., "<code>picture.png</code>"'s sound effect is the sound - "<code>picture.wav</code>" in the same directory.)</p> - - <h4>Language Support</h4> - <blockquote> - <p>For sounds for different locales (e.g., if the sound is someone - saying a word, and you want translated versions of the word said), - also create WAV files with the locale's label in the filename, in - the form: "<code><b>STAMP_LOCALE</b>.wav</code>"</p> - - <p>"<code>picture.png</code>"'s sound effect, when Tux Paint is run - in Spanish mode, would be "<code>picture_es.wav</code>". - In French mode, "<code>picture_fr.wav</code>". And so on...</p> - - <p>If no localized sound effect can be loaded, Tux Paint will - attempt to load the 'default' sound file. - (e.g., "<code>picture.wav</code>")</p> - </blockquote> - </blockquote> - - <hr size=1 noshade> - - <h3>Stamp Options</h3> - <blockquote> - <p>Aside from a graphical shape, a textual description, and a sound - effect, stamps can also be given other attributes. To do this, you need - to create a 'data file' for the stamp.</p> - - <p>A stamp data file is simply a text file containing the options.</p> - - <p>The file has the same name as the PNG image, but a "<code>.dat</code>" - extension. (e.g., "<code>picture.png</code>"'s data file is the text - file "<code>picture.dat</code>" in the same directory.)</p> - - <h4>Colored Stamps</h4> - <blockquote> - <p>Stamps can be made to be either "colorable" or "tintable."</p> - - <h5>Colorable</h5> - <blockquote> - <p>"Colorable" stamps they work much like brushes - you pick the stamp - to get the shape, and then pick the color you want it to be. - (Symbol stamps, like the mathematical and musical ones, are an - example.)</p> - - <p>Nothing about the original image is used except the transparency - ("alpha" channel). The color of the stamp comes out solid.</p> - - <center><img src="images/ex_colorable.png" width=74 height=92 - alt=""></center> - - <p>Add the word "<code><b>colorable</b></code>" to the stamp's data - file.</p> - </blockquote> - - <h5>Tinted</h5> - <blockquote> - <p>"Tinted" stamps are similar to "colorable" ones, except the - details of the original image are kept. (To put it technically, - the original image is used, but its hue is changed, based on the - currently-selected color.)</p> - - <center><img src="images/ex_tintable.png" width=151 height=78 - alt=""></center> - - <p>Add the word "<code><b>tintable</b></code>" to the stamp's data - file.</p> - - <p>Sometimes you don't want the white or gray parts of an image - tinted (see for example the dry erase marker stamp in the default - stamp package). You can add the word "<code><b>notintgray</b></code>" - to the stamp's data file to accomplish this. Only areas with saturation - over 25 % are then tinted.</p> - - </blockquote> - </blockquote> - - <h4>Unalterable Stamps</h4> - <blockquote> - <p>By default, a stamp can be flipped upside down, shown as a mirror - image, or both. This is done using the control buttons below the - stamp selector, at the lower right side of the screen in - Tux Paint.</p> - - <p>Sometimes, it doesn't make sense for a stamp to be flippable or - mirrored; for example, stamps of letters or numbers. - Sometimes stamps are symmetrical, so letting the user flip or mirror - them isn't useful.</p> - - <p>To make a stamp un-flippable, add the option - "<code><b>noflip</b></code>" to the stamp's data file.</p> - - <p>To keep a stamp from being mirrored, add the option - "<code><b>nomirror</b></code>" to the stamp's data file.</p> - </blockquote> - - <h4>Initial Stamp Size</h4> - <blockquote> - <p>By default, Tux Paint assumes that your stamp is sized - appropriately for unscaled display on a 608x472 canvas. This is - the original Tux Paint canvas size, provided by a 640x480 screen. - Tux Paint will then adjust the stamp according to the current - canvas size and, if enabled, the user's stamp size controls.</p> - - <p>If your stamp would be too big or too small, you can specify - a scale factor. If your stamp would be 2.5 times as wide (or tall) - as it should be, add the option "<code><b>scale 40%</b></code>" or - "<code><b>scale 5/2</b></code>" or "<code><b>scale 2.5</b></code>" - or "<code><b>scale 2:5</b></code>" to your image. You may include - an "<code><b>=</b></code>" if you wish, as in - "<code><b>scale=40%</b></code>".</p> - </blockquote> - - - <h4>Windows Users</h4> - <blockquote> - <p>You can use NotePad or WordPad to create these file. - Be sure to save it as Plain Text, and make sure the filename - has "<code>.dat</code>" at the end, and not "<code>.txt</code>"...</p> - </blockquote> - </blockquote> - - <h3>Pre-Mirrored Images</h3> - <blockquote> - <p>In some cases, you may wish to provide a pre-drawn version of - a stamp's mirror-image. For example, imagine a picture of a fire - truck with the words "<i>Fire Department</i>" written across - the side. You probably do not want that text to appear backwards - when the image is flipped!</p> - - <p>To create a mirrored version of a stamp that you want Tux Paint - to use, rather than mirroring one on its own, simply create a second - "<code>.png</code>" graphics file with the same name, except with - the string "<code><b>_mirror</b></code>" before the filename - extension.</p> - - <p>For example, for the stamp "<code><b>truck.png</b></code>" you would - create another file named "<code><b>truck_mirror.png</b></code>", which - will be used when the stamp is mirrored (rather than using a - backwards version of '<code>truck.png</code>').</p> - </blockquote> - - </blockquote> - - <hr size=1 noshade> - - - <h2>Fonts</h2> - <blockquote> - <img src="images/fontsizes.png" width=48 height=48 alt="" align=right> - - <p>The fonts used by Tux Paint are TrueType Fonts (TTF).</p> - - <p>Simply place them in the "<code><b>fonts</b></code>" directory. - Tux Paint will load the font and provide four different sizes - in the 'Letters' selector when using the 'Text' tool.</p> - - <br clear=all> - </blockquote> - - <hr size=1 noshade> - - - <h2>'Starters'</h2> - <blockquote> - <img src="images/open_open.png" width=48 height=48 alt="" align=right> - - <p>'Starter' images appear in the 'Open' dialog, along with pictures - you've created. They have a green button background, instead of blue.</p> - - <p>Unlike your saved pictures, however, when you select and open a - 'starter,' you're actually creating a new drawing. Instead of being - blank, though, the new drawing contains the contents of the 'starter.' - Additionally, as you edit your new picture, the contents of the - original 'starter' affect it.</p> - - <b>Coloring-Book Style</b> - - <blockquote> - <p>The most basic kind of 'starter' is similar to a picture in a coloring - book. It's an outline of a shape which you can then color in and - add details to. In Tux Paint, as you draw, type text, or stamp - stamps, the outline remains 'above' what you draw. You can erase the - parts of the drawing you made, but you can't erase the outline.</p> - - <p>To create this kind of 'starter' image, simply draw an outlined - picture in a paint program, make the rest of the graphic transparent - (that will come out as white in Tux Paint), and save it as a - PNG format file.</p> - </blockquote> - - <b>Scene-Style</b> - - <blockquote> - <p>Along with the 'coloring-book' style overlay, you can also provide - a separate background image as part of a 'starter' picture. The - overlay acts the same: it can't be drawn over, erased, or affected by - 'Magic' tools. However, the background can be!</p> - - <p>When the 'Eraser' tool is used on a picture based on this kind of - 'starter' image, rather than turning the canvas white, it returns that - part of the canvas to the original background picture.</p> - - <p>By creating both an overlay and a background, you can create a - 'starter' which simulates depth. Imagine a background that shows - the ocean, and an overlay that's a picture of a reef. You can then - draw (or stamp) fish in the picture. They'll appear in the ocean, - but never 'in front of' the reef.</p> - - <p>To create this kind of 'starter' picture, simply create an overlay - (with alpha transparency) as described above, and save it as a PNG. - Then create another image (without transparency), and save it with - the same filename, but with "<code>-back</code>" appended to the - name. (e.g., "<code>reef-back.png</code>" would be the background - ocean picture that corresponds to the "<code>reef.png</code>" - overlay, or foreground.)</p> - </blockquote> - - <p>The 'starter' images should be the same size as Tux Paint's - canvas. In the default 640x480 mode, that is 448x376 pixels. - If you're using 800x600 mode, it should be 608x496. (It should be - 192 pixels less wide, and 104 pixels less tall than the resolution.)</p> - - <p>Place them in the "<code><b>starters</b></code>" directory. - When the 'Open' dialog is accessed in Tux Paint, the 'starter' - images will appear at the beginning of the list with a green background.</p> - - <p><b>Note:</b> 'Starters' can't be saved over from within Tux Paint, - since loading a 'starter' is really like creating a new image. - (Instead of being blank, though there's already something there to work - with.) The 'Save' command simply creates a new picture, like it would - if the 'New' command had been used.</p> - - <p><b>Note:</b> 'Starters' are 'attached' to saved pictures, via a - small text file that has the same name as the saved file, but with - "<code>.dat</code>" as the extension. This allows the overlay and - background, if any, to continue to affect the drawing even after - Tux Paint has been quit, or another picture loaded or started. - (In other words, if you base a drawing on a 'starter' image, it will - always be affected by it.)</p> - - <br clear=all> </blockquote> </blockquote> @@ -1491,6 +1061,10 @@ <li><a href="../INSTALL.txt">INSTALL.txt</a><br> Instructions for compiling/installing, when applicable + <li><a href="EXTENDING.html">EXTENDING.html</a><br> + Detailed instructions on creating brushes, stamps and starters, + and adding fonts, to extend Tux Paint. + <li><a href="OPTIONS.html">OPTIONS.html</a><br> Detailed instructions on command-line and configuration-file options, for those who don't want to use Tux Paint Config. --- NEW FILE: ADVANCED-STAMPS-HOWTO.html --- <!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN"> <html><head><title>Tux Paint Advanced Stamps HOWTO</title> <meta http-equiv="Content-Type" content="text/html; charset=us-ascii"> </head> <body bgcolor="#FFFFFF" text="#000000" link="#0000FF" vlink="#FF0000" alink="#FF00FF"> <center> <h1><img src="images/tuxpaint-title.png" width=220 height=219 alt="Tux Paint"><br> version 0.9.16 <br> Advanced Stamps HOWTO</h1> <p>Copyright 2006 by Albert Cahalan for the Tux Paint project<br> New Breed Software</p> <p><a href="mailto:albert@...> <a href="http://www.newbreedsoftware.com/tuxpaint/">http://www.newbreedsoftware .com/tuxpaint/</a></p> <p>March 8, 2006 - March 8, 2006</p> </center> <h2>About this HOWTO</h2> <blockquote> <p>This HOWTO assumes that you want to make an excellent Tux Paint stamp from a JPEG image. There are easier and faster methods that produce lower quality.</p> <p>This HOWTO assumes you are dealing with normal opaque objects. Dealing with semi-transparent objects (fire, moving fan blade, kid's baloon) or light-giving objects (fire, lightbulb, sun) is best done with custom software. Images with perfect solid-color backgrounds are also best done with custom software, but are not troublesome to do as follows.</p> </blockquote> <h2>Image choice is crucial</h2> <blockquote> <h3>License</h3> <blockquote> <p>If you wish to submit artwork to the Tux Paint developers for consideration for inclusion in the official project, or if you wish to release your own copy of Tux Paint, bundled with your own graphics, you need an image that is compatible with the GNU <a href="../COPYING.txt">General Public License</a> used by Tux Paint.</p> <p>Images produced by the US government are Public Domain, but be aware that the US government sometimes uses other images on the web. <a href="http://images.google.com/">Google image</a> queries including either <code>site:gov</code> or <code>site:mil</code> will supply many suitable images. (Note: the *.mil sites include non-military content, too!)</p> Your own images can be placed in the Public Domain by declaring it so. (Hire a lawyer if you feel the need for legal advice.)</p> <p>For personal use, any image you can legitimately modify and use for your own personal use should be fine.</p> </blockquote> <h3>Image Size and Orientation:</h3> <blockquote> <p>You need an image that has a useful orientation. Perspective is an enemy. Images that show an object from the corner are difficult to fit into a nice drawing. As a general rule, telephoto side views are the best. The impossible ideal is that, for example, two wheels of a car are perfectly hidden behind the other two.</p> <p>Rotating an image can make it blurry, especially if you only rotate by a few degrees. Images that don't need rotation are best, images that need lots of rotation (30 to 60 degrees) are next best, and images that need just a few degrees are worst. Rotation will also make an image darker because most image editing software is very bad about gamma handling. (Rotation is only legitimate for gamma=1.0 images.)</p> <p>Very large images are more forgiving of mistakes, and thus easier to work with. Choose an image with an object that is over 1000 pixels across if you can. You can shrink this later to hide your mistakes.</p> <p>Be sure that the image is not too grainy, dim, or washed out.</p> <p>Pay attention to feet and wheels. If they are buried in something, you will need to draw new ones. If only one is buried, you might be able to copy the other one as a replacement.</p> </blockquote> </blockquote> <h2>Prepare the image:</h2> <blockquote> <p>First of all, be sure to avoid re-saving the image as a JPEG. This causes quality loss. There is a special tool called <a href="http://gnuwin32.sourceforge.net/packages/jpeg.htm">jpegtran</a> that lets you crop an image without the normal quality loss. If you want a GUI for it, use <a href="http://astron.berkeley.edu/~mperrin/software/ljcrop/">ljcrop</a>. Otherwise, use it like this:</p> <blockquote> <p><code>jpegtran -trim -copy none -crop 512x1728+160+128 < src.jpg > cropped.jpg</code></p> </blockquote> <p>Bring that image up in your image editor. If you didn't crop it yet, you may find that your image editor is very slow. Rotate and crop the image as needed. Save the image — choose whatever native format supports layers, masks, alpha, etc. <a href="http://www.gimp.org/">GIMP</a> users should choose "XCF", and Adobe Photoshop users should choose "PSD", for example.</p> <p>If you have rotated or cropped the image in your image editor, flatten it now. You need to have just one RGB layer <i>without mask or alpha</i>.</p> <p>Open the layers dialog box. Replicate the one layer several times. From top to bottom you will need something like this:</p> <ol> <li>unmodified image (write-protect this if you can) <li>an image you will modify — the "WIP" layer <li>solid green (write-protect this if you can) <li>solid magenta (write-protect this if you can) <li>unmodified image (write-protect this if you can) </ol> <p>Give the WIP layer a rough initial mask. You might start with a selection, or by using the grayscale value of the WIP layer. You might invert the mask.</p> <p><b>Warning:</b> once you have the mask, you may not rotate or scale the image normally. This would cause data loss. You will be given special scaling instructions later.</p> </blockquote> <h2>Prepare the mask:</h2> <blockquote> <p>Get used to doing Ctrl-click and Alt-click on the thumbnail images in the layers dialog. You will need this to control what you are looking at and what you are editing. Sometimes you will be editing things you can't see. For example, you might edit the mask of the WIP layer while looking at the unmodified image. Pay attention so you don't screw up. Always verify that you are editing the right thing.</p> <p>Set an unmodified image as what you will view (the top one is easiest). Set the WIP mask as what you will edit. At some point, perhaps not immediately, you should magnify the image to about 400% (each pixel of the image is seen and edited as a 4x4 block of pixels on your screen).</p> <p>Select parts of the image that need to be 100% opaque or 0% opaque. If you can select the object or background somewhat accurately by color, do so. As needed to avoid selecting any pixels that should be partially opaque (generally at the edge of the object) you should grow, shrink, and invert the selection.</p> <p>Fill the 100% opaque areas with white, and the 0% opaque areas with black. This is most easily done by drag-and-drop from the foreground/background color indicator. You should not see anything happen, because you are viewing the unmodified image layer while editing the mask of the WIP layer. Large changes might be noticable in the thumbnail.</p> <p>Now you must be zoomed in.</p> <p>Check your work. Hide the top unmodified image layer. Display just the mask, which should be a white object on a black background (probably with unedited grey at the edge). Now display the WIP layer normally, so that the mask is active. This should show your object over top of the next highest enabled layer, which should be green or magenta as needed for maximum contrast. You might wish to flip back and forth between those backgrounds by repeatedly clicking to enable/disable the green layer. Fix any obvious and easy problems by editing the mask while viewing the mask.</p> <p>Go back to viewing the top unmodified layer while editing the WIP mask. Set your drawing tool the paintbrush. For the brush, choose a small fuzzy circle. The 5x5 size is good for most uses.</p> <p>With a steady hand, trace around the image. Use black around the outside, and white around the inside. Avoid making more than one pass without switching colors (and thus sides).</p> <p>Flip views a bit, checking to see that the mask is working well. When the WIP layer is composited over the green or magenta, you should see a tiny bit of the original background as an ugly fringe around the edge. If this fringe is missing, then you made the object mask too small. The fringe consists of pixels that are neither 100% object nor 0% object. For them, the mask should be neither 100% nor 0%. The fringe gets removed soon.</p> <p>View and edit the mask. Select by color, choosing either black or white. Most likely you will see unselected specks that are not quite the expected color. Invert the selection, then paint these away using the pencil tool. Do this operation for both white and black.</p> </blockquote> <h2>Replace the fringe and junk pixels:</h2> <blockquote> <p>Still viewing the mask, select by color. Choose black. Shrink the selection by several pixels, being sure to NOT shrink from the edges of the mask (the shrink helps you avoid and recover from mistakes).</p> <p>Now disable the mask. View and edit the unmasked WIP layer. Using the color picker tool, choose a color that is average for the object. Drag-and-drop this color into the selection, thus removing most of the non-object pixels.</p> <p>This solid color will compress well and will help prevent ugly color fringes when Tux Paint scales the image down. If the edge of the object has multiple colors that are very different, you should split up your selection so that you can color the nearby background to be similar.</p> <p>Now you will paint away the existing edge fringe. Be sure that you are editing and viewing the WIP image. Frequent layer visibility changes will help you to see what you are doing. You are likely to use all of:</p> <ul> <li>composited over green (mask enabled) <li>composited over magenta (mask enabled) <li>original (the top or bottom layer) <li>composited over the original (mask enabled) <li>raw WIP layer (mask DISABLED) </ul> <p>To reduce accidents, you may wish to select only those pixels that are not grey in the mask. (Select by color from the mask, choose black, add mode, choose white, invert. Alternately: Select all, select by color from the mask, subtract mode, choose black, choose white.) If you do this, you'll probably want to expand the selection a bit and/or hide the "crawling ants" line that marks the selection.</p> <p>Use the clone tool and the brush tool. Vary the opacity as needed. Use small round brushes mostly, perhaps 3x3 or 5x5, fuzzy or not. (It is generally nice to pair up fuzzy brushes with 100% opacity and non-fuzzy brushes with about 70% opacity.) Unusual drawing modes can be helpful with semi-transparent objects.</p> <p>The goal is to remove the edge fringe, both inside and outside of the object. The inside fringe, visible when the object is composited over magenta or green, must be removed for obvious reasons. The outside fringe must also be removed because it will become visible when the image is scaled down. As an example, consider a 2x2 region of pixels at the edge of a sharp-edged object. The left half is black and 0% opaque. The right half is white and 100% opaque. That is, we have a white object on a black background. When Tux Paint scales this to 50% (a 1x1 pixel area), the result will be a grey 50% opaque pixel. The correct result would be a white 50% opaque pixel. To get this result, we would paint away the black pixels. They matter, despite being 0% opaque.</p> <p>Tux Paint can scale images down by a very large factor, so it is important to extend the edge of your object outward by a great deal. Right at the edge of your object, you should be very accurate about this. As you go outward away from the object, you can get a bit sloppy. It is reasonable to paint outward by a dozen pixels or more. The farther you go, the more Tux Paint can scale down without creating ugly color fringes. For areas that are more than a few pixels away from the object edge, you should use the pencil tool (or sloppy select with drag-and-drop color) to ensure that the result will compress well.</p> </blockquote> <h2>Save the image for Tux Paint</h2> <blockquote> <p>It is very easy to ruin your hard work. Image editors can silently destroy pixels in 0% opaque areas. The conditions under which this happens may vary from version to version. If you are very trusting, you can try saving your image directly as a PNG. Be sure to read it back in again to verify that the 0% opaque areas didn't turn black or white, which would create fringes when Tux Paint scales the image down. If you need to scale your image to save space (and hide your mistakes), you are almost certain to destroy all the 0% opaque areas. So here is a better way...</p> <h3>A Safer Way to Save:</h3> <blockquote> <p>Drag the mask from the layers dialog to the unused portion of the toolbar (right after the last drawing tool). This will create a new image consisting of one layer that contains the mask data. Scale this as desired, remembering the settings you use. Often you should start with an image that is about 700 to 1500 pixels across, and end up with one that is 300 to 400.</p> <p>Save the mask image as a NetPBM portable greymap ("<code>.pgm</code>") file. (If you are using an old release of The GIMP, you might need to convert the image to greyscale before you can save it.) Choose the more compact "RAW PGM" format. (The second character of the file should be the ASCII digit "5", hex byte 0x35.)</p> <p>You may close the mask image.</p> <p>Going back to the multi-layer image, now select the WIP layer. As you did with the mask, drag this from the layers dialog to the toolbar. You should get a single-layer image of your WIP data. If the mask came along too, get rid of it. You should be seeing the object and the painted-away surroundings, without any mask thumbnail in the layers dialog. If you scaled the mask, then scale this image in exactly the same way. Save this image as a NetPBM portable pixmap ("<code>.ppm</code>") file. (Note: ppm, not pgm.) (If you choose the RAW PPM format, the second byte of the file should be the ASCII digit "6", hex byte 0x36.)</p> <p>Now you need to merge the two files into one. Do that with the <a href="http://netpbm.sourceforge.net/">pnmtopng</a> command, like this:</p> <blockquote><p><code> pnmtopng -force -compression 9 -alpha mask.pgm fg.ppm > final-stamp.png </code></p></blockquote> </blockquote> </blockquote> </body></html> Index: OPTIONS.html =================================================================== RCS file: /cvsroot/tuxpaint/tuxpaint-website/docs/html/OPTIONS.html,v retrieving revision 1.2 retrieving revision 1.3 diff -u -d -r1.2 -r1.3 --- OPTIONS.html 11 Jul 2006 17:43:32 -0000 1.2 +++ OPTIONS.html 23 Oct 2006 19:25:47 -0000 1.3 @@ -11,18 +11,18 @@ version -0.9.15 +0.9.16 </h1> <h2>Options Documentation</h2> -<p>Copyright 2005 by Bill Kendrick and others<br> +<p>Copyright 2002-2006 by Bill Kendrick and others<br> New Breed Software</p> <p><a href="mailto:bill@...> <a href="http://www.newbreedsoftware.com/tuxpaint/">http://www.newbreedsoftware.com/tuxpaint/</a></p> -<p>November 12, 2005</p> +<p>October 11, 2006</p> </center> <hr size=2 noshade> @@ -383,6 +383,45 @@ It can be used in situations where the program is only being used for fun, or in a test environment. </dd> + + <dt><code><b>startblank=yes</b></code</dt> + <dd> + This causes Tux Paint to display a blank canvas when it first + starts up, rather than loading the last image that was being edited. + </dd> + + <dt><code><b>colorfile=<i>FILENAME</i></b></code></dt> + <dd> + <p>You may override Tux Paint's default color palette by creating + a plain ASCII text file that describes the colors you want, and + pointing to that file using the <code>colorfile</code> option.</p> + + <p>The file should list one color per line. Colors are defined in + terms of their Red, Green and Blue values, each from 0 (off) to 255 + (brightest). (For more information, try Wikipedia's + "<a href="http://en.wikipedia.org/wiki/Rgb">RGB color model</a>" + article.)</p> + + <p>Colors may be listed using three decimal numbers (e.g., + "<code>255 68 136</code>") or a 6- or 3-digit-long hexadecimal + 'triplet' (e.g., "<code>#ff4488</code>" or "<code>#F48</code>").</p> + + <p>After the color definition (on the same line) you may enter text to + describe the color. Tux will display this text when the color is + clicked. (For example, + "<code>#FFF White as snow.</code>")</p> + + <p>As an example, you can see the default colors currently + used in Tux Paint in: + "<a href="default_colors.txt"><code>default_colors.txt</code></a>".</p> + + <p>NOTES: You must separate decimal values with spaces, and begin + hexadecimal values with a pound/number-sign character + ("<code>#</code>"). In 3-digit hexadecimal, each digit is used for + both the high and low halves of the byte, so + "<code>#FFF</code>" is the same as "<code>#FFFFFF</code>", not + "<code>#F0F0F0</code>".</p> + </dd> <dt><code><b>lang=<i>LANGUAGE</i></b></code></dt> <dd> @@ -398,12 +437,17 @@ <td> </td> </tr> <tr> + <td><code>afrikaans</code></td> + <td> </td> + <td> </td> + </tr> + <tr> <td><code>albanian</code></td> <td> </td> <td> </td> </tr> <tr> - <td><code>afrikaans</code></td> + <td><code>arabic</code></td> <td> </td> <td> </td> </tr> @@ -478,6 +522,11 @@ <td> </td> </tr> <tr> + <td><code>faroese</code></td> + <td> </td> + <td> </td> + </tr> + <tr> <td><code>finnish</code></td> <td><code>suomi</code></td> <td> </td> @@ -490,7 +539,7 @@ <tr> <td><code>gaelic</code></td> <td><code>gaidhlig</code></td> - <td> </td> + <td><code>irish-gaelic</code></td> </tr> <tr> <td><code>galician</code></td> @@ -498,6 +547,11 @@ <td> </td> </tr> <tr> + <td><code>georgian</code></td> + <td> </td> + <td> </td> + </tr> + <tr> <td><code>german</code></td> <td><code>deutsch</code></td> <td> </td> @@ -513,6 +567,11 @@ <td> </td> </tr> <tr> + <td><code>gujarati</code></td> + <td> </td> + <td> </td> + </tr> + <tr> <td><code>hebrew</code></td> <td> </td> <td> </td> @@ -563,6 +622,11 @@ <td> </td> </tr> <tr> + <td><code>kurdish</code></td> + <td> </td> + <td> </td> + </tr> + <tr> <td><code>lithuanian</code></td> <td><code>lietuviu</code></td> <td> </td> @@ -578,6 +642,11 @@ <td><code>mexican</code></td> </tr> <tr> + <td><code>ndebele</code></td> + <td> </td> + <td> </td> + </tr> + <tr> <td><code>norwegian</code></td> <td><code>nynorsk</code></td> <td> </td> @@ -599,17 +668,17 @@ </tr> <tr> <td><code>russian</code></td> - <td> </td> + <td><code>russkiy</code></td> <td> </td> </tr> <tr> - <td><code>serbian</code></td> - <td> </td> - <td> </td> + <td><code>scottish</code></td> + <td><code>ghaidhlig</code></td> + <td><code>scottish-gaelic</code></td> </tr> <tr> - <td><code>spanish</code></td> - <td><code>espanol</code></td> + <td><code>serbian</code></td> + <td> </td> <td> </td> </tr> <tr> @@ -623,6 +692,16 @@ <td> </td> </tr> <tr> + <td><code>southafrican-english</code></td> + <td> </td> + <td> </td> + </tr> + <tr> + <td><code>spanish</code></td> + <td><code>espanol</code></td> + <td> </td> + </tr> + <tr> <td><code>swahili</code></td> <td> </td> <td> </td> @@ -633,6 +712,11 @@ <td> </td> </tr> <tr> + <td><code>tagalog</code></td> + <td> </td> + <td> </td> + </tr> + <tr> <td><code>tamil</code></td> <td> </td> <td> </td> @@ -643,6 +727,11 @@ <td> </td> </tr> <tr> + <td><code>tibetan</code></td> + <td> </td> + <td> </td> + </tr> + <tr> <td><code>traditional-chinese</code></td> <td> </td> <td> </td> @@ -658,6 +747,11 @@ <td> </td> </tr> <tr> + <td><code>venda</code></td> + <td> </td> + <td> </td> + </tr> + <tr> <td><code>vietnamese</code></td> <td> </td> <td> </td> @@ -672,6 +766,11 @@ <td><code>cymraeg</code></td> <td> </td> </tr> + <tr> + <td><code>xhosa</code></td> + <td> </td> + <td> </td> + </tr> </table> </blockquote> </dd> @@ -722,6 +821,7 @@ --1280x1204<br> --1400x1050<br> --1600x1200<br> + --startblank<br> --nosound<br> --noquit<br> --noprint<br> @@ -755,6 +855,7 @@ <dt><code><b> --windowed<br> --640x480<br> + --startlast<br> --sound<br> --quit<br> --print<br> @@ -908,6 +1009,11 @@ <td>Afrikaans</td> </tr> <tr> + <td><code>ar_SA</code></td> + <td> </td> + <td>Arabic</td> + </tr> + <tr> <td><code>be_BY</code></td> <td>Bielaruskaja</td> <td>Belarusian</td> @@ -918,6 +1024,11 @@ <td>Bulgarian</td> </tr> <tr> + <td><code>bo_CN</code></td> + <td> </td> + <td>Tibetan</td> + </tr> + <tr> <td><code>br_FR</code></td> <td>Brezhoneg</td> <td>Breton</td> @@ -963,6 +1074,11 @@ <td>British English</td> </tr> <tr> + <td><code>en_ZA</code></td> + <td> </td> + <td>South African English</td> + </tr> + <tr> <td><code>es_ES</code></td> <td>Español</td> <td>Spanish</td> @@ -983,6 +1099,11 @@ <td>Finnish</td> </tr> <tr> + <td><code>fo_FO</code></td> + <td> </td> + <td>Faroese</td> + </tr> + <tr> <td><code>fr_FR</code></td> <td>Français</td> <td>French</td> @@ -990,7 +1111,12 @@ <tr> <td><code>ga_IE</code></td> <td>Gàidhlig</td> - <td>Gaelic</td> + <td>Irish Gaelic</td> + </tr> + <tr> + <td><code>gd_GB</code></td> + <td>Ghaidhlig</td> + <td>Scottish Gaelic</td> </tr> <tr> <td><code>gl_ES</code></td> @@ -1003,6 +1129,11 @@ <td>Gronings</td> </tr> <tr> + <td><code>gu_IN</code></td> + <td> </td> + <td>Gujarati</td> + </tr> + <tr> <td><code>he_IL</code> (*)</td> <td> </td> <td>Hebrew</td> @@ -1043,11 +1174,21 @@ <td>Japanese</td> </tr> <tr> + <td><code>ka_GE.UTF-8</code></td> + <td> </td> + <td>Georgian</td> + </tr> + <tr> <td><code>ko_KR.UTF-8</code> (*)</td> <td> </td> <td>Korean</td> </tr> <tr> + <td><code>ku_TR.UTF-8</code></td> + <td> </td> + <td>Kurdish</td> + </tr> + <tr> <td><code>lt_LT.UTF-8</code></td> <td>Lietuviu</td> <td>Lithuanian</td> @@ -1073,6 +1214,11 @@ <td>Dutch</td> </tr> <tr> + <td><code>nr_ZA</code></td> + <td> </td> + <td>Ndebele</td> + </tr> + <tr> <td><code>pl_PL</code></td> <td>Polski</td> <td>Polish</td> @@ -1094,7 +1240,7 @@ </tr> <tr> <td><code>ru_RU</code></td> - <td> </td> + <td>Russkiy</td> <td>Russian</td> </tr> <tr> @@ -1143,6 +1289,11 @@ <td>Thai</td> </tr> <tr> + <td><code>tl_PH</code> (*)</td> + <td> </td> + <td>Tagalog</td> + </tr> + <tr> <td><code>tlh</code> (*)</td> <td>tlhIngan</td> <td>Klingon</td> @@ -1158,6 +1309,11 @@ <td>Ukrainian</td> </tr> <tr> + <td><code>ve_ZA</code></td> + <td> </td> + <td>Venda</td> + </tr> + <tr> <td><code>vi_VN</code></td> <td> </td> <td>Vietnamese</td> @@ -1168,6 +1324,11 @@ <td>Walloon</td> </tr> <tr> + <td><code>xh_ZA</code></td> + <td> </td> + <td>Xhosa</td> + </tr> + <tr> <td><code>zh_CN</code> (*)</td> <td> </td> <td>Chinese (Simplified)</td> --- NEW FILE: EXTENDING.html --- <!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN"> <html><head><title>Extending Tux Paint</title> <meta http-equiv="Content-Type" content="text/html; charset=us-ascii"> </head> <body bgcolor="#FFFFFF" text="#000000" link="#0000FF" vlink="#FF0000" alink="#FF00FF"> <center> <h1><img src="images/tuxpaint-title.png" width=220 height=219 alt="Tux Paint"><br> version 0.9.16 <br> Extending Tux Paint</h1> <p>Copyright 2002-2006 by Bill Kendrick and others<br> New Breed Software</p> <p><a href="mailto:bill@...> <a href="http://www.newbreedsoftware.com/tuxpaint/">http://www.newbreedsoftware.com/tuxpaint/</a></p> <p>June 14, 2002 - September 28, 2006</p> </center> <hr size=2 noshade> <p>If you wish to add or change things like Brushes and Rubber Stamps used by Tux Paint, you can do it fairly easily by simply putting or removing files on your hard disk.</p> <p>Note: You'll need to restart Tux Paint for the changes to take effect.</p> <h2>Where Files Go</h2> <blockquote> <h3>Standard Files</h3> <blockquote> <p>Tux Paint looks for its various data files in its 'data' directory.</p> <h4>Linux and Unix</h4> <blockquote> <p>Where this directory goes depends on what value was set for "<code>DATA_PREFIX</code>" when Tux Paint was built. See INSTALL.txt for details.</p> <p>By default, though, the directory is:</p> <blockquote><code> /usr/local/share/tuxpaint/ </code></blockquote> <p>If you installed from a package, it is more likely to be:</p> <blockquote><code> /usr/share/tuxpaint/ </code></blockquote> </blockquote> <h4>Windows</h4> <blockquote> <p>Tux Paint looks for a directory called 'data' in the same directory as the executable. This is the directory that the installer used when installing Tux Paint e.g.:</p> <blockquote><code> C:\Program Files\TuxPaint\data </code></blockquote> </blockquote> <h4>Mac OS X</h4> <blockquote> <p>Tux Paint stores its data files inside the "Tux Paint" icon (which is actually a special kind of folder on Mac OS X). The following steps explain how to get to the folders within:</p> <ol> <li>Bring up a 'context' menu by holding the [Control] key and clicking the Tux Paint icon the in Finder. (If you have a mouse with more than one button, you can simply right-click the icon.)</li> <li>Select "Show Contents" from the menu that appears. A new Finder window will appear with a folder inside called "Contents."</li> <li>Open the "Contents" folder and open the "Resources" folder found inside.</li> <li>There, you will find the "starters", "stamps" and "brushes" folders. Adding new content to these folders will make the content available to any user that launches this copy (icon) of Tux Paint.</li> </ol> <p><em>Note:</em> If you install a newer version of Tux Paint (by replacing its icon), you will lose changes made by following the instructions above, so keep backups of your new content (stamps, brushes, etc.).</p> <p>Tux Paint also looks for files in a "TuxPaint" folder that you can place in your system's "Application Support" folder (found under "Library" at the root of your hard disk):</p> <blockquote><code> /Library/Application Support/TuxPaint/ </code></blockquote> <p>It also looks for files in the user's "Preferences" folder, e.g.:</p> <blockquote><code> /Users/<i>(user name)</i>/Library/Preferences/TuxPaint/brushes/ </code></blockquote> </blockquote> </blockquote> <hr size=1 noshade> <h3>Personal Files</h3> <blockquote> <p>You can also create brushes, stamps, fonts and 'starters' in your own directory (folder) for Tux Paint to find.</p> <h4>Windows</h4> <blockquote> <p>Your personal Tux Paint folder is stored in your "Application Data". For example, on newer Windows (set up for an English-speaking user):</p> <blockquote><code> C:\Documents and Settings\<i>(user name)</i>\Application Data\TuxPaint\ </code></blockquote> </blockquote> <h4>Mac OS X</h4> <blockquote> <p>Your personal Tux Paint folder is stored in your "Library" folder: <blockquote><code> /Users/<i>(user name)</i>/Library/Application Support/ Tux Paint/</code> </code></blockquote> </blockquote> <h4>Linux and Unix</h4> <blockquote> <p>Your personal Tux Paint directory is "<code>$(HOME)/.tuxpaint/</code>" (also known as "<code>~/.tuxpaint/</code>".</p> <p>That is, if your home directory is "<code>/home/karl</code>", then your Tux Paint directory is "<code>/home/karl/.tuxpaint/</code>".</p> <p>Don't forget the period ("<code>.</code>") before the '<code>tuxpaint</code>'!</p> </blockquote> <p>To add brushes, stamps fonts, and 'starters,' create subdirectories under your personal Tux Paint directory named "<code><b>brushes</b></code>", "<code><b>stamps</b></code>", "<code><b>fonts</b></code>" and "<code><b>starters</b></code>" respectively.</p> <p>(For example, if you created a brush named "<code>flower.png</code>", you would put it in "<code>~/.tuxpaint/brushes/</code>" under Linux or Unix.)</p> </blockquote> </blockquote> <hr size=1 noshade> <h2>Brushes</h2> <blockquote> <p>The brushes used for drawing with the 'Brush' and 'Lines' tools in Tux Paint are simply PNG image files.</p> <img src="images/brush_edit.png" width=123 height=147 alt="" align=right> <p>The alpha (transparency) of the PNG image is used to determine the shape of the brush, which means that the shape can be 'anti-aliased' and even partially-transparent!</p> <p>Greyscale pixels in the brush PNG will be drawn using the currently-selected color in Tux Paint. Color pixels will be tinted.</p> <p>Brush images should be no wider than 40 pixels across and no taller than 40 pixels high. (i.e., the maximum size can be 40 x 40.)</p> <h3>Brush Options</h3> <blockquote> <p>Aside from a graphical shape, brushes can also be given other attributes. To do this, you need to create a 'data file' for the brush.</p> <p>A brush data file is simply a text file containing the options.</p> <p>The file has the same name as the PNG image, but a "<code>.dat</code>" extension. (e.g., "<code>brush.png</code>"'s data file is the text file "<code>brush.dat</code>" in the same directory.)</p> <h4>Brush Spacing</h4> <blockquote> <p>As of Tux Paint version 0.9.16, you can now specify the spacing for brushes (that is, how often they are drawn). By default, the spacing will be the brush's height, divided by 4.</p> <p>Add a line containing the line "<code><b>spacing=<i>N</i></b></code>" to the brush's data file, where <i>N</i> is the spacing you want for the brush. (The lower the number, the more often the brush is drawn.)</p> </blockquote> <h4>Animated Brushes</h4> <blockquote> <p>As of Tux Paint version 0.9.16, you may now create animated brushes. As the brush is used, each frame of the animation is drawn.</p> <p>Lay each frame out across a wide PNG image. For example, if your brush is 30x30 and you have 5 frames, the image should be 150x30.</p> <p>Add a line containing the line "<code><b>frames=<i>N</i></b></code>" to the brush's data file, where <i>N</i> is the number of frames in the brush.</p> <p><b>Note:</b> If you'd rather the frames be flipped through randomly, rather than sequentially, also add a line containing "<code><b>random</b></code>" to the brush's data file.</p> </blockquote> <h4>Directional Brushes</h4> <blockquote> <p>As of Tux Paint version 0.9.16, you may now create directional brushes. As the brush is used, different shapes are drawn, depending on the direction the brush is going.</p> <p>The directional shapes are divided into a 3x3 square in a PNG image. For example, if your brush is 30x30, the image should be 90x90, and each of the direction's shapes placed in a 3x3 grid. The center region is used for no motion. The top right is used for motion that's both up, and to the right. And so on.</p> <p>Add a line containing the line "<code><b>directional</b></code>" to the brush's data file.</p> </blockquote> <h4>Animated Directional Brushes</h4> <blockquote> <p>You may mix both animated and directional features into one brush. Use both options ("<code><b>frames=<i>N</i></b></code>" and "<code><b>directional</b></code>"), in separate lines in the brush's "<code>".dat</code>" file.</p> <p>Lay the brush out so that each 3x3 set of directional shapes are laid out across a wide PNG image. For example, if the brush is 30x30 and there are 5 frames, it would be 450x90. (The leftmost 150x90 pixels of the image represent the 9 direction shapes for the first frame, for example.)</p> </blockquote> </blockquote> <p>Place the brush image PNGs (and any data text files) in the "<code><b>brushes</b></code>" directory.</p> <p>Note: If your new brushes all come out as solid squares or rectangles, it's because you forgot to use alpha transparency! See the documentation file "PNG.txt" for more information and tips.</p> <br clear=all> </blockquote> <hr size=1 noshade> <h2>Stamps</h2> <blockquote> <p>All stamp-related files go in the "<code><b>stamps</b></code>" directory. It's useful to create subdirectories and sub-subdirectories there to organize the stamps. (For example, you can have a "<code>holidays</code>" folder with "<code>halloween</code>" and "<code>christmas</code>" sub-folders.)</p> <h3>Images</h3> <blockquote> <p>Rubber Stamps in Tux Paint can be made up of a number of separate files. The one file that is required is, of course, the picture itself.</p> <img src="images/stamp_edit.png" width=128 height=147 alt="" align=right> <p>The Stamps used by Tux Paint are PNG pictures. They can be full-color or greyscale. The alpha (transparency) of the PNG is used to determine the actual shape of the picture (otherwise you'll stamp a large rectangle on your drawings).</p> <p>The PNGs can be any size, but in practice, a 100 pixels wide by 100 pixels tall (100 x 100) is quite large for Tux Paint.</p> <p>Note: If your new stamps all have solid rectangular-shaped outlines of a solid color (e.g., white or black), it's because you forgot to use alpha transparency! See the documentation file "<a href="../PNG.txt">PNG.txt</a>" for more information and tips.</p> <p><b>Advanced Users:</b> The <a href="ADVANCED-STAMPS-HOWTO.html">Advanced Stamps HOWTO</a> describes, in detail, how to make images which will scale perfectly when used as stamps in Tux Paint.</p> <br clear=all> </blockquote> <hr size=1 noshade> <h3>Description Text</h3> <blockquote> <p>Text (".TXT") files with the same name as the PNG. (e.g., "<code>picture.png</code>"'s description is stored in "<code>picture.txt</code>" in the same directory.)</p> <p>The first line of the text file will be used as the US English description of the stamp's image. It must be encoded in UTF-8.</p> <h4>Language Support</h4> <blockquote> <p>Additional lines can be added to the text file to provide translations of the description, to be displayed when Tux Paint is running in a different locale (like French or Spanish).</p> <p>The beginning of the line should correspond to the language code of the language in question (e.g., "<code>fr</code>" for French, and "<code>zh_tw</code>" for Traditional Chinese), followed by "<code>.utf8=</code>" and the translated description (encoded in UTF-8).</p> <p>There are scripts in the "<code>po</code>" directory for converting the text files to PO format (and back) for easy translation to different languages. Therefore you should never add or change translations in the .txt files directly.</p> <p>If no translation is available for the language Tux Paint is currently running in, the US English text is used.</p> </blockquote> <h4>Windows Users</h4> <blockquote> <p>Use NotePad or WordPad to edit/create these files. Be sure to save them as Plain Text, and make sure they have "<code>.txt</code>" at the end of the filename...</p> </blockquote> </blockquote> <hr size=1 noshade> <h3>Sound Effects</h3> <blockquote> <p>WAVE (".WAV") files with the same name as the PNG. (e.g., "<code>picture.png</code>"'s sound effect is the sound "<code>picture.wav</code>" in the same directory.)</p> <h4>Language Support</h4> <blockquote> <p>For sounds for different locales (e.g., if the sound is someone saying a word, and you want translated versions of the word said), also create WAV files with the locale's label in the filename, in the form: "<code><b>STAMP_LOCALE</b>.wav</code>"</p> <p>"<code>picture.png</code>"'s sound effect, when Tux Paint is run in Spanish mode, would be "<code>picture_es.wav</code>". In French mode, "<code>picture_fr.wav</code>". And so on...</p> <p>If no localized sound effect can be loaded, Tux Paint will attempt to load the 'default' sound file. (e.g., "<code>picture.wav</code>")</p> </blockquote> </blockquote> <hr size=1 noshade> <h3>Stamp Options</h3> <blockquote> <p>Aside from a graphical shape, a textual description, and a sound effect, stamps can also be given other attributes. To do this, you need to create a 'data file' for the stamp.</p> <p>A stamp data file is simply a text file containing the options.</p> <p>The file has the same name as the PNG image, but a "<code>.dat</code>" extension. (e.g., "<code>picture.png</code>"'s data file is the text file "<code>picture.dat</code>" in the same directory.)</p> <h4>Colored Stamps</h4> <blockquote> <p>Stamps can be made to be either "colorable" or "tintable."</p> <h5>Colorable</h5> <blockquote> <p>"Colorable" stamps they work much like brushes - you pick the stamp to get the shape, and then pick the color you want it to be. (Symbol stamps, like the mathematical and musical ones, are an example.)</p> <p>Nothing about the original image is used except the transparency (from "alpha" channel). The color of the stamp comes out solid.</p> <center><img src="images/ex_colorable.png" width=74 height=92 alt=""></center> <p>Add a line containing the word "<code><b>colorable</b></code>" to the stamp's data file.</p> </blockquote> <h5>Tinted</h5> <blockquote> <p>"Tinted" stamps are similar to "colorable" ones, except the details of the original image are kept. (To put it technically, the original image is used, but its hue is changed, based on the currently-selected color.)</p> <center><img src="images/ex_tintable.png" width=151 height=78 alt=""></center> <p>Add a line containing the word "<code><b>tintable</b></code>" to the stamp's data file.</p> <h6>Tinting Options:</h6> <blockquote> <p>Depending on the contents of your stamp, you might want to have Tux Paint use one of a numer of methods when tinting it. Add one of the following lines to the stamp's data file:</p> <dl> <dt>"<code><b>tinter=normal</b></code>" (default)</dt> <dd>This is the normal tinting mode.</dd> <dt>"<code><b>tinter=anyhue</b></code>"</dt> <dd>This is ???.</dd> <dt>"<code><b>tinter=narrow</b></code>"</dt> <dd>This is ???.</dd> <dt>"<code><b>tinter=vector</b></code>"</dt> <dd>This is ???.</dd> </dl> </blockquote> </blockquote> </blockquote> <h4>Unalterable Stamps</h4> <blockquote> <p>By default, a stamp can be flipped upside down, shown as a mirror image, or both. This is done using the control buttons below the stamp selector, at the lower right side of the screen in Tux Paint.</p> <p>Sometimes, it doesn't make sense for a stamp to be flippable or mirrored; for example, stamps of letters or numbers. Sometimes stamps are symmetrical, so letting the user flip or mirror them isn't useful.</p> <p>To make a stamp un-flippable, add the option "<code><b>noflip</b></code>" to the stamp's data file.</p> <p>To keep a stamp from being mirrored, add a line containing the word "<code><b>nomirror</b></code>" to the stamp's data file.</p> </blockquote> <h4>Initial Stamp Size</h4> <blockquote> <p>By default, Tux Paint assumes that your stamp is sized appropriately for unscaled display on a 608x472 canvas. This is the original Tux Paint canvas size, provided by a 640x480 screen. Tux Paint will then adjust the stamp according to the current canvas size and, if enabled, the user's stamp size controls.</p> <p>If your stamp would be too big or too small, you can specify a scale factor. If your stamp would be 2.5 times as wide (or tall) as it should be, add the option "<code><b>scale 40%</b></code>" or "<code><b>scale 5/2</b></code>" or "<code><b>scale 2.5</b></code>" or "<code><b>scale 2:5</b></code>" to your image. You may include an "<code><b>=</b></code>" if you wish, as in "<code><b>scale=40%</b></code>".</p> </blockquote> <h4>Windows Users</h4> <blockquote> <p>You can use NotePad or WordPad to create these file. Be sure to save it as Plain Text, and make sure the filename has "<code>.dat</code>" at the end, and not "<code>.txt</code>"...</p> </blockquote> </blockquote> <h3>Pre-Mirrored Images</h3> <blockquote> <p>In some cases, you may wish to provide a pre-drawn version of a stamp's mirror-image. For example, imagine a picture of a fire truck with the words "<i>Fire Department</i>" written across the side. You probably do not want that text to appear backwards when the image is flipped!</p> <p>To create a mirrored version of a stamp that you want Tux Paint to use, rather than mirroring one on its own, simply create a second "<code>.png</code>" graphics file with the same name, except with the string "<code><b>_mirror</b></code>" before the filename extension.</p> <p>For example, for the stamp "<code><b>truck.png</b></code>" you would create another file named "<code><b>truck_mirror.png</b></code>", which will be used when the stamp is mirrored (rather than using a backwards version of '<code>truck.png</code>').</p> </blockquote> </blockquote> <hr size=1 noshade> <h2>Fonts</h2> <blockquote> <img src="images/fontsizes.png" width=48 height=48 alt="" align=right> <p>The fonts used by Tux Paint are TrueType Fonts (TTF).</p> <p>Simply place them in the "<code><b>fonts</b></code>" directory. Tux Paint will load the font and provide four different sizes in the 'Letters' selector when using the 'Text' tool.</p> <br clear=all> </blockquote> <hr size=1 noshade> <h2>'Starters'</h2> <blockquote> <img src="images/open_open.png" width=48 height=48 alt="" align=right> <p>'Starter' images appear in the 'Open' dialog, along with pictures you've created. They have a green button background, instead of blue.</p> <p>Unlike your saved pictures, however, when you select and open a 'starter,' you're actually creating a new drawing. Instead of being blank, though, the new drawing contains the contents of the 'starter.' Additionally, as you edit your new picture, the contents of the original 'starter' affect it.</p> <b>Coloring-Book Style</b> <blockquote> <p>The most basic kind of 'starter' is similar to a picture in a coloring book. It's an outline of a shape which you can then color in and add details to. In Tux Paint, as you draw, type text, or stamp stamps, the outline remains 'above' what you draw. You can erase the parts of the drawing you made, but you can't erase the outline.</p> <p>To create this kind of 'starter' image, simply draw an outlined picture in a paint program, make the rest of the graphic transparent (that will come out as white in Tux Paint), and save it as a PNG format file.</p> </blockquote> <b>Scene-Style</b> <blockquote> <p>Along with the 'coloring-book' style overlay, you can also provide a separate background image as part of a 'starter' picture. The overlay acts the same: it can't be drawn over, erased, or affected by 'Magic' tools. However, the background can be!</p> <p>When the 'Eraser' tool is used on a picture based on this kind of 'starter' image, rather than turning the canvas white, it returns that part of the canvas to the original background picture.</p> <p>By creating both an overlay and a background, you can create a 'starter' which simulates depth. Imagine a background that shows the ocean, and an overlay that's a picture of a reef. You can then draw (or stamp) fish in the picture. They'll appear in the ocean, but never 'in front of' the reef.</p> <p>To create this kind of 'starter' picture, simply create an overlay (with alpha transparency) as described above, and save it as a PNG. Then create another image (without transparency), and save it with the same filename, but with "<code>-back</code>" appended to the name. (e.g., "<code>reef-back.png</code>" would be the background ocean picture that corresponds to the "<code>reef.png</code>" overlay, or foreground.)</p> </blockquote> <p>The 'starter' images should be the same size as Tux Paint's canvas. In the default 640x480 mode, that is 448x376 pixels. If you're using 800x600 mode, it should be 608x496. (It should be 192 pixels less wide, and 104 pixels less tall than the resolution.)</p> <p>Place them in the "<code><b>starters</b></code>" directory. When the 'Open' dialog is accessed in Tux Paint, the 'starter' images will appear at the beginning of the list with a green background.</p> <p><b>Note:</b> 'Starters' can't be saved over from within Tux Paint, since loading a 'starter' is really like creating a new image. (Instead of being blank, though there's already something there to work with.) The 'Save' command simply creates a new picture, like it would if the 'New' command had been used.</p> <p><b>Note:</b> 'Starters' are 'attached' to saved pictures, via a small text file that has the same name as the saved file, but with "<code>.dat</code>" as the extension. This allows the overlay and background, if any, to continue to affect the drawing even after Tux Paint has been quit, or another picture loaded or started. (In other words, if you base a drawing on a 'starter' image, it will always be affected by it.)</p> <br clear=all> </blockquote> </body></html> Index: FAQ.html =================================================================== RCS file: /cvsroot/tuxpaint/tuxpaint-website/docs/html/FAQ.html,v retrieving revision 1.1 retrieving revision 1.2 diff -u -d -r1.1 -r1.2 --- FAQ.html 26 Nov 2005 21:28:06 -0000 1.1 +++ FAQ.html 23 Oct 2006 19:25:47 -0000 1.2 @@ -1,5 +1,5 @@ <!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN"> -<html><head><title>Tux Paint README</title> +<html><head><title>Tux Paint Frequently Asked Questions</title> <meta http-equiv="Content-Type" content="text/html; charset=us-ascii"> </head> @@ -11,19 +11,18 @@ alt="Tux Paint"><br> version -0.9.15 +0.9.16 <br> Frequently Asked Questions</h1> -<p>Copyright 2002-2005 by Bill Kendrick and others<br> +<p>Copyright 2002-2006 by Bill Kendrick and others<br> New Breed Software</p> <p><a href="mailto:bill@...> -<a href="http://www.newbreedsoftware.com/tuxpaint/">http://www.newbreedsoftware. -com/tuxpaint/</a></p> +<a href="http://www.newbreedsoftware.com/tuxpaint/">http://www.newbreedsoftware.com/tuxpaint/</a></p> -<p>September 14, 2002 - November 17, 2005</p> +<p>September 14, 2002 - March 8, 2006</p> </center> <h2>Drawing-related</h2> |
| Thread | Author | Date |
|---|---|---|
| [Tuxpaint-cvs] tuxpaint-website/docs/html ADVANCED-STAMPS-HOWTO.html, NONE, 1.1 EXTENDING.html, NONE, 1.1 FAQ.html, 1.1, 1.2 OPTIONS.html, 1.2, 1.3 README.html, 1.2, 1.3 | William Kendrick <wkendrick@us...> |