home *** CD-ROM | disk | FTP | other *** search
/ PC World 2005 May / PCWorld_2005-05_cd.bin / software / vyzkuste / tuxpaint / tuxpaint-0.9.14-win32-installer-1.exe / docs / README.txt < prev    next >
Text File  |  2004-10-07  |  43KB  |  1,029 lines

  1.                                    Tux Paint
  2.                                  version 0.9.14
  3.  
  4.                      A simple drawing program for children
  5.  
  6.                         Copyright 2004 by Bill Kendrick
  7.                                New Breed Software
  8.  
  9.                            bill@newbreedsoftware.com
  10.                    http://www.newbreedsoftware.com/tuxpaint/
  11.  
  12.                        June 14, 2002 - September 24, 2004
  13.  
  14.    ---------------------------------------------------------------------------
  15.  
  16.                                      About
  17.  
  18. What Is 'Tux Paint?'
  19.  
  20.        Tux Paint is a free drawing program designed for young children (kids
  21.        ages 3 and up). It has a simple, easy-to-use interface, fun sound
  22.        effects, and an encouraging cartoon mascot who helps guide children as
  23.        they use the program. It provides a blank canvas and a variety of
  24.        drawing tools to help your child be creative.
  25.  
  26. License:
  27.  
  28.        Tux Paint is an Open Source project, Free Software released under the
  29.        GNU General Public License (GPL). It is free, and the 'source code'
  30.        behind the program is available. (This allows others to add features,
  31.        fix bugs, and use parts of the program in their own GPL'd software.)
  32.  
  33.        See COPYING.txt for the full text of the GPL license.
  34.  
  35. Objectives:
  36.  
  37.        Easy and Fun
  38.                Tux Paint is meant to be a simple drawing program for young
  39.                children. It is not meant as a general-purpose drawing tool.
  40.                It is meant to be fun and easy to use. Sound effects and a
  41.                cartoon character help let the user know what's going on, and
  42.                keeps them entertained. There are also extra-large
  43.                cartoon-style mouse pointer shapes.
  44.  
  45.        Extensibility
  46.                Tux Paint is extensible. Brushes and "rubber stamp" shapes can
  47.                be dropped in and pulled out. For example, a teacher can drop
  48.                in a collection of animal shapes and ask their students to
  49.                draw an ecosystem. Each shape can have a sound which is
  50.                played, and textual facts which are displayed, when the child
  51.                selects the shape.
  52.  
  53.        Portability
  54.                Tux Paint is portable among various computer platforms:
  55.                Windows, Macintosh, Linux, etc. The interface looks the same
  56.                among them all. Tux Paint runs suitably well on older systems
  57.                (like a Pentium 133), and can be built to run better on slow
  58.                systems.
  59.  
  60.        Simplicity
  61.                There is no direct access to the computer's underlying
  62.                intricacies. The current image is kept when the program quits,
  63.                and reappears when it is restarted. Saving images requires no
  64.                need to create filenames or use the keyboard. Opening an image
  65.                is done by selecting it from a collection of thumbnails.
  66.                Access to other files on the computer is restricted.
  67.  
  68.    ---------------------------------------------------------------------------
  69.  
  70.                                 Using Tux Paint
  71.  
  72. Loading Tux Paint
  73.  
  74.   Linux/Unix Users
  75.  
  76.          Tux Paint should have placed a laucher icon in your KDE and/or GNOME
  77.          menus, under 'Graphics.'
  78.  
  79.          Alternatively, you can run the following command at a shell prompt
  80.          (e.g., "$"):
  81.  
  82.            $ tuxpaint
  83.  
  84.          If any errors occur, they will be displayed on the terminal (to
  85.          "stderr").
  86.  
  87.    ---------------------------------------------------------------------------
  88.  
  89.   Windows Users
  90.  
  91.                                                                     [Icon]    
  92.                                                                    Tux Paint  
  93.  
  94.          If you installed Tux Paint on your computer using the
  95.          'Tux Paint Installer,' it will have asked you whether you wanted a
  96.          'Start' menu short-cut, and/or a desktop shortcut. If you agreed,
  97.          you can simply run Tux Paint from the 'Tux Paint' section of your
  98.          'Start' menu (e.g., under "All Programs" on Windows XP), or by
  99.          double-clicking the "Tux Paint" icon on your desktop.
  100.  
  101.          If you installed Tux Paint using the 'ZIP-file' download, or if you
  102.          used the 'Tux Paint Installer,' but chose not to have shortcuts
  103.          installed, you'll need to double-click the "tuxpaint.exe" icon in
  104.          the 'Tux Paint' folder on your computer.
  105.  
  106.          By default, the 'Tux Paint Installer' will put Tux Paint's folder in
  107.          "C:\Program Files\", though you may have changed this when the
  108.          installer ran.
  109.  
  110.          If you used the 'ZIP-file' download, Tux Paint's folder will be
  111.          wherever you put it when you unzipped the ZIP file.
  112.  
  113.    ---------------------------------------------------------------------------
  114.  
  115.   Mac OS X Users
  116.  
  117.          Simply double-click the "Tux Paint" icon.
  118.  
  119.    ---------------------------------------------------------------------------
  120.  
  121. Title Screen
  122.  
  123.        When Tux Paint first loads, a title/credits screen will appear.
  124.  
  125.                                [Title Screenshot]
  126.  
  127.        Once loading is complete, press a key or click on the mouse to
  128.        continue. (Or, after about 30 seconds, the title screen will go away
  129.        automatically.)
  130.  
  131.    ---------------------------------------------------------------------------
  132.  
  133. Main Screen
  134.  
  135.        The main screen is divided into the following sections:
  136.  
  137.        Left Side: Toolbar
  138.  
  139.                The toolbar contains the drawing and editing controls.
  140.  
  141. [Tools: Paint, Stamp, Lines, Shapes, Text, Magic, Undo, Redo,       Eraser, New,
  142.                             Open, Save, Print, Quit]
  143.  
  144.        Middle: Drawing Canvas
  145.  
  146.                The largest part of the screen, in the center, is the drawing
  147.                canvas. This is, obviously, where you draw!
  148.  
  149.                                    [(Canvas)]
  150.  
  151.        Right Side: Selector
  152.  
  153.                Depending on the current tool, the selector shows different
  154.                things. e.g., when the Paint Brush tool is selected, it shows
  155.                the various brushes available. When the Rubber Stamp tool is
  156.                selected, it shows the different shapes you can use.
  157.  
  158.                  [Selectors - Brushes, Letters, Shapes, Stamps]
  159.  
  160.        Lower: Colors
  161.  
  162.                A palette of available colors are shown near the bottom of the
  163.                screen.
  164.  
  165.   [Colors - Black, White, Red, Pink, Orange, Yellow, Green, Cyan,       Blue,
  166.                               Purple, Brown, Grey]
  167.  
  168.        Bottom: Help Area
  169.  
  170.                At the very bottom of the screen, Tux, the Linux Penguin,
  171.                provides tips and other information while you draw.
  172.  
  173.  (For example: 'Pick a shape. Click to pick the center, drag, then       let go
  174. when it is the size you want.  Move around to rotate it, and       click to draw
  175.                                       it.)
  176.  
  177.    ---------------------------------------------------------------------------
  178.  
  179. Available Tools
  180.  
  181.   Drawing Tools
  182.  
  183.          Paint (Brush)
  184.  
  185.                  The Paint Brush tool lets you draw freehand, using various
  186.                  brushes (chosen in the Selector on the right) and colors
  187.                  (chosen in the Color palette towards the bottom).
  188.  
  189.                  If you hold the mouse button down, and move the mouse, it
  190.                  will draw as you move.
  191.  
  192.                  As you draw, a sound is played. The bigger the brush, the
  193.                  lower the pitch.
  194.  
  195.    ---------------------------------------------------------------------------
  196.  
  197.          Stamp (Rubber Stamp)
  198.  
  199.                  The Stamp tool is like a rubber stamp, or stickers. It lets
  200.                  you paste pre-drawn or photographic images (like a picture
  201.                  of a horse, or a tree, or the moon) in your picture.
  202.  
  203.                  As you move the mouse around, an outline follows the mouse,
  204.                  showing where the stamp will be placed.
  205.  
  206.                  Different stamps can have different sound effects. Some
  207.                  stamps can be colored or tinted.
  208.  
  209.                  Stamps can be shrunk and expanded, and many stamps can be
  210.                  flipped vertically, or displayed as a mirror-image, using
  211.                  controls at the bottom right of the screen.
  212.  
  213.                  (NOTE: If the "nostampcontrols" option is set, Tux Paint
  214.                  won't display the Mirror, Flip, Shrink and Grow controls for
  215.                  stamps. See the "Options" documentation.)
  216.  
  217.    ---------------------------------------------------------------------------
  218.  
  219.          Lines
  220.  
  221.                  This tool lets you draw straight lines using the various
  222.                  brushes and colors you normally use with the Paint Brush.
  223.  
  224.                  Click the mouse and hold it to choose the starting point of
  225.                  the line. As you move the mouse around, a thin 'rubber-band'
  226.                  line will show where the line will be drawn.
  227.  
  228.                  Let go of the mouse to complete the line. A "sproing!" sound
  229.                  will play.
  230.  
  231.    ---------------------------------------------------------------------------
  232.  
  233.          Shapes
  234.  
  235.                  This tool lets you draw some simple filled, and un-filled
  236.                  shapes.
  237.  
  238.                  Select a shape from the selector on the right (circle,
  239.                  square, oval, etc.).
  240.  
  241.                  In the canvas, click the mouse and hold it to stretch the
  242.                  shape out from where you clicked. Some shapes can change
  243.                  proportion (e.g., rectangle and oval), others cannot (e.g.,
  244.                  square and circle).
  245.  
  246.                  Let go of the mouse when you're done stretching.
  247.  
  248.                       Normal Mode
  249.  
  250.                               Now you can move the mouse around the canvas to
  251.                               rotate the shape.
  252.  
  253.                               Click the mouse button again and the shape will
  254.                               be drawn in the current color.
  255.  
  256.                       Simple Shapes Mode
  257.                               If simple shapes are enabled (e.g., with the
  258.                               "--simpleshapes" option), the shape will be
  259.                               drawn on the canvas when you let go of the
  260.                               mouse button. (There's no rotation step.)
  261.  
  262.    ---------------------------------------------------------------------------
  263.  
  264.          Text
  265.  
  266.                  Choose a font (from the 'Letters' available on the right)
  267.                  and a color (from the color palette near the bottom). Click
  268.                  on the screen and a cursor will appear. Type text and it
  269.                  will show up on the screen.
  270.  
  271.                  Press [Enter] or [Return] and the text will be drawn onto
  272.                  the picture and the cursor will move down one line.
  273.  
  274.                  Click elsewhere in the picture and the current line of text
  275.                  will move there, where you can continue editing.
  276.  
  277.    ---------------------------------------------------------------------------
  278.  
  279.          Magic (Special Effects)
  280.  
  281.                  The 'Magic' tool is actually a set of special tools. Select
  282.                  one of the "magic" effects from the selector on the right,
  283.                  and then click and drag around the picture to apply the
  284.                  effect.
  285.  
  286.                       Rainbow
  287.                               This is similar to the paint brush, but as you
  288.                               move the mouse around, it goes through all of
  289.                               the colors in the rainbow.
  290.  
  291.                       Sparkles
  292.                               This draws glowing yellow sparkles on the
  293.                               picture.
  294.  
  295.                       Mirror
  296.                               When you click the mouse in your picture with
  297.                               the "Mirror" magic effect selected, the entire
  298.                               image will be reversed, turning it into a
  299.                               mirror image.
  300.  
  301.                       Flip
  302.                               Similar to "Mirror." Click and the entire image
  303.                               will be turned upside-down.
  304.  
  305.                       Blur
  306.                               This makes the picture fuzzy wherever you drag
  307.                               the mouse.
  308.  
  309.                       Blocks
  310.                               This makes the picture blocky looking
  311.                               ("pixelated") wherever you drag the mouse.
  312.  
  313.                       Negative
  314.                               This inverts the colors wherever you drag the
  315.                               mouse. (e.g., white becomes black, and vice
  316.                               versa.)
  317.  
  318.                       Fade
  319.                               This fades the colors wherever you drag the
  320.                               mouse. (Do it to the same spot many times, and
  321.                               it will eventually become white.)
  322.  
  323.                       Chalk
  324.                               This makes parts of the picture (where you move
  325.                               the mouse) look like a chalk drawing.
  326.  
  327.                       Drip
  328.                               This makes the paint "drip" wherever you move
  329.                               the mouse.
  330.  
  331.                       Thick
  332.                               This makes the darker colors in the picture
  333.                               become thicker wherever you drag the mouse.
  334.  
  335.                       Thin
  336.                               Similar to "Thick," except dark colors become
  337.                               thinner (light colors become thicker).
  338.  
  339.                       Fill
  340.                               This floods the picture with a color. It lets
  341.                               you quickly fill parts of the picture, as if it
  342.                               were a coloring book.
  343.  
  344.    ---------------------------------------------------------------------------
  345.  
  346.          Eraser
  347.  
  348.                  This tool is similar to the Paint Brush. Wherever you click
  349.                  (or click and drag), the picture will be erased either to
  350.                  white, or to the background picture, if you began the
  351.                  current drawing with a 'Starter' image.
  352.  
  353.                  A number of eraser sizes are available.
  354.  
  355.                  As you move the mouse around, a square outline follows the
  356.                  pointer, showing what part of the picture will be erased to
  357.                  white.
  358.  
  359.                  As you erase, a "squeaky clean" eraser/wiping sound is
  360.                  played.
  361.  
  362.    ---------------------------------------------------------------------------
  363.  
  364.   Other Controls
  365.  
  366.          Undo
  367.  
  368.                  Clicking this tool will undo the last drawing action. You
  369.                  can even undo more than once!
  370.  
  371.                  Note: You can also press [Control]-[Z] on the keyboard to
  372.                  undo.
  373.  
  374.    ---------------------------------------------------------------------------
  375.  
  376.          Redo
  377.  
  378.                  Clicking this tool will redo the drawing action you just
  379.                  "undid" with the 'Undo' button.
  380.  
  381.                  As long as you don't draw again, you can redo as many times
  382.                  as you had "undone!"
  383.  
  384.                  Note: You can also press [Control]-[R] on the keyboard to
  385.                  redo.
  386.  
  387.    ---------------------------------------------------------------------------
  388.  
  389.          New
  390.  
  391.                  Clicking the "New" button will start a new drawing. You will
  392.                  first be asked whether you really want to do this.
  393.  
  394.                  Note: You can also press [Control]-[N] on the keyboard to
  395.                  start a new drawing.
  396.  
  397.    ---------------------------------------------------------------------------
  398.  
  399.          Open
  400.  
  401.                  This shows you a list of all of the pictures you've saved.
  402.                  If there are more than can fit on the screen, use the "Up"
  403.                  and "Down" arrows at the top and bottom of the list to
  404.                  scroll through the list of pictures.
  405.  
  406.                  Click a picture to select it, then...
  407.  
  408.                       * Click the green "Open" button at the lower left of
  409.                         the list to load the selected picture.
  410.  
  411.                         (Alternatively, you can double-click a picture's icon
  412.                         to load it.)
  413.  
  414.                       * Click the brown "Erase" (trash can) button at the
  415.                         lower right of the list to erase the selected
  416.                         picture. (You will be asked to confirm.)
  417.  
  418.                       * Or click the red "Back" arrow button at the lower
  419.                         right of the list to cancel and return to the picture
  420.                         you were drawing.
  421.  
  422.                  'Starter' Images
  423.  
  424.                    Along with pictures you've created, Tux Paint can provided
  425.                    'Starter' images. Opening them is like creating a new
  426.                    picture, except that the picture isn't blank. 'Starters'
  427.                    can be like a page from a coloring book (a black-and-white
  428.                    outline of a picture, which you can then color in), or
  429.                    like a 3D photograph, where you draw the bits in between.
  430.  
  431.                    'Starter' images have a green background in the 'Open'
  432.                    screen. (Normal images have a blue background.) When you
  433.                    load a 'Starter,' draw on it, and then click 'Save,' it
  434.                    creates a new picture (it doesn't overwrite the original
  435.                    'Starter,' so you can use it again later).
  436.  
  437.                  If choose to open a picture, and your current drawing hasn't
  438.                  been saved, you will be prompted as to whether you want to
  439.                  save it or not. (See "Save," below.)
  440.  
  441.                  Note: You can also press [Control]-[O] on the keyboard to
  442.                  get the 'Open' dialog.
  443.  
  444.    ---------------------------------------------------------------------------
  445.  
  446.          Save
  447.  
  448.                  This saves your current picture.
  449.  
  450.                  If you haven't saved it before, it will create a new entry
  451.                  in the list of saved images. (i.e., it will create a new
  452.                  file)
  453.  
  454.                  Note: It won't ask you anything (e.g., for a filename). It
  455.                  will simply save the picture, and play a "camera shutter"
  456.                  sound effect.
  457.  
  458.                  If you HAVE saved the picture before, or this is a picture
  459.                  you just loaded using the "Open" command, you will first be
  460.                  asked whether you want to save over the old version, or
  461.                  create a new entry (a new file).
  462.  
  463.                  (NOTE: If either the "saveover" or "saveovernew" options are
  464.                  set, it won't ask before saving over. See the "Options"
  465.                  documentation.)
  466.  
  467.                  Note: You can also press [Control]-[S] on the keyboard to
  468.                  save.
  469.  
  470.    ---------------------------------------------------------------------------
  471.  
  472.          Print
  473.  
  474.                  Click this button and your picture will be printed!
  475.  
  476.                       Disabling Printing
  477.  
  478.                               If the "noprint" option was set (either with
  479.                               "noprint=yes" in Tux Paint's configuration
  480.                               file, or using "--noprint" on the
  481.                               command-line), the "Print" button will be
  482.                               disabled.
  483.  
  484.                               See the "Options" documentation.)
  485.  
  486.                       Restricting Printing
  487.  
  488.                               If the "printdelay" option was used (either
  489.                               with "printdelay=SECONDS" in the configuration
  490.                               file, or using "--printdelay=SECONDS" on the
  491.                               command-line), you can only print once every
  492.                               SECONDS seconds.
  493.  
  494.                               For example, with "printdelay=60", you can
  495.                               print only once a minute.
  496.  
  497.                               See the "Options" documentation.)
  498.  
  499.                       Printing Command
  500.  
  501.                               (Linux and Unix only)
  502.  
  503.                               The command used to print is actually a set of
  504.                               commands that convert a PNG to a PostScript and
  505.                               send it to the printer:
  506.  
  507.                                 pngtopnm | pnmtops | lpr
  508.  
  509.                               This command can be changed by setting the
  510.                               "printcommand" value in Tux Paint's
  511.                               configuration file.
  512.  
  513.                               See the "Options" documentation.)
  514.  
  515.                       Printer Settings
  516.  
  517.                               (Windows only)
  518.  
  519.                               By default, Tux Paint simply prints to the
  520.                               default printer with default settings when the
  521.                               'Print' button is pushed.
  522.  
  523.                               However, if you hold the [ALT] key on the
  524.                               keyboard while pushing the button, as long as
  525.                               you're not in fullscreen mode, a Windows print
  526.                               dialog will appear, where you can change the
  527.                               settings.
  528.  
  529.                               You can have the printer configuration changes
  530.                               stored by using the "printcfg" option, either
  531.                               by using "--printcfg" on the command-line, or
  532.                               "printcfg=yes" in Tux Paint's own configuration
  533.                               file ("tuxpaint.cfg").
  534.  
  535.                               If the "printcfg" option is used, printer
  536.                               settings will be loaded from the file
  537.                               "userdata/print.cfg". Any changes will be saved
  538.                               there as well.
  539.  
  540.                               See the "Options" documentation.)
  541.  
  542.    ---------------------------------------------------------------------------
  543.  
  544.          Quit
  545.  
  546.                  Clicking the "Quit" button, closing the Tux Paint window, or
  547.                  pushing the "Escape" key will quit Tux Paint.
  548.  
  549.                  (NOTE: The "Quit" button can be disabled (e.g., with the
  550.                  "--noquit" command-line option), but the [Escape] key will
  551.                  still work. See the "Options" documentation.)
  552.  
  553.                  You will first be prompted as to whether you really want to
  554.                  quit.
  555.  
  556.                  If you choose to quit, and you haven't saved the current
  557.                  picture, you will first be asked if wish to save it. If it's
  558.                  not a new image, you will then be asked if you want to save
  559.                  over the old version, or create a new entry. (See "Save"
  560.                  above.)
  561.  
  562.                  NOTE: If the image is saved, it will be reloaded
  563.                  automatically the next time you run Tux Paint!
  564.  
  565.    ---------------------------------------------------------------------------
  566.  
  567.                      Loading Other Pictures into Tux Paint
  568.  
  569.      Since Tux Paint's 'Open' dialog only displays pictures you created with
  570.      Tux Paint, what if you want to load some other picture or photograph
  571.      into Tux Paint to edit?
  572.  
  573.      To do so, you simply need to convert the picture into a PNG (Portable
  574.      Network Graphic) image file, and place it in Tux Paint's "saved"
  575.      directory. ("~/.tuxpaint/saved/" under Linux and Unix, "userdata\saved\"
  576.      under Windows, "Library/Preferences/tuxpaint/saved/" under Mac OS X.)
  577.  
  578. Using 'tuxpaint-import'
  579.  
  580.        Linux and Unix users can use the "tuxpaint-import" shell script which
  581.        gets installed when you install Tux Paint. It uses some NetPBM tools
  582.        to convert the image ("anytopnm"), resize it so that it will fit in
  583.        Tux Paint's canvas ("pnmscale"), and convert it to a PNG ("pnmtopng").
  584.  
  585.        It also uses the "date" command to get the current time and date,
  586.        which is the file-naming convention Tux Paint uses for saved files.
  587.        (Remember, you are never asked for a 'filename' when you go to Save or
  588.        Open pictures!)
  589.  
  590.        To use 'tuxpaint-import', simply run the command from a command-line
  591.        prompt and provide it the name(s) of the file(s) you wish to convert.
  592.  
  593.        They will be converted and placed in your Tux Paint 'saved' directory.
  594.        (Note: If you're doing this for a different user - e.g., your child,
  595.        you'll need to make sure to run the command under their account.)
  596.  
  597.        Example:
  598.  
  599.          $ tuxpaint-import grandma.jpg
  600.          grandma.jpg -> /home/username/.tuxpaint/saved/20020921123456.png
  601.          jpegtopnm: WRITING A PPM FILE
  602.  
  603.        The first line ("tuxpaint-import grandma.jpg") is the command to run.
  604.        The following two lines are output from the program while it's
  605.        working.
  606.  
  607.        Now you can load Tux Paint, and a version of that original picture
  608.        will be available under the 'Open' dialog. Just double-click its icon!
  609.  
  610. Doing it Manually
  611.  
  612.        Windows, Mac OS X and BeOS users must currently do the conversion
  613.        manually.
  614.  
  615.        Load a graphics program that is capable of both loading your picture
  616.        and saving a PNG format file. (See the documentation file "PNG.txt"
  617.        for a list of suggested software, and other references.)
  618.  
  619.        Reduce the size of the image to no wider than 448 pixels across and no
  620.        taller than 376 pixels tall. (i.e., the maximum size is 448 x 376
  621.        pixels)
  622.  
  623.        Save the picture in PNG format. It is highly recommended that you name
  624.        the filename using the current date and time, since that's the
  625.        convention Tux Paint uses:
  626.  
  627.          YYYYMMDDhhmmss.png
  628.  
  629.          * YYYY = Year
  630.          * MM = Month (01-12)
  631.          * DD = Day (01-31)
  632.          * HH = Hour, in 24-hour format (00-23)
  633.          * mm = Minute (00-59)
  634.          * ss = Second (00-59)
  635.  
  636.        e.g.:
  637.  
  638.          20020921130500 - for September 21, 2002, 1:05:00pm
  639.  
  640.        Place this PNG file in your Tux Paint 'saved' directory. (See above.)
  641.  
  642.        Under Windows, this is in the "userdata" folder. Under Mac OS X, this
  643.        is in "Library/Preferences/tuxpaint/" in your home directory.
  644.  
  645.    ---------------------------------------------------------------------------
  646.  
  647.                               Extending Tux Paint
  648.  
  649.      If you wish to add or change things like Brushes and Rubber Stamps used
  650.      by Tux Paint, you can do it fairly easily by simply putting or removing
  651.      files on your hard disk.
  652.  
  653.      Note: You'll need to restart Tux Paint for the changes to take effect.
  654.  
  655. Where Files Go
  656.  
  657.   Standard Files
  658.  
  659.          Tux Paint looks for its various data files in its 'data' directory.
  660.  
  661.     Linux and Unix
  662.  
  663.            Where this directory goes depends on what value was set for
  664.            "DATA_PREFIX" when Tux Paint was built. See INSTALL.txt for
  665.            details.
  666.  
  667.            By default, though, the directory is:
  668.  
  669.              /usr/local/share/tuxpaint/
  670.  
  671.            If you installed from a package, it is more likely to be:
  672.  
  673.              /usr/share/tuxpaint/
  674.  
  675.     Windows
  676.  
  677.            Tux Paint looks for a directory called 'data' in the same
  678.            directory as the executable. This is the directory that the
  679.            installer used when installing Tux Paint e.g.:
  680.  
  681.              C:\Program Files\TuxPaint\data
  682.  
  683.     Mac OS X
  684.  
  685.            Tux Paint stores files in your account's "Libraries" folder, under
  686.            "Preferences", e.g.:
  687.  
  688.              /Users/Joe/Library/Preferences/
  689.  
  690.    ---------------------------------------------------------------------------
  691.  
  692.   Personal Files
  693.  
  694.          You can also create brushes, stamps, fonts and 'starters' in your
  695.          own directory for Tux Paint to find.
  696.  
  697.     Linux and Unix
  698.  
  699.            Your personal Tux Paint directory is "~/.tuxpaint/".
  700.  
  701.            That is, if your home directory is "/home/karl", then your
  702.            Tux Paint directory is "/home/karl/.tuxpaint/".
  703.  
  704.            Don't forget the period (".") before the 'tuxpaint'!
  705.  
  706.     Windows
  707.  
  708.            Your personal Tux Paint directory is named "userdata" and is in
  709.            the same directory as the executable e.g.:
  710.  
  711.              C:\Program Files\TuxPaint\userdata
  712.  
  713.          To add brushes, stamps fonts, and 'starters,' create subdirectories
  714.          under your personal Tux Paint directory named "brushes", "stamps",
  715.          "fonts" and "starters" respectively.
  716.  
  717.          (For example, if you created a brush named "flower.png", you would
  718.          put it in "~/.tuxpaint/brushes/" under Linux or Unix.)
  719.  
  720.    ---------------------------------------------------------------------------
  721.  
  722. Brushes
  723.  
  724.        The brushes used for drawing with the 'Brush' and 'Lines' tools in
  725.        Tux Paint are simply greyscale PNG images.
  726.  
  727.        The alpha (transparency) of the PNG image is used to determine the
  728.        shape of the brush, which means that the shape can be 'anti-aliased'
  729.        and even partially-transparent!
  730.  
  731.        Brush images should be no wider than 40 pixels across and no taller
  732.        than 40 pixels high. (i.e., the maximum size can be 40 x 40.)
  733.  
  734.        Just place them in the "brushes" directory.
  735.  
  736.        Note: If your new brushes all come out as solid squares or rectangles,
  737.        it's because you forgot to use alpha transparency! See the
  738.        documentation file "PNG.txt" for more information and tips.
  739.  
  740.    ---------------------------------------------------------------------------
  741.  
  742. Stamps
  743.  
  744.        All stamp-related files go in the "stamps" directory. It's useful to
  745.        create subdirectories and sub-subdirectories there to organize the
  746.        stamps. (For example, you can have a "holidays" folder with
  747.        "halloween" and "christmas" sub-folders.)
  748.  
  749.   Images
  750.  
  751.          Rubber Stamps in Tux Paint can be made up of a number of separate
  752.          files. The one file that is required is, of course, the picture
  753.          itself.
  754.  
  755.          The Stamps used by Tux Paint are PNG pictures. They can be
  756.          full-color or greyscale. The alpha (transparency) of the PNG is used
  757.          to determine the actual shape of the picture (otherwise you'll stamp
  758.          a large rectangle on your drawings).
  759.  
  760.          The PNGs can be any size, but in practice, a 100 pixels wide by
  761.          100 pixels tall (100 x 100) is quite large for Tux Paint.
  762.  
  763.          Note: If your new stamps all have solid rectangular-shaped outlines
  764.          of a solid color (e.g., white or black), it's because you forgot to
  765.          use alpha transparency! See the documentation file "PNG.txt" for
  766.          more information and tips.
  767.  
  768.    ---------------------------------------------------------------------------
  769.  
  770.   Description Text
  771.  
  772.          Text (".TXT") files with the same name as the PNG. (e.g.,
  773.          "picture.png"'s description is stored in "picture.txt" in the same
  774.          directory.)
  775.  
  776.          The first line of the text file will be used as the US English
  777.          description of the stamp's image. It must be encoded in UTF-8.
  778.  
  779.     Language Support
  780.  
  781.            Additional lines can be added to the text file to provide
  782.            translations of the description, to be displayed when Tux Paint is
  783.            running in a different locale (like French or Spanish).
  784.  
  785.            The beginning of the line should correspond to the language code
  786.            of the language in question (e.g., "fr" for French, and "zh_tw"
  787.            for Traditional Chinese), followed by ".utf8=" and the translated
  788.            description (encoded in UTF-8).
  789.  
  790.            There are scripts in the "po" directory for converting the text
  791.            files to PO format (and back) for easy translation to different
  792.            languages. Therefore you should never add or change translations
  793.            in the .txt files directly.
  794.  
  795.            If no translation is available for the language Tux Paint is
  796.            currently running in, the US English text is used.
  797.  
  798.     Windows Users
  799.  
  800.            Use NotePad or WordPad to edit/create these files. Be sure to save
  801.            them as Plain Text, and make sure they have ".txt" at the end of
  802.            the filename...
  803.  
  804.    ---------------------------------------------------------------------------
  805.  
  806.   Sound Effects
  807.  
  808.          WAVE (".WAV") files with the same name as the PNG. (e.g.,
  809.          "picture.png"'s sound effect is the sound "picture.wav" in the same
  810.          directory.)
  811.  
  812.     Language Support
  813.  
  814.            For sounds for different locales (e.g., if the sound is someone
  815.            saying a word, and you want translated versions of the word said),
  816.            also create WAV files with the locale's label in the filename, in
  817.            the form: "STAMP_LOCALE.wav"
  818.  
  819.            "picture.png"'s sound effect, when Tux Paint is run in Spanish
  820.            mode, would be "picture_es.wav". In French mode, "picture_fr.wav".
  821.            And so on...
  822.  
  823.            If no localized sound effect can be loaded, Tux Paint will attempt
  824.            to load the 'default' sound file. (e.g., "picture.wav")
  825.  
  826.    ---------------------------------------------------------------------------
  827.  
  828.   Stamp Options
  829.  
  830.          Aside from a graphical shape, a textual description, and a sound
  831.          effect, stamps can also be given other attributes. To do this, you
  832.          need to create a 'data file' for the stamp.
  833.  
  834.          A stamp data file is simply a text file containing the options.
  835.  
  836.          The file has the same name as the PNG image, but a ".dat" extension.
  837.          (e.g., "picture.png"'s data file is the text file "picture.dat" in
  838.          the same directory.)
  839.  
  840.     Colored Stamps
  841.  
  842.            Stamps can be made to be either "colorable" or "tintable."
  843.  
  844.       Colorable
  845.  
  846.              "Colorable" stamps they work much like brushes - you pick the
  847.              stamp to get the shape, and then pick the color you want it to
  848.              be. (Symbol stamps, like the mathematical and musical ones, are
  849.              an example.)
  850.  
  851.              Nothing about the original image is used except the transparency
  852.              ("alpha" channel). The color of the stamp comes out solid.
  853.  
  854.              Add the word "colorable" to the stamp's data file.
  855.  
  856.       Tinted
  857.  
  858.              "Tinted" stamps are similar to "colorable" ones, except the
  859.              details of the original image are kept. (To put it technically,
  860.              the original image is used, but its hue is changed, based on the
  861.              currently-selected color.)
  862.  
  863.              Add the word "tintable" to the stamp's data file.
  864.  
  865.              Sometimes you don't want the white or gray parts of an image
  866.              tinted (see for example the dry erase marker stamp in the
  867.              default stamp package). You can add the word "notintgray" to the
  868.              stamp's data file to accomplish this. Only areas with saturation
  869.              over 25 % are then tinted.
  870.  
  871.     Unalterable Stamps
  872.  
  873.            By default, a stamp can be flipped upside down, shown as a mirror
  874.            image, or both. This is done using the control buttons below the
  875.            stamp selector, at the lower right side of the screen in
  876.            Tux Paint.
  877.  
  878.            Sometimes, it doesn't make sense for a stamp to be flippable or
  879.            mirrored; for example, stamps of letters or numbers. Sometimes
  880.            stamps are symmetrical, so letting the user flip or mirror them
  881.            isn't useful.
  882.  
  883.            To make a stamp un-flippable, add the option "noflip" to the
  884.            stamp's data file.
  885.  
  886.            To keep a stamp from being mirrored, add the option "nomirror" to
  887.            the stamp's data file.
  888.  
  889.     Windows Users
  890.  
  891.            You can use NotePad or WordPad to create these file. Be sure to
  892.            save it as Plain Text, and make sure the filename has ".dat" at
  893.            the end, and not ".txt"...
  894.  
  895.   Pre-Mirrored Images
  896.  
  897.          In some cases, you may wish to provide a pre-drawn version of a
  898.          stamp's mirror-image. For example, imagine a picture of a fire truck
  899.          with the words "Fire Department" written across the side. You
  900.          probably do not want that text to appear backwards when the image is
  901.          flipped!
  902.  
  903.          To create a mirrored version of a stamp that you want Tux Paint to
  904.          use, rather than mirroring one on its own, simply create a second
  905.          ".png" graphics file with the same name, except with the string
  906.          "_mirror" before the filename extension.
  907.  
  908.          For example, for the stamp "truck.png" you would create another file
  909.          named "truck_mirror.png", which will be used when the stamp is
  910.          mirrored (rather than using a backwards version of 'truck.png').
  911.  
  912.    ---------------------------------------------------------------------------
  913.  
  914. Fonts
  915.  
  916.        The fonts used by Tux Paint are TrueType Fonts (TTF).
  917.  
  918.        Simply place them in the "fonts" directory. Tux Paint will load the
  919.        font and provide four different sizes in the 'Letters' selector when
  920.        using the 'Text' tool.
  921.  
  922.    ---------------------------------------------------------------------------
  923.  
  924. 'Starters'
  925.  
  926.        'Starter' images appear in the 'Open' dialog, along with pictures
  927.        you've created. They have a green button background, instead of blue.
  928.  
  929.        Unlike your saved pictures, however, when you select and open a
  930.        'starter,' you're actually creating a new drawing. Instead of being
  931.        blank, though, the new drawing contains the contents of the 'starter.'
  932.        Additionally, as you edit your new picture, the contents of the
  933.        original 'starter' affect it.
  934.  
  935.        Coloring-Book Style
  936.  
  937.          The most basic kind of 'starter' is similar to a picture in a
  938.          coloring book. It's an outline of a shape which you can then color
  939.          in and add details to. In Tux Paint, as you draw, type text, or
  940.          stamp stamps, the outline remains 'above' what you draw. You can
  941.          erase the parts of the drawing you made, but you can't erase the
  942.          outline.
  943.  
  944.          To create this kind of 'starter' image, simply draw an outlined
  945.          picture in a paint program, make the rest of the graphic transparent
  946.          (that will come out as white in Tux Paint), and save it as a PNG
  947.          format file.
  948.  
  949.        Scene-Style
  950.  
  951.          Along with the 'coloring-book' style overlay, you can also provide a
  952.          separate background image as part of a 'starter' picture. The
  953.          overlay acts the same: it can't be drawn over, erased, or affected
  954.          by 'Magic' tools. However, the background can be!
  955.  
  956.          When the 'Eraser' tool is used on a picture based on this kind of
  957.          'starter' image, rather than turning the canvas white, it returns
  958.          that part of the canvas to the original background picture.
  959.  
  960.          By creating both an overlay and a background, you can create a
  961.          'starter' which simulates depth. Imagine a background that shows the
  962.          ocean, and an overlay that's a picture of a reef. You can then draw
  963.          (or stamp) fish in the picture. They'll appear in the ocean, but
  964.          never 'in front of' the reef.
  965.  
  966.          To create this kind of 'starter' picture, simply create an overlay
  967.          (with alpha transparency) as described above, and save it as a PNG.
  968.          Then create another image (without transparency), and save it with
  969.          the same filename, but with "-back" appended to the name. (e.g.,
  970.          "reef-back.png" would be the background ocean picture that
  971.          corresponds to the "reef.png" overlay, or foreground.)
  972.  
  973.        The 'starter' images should be the same size as Tux Paint's canvas. In
  974.        the default 640x480 mode, that is 448x376 pixels. (If you're using
  975.        800x600 mode, it should be 608x496.)
  976.  
  977.        Place them in the "starters" directory. When the 'Open' dialog is
  978.        accessed in Tux Paint, the 'starter' images will appear at the
  979.        beginning of the list with a green background.
  980.  
  981.        Note: 'Starters' can't be saved over from within Tux Paint, since
  982.        loading a 'starter' is really like creating a new image. (Instead of
  983.        being blank, though there's already something there to work with.) The
  984.        'Save' command simply creates a new picture, like it would if the
  985.        'New' command had been used.
  986.  
  987.        Note: 'Starters' are 'attached' to saved pictures, via a small text
  988.        file that has the same name as the saved file, but with ".dat" as the
  989.        extension. This allows the overlay and background, if any, to continue
  990.        to affect the drawing even after Tux Paint has been quit, or another
  991.        picture loaded or started. (In other words, if you base a drawing on a
  992.        'starter' image, it will always be affected by it.)
  993.  
  994.    ---------------------------------------------------------------------------
  995.  
  996.                                 Further Reading
  997.  
  998.      Other documentation included with Tux Paint (in the "docs"
  999.      folder/directory) include:
  1000.  
  1001.        * AUTHORS.txt
  1002.          List of authors and contributors
  1003.        * CHANGES.txt
  1004.          Summary of changed between releases
  1005.        * COPYING.txt
  1006.          Copying license (The GNU General Public License)
  1007.        * INSTALL.txt
  1008.          Instructions for compiling/installing, when applicable
  1009.        * OPTIONS.html
  1010.          Detailed instructions on command-line and configuration-file
  1011.          options, for those who don't want to use Tux Paint Config.
  1012.        * PNG.txt
  1013.          Notes on creating PNG format images for use in Tux Paint
  1014.        * TODO.txt
  1015.          A list of pending features or bugs needing fixed
  1016.  
  1017.    ---------------------------------------------------------------------------
  1018.  
  1019.                                 How to Get Help
  1020.  
  1021.      If you need help, feel free to contact New Breed Software:
  1022.  
  1023.        http://www.newbreedsoftware.com/
  1024.  
  1025.      You may also wish to participate in the numerous Tux Paint mailing
  1026.      lists:
  1027.  
  1028.        http://www.newbreedsoftware.com/tuxpaint/lists/
  1029.