= QENTITY = v1.10   Modify ENTITY lump in a QUAKE or QUAKE II BSP
(425) 827-8794  Copyright 1998 Sensor Based Systems, Inc (www.sbsoftware.com)

===========================================================================

A quick and easy way to identify the type of QUAKE level and modify
the ENTITIES lump of a QUAKE/QUAKE II BSP without having to recompile the level.

See QCHAIN for automatically connecting QUAKE/QUAKE II levels together.

By identifying all BSPs in a directory as a Quake or Quake II BSP and listing
the player starts (single player or deathmatch), it's easy to organize
downloaded levels.  For example, place levels into a directory within the Quake
root, called \SINGLE\MAPS and \DEATH\MAPS. Use the -game option to play only
single or deathmatch levels.

The ENTITIES lump contains the "things" in the BSP, models and the next level
name when the level "exits" or ends.

QENTITY makes it a snap to :

1. Identify the type of level (QUAKE or QUAKE 2)
2. Identify the level as single/coop or deathmatch
3. Change the enemies or weapons in a level to suit your taste.
   (Refer to a QUAKE editor config file for a list of names.)
4. Change the level exit names so exiting the level automatically goes
   to another level of your choice.
5. Make any other minor ENTITY changes to a level instantly.

===========================================================================

Installation
------------

Install QENTITY.EXE and CW3220MT.DLL in any directory.

Syntax
------

      QENTITY quakelevel <option>

      quakelevel = The name of the level to modify.
                   You can use any wildcard, etc in the name, so for example,
                   the name *.bsp will process ALL BSP file names.
                   (default directory is current directory, .bsp optl).

      Options: (only one option may be selected at a time)

       -export   = Takes the ENTITIES lump in the BSP and creates a file
       (or -e)     named quakelevel.ent, where "quakelevel" is the name of
                   your level. The extension is always ".ent".

       -import   = Reads a file named quakelevel.ent which replaces the
       (or -i)     contents of the current ENTITIES lump in the BSP.

       -statall  = List "map" and "info_player_" to see exit names and
       (or -sa)    if single or multi player level.

       -statid   = Identify as Quake or Quake II level only
       (or -si)

Examples
--------

       QENTITY c:\QUAKE\ID1\MAPS\*    Identifies all the .BSP files as Q1 or Q2.

       QENTITY c:\SOMEDIR\DX* -sa     Lists Exit + player info for all the DX*.BSP files

       QENTITY c:\SOMEWHERE\KILLER -e Creates KILLER.ENT file.

       QENTITY c:\SOMEWHERE\KILLER -i Imports KILLER.ENT file (with your changes).

Note : To put the information into a file enter >YOURLOG.TXT after the command.
       For example QENTITY * -sa >QSTATS.TXT  writes all output to QSTATS.TXT.


How to modify exits, player starts, enemies, etc.
-------------------------------------------------

Make a copy of the original level for backup so you can play around and
not worry about any goofs you may make.

1. -export the ENTITIES lump from your BSP level
2. Use the DOS Edit, Windows NotePad or any other TXT editor to modify the
   file created in step 1.
3. For exit level name changes, search for the string "map" (including the
   quotes).  The name following this is the name of the next map to play
   upon exit. Type in your new BSP level name (in quotes).
4. Save your changes.
5. -import this modified lump.

Other modifications you can make
--------------------------------

Look at the configuration file of some of the Quake editors.  They have a list
of enemies, weapons, etc.  You can also just examine the ENTITIES lump you
exported with QENTITY.  Change the name(s) of the enemies or weapons and
presto, you are there.

You can also add more info_player starts, enemies and weapons.  Just play
around and duplicate the coordinates of other objects to get an idea of where
they end up.


History
-------

 8-20-98 Created from a subset of other utilities for QUAKE in response to
         a question of how to combine levels so that exiting one level
         will automatically go to another level of your choice.

 8-28-98 Add option to list "map" exit names and "info_player_" contents and
         process all the BSPs in a directory at one time.

Comments, ideas and suggestions welcome.
Send to:

jack@sbsoftware.com, subject: QENTITY

Enjoy,

Jack Vermeulen

===========================================================================

* Copyright / Permissions *

You MAY distribute this program, provided you include this file, with
no modifications.  You may distribute this file in any electronic
format (BBS, Diskette, CD, etc) as long as you include this file 
intact.

