The DarkMod Wiki - User contributions [en]

How to pack your Mission

2010-02-02T10:09:28Z

Crispy: made config file replacement warning a little more obnoxious

This article describes how to pack The Dark Mod missions into so-called PK4 files for release.

== Mission PK4s ==
Each TDM mission must be packaged in a PK4 file (a PK4 is just a renamed ZIP archive). The PK4 contains all the files needed to run the mission, including map, cm, aas, proc files, textures, models, scripts, defs, xdata, etc. The contents of the PK4 resemble the folder structure as found in the main <tt>darkmod/</tt> directory: textures go into textures/, .def files go to def/ and so on.

At the very minimum, a PK4 archive needs to contain the compiled map and two text files:
maps/outpost.map
maps/outpost.proc
maps/outpost.cm
maps/outpost.aas32
darkmod.txt
startingmap.txt
Easy to see, the above example list of files is based on a mission called <tt>outpost</tt>. The two text files are needed to display your mission in the "New Mission" dialog in TDM's main menu. See their description below.

=== darkmod.txt ===
The darkmod.txt file describes your mission in the TDM's mission selection dialog:
Title: The Outpost
Description: Break into a builder outpost to retrieve a gold ingot.
Author: angua & greebo
The description text mustn't be too long, be sure to check the length of the texts when testing the package in the mission installation dialog.

Starting with release TDM 1.01 it will be possible for missions to specify a "required version", so that missions which are built upon undead (for example) can specify in their darkmod.txt that it needs TDM 1.01 and upwards to run. If the mission installer encounters a version mismatch, a notification appears and TDM will refuse to install it.

You can specify another line after ''Author:''
Title: The Undead Outpost
Description: Break into a builder outpost to retrieve a gold ingot.
Author: angua & greebo
Required TDM Version: 1.01
The "Required TDM Version" string is optional, so existing missions still work of course.

=== startingmap.txt ===
This file holds the name of the first mission to load when the player selects "Start Mission". This is interesting for multi-map campaigns, but for a single-map mission just put the name of your map file in here:
outpost

== Before creating the PK4 ==
You should always perform a full recompile of your map. Delete the .proc, .cm and .aas* files and run a dmap command from TDM console. Make sure the dates of these files are making sense and no old files are floating around in your maps/ folder.

== Creating your PK4 ==
A good way to create your initial PK4 is to copy the compiled map files to a temporary maps/ folder and to zip them up. You can use any compression program capable of handling ZIP files, like 7-zip, WinRAR, WinZip, whatever (''important'': do not create files using RAR, 7z or any other format, only the ZIP format will be recognised). The zip file can have any legal filename - it doesn't have to be the exact mission name. Then rename its suffix to .pk4.

Be sure that the maps/ folder ends up in the root of your ZIP. Then add the '''darkmod.txt''' and the '''startingmap.txt''' to the archive.

In case you haven't added any custom models, textures or other assets (i.e. you're just using vanilla TDM assets), you're done here. Proceed with [[#Testing the PK4]]

== Adding custom Assets ==
Any custom models, textures, def, xdata files need to be added to the PK4. Be sure to put the files in the exact same folder structure as found in the darkmod/ main mod folder. Example: .mtr files need to go to the materials/ subfolder. If you were to extract the PK4 file to the darkmod/ folder, the files would end up in the correct place (note: don't do this actually, you might overwrite existing files in the darkmod folder).

In the (hopefully) rare case your mission needs to overwrite existing TDM content (e.g. modify a DEF file present in the main mod to change a setting), just include the modified file in your PK4. The file in your PK4 will "overrule" the ones in the mod base when the mission is installed (this is what the <tt>fs_game_base</tt> and <tt>fs_game</tt> parameters are for: "game" content will overrule "game_base" content).

Be aware that replacing files containing definitions (def, mtr, etc.) could potentially render your mission incompatible with future versions of TDM, so try to avoid this where possible. Sometimes it is necessary, however.

{{important|headline=Warning|text=Do not package '''DoomConfig.cfg''' or '''autoexec.cfg''' with your mission. Doing so will overwrite players' own config files, potentially cause their TDM installation to break!}}

== Testing the PK4 ==
Once created, add a new folder in your darkmod/fms/ directory and put the PK4 in there. Then start TDM, your map should be listed now in the list of available missions. Make sure to use a "good" foldername for your PK4, not conflicting with any existing ones and without spaces, special or foreign (=non-english) characters. Numbers are fine.

Install the mission and see whether it starts correctly.

== Splash Image (optional) ==
When browsing through the mission selection dialog, a small background screenshot can be displayed in the menu. This file is named '''install_splash.tga''' and can optionally be provided by the mission creator. Just create a small 256x256 image (must be TGA format, DDS files won't work) and put them in your PK4, next to the startingmap.txt and darkmod.txt files. The loading code will find this image and extract it just in time for display in the menu.

== FM Notes (optional) ==
It's possible to display a couple of lines as FM notes. Just add a file called '''readme.txt''' in the PK4. When this file is available, an additional button "Notes" will be displayed next to the "Install Mission" button.

== Distributing your Mission ==

You need only distribute your pk4 for others to play your fan mission. They must, of course, have the Dark Mod resources.

You can include a readme.txt or similar in the pk4 for any extra info including credits etc.

There will be at least one website available that accepts Dark Mod fan mission pk4s for downloading.

{{tutorial-editing}}

How to pack your Mission

2010-02-02T10:04:09Z

Crispy: added warnings about replacing files

This article describes how to pack The Dark Mod missions into so-called PK4 files for release.

== Mission PK4s ==
Each TDM mission must be packaged in a PK4 file (a PK4 is just a renamed ZIP archive). The PK4 contains all the files needed to run the mission, including map, cm, aas, proc files, textures, models, scripts, defs, xdata, etc. The contents of the PK4 resemble the folder structure as found in the main <tt>darkmod/</tt> directory: textures go into textures/, .def files go to def/ and so on.

At the very minimum, a PK4 archive needs to contain the compiled map and two text files:
maps/outpost.map
maps/outpost.proc
maps/outpost.cm
maps/outpost.aas32
darkmod.txt
startingmap.txt
Easy to see, the above example list of files is based on a mission called <tt>outpost</tt>. The two text files are needed to display your mission in the "New Mission" dialog in TDM's main menu. See their description below.

=== darkmod.txt ===
The darkmod.txt file describes your mission in the TDM's mission selection dialog:
Title: The Outpost
Description: Break into a builder outpost to retrieve a gold ingot.
Author: angua & greebo
The description text mustn't be too long, be sure to check the length of the texts when testing the package in the mission installation dialog.

Starting with release TDM 1.01 it will be possible for missions to specify a "required version", so that missions which are built upon undead (for example) can specify in their darkmod.txt that it needs TDM 1.01 and upwards to run. If the mission installer encounters a version mismatch, a notification appears and TDM will refuse to install it.

You can specify another line after ''Author:''
Title: The Undead Outpost
Description: Break into a builder outpost to retrieve a gold ingot.
Author: angua & greebo
Required TDM Version: 1.01
The "Required TDM Version" string is optional, so existing missions still work of course.

=== startingmap.txt ===
This file holds the name of the first mission to load when the player selects "Start Mission". This is interesting for multi-map campaigns, but for a single-map mission just put the name of your map file in here:
outpost

== Before creating the PK4 ==
You should always perform a full recompile of your map. Delete the .proc, .cm and .aas* files and run a dmap command from TDM console. Make sure the dates of these files are making sense and no old files are floating around in your maps/ folder.

== Creating your PK4 ==
A good way to create your initial PK4 is to copy the compiled map files to a temporary maps/ folder and to zip them up. You can use any compression program capable of handling ZIP files, like 7-zip, WinRAR, WinZip, whatever (''important'': do not create files using RAR, 7z or any other format, only the ZIP format will be recognised). The zip file can have any legal filename - it doesn't have to be the exact mission name. Then rename its suffix to .pk4.

Be sure that the maps/ folder ends up in the root of your ZIP. Then add the '''darkmod.txt''' and the '''startingmap.txt''' to the archive.

In case you haven't added any custom models, textures or other assets (i.e. you're just using vanilla TDM assets), you're done here. Proceed with [[#Testing the PK4]]

== Adding custom Assets ==
Any custom models, textures, def, xdata files need to be added to the PK4. Be sure to put the files in the exact same folder structure as found in the darkmod/ main mod folder. Example: .mtr files need to go to the materials/ subfolder. If you were to extract the PK4 file to the darkmod/ folder, the files would end up in the correct place (note: don't do this actually, you might overwrite existing files in the darkmod folder).

In the (hopefully) rare case your mission needs to overwrite existing TDM content (e.g. modify a DEF file present in the main mod to change a setting), just include the modified file in your PK4. The file in your PK4 will "overrule" the ones in the mod base when the mission is installed (this is what the <tt>fs_game_base</tt> and <tt>fs_game</tt> parameters are for: "game" content will overrule "game_base" content).

Be aware that replacing files containing definitions (def, mtr, etc.) could potentially render your mission incompatible with future versions of TDM, so try to avoid this where possible. Sometimes it is necessary, however.

'''Do not''' package '''DoomConfig.cfg''' or '''autoexec.cfg''' with your mission, as this will overwrite players' own config files, which may break their TDM installation!

== Testing the PK4 ==
Once created, add a new folder in your darkmod/fms/ directory and put the PK4 in there. Then start TDM, your map should be listed now in the list of available missions. Make sure to use a "good" foldername for your PK4, not conflicting with any existing ones and without spaces, special or foreign (=non-english) characters. Numbers are fine.

Install the mission and see whether it starts correctly.

== Splash Image (optional) ==
When browsing through the mission selection dialog, a small background screenshot can be displayed in the menu. This file is named '''install_splash.tga''' and can optionally be provided by the mission creator. Just create a small 256x256 image (must be TGA format, DDS files won't work) and put them in your PK4, next to the startingmap.txt and darkmod.txt files. The loading code will find this image and extract it just in time for display in the menu.

== FM Notes (optional) ==
It's possible to display a couple of lines as FM notes. Just add a file called '''readme.txt''' in the PK4. When this file is available, an additional button "Notes" will be displayed next to the "Install Mission" button.

== Distributing your Mission ==

You need only distribute your pk4 for others to play your fan mission. They must, of course, have the Dark Mod resources.

You can include a readme.txt or similar in the pk4 for any extra info including credits etc.

There will be at least one website available that accepts Dark Mod fan mission pk4s for downloading.

{{tutorial-editing}}

What's new in TDM 1.01

2010-01-10T01:12:32Z

Crispy: wording tweaks

This article is a work-in-progress and can change before the final release. There are '''no promises''' here. Features may be postponed or removed even if they appear on this list, and regressions may re-introduce bugs after they've been fixed internally.

== Bugs fixed ==

* [http://bugs.angua.at/view.php?id=1970 #1970]: Chests went non-solid when frobbed
* [http://bugs.angua.at/view.php?id=2072 #2072]: The player could shoulder rats
* [http://bugs.angua.at/view.php?id=2083 #2083]: Small items like candles, candle holders, rocks etc floated on water instead of sinking
* Fixed savegames getting to huge sizes, leading to out-of-memory or crashes
* Fixed a few crashes and memory errors

== Features added ==

* A lot new skins for: dirty fireplaces, unlit lamps etc.
* New script events for: get/setDroppable, isEntityHidden, Melee etc.
* Support for "skin_unlit" and "skin_lit" on light entities
* New "unbindOnAlertIndex" spawnarg on attached entities, to make AI drop them when alerted
* Crouch indicator: Lightgem "wings" squash down slightly when crouch mode is on (helpful when climbing)

== AI added ==

* Zombies
* Spiders
* Revenant

== Entities added ==

* A lot of new [[combo entities]] have been added:
** fireplaces,
** static torches,
** statues with torch in hand,
** campfires, bucket and bonfires,
** electric streetlights,
** wall-mounted lamps and torches,
** geodes with pulsating light,
** bottles+candle,
** skulls+candle etc.
* new colored torch flames: blue, green, orange
* new fireflames: white and black smoking, smouldering ones, large and huge bonfires, bucketfire

== See also ==

* [http://thedarkmod.com/downloads.php Download TDM]

What's new in TDM 1.01

2010-01-10T01:08:20Z

Crispy: expand WIP disclaimer

This article is a work-in-progress and can change before the final release. There are '''no promises''' here. Features may be postponed or removed even if they appear on this list, and regressions may re-introduce bugs after they've been fixed internally.

== Bugs fixed ==

* [http://bugs.angua.at/view.php?id=1970 #1970]: Chests go non-solid when frobbed
* [http://bugs.angua.at/view.php?id=2072 #2072]: The player could shoulder rats
* [http://bugs.angua.at/view.php?id=2083 #2083]: Small items like candles, candle holders, rocks etc float on water instead of sinking
* Fixed savegames getting to huge sizes, leading to out-of-memory or crashes
* Fixed a few crashes and memory errors

== Features added ==

* A lot new skins for: dirty fireplaces, unlit lamps etc.
* New script events for: get/setDroppable, isEntityHidden, Melee etc.
* Support for "skin_unlit" and "skin_lit" on light entities
* Support "unbindOnAlertIndex" spawnarg on AI, to make them drop attached things when they get alerted
* Support for crouch indicator

== AI added ==

* Zombies
* Spiders
* Revenant

== Entities added ==

* A lot of new [[combo entities]] have been added:
** fireplaces,
** static torches,
** statues with torch in hand,
** campfires, bucket and bonfires,
** electric streetlights,
** wall-mounted lamps and torches,
** geodes with pulsating light,
** bottles+candle,
** skulls+candle etc.
* new colored torch flames: blue, green, orange
* new fireflames: white and black smoking, smouldering ones, large and huge bonfires, bucketfire

== See also ==

* [http://thedarkmod.com/downloads.php Download TDM]

Fan Missions for The Dark Mod

2010-01-10T00:54:23Z

Crispy: tweaked column widths to make content fit better at 1024x768 and above

Following is what should be (provided the community keeps the list up to date) the definitive list of every fan mission ever released for The Dark Mod.
* Only include missions that are fully released, not those currently in development or testing.
* List by release date descending (newest at the top).
* A mission title may be listed in plain text as a record of release, or may optionally act as a link to an information page or primary direct download. It may also include links to a discussion thread (t), or download mirrors (m) (see next).
* '''Big Ugly Disclaimer:''' The Dark Mod team does not necessarily support or endorse content listed here. Apart from listed missions hosted directly on the [http://www.thedarkmod.com/ official TDM website], The Dark Mod team does not host the missions listed here, and disclaims all responsibility for them. This is a community maintained list, and an ongoing work in progress. Missions which are known to violate copyright must be text-only, and cannot contain links. Report and/or remove links found in violation of this rule.

{|border=1 cellspacing=0 cellpadding=3 width=100%

|-
!bgcolor=#d0d0e0 width="45%"|Fan Mission Title
!bgcolor=#d0d0e0 width="25%"|Author(s)
!bgcolor=#d0d0e0 width="10%"|Release Date
!bgcolor=#d0d0e0 width="5%"|Size (MB)
!bgcolor=#d0d0e0 width="15%"|Series

|-
!align=left|[http://www.mediafire.com/?m4ywobjodm0 The Sons of Baltona 1], [http://modetwo.net/darkmod/index.php?/topic/10498-fan-mission-the-sons-of-baltona-1-by-carnage-20100109 (t)]
|Carnage
|2010-01-09
|2.7
|GCC 09 / Baltona

|-
!align=left|[http://bloodgate.com/mirrors/tdm/pub/pk4/fms/living_expenses.pk4 Living Expenses], [http://modetwo.net/darkmod/index.php?/topic/10451-fm-living-expenses-by-sonosuke-2-jan-10/page__view__findpost__p__205386 (t)]
|Sonosuke
|2010-01-02
|5.9
|GCC 09

|-
!align=left|[http://bloodgate.com/mirrors/tdm/pub/pk4/fms/trapped.pk4 Trapped!], [http://modetwo.net/darkmod/index.php?/topic/10442-fm-trapped-by-railgun-dec-30/page__view__findpost__p__205092 (t)]
|RailGun
|2009-12-30
|6.3
|

|-
!align=left|[http://www.southquarter.com/downloads/parcel.pk4 The Parcel], [http://modetwo.net/darkmod/index.php?/topic/10404-fm-the-parcel-by-xonze-dec-24/page__view__findpost__p__204459 (t)], [http://bloodgate.com/mirrors/tdm/pub/pk4/fms/parcel.pk4 (m)]
|Xonze
|2009-12-24
|6.6
|GCC 09

|-
!align=left|[http://www.southquarter.com/downloads/too_late.pk4 Too Late], [http://modetwo.net/darkmod/index.php?/topic/10400-fm-too-late-by-nielsen74-24-dec-09/page__view__findpost__p__204396 (t)], [http://bloodgate.com/mirrors/tdm/pub/pk4/fms/too_late.pk4 (m)]
|Nielsen74
|2009-12-24
|3.8
|GCC 09

|-
!align=left|[http://www.mindplaces.com/darkmod/fmdetails.php?id=7 Thieves], [http://modetwo.net/darkmod/index.php?/topic/10286-fm-the-thieves-nov-2509/ (t)]
|Silencium, RailGun, Fidcal
|2009-11-26
|8.7
|

|-
!align=left|[http://www.mindplaces.com/darkmod/fmdetails.php?id=6 Patently Dangerous], [http://modetwo.net/darkmod/index.php?/topic/10125-fm-patently-dangerous-oct3109/page__view__findpost__p__199324 (t)]
|demagogue
|2009-10-31
|24
|

|-
!align=left|[http://www.mindplaces.com/darkmod/fmdetails.php?id=5 The Dark Mod Training Mission], [http://modetwo.net/darkmod/index.php?/topic/9932-fm-training-mission-17-oct-09/ (t)]
|TDM Team
|2009-10-17
|6
|

|-
!align=left|[http://www.mindplaces.com/darkmod/fmdetails.php?id=2 The Crown of Penitence], [http://modetwo.net/darkmod/index.php?/topic/9934-fm-crown-of-penitence-by-jesps-17-oct-09/ (t)]
|Jesps
|2009-10-16
|12.5
|

|-
!align=left|[http://www.mindplaces.com/darkmod/fmdetails.php?id=3 The Chalice of Kings], [http://modetwo.net/darkmod/index.php?/topic/9935-fm-chalice-of-kings-by-fidcal-17-oct-09/ (t)]
|Fidcal
|2009-10-15
|3
|Thief's Den

|-
!align=left|[http://www.mindplaces.com/darkmod/fmdetails.php?id=1 The Outpost], [http://modetwo.net/darkmod/index.php?/topic/9937-fm-the-outpost-by-angua-greebo-17-oct-09/ (t)]
|angua, greebo
|2008-12-23
|2
|

|}

Fan Missions for The Dark Mod

2010-01-10T00:52:06Z

Crispy: Added The Sons of Baltona 1

Following is what should be (provided the community keeps the list up to date) the definitive list of every fan mission ever released for The Dark Mod.
* Only include missions that are fully released, not those currently in development or testing.
* List by release date descending (newest at the top).
* A mission title may be listed in plain text as a record of release, or may optionally act as a link to an information page or primary direct download. It may also include links to a discussion thread (t), or download mirrors (m) (see next).
* '''Big Ugly Disclaimer:''' The Dark Mod team does not necessarily support or endorse content listed here. Apart from listed missions hosted directly on the [http://www.thedarkmod.com/ official TDM website], The Dark Mod team does not host the missions listed here, and disclaims all responsibility for them. This is a community maintained list, and an ongoing work in progress. Missions which are known to violate copyright must be text-only, and cannot contain links. Report and/or remove links found in violation of this rule.

{|border=1 cellspacing=0 cellpadding=3 width=100%

|-
!bgcolor=#d0d0e0 width="45%"|Fan Mission Title
!bgcolor=#d0d0e0 width="30%"|Author(s)
!bgcolor=#d0d0e0 width="10%"|Release Date
!bgcolor=#d0d0e0 width="5%"|Size (MB)
!bgcolor=#d0d0e0 width="10%"|Series

|-
!align=left|[http://www.mediafire.com/?m4ywobjodm0 The Sons of Baltona 1], [http://modetwo.net/darkmod/index.php?/topic/10498-fan-mission-the-sons-of-baltona-1-by-carnage-20100109 (t)]
|Carnage
|2010-01-09
|2.7
|GCC 09 / Baltona

|-
!align=left|[http://bloodgate.com/mirrors/tdm/pub/pk4/fms/living_expenses.pk4 Living Expenses], [http://modetwo.net/darkmod/index.php?/topic/10451-fm-living-expenses-by-sonosuke-2-jan-10/page__view__findpost__p__205386 (t)]
|Sonosuke
|2010-01-02
|5.9
|GCC 09

|-
!align=left|[http://bloodgate.com/mirrors/tdm/pub/pk4/fms/trapped.pk4 Trapped!], [http://modetwo.net/darkmod/index.php?/topic/10442-fm-trapped-by-railgun-dec-30/page__view__findpost__p__205092 (t)]
|RailGun
|2009-12-30
|6.3
|

|-
!align=left|[http://www.southquarter.com/downloads/parcel.pk4 The Parcel], [http://modetwo.net/darkmod/index.php?/topic/10404-fm-the-parcel-by-xonze-dec-24/page__view__findpost__p__204459 (t)], [http://bloodgate.com/mirrors/tdm/pub/pk4/fms/parcel.pk4 (m)]
|Xonze
|2009-12-24
|6.6
|GCC 09

|-
!align=left|[http://www.southquarter.com/downloads/too_late.pk4 Too Late], [http://modetwo.net/darkmod/index.php?/topic/10400-fm-too-late-by-nielsen74-24-dec-09/page__view__findpost__p__204396 (t)], [http://bloodgate.com/mirrors/tdm/pub/pk4/fms/too_late.pk4 (m)]
|Nielsen74
|2009-12-24
|3.8
|GCC 09

|-
!align=left|[http://www.mindplaces.com/darkmod/fmdetails.php?id=7 Thieves], [http://modetwo.net/darkmod/index.php?/topic/10286-fm-the-thieves-nov-2509/ (t)]
|Silencium, RailGun, Fidcal
|2009-11-26
|8.7
|

|-
!align=left|[http://www.mindplaces.com/darkmod/fmdetails.php?id=6 Patently Dangerous], [http://modetwo.net/darkmod/index.php?/topic/10125-fm-patently-dangerous-oct3109/page__view__findpost__p__199324 (t)]
|demagogue
|2009-10-31
|24
|

|-
!align=left|[http://www.mindplaces.com/darkmod/fmdetails.php?id=5 The Dark Mod Training Mission], [http://modetwo.net/darkmod/index.php?/topic/9932-fm-training-mission-17-oct-09/ (t)]
|TDM Team
|2009-10-17
|6
|

|-
!align=left|[http://www.mindplaces.com/darkmod/fmdetails.php?id=2 The Crown of Penitence], [http://modetwo.net/darkmod/index.php?/topic/9934-fm-crown-of-penitence-by-jesps-17-oct-09/ (t)]
|Jesps
|2009-10-16
|12.5
|

|-
!align=left|[http://www.mindplaces.com/darkmod/fmdetails.php?id=3 The Chalice of Kings], [http://modetwo.net/darkmod/index.php?/topic/9935-fm-chalice-of-kings-by-fidcal-17-oct-09/ (t)]
|Fidcal
|2009-10-15
|3
|Thief's Den

|-
!align=left|[http://www.mindplaces.com/darkmod/fmdetails.php?id=1 The Outpost], [http://modetwo.net/darkmod/index.php?/topic/9937-fm-the-outpost-by-angua-greebo-17-oct-09/ (t)]
|angua, greebo
|2008-12-23
|2
|

|}

Surface Types

2009-12-27T03:48:30Z

Crispy: Added undeadflesh. Partial cleanup of outdated info.

{{Original_Reference|Ishtvan|2974}}

Okay, adding the new surface types wasn't as easy as I thought, but I have put in a system for it and it works. This is subject to change. However, unless people really don't like this, I think we can go with this.

The following surfaces are standard D3 surfaces. We cannot change the name of these even if we wanted to.

= Old (D3) Surface Types =
Put these in the first line of the .mtr file

* none
* metal
* stone
* flesh
* wood
* cardboard
* liquid
* glass
* plastic
* ricochet
* surftype10
* surftype11
* surftype12
* surftype13
* surftype14

= New (unique to TDM) surface types =
Use surftype15 and put surface in description string (this list is not fixed, we can keep adding to it):

* tile
* carpet
* dirt
* gravel
* grass
* rock
* twigs
* foliage
* sand
* mud
* brokeglass
* snow
* ice
* squeakboard
* puddle
* moss
* cloth
* ceramic
* climbable
* slate
* straw
* armor_leath
* armor_chain
* armor_plate
* undeadflesh (like flesh, but less vulnerable to mundane damage)

= Instructions on putting in new surfaces =
We had to do some tricks to expand the list of surfaces. In the material file, put '''surftype15''' as the first line. Then, in the "description" line, put the new surface type in quotes. If you want to add anything after that, that's fine, just make sure the surface type is the first thing in the description, and you put a space after it.

NOTE: Old surfaces can be entered the same way as new surfaces, but it decreases performance
You could use the surftype15/description method to enter surface types for old D3 textures if you wanted. Entering it the "old" way would lead to slightly faster performance though, since wood is in the enumeration so no string manipulation is required. I don't think this performance impact will be noticable, but you never know.

= Examples =
Putting in one of the old D3 surface types, wood:
textures/darkmod/mansion/floor/manfloor03
{
wood

qer_editorimage textures/darkmod/mansion/floor/manfloor03.tga
diffusemap textures/darkmod/mansion/floor/manfloor03.tga
specularmap textures/darkmod/mansion/floor/manfloor03_s.tga
}

Putting in a new surface type, tile:
textures/darkmod/mansion/floor/manfloor02cen2
{
surftype15

description "tile"

qer_editorimage textures/darkmod/mansion/floor/manfloor02cen2.tga
diffusemap textures/darkmod/mansion/floor/manfloor02cen2.tga
specularmap textures/darkmod/mansion/floor/manfloor02cen2_s.tga
}

Again, note that you could put more in the description line, for example:

description "tile This is a tile mosaic that might look nice in a mansion entry hall"

This will work because the first word is tile and there's a space after it.

== Warning! ==
As of now, there is no system to tell you when you make a typo in the new surface type name that goes in the description field. The surface just won't play the proper sounds, etc, it will play the default sounds or none. In the final release, we will hopefully include a quick parser that will go thru the material files for the map and let you know if the new surface types don't match the valid ones.

= What surfaces do =
Surfaces are used to tell what sound to play when you walk on a surface (this code is already in D3, we just have to tell it what sounds to play and how loud those sounds should be to AI). They are also used when objects collide or a projectile hits a surface, to play a specific sound, give off a specific particle effect, or to trigger a specific action (rope arrow only sticks in wood; only "climbable" surfaces can be climbed).

They also determine armor factors in combat (an arrow will bounce off the AI's helmet, but if you shoot it right into the eye opening, it will hurt).

= See also =
* [[Damage Multiplier for Surfaces]]

[[Category:Textures]]
[[Category:Editing]]

Fan Missions for The Dark Mod

2009-12-22T00:13:16Z

Crispy: tweaked big ugly disclaimer

Sleeping AI

2009-12-17T01:43:15Z

Crispy: categorising

PLACEHOLDER TODO...

Sleeping AI are (mostly) working now. They can either put themselves to bed at map start when they have set the spawn arg

''sleeping 1'' or can be made to go to sleep and get back up during patrolling. This is done by targetting a path_sleep entity which then targets a path_wait.

There is also a testmap, test/sleep, which shows both possibilities. Testing please, there might be a few bugs creeping around (I also changed patrolling quite a bit).

By default, place the AI on the right side of the bed (as you look towards the head of the bed) and facing away. If you want the AI to start from the other side then add:

''lay_down_left 0''

There are a few known problems:
They can only lay down in one direction, so we would need a second mirrored animation.
The bed I'm using is too high, so they were clipping into it. I had to push it 8 units into the ground.
They often lie close or even over the edge of the bed.

AI have their eyes closed now while sleeping. This is using the pain anim as a place holder at the moment, since we don't have a suitable anim yet (sleeping looks like a quite painful experience now...)

Another problem is that the bounding box stays behind and is solid when the AI goes to bed.

When you KO a sleeping AI, they pop back to standing, like they did in Thief.

Also this is probably unrelated but might be contributing to this problem: I'm noticing that KO'd AI are sometimes(?) flashing into the AF pose for just a frame, then back to the pose they were in before KO'ing. You can see it if you watch really closely.

There is also a problem when they see the player while laying down - they jump up for a moment, then finsih putting themselves to bed and then finally get up to chase the player.

{{tutorial-ai}}

Func Forcefields

2009-11-29T11:02:44Z

Crispy: /* Out of plane force field (vertical component to the force) */ formatting

{{Original_Reference|Ishtvan|5502}}

= Using Func_Forcefields =

The basic documentation is there in the usage tab in the editor, if you place a func_forcefield and look at it. I'm just going to explain some of the more subtle stuff so that whoever creates this map can set it up.

First of all, a func_forcefield is a brush. Stuff inside that brush is affected, stuff outside is not. You can resize and reshape it however you want.

It will not work correctly if you texture the brush with common/nodraw, but you can use common/caulk.

Force fields have spawnargs for whether they should apply their push as a force, an impulse, or a velocity. These are set with spawnargs applyForce, applyImpulse, and applyVelocity. A force field may only apply one of those. Set the one you want to "1".

It turns out that applyForce doesn't work on AI, and applyVelocity doesn't feel right because your velocity suddenly jumps up, which is unrealistic (that might be okay for some applications). For stuff like river current or wind, I'm recommending applyImpulse, by setting the following:

"applyImpulse" "1"

A forcefield has a few different modes of directing the force. It can explode out from a point, implode toward a point (both of these things limited in distance by whether objects are actually within the force field brush). Or it can be uniform (force is directed the same within the whole brush). For river current, we want uniform.

The direction and magnitude of your force field can be set in the "uniform" spawnarg, which is a space-delimited 3d vector. Decide which directions you want your force field to go in on the map. If you're confused about which direction is which, changing views helped me see it, because the views are labeled YZ for example, so I instantly know which direction is the Y direction by looking at the YZ view.

Once you know, you can put in the force field. If you want a uniform 2d field in one 2d direction, use this equation: Figure out the angle off of the x axis for your direction. For example, y is 90, -y is -90, etc.

= In-plane force field (no vertical) =

uniform[x] = Mag * cos( theta )
uniform[y] = Mag * sin( theta )
uniform[z] = 0

Where Mag is the desired magnitude of your force.

If you want a uniform force in 3d, you also have to figure out roughly the elevation angle off of the XY plane (I'm calling it phi), and use the spherical coordinates formula:

= Out of plane force field (vertical component to the force) =

uniform[x] = Mag * cos(theta) cos( phi )
uniform[y] = Mag * sin(theta) cos( phi )
uniform[z] = Mag * sin( phi )

Some people define phi as the angle deviation from straight up instead of an elevation from the horizon, in that case interchange cos(phi) and sin(phi).

Finally, you are ready to set your "uniform" spawnarg with your vector direction:

"uniform" "<x> <y> <z>"

= Other spawnargs of interest =
Again these are documented in the usage tabs in the editor, but make sure that if you want your force field to always be active, you set:

"start_on" "1"

Otherwise, you can trigger it to toggle whether it's active.

= Performance =
Because a force field is constantly activating physics objects and evaluating their physics, it could potentially drag down performance. The following are some tips to help keep performance reasonable:

-The more physical objects within the forcefield, the worse the performance.

-If you can, place triggers to trigger the force field on or off based on whether the player is entering or leaving the area it's in. This may be difficult in large outdoor maps with large rivers, since you'd have to place huge triggers and those themselves have some impact on performance. In the case of one huge river in a map, it might be better to just write a script that triggers the forcefield or not based on distance to the line of the river.

-Make sure the field does not pile up objects somewhere! As long as the field pushes objects out of it, they'll exit the field by themselves and you won't have to worry much about performance. However, if the field goes right up to a wall, and pushes objects against that wall, the objects will not come to rest, they'll keep getting that impulse and keep getting smacked against the wall, using up CPU resources.

I'd recommend putting some dropoff or a brush that destroys objects or something at the end of your force field. Keep in mind that even if there is a small space, objects could pile up in that space and the next object would hit that object and still be stuck in the field, so you really have to watch out for this.

-Creative spawning/destroying or teleporting objects: How do you get a large river with random debris floating down it, when eventually all the debris will get pushed to the end? Well, you could do some scripting, spawn objects at one end of the river, and delete objects at the other end. Or, you could set up a brush to teleport the objects back to the start of the river and keep the same objects. A Prey-style portal would be ideal here, but those don't work in D3 without a lot of SDK modification.

= Known bug: AFs in water =
If you try to set up a river and there's a dead body in it, it will probably take off like a bat out of hell, because there's currently a bug/hack in the water physics code that reduces AF's masses in water. This makes impulses applied on AFs in water send them flying.

[[Category:Editing]]
[[Category:Tutorial]]

A - Z Beginner Full Guide Page 2

2009-11-23T04:34:25Z

Crispy: key to list entities is now J - as per http://modetwo.net/darkmod/index.php?/topic/9082-newbie-darkradiant-questions/page__pid__201864__st__375&#entry201864

{{A-Z Beginner Guide TOC}}

== Backups ==

Many of us have had that sickening feeling when you've worked on a document for a long time (hours, weeks, months) and it gets accidentally deleted. Make regular extra backups say every half an hour. The time varies depending on the type of work you are doing and how hard it would be to do it all again. Dark Radiant has a great feature to save a copy in a different name. This means you can keep your main working copy with the same name throughout. This helps a lot in many ways as you will find out. To save a copy use menu > file > Save Copy as. I suggest you make a new subfolder in your folder named eg, backups and save in there. Number your backup and EVERY time you save a backup copy give it a new number so you have a sequence of backups just in case. You can delete old ones to save space but always keep several backups.

== Adding Objects, AI ==

Later we are going to extend our room to one or two more but first let's add a few objects to our room. There are static objects like tables and beds under RMB menu 'Create Model' and functioning objects like moveable crates and AI under RMB menu 'Create Entity'. That is important to remember : if it is static then use the model list; if it functions, then use the entity list. For instance, do ''not'' select an AI from the static models list or you'll get an error. And even dead AI, eg, ragdolls, have a function (they can be dragged about) so use the entity list. For more info about objects in general, read [[Objects, General Info for Mission Designers]].

===Static Models===

* Press Esc to DEselect everything
* RMB menu > Create Model > darkmod > furniture > tables > wtable1
* Put it where you like in the room and remember Ctrl + TAB to get a side view to place it on the ground in the room. Moving brushes or objects always snaps to the current grid so if you can't quite get an object in line with the floor or whatever then decrease the grid size temporarily in the grid menu or you can use the + and - keys. But remember to restore later back to 8 just for consistency with this tutorial.
* Add a few more items of furniture of your choice. Not too many. Later we can shuffle them around when we add a doorway to another room then add more objects. I see this as a rough peasant's house not a grand mansion but choose what you like; put a picture on the wall if you like or a pot on the table. This learning process does not need to make design sense.
* To turn any object you can experiment with the rotate tool button but for simplicity I will only cover the Resize and Rotate dialog (called the Transform Dialog.) This can be opened via the modify menu > Rotate and Scale. I recommend you assign a shortcut key in the help menu if you use it a lot or keep it open. It is fairly self-explanatory. You will mostly rotate around the vertical Z axis as you will more often be turning furniture around rather than turning it over. Use it to turn your furniture if you wish.

===Functioning Entities===
Functioning Entities are not all visible objects so don't worry too much about all the strange items in this list. We'll just pick out a few...

First, it is very '''important''' when placing moveable entities like crates that their collision model '''does not clip into the surface they stand on''' else they will sink down when first nudged (see [[Objects, General Info for Mission Designers#Moveable Objects]].)

Now let's look at an AI character...

* Press Esc to DEselect everything
* RMB menu > Create Entity > darkmod > AI > Non-combat > atdm:ai_townsfolk_male1
* Put it where you like in the room and remember Ctrl + TAB to get a side view to place it on the ground.
* Turn him around to face whichever way you like.
* Likewise, under darkmod > moveables, add a atdm_moveable_crate01_1, a atdm:moveable_small_spoon_ornamental, and a atdm:moveable_chair_dining_2_red.

Let's make the man friendly so he doesn't hamper our testing...

* Select the AI by pointing at it and Shift + Alt LMB. This is an exclusive select and automatically deselects everything else.
* In the Entity Inspector on the panel check the 'Show inherited properties' at the top.
* Scroll down to see the word 'team' and select it to highlight it.
* In the box at the bottom change the team from 3 to 0 which is the player's 'team' and click the check button at its right.
* Alternatively you can add/change properties by just typing the name and value in directly - just clear the box and type in team and the value below and click the check button. Yet another way is to right click the classname at the top and select Add property.

That's a beginning of furnishing our room with objects. In a real mission you would take a lot more time and give it a lot more thought.

Ctrl + S to save and feel free to play it in game to see how it's looking. No need to dmap after adding objects - just use the map command as described before. (pathfinding might fail sometimes if you don't dmap so don't worry if the AI characters turn in circles or don't move while testing.)

== Adjusting the Light ==
if you entered the game again with the map command through Dark Mod then you may have noticed the light was a bit too bright - too harsh. This is how to adjust it...

* Esc to DEselect everything
* Select the light
* You can just use L to call up the Light Inspector or...
* In Entity Inspector select '_color' (if the _color property is not there you can just type it in at the bottom and 123 in the box below and click the tick(check) button.)
* At the bottom of Entity Inspector is a coloured panel - off-white in this case showing the brightness and colour of the light currently. Click it and the light inspector will appear.
* Reduce the 'Value' (brightness) to about 40 and click OK. Note that this is shown as 0.40 0.40 0.40 in the properties of the light in the entity inspector. The three values are the red, green, and blue components of white and are to adjust the colour. You can tweak that. For example, gaslight might be slightly blue and torch light slightly orange but it's easier to do it in the light inspector in the colour selector.
* With these temporary lights you can also extend the radius beyond the walls to brighten them up (but more on this later when we place wall torches as it can give problems.)
* At the end of the day, just use your judgement to adjust the lights how ''you'' want them to help you navigate and test your game.

Ctrl + S to save and just use 'map' again in DM(Dark Mod) to enter the game - no need to dmap for light changes as they are dynamic in-game. So you can quickly tweak a light value in DR, Ctrl+S to save, then map in DM to immediately see the result.

We'll adjust this room a little later when we have added some more rooms but for now it is done. Save the mission yet again with a NEW name (unless you have snapshot set in the Preferences.) When saving with a new name always first save it in the old name again then the new so both are uptodate. This is a bit over the top for this simple mission but later you will judge when to save - simply estimate how much work you are willing to lose: the last ten minutes? the last hour?

== New Rooms: Extending the Mission ==

Regard the room we've done as a 'back room'. We'll now make a larger front room.

* Esc to DEselect everything
* Ensure the grid size is 8. It shows in the grid menu or in the status bar.
* Ctrl + TAB to the top grid view
* Drag out a rectangle starting on the big grid square to the north (upwards on screen) of the first room 448 x 320. The big grids vary with zoom so here's an image. Don't worry if yours mission varies from this as so long as you follow the principles it should work...

<center>[[Image:AZroom2.jpg]]</center>

* Ctrl + TAB to a side view and ''outside'' drag the floor down to the same internal floor level as the first room and drag the ceiling up one big grid size above the first so it should be 192 high and look something like this....

<center>[[Image:AZroom2B.jpg]]</center>

* Esc to DEselect everything
* First go back to your small room and point at ONE surface of a wall ''in the camera view'' then select that surface with Ctrl+Shift+LMB
* In the Edit menu are two forms of copy and paste - the normal Windows one and a Dark Radiant exclusive called Copy Shader. Use this to copy the texture and this will include its scale and other adjustments.
* Set Texture Lock OFF (Shift+T or on S>Surface Inspector or [[image:DRtexLock.jpg]] on the top button bar.) This will let the texture align correctly in the new place. (more on this a little later under [[#Texture adjustment]]
* Esc to DEselect the surface
* As before, the ''new'' brush is a solid block. Select it again with Shift + Alt + LMB
* With the new block selected, paste in the texture we just copied. An alternative is to just select it from the Texture Browser but remember to set its scale to 0.3.
* By applying this to the whole block it's quicker than doing the walls one by one after it is hollowed out.
* Use the Room button on the left button bar as before to hollow it out then texture the floor and ceiling. Look back to [[#Making Your First Room]] if in doubt what to do.
* Put in a temporary light as before.
* Put a little furniture in as a living room and/or kitchen combo whatever just for quickness and we'll review it later. You can clone (duplicate) any selection, brush or object or combinations by hitting the SPACE bar then drag it away. When you clone ALWAYS immediately move the new selection. If you get distracted for a moment and forget it then it is not obvious it is there and you may forget and leave a table inside a table or a brush inside a brush.
* RMB inside the new room and select 'Move Player Start here' (check height in a side view.)
* Ctrl + S to save and take a look at it in-game. You will need to dmap first to compile the new terrain and then map. You should be in the new room.

How'd it go? You probably found it too dim. Increase the brightness of the light probably to the full 100 100 100. Then SPACE to clone the light and drag the light to one side somewhere in the room. Make three if you like - one high and one low. We are going to completely review and redo the lights later so just make it reasonable for now.

Well now we have two rooms separated by the void so the next step is a doorway between them...

== Doorways ==

There are many approaches to this. This is just one way.

First we need to know the size of our door (an alternate way is guesstimate the doorframe etc. then adjust after if needed.)

* DEselect everything
* RMB in grid view and select Create Model
* Select darkmod/architecture/doors/oversized/old_door_01.lwo
* By default, the door will be aligned with the south wall which is what we want.
* Place it in the small room touching the north wall centred in the second big grid from the right. Drag it down to just touch the ground in a side view, decreasing grid size if needed as shown below...

<center>[[Image:AZdoor01.jpg]]</center> 

<center>[[Image:AZdoor02.jpg]]</center>

This door is static, non-functioning so the next step is to get it to open and close....

== Making the Door Open ==

In most cases in the future you will just create a working door from the create entity menu where there is a wide selection of most common doors already working (or even select a prefab with working handles) but in this case I'm describing how to make this particular model into a working door so you understand the principle.

To make it possible for the player to open the door, this is what you need to do...

* Esc to DEselect everything else
* Select the door
* In the Entity Inspector select the top line 'classname' so it highlights
* At the bottom of Entity Inspector a button will appear marked 'Choose entity class'. Click it and select darkmod/movers/atdm:mover_door then click the check button.
* The door can now be opened and closed.
* The door will rotate by default anti-clockwise (viewed from above) by 90 degrees. Because this door is near a corner one might normally change it to rotate the other way into the corner by changing the rotate property from 0 90 0 to 0 -90 0 but in this case I want to put an elevator in that corner later so instead, make the door rotate more widely then people can get in the room more easily. Add/set the property rotate (not rotation) with a value of 0 150 0.
* This old door has its own pull handle so no need for anything else
* This door will not block sound yet - we'll deal with that later.
* For full details about doors see [[Doors]]

=== Doorframe ===

In a rough hovel, wooden hut, cave, or cellar you might just hang an old door without a frame but mostly in even modest houses it looks better with a frame and definitely in a grander place. This house just about qualifies for a frame and anyway, you need to know how!

* Ctrl + TAB for front view and RMB drag scroll zoom to get the front view of the door clearly in the grid view
* DEselect the door
* Make the grid size to 2 (grid menu or +- keys)
* Drag out a brush units = 64 wide x 12 deep x 8 high and place it over the door as the top of the doorframe aligned to the grid as shown in the image below. Drag out two other vertical brushes each 6 wide x 12 deep x 104 high and place them at the side of the door as shown to form the doorframe sides. They penetrate the wall for now but later we shall open out a corridor. Give all three of those entire brushes the texture darkmod/wood/boards/scratched temporarily (we'll adjust later.)

<center>[[Image:AZdoor03.jpg]]</center>

*Depth-wise it should be exactly over the centre of the door exactly against the face of the wall...

<center>[[Image:AZdoor04.jpg]]</center>

Because the outer edges of the doorframe align to the big grid it aligns reasonably well with the stonework around see below. Note it just fits under the course of bricks above which is good. (You might have a different wall texture.) Try to avoid cutting half way into bricks like that or worse, leaving a thin sliver of bricks or stone. Think structurally.

<center>[[Image:AZdoor05.jpg]]</center>

But you can see the wood texture alignment is pretty bad and we'll fix that next.

==Texture adjustment==

The horizontal top of the doorframe in the picture above is aligned wrongly; the grain of wood should be aligned to the length of a beam. Also, this texture is boards (planking) so will show the gaps between which must be aligned out of sight. Wood never really comes in an endless sheet anyway - it comes from trees! With experience we could have made one vertical of the doorframe (whose texture is aligned vertically) aligned it better, cloned it for the other side, cloned it again, rotated it, and resized it for the horizontal piece.

===Texture Lock===

Texture lock is most important. It is a mode toggle (Shift+T or on S>Surface Inspector or [[image:DRtexLock.jpg]] on the top button bar.)

* When ENABLED it keeps a texture aligned to its surface even when moved or rotated. This means a wooden beam will look just like it would in the real world if you moved or turned it - it would not change relative to the beam.
* When NOT ENABLED then the texture aligns to the world. This means different surfaces will align together when placed together. So if you cloned a wall and moved the duplicate to one side and a little higher, its stonework would align perfectly with the first wall.

I mostly keep Texture Lock enabled but you need to keep it in mind whenever moving textured brushes: do you wish the brush's surface textures to align with the world or the brush?

=== Texture Alignment with Surface Inspector ===

This assumes you used the same texture and constructed the doorframe as I described above. If your alignment is different then use your own judgement where to apply the following.....

'''Rotation...'''
* Esc to DEselect everything
* Move the camera so you can see the front and top of the doorway in the camera view
* In the camera view use Ctrl+Shift+LMB to select the front surface of the top horizontal of the doorframe. Make sure you do not select the whole brush with Shift LMB or Shift+Alt LMB.
* Press S to get Surface Inspector to show/hide or View menu. Tip: Hot keys might not work if you are focused in an input field. Just click somewhere else.
* In the ''step'' input to the right of ''rotation'' type in 90 if it is not already there.
* Click the righthand little arrow button to rotate the texture 90 degrees else you can just type 90 right in the rotation input.

'''Shifting (scrolling)...'''
* Set the step input for Horiz and Vert Shift to about 4.
* Use the arrows for Horiz and Vert to scroll the texture about.
* Note that Vert moves the texture horizontally now because we rotated it.
* Note that the dark lines of the edges of the boards texture scroll in and out.
* Scroll the texture so the dark lines are not showing and the beam looks OK.
* Note for the future: When cloning many beams in a row don't have them all identically aligned but shift for variety.

OK, now in the same way you have to inspect ALL of the visible surfaces of that brush one by one and see how they look. Yes, even on top where the player might never look! (''someone'' will!) Rotate/Shift where needed (small end pieces might be vertical or horizontal grain or even 45 degrees - use your judgement.) The far side of the brushes will also be visible eventually so do that too (see next paragraph.)

Tip: When inspecting, if any model or brush gets in the way of the view just select it with Shift+Alt+LMB and press H to hide it. So you can rise above the ceiling then 'Hide' it below you to look down into the room. Hide the wall so you can get at the back of the doorframe. You can keep hiding more stuff as you go along and use Shift H to reveal them again. Don't forget them! Another way might be Filter menu > Hide all entities to hide all the furniture in one go.

Likewise do the side brushes of the doorframe.

Finally, Shift H to unHide and give the whole doorframe and door one last inspection. Looking good?

== Corridors, Recesses ==

This will be a small recess rather than a corridor but the principle is the same : you just make a corridor like a small room except you won't need the ends which will be open to the rooms either end. You could make a solid and hollow it out and then delete the ends or make walls, floor, ceiling as separate brushes yourself. In this case the recess will be the same textures as the big room so another option is to clone the sides from it and reduce them so let's do that...

* Esc to DEselect everything
* Check grid size is 8
* Set Texture Lock OFF. This will ensure the texture will align to the world not the original brush. In this case it probably would be alright and the worst that can happen is you have to re-align the texture (but you wouldn't want to do that with an entire house.)
* Shift+Alt+LMB to select the left wall of the big room. You may find it easier to make these selections in the camera view. Repeated Shift+Alt+LMB will cycle down through different items if they overlap in the grid view.
* SPACE to clone it. Don't wait... drag it away immediately so you never forget it's there. As you drag it away, check that it really did clone and you are not just dragging the original. If so, use Ctrl+Z to undo the drag and try clone again.
* Drag it in the space between the two rooms near the door.
* Resize it to 48 x 8 and position it so it fits exactly as shown below between the two walls. It should be just to the left of the doorframe and touching it. The height is OK as it is.

<center>[[Image:AZdoor06.jpg]]</center>

* Repeat the above with the other wall and put it to the other side of the door
* Similarly do the same with floor and ceiling. These should become 64 x 56 and fit ''between'' the recess side walls ''touching'' the south wall, but ''intruding'' into the north wall (this will make more sense later.) I have 'deliberately' made a mistake with the floor which we'll correct later so you can see it's no biggy if you get things wrong - you just adjust later. See the red outline of the floor and ceiling in the image below....

<center>[[Image:AZdoor07.jpg]]</center>

Ctrl+S to resave the mission.

== 'Cutting' through walls, Joining Rooms ==

First, a tip: when you are resizing a narrow brush like a wall it sometimes happens that you accidentally move sideways and reduce its narrow width to zero - nothing at all. DON'T LET GO! If you release the mouse at that point it will be deleted! Instead move your mouse to that side so it re-appears. If you are in doubt as to its dimension you might need to Ctrl+Z undo. Get into the habit when resizing to keep your mouse button held down and only release when you know you can see the brush. I personally wish a brush could not be reduced below one grid unit. Later I will describe methods of moving and resizing which stop accidental side movements.

Now, you cannot actually cut holes in brushes - you can only surround a space with smaller brushes so it looks like one big brush with a hole in it. The following is easy but it might sound complicated so just try it and the worst that can happen is you have some undoing or reload your last save. So to cut out our doorway do the following...

* In the small south room face north in camera view looking at your door (this can be done in grid view but it's easier to be sure what you're doing.)
* Shift + H if you have hidden the wall to UNhide it so you can see both door and wall.
* Esc to DEselect everything (wish someone had nagged me with this when I started and maybe I would not have lost so much.)
* Select the door and H to hide it.
* Select the wall.
* In the grid view, press SPACE to clone the wall
* Immediately LMB drag towards the right from ''outside'' the left edge of the wall to reduce its length to just past the right doorframe and touching it.
* I'll clarify that - you are cloning the wall then moving its left side along past the doorframe like opening a curtain from the left.
* In camera view you should now see the ''original'' wall to the left of the doorframe and also inside the doorway. To the right of the doorway are ''both'' walls occupying the same space with just the new clone still highlighted
* Shift+Alt+LMB select the original wall to the left of the door.
* You are going to reduce this starting from the ''opposite''' end on the right...
* LMB drag towards the left from ''outside'' the ''right' edge of this wall to reduce it past the ''left'' edge of the doorway. Again, like opening the other curtain.
* You should now have two walls; one each side of the doorframe and exactly up to it with a gap over the doorframe.

Now we need to repeat the above for the south wall of the big room. I'll just summarise: you need to clone the south wall and reduce it to one side of the gap between the short connecting walls of the recess and the same for the original wall. Remember - like dragging curtains aside.

<center>[[Image:AZdoor08.jpg]]</center>

If you look south in the camera view from the big north room you will see that all that remains is the gap over the door frame...

* Clone one of the north walls of the little south room
* reduce its width to 64 and height to 80 and move it up to fit over the door exactly. It's top corner should just meet the corner edge of the little piece of ceiling we put in the recess. Here is a side view...

<center>[[Image:AZdoor09.jpg]]</center>

* Esc to DEselect the section we just put over the doorway.
* From the north you should see it is the wrong texture for that recess and that big room.
* Shift+Ctrl+LMB to select its north ''face'' in the recess and re-texture it to the same as the other walls in the recess (same as the big room.) You can copy and paste the texture or get it from the Texture Browser by just clicking it there.
* You will also need to re-align/rotate the texture on the doorframe if you didn't do that side before

If you examine what has been done by moving about in the camera view you will see the 'deliberate' mistake in the little piece of floor in the recess. Hide the door and you can see there is a gap. Here is a side view.

<center>[[Image:AZdoor10.jpg]]</center>

Just select that side view in the grid view and resize it to close the gap. The doorway should be complete. Zoom around in camera view and check it out.

I suggest you clone a light in that big room and drag it near the recess for now.

Ctrl + S to save and then Save As with a new name.

You can now dmap (the new name.) If you get a leak error then use File Menu > Pointfile in Dark Radiant to see a red line pointing the track of the leak. Did you leave a gap? (For details on fixing leaks & pointfile see [[Leaking maps]] and [[Performance: Essential Must-Knows#Build Airtight. Seal out the Void. Avoid Leaks]])

Map to play through and check it looks OK.

== Ambient Light: Gloom not Doom ==

Notice how harsh and black the shadows are in this mission? You need shadows for atmosphere and to hide in a stealth game but seeing nothing at all but blackness is not popular among players so we are going to add ambient light.

Ambient light is a steady background low light casting no shadows. The light has a radius but it does not fade from its centre; it's brightness is constant throughout its radius. Except for special cases the ambient light should be present throughout a mission as the minimum light when no other light is present. The ambient can also add a little colour so different ambient lights might illuminate a crystal grotto as pale blue; a lava cave with a ruddy glow, and so on. But unless you have special needs like that then one ambient is sufficient for the whole mission.

* Press Esc to DEselect everything (from now on I'll not mention this. Take care!)
* From the grid view RMB menu, create a light in the centre of the mission. This might be just below the bottom right corner of the big room by the time we are finished but we cannot put an entity or a light in the void; it will cause a leak error. One might create a tiny room there in isolation just for the light but it does not need to be exactly centred so stick it in the bottom right corner of the big room.
* Increase its radius to cover both rooms completely either by dragging or adjusting its radius in the Entity Inspector. Keep its centre roughly in the bottom right corner of that room. It only needs to roughly cover the rooms and can stick out on all sides.
* Check the side view for height.

===ambient_world helps performance===

If the main ambient light is named ''ambient_world'' then Dark Mod provides an option for a virtual ambient light to help performance so it is essential that you do this. It makes a significant difference to low-end system frame rates.

* In the Entity Inspector select the 'name' line
* In the input at the bottom change it to ambient_world. Click the check button
* Esc to DEselect it
* Press J to list entities.
* Click the map in the list and the whole list will open up
* You should see ambient_world in there.
* Click it and your light is selected and its radius reveals it clearly

In this way you can name anything you want for your own convenience both so you can identify and find them easily. The list is in ASCII order so capitals first then lower case,thereafter in alphabetical order.

* with the light selected, press L for the Light Inspector
* Click the white rectangle Colour button and reduce the brightness (Value) to 8 or 10 and click OK.
* Also in the Light Inspector you will see a list headed 'Texture' with 'fog' and 'lights' in the list; click the + sign against 'lights' to open up its list
* In the 'lights' list select 'lights/ambientLightnfo'; this immediately goes in the properties of the light.
* L to close the Light Inspector

The actual brightness is a matter of taste. Players should be able to dimly see texture even in the darkest corners. But don't make the ambient too bright or you get flat, washed out, missions with poor atmosphere and it will be hard for the player to judge where to hide if there are no good shadows. Judge your mission over a few days sometimes on a bright day; sometimes at night before you decide on the best compromise that you like. The player's in-game brightness setting and personal preferences will also affect how the game appears so it is not an easy thing to judge. Review the guidelines at [[Virtual Darkness]]

Generally speaking, an ambient light of below 3 is going to be too dark; 10 or above rather too light. Thief's Den was released with an ambient of 4. Also consider does your mission have lots of dark textures? You might raise the ambient a little if so. Your choice. I shall use 4 for this mission because our main stone walls are quite light. Whatever you choose, reconsider when finished and all the other lights have been placed. I use a brighter ambient in these earlier stages while testing but remember to turn it down when you do the final lighting later.

Tip: Try to avoid large areas of ''only'' ambient light with here and there a 'real' light such as a torch. Instead, think of lighting most of your FM plus some shadows to hide in. Yes, it's not realistic. In real life at night a large house might be completely dark but it's not good stealth gameplay fun and large areas of ambient lighting look flat. There are exceptions of course but generally lots of light with shadows for the player to hide in looks much more atmospheric and lifts the visual quality (of course avoid too many lights especially if they overlap because they reduce performance.)

Check out your mission now in-game. That ambient lifts it tremendously right? You might even want to remove or reduce some of the other lights. Remember, they are all temporary still and we shall do proper lighting later on.

{{A-Z Beginner Guide TOC}}

FAQ

2009-11-16T00:05:09Z

Crispy: /* Supported Operating Systems */ notes on gentoo and GCC

{{important|headline=Important|text=This FAQ relates to the full TDM release version only. For players of the pre-release demos such as '''[[Thief's Den]]''' and '''[[Saint_Lucia|Tears of Saint Lucia]]''' please refer to the '''[[FAQ (Demo Releases)|Demo FAQ]]'''.'''}}

== What Doom versions are supported? ==

=== Can I use the Demo version of Doom 3? ===

No, sorry.

=== Does it run with the Steam version of Doom 3? ===

Yes :) You need to install the mod into the directory where Steam put Doom3, this might be under:

C:\Program Files\Steam\steamapps\common\doom 3

or a similiar folder.

== Patching Doom 3 to verson 1.3.1.1304 ==

=== How can I check whether my Doom 3 is correctly patched? ===

Open Doom 3 and hit {{key|Ctrl}}+{{key|Alt}}+{{key|~}} (tilde, {{key|^}} on German keyboards) to open the console. You'll see the version printed in the lower left corner of the console. It should read '''1.3.1.1304'''. If your version is ending on 1302, you've got the wrong patch installed.

=== Where can I get the right patch? ===

We have the patch hosted on our FTP. See the [[Installation]] article to find a link to it.

If you have version 1.3.1.1302, you may need to uninstall and reinstall before patch 1.3.1.1304 will let you apply it.

=== What's that issue with the 1.3.1 patch? ===

When the 1.3.1 patch was released by Id, they released it a bit too early. Some download sites picked it up quite fast though and started to distribute it. The problem is, that Id replaced that patch with a different one, and, probably thinking that it hadn't spread yet, didn't bother to change the version number. However, you can still find "wrong" 1.3.1 patches and these will not work with the mod. That's why it is important to check the version number in the console to make sure that the right 1.3.1 patch is installed if the mod doesn't work. The link provided here on our own page points to the correct patch, so if you downloaded it from here you don't need to worry about it.

== Supported Operating Systems ==

=== Which Windows versions can I use? ===

Doom 3 needs at least Windows XP or Windows 2000. Saint Lucia was successfully run under Windows XP and Vista. Support for 64 bit Windows or Windows 2000 was not tested.

=== Does it run in Linux? ===
Yes, Linux is supported.
=== Does it run in 64 Bit Linux? ===
Yes, Linux 64 bit is supported. In addition to the steps above, you need 32 bit compatibility libraries, since Doom3 is 32 bit only:
* On '''SuSE''', they should be included.
* On Ubuntu/Kubuntu, install the package '''ia32'''.
* Since you cannot install 32 bit libraries on a 64 bit system with the normal package manager, you should use [http://ubuntuforums.org/showthread.php?t=474790 getlibs] to install '''libmng''' and the boost filesystem lib:
:<code>getlibs libmng.so.1</code>
:<code>getlibs -l libboost-filesystem1.34.1</code>

=== What about Gentoo? ===
Yes. It's not "officially" supported (the team doesn't test it specifically), however several users have reported success running TDM under Gentoo.

=== What about Ubuntu 8.10? ===
Yes. As of this writing you will need to install the '''libboost-filesystem''' package.

=== GLIBCXX_3.4.9 errors ===

If you receive an error about <tt>GLIBCXX_3.4.9</tt>, delete or rename the files <code>/usr/local/games/doom3/libstdc++.so.6</code> and <code>/usr/local/games/doom3/libgcc_s.so.1.</code>

If this doesn't resolve the error and you have an old version of GCC, then you may have to upgrade. It has been [http://modetwo.net/darkmod/index.php?/topic/9982-the-dark-mod-doom3-in-linux/ confirmed] that, at least under Gentoo, GCC 4.1 does not work with TDM but GCC 4.3 and GCC 4.4 are compatible.

=== Does it run on Mac OS X?===
No. Or at least not yet. The Doom 3 game itself does support Mac OS X, but The Dark Mod currently does not because we don't have any developers who use Macs. If you can help us getting it to run on OS X, please [http://modetwo.net/darkmod/index.php?showforum=11 let us know on the forum].

Since TDM works on Linux already, getting it working on OS X should not be too difficult for anyone with experience programming for that platform. In theory it's just a question of figuring out how to build the mod, sorting out dependencies, and writing a few pieces of platform-specific code.

== Graphics ==

=== Does TDM support widescreen resolutions? ===

Yes. Choose "16:9" or "16:10" in the in-game ''Settings'' menu, and select the appropriate resolution. Note that you need to restart the game to have the new setting in effect.

If the native resolution of your wide screen monitor is not listed, you can enter it into '''DoomConfig.cfg''' by changing the following entries like so:

set r_mode -1
set r_customwidth 1280
set r_customheight 800

Note that if you get performance problems, it might be better to halve the resolution in both directions. Please see also [[Performance Tweaks]].

== Troubleshooting ==

It is hard to answer question on why something fails, because wildly different systems cause wildy different symptoms. If the following section does not help you, please ask at out our [http://www.modetwo.net/darkmod forums].

=== Updater (tdm_update.exe) closes almost as soon as it's started ===

See the [[Tdm_update#Updater_closes_almost_as_soon_as_it.27s_started|main article on tdm_update]].

=== FM downloaded but won't play ===

If you have downloaded an FM you might see it in the New Missions List but can't get it to play. These are almost always an install problem. These are some of the causes and cures:

FMs (fan missions) are archives and MUST be suffixed .pk4 not zip. Apparently Internet Explorer 8 may change it from pk4 to zip during download without telling you. You need to rename it back.

You MUST use doom3\darkmod\tdmlauncher.exe to run Dark Mod in Windows and NOT Doom3.exe.

You do NOT need to extract the pk4 archives to install or play. Just download into or move the pk4 into the darkmod\fms folder. Optionally you can create a folder of the same name as the map and put it in there, eg, darkmod\fms\chalice but there is no need because Dark Mod will create that automatically. Just make sure your pk4 goes, unopened, into the fms folder then run tdmlauncher.exe

If you have done the above but see for example, a blank objectives screen and no briefing then it is still almost certainly an install error. I recommend you do a clean sweep if in doubt:
* exit Dark Mod
* delete doom3\darkmod\currentfm.txt (this just uninstalls any FM)
* Delete the map game folder (if any) This is NOT the folder in fms but the folder in doom3 of the same name as the FM, eg, doom3\chalice. Note: this has savegames and screenshots in so check and move them out if you want to preserve them. However, if you can't get the game to play it's likely you don't have any yet. If you can't see the folder don't worry. The folder name is normally the same as the pk4 but it might not be. Strictly speaking it must be the same as the name in startingmap.txt inside the pk4 archive. You might see this file in fms.
* Move the pk4 into the darkmod\fms folder if it is not already there.
* Delete the darkmod\fms\FMname folder if any, eg, darkmod\fms\chalice. Don't worry if there isn't one; it will be created automatically later.

So all that is left is the pk4 in the fms folder. Now run tdmlauncher.exe. The FM should be in the list in the New Missions menu. Re-install it and you should now be able to play it.

=== The game crashes on load ===
Make sure that:
* You installed [[#Patching_Doom_3_to_verson_1.3.1.1304|the correct version]] of the Doom 3 1.3.1 patch.
* Your system meets at least the minimum system specs.
* You have enough free main memory. Try closing a few running programs like Outlook, Anti-Virus or torrent clients.

==== Unknown event 'moveToCoverFrom'" ====
If you get a message like:

ERROR: Error: file script\doom_events.script, line 1038: Unknown event 'moveToCoverFrom'

or see this in the log:

found DLL in pak file: C:\Program Files\Doom 3\darkmod\tdm_game01.pk4/gamex86.dll
copy gamex86.dll to C:\Program Files\Doom 3\darkmod\gamex86.dll
could not create destination file

then try extracting that gamex86.dll manually from '''tdm_game01.pk4''' with Winzip or a similiar program into that folder.

The reason is very probably that you installed Doom3 into a folder with a space in it, and it seems Doom3 does not like that. Sorry.

=== Unknown event 'setEntityRelation' ===
The game is crashing to a small blue screen on startup:

[[Image:ErrorSetEntityRelation.jpg]]

The reason for this error is most likely an old version of gamex86.dll (or gamex86.so) lying around in your Doom 3 folder. Delete that file and try again.

=== Textures are missing, screen mostly black ===

[[Image:Tdm missing textures.jpg|right|240px|Black textures]]

Look into your '''DoomConfig.cfg''' inside your <tt>darkmod</tt> folder and check that the
following settings are like shown below:

<pre style="max-width:35em">
seta image_usePrecompressedTextures "1"
seta image_useNormalCompression "2"
seta image_useAllFormats "1"
seta image_useCompression "0"
seta image_preload "1"
</pre>

=== The briefing is very fuzzy ===

Look into your '''DoomConfig.cfg''' inside your <tt>darkmod</tt> folder and check that the
following settings are like shown below:

seta image_roundDown "1"
seta image_forceDownSize "0"
seta image_downSize "0"

=== The sky is corrupted ===

You either see black sky, or fragments of other textures. This seems only to happen on Geforce 6800 cards.

There are two fixes for this:

As a quick fix you can rename the following folder:

env/skyboxes/skybox_darkland_ne

to an different name. That will result in black sky.

Alternatively, edit the file <tt>materials/tdm_sky.mtr</tt> with '''Wordpad''' or a different editor and
find the sky material named '''textures/darkmod/nature/skybox/skybox_darkland_NE''':

<pre>
//Author: Dram
//skybox_ocean with ocean replaced with dark land
//Moon moved to north east by Fidcal
textures/darkmod/nature/skybox/skybox_darkland_NE
{
qer_editorimage env/skyboxes/skybox_ocean/ocean_ed
noFragment
noshadows
noimpact
nooverlays
forceOpaque
{
forceHighQuality
blend add
cameraCubeMap env/skyboxes/skybox_darkland_ne/darkland_NE
texgen skybox
texgen wobblesky .0 .0 .0
}
}
</pre>

In this declaration, comment out the line that reads '''forceHighQuality''' by adding <tt>//</tt> in front of it:

// forceHighQuality

That should fix the sky and make it render correctly.

=== Sky rotates ===

If you see the sky spinning it may be an ATI graphics card problem. One report says this was cured by turning off Catalyst AI. Also gives better loading times and cures bloom problem.

=== Bloom problems ===

If have a problem with bloom it may be an ATI graphics card problem. One report says this was cured by turning off Catalyst AI. Also gives better loading times and cures spinning sky problem.

=== The game is '''very''' slow! ===

If you get loading times of 5 minutes or more, less than 10 FPS, or the game even stutters, please try this:

Look into your '''DoomConfig.cfg''' inside your <tt>darkmod</tt> folder and check that the
following settings are like shown below:

<pre style="max-width:35em">
seta image_usePrecompressedTextures "1"
seta image_useNormalCompression "2"
seta image_useAllFormats "1"
seta image_useCompression "1"
seta image_preload "1"
</pre>

If that doesn't help, your system might run out of memory. Either upgrade to more than 1 Gbyte memory,
or try to close some other applications before playing.

Please see also the article about [[Performance Tweaks]] to improve the performance.

=== Slow loading times ===

If you find an FM is very slow to load it may be an ATI graphics card problem. One report says this was cured by turning off Catalyst AI. Also cures bloom and spinning sky problem.

===Underwater performance poor===

If you get very low framerates underwater then try turning off bloom.

===Upside-down screen===

If you get an upside-down screen, try turning off bloom.

===Game freezes for several seconds when opening doors===
Solution to problems:

A) "game freezes and loads some data from hard drive while opening doors"

B) "while loading mission you are returned to the menu and need to restart loading"

is
DISABLE EAX 4.0 HD in Audio Settings menu.

===Game exits to menu after mission load, with renderpipe error in console===

'''Symptoms:''' Missions are installed properly and will load, but after they reach 100% you are returned to the main menu or objectives screen. If you open the console (Ctrl-Alt-~ on US keyboards), you see one/both of these errors:

ERROR: Failed to open \\.\pipe\dm_renderpipe

or

ERROR: idRenderSystemLocal::uncrop currentcrop <1

'''Solution:''' Some firewalls, notably ''Sunbelt Firewall'' (aka ''Kerio Firewall'') are known to interfere with TDM's lightgem, ''even when "disabled"''. To fix this problem, completely uninstall the firewall, and get a different one instead.

== Known bugs ==
See article [[Known Bugs]].

=== Changing the screen resolution/aspect ratio does nothing!? ===
These changes require a restart of Doom to work.

[[Category:General]] [[Category:Installation]]

FAQ

2009-11-10T05:14:14Z

Crispy: /* Troubleshooting */

{{important|headline=Important|text=This FAQ relates to the full TDM release version only. For players of the pre-release demos such as '''[[Thief's Den]]''' and '''[[Saint_Lucia|Tears of Saint Lucia]]''' please refer to the '''[[FAQ (Demo Releases)|Demo FAQ]]'''.'''}}

== What Doom versions are supported? ==

=== Can I use the Demo version of Doom 3? ===

No, sorry.

=== Does it run with the Steam version of Doom 3? ===

Yes :) You need to install the mod into the directory where Steam put Doom3, this might be under:

C:\Program Files\Steam\steamapps\common\doom 3

or a similiar folder.

== Patching Doom 3 to verson 1.3.1.1304 ==

=== How can I check whether my Doom 3 is correctly patched? ===

Open Doom 3 and hit {{key|Ctrl}}+{{key|Alt}}+{{key|~}} (tilde, {{key|^}} on German keyboards) to open the console. You'll see the version printed in the lower left corner of the console. It should read '''1.3.1.1304'''. If your version is ending on 1302, you've got the wrong patch installed.

=== Where can I get the right patch? ===

We have the patch hosted on our FTP. See the [[Installation]] article to find a link to it.

If you have version 1.3.1.1302, you may need to uninstall and reinstall before patch 1.3.1.1304 will let you apply it.

=== What's that issue with the 1.3.1 patch? ===

When the 1.3.1 patch was released by Id, they released it a bit too early. Some download sites picked it up quite fast though and started to distribute it. The problem is, that Id replaced that patch with a different one, and, probably thinking that it hadn't spread yet, didn't bother to change the version number. However, you can still find "wrong" 1.3.1 patches and these will not work with the mod. That's why it is important to check the version number in the console to make sure that the right 1.3.1 patch is installed if the mod doesn't work. The link provided here on our own page points to the correct patch, so if you downloaded it from here you don't need to worry about it.

== Supported Operating Systems ==

=== Which Windows versions can I use? ===

Doom 3 needs at least Windows XP or Windows 2000. Saint Lucia was successfully run under Windows XP and Vista. Support for 64 bit Windows or Windows 2000 was not tested.

=== Does it run in Linux? ===
Yes, Linux is supported.
=== Does it run in 64 Bit Linux? ===
Yes, Linux 64 bit is supported. In addition to the steps above, you need 32 bit compatibility libraries, since Doom3 is 32 bit only:
* On '''SuSE''', they should be included.
* On Ubuntu/Kubuntu, install the package '''ia32'''.
* Since you cannot install 32 bit libraries on a 64 bit system with the normal package manager, you should use [http://ubuntuforums.org/showthread.php?t=474790 getlibs] to install '''libmng''' and the boost filesystem lib:
:<code>getlibs libmng.so.1</code>
:<code>getlibs -l libboost-filesystem1.34.1</code>

=== What about Gentoo? ===
Should work too.
=== What about Ubuntu 8.10? ===
Yes. As of this writing you will need to install the '''libboost-filesystem''' package.

=== GLIBCXX_3.4.9 errors ===

If you receive an error about <tt>GLIBCXX_3.4.9</tt>, delete or rename the files <code>/usr/local/games/doom3/libstdc++.so.6</code> and <code>/usr/local/games/doom3/libgcc_s.so.1.</code>

=== Does it run on Mac OS X?===
No. Or at least not yet. The Doom 3 game itself does support Mac OS X, but The Dark Mod currently does not because we don't have any developers who use Macs. If you can help us getting it to run on OS X, please [http://modetwo.net/darkmod/index.php?showforum=11 let us know on the forum].

Since TDM works on Linux already, getting it working on OS X should not be too difficult for anyone with experience programming for that platform. In theory it's just a question of figuring out how to build the mod, sorting out dependencies, and writing a few pieces of platform-specific code.

== Graphics ==

=== Does TDM support widescreen resolutions? ===

Yes. Choose "16:9" or "16:10" in the in-game ''Settings'' menu, and select the appropriate resolution. Note that you need to restart the game to have the new setting in effect.

If the native resolution of your wide screen monitor is not listed, you can enter it into '''DoomConfig.cfg''' by changing the following entries like so:

set r_mode -1
set r_customwidth 1280
set r_customheight 800

Note that if you get performance problems, it might be better to halve the resolution in both directions. Please see also [[Performance Tweaks]].

== Troubleshooting ==

It is hard to answer question on why something fails, because wildly different systems cause wildy different symptoms. If the following section does not help you, please ask at out our [http://www.modetwo.net/darkmod forums].

=== Updater (tdm_update.exe) closes almost as soon as it's started ===

See the [[Tdm_update#Updater_closes_almost_as_soon_as_it.27s_started|main article on tdm_update]].

=== FM downloaded but won't play ===

If you have downloaded an FM you might see it in the New Missions List but can't get it to play. These are almost always an install problem. These are some of the causes and cures:

FMs (fan missions) are archives and MUST be suffixed .pk4 not zip. Apparently Internet Explorer 8 may change it from pk4 to zip during download without telling you. You need to rename it back.

You MUST use doom3\darkmod\tdmlauncher.exe to run Dark Mod in Windows and NOT Doom3.exe.

You do NOT need to extract the pk4 archives to install or play. Just download into or move the pk4 into the darkmod\fms folder. Optionally you can create a folder of the same name as the map and put it in there, eg, darkmod\fms\chalice but there is no need because Dark Mod will create that automatically. Just make sure your pk4 goes, unopened, into the fms folder then run tdmlauncher.exe

If you have done the above but see for example, a blank objectives screen and no briefing then it is still almost certainly an install error. I recommend you do a clean sweep if in doubt:
* exit Dark Mod
* delete doom3\darkmod\currentfm.txt (this just uninstalls any FM)
* Delete the map game folder (if any) This is NOT the folder in fms but the folder in doom3 of the same name as the FM, eg, doom3\chalice. Note: this has savegames and screenshots in so check and move them out if you want to preserve them. However, if you can't get the game to play it's likely you don't have any yet. If you can't see the folder don't worry. The folder name is normally the same as the pk4 but it might not be. Strictly speaking it must be the same as the name in startingmap.txt inside the pk4 archive. You might see this file in fms.
* Move the pk4 into the darkmod\fms folder if it is not already there.
* Delete the darkmod\fms\FMname folder if any, eg, darkmod\fms\chalice. Don't worry if there isn't one; it will be created automatically later.

So all that is left is the pk4 in the fms folder. Now run tdmlauncher.exe. The FM should be in the list in the New Missions menu. Re-install it and you should now be able to play it.

=== The game crashes on load ===
Make sure that:
* You installed [[#Patching_Doom_3_to_verson_1.3.1.1304|the correct version]] of the Doom 3 1.3.1 patch.
* Your system meets at least the minimum system specs.
* You have enough free main memory. Try closing a few running programs like Outlook, Anti-Virus or torrent clients.

==== Unknown event 'moveToCoverFrom'" ====
If you get a message like:

ERROR: Error: file script\doom_events.script, line 1038: Unknown event 'moveToCoverFrom'

or see this in the log:

found DLL in pak file: C:\Program Files\Doom 3\darkmod\tdm_game01.pk4/gamex86.dll
copy gamex86.dll to C:\Program Files\Doom 3\darkmod\gamex86.dll
could not create destination file

then try extracting that gamex86.dll manually from '''tdm_game01.pk4''' with Winzip or a similiar program into that folder.

The reason is very probably that you installed Doom3 into a folder with a space in it, and it seems Doom3 does not like that. Sorry.

=== Unknown event 'setEntityRelation' ===
The game is crashing to a small blue screen on startup:

[[Image:ErrorSetEntityRelation.jpg]]

The reason for this error is most likely an old version of gamex86.dll (or gamex86.so) lying around in your Doom 3 folder. Delete that file and try again.

=== Textures are missing, screen mostly black ===

[[Image:Tdm missing textures.jpg|right|240px|Black textures]]

Look into your '''DoomConfig.cfg''' inside your <tt>darkmod</tt> folder and check that the
following settings are like shown below:

<pre style="max-width:35em">
seta image_usePrecompressedTextures "1"
seta image_useNormalCompression "2"
seta image_useAllFormats "1"
seta image_useCompression "0"
seta image_preload "1"
</pre>

=== The briefing is very fuzzy ===

Look into your '''DoomConfig.cfg''' inside your <tt>darkmod</tt> folder and check that the
following settings are like shown below:

seta image_roundDown "1"
seta image_forceDownSize "0"
seta image_downSize "0"

=== The sky is corrupted ===

You either see black sky, or fragments of other textures. This seems only to happen on Geforce 6800 cards.

There are two fixes for this:

As a quick fix you can rename the following folder:

env/skyboxes/skybox_darkland_ne

to an different name. That will result in black sky.

Alternatively, edit the file <tt>materials/tdm_sky.mtr</tt> with '''Wordpad''' or a different editor and
find the sky material named '''textures/darkmod/nature/skybox/skybox_darkland_NE''':

<pre>
//Author: Dram
//skybox_ocean with ocean replaced with dark land
//Moon moved to north east by Fidcal
textures/darkmod/nature/skybox/skybox_darkland_NE
{
qer_editorimage env/skyboxes/skybox_ocean/ocean_ed
noFragment
noshadows
noimpact
nooverlays
forceOpaque
{
forceHighQuality
blend add
cameraCubeMap env/skyboxes/skybox_darkland_ne/darkland_NE
texgen skybox
texgen wobblesky .0 .0 .0
}
}
</pre>

In this declaration, comment out the line that reads '''forceHighQuality''' by adding <tt>//</tt> in front of it:

// forceHighQuality

That should fix the sky and make it render correctly.

=== Sky rotates ===

If you see the sky spinning it may be an ATI graphics card problem. One report says this was cured by turning off Catalyst AI. Also gives better loading times and cures bloom problem.

=== Bloom problems ===

If have a problem with bloom it may be an ATI graphics card problem. One report says this was cured by turning off Catalyst AI. Also gives better loading times and cures spinning sky problem.

=== The game is '''very''' slow! ===

If you get loading times of 5 minutes or more, less than 10 FPS, or the game even stutters, please try this:

Look into your '''DoomConfig.cfg''' inside your <tt>darkmod</tt> folder and check that the
following settings are like shown below:

<pre style="max-width:35em">
seta image_usePrecompressedTextures "1"
seta image_useNormalCompression "2"
seta image_useAllFormats "1"
seta image_useCompression "1"
seta image_preload "1"
</pre>

If that doesn't help, your system might run out of memory. Either upgrade to more than 1 Gbyte memory,
or try to close some other applications before playing.

Please see also the article about [[Performance Tweaks]] to improve the performance.

=== Slow loading times ===

If you find an FM is very slow to load it may be an ATI graphics card problem. One report says this was cured by turning off Catalyst AI. Also cures bloom and spinning sky problem.

===Underwater performance poor===

If you get very low framerates underwater then try turning off bloom.

===Upside-down screen===

If you get an upside-down screen, try turning off bloom.

===Game freezes for several seconds when opening doors===
Solution to problems:

A) "game freezes and loads some data from hard drive while opening doors"

B) "while loading mission you are returned to the menu and need to restart loading"

is
DISABLE EAX 4.0 HD in Audio Settings menu.

===Game exits to menu after mission load, with renderpipe error in console===

'''Symptoms:''' Missions are installed properly and will load, but after they reach 100% you are returned to the main menu or objectives screen. If you open the console (Ctrl-Alt-~ on US keyboards), you see one/both of these errors:

ERROR: Failed to open \\.\pipe\dm_renderpipe

or

ERROR: idRenderSystemLocal::uncrop currentcrop <1

'''Solution:''' Some firewalls, notably ''Sunbelt Firewall'' (aka ''Kerio Firewall'') are known to interfere with TDM's lightgem, ''even when "disabled"''. To fix this problem, completely uninstall the firewall, and get a different one instead.

== Known bugs ==
See article [[Known Bugs]].

=== Changing the screen resolution/aspect ratio does nothing!? ===
These changes require a restart of Doom to work.

[[Category:General]] [[Category:Installation]]

FAQ

2009-11-10T05:13:34Z

Crispy: /* Troubleshooting */ tdm_update crashing solution

{{important|headline=Important|text=This FAQ relates to the full TDM release version only. For players of the pre-release demos such as '''[[Thief's Den]]''' and '''[[Saint_Lucia|Tears of Saint Lucia]]''' please refer to the '''[[FAQ (Demo Releases)|Demo FAQ]]'''.'''}}

== What Doom versions are supported? ==

=== Can I use the Demo version of Doom 3? ===

No, sorry.

=== Does it run with the Steam version of Doom 3? ===

Yes :) You need to install the mod into the directory where Steam put Doom3, this might be under:

C:\Program Files\Steam\steamapps\common\doom 3

or a similiar folder.

== Patching Doom 3 to verson 1.3.1.1304 ==

=== How can I check whether my Doom 3 is correctly patched? ===

Open Doom 3 and hit {{key|Ctrl}}+{{key|Alt}}+{{key|~}} (tilde, {{key|^}} on German keyboards) to open the console. You'll see the version printed in the lower left corner of the console. It should read '''1.3.1.1304'''. If your version is ending on 1302, you've got the wrong patch installed.

=== Where can I get the right patch? ===

We have the patch hosted on our FTP. See the [[Installation]] article to find a link to it.

If you have version 1.3.1.1302, you may need to uninstall and reinstall before patch 1.3.1.1304 will let you apply it.

=== What's that issue with the 1.3.1 patch? ===

When the 1.3.1 patch was released by Id, they released it a bit too early. Some download sites picked it up quite fast though and started to distribute it. The problem is, that Id replaced that patch with a different one, and, probably thinking that it hadn't spread yet, didn't bother to change the version number. However, you can still find "wrong" 1.3.1 patches and these will not work with the mod. That's why it is important to check the version number in the console to make sure that the right 1.3.1 patch is installed if the mod doesn't work. The link provided here on our own page points to the correct patch, so if you downloaded it from here you don't need to worry about it.

== Supported Operating Systems ==

=== Which Windows versions can I use? ===

Doom 3 needs at least Windows XP or Windows 2000. Saint Lucia was successfully run under Windows XP and Vista. Support for 64 bit Windows or Windows 2000 was not tested.

=== Does it run in Linux? ===
Yes, Linux is supported.
=== Does it run in 64 Bit Linux? ===
Yes, Linux 64 bit is supported. In addition to the steps above, you need 32 bit compatibility libraries, since Doom3 is 32 bit only:
* On '''SuSE''', they should be included.
* On Ubuntu/Kubuntu, install the package '''ia32'''.
* Since you cannot install 32 bit libraries on a 64 bit system with the normal package manager, you should use [http://ubuntuforums.org/showthread.php?t=474790 getlibs] to install '''libmng''' and the boost filesystem lib:
:<code>getlibs libmng.so.1</code>
:<code>getlibs -l libboost-filesystem1.34.1</code>

=== What about Gentoo? ===
Should work too.
=== What about Ubuntu 8.10? ===
Yes. As of this writing you will need to install the '''libboost-filesystem''' package.

=== GLIBCXX_3.4.9 errors ===

If you receive an error about <tt>GLIBCXX_3.4.9</tt>, delete or rename the files <code>/usr/local/games/doom3/libstdc++.so.6</code> and <code>/usr/local/games/doom3/libgcc_s.so.1.</code>

=== Does it run on Mac OS X?===
No. Or at least not yet. The Doom 3 game itself does support Mac OS X, but The Dark Mod currently does not because we don't have any developers who use Macs. If you can help us getting it to run on OS X, please [http://modetwo.net/darkmod/index.php?showforum=11 let us know on the forum].

Since TDM works on Linux already, getting it working on OS X should not be too difficult for anyone with experience programming for that platform. In theory it's just a question of figuring out how to build the mod, sorting out dependencies, and writing a few pieces of platform-specific code.

== Graphics ==

=== Does TDM support widescreen resolutions? ===

Yes. Choose "16:9" or "16:10" in the in-game ''Settings'' menu, and select the appropriate resolution. Note that you need to restart the game to have the new setting in effect.

If the native resolution of your wide screen monitor is not listed, you can enter it into '''DoomConfig.cfg''' by changing the following entries like so:

set r_mode -1
set r_customwidth 1280
set r_customheight 800

Note that if you get performance problems, it might be better to halve the resolution in both directions. Please see also [[Performance Tweaks]].

== Troubleshooting ==

It is hard to answer question on why something fails, because wildly different systems cause wildy different symptoms. If the following section does not help you, please ask at out our [http://www.modetwo.net/darkmod forums].

=== Updater closes almost as soon as it's started ===

See the [[Tdm_update#Updater_closes_almost_as_soon_as_it.27s_started|main article on tdm_update]].

=== FM downloaded but won't play ===

If you have downloaded an FM you might see it in the New Missions List but can't get it to play. These are almost always an install problem. These are some of the causes and cures:

FMs (fan missions) are archives and MUST be suffixed .pk4 not zip. Apparently Internet Explorer 8 may change it from pk4 to zip during download without telling you. You need to rename it back.

You MUST use doom3\darkmod\tdmlauncher.exe to run Dark Mod in Windows and NOT Doom3.exe.

You do NOT need to extract the pk4 archives to install or play. Just download into or move the pk4 into the darkmod\fms folder. Optionally you can create a folder of the same name as the map and put it in there, eg, darkmod\fms\chalice but there is no need because Dark Mod will create that automatically. Just make sure your pk4 goes, unopened, into the fms folder then run tdmlauncher.exe

If you have done the above but see for example, a blank objectives screen and no briefing then it is still almost certainly an install error. I recommend you do a clean sweep if in doubt:
* exit Dark Mod
* delete doom3\darkmod\currentfm.txt (this just uninstalls any FM)
* Delete the map game folder (if any) This is NOT the folder in fms but the folder in doom3 of the same name as the FM, eg, doom3\chalice. Note: this has savegames and screenshots in so check and move them out if you want to preserve them. However, if you can't get the game to play it's likely you don't have any yet. If you can't see the folder don't worry. The folder name is normally the same as the pk4 but it might not be. Strictly speaking it must be the same as the name in startingmap.txt inside the pk4 archive. You might see this file in fms.
* Move the pk4 into the darkmod\fms folder if it is not already there.
* Delete the darkmod\fms\FMname folder if any, eg, darkmod\fms\chalice. Don't worry if there isn't one; it will be created automatically later.

So all that is left is the pk4 in the fms folder. Now run tdmlauncher.exe. The FM should be in the list in the New Missions menu. Re-install it and you should now be able to play it.

=== The game crashes on load ===
Make sure that:
* You installed [[#Patching_Doom_3_to_verson_1.3.1.1304|the correct version]] of the Doom 3 1.3.1 patch.
* Your system meets at least the minimum system specs.
* You have enough free main memory. Try closing a few running programs like Outlook, Anti-Virus or torrent clients.

==== Unknown event 'moveToCoverFrom'" ====
If you get a message like:

ERROR: Error: file script\doom_events.script, line 1038: Unknown event 'moveToCoverFrom'

or see this in the log:

found DLL in pak file: C:\Program Files\Doom 3\darkmod\tdm_game01.pk4/gamex86.dll
copy gamex86.dll to C:\Program Files\Doom 3\darkmod\gamex86.dll
could not create destination file

then try extracting that gamex86.dll manually from '''tdm_game01.pk4''' with Winzip or a similiar program into that folder.

The reason is very probably that you installed Doom3 into a folder with a space in it, and it seems Doom3 does not like that. Sorry.

=== Unknown event 'setEntityRelation' ===
The game is crashing to a small blue screen on startup:

[[Image:ErrorSetEntityRelation.jpg]]

The reason for this error is most likely an old version of gamex86.dll (or gamex86.so) lying around in your Doom 3 folder. Delete that file and try again.

=== Textures are missing, screen mostly black ===

[[Image:Tdm missing textures.jpg|right|240px|Black textures]]

Look into your '''DoomConfig.cfg''' inside your <tt>darkmod</tt> folder and check that the
following settings are like shown below:

<pre style="max-width:35em">
seta image_usePrecompressedTextures "1"
seta image_useNormalCompression "2"
seta image_useAllFormats "1"
seta image_useCompression "0"
seta image_preload "1"
</pre>

=== The briefing is very fuzzy ===

Look into your '''DoomConfig.cfg''' inside your <tt>darkmod</tt> folder and check that the
following settings are like shown below:

seta image_roundDown "1"
seta image_forceDownSize "0"
seta image_downSize "0"

=== The sky is corrupted ===

You either see black sky, or fragments of other textures. This seems only to happen on Geforce 6800 cards.

There are two fixes for this:

As a quick fix you can rename the following folder:

env/skyboxes/skybox_darkland_ne

to an different name. That will result in black sky.

Alternatively, edit the file <tt>materials/tdm_sky.mtr</tt> with '''Wordpad''' or a different editor and
find the sky material named '''textures/darkmod/nature/skybox/skybox_darkland_NE''':

<pre>
//Author: Dram
//skybox_ocean with ocean replaced with dark land
//Moon moved to north east by Fidcal
textures/darkmod/nature/skybox/skybox_darkland_NE
{
qer_editorimage env/skyboxes/skybox_ocean/ocean_ed
noFragment
noshadows
noimpact
nooverlays
forceOpaque
{
forceHighQuality
blend add
cameraCubeMap env/skyboxes/skybox_darkland_ne/darkland_NE
texgen skybox
texgen wobblesky .0 .0 .0
}
}
</pre>

In this declaration, comment out the line that reads '''forceHighQuality''' by adding <tt>//</tt> in front of it:

// forceHighQuality

That should fix the sky and make it render correctly.

=== Sky rotates ===

If you see the sky spinning it may be an ATI graphics card problem. One report says this was cured by turning off Catalyst AI. Also gives better loading times and cures bloom problem.

=== Bloom problems ===

If have a problem with bloom it may be an ATI graphics card problem. One report says this was cured by turning off Catalyst AI. Also gives better loading times and cures spinning sky problem.

=== The game is '''very''' slow! ===

If you get loading times of 5 minutes or more, less than 10 FPS, or the game even stutters, please try this:

Look into your '''DoomConfig.cfg''' inside your <tt>darkmod</tt> folder and check that the
following settings are like shown below:

<pre style="max-width:35em">
seta image_usePrecompressedTextures "1"
seta image_useNormalCompression "2"
seta image_useAllFormats "1"
seta image_useCompression "1"
seta image_preload "1"
</pre>

If that doesn't help, your system might run out of memory. Either upgrade to more than 1 Gbyte memory,
or try to close some other applications before playing.

Please see also the article about [[Performance Tweaks]] to improve the performance.

=== Slow loading times ===

If you find an FM is very slow to load it may be an ATI graphics card problem. One report says this was cured by turning off Catalyst AI. Also cures bloom and spinning sky problem.

===Underwater performance poor===

If you get very low framerates underwater then try turning off bloom.

===Upside-down screen===

If you get an upside-down screen, try turning off bloom.

===Game freezes for several seconds when opening doors===
Solution to problems:

A) "game freezes and loads some data from hard drive while opening doors"

B) "while loading mission you are returned to the menu and need to restart loading"

is
DISABLE EAX 4.0 HD in Audio Settings menu.

===Game exits to menu after mission load, with renderpipe error in console===

'''Symptoms:''' Missions are installed properly and will load, but after they reach 100% you are returned to the main menu or objectives screen. If you open the console (Ctrl-Alt-~ on US keyboards), you see one/both of these errors:

ERROR: Failed to open \\.\pipe\dm_renderpipe

or

ERROR: idRenderSystemLocal::uncrop currentcrop <1

'''Solution:''' Some firewalls, notably ''Sunbelt Firewall'' (aka ''Kerio Firewall'') are known to interfere with TDM's lightgem, ''even when "disabled"''. To fix this problem, completely uninstall the firewall, and get a different one instead.

== Known bugs ==
See article [[Known Bugs]].

=== Changing the screen resolution/aspect ratio does nothing!? ===
These changes require a restart of Doom to work.

[[Category:General]] [[Category:Installation]]

Tdm update

2009-11-10T05:10:45Z

Crispy: temp folder fix

'''tdm_update''' is the primary method to install and update The Dark Mod.

== Where to get it ==

Each of our mirrors contains a copy of the updater. Get it from here:

* Download from www.keepofmetalandgold.com: [http://www.keepofmetalandgold.com/files/tdm/tdm_update_win.zip Windows] or [http://www.keepofmetalandgold.com/files/tdm/tdm_update_linux.zip Linux]
* Download from www.fical.com: [http://www.fidcal.com/darkuser/tdm_update_win.zip Windows] or [http://www.fidcal.com/darkuser/tdm_update_linux.zip Linux]
* Download from www.southquarter.com: [http://www.southquarter.com/tdm/tdm_update_win.zip Windows] or [http://www.southquarter.com/tdm/tdm_update_linux.zip Linux]
* Download from www.shadowdarkkeep.com: [http://www.shadowdarkkeep.com/files/tdm/tdm_update_win.zip Windows] or [http://www.shadowdarkkeep.com/files/tdm/tdm_update_linux.zip Linux]
* Download from roggen.jmnet.us: [http://roggen.jmnet.us/darkmod/tdm_update_win.zip Windows] or [http://roggen.jmnet.us/darkmod/tdm_update_linux.zip Linux]
* Download from www.bloodgate.com: [http://www.bloodgate.com/mirrors/tdm/pub/pk4/tdm_update_win.zip Windows] or [http://www.bloodgate.com/mirrors/tdm/pub/pk4/tdm_update_linux.zip Linux]

== Use it to '''install''' TDM ==

Unzip the downloaded archive and place:

* Windows: tdm_update.exe into '''C:\Games\Doom3\darkmod''' (or wherever Doom 3 is installed) and run it
* Linux: tdm_update.exe into '''~/.doom3/darkmod''' and run it

Note: You must either create the "darkmod" folder by yourself, or place the program directly into the Doom 3 folder so it can create the folder for you.

== Use it to '''update''' TDM ==

Simple navigate to your darkmod folder and run tdm_update.

== Troubleshooting ==

=== Updater closes almost as soon as it's started ===

Clear out your temp folder, as follows:

# Click Start
# Click Run
# Type <tt>%temp%</tt> and press enter (make sure you include the % signs) (if this step doesn't work, try navigating to it - see below for the path)
# Select all (Ctrl-A) and (Delete).

On Windows Vista, the temporary folder in question is usually at <tt>C:\Users\[your Windows user name]\AppData\Local\Temp</tt>. On Windows XP, look in <tt>C:\Documents and Settings\[your Windows user name]\Application Data\Local Settings\Temp</tt>.

== See also ==

* [[FAQ]] - Frequently Answered Questions

Speed, AI

2009-11-08T00:31:24Z

Crispy: more categories

#redirect[[Animation playback speed]]

{{tutorial-ai}}

The Dark Mod Gameplay

2009-11-07T00:54:20Z

Crispy: /* Manipulating Junk Objects */

''author: Springheel''

Since The Dark Mod is designed to simulate the stealth gameplay of Thief, many things will be very familiar to Thief players. There are some features that work differently, however, and some features are only partially working in the 1.0 Beta version. The following guide will explain how things work (for what doesn't work yet, see [[Known Bugs]]) in The Dark Mod.

If you have never played Stealth Games before, start with the [[Basics of Stealth Gaming]].

Veteran stealth gamers can read the various sections below for more detail:

= The Game Menus =

Your experience with The Dark Mod will start with the Main Menu, where you may wish to adjust some settings before starting your first mission. If you already have saved games from a currently installed mission, you can load them from the Load/Save menu.

== Starting a Mission ==
[[Image:new_mission.jpg|thumb|The New Mission menu.]]

# Select ''New Mission'' from the Main Menu.
# Select a Mission from the list (start with the Training Mission if this is your first time) and click ''Install Mission''.
# TDM will install the mission and restart. Select ''New Mission'' again, and click ''Start Mission''
# You will see a briefing that introduces the mission. Click ''Objectives'' to proceed.
# Read your objectives, and choose your Difficulty Level. Then select ''Buy Equipment'' (or ''Start Mission'' in some missions).
# After purchasing desired equipment, hit ''Start Mission''. (The option to ''Drop'' starting items is available, but use with caution...dropping some items may make a mission impossible to complete)
# The Mission Loading screen should appear. Be patient...loading a mission for the first time can take several minutes.

To call the Main Menu during the game, press {{key|ESC}}) .

See [[Installing and Running Fan Missions]] for more information.

== Changing Settings ==

# Select ''Settings'' from the Main Menu
# Select the type of setting you wish to adjust: ''Audio'', ''Video'', ''Controls'', or ''Gameplay''
# The controls are set to defaults familiar to ''Thief'' players, however there are new keys/features that are worth reviewing.

== Objectives ==

When you call the Main Menu during a mission (by hitting the ESC key), you will see an option for "Objectives". This is where you can check your progress.

Your objectives are also displayed after the Mission Briefing when you first start a mission.

When you complete an objective, a chime will sound and “Objective Completed” will be displayed at the top of the screen.

When you have completed all objectives, the map will close and a “Mission Succeeded” screen will appear. Likewise, if you fail an objective or are killed, a “Failed Mission” screen will appear. You can restart the map by selecting the "Restart" option or via the Main Menu.

----

= HUD Display =

[[Image:hud.jpg|thumb|The Game Screen indicators.]]

1. WEAPON ICON: An icon of your currently selected weapon is displayed in the bottom left corner of the screen.

2. BREATH INDICATOR: When you are underwater a small blue bar will appear above the lightgem. This bar measures how much air you have left. When the blue bar runs out, you start to take damage. Surfacing or using a Breath Potion will restore your air bar.

3. LIGHTGEM: The lightgem at the bottom of the screen indicates how easy you are to see. This is primarily due to how much light is hitting you, but also includes things like whether you are crouched, moving, or have a weapon drawn.

4. HEALTH INDICATOR: When you are injured, a small red healthbar appears below the lightgem. It will remain visible until you are returned to full health.

5. INVENTORY ICON: Your currently selected inventory object (or your loot total) is displayed as an icon in the bottom right.

== Weapons ==

Weapon hotkeys were changed at the last minute, so this list may need modifying:
* {{key|`}} Put away weapons
* {{key|1}} Blackjack
* {{key|2}} Short Sword
[[Image:arrows.jpg|thumb|A selection of arrows you can choose from.]]
* {{key|3}} Broadheads
* {{key|4}} [[Water Arrows]]
* {{key|5}} [[Fire Arrows]]
* {{key|6}} [[Rope Arrows]]
* {{key|7}} [[Gas Arrows]]
* {{key|8}} [[Noise Arrows]]
* {{key|9}} [[Moss Arrows]]

''(note that there has been a report that linux users cannot use the {{key|`}} as it is mapped to the console. Linux users will need to select a different key for 'Put away weapons'.)''

== Inventory Objects ==
Cycle through your inventory using the Inventory Prev/Next keys (default: {{key|[}} or {{key|TAB}} for next item and {{key|]}} for prev item). Inventory objects are stored in groups, so all keys will be stored together, all readables, etc. You can cycle through groups with the Prev/Next Group keys.

To ‘use’ an inventory object, select it and then hit the Use key (default: {{key|U}}). This will drink potions, throw mines, activate the spyglass, etc. To "use" objects on other objects (like using a key on a door), select the object in inventory, highlight the thing you want to use it on, and hit Use.

You can drop inventory items by hitting the Drop key (default: {{key|R}}) twice. See the section "Holding Junk Objects" for more information. Note that mappers may designate some important inventory items as undroppable.

You can clear the inventory selection by hitting the {{key|BACKSPACE}} key.

To set hotkeys for your inventory items, please see [[Custom Settings for Players]].

=== Inventory Object: Flashbomb ===
[[Image:equipment.jpg|thumb|The tools of a professional burglar.]]
Activate a flashbomb by selecting it in inventory and hitting Use. Flashbombs detonate on impact. A short tap will cause it to fall and go off at your feet. Holding down the Use key will throw the flashbomb further away. If you use the Drop key to put the flashbomb down, it is not activated at all.

An AI must be looking at the flashbomb to be blinded. Don't look at the point of impact or you'll be blinded too.

AI are only blinded for a few seconds, and they are alerted by the flash, so this tool is most useful for getting away when you've been spotted.

Flashbombs have no affect on the undead.

=== Inventory Object: Holy Water ===

Select your holy water in inventory and hit the Use key. This puts holy water into your water arrows, making them lethal to undead. The effect is temporary (lasts 30 seconds) so use it wisely. (Note that there are no zombies in the beta version of TDM.)

=== Inventory Objects: Keys ===
Some doors or chests require keys to open. To open a locked door, select the appropriate key by scrolling to it in your inventory and hit the Use key (or the Frob key if you wish) while highlighting the door. Note that certain types of door locks (like padlocks) might have to be frobbed separately.

=== Inventory Objects: Lockpicks ===
See [[#Lockpicking|Lockpicking]] for more information on lockpicks.

=== Inventory Objects: Maps and Readables ===

In The Dark Mod, both maps and most readables (books, scrolls, etc) are inventory items. To read them, you scroll to the object in your inventory and then hit the Use key. The map or readable will be displayed on screen. Note that '''this does not pause the game'''. Unlike Thief, events continue to unfold around you, and you can be attacked while reading if not careful. You can see your environment around the edges of the map/readable, but the best suggestion is to find a safe place to read. With multi-page readables (distinguishable by folded corners on the page), use the next/prev inventory or next/prev weapon keys to scroll through pages. Hitting Use or Attack will put the readable away.

The Map key (default: {{key|M}}) will also automatically bring up your map, if you have one.

=== Inventory Object: Mines ===

Place a mine by selecting it in inventory and hitting Use. A short tap will drop the mine at your feet. Holding down Use will throw the mine further away. Once activated in this way, a mine is armed and will go off if stepped on. If you use the Drop key to put the mine down, it is not armed.

Mines are currently not very sensitive and AI can occasionally step right over them without setting them off. Note that you can set mines off by shooting them with an arrow.

=== Inventory Object: Player Lantern ===

Light is usually the bane of thieves everywhere, but there are times when you need just a little to make your way around. To this end, some thieves carry a covered lantern with a hood that can be closed to block out the light. To use the lantern, select it in inventory and hit Use. This will lift the cover if the lantern is currently off, or close the cover if it is currently lit. There is also a hotkey for using the lantern; by default this is {{key|L}}. This lantern is clipped to your belt so your hands are free, and it can even be used underwater for short periods.

Obviously using the lantern makes you clearly visible to any nearby opponents.

=== Inventory Object: Potions ===

Potions are used by selecting them in inventory and hitting Use. Healing potions will restore hit points (the effect is somewhat gradual). Breath potions increase the player's breath meter, allowing them to stay underwater longer.

=== Inventory Object: Spyglass ===

A good Thief likes to scout ahead. To use the spyglass, select it in inventory and hit Use. You can use the next/prev weapon keys to zoom in and out. You cannot use weapons or frob objects while using the spyglass.

= Movement =

Movement in The Dark Mod is not that different than Thief. You can run, walk, or creep, as well as do any of the three while crouching. The faster you move, the more noise you make.

== Climbing ==

''needs revising''

Ladder/vine climbing:

Rope climbing:

=== Swinging on Ropes ===

Tapping the "attack" key while on a rope will cause the rope to swing forward. You can actually gain more momentum by continuing to tap it every time you start swinging forward (think of it like swinging your legs forward on a swing). This can allow you to jump off the rope and grab ledges that are otherwise too far away.

Note that the further down the rope you are, the more distance you can travel when swinging (just like a real rope).

== Mantling ==
There are two different ways to mantle (pull yourself up onto ledges) in The Dark Mod. One is by holding down the Jump key, which Thief players will be familiar with. There is also a key specifically for mantling (default: {{key|
C}}), so that failing to mantle will not result in jumping and making noise. Ideally there should be no difference in these methods, but occasionally one method will work when the other will not.
Mantling is affected by where you are looking, so a successful mantle is more likely if you are looking directly at the edge of the object you wish to climb. To climb on a chair, look down at the seat then press the mantle control. By this means you can clamber over relatively low but awkward obstructions and even select one ledge above/below another.

You cannot mantle while carrying a junk object or body.

= Interacting With Your Environment =

The Dark Mod gives you far more flexibility than previous Thief games when it comes to interacting with things.

== Manipulating Junk Objects ==
This is one area that works quite differently from the Thief series. “Junk” objects (anything that you can carry that doesn’t go into inventory, like chairs, candles, or bodies) are held out in front of you when frobbed. Unlike in Thief, they take up physical space, and can be used to push or manipulate other objects. They can also bump into other objects, making noise (or being knocked out of your hands), so be careful.

To grab a junk object, frob it as normal. The object will stop highlighting, and any weapons you have selected will lower. At this point, you can use the next/prev weapon keys (default: mousewheel up/down) to move the object closer/further away from you, and moving your mouse around will move the object (it stays basically in the center of your screen).

The heavier the object, the slower it moves, so you may notice a ‘lag’ if you turn quickly with heavy objects. It can take a while to get used to this.

To drop an object, hit the Drop key (default: {{key|R}}). By crouching and angling your view down gently, you'll find that you can easily set down objects without making noise. You can also throw a held object by hitting the Attack key. Tapping the Attack key throws the object a short distance; holding the Attack key down and releasing it will throw it further.

To rotate a held object, hold down the {{key|Z}} key or middle mouse button, and move your mouse.
(By default, horizontal movement of the mouse yaws the object around the vertical axis, and vertical movement pitches the object up and down. Holding down the Run key makes horizontal mouse movement roll the object around the forward axis.) This can be useful for replacing objects that have been knocked over, or for placing moveable objects in creative ways (like putting a plank over a gap, or stacking chairs).
It is possible to “drop” inventory items into your hands, where they can be manipulated as if they were junk objects. Select the object in your inventory, and hit the Drop key {{key|R}}. The object will appear in front of you like a junk object, and you can rotate it, set it down, etc. To put it back into your inventory, you must "use" the item again ({{key|U}}) or scroll to the next inventory item ({{key|TAB}} or {{key|[}}/{{key|]}}).
[[Image:candles6.jpg|thumb|[http://www.youtube.com/watch?v=922ArtrKgC4 Click to see TDM candles in action.] ]]
AI will hear junk objects that are dropped or banged around. It takes some skill to pick up objects on a crowded table without knocking them into each other. Remember than an object moves to the center of the screen when you pick it up. If you are looking slightly above the object, it will jump up to center screen (usually a good thing). If you're looking slightly below the object, it will jump down, banging whatever surface it rests on (a bad thing). A little practice may be required to smoothly and quietly sort through objects.

Some objects that are too heavy to lift may still be movable (like large crates). Walking or running into such objects may (mapper's choice) push them along the ground.

=== Junk Objects: Candles ===

Lit candles can be frobbed and carried around to light your way (obviously you will be easily spotted while carrying a lit candle). They can also be used to light flammable objects like other candles or torches. Click the caption on the right for a demonstration.

Candles can be extinguished by water, or you can pinch them out by picking them up and clicking the Use key. (Note that this method can also be used on some movable lanterns).

Be aware that multiple light sources can cause a significant drain on your framerate. If you go around a room lighting six or seven new candles, don't be surprised if your framerate drops significantly.

=== Junk Objects: Bodies ===

Bodies work differently than most other objects. There are two ways to deal with dead or unconscious bodies in The Dark Mod. You can both drag them and carry them.

To drag a body, you must ‘frob’ it (which probably requires crouching), and then back away. The body will drag along with you until you frob it again or the body gets stuck on something.

This is not the most graceful way of moving bodies and is not recommended for long distances. Bodies can catch on things and get pulled out of your hands. It can be useful for quickly shifting a body into a shadow, however. You can even move individual limbs to put a flailing arm back into a shadow.

You can also carry a body over your shoulder. While a body is being dragged, hitting the Use button will lift it up over your shoulder. While carrying a body you move more slowly and cannot use weapons or inventory objects (though you can open doors). When you are ready to drop the body, hit Use again. If there is not enough room, you will hear a grunt and nothing will happen. Back up a bit and try again. When you drop a body, it will be the opposite orientation from the way you picked it up (if a body is face-up when you lift it, it will be face-down when you drop it). This allows you to easily search a body for keys or other objects.

== Doors ==
You can interrupt a door opening or closing by frobbing it again. Frobbing a moving door stops it, allowing you to open a door just a crack to peer beyond.

You can lean into a door (use the lean left/right keys) to press your ear up against it and hear what's on the other side. Note that while you're concentrating on what's beyond the door you'll be less able to hear the sounds in the room you're currently in.

Some doors or chests are locked and require keys (or lockpicks, see below) to open. To open a locked door, select the appropriate key by scrolling to it in your inventory and hit the Use key (or the Frob key if you wish) while highlighting the door. Note that certain types of door locks (like padlocks) might have to be frobbed separately.

== Lockpicking ==
You will definitely want to practice lockpicking in the Training Mission before trying a real map. Just reading the instructions is probably not enough to get the hang of it.

There are two types of lockpicks, 'triangle' and 'snake'. To begin, you must have the correct lockpick selected in inventory. If you do not, you will see a red flash behind the lockpick icon when you frob the locked door. To pick a lock, move close enough to highlight the door and hold the Use key. You will start to hear a sequence of clicks, and see the door handle (or lock pin) jiggle in sync.

The clicks are a random pattern. At the end of the pattern is a brief period of silence, then the pattern will begin again. To be successful you must hit the Attack key (or release the Use key if you prefer) at the start of that silence. If you hit the Attack key at the wrong time there is a dull 'fail' sound and the pattern begins again. Your goal is to learn the sequence of clicks so that you can anticipate when it will end. This requires concentration.

Some locks are more difficult than others and have multiple pins (which may require switching lockpicks). You can make lockpicking harder or easier in the Settings Menu, by adjusting how much silence there is between each pattern (the more silence, the easier it is to react in time). Setting Lockpicking to "Auto" will make locks open automatically after the pattern repeats 3 times.

== Chests ==
It can sometimes be a little awkward frobbing items inside deep chests. Leaning forward (or even sideways) will usually help.

If you get too close to a chest, you can sometimes get in the way of the lid opening or closing. Back up a little if the lid is not moving as expected.

----

= Combat =

There are a number of ways that combat is different in The Dark Mod.

Keep in mind that you are not a warrior. Guards are generally better trained than you are, and while you might win a few one-on-one battles, you will almost certainly die if facing two guards at once.

== Blackjacking ==

Your blackjack is more effective if your opponent is relaxed and not expecting trouble.

You must hit an AI on the head to knock them out. Hitting an AI anywhere else will simply alert them.

'''You can successfully knock out:'''

'''1. Unarmed civilian AI from any direction, any time.'''

'''2. Bare-headed guards from any direction when relaxed, or from behind when alert.'''

'''3. Helmeted guards from behind when relaxed (helmeted guards cannot be knocked out when alert).'''

The blackjack does a small amount of damage, so you could theoretically beat someone to death with it, if you have a lot of time on your hands.

Undead and some animals cannot be knocked out with the blackjack.

'''Note:''' the blackjack makes an overhead swing, so if there is something low in the way (like a doorframe) you might hit it instead of your target.

== Melee Combat ==
[[image:combat1.jpg|thumb|A guard winds up for an overhead attack]]
There is a combat arena in the Training Map for practicing combat. After a few rounds you will have a much better feel for how it works.

You can use your shortsword to attack an enemy, as well as block enemy weapons. Attacking a relaxed enemy (ie, backstabbing) does extra damage.
To attack, hit the Attack key. This will make a left-to-right, slashing attack. If you move the mouse while clicking the Attack key, you can select other kinds of attacks. Moving the mouse down will cause an overhead swing. Moving the mouse up will cause a thrust attack. Moving the mouse left or right will cause a right-to-left or left-to-right slash, respectively.

AI can parry your swings (unless they are using a dagger), and they will do this more easily if you keep using the same kind of attack, so you will want to mix it up.

The amount of damage you do varies depending on where you hit. Hitting an AI in the head will do more damage than hitting their arm or leg. Armour also plays a factor. Your sword can't penetrate plate armour, and even chainmail or leather armour will provide the AI some protection.

To block an enemy strike, hold the Parry key. If you have the "Auto Parry" option selected in the Main Menu, you will automatically select the appropriate block. You must hit the block key just as the AI is winding up for their attack--too late and you'll get hit before the block is ready. Too early and the AI will see the block and choose a different attack. Obviously, you must also be facing the AI...holding up a block while looking off to the side won't help.

If you are using Manual Parry (select in the Settings menu), you need to select the appropriate block yourself by moving the mouse while holding the Parry button down.

If you successfully block an attack or damage your opponent the AI will be temporarily "flat-footed". They can still attack and defend, but they will not chase you if you turn to run. The effect lasts only a second or two, but that can sometimes be enough time to give you a head start.

The trick to a successful combat is timing. You need to try to anticipate your opponent's attacks, and then launch counter-attacks before he has a chance to parry.

AI will usually try to flee if they are badly wounded.

== Missile Combat ==

Your broadhead arrows cannot penetrate plate armour, and will do less damage if they hit chain or leather armour. The best result is to hit unarmoured flesh. A single arrow to the head will kill a relaxed guard. Alert guards are assumed to be taking measures to minimize the damage from incoming arrows.

If you are hit while trying to fire an arrow, your attack will be canceled.

AI will switch to missile combat if they can see you but cannot reach you. If they don't have a missile weapon, they will become angry and start throwing whatever they can get their hands on (currently, that means wine bottles).

AI archers will fire arrows at you. Some AI are better shots than others. Hitting an AI archer does NOT cancel their attack at the moment, which makes AI archers a challenge to defeat. This will probably change in the future, as AI archers are not fully playtested yet.

----

= AI =

The AI of TDM 1.0 still have some rough edges, but in general they are formidable opponents.

== AI Senses ==

AI can see you if your lightgem is not totally black. The longer you're in their field of vision, the more likely they are to notice you and come and investigate.

AI can hear your footsteps, and noise that you make from banging into things or dropping objects.

AI can also feel you if you bump into them, or vice versa.

TDM AI are fairly intelligent about searching. They can identify good hiding spots and will check them out first.

When AI become alert, their acuity actually goes up. A shadow that is sufficient to hide you from a relaxed AI might not be enough for an AI that is alert and actively looking for trouble.

AI do not forget about you after giving up the search. They remain in an alert state, with higher senses and their weapons out.

== AI Behaviour ==

AI need to see evidence in order to react to it. If a bloodstain or missing loot is in shadow, an AI won't notice it.

AI can react to missing objects or lights being put out, but only if mappers set the objects/lights as noteworthy. AI can potentially relight lights, if a mapper chooses.

AI become suspicious if they find a weapon lying around. Finding blood or a body will cause them to go fully alert.

AI can hear broadhead arrow impacts. If you shoot an arrow and it hits a wall nearby, the AI will notice. AI will also react to water arrows if you fire them too close (or if you hit an AI with one).

AI do not yet notice moss arrow impacts, moss patches, ropes from rope arrows, open doors, or mines. These things will likely cause minor alerts in the future.

[[Category:Gameplay]]

Walking speed of AI

2009-11-07T00:52:39Z

Crispy: Redirecting to Animation playback speed

#REDIRECT [[Animation playback speed]]
{{tutorial-ai}}

Walking speed of AI

2009-11-07T00:51:57Z

Crispy: Redirecting to Animation playback speed

#REDIRECT [[Animation playback speed]]

Animation playback speed

2009-11-07T00:49:24Z

Crispy: categories

In TDM, you can change the speed at which an animation plays on an entity just by setting a spawnarg on that entity. The spawnarg to change is <tt>anim_rate_X</tt>, where X is an animation name. The animation's speed is multiplied by the spawnarg's value; 1.0 means no change, 0.5 means half speed, 2.0 means double speed, and so on.

For example, this spawnarg setting would cause the entity to walk at 95% of the usual speed:

<code>"anim_rate_walk" "0.95"</code>

You can use this to give different walk speeds to individual AIs, or to tweak the walk speed for entire classes of AI.

==Caveats==
* This only changes the animation's speed, not its character. You may not be able to vary e.g. the "purposefulness" of a walk by simply changing its playback speed; it could just look like it's in slow motion, or oddly sped up. Try experimenting to see how much you can get away with.
* Walk speed is '''crucial''' for game balance. It is very difficult to blackjack or backstab an AI that walks faster than the player can move without alerting it! So don't set the walk animation rate too high either.
* The speed of the walk animation appears to have an effect on how easily AI can climb stairs (and presumably slopes as well). The slower the walk animation is, the lower the stair has to be before the AI will be able to climb it. So don't set the walk animation rate too low. You could also try to work around this using [[Pathfinding#Steep_Steps.2C_Slopes.2C_and_Extreme_Pathfinding.21|extreme pathfinding]]. Don't worry about this too much, however, unless your AIs need to traverse unusually steep slopes. Small changes will usually be fine.
* If the animation itself has a setRate frame command (which accomplishes the same effect as this spawnarg) in the modelDef where it's defined, then the frame command will '''override''' this spawnarg.

[[Category:Animation]]
{{tutorial-ai}}

FAQ

2009-11-03T00:38:05Z

Crispy: renderpipe error with Sunbelt/Kerio Firewall

{{important|headline=Important|text=This FAQ relates to the full TDM release version only. For players of the pre-release demos such as '''[[Thief's Den]]''' and '''[[Saint_Lucia|Tears of Saint Lucia]]''' please refer to the '''[[FAQ (Demo Releases)|Demo FAQ]]'''.'''}}

== What Doom versions are supported? ==

=== Can I use the Demo version of Doom 3? ===

No, sorry.

=== Does it run with the Steam version of Doom 3? ===

Yes :) You need to install the mod into the directory where Steam put Doom3, this might be under:

C:\Program Files\Steam\steamapps\common\doom 3

or a similiar folder.

== Patching Doom 3 to verson 1.3.1.1304 ==

=== How can I check whether my Doom 3 is correctly patched? ===

Open Doom 3 and hit {{key|Ctrl}}+{{key|Alt}}+{{key|~}} (tilde, {{key|^}} on German keyboards) to open the console. You'll see the version printed in the lower left corner of the console. It should read '''1.3.1.1304'''. If your version is ending on 1302, you've got the wrong patch installed.

=== Where can I get the right patch? ===

We have the patch hosted on our FTP. See the [[Installation]] article to find a link to it.

If you have version 1.3.1.1302, you may need to uninstall and reinstall before patch 1.3.1.1304 will let you apply it.

=== What's that issue with the 1.3.1 patch? ===

When the 1.3.1 patch was released by Id, they released it a bit too early. Some download sites picked it up quite fast though and started to distribute it. The problem is, that Id replaced that patch with a different one, and, probably thinking that it hadn't spread yet, didn't bother to change the version number. However, you can still find "wrong" 1.3.1 patches and these will not work with the mod. That's why it is important to check the version number in the console to make sure that the right 1.3.1 patch is installed if the mod doesn't work. The link provided here on our own page points to the correct patch, so if you downloaded it from here you don't need to worry about it.

== Supported Operating Systems ==

=== Which Windows versions can I use? ===

Doom 3 needs at least Windows XP or Windows 2000. Saint Lucia was successfully run under Windows XP and Vista. Support for 64 bit Windows or Windows 2000 was not tested.

=== Does it run in Linux? ===
Yes, Linux is supported.
=== Does it run in 64 Bit Linux? ===
Yes, Linux 64 bit is supported. In addition to the steps above, you need 32 bit compatibility libraries, since Doom3 is 32 bit only:
* On '''SuSE''', they should be included.
* On Ubuntu/Kubuntu, install the package '''ia32'''.
* Since you cannot install 32 bit libraries on a 64 bit system with the normal package manager, you should use [http://ubuntuforums.org/showthread.php?t=474790 getlibs] to install '''libmng''' and the boost filesystem lib:
:<code>getlibs libmng.so.1</code>
:<code>getlibs -l libboost-filesystem1.34.1</code>

=== What about Gentoo? ===
Should work too.
=== What about Ubuntu 8.10? ===
Yes. As of this writing you will need to install the '''libboost-filesystem''' package.

=== GLIBCXX_3.4.9 errors ===

If you receive an error about <tt>GLIBCXX_3.4.9</tt>, delete or rename the files <code>/usr/local/games/doom3/libstdc++.so.6</code> and <code>/usr/local/games/doom3/libgcc_s.so.1.</code>

=== Does it run on Mac OS X?===
No. Or at least not yet. The Doom 3 game itself does support Mac OS X, but The Dark Mod currently does not because we don't have any developers who use Macs. If you can help us getting it to run on OS X, please [http://modetwo.net/darkmod/index.php?showforum=11 let us know on the forum].

Since TDM works on Linux already, getting it working on OS X should not be too difficult for anyone with experience programming for that platform. In theory it's just a question of figuring out how to build the mod, sorting out dependencies, and writing a few pieces of platform-specific code.

== Graphics ==

=== Does TDM support widescreen resolutions? ===

Yes. Choose "16:9" or "16:10" in the in-game ''Settings'' menu, and select the appropriate resolution. Note that you need to restart the game to have the new setting in effect.

If the native resolution of your wide screen monitor is not listed, you can enter it into '''DoomConfig.cfg''' by changing the following entries like so:

set r_mode -1
set r_customwidth 1280
set r_customheight 800

Note that if you get performance problems, it might be better to halve the resolution in both directions. Please see also [[Performance Tweaks]].

== Troubleshooting ==

It is hard to answer question on why something fails, because wildly different systems cause wildy different symptoms. If the following section does not help you, please ask at out our [http://www.modetwo.net/darkmod forums].

=== FM downloaded but won't play ===

If you have downloaded an FM you might see it in the New Missions List but can't get it to play. These are almost always an install problem. These are some of the causes and cures:

FMs (fan missions) are archives and MUST be suffixed .pk4 not zip. Apparently Internet Explorer 8 may change it from pk4 to zip during download without telling you. You need to rename it back.

You MUST use doom3\darkmod\tdmlauncher.exe to run Dark Mod in Windows and NOT Doom3.exe.

You do NOT need to extract the pk4 archives to install or play. Just download into or move the pk4 into the darkmod\fms folder. Optionally you can create a folder of the same name as the map and put it in there, eg, darkmod\fms\chalice but there is no need because Dark Mod will create that automatically. Just make sure your pk4 goes, unopened, into the fms folder then run tdmlauncher.exe

If you have done the above but see for example, a blank objectives screen and no briefing then it is still almost certainly an install error. I recommend you do a clean sweep if in doubt:
* exit Dark Mod
* delete doom3\darkmod\currentfm.txt (this just uninstalls any FM)
* Delete the map game folder (if any) This is NOT the folder in fms but the folder in doom3 of the same name as the FM, eg, doom3\chalice. Note: this has savegames and screenshots in so check and move them out if you want to preserve them. However, if you can't get the game to play it's likely you don't have any yet. If you can't see the folder don't worry. The folder name is normally the same as the pk4 but it might not be. Strictly speaking it must be the same as the name in startingmap.txt inside the pk4 archive. You might see this file in fms.
* Move the pk4 into the darkmod\fms folder if it is not already there.
* Delete the darkmod\fms\FMname folder if any, eg, darkmod\fms\chalice. Don't worry if there isn't one; it will be created automatically later.

So all that is left is the pk4 in the fms folder. Now run tdmlauncher.exe. The FM should be in the list in the New Missions menu. Re-install it and you should now be able to play it.

=== The game crashes on load ===
Make sure that:
* You installed [[#Patching_Doom_3_to_verson_1.3.1.1304|the correct version]] of the Doom 3 1.3.1 patch.
* Your system meets at least the minimum system specs.
* You have enough free main memory. Try closing a few running programs like Outlook, Anti-Virus or torrent clients.

==== Unknown event 'moveToCoverFrom'" ====
If you get a message like:

ERROR: Error: file script\doom_events.script, line 1038: Unknown event 'moveToCoverFrom'

or see this in the log:

found DLL in pak file: C:\Program Files\Doom 3\darkmod\tdm_game01.pk4/gamex86.dll
copy gamex86.dll to C:\Program Files\Doom 3\darkmod\gamex86.dll
could not create destination file

then try extracting that gamex86.dll manually from '''tdm_game01.pk4''' with Winzip or a similiar program into that folder.

The reason is very probably that you installed Doom3 into a folder with a space in it, and it seems Doom3 does not like that. Sorry.

=== Unknown event 'setEntityRelation' ===
The game is crashing to a small blue screen on startup:

[[Image:ErrorSetEntityRelation.jpg]]

The reason for this error is most likely an old version of gamex86.dll (or gamex86.so) lying around in your Doom 3 folder. Delete that file and try again.

=== Textures are missing, screen mostly black ===

[[Image:Tdm missing textures.jpg|right|240px|Black textures]]

Look into your '''DoomConfig.cfg''' inside your <tt>darkmod</tt> folder and check that the
following settings are like shown below:

<pre style="max-width:35em">
seta image_usePrecompressedTextures "1"
seta image_useNormalCompression "2"
seta image_useAllFormats "1"
seta image_useCompression "0"
seta image_preload "1"
</pre>

=== The briefing is very fuzzy ===

Look into your '''DoomConfig.cfg''' inside your <tt>darkmod</tt> folder and check that the
following settings are like shown below:

seta image_roundDown "1"
seta image_forceDownSize "0"
seta image_downSize "0"

=== The sky is corrupted ===

You either see black sky, or fragments of other textures. This seems only to happen on Geforce 6800 cards.

There are two fixes for this:

As a quick fix you can rename the following folder:

env/skyboxes/skybox_darkland_ne

to an different name. That will result in black sky.

Alternatively, edit the file <tt>materials/tdm_sky.mtr</tt> with '''Wordpad''' or a different editor and
find the sky material named '''textures/darkmod/nature/skybox/skybox_darkland_NE''':

<pre>
//Author: Dram
//skybox_ocean with ocean replaced with dark land
//Moon moved to north east by Fidcal
textures/darkmod/nature/skybox/skybox_darkland_NE
{
qer_editorimage env/skyboxes/skybox_ocean/ocean_ed
noFragment
noshadows
noimpact
nooverlays
forceOpaque
{
forceHighQuality
blend add
cameraCubeMap env/skyboxes/skybox_darkland_ne/darkland_NE
texgen skybox
texgen wobblesky .0 .0 .0
}
}
</pre>

In this declaration, comment out the line that reads '''forceHighQuality''' by adding <tt>//</tt> in front of it:

// forceHighQuality

That should fix the sky and make it render correctly.

=== Sky rotates ===

If you see the sky spinning it may be an ATI graphics card problem. One report says this was cured by turning off Catalyst AI. Also gives better loading times and cures bloom problem.

=== Bloom problems ===

If have a problem with bloom it may be an ATI graphics card problem. One report says this was cured by turning off Catalyst AI. Also gives better loading times and cures spinning sky problem.

=== The game is '''very''' slow! ===

If you get loading times of 5 minutes or more, less than 10 FPS, or the game even stutters, please try this:

Look into your '''DoomConfig.cfg''' inside your <tt>darkmod</tt> folder and check that the
following settings are like shown below:

<pre style="max-width:35em">
seta image_usePrecompressedTextures "1"
seta image_useNormalCompression "2"
seta image_useAllFormats "1"
seta image_useCompression "1"
seta image_preload "1"
</pre>

If that doesn't help, your system might run out of memory. Either upgrade to more than 1 Gbyte memory,
or try to close some other applications before playing.

Please see also the article about [[Performance Tweaks]] to improve the performance.

=== Slow loading times ===

If you find an FM is very slow to load it may be an ATI graphics card problem. One report says this was cured by turning off Catalyst AI. Also cures bloom and spinning sky problem.

===Underwater performance poor===

If you get very low framerates underwater then try turning off bloom.

===Upside-down screen===

If you get an upside-down screen, try turning off bloom.

===Game freezes for several seconds when opening doors===
Solution to problems:

A) "game freezes and loads some data from hard drive while opening doors"

B) "while loading mission you are returned to the menu and need to restart loading"

is
DISABLE EAX 4.0 HD in Audio Settings menu.

===Game exits to menu after mission load, with renderpipe error in console===

'''Symptoms:''' Missions are installed properly and will load, but after they reach 100% you are returned to the main menu or objectives screen. If you open the console (Ctrl-Alt-~ on US keyboards), you see one/both of these errors:

ERROR: Failed to open \\.\pipe\dm_renderpipe

or

ERROR: idRenderSystemLocal::uncrop currentcrop <1

'''Solution:''' Some firewalls, notably ''Sunbelt Firewall'' (aka ''Kerio Firewall'') are known to interfere with TDM's lightgem, ''even when "disabled"''. To fix this problem, completely uninstall the firewall, and get a different one instead.

== Known bugs ==
See article [[Known Bugs]].

=== Changing the screen resolution/aspect ratio does nothing!? ===
These changes require a restart of Doom to work.

[[Category:General]] [[Category:Installation]]

Adding Heads and Weapons to AI

2009-10-31T02:31:06Z

Crispy: Marked for cleanup/updating

TODO : def_attach1 <weapon name> is sufficient now to attach weapons so this article needs reviewing.

TODO : def_head <head name> is sufficient now to attach heads.

Are you a mapper looking for info on [[Swapping Heads on AI Models]] in your map?

Are you looking for a review of [[Heads Available for AI]] to choose from?

To see updated information on attaching weapons, see [[Attaching Props to AI]]

== Removing inherited Attachments from AI ==
It's possible to remove inherited AI attachments like weapons in DarkRadiant by overriding the inherited spawnargs. To do this, select the entity in DarkRadiant, select "Show inherited properties" and browse to the offending attachment (for instance "def_attach1") and set its value to the minus sign "-". (Note: It's not possible to store empty spawnargs (this would be a deletion in DarkRadiant), the "empty" value has been set to the minus "-" - this is just a convention, the SDK will ignore the minus signs. Other values will throw an error).
"def_attach1" "-"
This will override the inherited spawnarg and in fact remove the attachment from the AI without throwing a console error on map load.

{{tutorial-ai}}
[[Category:Cleanup]]

Attaching Props to AI

2009-10-31T02:30:40Z

Crispy: replaced with template that includes relevant categories

Attaching things to AI is an important way to make your AI unique.

There are three ways to attach things (hereafter referred to as 'props') to AI. Not all are equally good, and they are listed in order of preference:

== 1. Using Attachment Positions ==

This is the preferred way of attaching things to AI. Each AI has a set of pre-determined coordinates (attachment points). The mapper can attach things to these points by using the following spawnargs in an AI's entity window:

"def_attach5" "[entity name]"
"pos_attach5" "[attachment point name]"

The number is arbitrary. As long as both lines have the same number, you could use 999. Best to stay away from numbers 1-5, however, as some AI come with default props (pauldrons, weapons, etc), and you could overwrite them.

'''[entity name]''' is the entity that you want to attach, like "atdm:prop_torch_gothic_on". You can find a list of preset attachable objects in prop_items.def and prop_wearable_items.def. Or see the quick list below.

'''[attachment point name]''' is the name of the predefined point you want to attach the object to, like "hand_l". See the list of preset attachment points below.

This image indicates some common attachment points. You can cut and paste the names below:

http://www.mindplaces.com/save/attachment_points.jpg

1. '''"hip_sheath_l"'''

This is designed for sheathed weapons on the hip.

2. '''"hand_l"'''

The left hand, primarily used for torches. You can attach a weapon to this hand but AI will not currently attack with it.

3. '''"belt_back_right"'''

This is on the back of the belt on the right hand side, designed for purses, keys, or other things players may want to pickpocket.

4. '''"hand_r"'''

The right hand. Generally reserved for weapon use.

5. '''"slung_across_back_rl"'''

This is primarily used for weapons worn on the back, like hammers or bows.

===List of Attachable Objects===
You can attach any existing entity, but the entities below have spawnargs that position them properly. For information on making new attachment points, or positioning new entities, see [[Attachment Positions]].

'''Torches:'''

"def_attach5" "atdm:prop_torch_on"
"pos_attach5" "hand_l"

"def_attach5" "atdm:prop_torch_gothic_on"
"pos_attach5" "hand_l"

'''Belt Objects:'''

"def_attach6" "atdm:prop_lootbag" (used for loot)
"pos_attach6" "belt_back_right"

"def_attach6" "atdm:prop_belt_pouch" (used for decoration)
"pos_attach6" "belt_back_right"

"def_attach6" "atdm:prop_goldkey"
"pos_attach6" "belt_back_right"

"def_attach6" "atdm:prop_silverkey"
"pos_attach6" "belt_back_right"

"def_attach6" "atdm:prop_key_padlock"
"pos_attach6" "belt_back_right"

"def_attach6" "atdm:prop_key_simple"
"pos_attach6" "belt_back_right"

"def_attach6" "atdm:prop_key_fancy01"
"pos_attach6" "belt_back_right"

"def_attach6" "atdm:prop_potion_healing"
"pos_attach6" "belt_back_right"

"def_attach6" "atdm:prop_smithyhammer" (decorative only atm)
"pos_attach6" "hip_sheath_l"

'''Other'''

"def_attach5" "atdm:prop_halberd" (decorative only--does not work well in combat)
"pos_attach5" "hand_l"

==2. Using def_attach==

See [[Making 'Prop' Entities]].

==3. Binding==

See [[Attaching Items]].

{{tutorial-ai}}

Attaching Props to AI

2009-10-31T02:29:23Z

Crispy: AI and AI Tutorials categories

FAQ

2009-10-21T00:25:40Z

Crispy: /* The game crashes on load */

{{important|headline=Important|text=This FAQ relates to the full TDM release version only. For players of the pre-release demos such as '''[[Thief's Den]]''' and '''[[Saint_Lucia|Tears of Saint Lucia]]''' please refer to the '''[[FAQ (Demo Releases)|Demo FAQ]]'''.'''}}

== What Doom versions are supported? ==

=== Can I use the Demo version of Doom 3? ===

No, sorry.

=== Does it run with the Steam version of Doom 3? ===

Yes :) You need to install the mod into the directory where Steam put Doom3, this might be under:

C:\Program Files\Steam\steamapps\common\doom 3

or a similiar folder.

== Patching Doom 3 to verson 1.3.1.1304 ==

=== How can I check whether my Doom 3 is correctly patched? ===

Open Doom 3 and hit {{key|Ctrl}}+{{key|Alt}}+{{key|~}} (tilde, {{key|^}} on German keyboards) to open the console. You'll see the version printed in the lower left corner of the console. It should read '''1.3.1.1304'''. If your version is ending on 1302, you've got the wrong patch installed.

=== Where can I get the right patch? ===

We have the patch hosted on our FTP. See the [[Installation]] article to find a link to it.

If you have version 1.3.1.1302, you may need to uninstall and reinstall before patch 1.3.1.1304 will let you apply it.

=== What's that issue with the 1.3.1 patch? ===

When the 1.3.1 patch was released by Id, they released it a bit too early. Some download sites picked it up quite fast though and started to distribute it. The problem is, that Id replaced that patch with a different one, and, probably thinking that it hadn't spread yet, didn't bother to change the version number. However, you can still find "wrong" 1.3.1 patches and these will not work with the mod. That's why it is important to check the version number in the console to make sure that the right 1.3.1 patch is installed if the mod doesn't work. The link provided here on our own page points to the correct patch, so if you downloaded it from here you don't need to worry about it.

== Supported Operating Systems ==

=== Which Windows versions can I use? ===

Doom 3 needs at least Windows XP or Windows 2000. Saint Lucia was successfully run under Windows XP and Vista. Support for 64 bit Windows or Windows 2000 was not tested.

=== Does it run in Linux? ===
Yes, Linux is supported.
=== Does it run in 64 Bit Linux? ===
Yes, Linux 64 bit is supported. In addition to the steps above, you need 32 bit compatibility libraries, since Doom3 is 32 bit only:
* On '''SuSE''', they should be included.
* On Ubuntu/Kubuntu, install the package '''ia32'''.
* Since you cannot install 32 bit libraries on a 64 bit system with the normal package manager, you should use [http://ubuntuforums.org/showthread.php?t=474790 getlibs] to install '''libmng''' and the boost filesystem lib:
:<code>getlibs libmng.so.1</code>
:<code>getlibs -l libboost-filesystem1.34.1</code>

=== What about Gentoo? ===
Should work too.
=== What about Ubuntu 8.10? ===
Yes. As of this writing you will need to install the '''libboost-filesystem''' package.

=== GLIBCXX_3.4.9 errors ===

If you receive an error about <tt>GLIBCXX_3.4.9</tt>, delete or rename the files <code>/usr/local/games/doom3/libstdc++.so.6</code> and <code>/usr/local/games/doom3/libgcc_s.so.1.</code>

=== Does it run on Mac OS X?===
No. Or at least not yet. The Doom 3 game itself does support Mac OS X, but The Dark Mod currently does not because we don't have any developers who use Macs. If you can help us getting it to run on OS X, please [http://modetwo.net/darkmod/index.php?showforum=11 let us know on the forum].

Since TDM works on Linux already, getting it working on OS X should not be too difficult for anyone with experience programming for that platform. In theory it's just a question of figuring out how to build the mod, sorting out dependencies, and writing a few pieces of platform-specific code.

== Graphics ==

=== Does TDM support widescreen resolutions? ===

Yes. Choose "16:9" or "16:10" in the in-game ''Settings'' menu, and select the appropriate resolution. Note that you need to restart the game to have the new setting in effect.

If the native resolution of your wide screen monitor is not listed, you can enter it into '''DoomConfig.cfg''' by changing the following entries like so:

set r_mode -1
set r_customwidth 1280
set r_customheight 800

Note that if you get performance problems, it might be better to halve the resolution in both directions. Please see also [[Performance Tweaks]].

== Troubleshooting ==

It is hard to answer question on why something fails, because wildly different systems cause wildy different symptoms. If the following section does not help you, please ask at out our [http://www.modetwo.net/darkmod forums].

=== FM downloaded but won't play ===

If you have downloaded an FM you might see it in the New Missions List but can't get it to play. These are almost always an install problem. These are some of the causes and cures:

FMs (fan missions) are archives and MUST be suffixed .pk4 not zip. Apparently Internet Explorer 8 may change it from pk4 to zip during download without telling you. You need to rename it back.

You MUST use doom3\darkmod\tdmlauncher.exe to run Dark Mod in Windows and NOT Doom3.exe.

You do NOT need to extract the pk4 archives to install or play. Just download into or move the pk4 into the darkmod\fms folder. Optionally you can create a folder of the same name as the map and put it in there, eg, darkmod\fms\chalice but there is no need because Dark Mod will create that automatically. Just make sure your pk4 goes, unopened, into the fms folder then run tdmlauncher.exe

If you have done the above but see for example, a blank objectives screen and no briefing then it is still almost certainly an install error. I recommend you do a clean sweep if in doubt:
* exit Dark Mod
* delete doom3\darkmod\currentfm.txt (this just uninstalls any FM)
* Delete the map game folder (if any) This is NOT the folder in fms but the folder in doom3 of the same name as the FM, eg, doom3\chalice. Note: this has savegames and screenshots in so check and move them out if you want to preserve them. However, if you can't get the game to play it's likely you don't have any yet. If you can't see the folder don't worry. The folder name is normally the same as the pk4 but it might not be. Strictly speaking it must be the same as the name in startingmap.txt inside the pk4 archive. You might see this file in fms.
* Move the pk4 into the darkmod\fms folder if it is not already there.
* Delete the darkmod\fms\FMname folder if any, eg, darkmod\fms\chalice. Don't worry if there isn't one; it will be created automatically later.

So all that is left is the pk4 in the fms folder. Now run tdmlauncher.exe. The FM should be in the list in the New Missions menu. Re-install it and you should now be able to play it.

=== The game crashes on load ===
Make sure that:
* You installed [[#Patching_Doom_3_to_verson_1.3.1.1304|the correct version]] of the Doom 3 1.3.1 patch.
* Your system meets at least the minimum system specs.
* You have enough free main memory. Try closing a few running programs like Outlook, Anti-Virus or torrent clients.

==== Unknown event 'moveToCoverFrom'" ====
If you get a message like:

ERROR: Error: file script\doom_events.script, line 1038: Unknown event 'moveToCoverFrom'

or see this in the log:

found DLL in pak file: C:\Program Files\Doom 3\saintlucia\darkmod.pk4/gamex86.dll
copy gamex86.dll to C:\Program Files\Doom 3\saintlucia\gamex86.dll
could not create destination file

then try extracting that gamex86.dll manually from '''darkmod.pk4''' with Winzip or a similiar program into that folder.

The reason is very probably that you installed Doom3 into a folder with a space in it, and it seems Doom3 does not like that. Sorry.

=== Unknown event 'setEntityRelation' ===
The game is crashing to a small blue screen on startup:

[[Image:ErrorSetEntityRelation.jpg]]

The reason for this error is most likely an old version of gamex86.dll (or gamex86.so) lying around in your Doom 3 folder. Delete that file and try again.

=== Textures are missing, screen mostly black ===

[[Image:Tdm missing textures.jpg|right|240px|Black textures]]

Look into your '''DoomConfig.cfg''' inside your <tt>saintlucia</tt> or <tt>thiefsden</tt> folder and check that the
following settings are like shown below:

<pre style="max-width:35em">
seta image_usePrecompressedTextures "1"
seta image_useNormalCompression "2"
seta image_useAllFormats "1"
seta image_useCompression "0"
seta image_preload "1"
</pre>

=== The briefing is very fuzzy ===

Look into your '''DoomConfig.cfg''' inside your <tt>saintlucia</tt> or <tt>thiefsden</tt> folder and check that the
following settings are like shown below:

seta image_roundDown "1"
seta image_forceDownSize "0"
seta image_downSize "0"

=== The sky is corrupted ===

You either see black sky, or fragments of other textures. This seems only to happen on Geforce 6800 cards.

There are two fixes for this:

As a quick fix you can rename the following folder:

env/skyboxes/skybox_darkland_ne

to an different name. That will result in black sky.

Alternatively, edit the file <tt>materials/tdm_sky.mtr</tt> with '''Wordpad''' or a different editor and
find the sky material named '''textures/darkmod/nature/skybox/skybox_darkland_NE''':

<pre>
//Author: Dram
//skybox_ocean with ocean replaced with dark land
//Moon moved to north east by Fidcal
textures/darkmod/nature/skybox/skybox_darkland_NE
{
qer_editorimage env/skyboxes/skybox_ocean/ocean_ed
noFragment
noshadows
noimpact
nooverlays
forceOpaque
{
forceHighQuality
blend add
cameraCubeMap env/skyboxes/skybox_darkland_ne/darkland_NE
texgen skybox
texgen wobblesky .0 .0 .0
}
}
</pre>

In this declaration, comment out the line that reads '''forceHighQuality''' by adding <tt>//</tt> in front of it:

// forceHighQuality

That should fix the sky and make it render correctly.

=== Sky rotates ===

If you see the sky spinning it may be an ATI graphics card problem. One report says this was cured by turning off Catalyst AI. Also gives better loading times and cures bloom problem.

=== Bloom problems ===

If have a problem with bloom it may be an ATI graphics card problem. One report says this was cured by turning off Catalyst AI. Also gives better loading times and cures spinning sky problem.

=== The game is '''very''' slow! ===

If you get loading times of 5 minutes or more, less than 10 FPS, or the game even stutters, please try this:

Look into your '''DoomConfig.cfg''' inside your <tt>darkmod</tt> folder and check that the
following settings are like shown below:

<pre style="max-width:35em">
seta image_usePrecompressedTextures "1"
seta image_useNormalCompression "2"
seta image_useAllFormats "1"
seta image_useCompression "1"
seta image_preload "1"
</pre>

If that doesn't help, your system might run out of memory. Either upgrade to more than 1 Gbyte memory,
or try to close some other applications before playing.

Please see also the article about [[Performance Tweaks]] to improve the performance.

=== Slow loading times ===

If you find an FM is very slow to load it may be an ATI graphics card problem. One report says this was cured by turning off Catalyst AI. Also cures bloom and spinning sky problem.

===Underwater performance poor===

If you get very low framerates underwater then try turning off bloom.

===Upside-down screen===

If you get an upside-down screen, try turning off bloom.

== Known bugs ==
See article [[Known Bugs]].

=== Changing the screen resolution/aspect ratio does nothing!? ===
These changes require a restart of Doom to work.

[[Category:General]] [[Category:Installation]]

Animation playback speed

2009-08-17T10:22:31Z

Crispy: caveat added and clarified

Overriding animations via attached objects

2009-04-05T01:01:55Z

Crispy: simplified some of the language and removed some unnecessary info to clarify the article

TDM has a mechanism for causing AIs (and other actors) to automatically use different sets of animations when certain objects are attached to them. This could be used for weapons, torches, bandages, or anything else you can think of. It works as follows.

==Basic usage==

When an entity (for example, a longsword) is attached to an actor (for example, an AI), the code will look for spawnargs on the first entity (the longsword) with names that start with "replace_anim_". The remainder of the name is the animation to replace on the actor/AI, and the value is the animation to replace it with. For example:

"replace_anim_throw" "look_around"

Placing the above line in the ai_weapon_longsword entityDef would cause AIs carrying longswords to use their "look_around" animation whenever they would normally use their "throw" animation.

'''Note:''' The animation names are the ones specified in the model def. They are not filenames.

The practical uses for this include being able to have different animations for guards carrying torches, and/or different weapons. Some examples:

* AIs carrying hammers should use two-handed overhead swings to attack instead of one-handed slashes. A dagger needs a stabbing motion. A club is different again. And so on.
* Suppose guards have a "peering around" animation, in which the guard puts his left hand up to shield his eyes. If he was holding a torch, this would burn him. To prevent this, you could add <tt>"replace_anim_peering_around" "peering_around_torch"</tt> to the torch entityDef. This would replace the <tt>peering_around</tt> anim with <tt>peering_around_torch</tt> for torch-carrying guards. <tt>peering_around_torch</tt> might have the guard's left hand lifted up in the air (to illuminate the surroundings) instead, for example.
* A guard with a bandaged leg (an attached bandage entity) could be made to limp instead of walking normally.

==Combining multiple replacements (advanced)==

So far so good, but what if we want to combine several uses? What if a torch-carrying hammer-wielding guard should have a different animation from a non-torch-carrying hammer-wielder, which is different again from a torch-carrying sword-wielder? Well, animations can be replaced multiple times.

Let's assume that the default melee_attack anim is for a sword-wielding guard with no torch. In the torch entityDef, you'd put:
<pre>"replace_anim_melee_attack" "melee_attack_torch"
"replace_anim_hammer_attack" "hammer_attack_torch"</pre>

And in the hammer entityDef, you'd put:
<pre>"replace_anim_melee_attack" "hammer_attack"
"replace_anim_melee_attack_torch" "hammer_attack_torch"</pre>

(''Aside:'' If this seems a little redundant to you, then you're right - <tt>hammer_attack_torch</tt> is mentioned twice. However, this is necessary because there's no reliable way to know whether the torch's replacements or the hammer's replacements will be applied first.)

You can do as many similar combinations as you like (limping, torch-carrying, hammer-wielding guard anyone?) but it starts to get messy pretty quickly.

[[Category:Animation]]

FAQ

2009-01-12T12:11:17Z

Crispy: /* What about Ubuntu 8.10? */

'''These FAQs relate to pre-release missions such as [[Thief's Den]] and [[Saint_Lucia|Tears of Saint Lucia]]:'''

== What Doom versions are supported? ==

=== Can I use the Demo version of Doom 3? ===

No, sorry.

=== Does it run with the Steam version of Doom 3? ===

Yes :) You need to install the mod into the directory where Steam put Doom3, this might be under:

C:\Program Files\Steam\steamapps\common\doom 3

or a similiar folder.

== Patching Doom 3 to verson 1.3.1.1304 ==

=== How can I check whether my Doom 3 is correctly patched? ===

Open Doom 3 and hit {{key|Ctrl}}+{{key|Alt}}+{{key|~}} (tilde, {{key|^}} on German keyboards) to open the console. You'll see the version printed in the lower left corner of the console. It should read '''1.3.1.1304'''. If your version is ending on 1302, you've got the wrong patch installed.

=== Where can I get the right patch? ===

We have the patch hosted on our FTP. See [[#Installation|above]] to find a link to it.

If you have version 1.3.1.1302, you may need to uninstall and reinstall before patch 1.3.1.1304 will let you apply it.

=== What's that issue with the 1.3.1 patch? ===

When the 1.3.1 patch was released by Id, they released it a bit too early. Some download sites picked it up quite fast though and started to distribute it. The problem is, that Id replaced that patch with a different one, and, probably thinking that it hadn't spread yet, didn't bother to change the version number. However, you can still find "wrong" 1.3.1 patches and these will not work with the mod. That's why it is important to check the version number in the console to make sure that the right 1.3.1 patch is installed if the mod doesn't work. The link provided here on our own page points to the correct patch, so if you downloaded it from here you don't need to worry about it.

== Supported Operating Systems ==

=== Which Windows versions can I use? ===

Doom 3 needs at least Windows XP or Windows 2000. Saint Lucia was successfully run under Windows XP and Vista. Support for 64 bit Windows or Windows 2000 was not tested.

=== Does it run in Linux? ===

Yes, Linux is supported. You may need:
* the package '''libdevil1''', use your package manager to install '''libdevil1''' or '''libdevil1c2'''
* either Wine or p7zip to extract the contents from the EXE file
* '''only for Thief's Den''': recompile the map via the console, or the pathfinding of the AI is broken

=== Does it run in 64 Bit Linux? ===

Yes, Linux 64 bit is supported. In addition to the steps above, you need 32 bit compatibility libraries, since Doom3 is 32 bit only:
* On '''SuSE''', they should be included.
* On Ubuntu/Kubuntu, install the package '''ia32'''.
* Since you cannot install 32 bit libraries on a 64 bit system with the normal package manager, you should use [http://ubuntuforums.org/showthread.php?t=474790 getlibs] to install '''libdevil''' and '''libmng''':
:<code>getlibs libIL.so.1</code>
:<code>getlibs libmng.so.1</code>
:For saintlucia only: <code>getlibs -l libboost-filesystem1.34.1</code>

=== What about Gentoo? ===

Use <tt>emerge devil</tt> to install the libdevil1 library.

=== What about Ubuntu 8.10? ===

Yes. As of this writing you will need to install the '''libboost-filesystem''' package.

If you get an error about GLIBCXX_3.4.9, delete or rename the files <code>/usr/local/games/doom3/libstdc++.so.6</code> and <code>/usr/local/games/doom3/libgcc_s.so.1.</code>

=== Does it run on Mac OS X?===

No. Or at least not yet. The Doom 3 game itself does support Mac OS X, but The Dark Mod currently does not because we don't have any developers who use Macs. If you can help us getting it to run on OS X, please [http://modetwo.net/darkmod/index.php?showforum=11 let us know] on the forum.

Since TDM works on Linux already, getting it working on OS X should not be too difficult for anyone with experience programming for that platform. In theory it's just a question of figuring out how to build the mod, sorting out dependencies, and writing a few pieces of platform-specific code.

== Graphics ==

=== Does TDM support widescreen resolutions? ===

Yes. Choose "16:9" or "16:10" in the in-game ''Settings'' menu, and select the appropriate resolution. Note that you need to restart the game to have the new setting in effect.

If the native resolution of your wide screen monitor is not listed, you can enter it into '''DoomConfig.cfg''' by changing the following entries like so:

set r_mode -1
set r_customwidth 1280
set r_customheight 800

Note that if you get performance problems, it might be better to halve the resolution in both directions. Please see also [[Performance Tweaks]].

== Troubleshooting ==

It is hard to answer question on why something fails, because wildly different systems cause wildy different symptoms. If the following section does not help you, please ask at out [ forum].

=== The game crashes on load ===

Make sure that:

* the downloaded file was really '''downloaded correctly''', and could be extracted '''completely'''
* you extracted the contents to your Doom 3 directory
* the DevIL.dll file is in your base Doom 3 directory
* Your system meets at least the minimum system specs
* You have enough free main memory. Try closing a few running programs like Outlook, Anti-Virus or torrent clients

==== Unknown event 'moveToCoverFrom'" ====

If you get a message like:

ERROR: Error: file script\doom_events.script, line 1038: Unknown event 'moveToCoverFrom'

or see this in the log:

found DLL in pak file: C:\Programfiler\Doom 3\saintlucia\darkmod.pk4/gamex86.dll
copy gamex86.dll to C:\Programfiler\Doom 3\saintlucia\gamex86.dll
could not create destination file

then try extracting that gamex86.dll manually from '''darkmod.pk4''' with Winzip or a similiar program into that folder.

The reason is very probably that you installed Doom3 into a folder with a space in it, and it seems Doom3 does not like that. Sorry.

=== Textures are missing, screen mostly black ===

[[Image:Tdm missing textures.jpg|right|240px|Black textures]]

Look into your '''DoomConfig.cfg''' inside your <tt>saintlucia</tt> or <tt>thiefsden</tt> folder and check that the
following settings are like shown below:

<pre style="max-width:35em">
seta image_usePrecompressedTextures "1"
seta image_useNormalCompression "2"
seta image_useAllFormats "1"
seta image_useCompression "1"
seta image_preload "1"
</pre>

=== The briefing is very fuzzy ===

Look into your '''DoomConfig.cfg''' inside your <tt>saintlucia</tt> or <tt>thiefsden</tt> folder and check that the
following settings are like shown below:

seta image_roundDown "1"
seta image_forceDownSize "0"
seta image_downSize "0"

=== The sky is corrupted ===

You either see black sky, or fragments of other textures. This seems only to happen on Geforce 6800 cards.

There are two fixes for this:

As a quick fix you can rename the following folder:

env/skyboxes/skybox_darkland_ne

to an different name. That will result in black sky.

Alternatively, edit the file <tt>materials/tdm_sky.mtr</tt> with '''Wordpad''' or a different editor and
find the sky material named '''textures/darkmod/nature/skybox/skybox_darkland_NE''':

<pre>
//Author: Dram
//skybox_ocean with ocean replaced with dark land
//Moon moved to north east by Fidcal
textures/darkmod/nature/skybox/skybox_darkland_NE
{
qer_editorimage env/skyboxes/skybox_ocean/ocean_ed
noFragment
noshadows
noimpact
nooverlays
forceOpaque
{
forceHighQuality
blend add
cameraCubeMap env/skyboxes/skybox_darkland_ne/darkland_NE
texgen skybox
texgen wobblesky .0 .0 .0
}
}
</pre>

In this declaration, comment out the line that reads '''forceHighQuality''' by adding <tt>//</tt> in front of it:

// forceHighQuality

That should fix the sky and make it render correctly.

== The game is '''very''' slow! ==

If you get loading times of 5 minutes or more, less than 10 FPS, or the game even stutters, please try this:

Look into your '''DoomConfig.cfg''' inside your <tt>saintlucia</tt> or <tt>thiefsden</tt> folder and check that the
following settings are like shown below:

<pre style="max-width:35em">
seta image_usePrecompressedTextures "1"
seta image_useNormalCompression "2"
seta image_useAllFormats "1"
seta image_useCompression "1"
seta image_preload "1"
</pre>

If that doesn't help, your system might run out of memory. Either upgrade to more than 1 Gbyte memory,
or try to close some other applications before playing.

Please see also the article about [[Performance Tweaks]] to improve the performance.

== Known bugs ==

=== Changing the screen resolution/aspect ratio does nothing!? ===

These changes require a restart of Doom to work. Currently, our GUI does not warn you about this. You can enter vid_restart in the console to restart the renderer without quitting the game.

[[Category:General]] [[Category:Installation]]

FAQ

2009-01-12T12:07:19Z

Crispy: /* Does it run in MacOS? */ details and proofreading

'''These FAQs relate to pre-release missions such as [[Thief's Den]] and [[Saint_Lucia|Tears of Saint Lucia]]:'''

== What Doom versions are supported? ==

=== Can I use the Demo version of Doom 3? ===

No, sorry.

=== Does it run with the Steam version of Doom 3? ===

Yes :) You need to install the mod into the directory where Steam put Doom3, this might be under:

C:\Program Files\Steam\steamapps\common\doom 3

or a similiar folder.

== Patching Doom 3 to verson 1.3.1.1304 ==

=== How can I check whether my Doom 3 is correctly patched? ===

Open Doom 3 and hit {{key|Ctrl}}+{{key|Alt}}+{{key|~}} (tilde, {{key|^}} on German keyboards) to open the console. You'll see the version printed in the lower left corner of the console. It should read '''1.3.1.1304'''. If your version is ending on 1302, you've got the wrong patch installed.

=== Where can I get the right patch? ===

We have the patch hosted on our FTP. See [[#Installation|above]] to find a link to it.

If you have version 1.3.1.1302, you may need to uninstall and reinstall before patch 1.3.1.1304 will let you apply it.

=== What's that issue with the 1.3.1 patch? ===

When the 1.3.1 patch was released by Id, they released it a bit too early. Some download sites picked it up quite fast though and started to distribute it. The problem is, that Id replaced that patch with a different one, and, probably thinking that it hadn't spread yet, didn't bother to change the version number. However, you can still find "wrong" 1.3.1 patches and these will not work with the mod. That's why it is important to check the version number in the console to make sure that the right 1.3.1 patch is installed if the mod doesn't work. The link provided here on our own page points to the correct patch, so if you downloaded it from here you don't need to worry about it.

== Supported Operating Systems ==

=== Which Windows versions can I use? ===

Doom 3 needs at least Windows XP or Windows 2000. Saint Lucia was successfully run under Windows XP and Vista. Support for 64 bit Windows or Windows 2000 was not tested.

=== Does it run in Linux? ===

Yes, Linux is supported. You may need:
* the package '''libdevil1''', use your package manager to install '''libdevil1''' or '''libdevil1c2'''
* either Wine or p7zip to extract the contents from the EXE file
* '''only for Thief's Den''': recompile the map via the console, or the pathfinding of the AI is broken

=== Does it run in 64 Bit Linux? ===

Yes, Linux 64 bit is supported. In addition to the steps above, you need 32 bit compatibility libraries, since Doom3 is 32 bit only:
* On '''SuSE''', they should be included.
* On Ubuntu/Kubuntu, install the package '''ia32'''.
* Since you cannot install 32 bit libraries on a 64 bit system with the normal package manager, you should use [http://ubuntuforums.org/showthread.php?t=474790 getlibs] to install '''libdevil''' and '''libmng''':
:<code>getlibs libIL.so.1</code>
:<code>getlibs libmng.so.1</code>
:For saintlucia only: <code>getlibs -l libboost-filesystem1.34.1</code>

=== What about Gentoo? ===

Use <tt>emerge devil</tt> to install the libdevil1 library.

=== What about Ubuntu 8.10? ===

So far Ubuntu 8.10 is not yet officially released and we have not tested it. It might work if you install '''libboost-filesystem.1.34.1'''.

=== Does it run on Mac OS X?===

No. Or at least not yet. The Doom 3 game itself does support Mac OS X, but The Dark Mod currently does not because we don't have any developers who use Macs. If you can help us getting it to run on OS X, please [http://modetwo.net/darkmod/index.php?showforum=11 let us know] on the forum.

Since TDM works on Linux already, getting it working on OS X should not be too difficult for anyone with experience programming for that platform. In theory it's just a question of figuring out how to build the mod, sorting out dependencies, and writing a few pieces of platform-specific code.

== Graphics ==

=== Does TDM support widescreen resolutions? ===

Yes. Choose "16:9" or "16:10" in the in-game ''Settings'' menu, and select the appropriate resolution. Note that you need to restart the game to have the new setting in effect.

If the native resolution of your wide screen monitor is not listed, you can enter it into '''DoomConfig.cfg''' by changing the following entries like so:

set r_mode -1
set r_customwidth 1280
set r_customheight 800

Note that if you get performance problems, it might be better to halve the resolution in both directions. Please see also [[Performance Tweaks]].

== Troubleshooting ==

It is hard to answer question on why something fails, because wildly different systems cause wildy different symptoms. If the following section does not help you, please ask at out [ forum].

=== The game crashes on load ===

Make sure that:

* the downloaded file was really '''downloaded correctly''', and could be extracted '''completely'''
* you extracted the contents to your Doom 3 directory
* the DevIL.dll file is in your base Doom 3 directory
* Your system meets at least the minimum system specs
* You have enough free main memory. Try closing a few running programs like Outlook, Anti-Virus or torrent clients

==== Unknown event 'moveToCoverFrom'" ====

If you get a message like:

ERROR: Error: file script\doom_events.script, line 1038: Unknown event 'moveToCoverFrom'

or see this in the log:

found DLL in pak file: C:\Programfiler\Doom 3\saintlucia\darkmod.pk4/gamex86.dll
copy gamex86.dll to C:\Programfiler\Doom 3\saintlucia\gamex86.dll
could not create destination file

then try extracting that gamex86.dll manually from '''darkmod.pk4''' with Winzip or a similiar program into that folder.

The reason is very probably that you installed Doom3 into a folder with a space in it, and it seems Doom3 does not like that. Sorry.

=== Textures are missing, screen mostly black ===

[[Image:Tdm missing textures.jpg|right|240px|Black textures]]

Look into your '''DoomConfig.cfg''' inside your <tt>saintlucia</tt> or <tt>thiefsden</tt> folder and check that the
following settings are like shown below:

<pre style="max-width:35em">
seta image_usePrecompressedTextures "1"
seta image_useNormalCompression "2"
seta image_useAllFormats "1"
seta image_useCompression "1"
seta image_preload "1"
</pre>

=== The briefing is very fuzzy ===

Look into your '''DoomConfig.cfg''' inside your <tt>saintlucia</tt> or <tt>thiefsden</tt> folder and check that the
following settings are like shown below:

seta image_roundDown "1"
seta image_forceDownSize "0"
seta image_downSize "0"

=== The sky is corrupted ===

You either see black sky, or fragments of other textures. This seems only to happen on Geforce 6800 cards.

There are two fixes for this:

As a quick fix you can rename the following folder:

env/skyboxes/skybox_darkland_ne

to an different name. That will result in black sky.

Alternatively, edit the file <tt>materials/tdm_sky.mtr</tt> with '''Wordpad''' or a different editor and
find the sky material named '''textures/darkmod/nature/skybox/skybox_darkland_NE''':

<pre>
//Author: Dram
//skybox_ocean with ocean replaced with dark land
//Moon moved to north east by Fidcal
textures/darkmod/nature/skybox/skybox_darkland_NE
{
qer_editorimage env/skyboxes/skybox_ocean/ocean_ed
noFragment
noshadows
noimpact
nooverlays
forceOpaque
{
forceHighQuality
blend add
cameraCubeMap env/skyboxes/skybox_darkland_ne/darkland_NE
texgen skybox
texgen wobblesky .0 .0 .0
}
}
</pre>

In this declaration, comment out the line that reads '''forceHighQuality''' by adding <tt>//</tt> in front of it:

// forceHighQuality

That should fix the sky and make it render correctly.

== The game is '''very''' slow! ==

If you get loading times of 5 minutes or more, less than 10 FPS, or the game even stutters, please try this:

Look into your '''DoomConfig.cfg''' inside your <tt>saintlucia</tt> or <tt>thiefsden</tt> folder and check that the
following settings are like shown below:

<pre style="max-width:35em">
seta image_usePrecompressedTextures "1"
seta image_useNormalCompression "2"
seta image_useAllFormats "1"
seta image_useCompression "1"
seta image_preload "1"
</pre>

If that doesn't help, your system might run out of memory. Either upgrade to more than 1 Gbyte memory,
or try to close some other applications before playing.

Please see also the article about [[Performance Tweaks]] to improve the performance.

== Known bugs ==

=== Changing the screen resolution/aspect ratio does nothing!? ===

These changes require a restart of Doom to work. Currently, our GUI does not warn you about this. You can enter vid_restart in the console to restart the renderer without quitting the game.

[[Category:General]] [[Category:Installation]]

Installation

2009-01-12T12:01:08Z

Crispy: actual filenames

{{important|headline=Installing ''Thief's Den''?|text=You can ignore this page. Instead, follow the instructions at this link: [[Thief%27s_Den#Installation|Thief's Den Installation]].}}

{{important|headline=Installing ''The Tears of Saint Lucia''?|text=You can ignore this page. Instead, follow the instructions at this link: [[Saint_Lucia|Saint Lucia Installation]].}}

__TOC__

{{important|headline=The instructions on this page are primarily intended for beta mappers and other new team members.|text=If you're installing either of our public mission releases, ''Thief's Den'' or ''The Tears of Saint Lucia'', refer to the links given above.}}

{{important|headline=Windows users|text=You'll need to install the [http://72.8.59.188/TheDarkMod/Files/DOOM3-1.3.1.exe Doom 3 patch 1.3.1] and copy the DevIL.dll (shipped with Darkmod) library to your C:\Windows\system32 folder otherwise D3 will crash.}}

== Requirements ==

In order to install The Dark Mod, you need to have the v1.3.1 patch for Doom 3 installed. See the [[#Weblinks|download section below]] for links.

Make sure that the install path for Doom 3:

* does not contain any blanks (e.g. <code>C:/doom3</code> is ok, <code>C:/Program files/Doom3</code> is not)
* is in all lowercase (e.g. <code>/usr/local/lib/doom3</code> is ok, <code>/home/username/MyDoom</code> is not)

The latter point is especially important for Linux.

Doom 3 currently supports Windows, Linux and Mac platforms, but '''The Dark Mod''' currently supports only Windows and Linux.

== Installing The Dark Mod ==

===Install on Windows===

#Download the DarkMod package, [[#Weblinks|see below]].
# In the distribution is a DLL contained named <code>DevIL.dll</code> which is required for image handling. Since as the time of writing there is no installer, so the user must install this library himself. To do this the DLL must be copied in the <code>windows/system32</code> directory. The DLL can also be put in any other directory where a path is pointing to (meaning that the directory is included in the PATH environment variable when Doom 3 is run). If the library is not found when the mod is loaded, Doom 3 will show its blue window and can not be started.
# The downloaded archive must be extracted directly into the Doom 3 folder, which will create a darkmod folder in there, with all files necessary to run the mod.

===Install on Linux===

# You need the native version of Doom 3 installed and patched to v1.3.1, [[#Weblinks|see below]] for download links and install instructions.
# Since there is no 64 bit version of either Doom 3 or The DarkMod, on 64 bit systems you also need the 32 bit compatibility libraries installed. On some distributions like SuSE, these are included in the default installation, but on Kubuntu/Ubuntu you need to install the package called <code>ia32-lib</code> and all its dependencies. Otherwise, even the installer for Doom 3 will fail to run.
# The downloaded DarkMod archive must be extracted into your own user's Doom 3 folder, which is usually under <code>/home/username/.doom3/</code> (substitute "username" with your own username, of course). This will create a <code>darkmod</code> folder in there, with all files necessary to run the mod.
# If you get an error about GLIBCXX_3.4.9, delete or rename the files <tt>/usr/local/games/doom3/libstdc++.so.6</tt> and <tt>/usr/local/games/doom3/libgcc_s.so.1</tt>.

== Running the Mod ==

=== Changing the screen resolution ===
You can choose from the various screen resolutions in the main menu under "Settings". You'll have to restart the game for the changes to take effect.

Note to widescreen users: Doom 3 resolutions default to 4:3 screen aspect ratios. If you're running wide screens (e.g. 1280x800, 1440x900, 1680x1050) you'll need to set that ratio to 16:10 in the Video Settings.

===Loading the mod manually===

In order to run ''The Dark Mod'', Doom 3 can be started normally. In the lower right corner you can see a button saying "MOD". Clicking on this button will cause a dialog to appear listing all the mods currently installed. You can select ''Darkmod'' by choosing the appropriate entry from the dialog and load it. This will cause Doom 3 to load the mod data and initialze the mod.

===Using the command line or a shortcut (recommended)===

Alternatively, The Dark Mod can be initialized directly from the command line (or via a shortcut from the desktop) by using the command line:

* '''Windows:''' "<path to Doom 3>/doom3.exe set fs_game darkmod"
* '''Linux:''' "<path to Doom 3>/doom3 +seta com_allowConsole 1 +set fs_game darkmod"

It is recommended to use this way of running ''The Dark Mod'', as it appears that Doom 3 will handle paths more consistently then loading the mod manually.

Please see also the articles about [[Doom3 command line]] and [[Creating Desktop Shortcuts for Doom3]].

== Performance Tweaks ==

See also [[Performance Tweaks]] to make TDM run a little bit faster.

== Weblinks ==

* Doom [http://72.8.59.188/TheDarkMod/Files/DOOM3-1.3.1.exe v1.3.1 patch for Windows]
* Doom v1.3.1 for Linux: [ftp://ftp.idsoftware.com/idstuff/doom3/ FTP] [http://zerowing.idsoftware.com:6969/ BitTorrent]
* '''TODO:''' Insert download link to The DarkMod

{{installation}}

Installation

2009-01-12T11:58:34Z

Crispy: /* Installing The Dark Mod */

{{important|headline=Installing ''Thief's Den''?|text=You can ignore this page. Instead, follow the instructions at this link: [[Thief%27s_Den#Installation|Thief's Den Installation]].}}

{{important|headline=Installing ''The Tears of Saint Lucia''?|text=You can ignore this page. Instead, follow the instructions at this link: [[Saint_Lucia|Saint Lucia Installation]].}}

__TOC__

{{important|headline=The instructions on this page are primarily intended for beta mappers and other new team members.|text=If you're installing either of our public mission releases, ''Thief's Den'' or ''The Tears of Saint Lucia'', refer to the links given above.}}

{{important|headline=Windows users|text=You'll need to install the [http://72.8.59.188/TheDarkMod/Files/DOOM3-1.3.1.exe Doom 3 patch 1.3.1] and copy the DevIL.dll (shipped with Darkmod) library to your C:\Windows\system32 folder otherwise D3 will crash.}}

== Requirements ==

In order to install The Dark Mod, you need to have the v1.3.1 patch for Doom 3 installed. See the [[#Weblinks|download section below]] for links.

Make sure that the install path for Doom 3:

* does not contain any blanks (e.g. <code>C:/doom3</code> is ok, <code>C:/Program files/Doom3</code> is not)
* is in all lowercase (e.g. <code>/usr/local/lib/doom3</code> is ok, <code>/home/username/MyDoom</code> is not)

The latter point is especially important for Linux.

Doom 3 currently supports Windows, Linux and Mac platforms, but '''The Dark Mod''' currently supports only Windows and Linux.

== Installing The Dark Mod ==

===Install on Windows===

#Download the DarkMod package, [[#Weblinks|see below]].
# In the distribution is a DLL contained named <code>DevIL.dll</code> which is required for image handling. Since as the time of writing there is no installer, so the user must install this library himself. To do this the DLL must be copied in the <code>windows/system32</code> directory. The DLL can also be put in any other directory where a path is pointing to (meaning that the directory is included in the PATH environment variable when Doom 3 is run). If the library is not found when the mod is loaded, Doom 3 will show its blue window and can not be started.
# The downloaded archive must be extracted directly into the Doom 3 folder, which will create a darkmod folder in there, with all files necessary to run the mod.

===Install on Linux===

# You need the native version of Doom 3 installed and patched to v1.3.1, [[#Weblinks|see below]] for download links and install instructions.
# Since there is no 64 bit version of either Doom 3 or The DarkMod, on 64 bit systems you also need the 32 bit compatibility libraries installed. On some distributions like SuSE, these are included in the default installation, but on Kubuntu/Ubuntu you need to install the package called <code>ia32-lib</code> and all its dependencies. Otherwise, even the installer for Doom 3 will fail to run.
# The downloaded DarkMod archive must be extracted into your own user's Doom 3 folder, which is usually under <code>/home/username/.doom3/</code> (substitute "username" with your own username, of course). This will create a <code>darkmod</code> folder in there, with all files necessary to run the mod.
# If you get an error about GLIBCXX_3.4.9, browse to the folder <tt>/usr/local/games/doom3</tt> and delete or rename the libc files you find there.

== Running the Mod ==

=== Changing the screen resolution ===
You can choose from the various screen resolutions in the main menu under "Settings". You'll have to restart the game for the changes to take effect.

Note to widescreen users: Doom 3 resolutions default to 4:3 screen aspect ratios. If you're running wide screens (e.g. 1280x800, 1440x900, 1680x1050) you'll need to set that ratio to 16:10 in the Video Settings.

===Loading the mod manually===

In order to run ''The Dark Mod'', Doom 3 can be started normally. In the lower right corner you can see a button saying "MOD". Clicking on this button will cause a dialog to appear listing all the mods currently installed. You can select ''Darkmod'' by choosing the appropriate entry from the dialog and load it. This will cause Doom 3 to load the mod data and initialze the mod.

===Using the command line or a shortcut (recommended)===

Alternatively, The Dark Mod can be initialized directly from the command line (or via a shortcut from the desktop) by using the command line:

* '''Windows:''' "<path to Doom 3>/doom3.exe set fs_game darkmod"
* '''Linux:''' "<path to Doom 3>/doom3 +seta com_allowConsole 1 +set fs_game darkmod"

It is recommended to use this way of running ''The Dark Mod'', as it appears that Doom 3 will handle paths more consistently then loading the mod manually.

Please see also the articles about [[Doom3 command line]] and [[Creating Desktop Shortcuts for Doom3]].

== Performance Tweaks ==

See also [[Performance Tweaks]] to make TDM run a little bit faster.

== Weblinks ==

* Doom [http://72.8.59.188/TheDarkMod/Files/DOOM3-1.3.1.exe v1.3.1 patch for Windows]
* Doom v1.3.1 for Linux: [ftp://ftp.idsoftware.com/idstuff/doom3/ FTP] [http://zerowing.idsoftware.com:6969/ BitTorrent]
* '''TODO:''' Insert download link to The DarkMod

{{installation}}

Installation

2009-01-12T11:58:17Z

Crispy: /* Installing The Dark Mod */ fix for GLIBC errors on Linux

{{important|headline=Installing ''Thief's Den''?|text=You can ignore this page. Instead, follow the instructions at this link: [[Thief%27s_Den#Installation|Thief's Den Installation]].}}

{{important|headline=Installing ''The Tears of Saint Lucia''?|text=You can ignore this page. Instead, follow the instructions at this link: [[Saint_Lucia|Saint Lucia Installation]].}}

__TOC__

{{important|headline=The instructions on this page are primarily intended for beta mappers and other new team members.|text=If you're installing either of our public mission releases, ''Thief's Den'' or ''The Tears of Saint Lucia'', refer to the links given above.}}

{{important|headline=Windows users|text=You'll need to install the [http://72.8.59.188/TheDarkMod/Files/DOOM3-1.3.1.exe Doom 3 patch 1.3.1] and copy the DevIL.dll (shipped with Darkmod) library to your C:\Windows\system32 folder otherwise D3 will crash.}}

== Requirements ==

In order to install The Dark Mod, you need to have the v1.3.1 patch for Doom 3 installed. See the [[#Weblinks|download section below]] for links.

Make sure that the install path for Doom 3:

* does not contain any blanks (e.g. <code>C:/doom3</code> is ok, <code>C:/Program files/Doom3</code> is not)
* is in all lowercase (e.g. <code>/usr/local/lib/doom3</code> is ok, <code>/home/username/MyDoom</code> is not)

The latter point is especially important for Linux.

Doom 3 currently supports Windows, Linux and Mac platforms, but '''The Dark Mod''' currently supports only Windows and Linux.

== Installing The Dark Mod ==

===Install on Windows===

#Download the DarkMod package, [[#Weblinks|see below]].
# In the distribution is a DLL contained named <code>DevIL.dll</code> which is required for image handling. Since as the time of writing there is no installer, so the user must install this library himself. To do this the DLL must be copied in the <code>windows/system32</code> directory. The DLL can also be put in any other directory where a path is pointing to (meaning that the directory is included in the PATH environment variable when Doom 3 is run). If the library is not found when the mod is loaded, Doom 3 will show its blue window and can not be started.
# The downloaded archive must be extracted directly into the Doom 3 folder, which will create a darkmod folder in there, with all files necessary to run the mod.

===Install on Linux===

# You need the native version of Doom 3 installed and patched to v1.3.1, [[#Weblinks|see below]] for download links and install instructions.
# Since there is no 64 bit version of either Doom 3 or The DarkMod, on 64 bit systems you also need the 32 bit compatibility libraries installed. On some distributions like SuSE, these are included in the default installation, but on Kubuntu/Ubuntu you need to install the package called <code>ia32-lib</code> and all its dependencies. Otherwise, even the installer for Doom 3 will fail to run.
# The downloaded DarkMod archive must be extracted into your own user's Doom 3 folder, which is usually under <code>/home/username/.doom3/</code> (substitute "username" with your own username, of course). This will create a <code>darkmod</code> folder in there, with all files necessary to run the mod.
# If you get an error about GLIBCXX_3.4.9, browse to the folder <tt>/usr/local/games/doom3</tt> and delete or rename the glibc files you find there.

== Running the Mod ==

=== Changing the screen resolution ===
You can choose from the various screen resolutions in the main menu under "Settings". You'll have to restart the game for the changes to take effect.

Note to widescreen users: Doom 3 resolutions default to 4:3 screen aspect ratios. If you're running wide screens (e.g. 1280x800, 1440x900, 1680x1050) you'll need to set that ratio to 16:10 in the Video Settings.

===Loading the mod manually===

In order to run ''The Dark Mod'', Doom 3 can be started normally. In the lower right corner you can see a button saying "MOD". Clicking on this button will cause a dialog to appear listing all the mods currently installed. You can select ''Darkmod'' by choosing the appropriate entry from the dialog and load it. This will cause Doom 3 to load the mod data and initialze the mod.

===Using the command line or a shortcut (recommended)===

Alternatively, The Dark Mod can be initialized directly from the command line (or via a shortcut from the desktop) by using the command line:

* '''Windows:''' "<path to Doom 3>/doom3.exe set fs_game darkmod"
* '''Linux:''' "<path to Doom 3>/doom3 +seta com_allowConsole 1 +set fs_game darkmod"

It is recommended to use this way of running ''The Dark Mod'', as it appears that Doom 3 will handle paths more consistently then loading the mod manually.

Please see also the articles about [[Doom3 command line]] and [[Creating Desktop Shortcuts for Doom3]].

== Performance Tweaks ==

See also [[Performance Tweaks]] to make TDM run a little bit faster.

== Weblinks ==

* Doom [http://72.8.59.188/TheDarkMod/Files/DOOM3-1.3.1.exe v1.3.1 patch for Windows]
* Doom v1.3.1 for Linux: [ftp://ftp.idsoftware.com/idstuff/doom3/ FTP] [http://zerowing.idsoftware.com:6969/ BitTorrent]
* '''TODO:''' Insert download link to The DarkMod

{{installation}}

Installation

2008-10-30T09:29:13Z

Crispy:

{{important|headline=Installing ''Thief's Den''?|text=You can ignore this page. Instead, follow the instructions at this link: [[Thief%27s_Den#Installation|Thief's Den Installation]].}}

{{important|headline=Installing ''The Tears of Saint Lucia''?|text=You can ignore this page. Instead, follow the instructions at this link: [[Saint_Lucia|Saint Lucia Installation]].}}

__TOC__

{{important|headline=The instructions on this page are primarily intended for beta mappers and other new team members.|text=If you're installing either of our public mission releases, ''Thief's Den'' or ''The Tears of Saint Lucia'', refer to the links given above.}}

{{important|headline=Windows users|text=You'll need to install the [http://72.8.59.188/TheDarkMod/Files/DOOM3-1.3.1.exe Doom 3 patch 1.3.1] and copy the DevIL.dll (shipped with Darkmod) library to your C:\Windows\system32 folder otherwise D3 will crash.}}

== Requirements ==

In order to install The Dark Mod, you need to have the v1.3.1 patch for Doom 3 installed. See the [[#Weblinks|download section below]] for links.

Make sure that the install path for Doom 3:

* does not contain any blanks (e.g. <code>C:/doom3</code> is ok, <code>C:/Program files/Doom3</code> is not)
* is in all lowercase (e.g. <code>/usr/local/lib/doom3</code> is ok, <code>/home/username/MyDoom</code> is not)

The latter point is especially important for Linux.

Doom 3 currently supports Windows, Linux and Mac platforms, but '''The Dark Mod''' currently supports only Windows and Linux.

== Installing The Dark Mod ==

===Install on Windows===

#Download the DarkMod package, [[#Weblinks|see below]].
# In the distribution is a DLL contained named <code>DevIL.dll</code> which is required for image handling. Since as the time of writing there is no installer, so the user must install this library himself. To do this the DLL must be copied in the <code>windows/system32</code> directory. The DLL can also be put in any other directory where a path is pointing to (meaning that the directory is included in the PATH environment variable when Doom 3 is run). If the library is not found when the mod is loaded, Doom 3 will show its blue window and can not be started.
# The downloaded archive must be extracted directly into the Doom 3 folder, which will create a darkmod folder in there, with all files necessary to run the mod.

===Install on Linux===

# You need the native version of Doom 3 installed and patched to v1.3.1, [[#Weblinks|see below]] for download links and install instructions.
# Since there is no 64 bit version of either Doom 3 or The DarkMod, on 64 bit systems you also need the 32 bit compatibility libraries installed. On some distributions like SuSE, these are included in the default installation, but on Kubuntu/Ubuntu you need to install the package called <code>ia32-lib</code> and all its dependencies. Otherwise, even the installer for Doom 3 will fail to run.
# The downloaded DarkMod archive must be extracted into your own user's Doom 3 folder, which is usually under <code>/home/username/.doom3/</code> (substitute "username" with your own username, of course). This will create a <code>darkmod</code> folder in there, with all files necessary to run the mod.

== Running the Mod ==

=== Changing the screen resolution ===
You can choose from the various screen resolutions in the main menu under "Settings". You'll have to restart the game for the changes to take effect.

Note to widescreen users: Doom 3 resolutions default to 4:3 screen aspect ratios. If you're running wide screens (e.g. 1280x800, 1440x900, 1680x1050) you'll need to set that ratio to 16:10 in the Video Settings.

===Loading the mod manually===

In order to run ''The Dark Mod'', Doom 3 can be started normally. In the lower right corner you can see a button saying "MOD". Clicking on this button will cause a dialog to appear listing all the mods currently installed. You can select ''Darkmod'' by choosing the appropriate entry from the dialog and load it. This will cause Doom 3 to load the mod data and initialze the mod.

===Using the command line or a shortcut (recommended)===

Alternatively, The Dark Mod can be initialized directly from the command line (or via a shortcut from the desktop) by using the command line:

* '''Windows:''' "<path to Doom 3>/doom3.exe set fs_game darkmod"
* '''Linux:''' "<path to Doom 3>/doom3 +seta com_allowConsole 1 +set fs_game darkmod"

It is recommended to use this way of running ''The Dark Mod'', as it appears that Doom 3 will handle paths more consistently then loading the mod manually.

Please see also the articles about [[Doom3 command line]] and [[Creating Desktop Shortcuts for Doom3]].

== Performance Tweaks ==

See also [[Performance Tweaks]] to make TDM run a little bit faster.

== Weblinks ==

* Doom [http://72.8.59.188/TheDarkMod/Files/DOOM3-1.3.1.exe v1.3.1 patch for Windows]
* Doom v1.3.1 for Linux: [ftp://ftp.idsoftware.com/idstuff/doom3/ FTP] [http://zerowing.idsoftware.com:6969/ BitTorrent]
* '''TODO:''' Insert download link to The DarkMod

{{installation}}

Installation

2008-10-30T09:28:41Z

Crispy:

{{important|headline=Installing ''Thief's Den''?|text=You can ignore this page. Instead, follow the instructions at this link: [[Thief%27s_Den#Installation|Thief's Den Installation]].}}

{{important|headline=Installing ''The Tears of Saint Lucia''?|text=You can ignore this page. Instead, follow the instructions at this link: [[Saint_Lucia|Saint Lucia Installation]].}}

__TOC__

{{important|headline=The instructions on this page are primarily intended for beta mappers and other new team members.|text=If you're installing either of our public mission releases, ''Thief's Den'' or ''The Tears of Saint Lucia'', refer to the links given above.}}

{{important|headline=Windows users (but not Thief's Den)|text=You'll need to install the [http://72.8.59.188/TheDarkMod/Files/DOOM3-1.3.1.exe Doom 3 patch 1.3.1] and copy the DevIL.dll (shipped with Darkmod) library to your C:\Windows\system32 folder otherwise D3 will crash.}}

== Requirements ==

In order to install The Dark Mod, you need to have the v1.3.1 patch for Doom 3 installed. See the [[#Weblinks|download section below]] for links.

Make sure that the install path for Doom 3:

* does not contain any blanks (e.g. <code>C:/doom3</code> is ok, <code>C:/Program files/Doom3</code> is not)
* is in all lowercase (e.g. <code>/usr/local/lib/doom3</code> is ok, <code>/home/username/MyDoom</code> is not)

The latter point is especially important for Linux.

Doom 3 currently supports Windows, Linux and Mac platforms, but '''The Dark Mod''' currently supports only Windows and Linux.

== Installing The Dark Mod ==

===Install on Windows===

#Download the DarkMod package, [[#Weblinks|see below]].
# In the distribution is a DLL contained named <code>DevIL.dll</code> which is required for image handling. Since as the time of writing there is no installer, so the user must install this library himself. To do this the DLL must be copied in the <code>windows/system32</code> directory. The DLL can also be put in any other directory where a path is pointing to (meaning that the directory is included in the PATH environment variable when Doom 3 is run). If the library is not found when the mod is loaded, Doom 3 will show its blue window and can not be started.
# The downloaded archive must be extracted directly into the Doom 3 folder, which will create a darkmod folder in there, with all files necessary to run the mod.

===Install on Linux===

# You need the native version of Doom 3 installed and patched to v1.3.1, [[#Weblinks|see below]] for download links and install instructions.
# Since there is no 64 bit version of either Doom 3 or The DarkMod, on 64 bit systems you also need the 32 bit compatibility libraries installed. On some distributions like SuSE, these are included in the default installation, but on Kubuntu/Ubuntu you need to install the package called <code>ia32-lib</code> and all its dependencies. Otherwise, even the installer for Doom 3 will fail to run.
# The downloaded DarkMod archive must be extracted into your own user's Doom 3 folder, which is usually under <code>/home/username/.doom3/</code> (substitute "username" with your own username, of course). This will create a <code>darkmod</code> folder in there, with all files necessary to run the mod.

== Running the Mod ==

=== Changing the screen resolution ===
You can choose from the various screen resolutions in the main menu under "Settings". You'll have to restart the game for the changes to take effect.

Note to widescreen users: Doom 3 resolutions default to 4:3 screen aspect ratios. If you're running wide screens (e.g. 1280x800, 1440x900, 1680x1050) you'll need to set that ratio to 16:10 in the Video Settings.

===Loading the mod manually===

In order to run ''The Dark Mod'', Doom 3 can be started normally. In the lower right corner you can see a button saying "MOD". Clicking on this button will cause a dialog to appear listing all the mods currently installed. You can select ''Darkmod'' by choosing the appropriate entry from the dialog and load it. This will cause Doom 3 to load the mod data and initialze the mod.

===Using the command line or a shortcut (recommended)===

Alternatively, The Dark Mod can be initialized directly from the command line (or via a shortcut from the desktop) by using the command line:

* '''Windows:''' "<path to Doom 3>/doom3.exe set fs_game darkmod"
* '''Linux:''' "<path to Doom 3>/doom3 +seta com_allowConsole 1 +set fs_game darkmod"

It is recommended to use this way of running ''The Dark Mod'', as it appears that Doom 3 will handle paths more consistently then loading the mod manually.

Please see also the articles about [[Doom3 command line]] and [[Creating Desktop Shortcuts for Doom3]].

== Performance Tweaks ==

See also [[Performance Tweaks]] to make TDM run a little bit faster.

== Weblinks ==

* Doom [http://72.8.59.188/TheDarkMod/Files/DOOM3-1.3.1.exe v1.3.1 patch for Windows]
* Doom v1.3.1 for Linux: [ftp://ftp.idsoftware.com/idstuff/doom3/ FTP] [http://zerowing.idsoftware.com:6969/ BitTorrent]
* '''TODO:''' Insert download link to The DarkMod

{{installation}}

Installation

2008-10-30T09:28:00Z

Crispy: Redirect people looking for Saint Lucia to SL page; clarify purpose of this page

{{important|headline=Installing ''Thief's Den''?|text=You can ignore this page. Instead, follow the instructions at this link: [[Thief%27s_Den#Installation|Thief's Den Installation]].}}

{{important|headline=Installing ''The Tears of Saint Lucia''?|text=You can ignore this page. Instead, follow the instructions at this link: [[Saint_Lucia|Saint Lucia Installation]].}}

__TOC__

{{important|headline=The instructions on this page are primarily intended for beta mappers and other new team members.|text=If you're installing our standalone alpha releases, ''Thief's Den'' or ''The Tears of Saint Lucia'', refer to the links given above.}}

{{important|headline=Windows users (but not Thief's Den)|text=You'll need to install the [http://72.8.59.188/TheDarkMod/Files/DOOM3-1.3.1.exe Doom 3 patch 1.3.1] and copy the DevIL.dll (shipped with Darkmod) library to your C:\Windows\system32 folder otherwise D3 will crash.}}

== Requirements ==

In order to install The Dark Mod, you need to have the v1.3.1 patch for Doom 3 installed. See the [[#Weblinks|download section below]] for links.

Make sure that the install path for Doom 3:

* does not contain any blanks (e.g. <code>C:/doom3</code> is ok, <code>C:/Program files/Doom3</code> is not)
* is in all lowercase (e.g. <code>/usr/local/lib/doom3</code> is ok, <code>/home/username/MyDoom</code> is not)

The latter point is especially important for Linux.

Doom 3 currently supports Windows, Linux and Mac platforms, but '''The Dark Mod''' currently supports only Windows and Linux.

== Installing The Dark Mod ==

===Install on Windows===

#Download the DarkMod package, [[#Weblinks|see below]].
# In the distribution is a DLL contained named <code>DevIL.dll</code> which is required for image handling. Since as the time of writing there is no installer, so the user must install this library himself. To do this the DLL must be copied in the <code>windows/system32</code> directory. The DLL can also be put in any other directory where a path is pointing to (meaning that the directory is included in the PATH environment variable when Doom 3 is run). If the library is not found when the mod is loaded, Doom 3 will show its blue window and can not be started.
# The downloaded archive must be extracted directly into the Doom 3 folder, which will create a darkmod folder in there, with all files necessary to run the mod.

===Install on Linux===

# You need the native version of Doom 3 installed and patched to v1.3.1, [[#Weblinks|see below]] for download links and install instructions.
# Since there is no 64 bit version of either Doom 3 or The DarkMod, on 64 bit systems you also need the 32 bit compatibility libraries installed. On some distributions like SuSE, these are included in the default installation, but on Kubuntu/Ubuntu you need to install the package called <code>ia32-lib</code> and all its dependencies. Otherwise, even the installer for Doom 3 will fail to run.
# The downloaded DarkMod archive must be extracted into your own user's Doom 3 folder, which is usually under <code>/home/username/.doom3/</code> (substitute "username" with your own username, of course). This will create a <code>darkmod</code> folder in there, with all files necessary to run the mod.

== Running the Mod ==

=== Changing the screen resolution ===
You can choose from the various screen resolutions in the main menu under "Settings". You'll have to restart the game for the changes to take effect.

Note to widescreen users: Doom 3 resolutions default to 4:3 screen aspect ratios. If you're running wide screens (e.g. 1280x800, 1440x900, 1680x1050) you'll need to set that ratio to 16:10 in the Video Settings.

===Loading the mod manually===

In order to run ''The Dark Mod'', Doom 3 can be started normally. In the lower right corner you can see a button saying "MOD". Clicking on this button will cause a dialog to appear listing all the mods currently installed. You can select ''Darkmod'' by choosing the appropriate entry from the dialog and load it. This will cause Doom 3 to load the mod data and initialze the mod.

===Using the command line or a shortcut (recommended)===

Alternatively, The Dark Mod can be initialized directly from the command line (or via a shortcut from the desktop) by using the command line:

* '''Windows:''' "<path to Doom 3>/doom3.exe set fs_game darkmod"
* '''Linux:''' "<path to Doom 3>/doom3 +seta com_allowConsole 1 +set fs_game darkmod"

It is recommended to use this way of running ''The Dark Mod'', as it appears that Doom 3 will handle paths more consistently then loading the mod manually.

Please see also the articles about [[Doom3 command line]] and [[Creating Desktop Shortcuts for Doom3]].

== Performance Tweaks ==

See also [[Performance Tweaks]] to make TDM run a little bit faster.

== Weblinks ==

* Doom [http://72.8.59.188/TheDarkMod/Files/DOOM3-1.3.1.exe v1.3.1 patch for Windows]
* Doom v1.3.1 for Linux: [ftp://ftp.idsoftware.com/idstuff/doom3/ FTP] [http://zerowing.idsoftware.com:6969/ BitTorrent]
* '''TODO:''' Insert download link to The DarkMod

{{installation}}

DDS creation

2008-10-01T09:59:01Z

Crispy: put table of contents back in usual place

This should describe the steps you'll have to follow in order to create DDS files suitable for use in your Dark Mod maps and how to convert from DDS to other image formats using "The Compressonator"

==Converting Image TO DDS==

You'll need [http://208.49.149.118/TheDarkMod/Files/ATI_Compressonator_v1.21.zip ATI's "The Compressonator" application version 1.21.1044] with this exact version - other (newer) versions will not work! Install/unzip it to a folder and create a shortcut if you like.

{{important|headline=Important|text=The normalmap DDS compression section is here for documentation purposes only. '''You don't need to compress the normalmaps for using them in The Dark Mod.''' Only compress the diffusemaps and speculars.}}

=== Compress Diffuse/Specular Maps ===
* Open your source (TGA) file
* Create Mip Maps using the '''Box-Filter''' with the lowest mip map size of '''1x1'''.
[[Image:01_mips.jpg|frameless]]

* Compress the Image using '''DXT1 compression (0/1 bit alpha)''' with a colour weighting of '''red=0.3086, green=0.6094, blue=0.082'''. This applies for images '''without alpha'''. For images with alpha you'll have to choose the DXT3 compression.
[[Image:02_compression.jpg|frameless]]

* Save your DDS to the '''dds/''' tree, e.g. dds/textures/darkmod/stone/blah.dds. You won't need to add the dds/ path prefix to your shader definition, this is automatically added by the game.

=== Compress Normalmaps ===
{{important|headline=Important|text=The normalmap DDS compression section is here for documentation purposes only. You '''don't''' need to compress the normalmaps for using them in The Dark Mod.}}

* Open your source (TGA) file
* Create Mip Maps using the '''Box-Filter''' with the lowest mip map size of '''1x1''' (same as for the diffuse maps).
[[Image:01_normal_mips.jpg|frameless]]
* Compress your normalmap using the '''UberCompressor''' in '''DXT5 RXGB''' format with the colour weighting of '''red=0, green=0.5, blue=0.5''' and '''"adaptive" ticked off'''.
[[Image:02_normal_compression.jpg|frameless]]
* Save your DDS to the '''dds/''' tree, e.g. dds/textures/darkmod/stone/blah_local.dds. You won't need to add the dds/ path prefix to your shader definition, this is automatically added by the game.

=== Batch Processing ===
Choose '''File > Batch Compress''' or hit F4 to open the batch compression dialog. Choose the same compression settings as described above for your diffuse and normal maps. Don't mix diffuse/speculars with normals as they require different compression settings.

[[Image:dds_batch_screenshot.jpg|frameless]]

=== Change the File Extension to lowercase ===
The Compressonator automatically names the file *.DDS, but all files should be lowercase (also the TGAs). Be sure to rename the files to a lowercase .dds extension before uploading them.

Option A: Use Windows Explorer. You need to change your Explorer settings to display the file extension:
# Open up Windows Explorer
# Go '''Tools''' > '''Folder Options'''
# Click the View tab and uncheck '''Hide extensions for known file types'''

Then you can highlight your file and hit F2 (or right-click > Rename) and change the extension to lowercase.

Option B: This can also be done via the command line '''Start''' > '''Run...''' > '''cmd''' (then cd to your textures folder) and rename the files via:
ren *.DDS *.dds

=== Command Line Parameters ===
ATI's compressonator provides some command line parameters to compress the textures:
thecompressonator -convert "normal.tga" "normal.dds" RXGB +red 0.0 +green 0.5 +blue 0.5 -mipmaps
thecompressonator -convert "specular.tga" "specular.dds" DXT1 -mipmaps
thecompressonator -convert "diffuse.tga" "diffuse.dds" DXT1 -mipmaps
thecompressonator -convert "diffuse_with_alpha.tga" "diffuse.dds" DXT3 -mipmaps

==Converting FROM DDS to common image file formats==

This is trivial but slightly confusing on The Compressonator:

* File Menu > Save Original
* At the bottom of the dialog below the file name input select ''save as type''. It may show DDS by default so don't be put off.
* Select file format from BMP, PNG, or TGA (use TGA generally for Dark Mod.)
* Make sure the filename you want is shown in the input box and click ''save''.

[[Category:Tutorial]]
[[Category:Textures]]

Overriding animations via attached objects

2008-08-31T02:55:44Z

Crispy: small correction (only works when attaching to actors)

TDM has a mechanism for causing AIs (and other actors) to automatically use different sets of animations when certain objects are attached to them. This could be used for weapons, torches, bandages, or anything else you can think of. It works as follows.

==Basic usage==

When an entity (for example, a longsword) is attached to an actor (for example, an AI), the code will look for spawnargs on the first entity (the longsword) with keys that start with "replace_anim_". The remainder of the key is the animation to replace on the actor/AI, and the value is the animation to replace it with. For example:

"replace_anim_throw" "look_around"

Placing the above line in the ai_weapon_longsword entityDef would cause AIs carrying longswords to use their "look_around" animation whenever they would normally use their "throw" animation.

'''Note:''' The animation names are the ones specified in the model def. They are not filenames.

The practical uses for this include being able to have different animations for guards carrying torches, and/or different weapons. Some examples:

* AIs carrying hammers should use two-handed overhead swings to attack instead of one-handed slashes. A dagger needs a stabbing motion. A club is different again. And so on.
* In a "peering around" animation, a non-torch-carrying guard might put his left hand up to shield his eyes. If he was holding a torch, though, this would burn him. To prevent this, you could add <tt>"replace_anim_peering_around" "peering_around_torch"</tt> to the torch entityDef. This would replace the <tt>peering_around</tt> anim with <tt>peering_around_torch</tt> for torch-carrying entities. The replacement animation might have the left hand lifted up in the air (to illuminate the surroundings) instead.
* A guard with a bandaged leg (an attached bandage entity) could be made to limp instead of walking normally.

==Combining multiple replacements (advanced)==

So far so good, but what if we want to combine several uses? What if a torch-carrying hammer-wielding guard should have a different animation from a non-torch-carrying hammer-wielder, which is different again from a torch-carrying sword-wielder? Well, animations can be replaced multiple times.

Let's assume that the default melee_attack anim is for a sword-wielding guard with no torch. In the torch entityDef, you'd put:
<pre>"replace_anim_melee_attack" "melee_attack_torch"
"replace_anim_hammer_attack" "hammer_attack_torch"</pre>

And in the hammer entityDef, you'd put:
<pre>"replace_anim_melee_attack" "hammer_attack"
"replace_anim_melee_attack_torch" "hammer_attack_torch"</pre>

(If this seems a little redundant, it is - there are two ways to get from <tt>melee_attack</tt> to <tt>hammer_attack_torch</tt>. However, there's no reliable way to know whether the torch's replacements or the hammer's replacements take precedence. So you need both, or Bad Things Will Happen. This is perhaps not ideal, but it does keep the feature simple. Hopefully there will never be a need for more than 2-3 replacements at once anyway.)

The console will throw up a warning if you cause an infinite loop of replacements pointing at each other.

[[Category:Animation]]

Spiral Staircases

2008-08-17T01:43:44Z

Crispy: uploaded first few images to wiki

{{missing-image}} {{Original_Reference|Renzatic|125}}

== Basic Room Geometry ==
Okay, let's start out with the basics here. Choose the caulk texture (located in textures/textures/common from your media tab, more on this later) and make a brush that's 256x256x320 (4x4 big grids on the overhead map), and while selected hit the [[Image:Button_hollow.jpg]] hollow button. The end results should look like this...

[[Image:Hollowed_room.jpg]]

This will be the foundation of your tower. You want the solid brushes as your backing to prevent BSP holes, even though you can't walk through them the engine considers the patches you're gonna make as nonsolids.

Now we're getting to the fun part: Patches. make a brush that's 128x128x320 and fit it in the corner of your tower like wah:

[[Image:Corner_brush.jpg]]

This will give you the basic outline of where your bevel is gonna be. So, while still keeping the brush selected, go to your patch menu and select Bevel.

[[Image:Patch_menu.jpg]]

The end result should look something like this...

[[Image:Bevel.jpg]]

Wow, what a nice curve! Too bad it's facing the wrong way, huh? Guess we'll need to fix that....here's how you do it:

Select your newly created bevel, and hit the [[Image:Z_rotate_key.jpg]] Z axis rotation Key until you get it where you want it...

[[Image:Rotated_bevel.jpg]]

You'll want the ends to line up with the edges of where your original brush was as well, overlapping is generally something you'll want to avoid so get in the habit of making sure everything is aligned properly. If you find that your bevel is a bit larger than what it should be, simply push the ends and resize it til it fits where you want it to go. It should meet up with the center like...

[[Image:Aligned_bevel.jpg]]

Now this'll be the moment that you notice that patches are all one sided...you can see the foundation wall through the mesh. This is an easy problem to fix, all you need to do is go to your patch menu, matrix, and select invert...like so...

[[Image:invert.jpg]]

By this point you should have one corner of your future tower done. To finish the rest all you need to do is select your bevel, copy it, paste it (ctrl-c to copy and ctrl-v to paste, get used to using this), and rotate it on the http://users.chartertn.net/greymatt/tutorial/z_rotate_key.jpg Z-axis like you did before. Do it 4 times and you should have the outer wall of your tower.

http://users.chartertn.net/greymatt/tutorial/outer_wall.jpg

Now for your center piece (there's probably some nice architectural term for it, but hell if I know what it is), this is even easier than the bevels and should only take you 2 steps to finish up.

First, make a square in the center...it can be any size you want as long as it's as tall as the rest of your tower. Mine looks like this...

http://users.chartertn.net/greymatt/tutorial/center.jpg

Now go back to your patch menu, select cylinder..

http://users.chartertn.net/greymatt/tutorial/patch_cylinder.jpg

and voila, the basic structure of your tower is now done.

http://users.chartertn.net/greymatt/tutorial/center_cylinder.jpg

Once you get used to it you can make this room in about a minute and a half. You can go ahead and texture it if you want, but make sure that when you select one of the brushes (as opposed to the patches) you just select the face that you'll see. The caulk texture keeps the engine from rendering unseen faces, you won't need a texture on the bottom half of the floor that's forever blocked from your view, just the side you'll see. To select a single face just hold down ctrl-shift and left click the face you want to select.

You can use any texture you want, but I'm gonna go ahead and use one of our textures for the walls. Go ahead and do a regular shift-left click on the patches, and apply the textures, then do the ctrl-shift-leftclick on the floor and apply there too. Hit the S key when you have a surface or a brush selected to bring up the texture tweaker and play with this til you think they look alright. My end results look something like this...

http://users.chartertn.net/greymatt/tutorial/textured_tower.jpg

Next I'll be getting into the more complicated half of the tutorial...making the steps. It's a bit more indepth than doing the rest of the tower, but by the time you're done you should be pretty comfortable with using the cut tool and playing around on the ultra small grid spacings.

== The Staircase ==
Now lets get on with the whole point of making a spiral staircase....the staircase.

Okay, make a 64x64x8 brush, select a good stair texture..I'm gonna use hell/boards1, and align it where you want your stairs to start. It'll look pretty similar to how you started your bevel once you're done. Just make sure that the brush is setting on top of the floor and not in it.

http://users.chartertn.net/greymatt/tutorial/stair_start.jpg

Now we're gonna get into http://users.chartertn.net/greymatt/tutorial/cutting.jpg BSP clipping. With this button selected you'll be able to place guide points showing where you want to make a cut across a brush. It's an important tool that you'll find you can't live without once you really get into mapping.

http://users.chartertn.net/greymatt/tutorial/bsp_cut.jpg

The yellow half of the cut represents what the editor is gonna keep, the other half will be deleted. If you find that you want to keep the part being seleced for deletion you can always go to selection/clipper/flip clip orientation.

http://users.chartertn.net/greymatt/tutorial/clipper_menu.jpg

All the options are fairly self explanatory, but keep split selection (selectedion?) in mind, we'll be using that quite a bit in a few.

You're gonna be using the contours of your inner column and outer walls as the guidelines for your steps. So with keeping that in mind you're gonna select your board textured square, hit the http://users.chartertn.net/greymatt/tutorial/cutting.jpg clipping tool button, and set your grid to 1 by either hitting 1 on the keyboard or selecting it from the grid menu near the top of the screen (nope, not gonna post a pic, it's easy to find).

What you're gonna want to do is put a cut point at the top left of the square and one roughly on where the bevel bends...

http://users.chartertn.net/greymatt/tutorial/cut1.jpg

and then split the selection by either going to the clipper menu shown above or hitting shift-enter. Do this along every bevel bend (you don't necessarily HAVE to, but it makes step 2 & 3 much easier) and work your way around the brush using the patch contours as your guide.

http://users.chartertn.net/greymatt/tutorial/cut2.jpg

http://users.chartertn.net/greymatt/tutorial/cut3.jpg

...and there you have it. The first 8 steps of your stairway. We're not quite through yet, we've still got to trim off the edges that are sticking out beyond the wall to make it all nice and t-i-i-i-ight and purdy.

Now your old brush is now 8 new brushes, and you'll want to treat them as such. Select the first step and fire up the http://users.chartertn.net/greymatt/tutorial/cutting.jpg clipper yet again. Now it's time to trim the edges. Put your cutting points along the line that it meets the cylinder and cut off the bit that pokes into. Go to a smaller grid if you have to make it line up right, and doing a clip/flip if you're cutting the wrong section...and remember that undo is your friend if you screw up.

http://users.chartertn.net/greymatt/tutorial/trimming1.jpg

You'll find that with the cylinder edges you can sometimes select 2 steps and cut em both as shown in the pic...it won't be this easy on the on the outer bevel edges, you'll have to do them seperately.

http://users.chartertn.net/greymatt/tutorial/trimming2.jpg

Do this for all the steps and you'll eventually end up with this...

http://users.chartertn.net/greymatt/tutorial/stairwell1.jpg

If you find that the edges don't match up exactly, and they probably won't for the bevel edges, the cylinder edges usually do, don't panic. When you're working on a grid that small (I had to go to grid 0.5 to get it right) any place where the steps don't meet up with the wall won't be noticed...just try to get it as close as possible and err on the outside of the bevel rather than the inside.

Now your steps are almost complete. Now all you need to do is switch back to a higher grid and adjust the brushes so they actually make the steps. Compared to what we just did this part is easy, and shouldn't take you more than a couple of minutes at most.

http://users.chartertn.net/greymatt/tutorial/steps.jpg

What I usually do is size the brushes one grid unit up on the Z window, but if you want planks then just move the entire brushes up one space each...easy as that.

Of course the bigger the grid is set to the larger the steps are obviously gonna be. For this example I'm using the 8-grid, but when you're actually designing maps I'd use the 4-grid at most...Doom 3 works on a really small scale in comparison to other Radiant games so keep that in mind when.

Now comes the last step...select your 8 brushes, copy them, rotate them using the Z rotation button, and then just tweak them til you're satisified. The finished results should look like...

http://users.chartertn.net/greymatt/tutorial/finished_product.jpg

Now all you need to do is mess with the textures on the steps to get them to align properly (it'll look like crap if you leave it as-is), and you've finished your first spiral staircase.

[[Category:Editing]]
[[Category:Tutorial]]

File:Invert.jpg

2008-08-17T01:42:40Z

Crispy: Image from Spiral Staircases tutorial.

Image from [[Spiral Staircases]] tutorial.

File:Aligned bevel.jpg

2008-08-17T01:42:23Z

Crispy: Image from Spiral Staircases tutorial.

Image from [[Spiral Staircases]] tutorial.

File:Rotated bevel.jpg

2008-08-17T01:42:09Z

Crispy: Image from Spiral Staircases tutorial.

Image from [[Spiral Staircases]] tutorial.

File:Z rotate key.jpg

2008-08-17T01:41:40Z

Crispy: Z axis rotation toolbar button

Z axis rotation toolbar button

File:Bevel.jpg

2008-08-17T01:40:56Z

Crispy: Image from Spiral Staircases tutorial.

Image from [[Spiral Staircases]] tutorial.

File:Patch menu.jpg

2008-08-17T01:40:37Z

Crispy: Image from Spiral Staircases tutorial.

Image from [[Spiral Staircases]] tutorial.

File:Corner brush.jpg

2008-08-17T01:39:41Z

Crispy: Image from Spiral Staircases tutorial.

Image from [[Spiral Staircases]] tutorial.

File:Button hollow.jpg

2008-08-17T01:39:01Z

Crispy: "Hollow" toolbar button

"Hollow" toolbar button

File:Hollowed room.jpg

2008-08-17T01:35:23Z

Crispy: Image from Spiral Staircases tutorial.

Image from [[Spiral Staircases]] tutorial.

Arrow sticking behaviour

2008-07-14T07:03:14Z

Crispy: usage examples

Broadhead arrows will stick into some objects they hit. Here is a description of the logic behind whether or not an arrow sticks in.

* The most important thing is the [[Surface_Types#What_surfaces_do|surface type]] of the object. Arrows will only stick into "soft" surfaces; for example, flesh, wood, and dirt, among others.
* Arrows will not stick into living AIs. This is to avoid guards sauntering around with dirty great arrows sticking out of their chests, which looks silly. Note that an arrow which kills an AI ''will'' stick, even if the AI was alive before being shot.
* Arrows will not stick into objects attached to living AIs, principally because this includes AI heads.
* You can override some of these rules using two spawnargs, '''arrowsticking_forceenabled''' and '''arrowsticking_disabled''', which are documented below.

==Overriding arrow-sticking behaviour==

To force arrows to never stick in an entity, set the spawnarg '''arrowsticking_disabled''' like so: "arrowsticking_disabled" "1"

* Usage example: There are sometimes instability problems with certain ragdolls (AFs) when they have arrows fired into them. arrowsticking_disabled provides a quick and dirty way to get around this.

To force arrows to always stick in an entity, ''provided that the surface type is soft'', you can set the spawnarg '''arrowsticking_forceenabled''' like so: "arrowsticking_forceenabled" "1". However, arrows will still break rather than sticking into the entity's hard surfaces, if it has any.

* Usage example: Suppose you've given an AI a wooden shield to carry. Since the shield is attached to the AI, arrows won't normally stick in it, according to the rules above. To fix this, you can set "arrowsticking_forceenabled" "1" on the shield.

AI heads are usually separate entities from AI bodies, so if you change these spawnargs for an AI entity make sure to also change the spawnargs for its head entity (if it has one).

==Info for coders==

This logic is in tdm_weapon_arrow_result_base.script. The active() method is called when an arrow hits a soft surface; dud() is called if it hits a hard surface.

[[Category:Editing]]
[[Category:Scripting]]

Arrowsticking forceenabled

2008-07-14T06:57:08Z

Crispy: Redirecting to Arrow sticking behaviour

#REDIRECT [[Arrow_sticking_behaviour]]

[[Category:Spawnargs]]

Arrowsticking disabled

2008-07-14T06:56:46Z

Crispy: Redirecting to Arrow sticking behaviour

#REDIRECT [[Arrow_sticking_behaviour]]

[[Category:Spawnargs]]