home *** CD-ROM | disk | FTP | other *** search
/ DP Tool Club 31 / CDASC_31_1996_juillet_aout.iso / vrac / multikit.zip / TOOLS.DOC < prev    next >
Text File  |  1996-03-01  |  8KB  |  168 lines
  1.  
  2.  Documentation ─────────────────────────────────────────────────────────────┐
  3.  │                               Tool Programs                              │
  4.  └───────────────────────────────────────────────────────────── MULTIKIT v1.0
  5.  
  6.  
  7.  
  8.  1. ARCHIVER
  9.  ───────────
  10.  
  11.  This program archives your files. It puts them together into one big file
  12.  and returns a PASCAL script file containing the start of each single file
  13.  in the archive. You can include this file into your program and  use  the
  14.  defined constants together with the SEEK function. And each loading  pro-
  15.  cedure of the MULTIKIT supports a seek parameter. Why this you might ask.
  16.  Well that has something to do with the art of coding:  a program  consis-
  17.  ting  of  hundreds and hundreds of files looks very poor and is hardly to
  18.  handle by the user. The possibility  of errors in the directory structure
  19.  increases rapidly, you must wait minutes when deleting so much files, ...
  20.  At least the number of files per directory is limited. Use  the  ARCHIVER
  21.  to solute this problems.
  22.  
  23.  
  24.  Functions:     Cursor Keys - Move the selector bar
  25.                         INS - Mark/Unmark a single file
  26.                          +  - Mark all files
  27.                          -  - Unmark all files
  28.                       ENTER - change to selected directory
  29.                         TAB - change between file display and options
  30.                 Copy option - Copies the marked files into an archive
  31.                               and returns a script file
  32.                 Move option - Like the copy options but deletes the
  33.                               source files
  34.                        Quit - Change back to default directory and quit
  35.  
  36.  Limitations:   Read-only files are not supported
  37.                 Drive can not be changed
  38.                 Very less error checking
  39.  
  40.  Suggestions:   Don't use an archive name with the extension 'PAS' because
  41.                  the script file uses this extension: <archive name>.PAS
  42.                 Assure that no error may occur during the  archiving  pro-
  43.                  cess like less disk space, bad sector error  or  anything
  44.                  else. The archiving would be terminated at once.
  45.  
  46.  
  47.  
  48.  
  49.  2. COMPRESS
  50.  ───────────
  51.  
  52.  MULTIKIT v1.0 supports only compressed data files. So all image and sound
  53.  data must be compressed by using the PKWare algorithm.  Use  COMPRESS  to
  54.  shrink modules and samples you want to use  in  context  with  SOUND.TPU.
  55.  Image data is automaticly compressed by XMDETOOL (s.b.), so don't try to
  56.  shrink these data by using COMPRESS.
  57.  
  58.  
  59.  Functions:     Command line parameter structure is
  60.                 < COMPRESS InFile OutFile >
  61.  
  62.                      InFile - file you want to compress
  63.                     OutFile - name of file containing the compressed data
  64.  
  65.  Limitations:   Less error checking
  66.  
  67.  Suggestions:   Of course InFile and OutFile shouldn't have the same name,
  68.                  the program won't check this.
  69.  
  70.  
  71.  
  72.  
  73.  3. FONTEDIT
  74.  ───────────
  75.  
  76.  You might have asked yourself how to create MULTIKIT compatible fonts for
  77.  XMODE.TPU which can be loaded via XLOADFNT and used within your  program.
  78.  Well thats what FONTEDIT is for. Creating and modifying fonts and  saving
  79.  them in MULTIKIT font file format in the easiest way.
  80.  
  81.  Functions:             New - Clear all data
  82.                        Load - Load the specified font file
  83.                        ROM8 - Load ROM 8x8 font
  84.                       ROM14 - Load ROM 8x14 font
  85.                        Save - Save the data refering to the specifications
  86.                               given in the Font/File Data Field.
  87.                        Quit - Quit the program immediately
  88.                    Alphabet - Select the letter to edit
  89.               Magnification - Set/Clear single pixels
  90.              Font/File Data - Setup file specifications
  91.                                FileName:   Is neccessary for load and save
  92.                                            functions. (If you load a file,
  93.                                            the other data will be ignored)
  94.                                Font/Mouse: If you select  MOUSE  then  the
  95.                                            current char will be saved as a
  96.                                            pascal file which you  can  in-
  97.                                            clude in your program  and  use
  98.                                            in connection with MOUSEDEFINE.
  99.                                First Char: ASCII-Code of the first charac-
  100.                                            ter in the font.
  101.                                Last Char:  ASCII-Code of the last char.
  102.                                Width:      Width of the chars. You can on-
  103.                                            ly enter 8  or  0  (zero  means
  104.                                            variable width).
  105.                                Height:     Height of a char (1 <= X <= 14)
  106.  
  107.  Limitations:   Supports only char heights up to 14
  108.                 Supports only char widths 0 (variable) and 8
  109.                 Less error checking (as usual)
  110.  
  111.  Suggestions:   If an error occurs during the load/save operations  you'll
  112.                  hear some noise. Else the operation has been  successful.
  113.                 Remember: Everything will be  executed  immediately.  That
  114.                  means you'll get no questions like "DO YOU  REALLY  WANNA
  115.                  DO THAT ?". Be careful to aviod data loss.
  116.  
  117.  
  118.  
  119.  
  120.  4. XMDETOOL
  121.  ───────────
  122.  
  123.  XMDETOOL converts images into XMODE.TPU compatible sprites.  You can load
  124.  GIF files of version 87a/89a in resolution 320x200x256 and  unpacked  BMP
  125.  images using the same resolution and save them  as  XMODE.TPU  compatible
  126.  sprites. The palette can also be saved.
  127.  
  128.  
  129.  Functions:      Mouse move - Mark sprite
  130.                    Load GIF - Loads a GIF file from the disk into memory
  131.                    Load BMP - Loads a BMP file
  132.                 Save Sprite - Saves a part of the loaded image to a file
  133.                 Save Screen - Saves the entire image
  134.                 Message Box - Used for message output (errors,information)
  135.                    Save Pal - Saves the color palette of the current image
  136.                        Quit - Quits the program immediately
  137.  
  138.  Limitations:   Supports only 320x200x256 GIF/BMP images
  139.                 Less error checking
  140.  
  141.  Suggestions:   Don't  try to load GIF/BMP files with any other resolution
  142.                  than 320x200x256 or your computer may hang.
  143.                 Install your VESA driver before executing the program, be-
  144.                  cause XMDETOOL needs a VESA compatible SVGA card
  145.                 Remember that XMODE.TPU does only  support  sprites  whose
  146.                  widths are multiple of four pixel. The program checks  it
  147.                  automaticly and displays the current coordinates  in  the
  148.                  message box when you are marking a sprite.
  149.  
  150.  
  151.  
  152.  
  153.  Disclaimer
  154.  ──────────
  155.  
  156.  All MULTIKIT tools are FREEWARE. They can be copied and used without  any
  157.  restrictions. EXCEPTION: YOU'RE NOT ALLOWED TO DO ANYTHING WITH THIS PRO-
  158.  GRAM IF THERE IS ANY COMMERCIAL BACKGROUND. This includes i.e. the follo-
  159.  wing: charging a fee for copying, creating shareware or commercial  soft-
  160.  ware using these tools
  161.  
  162.  Additional coders in alphabetical order:             Every source code or
  163.   PKWare Inc.        (Data compression)               library used here is
  164.   Tristian Tarrant   (GIF/BMP loading procedures)     FREEWARE.
  165.  
  166.  
  167.  (C) Copyright by TSC-Software, 1995-96.
  168.