home *** CD-ROM | disk | FTP | other *** search
/ The Datafile PD-CD 3 / PDCD_3.iso / utilities / utilss / sprtools / readme
Text File  |  1995-03-10  |  9KB  |  205 lines
  1. SPRtools
  2. ========
  3.  
  4. SPRtools block 1c release (10-Mar-1995).
  5. (C) 1989-1995 DEEJ Technology PLC
  6.  
  7. Contents
  8. --------
  9. SPRtools provides bitmap format conversion and image processing utilities,
  10. designed to run on RISC OS and UNIX platforms.
  11.  
  12. This release contains the following tools:-
  13.  
  14. bmp2spr  : Version 3.00 (02-Feb-1995) : Windows 3 / OS2 BMP to sprite
  15. bmp_info : Version 3.00 (02-Feb-1995) : Windows 3 / OS2 BMP file information
  16. chmode   : Version 1.50 (21-Jun-1993) : Sprite change mode
  17. clr2spr  : Version 2.10 (15-Jul-1994) : !Translator Clear format to Sprite
  18. clr_info : Version 2.01 (25-Aug-1993) : !Translator Clear file information
  19. ras2spr  : Version 2.50 (17-Jun-1994) : Sun raster format to Sprite
  20. ras_info : Version 2.00 (16-Nov-1993) : Sun raster file information
  21. sb2spr   : Version 2.00 (24-Jun-1993) : HP Starbase format to Sprite
  22. sb_info  : Version 2.00 (23-Aug-1993) : HP Starbase file information
  23. spr2bmp  : Version 3.00 (02-Feb-1995) : Sprite to Windows 3 BMP
  24. spr2clr  : Version 2.00 (27-Aug-1993) : Sprite to !Translator Clear format
  25. spr2ras  : Version 2.00 (18-Nov-1993) : Sprite to Sun raster format
  26. spr2sb   : Version 5.00 (23-Aug-1993) : Sprite to HP Starbase format
  27. spr2tga  : Version 2.00 (22-Aug-1993) : Sprite to Targa TGA format
  28. spr2xbm  : Version 5.01 (25-Nov-1993) : Sprite to X Windows bitmap/pixmap
  29. spr2xwd  : Version 1.50 (23-Aug-1993) : Sprite to X Windows Display format
  30. spr3spr  : Version 1.10 (15-Jul-1994) : Sprite separation utility
  31. spr_diff : Version 1.00 (20-Oct-1993) : Sprite differencing utility
  32. spr_fsi  : Version 1.10 (20-Apr-1994) : Sprite image processing tool
  33. spr_info : Version 4.02 (13-Jan-1994) : Sprite information and statistics
  34. spr_pal  : Version 2.12 (20-Aug-1993) : Sprite palette image creator
  35. tga2spr  : Version 2.00 (23-Aug-1993) : Targa TGA format to Sprite
  36. tga_info : Version 2.50 (22-Aug-1993) : Targa TGA file information
  37. xwd2spr  : Version 1.60 (18-Nov-1993) : X Windows Display format to Sprite
  38. xwd_info : Version 1.50 (23-Aug-1993) : X Windows Display file information
  39.  
  40.  
  41. License
  42. -------
  43. SPRtools are and remain the copyright of DEEJ Technology PLC.
  44.  
  45. The unmodified distribution package may be freely copied by users and
  46. distributed by organisations as long it remains free of charge (except for the
  47. minimum of distribution media costs), and is not bundled with any commercial
  48. product, either software or in the form of a disc based magazine. It may be
  49. placed on builtin boards or archive servers without restriction.
  50.  
  51. Only the original distrubtion packages can be passed on, copying of parts
  52. of the package other than described in the installation is not permmited.
  53. The code may be modified by the user, but must not be passed on, all
  54. changes should be notified to the address at the end of this document.
  55. No code may be used in commercial products with out prior and express
  56. permission of DEEJ Technology PLC.
  57.  
  58. SPRtools is not supplied with WARRANTY of any kind either expressed or implied.
  59. The author is under no obligation to provide support, corrections or
  60. enhancements, any supplied are purely on a good will basis.
  61.  
  62.  
  63. Distribution
  64. ------------
  65. SPRtools is distributed in to forms; a spark archive for RISC OS, and a
  66. compressed tar file for UNIX. Both forms contain the same files with
  67. differing filenames to conform to RISC OS and UNIX conventions. Scripts
  68. are provided to convert between RISC OS and UNIX filenames.
  69.  
  70. Directories contained in the Release
  71.  
  72.     bin    - contains executables when built
  73.     docs    - documentation on SPRtools
  74.     riscos    - RISC OS specific files, makefile, plus directories
  75.             basic     - BASIC files for creating 24 bit sprites
  76.             comndcfg - configuration files for !ComndCTRL
  77.             obey     - scripts for RISC OS / UNIX transferring
  78.     unix    - UNIX specific file, including makefiles
  79.     sprites - test sprite files
  80.     source    - contains source files - Tar release only
  81.     c,h,o   - contains source files - Archive release only
  82.  
  83.  
  84. Installation
  85. ------------
  86. Spark archive on RISC OS
  87.         Create a directory called SPRtools in the desired location
  88.         on your harddisc. Using !Spark, !SparkFS, !ArcFS (or other
  89.         popular archive handling tools) to copy the contents of
  90.         the archive to the SPRtools directory.
  91.  
  92. Spark archive on UNIX
  93.         First install the archive on a RISC OS machine as described
  94.         above. Copy the script SPRtools.riscos.obey.tounix to the
  95.         SPRtools directory. Place an empty  DOS formatted disc (720K
  96.         should be sufficient for this release, but 1.44M may be
  97.         necessary) in drive 0, and double click on the tounix script.
  98.         Files will be copied on to the DOS disc, from where they can
  99.         be copied to a UNIX system, either directly or via a NFS PC.
  100.  
  101. Tar file on UNIX
  102.         Create a directory called sprtools in the desired location.
  103.         Extract the contents of the tar file into this directory
  104.         (using 'tar xvf sprtools.tar' after uudecoding and uncomp-
  105.         ressing).
  106.  
  107. Tar file on RISC OS
  108.         If you have access to !SparkFS (or another RISC OS program
  109.         that can handle tar files), make a directory called SPRtools
  110.         and copy the tar file in to it (the tar file can be in any
  111.         compressed or uuencoded form), the tarfile must be called
  112.         'sprtools/t' (case is important). Extract just the file
  113.         sprtools/t.riscos.obey.fromtar to the SPRtools directory
  114.         and set its file type to TaskObey. Running this script will
  115.         extract and install the files, and set the file types.
  116.  
  117.         If you do not have !SparkFS, first install on UNIX as
  118.         described above. The sprtools directory can then be copied
  119.         to DOS disc (720K should be sufficient for this release, but
  120.         1.44M may be necessary), either directly or via a NFS PC.
  121.         On a RISC OS machine, place the DOS disc in drive zero and
  122.         create a directory called SPRtools. Copy just the file
  123.         sprtools.riscos.obey.fromunix into this directory, set its
  124.         file type to TaskObey and double click to install the files.
  125.  
  126. Building
  127. --------
  128. RISC OS        Copy the file SPRtools.riscos.makefile to the SPRtools
  129.         directory. Ensure that C$path is set up so the Clib is
  130.         accessible to the compiler. Build SPRtools using AMU
  131.         (or Make) using DDE or from the command line.
  132.  
  133. UNIX        First read the readme file in sprtools/unix, choose the
  134.         most appropriate make file for your system and copy
  135.         it to sprtools/source/makefile. Change to the sprtools/source
  136.         directory and type 'make'.
  137.  
  138. Running
  139. -------
  140. RISC OS        Place the SPRtools.bin directory on your Run$Path. This
  141.         should be done by placing a line in your desktop boot file.
  142.         e.g. Set Run$Path %,[...].,adfs::HardDisc.SPRtools.bin.
  143.         where [...] are a list of comma separated directories (ending
  144.         in '.') that you also want on the run path.
  145.  
  146.         SPRtools may then be run form the command line, or a task
  147.         window. A full RISC OS interface to the tools is provided
  148.         in conjunction with !ComndCTRL, this enables input and
  149.         files to be selected by dragging, options set using menus,
  150.                 and the correct filetype allocated to image files produced.
  151.         See SPRtools/riscos/comndcfg/readme for more details.
  152.  
  153.         When dealing with very big sprites a large amount of memory
  154.         will be required, all SPRtools can be run under VIRTUAL.
  155.         VIRTUAL is available from many PD sources and enables
  156.         limited virtual memory support in taskwindows.
  157.  
  158. UNIX        Place the sprtools/bin directory on your $PATH. For csh
  159.         add the following to your .cshrc after any other 'set $paths's.
  160.         e.g. set path=($path $HOME/sprtools/bin)
  161.  
  162.         Under csh type 'rehash', you will then be able to access
  163.         SPRtools from any directory. Under UNIX shells several
  164.         operations may be chained together using pipes.
  165.  
  166.         e.g. to display Windows BMP on X windows
  167.              bmp2spr windows.bmp | spr2xwd | xwud
  168.  
  169.         e.g. to convert a sprite to a X window backdrop
  170.              spr_fsi -bpp 1 -scale 1280,1024 -in sprite | spr2xbm >bits
  171.              xsetroot -fg white -bg black -bitmap bits
  172.  
  173. General        Full documentation is provided in the Docs directory.
  174.  
  175.  
  176. Information
  177. -----------
  178. SPRtools is continually being developed and improved. Please report any
  179. problems or suggestions for improvements / new features to the address
  180. below.
  181.  
  182. It is hoped that RISC OS and X windows front end applications built around
  183. SPRtools will be available sometime in 1995.
  184.  
  185. If SPRtools is required to be converted to any platf