home *** CD-ROM | disk | FTP | other *** search
/ ARM Club 3 / TheARMClub_PDCD3.iso / programs / misc / kisstools / !KISSTools / !Help < prev    next >
Text File  |  1998-12-08  |  9KB  |  249 lines
  1.  
  2.                    !KISSTools V0.8
  3.                    ~~~~~~~~~~~~~~~
  4.  
  5.   INDEX
  6.  
  7.   1 - Background to KISS (and plug for my KISS viewer, !PlayKISS)
  8.   2 - Overview of !KISSTools functionality
  9.   3 - Sprite->CEL conversion
  10.   4 - CEL->Sprite conversion
  11.   5 - Palette->KCF conversion
  12.   6 - KCF->Palette conversion
  13.   7 - Multiple file loads
  14.   8 - Other tools (plug for my KISS editor, !MakeKISS)
  15.   9 - LZH files, and their problems on RiscOS
  16.  10 - License conditions
  17.  11 - Disclaimer
  18.  12 - Bug reports/contacting me
  19.  
  20.       History
  21.  
  22.  
  23. 1. KISS Background
  24.  
  25. KISS is a paper doll program which originated in Japan in 1991.
  26. It was originally developed for a NEC computer, but has been
  27. ported to a number of operating systems & platforms including
  28. Windows, MacIntosh and Amiga.
  29.  
  30. To help spread KISS, the specification was formalised (and
  31. broadened, to allow for more capable hardware). This is known
  32. as the KISS General Specification (KISS/GS), and is available
  33. on the web on "The Big KISS Page" at:
  34.  
  35.    http://otakuworld.com/dov/kiss/index.html
  36.  
  37. KISS/GS is absolutely required reading to create or edit your own
  38. dolls, so this help file assumes you are familiar with the KISS/GS
  39. terminology.
  40.  
  41. There is a (not-terribly-well-supported) variant of KiSS known as
  42. Cherry KiSS (why, I don't know). Standard KiSS uses 4 or 8 bpp
  43. colour images as the basic building block; Cherry KiSS uses
  44. true-colour (24 bpp) images. From version 0.3, KiSSTools provides
  45. support for Cherry KiSS as well.
  46.  
  47. To view KISS dolls on an Acorn RiscPC, use my !PlayKISS program
  48. (from V3.00, PlayKISS supports Cherry KISS).
  49.  
  50.  
  51. 2. !KISSTools overview
  52.  
  53. !KISSTools is a very simple tool to help create and KISS dolls.
  54. It provides 4 basic functions:
  55.  
  56.     i) Convert sprites to CEL files.
  57.  
  58.    ii) Convert CEL files to sprites.
  59.  
  60.   iii) Convert RiscOS palette files to KISS "KCF" palettes.
  61.  
  62.    iv) Convert KCF files to RiscOS palette files.
  63.  
  64. These are described in the following sections.
  65.  
  66.  
  67. 3. Sprite->Cel conversion
  68.  
  69. Any sprite of 256 colours or less can be converted to KISS/GS2
  70. cels; in addition, sprites of 16 or fewer colours can be converted
  71. to KISS/GS1 sprites.
  72.  
  73. To convert a sprite, simply drag the file it to the iconbar icon;
  74. you will be presented with a normal "Save As" box (filetype "Data")
  75. with a default filename generated from the sprite name.
  76.  
  77. The Save As box has the following options:
  78.  
  79.   Trim   : If ticked, all transparent rows and columns around the 
  80.            edges of the sprite will be removed.
  81.  
  82.   GS2+   : If ticked, the sprite will be converted to a KISS/GS2
  83.            or later format cel. If "Trim" is not selected, left
  84.            hand transparent columns and top transparent rows will
  85.            be removed, and the "offset" fields in the cel header
  86.            set to compensate.
  87.  
  88.   Cherry : If ticked, allows 16 or 32 bpp sprites to be converted
  89.            into Cherry KiSS cels. NB. If this is selected, GS2+
  90.            rules for trimming are applied, irresepctive of
  91.            whether the GS2+ option is enabled.
  92.  
  93. If the sprite file contains more than one sprite, they will be
  94. processed in sequence (ie after each sprite is converted, the
  95. Save As box will open again for the next sprite).
  96.  
  97. NB As KISS defines colour 0 to mean "transparent", all pixels in
  98. the sprite that are either masked or are colour 0 will be mapped
  99. onto colour zero (this does not apply to Cherry KiSS).
  100.  
  101.  
  102. 4. Cel->Sprite conversion
  103.  
  104. To convert a CEL file, drag it to the iconbar icon; a Save As
  105. box will appear. There are no options for this conversion.
  106.  
  107. CEL files will be converted to MODE 27 sprites (16-colour CELs)
  108. MODE 28 sprites (256-colour CELs), or a "deep" sprite for Cherry
  109. KiSS CELs. If the CEL file is a new-format CEL (ie KISS/GS2),
  110. the sprite will have transparent rows and/or columns added
  111. at the top and left to account for any "offset" fields in the CEL
  112. header.
  113.  
  114. Sprites generated from non-Cherry KiSS cels will have a bizarre
  115. appearance using the default desktop palette (as they have no
  116. palette). To view it as it should be, convert its KCF file to a
  117. RiscOS palette file, and drop the palette into the sprite editing
  118. window in !Paint.
  119.  
  120. NB CEL files must be file-typed "Data", and should be correctedly
  121. named (ie terminate with "/cel") for !KISSTools to recognise them.
  122.  
  123. NNB !PlayKISS also provides a Cel export facility to extract all
  124. the cels into a single sprite file. However, they are "New Format"
  125. sprites (ie with a 1 bit-per-pixel mask), and !Paint  will not
  126. allow the palette to be set by dragging and dropping a palette
  127. file. The !PlayKISS cel export facility should therefore be seen
  128. as giving an overview of the available cels, rather than a tool for
  129. building dolls.
  130.  
  131.  
  132. 5. Palette->KCF conversion
  133.  
  134. To convert one or more palette files into a single KCF file, drag
  135. them to the iconbar. A Save As box will appear, with the following
  136. options:
  137.  
  138.   GS2+ : If ticked, the resulting KCF file will be in KISS/GS2
  139.          format.
  140.  
  141.   12 bit ) These define the accuracy of the palette. KISS/GS1
  142.          ) files only allow 12-bit accuracy, so this is disabled
  143.   24 bit ) if the GS2+ option described above is not ticked.
  144.  
  145. KCF files contain between 1 and 10 palette groups, Multiple groups
  146. can be contructed by dragging multiple palette files to the iconbar
  147. (or the Save As box after it has opened); each palette file will
  148. generate a separate group (the number of palette groups in the KCF
  149. file is shown on the Save As box.
  150.  
  151. Palettes are not used for Cherry KiSS.
  152.  
  153.  
  154. 6. KCF->Palette conversion
  155.  
  156. To convert one of the palette groups in a KCF file to a RiscOS
  157. palette, drag the KCF file to the iconbar. A SaveAs box will
  158. appear, with a control which allows a palette group number to be
  159. specified for the conversion.
  160.  
  161. If the palette group number specified is greater than the number of
  162. groups in the file, the highest numbered group is converted.
  163.  
  164. NB KCF files must be typed as "Data", and should be correctedly
  165. named (ie terminate with "/kcf") for !KISSTools to recognise them.
  166.  
  167.  
  168. 7. Dragging multiple files to the iconbar
  169.  
  170. A mixed set of sprites, palettes, and data files can be dragged to
  171. the iconbar, and they will be processed in turn (but ordered by
  172. type). If the "Cancel" button on a Save As box is selected, that
  173. conversion AND ALL THE OUTSTANDING CONVERSIONS are discarded.
  174.  
  175.  
  176. 8. Other tools
  177.  
  178. !MakeKISS, a KISS doll development tool, is now available, which
  179. provides a number of sophisticated doll editing facilities.
  180.  
  181. Although it provides similar file conversion facilities as
  182. !KISSTools, it is not a complete replacement, as the latter is
  183. much more convenient for converting large numbers of files.
  184.  
  185.  
  186. 9. LZH archives
  187.  
  188. Unfortunately, SparkFS only provides read access to LZH archives,
  189. not write access. An appropriate archiver, lharc (and its desktop
  190. front end, DTLharc) is available from my web site, at:
  191.  
  192.    http://www.argonet.co.uk.users/tigger/programs/progs.html
  193.  
  194.  
  195. 10. License Conditions
  196.  
  197. !KISSTools is NOT Public Domain. However, copies may be passed on
  198. to other people as long as the following conditions are met:
  199.  
  200.  (1) Copies may be passed between private individuals as long as
  201.      this is done free of charge.
  202.  
  203.  (2) It may be distributed by public domain libraries, as long as
  204.      no charge is made other than for the media.
  205.  
  206.  (3) It may be distributed by remote databases such as FTP sites
  207.      or mail servers on InterNet or bulletin boards, as long as no
  208.      charge is made for downloading it (other than the cost of the
  209.      phone call).
  210.  
  211.  (4) The copyright remains with me at all times.
  212.  
  213.  (5) It is distributed in its entirety, including these conditions.
  214.  
  215.  
  216. 11. Disclaimer
  217.  
  218. !KISSTools is distributed "as is", and used at your own risk. I
  219. accept no responsibility for damage to your computer, your data,
  220. or even the possibly addictive effects of KISS.
  221.  
  222.  
  223. 12. Further information & bug reports
  224.  
  225. If you have any problems with !KISSTools, please contact me at the
  226. email address given below, and I'll try to fix them.
  227.  
  228. Nick Roberts
  229. tigger@argonet.co.uk
  230.  
  231. =====================================================================
  232.  
  233. History:
  234.  
  235. Version       Description
  236.  
  237.   0.1         First general release. Probably a bit "beta".
  238.   0.2         Fixed default name in sprite->cel conversion saveas.
  239.   0.3         Added simple support for "Cherry" KiSS truecolour cels.
  240.   0.4         Fixed minor bug with 16 colour cels.
  241.   0.5         Fixed bug with transparency for cels with an offset.
  242.   0.6         Internal rewrite to use common code with MakeKISS
  243.   0.7         Now uses version 2 of the shared KISS code.
  244.               Name of cel in a sprite->cel conversion could contain
  245.               a period (if the source sprite did). Now fixed.
  246.   0.8         Stupid error in conversion from 256-colour sprites to
  247.               cels - didn't allow for difference between GCOL and
  248.               colour number. Now fixed. Also, uses V3 of Shared KISS
  249.               code.