home *** CD-ROM | disk | FTP | other *** search
/ Chip Hitware 6 B / CHIP_HITWARE6_B.iso / gry / wkiss / tools / ks_utils.lzh / KISSFMT.DOC < prev    next >
Encoding:
Text File  |  1994-04-24  |  6.8 KB  |  292 lines
  1.  
  2. This is a partial translation of KISS224C.DOC, a document included in 
  3. KISS224C.LZH (Kiss for PC-9801 ver.2.24c)
  4.  
  5. -------------------------------------------------------------------------------
  6.  
  7.     PC-9801
  8.     Kisekae program KISS.EXE ver 2.24c
  9.  
  10.     Data Creation Manual
  11.  
  12. -------------------------------------------------------------------------------
  13.  
  14.  
  15.  
  16. 1. FUNCTION AND LIMITATIONS OF KISS
  17.  
  18.     KISS is an image display program with transparency processing. 
  19.     It comforms to the hardware of NEC PC-9801 series and therefore
  20.     has the limitations:
  21.  
  22.     * Pictures are limited to 16 colors out of a palette of 4096 colors.
  23.  
  24.     The KISS program
  25.  
  26.     * Can overlap up to 128 pictures.
  27.  
  28.     And it has object manipulation functions with mouse manipulation
  29.     so that it can be used as kisekae.
  30.  
  31.     * You can move the clothes and other objects with the mouse.
  32.  
  33.     In addition you can
  34.  
  35.     * Save the allocation of objects you have made.
  36.  
  37.  
  38.  
  39. 2.    DATA FILES
  40.  
  41.     KISS has the following types of data files:
  42.  
  43.     * Cel files
  44.  
  45.         These specify the individual elements of picture data.
  46.         There are 16 available colors, and color #0 is transparent.
  47.  
  48.     * Palette file
  49.  
  50.         This specifies the palette of 16 colors.
  51.         You can at one time use 16 out of 4096 colors.
  52.         A set of 16 colors forms a palette group.
  53.         You can select one of 10 palette groups.
  54.  
  55.     * Configuration file
  56.  
  57.         This specifies how to overlap or locate cel data.
  58.         Since it is a text file it can be made with a text editor.
  59.  
  60.         WARNING:
  61.         A part of it may be overwritten by the KISS program when 
  62.         the Save function is invoked.
  63.  
  64.         N.B.
  65.         Most KISS data are created in the MS-DOS environment,
  66.         thus the end-of-line codes in the configuration file are 
  67.         usually CR/LF. You may as well convert them into appropriate 
  68.         ones for your system before you play. e.g. CR for Macintosh,
  69.         LF for UNIX (X window system).
  70.  
  71.  
  72.  
  73. 3.    TERMINOLOGY
  74.  
  75.     Cel        A minimum picture unit KISS deals with.
  76.  
  77.     Object        A picture that consists of one or more cels.
  78.             It is a basic unit moved with a mouse.
  79.  
  80.     Palette group    Palette information of 16 colors out of 4096.
  81.  
  82.     Set        A pattern of picture that consists of 
  83.             a palette group and allocated objects.
  84.  
  85.  
  86.  
  87. 4.    CONFIGURATION FILE (.CNF) FORMAT
  88.  
  89.     The leftmost character of each line determines the function of 
  90.     the line.
  91.  
  92.  
  93.     '='    Memory Size
  94.  
  95.         synopsis: =<memory>K
  96.  
  97.         Specifies the amount of memory KISS needs as the data area
  98.         when starting up. This directive exists for compatibility 
  99.         with ver.1 and is ignored in ver.2. It is recommended not 
  100.         to specify it.
  101.  
  102.         e.g.
  103.  
  104.         =260K
  105.  
  106.     '('    Screen Size
  107.  
  108.         synopsis: (width,height)
  109.  
  110.         Specifies the size of the kisekae screen. Default is 
  111.         (448,320), which is compatible with ver.2.18.
  112.         The maximum is (640,400).
  113.  
  114.         e.g.
  115.  
  116.         (640,400)
  117.  
  118.     '%'    Palette File
  119.  
  120.         synopsis: %<palette file name>
  121.  
  122.         Specifies the palette file.
  123.  
  124.         e.g.
  125.  
  126.         %COL.KCF
  127.  
  128.     '['    Border Color
  129.  
  130.         synopsis: [<border color code>
  131.  
  132.         Specifies the border color. The range is within 0 - 15.
  133.  
  134.         e.g.
  135.  
  136.         [12
  137.  
  138.     '#'    Cel Files (multiple instances permitted)
  139.  
  140.         synopsys: #<mark>[.<fixed value>] <cel file name> [:<set#> ...]
  141.  
  142.         <mark>        The object ID. The cels of the same <mark>
  143.                 value will be treated as one object.
  144.                 The range is within 0 - 127.
  145.  
  146.         <fixed value>    Specifies that the object cannot be moved 
  147.                 in normal operation.
  148.                 The range is within 0 - 32767.
  149.                 The default is 0 (movable).
  150.  
  151.         <cel file name>    Extensions cannot be omitted.
  152.  
  153.         <set#>        You should specify this if you want the cel 
  154.                 data to be available only in particular sets.
  155.                 The range is within 0 - 9.
  156.                 If omitted, the cel is available in all sets.
  157.  
  158.         If multiple cel files are specified (you cannot play kisekae
  159.         with only one cel, so you usually specify multiple cels), 
  160.         the order of specifications represents the priority of cels.
  161.         Up to 128 cels can be specified.
  162.  
  163.         e.g.
  164.  
  165.         #2    data1.cel            ; upper cel
  166.         #3    data2.cel    :2 3 4        ; 
  167.         #4.255    data3.cel            ; fixed
  168.         #2    data1_.cel            ; lower cel
  169.  
  170.         In this example data1.cel and data1_.cel are treated as 
  171.         one object. Between them data2.cel and data3.cel can
  172.         go through.
  173.  
  174.     '$'    Set Information (multiple instances permitted)
  175.  
  176.         synopsis: $<palette group> [{<x-coord,y-coord>|*} ...]
  177.  
  178.         Specifies the palette group and the coordinates of every 
  179.         object in each set.
  180.         The first specification corresponds set #0, and you can
  181.         specify up to 10 sets.
  182.         This directive is generated automatically with the Save
  183.         function of KISS, therefore users seldom ever need to edit 
  184.         it directly.
  185.  
  186.         If this directive exceeds one line, the rest is written 
  187.         in the next line as a continued line. The leftmost character
  188.         of continued lines is ' ' (space).
  189.  
  190.         <palette group>    0 - 9.
  191.         <x-,y-coord>    Coordinates of the objects. (up to 128)
  192.                 The order of appearance corresponds to 
  193.                 the <mark> value of objects.
  194.                 '*' is specified as a filler for unused
  195.                 objects in the set.
  196.  
  197.         e.g.
  198.  
  199.         $2 192,11 * 56,176 55,21 259,62 15,24 375,63
  200.         $3 43,115 154,62 372,108 253,156 * * * 165,207
  201.          * 162,198 * 119,56 152,44 * * * 
  202.          16,355 394,362 108,355 * * * 125,261
  203.         $0 192,11 * 56,176 55,21 259,62 15,24 375,63
  204.  
  205.     ';'    Comment
  206.  
  207.         synopsis: ;<comment>
  208.  
  209.         Will be ignored.
  210.  
  211.  
  212.  
  213. 5.    CEL FILE (.CEL) FORMAT
  214.  
  215.     offset    contents
  216.     ------    --------
  217.     +0    width  (16 bits, little endian, <= 640)
  218.     +2    height (16 bits, little endian, <= 400)
  219.     +4~    image data
  220.  
  221.     image data format:
  222.     Each nibble(4 bits) represents one pixel.
  223.     If the width is an odd number an additional pixel of color #0 is 
  224.     appended at the rightmost.
  225.  
  226.  
  227.  
  228. 6.    PALETTE FILE (.KCF) FORMAT
  229.  
  230.     A color is specified with 16 bits (little endian).
  231.     Each RGB component is 4 bits, resulting in a palette of 4096 colors.
  232.  
  233.     MSB              LSB
  234.     | 0000 | gggg | rrrr | bbbb |
  235.  
  236.     In the bytewise hex dump they look like:
  237.  
  238.         RB 0G RB 0G .. ..
  239.  
  240.     16 bits x 16 colors x 10 groups = 320 bytes
  241.  
  242.  
  243.  
  244. 7.    COMPARISON WITH KISS VER 2.18
  245.  
  246.     item            KISS ver 2.24c        KISS ver 2.18
  247.     ------------        --------------        -------------
  248.     Kisekae area        640x400            448x320
  249.     Max# of objects        128            48
  250.     Max# of cels        128            48
  251.     # of sets         10            10
  252.     # of palette groups     10            10
  253.  
  254.  
  255.  
  256. 8.    DEBUG INFORMATION
  257.  
  258.     Debug information is output when the -d option is specified.
  259.  
  260.     * Cel loading info
  261.  
  262.     $1b61:0  12763 Bytes/ 172 x  25    0   0 plate.cel
  263.     $1e7f:0   5670 Bytes/  68 x  45   12   0 shoes2.cel
  264.     $1fe2:0      4475 Bytes/  67 x  32   11   0 shoes1.cel
  265.     -------    ------------ ----------  --- --- ----------
  266.     1)    2)         3)          4)  5)  6)
  267.  
  268.     1)    Memory address of a cel loaded (segment:offset)
  269.     2)    Size of cel loaded (includes expanded memory)
  270.     3)    Size of cel (width x height)
  271.     4)    Value of <mark>
  272.     5)    Fixed value
  273.     6)    File name
  274.  
  275.     * Object click info
  276.  
  277.     1st line        2nd line
  278.       8:( 20,105)           5 /   2
  279.     --- ----------        ----  ----
  280.     1)  2)            3)    4)
  281.  
  282.     1) Value of <mark>
  283.     2) Coordinates (x,y)
  284.     3) Fixed value (current)
  285.     4) Fixed value (initial)
  286.  
  287. -------------------------------------------------------------------------------
  288.  
  289. If you have any questions feel free to ask in rec.arts.anime or 
  290. send E-mail to yuki@is.s.u-tokyo.ac.jp.
  291.  
  292.