Warning, /games/palapeli/slicers/goldberg/README is written in an unsupported language. File is not indexed.

0001 The Goldberg Slicer: Versatile grid generator for the KDE puzzle game Palapeli
0002 
0003 Copyright (C) 2010 Johannes Loehnert (loehnert.kde@gmx.net)
0004 
0005 This program is free software; you can redistribute it and/or modify
0006 it under the terms of the GNU General Public License as published by
0007 the Free Software Foundation; either version 2 of the License, or
0008 (at your option) any later version.
0009 
0010 This program is distributed in the hope that it will be useful,
0011 but WITHOUT ANY WARRANTY; without even the implied warranty of
0012 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
0013 GNU General Public License for more details.
0014 
0015 You should have received a copy of the GNU General Public License along
0016 with this program; if not, write to the Free Software Foundation, Inc.,
0017 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.
0018 
0019 
0020 DESCRIPTION
0021 ===========
0022 
0023 The Goldberg slicer is a plugin for the game Palapeli, which comes with the KDE
0024 distribution from version 4.4 onwards. Slicers in Palapeli are responsible for
0025 splitting up an image into a number of puzzle pieces.
0026 
0027 The Goldberg slicer offers:
0028 
0029  * Authentic-looking jigsaw puzzles just like from the store
0030  * Distinctive, individual piece borders
0031  * Plenty of nifty knobs and switches to play with.
0032 
0033 The project is to be found on http://code.google.com/p/palapeli-goldberg-slicer.
0034 Mailing list: palapeli-goldberg-slicer@googlegroups.com.
0035 
0036 Infos about Palapeli can be found on the author's blog,
0037     http://majewsky.wordpress.com/
0038 
0039 
0040 USAGE
0041 =====
0042 
0043 Start Palapeli, click "Create puzzle". "Goldberg" should now be available as puzzle type. The options you can set are:
0044 
0045 == Tesselation type ==
0046 
0047 determines which grid is used to split up the image, or put another way, what shape the puzzle pieces will have. You have the following choices:
0048 
0049  * *Rectangular Grid*: The ordinary jigsaw puzzle as we all know and love it.
0050  * *Cairo pentagonal*: Five-sided pieces with unequal edge angles.
0051  * *Hexagonal*: Six-sided pieces.
0052  * *Rotrex (rhombi-trihexagonal)*: Hexagons surrounded by rectangles and triangles. Looks like many intersecting circles.
0053  * *Irregular*: random pieces. The program `qvoronoi` (part of qhull) is needed to generate irregular puzzles.
0054 
0055 The Cairo tesselation is rather hard to puzzle, since the pieces fit together in an unfamiliar manner. The Rotrex tesselation is simpler than the rectangular grid and looks pretty when put together.
0056 
0057 
0058 == Approx. piece count ==
0059 
0060 is used to calculate the grid size. In most cases the actual piece count will be somewhat larger or smaller than what you set.
0061 
0062 
0063 == Flipped edge percentage ==
0064 
0065 sets the probability for each edge (plug) to be "flipped". A plug is "flipped" if it points in the opposite direction as it would in a fully regular grid. On the rect grid, this results in pieces with 3 or 4 plugs pointing inwards resp. outwards.
0066 
0067  * 0% (slider at the left): no edges are flipped, fully regular grid
0068  * 50% (slider in the middle): All edges are random.
0069  * 100% (slider at the right): Fully regular grid again, but now with "alternate" rule.
0070 
0071 "Alternate" rule does _not_ simply mean reversal of all plugs. In the alternate rectangular grid, each piece has 4 inward or 4 outward-pointing plugs. For the other tesselations, just try it out.
0072 
0073 This setting has no effect when using the irregular tesselation.
0074 
0075 
0076 == Edge curviness ==
0077 
0078 determines how curvy the edges are, i.e. how strongly the borders "dent in" or "bulge out".
0079 
0080  * 0%: edges are straight lines (except for the plugs)
0081  * 100%: edges are very curved.
0082 
0083 
0084 == Plug size ==
0085 
0086 determines the size of the "plug" part of each edge. The default (middle) setting is chosen to look like a real puzzle.
0087 
0088  * 0%: plugs are half the default size
0089  * 100%: plugs are 1.5x the default size, which already looks obscenely large.
0090 
0091 Goldberg slicer tries very hard to avoid collisions between plugs. Colliding edges are reshaped multiple times and shrinked in small steps. However there still remain cases where no solution can be found, especially for large plug sizes.
0092 
0093 
0094 == Diversity of curviness ==
0095 
0096 determines how much the "curviness" (see above) varies between borders.
0097 
0098  * 0%: The "dents" and "bulges" look all the same.
0099  * 100%: There are very curvy and very straight borders.
0100 
0101 
0102 == Diversity of plug position ==
0103 
0104 determines how much the plug position varies:
0105 
0106  * 0%: Plugs are all in the middle of their border
0107  * 100%: Plugs may be anywhere between the border endpoints.
0108 
0109 
0110 == Diversity of plugs ==
0111 
0112 determines how individual the plugs look like.
0113 
0114  * 0%: Plugs look all the same.
0115  * 100%: Each plug will be a unique piece of art crafted especially for you.
0116 
0117 
0118 == Irr.: Diversity of piece size ==
0119 
0120 applies only to irregular tesselation, and determines how much the piece size varies.
0121 
0122  * 100%: very small and large pieces
0123  * 50%: (default) pieces are all roughly of same size
0124  * 0%: pieces are roughly of same size, crystallite-like structures arise
0125 
0126 
0127 == Piece outlines ==
0128 
0129 Draw a fine black outline around each piece, so that the individual pieces remain discernible in the assembled puzzle.
0130 
0131 
0132 == Dump grid image ==
0133 
0134 Save an image of the grid (black edges on white background). It is saved as `~/goldber-slicer-dump.png`. If a previous dump exists, it is overwritten.