home *** CD-ROM | disk | FTP | other *** search
/ Quake 'em / QUAKEEM.BIN / quake / programs / qpu11 / qpu.doc next >
Encoding:
Text File  |  1996-08-23  |  7.8 KB  |  226 lines
  1.            
  2.                           //==\\ /|==|\ /\  /\
  3.                           ││  ││ ││  ││ ││  ││  v1.1
  4.                           ││\\││ ││==|/ ││  ││  ────
  5.                           ││ \\│ ││     ││  ││  │ by Richard
  6.                           \\==\\─\/─────\\──//──│    Nichols
  7.                                  (c)1996
  8. QPU v1.1 Documentation
  9. ══════════════════════
  10.  
  11. Written by Richard Nichols. Intended for DOS viewing.
  12.  
  13. Contents
  14. ────────
  15.  
  16. [I]   - Copyright info.
  17. [II]  - License info.
  18. [III] - About Me.
  19.  
  20. [IV]  - What is QPU?
  21. [V]   - Features and requirements of QPU.
  22. [VI]  - Index of features
  23.           ■ Basic use
  24.           ■ F1 - Extract
  25.           ■ F2 - Extract all
  26.           ■ F3 - Remove
  27.           ■ F4 - Insert
  28.           ■ F5 - View/Play
  29.           ■ F6 - Pack Info
  30.           ■ F7 - Rebuild
  31.           ■ F8 - Rename
  32.  
  33. [VII]  - Hints/Tips/Tricks/Notes
  34. [VIII] - Planned for future versions
  35. [IX]   - Contact Info
  36.  
  37. I. Copyright Information.
  38. ─────────────────────────
  39.  
  40.   THIS PIECE OF SOFTWARE IS FREEWARE YOU MUST DISTRIBUTE IT FREE OF CHARGE.
  41.   I AM NOT AFFILIATED WITH ID SOFTWARE IN ANY WAY, DO NOT MAIL OR ANNOY
  42.   ID ABOUT THIS PROGRAM. CONSEQUENTLY THIS IS AN UNOFFICIAL QUAKE ADDON.
  43.   QUAKE IS THE PROPERTY OF ID SOFTWARE DO NOT INFRINGE THEIR COPYRIGHT.
  44.  
  45.   I TAKE NO RESPONSIBLITY WHATSOEVER FOR THE ACTIONS OF THIS PROGRAM IN
  46.   RELATION TO YOUR COMPUTER SOFTWARE OR HARDWARE OR YOU. IF THIS PROGRAM
  47.   CAUSES DETRIMENT IN ANY WAY THE RESPONSIBITY IS NOT MINE.
  48.  
  49.   BY USING THE PROGRAM (QPU) YOU AGREE TO THE ABOVE TERMS AND CONDITIONS.
  50.  
  51.  
  52. II. License Information.
  53. ────────────────────────
  54.  
  55.   You are permitted to use this piece of software free of charge under the
  56.   provision that you send me mail of some sort and tell me what you think
  57.   of this program and any possible improvements. Contact Info is at the end
  58.   of this document.
  59.  
  60.   You may distribute this program so long as you do so FREE OF CHARGE! If
  61.   you are a magazine cover CD/disk collator then mail me before including
  62.   this please. If you are selling this for a profit you do so totally
  63.   illegally and without consent.
  64.  
  65.  ( The above restrictions are waved concerning Walnut Creek CDROM )
  66.  
  67. III. About me.
  68. ──────────────
  69.  
  70.   Well I'm 16, in grade 11 and live Australia. In my spare time I play
  71.   games, do homework and a large amount of programming. I'm an avid DOOM
  72.   fanatic and I embrace QUAKE with gayous abandon!
  73.  
  74.   I like music also and my favourite bands are Rage Against the Machine,
  75.   Insurge, Metallica and Red Hot Chilli Peppers. My favourite song at the
  76.   moment is Metallica's "Until it Sleeps".
  77.  
  78.   I want to go to uni study comp sci and become a professional programmer
  79.   for a major software house. You can help by sending me a mail telling me
  80.   how great this software is!
  81.  
  82.  
  83. IV. What is QPU?
  84. ────────────────
  85.  
  86.    QPU is a utility for viewing and editing the pack file format which
  87.    id Software's great game QUAKE uses. With it you can rip out files,
  88.    insert your own or just browse what's there.
  89.  
  90.  
  91. V. Features and requirements of QPU.
  92. ────────────────────────────────────
  93.  
  94. QPU requires:
  95.  
  96.   ■ 286 or better
  97.   ■ 640k of base RAM (350k Free)
  98.   ■ VGA display
  99.   ■ A Sound Blaster is required for Sound.
  100.  
  101.   ■ A pack to edit is also helpful =)
  102.  
  103. QPU can:
  104.  
  105.   ■ Play sounds & view graphics from the pack
  106.   ■ Insert and remove files from the pack
  107.   ■ Rename a file in the pack
  108.   ■ Extract one or all of the files from the pack w/ or w/o paths.
  109.   ■ Rebuild the whole pack and optimise
  110.   ■ Give detailed pack info
  111.  
  112. VI. Index of features.
  113. ──────────────────────
  114.   ■ Basic use
  115.  
  116.     - The index window can be controlled with the up and down arrow keys.
  117.       Page up and page down go up and down a page. Home goes to the top
  118.       of the file, and end goes to the bottom.
  119.       LEFT and RIGHT move the hotspot (red line) up and down. This indicates
  120.       the currently selected entry in the pack. ESC quits. F1-F7 selects
  121.       actions (see below).
  122.  
  123.   ■ F1-Extract
  124.  
  125.     - This is pretty simple. Just press F1 to have the currently high-
  126.       lighted file extracted to the current directory with the name of
  127.       the file in the make. It does not keep directory tree structure.
  128.  
  129.   ■ F2-Extract All
  130.  
  131.     - This is the function performed by most other pack programs. Use this
  132.       to extract ALL the files from the pack. You have the option of keep-
  133.       ing the directory tree from the pack or just dumping the whole lot
  134.       to the current path. The tree is created off of the current path.
  135.       This can take about 10-15 minutes on slower HDs.
  136.  
  137.   ■ F3-Remove
  138.  
  139.     - This deletes the currently selected file from the pack. It does not
  140.       come back so choose wisely. This does not free the space taken by the
  141.       file. You must rebuild to free it (see notes).
  142.  
  143.   ■ F4-Insert
  144.  
  145.     - Inserts a file of your choosing into the pack as the last entry. This
  146.       will ONLY work if the pack's directory is at the end of the file. If
  147.       your's isn't then choose REBUILD from the main menu.
  148.  
  149.   ■ F5-View/Play
  150.  
  151.     - Plays or views the currently highlighted file. Applicable files are:
  152.  
  153.         * WAV sounds. Autodetection of Sound Blaster occurs at start.
  154.         * LMP graphics. On VGA displays =)
  155.         * BIN text images. (endscreen)
  156.  
  157.       More types will be added in later versions.
  158.  
  159.   ■ F6-Info
  160.  
  161.     - This just gives a listing of all the pack stats. Pretty self-
  162.       explanitory.
  163.  
  164.   ■ F7-Rebuild
  165.  
  166.     - This will rebuild the ENTIRE pack file to another name. This removes
  167.       any loose space along the way and will structure the pack such that
  168.       the directory is at the end. This can take about 10 minutes on some
  169.       machines.
  170.  
  171.   ■ F8-Rename
  172.  
  173.     - This will rename the highlighted file to your choosing. This will
  174.       be written to the pack IMMEDIATELY so don't screw up k?
  175.  
  176. VII. Hints/Tips/Tricks/Notes.
  177. ─────────────────────────────
  178.  
  179. 1. QPU is a very disk dependant piece of software.
  180.    Rebuild and extract all particularly give your HD a fair whacking so
  181.    it is best to load SMARTDRV before doing something big. I benchmarked
  182.    SMARTDRV to give about a 500% increase in performance on a few
  183.    different machines. Use it!
  184.  
  185. 2. Some of the features are very powerful. If you have a already modified
  186.    pack file then it would be a good idea to MAKE A BACKUP. Remember its
  187.    not my fault or responsibilty if QPU screws up you pak or machine.
  188.  
  189. 3. The remove function does NOT delete the space taken by the file removed.
  190.    So if you delete 5 .bsp files then you'll still have about 7 meg of
  191.    spare space in the pack file. To recover the space you have to REBUILD
  192.    the pack. To find out exactly how much space can be freed press F6.
  193.  
  194. 4. If things go all screwy on your monitor then its because you are either
  195.    running under windows or more likely you have a weird video card. This
  196.    is because QPU uses direct screen writes and also modifies the DOS text
  197.    font. To get over this you must mail me and I'll compile you a version
  198.    without these features.
  199.  
  200. VIII. Planned for future versions.
  201. ──────────────────────────────────
  202.  
  203.   The point is this: Is a pack editor particularly useful? You may only
  204.   need it once and it will only really be useful for people developing
  205.   editors etc. Therefore development of QPU has ceased. I may make a
  206.   Quake 3D editor, but then again I may not. We will see. Just lately I
  207.   have been REALLY busy so I really wouldn't have a clue.
  208.  
  209. IX. Contact Info.
  210. ─────────────────
  211.  
  212. Report bugs, thank me (register) from these places.
  213.  
  214. You can contact me in a variety of ways:
  215.  
  216.    E-Mail: tiberius@mailhost.net
  217.    WWW   : www.bip.concept.se/user/rich/index.htm
  218.    Phone : +61-(0)79-286832
  219.  
  220.    Snail : 354 Philp Ave 
  221.    mail  : Nth Rockhampton
  222.          : Q 4701
  223.          : AUSTRALIA
  224.  
  225.  
  226.