Opt (Creating New Thing, LineDef and Sector descriptions

DeePsea lets you change the descriptions for Things, LineDefs and Sector by supplying an optional .OPT file. This file is not required for regular DOOM, just make one if you would like your own descriptions.

The following are typical OPT file names (see note below):

Create a file with a text editor (maching the game desired). Place the file in the DeePsea directory. The contents of the file is described below in a sample file layout for DOOM2.

The supplied BOOM.OPT file shows in detail how all the entries are added and you can see what it looks like in DeePsea! This file contains entries for BOOM support. See DOSDOOM2.OPT for DOSDOOM entries. See ZDOOM.OPT and ZDOOMHEXEN.OPT for ZDOOM entries.

NOTE & CAUTION : We suggest you rename your own file to something else, since the default OPT names are destroyed when you install DeePsea each time.

Sample BOOM.OPT file

// This is an optional control file to change the descriptions as shown

You can use // as a comment line. The line is ignored

id The identifier number of the Thing, LineDef, or Sector type

id can be decimal or hex (ox...). Normally, the id number must match an existing id number. The only exception is for DOOM/DOOM2 (see below).

Blank lines are ignored

HEXEN Note:

Be sure to identify the optional parameters in the same sequence.

The words Tag, Tid, PolyId and Angle are special keywords and must

be entered as shown, otherwise DeePsea will not keep track of them!

Categories for DOOM, BOOM, HEXEN and ZDOOM only

There are 2 types of categories:

1.    Those prebuilt/predefined in DeePsea

2.    New categories you add.

There are 12 predefined categories, you can make 10 more new ones. You can replace the descriptions of the prebuilt categories and add new ones. See below for syntax for each section.

A category is identified by keying "some category". The maximum description is 40 characters

To replace an existing category, add one of the following Category Keywords listed below. For example : "Some Category" DoorOpen replaces the category description "Door Open" with "Some Category"

New entries following an existing modification are added to the category. See below for the number of entries permitted for each categories.

id : Identifier of the Thing, LineDef, or Sector type- can be decimal or hex, for example, decimal 18 is 0x0012 in hex

"-": creates a separator line and counts as an entry

[THINGS] This identifies the section for modifying Thing descriptions and sprite names.

// id spritename Thing desc (52 max) color (optl) radius(optl) height(optl) property (optl) shape (optl)

// the following are replacements :

0x0001 "PLAYA1" "Player1 Start" Player1 char Play1 // replacement 1 sample hex id name

2 "PLAYB1" "Player2 Start" Player2 char Play2 // replacement 2

// The next shows adding a new category and a new thing (DOOM only)

// There are 5 new categories available for Things

"Controllers" // required to activate category color radius height property shape

5001 "BAL1C0" "Push Controller 1" YELLOW 16 2 PUSH ROUND // added

5002 "BAL1D0" "Push Controller 2" YELLOW 16 2 PUSH SQUARE // added

[LINEDEFS] This identifies the section for modifying LineDef descriptions.

// id " LONG DESCRIPTION (52 max) " "SHORT DESC (16) " MOVER PROPERTY TAG [COLOR] arg1 arg2

// [COLOR] is optional and is for specials with tags only

// arg1 - arg5 are optional default values (values for ZDOOM-HEXEN linedefs only)

26 "DR OpenBlue Wait/close" "DR OpenBlue C " RaiseDoor Bluekey NoTag // replacement

"Door (close)" DoorClose // add to existing category - the 2nd DoorClose is a keyword

"-"

196 "SR Close Door, Opens after 30 seconds" "SR Close Door 30" None None Tag

// the next shows adding a new category and a new LineDef (DOOM only)

"Set/Accell Vectors" // new category

223 ".. Set Friction in Tagged Sector Sludge<100, Ice>100" "Friction Amount"

[SECTORS] This identifies the section for modifying Sector descriptions.

// id long description (52 max) short desc (16 max)

1 "Light Blinks Randomly" "Blinks Random " // replacement

// the next shows adding a new category and a new Sector (DOOM only)

"BOOM Sectors" // required to activate category

1 "Light Blinks Randomly" "Blinks Random" DELETE // descriptions could have been anything

1 "Light Blinks Randomly readd" "Blinks Random" // descriptions to show it's been replaced

18 "BOOM 1 only (see DOOM2.OPT file) " "BOOM 1 " // added

"Lights" Lights // add next to this category - the second lights is a keyword

33 "A new light" "new light"

"New Sector 1" // new category1

32 "Sector with Damage 5 " "Damage 5 " // added

64 "Sector with Damage 10 " "Damage 10 " // added

86 "Sector with Damage 20 " "Damage 20 " // added

"New Sector 2" // new category2

321 "Sector with Damage xx " "Damage xx " // added

641 "Sector with Damage yy " "Damage yy " // added

861 "Sector with Damage zz " "Damage zz " // added

[COLORMAPS]

Older version of DeePsea had this section. This has been replaced by an interactive F5/Texture dialog where you can add not only color mapping table names, but also predefined RRGGBB color values for ZDOOM and LEGACY.

Colormaps are used by the BOOM 242 linedef (please see BOOM documentation).

For ZDOOM you can use hexadecimal RRGGBB texture names instead of COLORMAPS (please review ZDOOM documentation).

For LEGACY the hexadecimal format is #RRGGBBa (Please review LEGACY documentation).

See Options (F5) - Map, Node, Project, Color, Sound, Texture, Check, Zoom for more details.

Special Note for DOOM modified Extensions (e.g. ZDOOM & BOOM)

When adding New LineDefs for BOOM, the LineDef type numbers do not have to match any existing LineDef number, but they must belong to one of the 10 User Categories. There are 32 slots available in 10 different new categories for a total of 320 new types. You can also add to one of the existing 12 categories (to expand them to a total of 32 each). The amount of space free in each one varies. The total number of entries cannot exceed 32, including menu separators.

In addition, you can add 15 new User Thing Categories with 32 new Things each and 6 new User Sector Categories with 32 new entries each. Any number that does not match a prior section is added the the "User Category" section for Things or Sectors. So you can use this for any of the DOOM modifications being made.

If you do not have any DECORATE entries, then you can use the special Decorate1-4 keyword and use the Decorate areas for another purpose.

Note : In all cases, if a new type is added, the Category must be supplied first. To extend an existing category, suppy the "yourcategory" categorykeyword (from below)

BOOM support is optional. If you turn this off, the special checks for BOOM LineDef types are turned off.

ZDOOM - HEXEN support is optional. If you turn this off, the special processing for DOOM or HERETIC checks in HEXEN mode are turned off.

29 Color Names for THINGS and LineDefs (also used in DECORATE)

BLUE

GREEN

CYAN

RED

MAGENTA

BROWN

LIGHTGRAY

DARKGRAY

LIGHTBLUE

LIGHTGREEN

LIGHTCYAN

LIGHTRED

LIGHTMAGENTA

YELLOW

WHITE

GRAY

DARKERGRAY

DARKRED

DARKGREEN

DARKBLUE

DARKMAGENTA

ORANGE

LIGHTBROWN

SALMON

LIGHTYELLOW

LIGHTERBLUE

LIGHTERGREEN

LIGHTERRED

LIGHTERGRAY

Thing CATEGORY Keywords for Accessing Existing Categories

PlayerStart

Keys

Equipment

Weapons

Ammunition

Enemies

Decorations

LightSources

Corpses

HangingCorpses

Decorate1

Decorate2

Decorate3

Decorate4

Thing PROPERTY types (also used in DECORATE)

SKIP ignore (for replacements only)

NONE to reset existing

DELETE special* see below

PlayerStart1

PlayerStart2

PlayerStart3

PlayerStart4

PlayerStart5

PlayerStart6

PlayerStart7

PlayerStart8

PlayerStart (generic for any over 8)

DeathMatch

Teleport

Keys

Equipment

Weapons

Ammunition

Enemy

Decorations

LightSources

Corpses

HangingCorpses

The following properties also define specific Images

Sound

SoundSeq

Ambient

MapSpot

MapSpotGrav

PolyObj

PolyObjCrush

PolyAnchor

Hate

Fountain

Sparks

Bridge

Slope

Decal

CameraAiming

CameraSecurity

CameraMoving

PatrolPoint

PathFollow

Water

Push

Pull

Action

SkyBoxSilence

SkyBoxPick

SkyBoxView

ActorMover

InterPolPoint

InterPolSpecial

EyesAboveFloor

EyesBelowFloor

EyesAboveCeiling

EyesBelowCeiling

SlopeFloorHERE

SlopeCeilHERE

SetFloorSLOPE

SetCeilSLOPE

CopyFloorPLANE

CopyCeilPLANE

SecretTrigger

BBOX

DECORATE (always forces the lightbulb image)

Thing SHAPE types (also used in DECORATE)

(shape used for non-graphical Thing display, use Q to toggle, overrides F5 Setting)

ROUND

SQUARE

PLUS

CHAR xxx (up to 8 characters to display – a + is always used for the display)

LineDef Category Keywords for Accessing Existing Categories

DoorKeys

DoorOpen

DoorClose

Ceilings

Crushers

FloorRaiseCeiling

FloorRaiseFloor

FloorLower

Stairs

LiftsMoving

Lights

Teleport

The following are for ZDOOM Hexen mode only

Door

Poly

LineThing

Scripts

LineDef MOVER types = optional for missing texture checking =

RaiseDoor

RaiseFloor

LowerFloor

RaiseCeil

LowerCeil

RaiseStair

RaiseLower for perpetuals

NONE to reset existing

SKIP ignore (for replacements only)

DELETE special* see below

DELETE is a special keyword that permits you to remove an existing entry from a category. This frees up a slot. The entry must be entered in another category to show up in the submenus. To just replace a description, see discussion above.

LineDef PROPERTY types = optional for error checking =

Teleport

RedKey

BlueKey

YellowKey

RedSkull

BlueSkull

YellowSkull

NONE to reset existing

SKIP ignore (for replacements only)

The following are for ZDOOM Hexen mode only

REDAny

BLUEAny

YELLOWAny

ANYKey

ALLKeys

Scripts

LineDef TAG types = optional for error checking =

SectorTag requires tag to a sector (default assumed)

LineTag requires tag to a line (BOOM/ZDOOM only)

NoTag no tag check required

OptionTag tag or no tag is ok (BOOM/ZDOOM only)

DummyTag the tag is not really a tag, but something else, like LEGACY scripts.

DummyTags prevents the error checker from flagging the tag field as an error.

Dx (Door) tag types are set automatically, so leave D in description start.

LineDef Color = optional for lines with tags

The optional color code for any linedefs with tags identify certain LineDefs with a special visual color. For Legacy, this easily shows you where all your scripts are located, however it’s available for any port. To see these colors, enable the OPT file color code in F5/Project Option - Use OPT line colors.

SECTOR category types

Lights

HealthDamage

SecretOther

The following are for ZDOOM Hexen mode only

Damage

Scrolls

Wind

Stairs

You can use the special keyword DELETE for Sector specials same as LineDef