Documentation & Manual

opt_entdata, 1.1 Release

Contents:

• Installation
• What's the point?
• Command-line parameters
  • -simplify
  • -setting
  • -ripent
  • -nolog
  • -verbose
  • -delbackup
  • -nolinemod
  • -nomiscents
  • -nolights
  • -nostrip
  • -noorigins
  • -texdata
  • -lightdata
  • -noinfo
  • -chart
• Customisable settings & property list files
• Property Extractor (new)
• Contact, discussion threads & help
• Credits

Installation

What's the point?

• Smaller BSP sizes
• More space for you to do things with entities
• You get bragging rights for using it

• you will spend about 5 minutes setting up opt_entdata
• maybe another 2 minutes a week checking for an update

Command-line parameters

• -simplify
  Simplify takes names of entities and replaces them with a (in theory) shorter one.
  It also makes debugging scripted events difficult so it is recommended only for release versions of a map.
  Worse, sometimes simplify may overwrite a name it shouldn't.
  Consider, for example, an entity named spawnflags or similar. Now let us assume simplify picks that up as a name and replaces it with a name of abc
  Messy eh?
  
  
• -settings
  ...where myfile.db is a customised version of the setting_default.db file.
  You only need specify this parameter if you don't want to use the setting_default.
  For further info on how this stuff works see customisable settings & property list files
  
  
• -ripent
  ...provided ripent is in the same directory as opt_entdata or you have set your settings file correctly.
  This enables automated execution of ripent(s) before and after opt_entdata.
  Output from ripent (here-on refered to as ripent, that's what it is called in ZHLTpXX) is not logged.
  The RIPENT line of your settings file may be uncommented and changed appropiately if ripent is not in the same directory as opt_entdata.
  
  
• -nolog
  In 0.6 and previous versions of opt_entdata logging had to be turned on.
  In this version logging is enabled by default.
  Note that, regardless of -nolog's presence, logging will be disabled if opt_entdata can't locate your map's .log file.
  
  
• -verbose
  As in previous versions and millions of programs around the planet the verbose option enables extra info while the program is running.
  If you are seeing weird problems verbose mode will show where some of them occur.
  When (if ever) asked for a logfile from opt_entdata (or screen output) then -verbose is a recommended option to use.
  
  
• -delbackup
  Usage of the -delbackup option will have opt_entdata attempt to delete the backup of a map's .ent data after running.
  Now this option will also delete .ent files left behind if -ripent is used.
  
  
• -nolinemod
  -nolinemod is an option for those having problems with other programs that may need access to a map's entdata.
  Users have reported, for example, that opt_entdata without -nolinemod will stop resgen from working.
  If you want to run opt_entdata on the same data more than once then use this option.
  
  
• -nomiscents
  -nomiscents is an option for those who want info_null, info_texxlights and info_compile_parameters left in their BSPs.
  If you seem to be getting errors around where the "Removing unrequired entities.." message appears then try disabling it here.
  
  
• -nolights
  -nolights does the same thing as -nomiscents: it disables the removal of lights and (most) optimisations to them.
  This option has a MAJOR impact on the effectiveness of opt_entdata. Use with caution if you're near limits.
  
  
• -nostrip
  -nostrip is *another* clone of the -nomiscents option but its for the "Striping ent properties.." part of things.
  This stage frequently is the cause of problems especially if they are ingame weirdness with entities.
  This option has a MAJOR impact on the effectiveness of opt_entdata. Use with caution if you're near limits.
  
  
• -noorigins
  -noorigins turns off the new origin removal code.
  If you feel that origins are missing from entities that need them then try switching this.
  Note that, by default, the origin remover only affects entities that DO NOT need them, multimanagers and lights are good examples.
  You can also add to or modify the removal list - as (and if) required.
  
  
• -texdata n ..where n is texdata size in kB.
  The -texdata option is excactly the same as the one found in ZHLT/MHLT/ZHLTpXX so use it with opt_entdata if you did when compiling the map.
  The program will handle the passing of this to ripent when it gets run.
  
  
• -lightdata n ..where n is lightdata size in kB.
  The -lightdata option is exactly the same as the one found in ZHLTpXX/ZHLT3 so use it with opt_entdata if you did when compiling the map.
  The program will handle the passing of this to ripent when it gets run.
  
  
• -noinfo
  The -noinfo option gets rid of the config info that ZHLT3 (beta 4 upwards) ripent displays.
  
  
• -chart
  In ZHLT3 ripent dosen't display the bsp chart by default.
  Usage of -chart will turn this back on but spam your screen.

Customisable settings & property list files

Property Extractor

Contact, discussion threads & help

Credits