Qu-ake/Qu-ake.iso/qu_ke/utils/bsptools/011/QPU.DOC

Text File | 1996-10-25 | 14.5 KB | 397 lines

               ╔════════════════════════════════════════════════╗
               ║     ┌──────────╖ ┌──────────╖ ┌────╖ ┌────╖    ║
               ║     │  ╔════╕  ║ ╘╕  ╔═══╕  ║ ╘╕  ╔╝ ╘╕  ╔╝    ║
               ║     │  ║    │  ║  │  ║   │  ║  │  ║   │  ║     ║
               ║     │  ║    │  ║  │  ╙───┘  ║  │  ║   │  ║     ║
               ║     │  ║    │  ║  │  ╔══════╝  │  ║   │  ║     ║
               ║     │  ║ ┌─╖│  ║  │  ║ version │  ║   │  ║     ║
               ║     │  ╙─┘ ╙┘  ║ ┌┘  ╙╖  1.4b  │  ╙───┘  ║     ║
               ║     ╘═════╕ ╔══╝ ╘════╝        ╘═════════╝     ║
               ║           ╘═╝  (c)1996 Richard Nichols         ║
               ║                                                ║
               ╚════════════════════════════════════════════════╝

                              QPU v1.4b Documentation
                              ═══════════════════════

               Written by Richard Nichols. Intended for DOS viewing.
               QPU was written on a budget of $16.95 (not including
               coke, pizza and compilers). It is about 2500 lines in
               length. It took about 100 hours of my spare time.

New Stuff in 1.4b
─────────────────
 ■ Non registerable bug fix

New Stuff in 1.4
────────────────
  ■ Create your own pack files
  ■ Utility PCX2LMP for importing PCX files to pack
  ■ Extract PCX file from LMP resource
  ■ New and improved title graphics
  ■ Interface with < 10 entries now works
  ■ Insert file size now fixed
  ■ Menu now a lot better and easier to use
  ■ Help Screen
  ■ Setup options:
     ∙ Turn off the title graphics
     ∙ Over-ride soundblaster detection
  ■ Now only takes 900 entries for memory reasons
  ■ Fixed remove file bug
  ■ Updated Documentation
  ■ Mostly rewritten documentation
  ■ Added bug report sheet
  ■ Tidied up the code and other things
    you don't want to know about =)

Known bugs
──────────
  ∙ Removing lots of files can cause it to crash (?)
  ∙ Some WAVS in regg'ed Quake (and 2 in SW) are signed I think
    I'll fix this as soon as poss.

Contents
────────

[I]   - Legalities
[II]  - License info
[III] - About me

[IV]  - What is QPU?
[V]   - Features and requirements of QPU.
[VI]  - Index of features
          ■ Basic use
          ■ F1  - Extract
          ■ F2  - Extract all
          ■ F3  - Remove
          ■ F4  - Insert
          ■ F5  - View/Play
          ■ F6  - Pack Info
          ■ F7  - Rebuild
          ■ F8  - Rename
          ■ F9  - Setup
          ■ F10 - Help
          ■ How to make a new pack file
          ■ PCX2LMP - Details of use

[VII]  - Hints/Tips/Tricks/Notes
[VIII] - Planned for future versions
[IX]   - Contact Info
[X]    - Bug reporting

I. Legalities
─────────────

There are some basic things that you should be aware of when using this
program:

  ■ QPU is (c)1996 Richard Nichols. QPU is FREEWARE, ie. it can be
    distributed free of charge so long as all files from the orignal
    distribution are included. You may NOT distribute REGISTERED versions
    of QPU (even if it doesn't cost anything to register). Only Walnut
    Creek CDROM is permitted to distribute this program on CD's or bundled
    with other programs. For permission you must contact me.

  ■ I am in no way responsible for any damage that occurs to your
    software or hardware as a result of using QPU. It shouldn't do
    anything detrimental but if it does then its not my problem okay?

  ■ Quake is (c)1995-6 id Software. QPU is NOT an official id Software
    release but instead a 3rd Party addition. For help or questions
    contact me and not id Software.

  ■ It is _specifically_ prohibited that you do not sell QPU for a profit
    (unless you are Walnut Creek CDROM). Violators of this rule will face
    legal consequences.

II. License Information.
────────────────────────

  QPU in its default state is FREEWARE. You may distribute it to whom
  ever you like so long as you give them all the files that you were
  given.
  Registering QPU entails sending me an e-mail (or snail mail) and telling
  me what you think of QPU and any possible improvements. In return I will
  send you the registration code to decrypt the registered version. In
  registering you will achieve a number of things:

    ■ Get a full program for nothing
    ■ No more end delay
    ■ You'll encourage me to keep programming stuff like this
    ■ A warm fuzzy feeling

  If and when you register, please, please, please do NOT distribute the
  registered version OR the code to register the program.

III. About me.
──────────────

  Well I'm 16, in grade 11 and live Australia. In my spare time I play
  games, do homework and a large amount of programming. I'm an avid DOOM
  fanatic and I embrace QUAKE with gayous abandon!

  I like music also and my favourite bands are Rage Against the Machine,
  Insurge, Metallica and Red Hot Chilli Peppers. My favourite song at the
  moment is Metallica's "Until it Sleeps".

  I want to go to uni study comp sci and become a professional programmer
  for a major software house. You can help by sending me a mail telling me
  how great this software is!

  I would also like to thank those people who have taken an interest in
  QPU and have not only registered but have contributed their ideas and
  critics to me.

  I have also learnt a HELL of a lot about programming, managing a big
  project like this and also how to get people motivated into taking
  part. Incidently I am in a new demo group called SoLaCe now so remember
  to check out the stuff we make =).


IV. What is QPU?
────────────────

   QPU is a utility for viewing and editing the pack file format which
   id Software's great game QUAKE uses. It is the most dynamic and featured
   pack editor out there. It easily mows down the opposition allowing you
   to do things that were never before possible (steady on =).

V. Features and requirements of QPU.
────────────────────────────────────

QPU requires:

  ■ 386 or better
  ■ 640k of base RAM (350k Free)
  ■ VGA display
  ■ A Sound Blaster is required for sound
    but not necessary to run the program

  ■ An id Software pack file

QPU can:

  ■ Extract singular files from the pack
  ■ Extract the whole pack to a directory or directory structure
  ■ Remove (delete) entries from the pack
  ■ Insert your own files into the pack
  ■ View/Play sounds and graphics in the pack
  ■ Give detailed pack information
  ■ Rebuild the pack file freeing up any wasted space
  ■ Rename (move) files around in the pack
  ■ Can import/export PCX files as LMP graphics
  ■ Can create entirely new pack files

VI. Index of features.
──────────────────────
  ■ Basic use

    - The index window can be controlled with the up and down arrow keys.
      Page up and page down go up and down a page. Home goes to the top
      of the file, and end goes to the bottom.
      LEFT and RIGHT move the hotspot (red line) up and down. This indicates
      the currently selected entry in the pack. ESC quits. F1-F10 selects
      actions (see below).

  ■ F1-Extract

    - This is pretty simple. Just press F1 to have the currently high-
      lighted file extracted to the current directory with the name of
      the file in the make. It does not keep directory tree structure.

      Extracting an LMP file from the pack will give you the option of
      extracting it to a PCX file instead. The PCX file extraction is
      EXTREMELY lossy, ie. it doesn't attempt to compress the file. It
      can be loaded in an editor so it doesn't make much difference and
      it saves me a lot of programming =).

  ■ F2-Extract All

    - This is the function performed by most other pack programs. Use this
      to extract ALL the files from the pack. You have the option of keep-
      ing the directory tree from the pack or just dumping the whole lot
      to the current path. The tree is created off of the current path.
      This can take about 10-15 minutes on slower HDs.

  ■ F3-Remove

    - This deletes the currently selected file from the pack. It does not
      come back so choose wisely. This does not free the space taken by the
      file. You must rebuild to free it (see notes).

  ■ F4-Insert

    - Inserts a file of your choosing into the pack as the last entry. This
      will ONLY work if the pack's directory is at the end of the file. If
      your's isn't then choose REBUILD from the main menu.

  ■ F5-View/Play

    - Plays or views the currently highlighted file. Applicable files are:

        ∙ WAV sounds. Autodetection of Sound Blaster occurs at start.
        ∙ LMP graphics. On VGA displays =)
        ∙ BIN text images. (endscreen)

      More types will be added in later versions.

  ■ F6-Info

    - This just gives a listing of all the pack stats. Pretty self
      explanitory.

  ■ F7-Rebuild

    - This will rebuild the ENTIRE pack file to another name. This removes
      any loose space along the way and will structure the pack such that
      the directory is at the end. This can take about 10 minutes on some
      machines.

  ■ F8-Rename

    - This will rename the highlighted file to your choosing. This will
      be written to the pack IMMEDIATELY so don't screw up k?

  ■ F9-Setup

    - This enters the setup utility where you can customize a few things.

      ∙ Display Logo at start?
          - Yes displays the fire effect
          - No jumps you straight to the editor

      ∙ Override Sound Blaster Detection?
          - Yes allows you to force QPU to use a specific SB
          - No just keeps the Auto-Detection

  ■ F10-Help

    - This gives a key list of all commands etc.

  ■ How to make a new pack file

    - This is pretty simple. Let's say that you want to make a file called
      'CARNAGE.PAK'. All you have to do is type 'QPU CARNAGE.PAK' and then
      answer yes when prompted if you want to create the file. You can then
      edit the new pack file to you heart's content!

  ■ PCX2LMP - Details

    - The bundled file PCX2LMP will allow you to insert PCX files into the
      pack in a format Quake can handle. The program is external to QPU.
      You can find it in the same directory as QPU. The syntax is:

          PCX2LMP MYPIC.PCX MYPIC.LMP

      Where you replace mypic with whatever you are converting. The program
      should NOT be distributed without the rest of QPU, ie. don't go
      ripping it out of this package for other uses. You are permitted to
      use it for your own use only. Sorry about the speed too, This is a
      modified version of my PCX2RAW utility, I don't bother optimizing
      stuff I use myself too much =).

      To use the pics you have converted go into qpu and hit F4 for insert
      and type the name of the file you converted.

VII. Hints/Tips/Tricks/Notes.
─────────────────────────────

1. QPU is a very disk dependant piece of software.
   Rebuild and extract all particularly give your HD a fair whacking so
   it is best to load SMARTDRV before doing something big. I benchmarked
   SMARTDRV to give about a 500% increase in performance on a few
   different machines. Use it!

2. Some of the features are very powerful. If you have already modified your
   pack file then it would be a good idea to MAKE A BACKUP. Remember its
   not my responsibilty if QPU screws up you pak or machine.

3. The remove function does NOT delete the space taken by the file removed.
   So if you delete 5 .bsp files then you'll still have about 7 meg of
   spare space in the pack file. To recover the space you have to REBUILD
   the pack. To find out exactly how much space can be freed press F6.

4. If things go all screwy on your monitor then its because you are either
   running under Windows or more likely you have a weird video card. This
   is because QPU uses direct screen writes and also modifies the DOS text
   font. To get over this you must mail me and I'll compile you a version
   without these features.

5. If you find that your Sound Card doesn't get Autodetect at the start
   (this is known to happen on some SB Pros) then go into QPU and hit
   F9 for setup. Answer yes to override Sound Blaster detect and then
   enter the middle digit of your SB's base port. From now own the
   detection will be overruled by your selection.

VIII. Planned for future versions.
──────────────────────────────────

  I don't know. Any modifications from now on are strictly requests. Things
  that have been suggested so far (but I'm too lazy to code) are:

     ■ Order all the entries in their directories when rebuilding
     ■ File tagging

    *■ Build a pack file from a directory struction (anti-extract all)

  If you like the sound of any of those then mail me and I might
  consider it k?

 * This is a difficult function to program; to the people that suggested
   it I point out that the id Software utility source code (qutils.tar.gz)
   has a program that can do this, as does Quake C. I suggest you use that.

IX. Contact Info.
─────────────────

Report bugs, thank me (register) from these places.

You can contact me in a variety of ways:

   E-Mail: mailto:[e-mail]
   WWW   : http://www.bip.concept.se/user/rich/index.htm
   Phone : [phone]

   Snail : 354 Philp Ave
   mail  : Nth Rockhampton
         : Q 4701
         : AUSTRALIA

X. Bug reporting
────────────────

If you have a specific bug to report, you could make my life easier
and use this report sheet =)
----------------CUT--HERE-----------------------------

QPU 1.4 BUG REPORT SHEET

Name: ________________________________________________
Email: _______________________________________________

Computer type: _______________________________________
Operating System: ____________________________________

Version of Quake: ____________________________________

Description of bug:

______________________________________________________
______________________________________________________
______________________________________________________
______________________________________________________
______________________________________________________

Do want me to send you the registration code?
(Y/N): ______________________________________

Thanks

-Richard Nichols

--------------------------------------------
QPU and PCX2LMP are (c)1996 Richard Nichols
Quake, PAK and LMP are (c)1995-6 id Software
Any names I may have mentioned are trademarks
of their respective owners