The DarkMod Wiki - User contributions [en]

Reporting Problem

2026-04-24T23:16:47Z

Datiswous: /* Coordinates */

If TDM does not work properly for you, the best thing to do would be to report the problem.

You are welcome to post in Tech Support section of the [[The_Dark_Mod#Dark_Mod_Forums|forums]], even if you suspect the problem is with your machine or you want to get some help/clarifications.
When there is clearly a problem with TDM itself, an issue is usually created in the [[The_Dark_Mod#Bugtracker|bugtracker]].
But since the bugtracker is a rather technical place, it is more advised to report problems in the forum.
Sooner or later someone will create the issue anyway if it is really needed.

This article describes some general information typically requested from everyone who reports a problem.

== Baseline ==

This pieces of information are almost mandatory:

# Contents of <tt>darkmod.cfg</tt>.
# Contents of game console at some moment (known as "condump").
# In case of graphical issue, a screenshot showing the problem is often needed.

You can omit this information when writing a post on the forums: maybe your issue is trivial and someone will quickly explain what's wrong.
If it is not obvious, then you will soon be asked for it anyway =)

However, when creating an issue on the bugtracker, it is highly desirable to include all of these things, as well as the steps to reproduce.

=== darkmod.cfg ===

The file named <tt>darkmod.cfg</tt> should be located in the root directory of TDM installation.
If in doubt, you can locate this directory by checking what executable is run when you start the game: it is in the same directory.
Let's assume for the rest of the article that root directory is <tt>C:\games\thedarkmod</tt>

This file stores the values of all switches and tweaks that player can change.
The game may work in completely different ways depending on these values, thus they are very important for reproducing the problem.

When reporting the problem on forums, you can do one of:
* Attach it to a forum post. In this case rename it to something like <tt>darkmod_cfg.txt</tt>, the forum forbids anything except txt files.
* Copy/paste the full contents of the file into the post. In this case, please wrap it into "spoiler" tag, so that readers don't have to always scroll across the 5 pages of it.

When reporting on bugtracker, just attach the <tt>darkmod.cfg</tt> file to the issue.

=== condump ===

The term "condump" means all the text written to the game console.
You can usually open game console by pressing either Tilde(~) key or Ctrl+Alt+Tilde combo.

There are two ways to save the contents of game console into a file:

:'''1) condump.''' Open game console, type the following and hit Enter: <tt>condump unwrap my_nasty_issue</tt>
:Then find file named <tt>my_nasty_issue.txt</tt> in <tt>C:\games\thedarkmod</tt> (root TDM directory).
:Note: execute the command soon after the issue manifests itself.

:'''2) logfile.''' Open file <tt>darkmod.cfg</tt> in text editor.
:Find or create new line containing: <tt>seta logFile "?"</tt>
:Instead of the question mark, set digit 2 if you experience a crash. Otherwise digit 1 is also OK.
:Save the file, start TDM and reproduce the issue.
:Now find the file named <tt>qconsole.log</tt> in the directory of the currently installed FM, for instance in <tt>C:\games\thedarkmod\fms\newjob</tt>.

The first approach is better, but it is useless if TDM crashes or you cannot even get into game console.
In any of these cases, use the second approach.

When you have got the file, add it to your report just as you did with <tt>darkmod.cfg</tt>.

=== Screenshot ===

If something looks wrong for you, posting screenshot is a good thing to do.
Otherwise, the guy who tries to reproduce your issue and fails will have hard time guessing if he sees the same picture as you.
You can of course try to explain what you see with words, but it is vague and subjective.

There are two ways to get a screenshot:
# Press a key in-game (F12 by default). Then find the screenshot in <tt>C:\games\thedarkmod\screenshots</tt>
# Ensure that you run game in Windowed mode. Press Print-Screen key to copy screen to clipboard. Start Paint and paste (Ctrl+V) it there. Trim the TDM window in it and save.
The first approach is preferred, but sometimes it fails to capture the glitch.

When you want to share a picture on the forums, you can do one of:
* Add it as attachment to your forum post.
* Upload it to some free image hosting, and insert a link to it (click on Image icon) into the post. Surround the link/picture in spoiler tag (unless it is low-resolution) !

When reporting on bugtracker, simply attach the file to the issue and mention it somewhere in the text.

=== Coordinates ===

Typically, a problem happens in-game on at least one of the released fan missions. In such case, please write the name of the FM and the world coordinates where the problem happens.

In order to find world coordinates, execute <tt>getviewpos</tt> in the game console.
The coordinates will be printed in response: the first three are the coordinates, and the last three are the viewing angles. Copy them all to your report.
Since you cannot copy text directly from the game console, use [[Reporting Problem#condump|one of the methods described above to get a condump]].
In fact, it is a good idea to run <tt>getviewpos</tt> just before creating a condump.
By the way, you can execute <tt>setviewpos</tt> with these six arguments to teleport yourself to this specific location, e.g. to ensure that you have copied coords correctly.

Alternatively, you can set <tt>tdm_show_viewpos 1</tt> to display current coordinates on screen, so that they can be captured in screenshot.
Or you can call command <tt>screenshot_viewpos</tt> to make a special screenshot with coordinates visible on it.

See also: https://forums.thedarkmod.com/index.php?/topic/22361-screenshots-with-coordinates/

== Advanced ==

Here are few more advanced tricks which may help debugging issues.

=== Crashdump ===

When TDM crashes, you can record a "memory dump" or "crash dump" of it.
It often contains information invaluable for coders, but it is only useful for debugging crashes.

The article [[Save a Memory Dump for debugging Crashes]] explains in detail how to record it.

=== Video ===

Some graphical issues are very obvious in dynamics, but when you take a still screenshot, it does not capture the tragedy well enough.

In such case you can record a video of the problem.
[https://obsproject.com/ Open Broadcast Software] is a free program which can easily record a high-quality and high-FPS game footage.
The program is quite complicated, but the main thing you need is to add a "source": either "Game Capture", or "Window Capture", or "Screen Capture".

When you have a video, you can either upload it to video hosting (like YouTube) and post a link, or upload it to cloud storage (like Google Drive) and post a shared link.
If you copy/paste a link to YouTube video into a forum post, the forum will show embedded player automatically.

=== Installation state ===

Sometimes there is a chance that your TDM installation is corrupt.
In such case it is great to give people a brief overview of it.<br>
Like generating a filelist of the gamefolder.<br>
<br>
To create a filelisting of the TDM gamefolder, in windows 10<br>

# Open file explorer, navigate to the tdm gamefolder.
# click "file" (menu) > "open in powershell" and a blue window will appear.
# Fill in the following command line in that window and hit the enter-key: dir /s > mytmdfolderandfiles.txt<br>This command generate a textfile in your gamefolder.
# the content of this file mytmdfolderandfiles.txt you can give to people for research.
After this, just run the TDM installer to download the original files.

'''TODO''': write some simple way to get good textual representation of TDM installation directory.

DDS creation

2026-04-01T11:42:07Z

Datiswous: /* DDS Creation, In General */ added BC5 and changed link

''This page was entirely rewritten in August 2020 by peter_spy and Geep - A shortened version of the prior content here may be found at new page [[DDS Creation with ATI Compressonator]].

==Introduction to DDS==

DDS (Direct Draw Surface) is an image format often used in games due to its significant advantages over other file types:

'''No need for conversion during load''': This is a target format in which textures are stored in your GPU memory. Other image types, like TGA, have to be converted during loading, and that makes the whole process longer.

'''Better image quality with mipmapping''': Game engines use LOD systems to generate textures further away from the player, but (without mipmaps available) that results in blurred image and moire patterns. Mipmaps are scaled-down versions of your texture, stored within the same file as the full-scale texture. Mipmaps will improve image quality, the transition between LOD stages, and overall performance. More on mipmapping: https://en.wikipedia.org/wiki/Mipmap

'''Very efficient compression''': Depending on the DDS compression format, a typical results is around 25% of the original uncompressed file. For example, a 2048x2048 px RGB texture saved as uncompressed TGA will be around 12 MB. Save it as DDS, and you'll go below 3 MB. Other formats like PNG or Zip compression will give you around 9 MB.

==Textures in TDM==

TDM can handle textures in TGA, DDS, jpg and png formats. TGA and DDS are generally recomended for textures. For guidance in preparing compliant texture files, applicable to both formats, see:
* [[How_to_add_Textures_to_The_Dark_Mod]]
* [[Texture_Guidelines]]

'''Folder structure in your FM'''

While all TGA, png, jpg files go to:

yourFmRootFolder/textures/''[optional subfolder(s)]''

DDS files should go to:

yourFmRootFolder/'''dds'''/textures/''[optional subfolder(s)]''

In other words, you need to copy-paste your folder structure into the dds directory. (At one time, the DDS hierarchy could be no more than 5 deep; this is no longer an issue.)

'''Priority''': TDM gives DDS files higher priority than TGAs. If you have both for a given material, the engine will only load the DDS.

'''Normal Maps''': You can safely convert diffuse and specular textures to DDS. But normal (bump) maps are not images in the traditional sense; they're more like vector maps. lossy compression will usually introduce some artifacts and otherwise damage that data. You can either use BC5 DDS compression (as of TDM 2.10) for normal maps (this is a special DDS compression for normalmaps alone that doesn't damage the file) or use TGA format instead.

==DDS Creation, In General ==

'''Compression Formats''': DDS files can be compressed in different ways, depending on source image requirements. As a general rule, use -
* DXT1 compression with RGB images
* DXT5 for textures with alpha channel transparency
* BC5 (only) for normalmaps
More info on compression formats: https://en.wikipedia.org/wiki/S3_Texture_Compression

'''Mipmaping''': '''Mipmap generation is mandatory in TDM.''' Otherwise DDS textures won't show in game and you'll get console errors.

TIP: You can improve texture quality - at no additional performance cost - by using the best mipmaps scaling filter available in the DDS file export settings. Usually they're ordered from faster/low-quality to slower/high-quality.

==DDS Creation with Specific Tools==
* [[DDS Creation with GIMP]]
* [[DDS Creation with ATI Compressonator]]

==General Workflow Tips==

* Convert to DDS only after you have finalized textures that make up your material. There are at least two reasons for that:

: '''DDS format isn't suited for fast iteration''': You have to restart the game and reload the map to see the any changes. With TGA files, you just need to use a refresh command to see your changes in an instant.

: '''DDS compression is lossy''': While the compression ratio is pretty great, it slightly reduces image quality. You shouldn't work on DDS textures directly, as you'll decrease image quality with each save. Keep your source files and work on them instead, then export TGAs to DDS when you're happy with the final result.

* Planning to revise and test your material's textures? Besides re-exporting the updated textures as TGA, be sure to delete its old DDS textures, that would have priority.

==Testing Your DDS Texture==
Mipmapping is affected by in-game Anisotropic Filtering. Set it to x16 to ensure maximum image quality while testing your materials.

== See Also ==
* [https://www.reedbeta.com/blog/understanding-bcn-texture-compression-formats/ Understanding bcn texture compression formats]
* [http://wiki.polycount.com/wiki/DXT DDS compression formats]
* [https://en.wikipedia.org/wiki/Mipmap Mipmaps]

[[Category:Tutorial]]
[[Category:Textures]]

DDS creation

2026-04-01T11:35:07Z

Datiswous: /* Textures in TDM */ changed info about BC5 DDS

''This page was entirely rewritten in August 2020 by peter_spy and Geep - A shortened version of the prior content here may be found at new page [[DDS Creation with ATI Compressonator]].

==Introduction to DDS==

DDS (Direct Draw Surface) is an image format often used in games due to its significant advantages over other file types:

'''No need for conversion during load''': This is a target format in which textures are stored in your GPU memory. Other image types, like TGA, have to be converted during loading, and that makes the whole process longer.

'''Better image quality with mipmapping''': Game engines use LOD systems to generate textures further away from the player, but (without mipmaps available) that results in blurred image and moire patterns. Mipmaps are scaled-down versions of your texture, stored within the same file as the full-scale texture. Mipmaps will improve image quality, the transition between LOD stages, and overall performance. More on mipmapping: https://en.wikipedia.org/wiki/Mipmap

'''Very efficient compression''': Depending on the DDS compression format, a typical results is around 25% of the original uncompressed file. For example, a 2048x2048 px RGB texture saved as uncompressed TGA will be around 12 MB. Save it as DDS, and you'll go below 3 MB. Other formats like PNG or Zip compression will give you around 9 MB.

==Textures in TDM==

TDM can handle textures in TGA, DDS, jpg and png formats. TGA and DDS are generally recomended for textures. For guidance in preparing compliant texture files, applicable to both formats, see:
* [[How_to_add_Textures_to_The_Dark_Mod]]
* [[Texture_Guidelines]]

'''Folder structure in your FM'''

While all TGA, png, jpg files go to:

yourFmRootFolder/textures/''[optional subfolder(s)]''

DDS files should go to:

yourFmRootFolder/'''dds'''/textures/''[optional subfolder(s)]''

In other words, you need to copy-paste your folder structure into the dds directory. (At one time, the DDS hierarchy could be no more than 5 deep; this is no longer an issue.)

'''Priority''': TDM gives DDS files higher priority than TGAs. If you have both for a given material, the engine will only load the DDS.

'''Normal Maps''': You can safely convert diffuse and specular textures to DDS. But normal (bump) maps are not images in the traditional sense; they're more like vector maps. lossy compression will usually introduce some artifacts and otherwise damage that data. You can either use BC5 DDS compression (as of TDM 2.10) for normal maps (this is a special DDS compression for normalmaps alone that doesn't damage the file) or use TGA format instead.

==DDS Creation, In General ==

'''Compression Formats''': DDS files can be compressed in different ways, depending on source image requirements. As a general rule, use -
* DXT1 compression with RGB images
* DXT5 for textures with alpha channel transparency
More info on compression formats: http://wiki.polycount.com/wiki/DXT

'''Mipmaping''': '''Mipmap generation is mandatory in TDM.''' Otherwise DDS textures won't show in game and you'll get console errors.

TIP: You can improve texture quality - at no additional performance cost - by using the best mipmaps scaling filter available in the DDS file export settings. Usually they're ordered from faster/low-quality to slower/high-quality.

==DDS Creation with Specific Tools==
* [[DDS Creation with GIMP]]
* [[DDS Creation with ATI Compressonator]]

==General Workflow Tips==

* Convert to DDS only after you have finalized textures that make up your material. There are at least two reasons for that:

: '''DDS format isn't suited for fast iteration''': You have to restart the game and reload the map to see the any changes. With TGA files, you just need to use a refresh command to see your changes in an instant.

: '''DDS compression is lossy''': While the compression ratio is pretty great, it slightly reduces image quality. You shouldn't work on DDS textures directly, as you'll decrease image quality with each save. Keep your source files and work on them instead, then export TGAs to DDS when you're happy with the final result.

* Planning to revise and test your material's textures? Besides re-exporting the updated textures as TGA, be sure to delete its old DDS textures, that would have priority.

==Testing Your DDS Texture==
Mipmapping is affected by in-game Anisotropic Filtering. Set it to x16 to ensure maximum image quality while testing your materials.

== See Also ==
* [https://www.reedbeta.com/blog/understanding-bcn-texture-compression-formats/ Understanding bcn texture compression formats]
* [http://wiki.polycount.com/wiki/DXT DDS compression formats]
* [https://en.wikipedia.org/wiki/Mipmap Mipmaps]

[[Category:Tutorial]]
[[Category:Textures]]

DDS creation

2026-04-01T11:27:37Z

Datiswous: /* Textures in TDM */

''This page was entirely rewritten in August 2020 by peter_spy and Geep - A shortened version of the prior content here may be found at new page [[DDS Creation with ATI Compressonator]].

==Introduction to DDS==

DDS (Direct Draw Surface) is an image format often used in games due to its significant advantages over other file types:

'''No need for conversion during load''': This is a target format in which textures are stored in your GPU memory. Other image types, like TGA, have to be converted during loading, and that makes the whole process longer.

'''Better image quality with mipmapping''': Game engines use LOD systems to generate textures further away from the player, but (without mipmaps available) that results in blurred image and moire patterns. Mipmaps are scaled-down versions of your texture, stored within the same file as the full-scale texture. Mipmaps will improve image quality, the transition between LOD stages, and overall performance. More on mipmapping: https://en.wikipedia.org/wiki/Mipmap

'''Very efficient compression''': Depending on the DDS compression format, a typical results is around 25% of the original uncompressed file. For example, a 2048x2048 px RGB texture saved as uncompressed TGA will be around 12 MB. Save it as DDS, and you'll go below 3 MB. Other formats like PNG or Zip compression will give you around 9 MB.

==Textures in TDM==

TDM can handle textures in TGA, DDS, jpg and png formats. TGA and DDS are generally recomended for textures. For guidance in preparing compliant texture files, applicable to both formats, see:
* [[How_to_add_Textures_to_The_Dark_Mod]]
* [[Texture_Guidelines]]

'''Folder structure in your FM'''

While all TGA, png, jpg files go to:

yourFmRootFolder/textures/''[optional subfolder(s)]''

DDS files should go to:

yourFmRootFolder/'''dds'''/textures/''[optional subfolder(s)]''

In other words, you need to copy-paste your folder structure into the dds directory. (At one time, the DDS hierarchy could be no more than 5 deep; this is no longer an issue.)

'''Priority''': TDM gives DDS files higher priority than TGAs. If you have both for a given material, the engine will only load the DDS.

'''Leave Normal Maps as TGA''': You can safely convert diffuse and specular textures to DDS. But normal (bump) maps are not images in the traditional sense; they're more like vector maps. Any lossy compression will always introduce some artifacts and otherwise damage that data. To be on the safe side, keep normal maps as TGAs. <br>'''NEW''': As of TDM 2.10 and newer, we now support BC5 DDS ( RGTC ) compression for normal maps which shows no artifacts.

==DDS Creation, In General ==

'''Compression Formats''': DDS files can be compressed in different ways, depending on source image requirements. As a general rule, use -
* DXT1 compression with RGB images
* DXT5 for textures with alpha channel transparency
More info on compression formats: http://wiki.polycount.com/wiki/DXT

'''Mipmaping''': '''Mipmap generation is mandatory in TDM.''' Otherwise DDS textures won't show in game and you'll get console errors.

TIP: You can improve texture quality - at no additional performance cost - by using the best mipmaps scaling filter available in the DDS file export settings. Usually they're ordered from faster/low-quality to slower/high-quality.

==DDS Creation with Specific Tools==
* [[DDS Creation with GIMP]]
* [[DDS Creation with ATI Compressonator]]

==General Workflow Tips==

* Convert to DDS only after you have finalized textures that make up your material. There are at least two reasons for that:

: '''DDS format isn't suited for fast iteration''': You have to restart the game and reload the map to see the any changes. With TGA files, you just need to use a refresh command to see your changes in an instant.

: '''DDS compression is lossy''': While the compression ratio is pretty great, it slightly reduces image quality. You shouldn't work on DDS textures directly, as you'll decrease image quality with each save. Keep your source files and work on them instead, then export TGAs to DDS when you're happy with the final result.

* Planning to revise and test your material's textures? Besides re-exporting the updated textures as TGA, be sure to delete its old DDS textures, that would have priority.

==Testing Your DDS Texture==
Mipmapping is affected by in-game Anisotropic Filtering. Set it to x16 to ensure maximum image quality while testing your materials.

== See Also ==
* [https://www.reedbeta.com/blog/understanding-bcn-texture-compression-formats/ Understanding bcn texture compression formats]
* [http://wiki.polycount.com/wiki/DXT DDS compression formats]
* [https://en.wikipedia.org/wiki/Mipmap Mipmaps]

[[Category:Tutorial]]
[[Category:Textures]]

DDS creation

2026-04-01T11:25:55Z

Datiswous: /* Textures in TDM */

''This page was entirely rewritten in August 2020 by peter_spy and Geep - A shortened version of the prior content here may be found at new page [[DDS Creation with ATI Compressonator]].

==Introduction to DDS==

DDS (Direct Draw Surface) is an image format often used in games due to its significant advantages over other file types:

'''No need for conversion during load''': This is a target format in which textures are stored in your GPU memory. Other image types, like TGA, have to be converted during loading, and that makes the whole process longer.

'''Better image quality with mipmapping''': Game engines use LOD systems to generate textures further away from the player, but (without mipmaps available) that results in blurred image and moire patterns. Mipmaps are scaled-down versions of your texture, stored within the same file as the full-scale texture. Mipmaps will improve image quality, the transition between LOD stages, and overall performance. More on mipmapping: https://en.wikipedia.org/wiki/Mipmap

'''Very efficient compression''': Depending on the DDS compression format, a typical results is around 25% of the original uncompressed file. For example, a 2048x2048 px RGB texture saved as uncompressed TGA will be around 12 MB. Save it as DDS, and you'll go below 3 MB. Other formats like PNG or Zip compression will give you around 9 MB.

==Textures in TDM==

TDM can handle textures in TGA, DDS, jpg and png formats. TGA and DDS are generally recomended for textures. For guidance in preparing compliant texture files, applicable to both formats, see:
* [[How_to_add_Textures_to_The_Dark_Mod]]
* [[Texture_Guidelines]]

'''Folder structure in your FM'''

While all TGA, png, jpg files go to:

yourFmRootFolder/textures/''[optional subfolder(s)]''

DDS files should go to:

yourFmRootFolder/'''dds'''/textures/''[optional subfolder(s)]''

In other words, you need to copy-paste your folder structure into the dds directory. (At one time, the DDS hierarchy could be no more than 5 deep; this is no longer an issue.)

'''Priority''': TDM gives DDS files higher priority than TGAs. If you have both for a given material, the engine will only load the DDS.

'''Leave Normal Maps as TGA''': You can safely convert diffuse and specular textures to DDS. But normal (bump) maps are not images in the traditional sense; they're more like vector maps. Any lossy compression will always introduce some artifacts and otherwise damage that data. To be on the safe side, keep normal maps as TGAs. <br>'''NEW''': As of TDM 2.10 and newer, we now support BC5 DDS ( RGTC ) compression for normal maps.

==DDS Creation, In General ==

'''Compression Formats''': DDS files can be compressed in different ways, depending on source image requirements. As a general rule, use -
* DXT1 compression with RGB images
* DXT5 for textures with alpha channel transparency
More info on compression formats: http://wiki.polycount.com/wiki/DXT

'''Mipmaping''': '''Mipmap generation is mandatory in TDM.''' Otherwise DDS textures won't show in game and you'll get console errors.

TIP: You can improve texture quality - at no additional performance cost - by using the best mipmaps scaling filter available in the DDS file export settings. Usually they're ordered from faster/low-quality to slower/high-quality.

==DDS Creation with Specific Tools==
* [[DDS Creation with GIMP]]
* [[DDS Creation with ATI Compressonator]]

==General Workflow Tips==

* Convert to DDS only after you have finalized textures that make up your material. There are at least two reasons for that:

: '''DDS format isn't suited for fast iteration''': You have to restart the game and reload the map to see the any changes. With TGA files, you just need to use a refresh command to see your changes in an instant.

: '''DDS compression is lossy''': While the compression ratio is pretty great, it slightly reduces image quality. You shouldn't work on DDS textures directly, as you'll decrease image quality with each save. Keep your source files and work on them instead, then export TGAs to DDS when you're happy with the final result.

* Planning to revise and test your material's textures? Besides re-exporting the updated textures as TGA, be sure to delete its old DDS textures, that would have priority.

==Testing Your DDS Texture==
Mipmapping is affected by in-game Anisotropic Filtering. Set it to x16 to ensure maximum image quality while testing your materials.

== See Also ==
* [https://www.reedbeta.com/blog/understanding-bcn-texture-compression-formats/ Understanding bcn texture compression formats]
* [http://wiki.polycount.com/wiki/DXT DDS compression formats]
* [https://en.wikipedia.org/wiki/Mipmap Mipmaps]

[[Category:Tutorial]]
[[Category:Textures]]

DDS creation

2026-04-01T11:24:31Z

Datiswous: /* Textures in TDM */

''This page was entirely rewritten in August 2020 by peter_spy and Geep - A shortened version of the prior content here may be found at new page [[DDS Creation with ATI Compressonator]].

==Introduction to DDS==

DDS (Direct Draw Surface) is an image format often used in games due to its significant advantages over other file types:

'''No need for conversion during load''': This is a target format in which textures are stored in your GPU memory. Other image types, like TGA, have to be converted during loading, and that makes the whole process longer.

'''Better image quality with mipmapping''': Game engines use LOD systems to generate textures further away from the player, but (without mipmaps available) that results in blurred image and moire patterns. Mipmaps are scaled-down versions of your texture, stored within the same file as the full-scale texture. Mipmaps will improve image quality, the transition between LOD stages, and overall performance. More on mipmapping: https://en.wikipedia.org/wiki/Mipmap

'''Very efficient compression''': Depending on the DDS compression format, a typical results is around 25% of the original uncompressed file. For example, a 2048x2048 px RGB texture saved as uncompressed TGA will be around 12 MB. Save it as DDS, and you'll go below 3 MB. Other formats like PNG or Zip compression will give you around 9 MB.

==Textures in TDM==

TDM can handle textures in TGA, DDS, jpg and png formats. TGA and DDS are generally recomended for textures. For guidance in preparing compliant texture files, applicable to both formats, see:
* [[How_to_add_Textures_to_The_Dark_Mod]]
* [[Texture_Guidelines]]

'''Folder structure in your FM'''

While all TGA files go to:

yourFmRootFolder/textures/''[optional subfolder(s)]''

DDS files should go to:

yourFmRootFolder/'''dds'''/textures/''[optional subfolder(s)]''

In other words, you need to copy-paste your folder structure into the dds directory. (At one time, the DDS hierarchy could be no more than 5 deep; this is no longer an issue.)

'''Priority''': TDM gives DDS files higher priority than TGAs. If you have both for a given material, the engine will only load the DDS.

'''Leave Normal Maps as TGA''': You can safely convert diffuse and specular textures to DDS. But normal (bump) maps are not images in the traditional sense; they're more like vector maps. Any lossy compression will always introduce some artifacts and otherwise damage that data. To be on the safe side, keep normal maps as TGAs. <br>'''NEW''': As of TDM 2.10 and newer, we now support BC5 DDS ( RGTC ) compression for normal maps.

==DDS Creation, In General ==

'''Compression Formats''': DDS files can be compressed in different ways, depending on source image requirements. As a general rule, use -
* DXT1 compression with RGB images
* DXT5 for textures with alpha channel transparency
More info on compression formats: http://wiki.polycount.com/wiki/DXT

'''Mipmaping''': '''Mipmap generation is mandatory in TDM.''' Otherwise DDS textures won't show in game and you'll get console errors.

TIP: You can improve texture quality - at no additional performance cost - by using the best mipmaps scaling filter available in the DDS file export settings. Usually they're ordered from faster/low-quality to slower/high-quality.

==DDS Creation with Specific Tools==
* [[DDS Creation with GIMP]]
* [[DDS Creation with ATI Compressonator]]

==General Workflow Tips==

* Convert to DDS only after you have finalized textures that make up your material. There are at least two reasons for that:

: '''DDS format isn't suited for fast iteration''': You have to restart the game and reload the map to see the any changes. With TGA files, you just need to use a refresh command to see your changes in an instant.

: '''DDS compression is lossy''': While the compression ratio is pretty great, it slightly reduces image quality. You shouldn't work on DDS textures directly, as you'll decrease image quality with each save. Keep your source files and work on them instead, then export TGAs to DDS when you're happy with the final result.

* Planning to revise and test your material's textures? Besides re-exporting the updated textures as TGA, be sure to delete its old DDS textures, that would have priority.

==Testing Your DDS Texture==
Mipmapping is affected by in-game Anisotropic Filtering. Set it to x16 to ensure maximum image quality while testing your materials.

== See Also ==
* [https://www.reedbeta.com/blog/understanding-bcn-texture-compression-formats/ Understanding bcn texture compression formats]
* [http://wiki.polycount.com/wiki/DXT DDS compression formats]
* [https://en.wikipedia.org/wiki/Mipmap Mipmaps]

[[Category:Tutorial]]
[[Category:Textures]]

Secrets

2026-03-27T13:14:09Z

Datiswous: /* Secrets */ removed irrelevant double info about version

==Secrets==

Secrets are typically well-hidden or hard to reach items or locations. You might like to recognise the player's achievement in finding a secret by showing a message with a sound, and show how many secrets the player has found at the end of the mission.

As of 2.10, this can be done easily with spawnargs or secret-related entities and no longer requires scripts or tweaking GUI files.

== Setting up a secret ==
=== Frob-based secret ===
Often a secret is just a piece of loot or gear that the player can frob. Setting the spawnarg
"secret" "1"
will mark it as a secret, and it will be considered found when the player frobs it. Each entity with this spawnarg will increase the total number of secrets in the map by 1, regardless of whether the player can frob the entity.

=== Trigger-based secret ===
An alternative way to setup a secret is by creating an
atdm:secret
entity, found in the Info/ folder. When this entity is triggered by something, for example a lever, a trigger_once brush or as the "completion target" of an objective, the player is considered to have found a secret.

By default, each of these atdm:secret entities can only be triggered once and will add 1 to the total number of secrets in the map.

You can reuse an atdm:secret entity for multiple secrets by increasing the "count" spawnarg, but you should make sure that each secret can only send one trigger. A trigger_once brush would be suitable, but not a button or reversible objective.

== The message ==
Whenever the player finds a secret a message will be shown and a sound will play. The message & sound change when the player has found all secrets.

You can customise or disable this by placing an entity of the following type in your map (found in the Info folder) and changing its spawnargs:
atdm:secret_messages

=== Spawnargs of the message entity ===
It offers the following spawnargs:
* ''message'' and ''sound'' - These spawnargs determine whether and when a message or sound will appear.
** 0 = never
** 1 = whenever the player finds a secret (default)
** 2 = only when the player has found all secrets
* ''delay'' - Wait this amount of time in seconds after finding a secret before showing the message and starting the sound.
* ''s_volume'' - This allows to increase or decrease the volume of the sound in dB.

The following spawnargs have either "found" or "found_all" in their names. This allows you to configure 2 different messages, depending on whether the player has found some or all secrets.
** ''gui'' - which GUI to use for the message, i.e. a scroll or only white text. This also determines the position of the message.
** ''show'' - how long to show the message.
** ''lines'' - how many lines the message is long (affects positioning of the lines).
** ''text'' - the text shown by the message.
** ''snd'' - the sound to play. It should not loop

The ''text'' spawnargs deserve special mention since they support keywords that are automatically converted by the script:
* ${numFound} - how many secrets the player has found so far.
* ${numTotal} - how many secrets there are in total.
* ${numRemaining} - how many secrets the player hasn't found yet.
* ${s} - this letter only appears if the player has found 2 or more secrets.

As an example, these are the default ''text'' spawnarg values:
* "text_found" "You found ${numFound} secret${s}, ${numRemaining} to go!"
* "text_found_all" "Congratulations! You have found all ${numTotal} secrets!"

== Listing all secrets ==
You can find out which entities are considered as secrets by the game at any time by placing this entity from the Info folder in your map:
atdm:secrets_list

At map start, it will post the names of all "secret" entities near the bottom of the console log and by how much each one increases the total number of secrets, i.e.
Secret, counts as 1: golden_chalice_1
Secret, counts as 1: atdm_secret_1
Secret, counts as 2: atdm_secret_4

== Scripting ==
The secrets system supports the following script events, allowing you to check the current status or even make your own system without using anything else mentioned in this article:
getMissionStatistic( "secretsFound" )
getMissionStatistic( "secretsTotal" )
setSecretsFound( float secrets )
setSecretsTotal( float secrets )

=== Updating your mission to use the secrets system ===
If you already have your own system for tracking secrets, you may want to update your FM so that secrets are shown on the statistics screen. This can be done ad hoc with little effort by adding the following to your script:
* setSecretsTotal() at map start (i.e. in void main()), passing the total number of secrets.
* setSecretsFound() when your script detects that a secret has been found, passing the variable for the number of secrets found so far.

{{editing}}
[[Category:Editing]]

Skybox Basic Details

2026-03-13T13:13:17Z

Datiswous:

'''How to create sky:'''

# Go to {{menu|l1=File|l2=Import Prefab}} and select '''skybox > tdm_starry.pfb'''.
# Check the '''Texture Lock''' [[Image:DRtexLock.jpg]] status, it must be enabled. Lock textures on the [[prefab]] by pressing {{key|name=S}}, or the moon texture may get out of alignment.
# The loaded prefab is already selected, so move it out of the way of your normal map geometry. The exact place doesn't really matter, just move it where it doesn't get in the way later.
# In your map, texture the '''inside facing sides''' of your sky brushes with '''<code>textures/smf/portal_sky</code>''', by selecting them with {{key-ctrl}}+{{key-shift}}+{{LMB}}.

Finished. When you load your level, you will see an attractive night sky with clouds, moon and stars.

=== How to change the moon ===

Go to the loaded prefab, and hide everything until you find a very tiny brush. This brush has the moon texture on one side, and the placement of this brush changes the place of the moon on the sky.

=== How to change sky background color ===

If you use the tdm_sky_starry1.pfb in the directions above, notice that there's a patch mesh in the skybox room covered with a blank white texture <code>(textures/darkmod/nature/skybox/starry1/skyfade)</code>; in many maps it shows up as black, however -- that's because in the shader definition it has <code>"spectrum 2"</code>, meaning that it is only lit by light textures in that spectrum. Most lights you place are usually in spectrum 1, so nothing is lighting that white texture, and so it ends up black!

So, place a light in the middle of the skybox room. Choose a light texture with "spectrum2" in it <code>(lights/spectrum2Light_round)</code> and choose a dark color for the light (maybe #0A192B?). Keep in mind that [http://media.photobucket.com/image/night%20sky%20trees/calendermod/NightSkyTrees1.jpg the sky is usually brighter than the Earth's surface in real-life, especially at night] -- and for ease of level readability and cool silhouettes, it's probably better for you to follow that. (e.g. my level's outdoor ambient light "value" is 5, but my level's skybox background light "value" is "16") However, you should definitely test often and see what settings you like.

== Background information ==

To get good performance, you have to create spaces that are separated by [[Visportals]] from each other.

Therefore the outside area of your building should be a series of corridors around the building with the brushes designated ''skybox'' stretching from the outside wall or buildings forming the border of your level, to the highest point of the building you want to be visible, to the top of the roof. Note, PortalSky used here will show sky in front of whatever is behind, Caulk used here will show sky but also allow func_static (not worldspawn brushes) that have part in the same "leaf" section. This use of Caulk allows sealing, but also permit skyline to appear beyond.

This enables the use of visportals stretching from the skybox to the ground at key corners, so that when you are standing on the north side of the map, you won't also be seeing (and rendering) the south side at the same time.

The sides of the brushes which face outside the level have to textured with anything that is solid and a valid texture, people often use caulk, but as long as it's not <code>no_draw</code>, you're fine.

{{tutorial-editing}}
[[Category:Skybox]]
[[Category:Mapping Tutorials]]

Security Camera

2026-03-10T16:57:31Z

Datiswous: /* Examining a Test Map */

==Security Camera==

<span style="color: red">This article documents the security camera after the major overhaul in version 2.10 onwards. See [[Security Camera (legacy)]] if you're working with TDM 2.09 or older.</span>

The security camera provides the following features:

* It can either sweep back and forth between two angles or remain stationary.
* If the camera sees the player, an AI on a hostile team or a body, it plays a short alert sound that is silent to nearby guards. If the enemy or body is still in view several seconds later, an alarm sounds. This alarm will repeat every few seconds for a while, even if the enemy moves out of sight.
* The camera is able to track its enemy, making it much harder to escape its view.
* An optional spotlight that points forward, lighting the area in the direction the camera faces.
* The ability to toggle the camera power on/off by triggering it. Each of the above described subsystems can be toggled individually.
* If the camera has targets, these will be activated when the camera is fully alerted. This gives the map author the ability to play a more powerful alarm than the one given off by the camera (or to do a variety of other things.)
* Sending what it sees to a separate, func_static display screen. Alternatively, it can send what another entity (typically a target_null) sees.

==The Security Camera: Entities and Prefabs==

Security camera entities can be found in ''AI/Machines/Security Camera'' and inherit from ''func_securitycamera''. Prefabs can be found in ''AI/Machines''.

Place the camera entity in your map, and orient it toward its starting direction. A rotating camera will sweep clockwise, halt a moment, then sweep back counter-clockwise.

Some cameras may be designed to use additional parts, i.e. a ceiling pivot entity with scripted gears. See the prefabs or the entity descriptions for more info.

==Spawnargs==

===Movement Spawnargs===

* "rotate" - If "1" (default) the camera will rotate. If "0", the camera is stationary.
* "sweepSpeed" - Horizontal rotation speed in degrees per second.
* "sweepAngle" - The number of degrees the camera covers during its sweep. You can cause a camera to initially sweep in the counter-clockwise direction by setting this to a negative number.
* "sweepWait" - How long the pause is after the end of a sweep. Default is 0.5 seconds.
* "sweepWaitSoundOffset" - Start playing snd_end before the camera reaches the end of its sweep, by this amount of seconds.

===Detection Spawnargs===

These spawnargs govern how the security camera detects and reacts to enemies: max detection distance, at what light intensity, how long the alarm lasts, whether to trigger anything and so on.

* "scanDist" - The distance limit for spotting the enemy.
* "scanFov" - The camera's field of view.
* "seePlayer" - Whether the camera will react to the player.
* "seeAI" - Whether the camera will react to AIs, and what their relationship to the camera's team has to be.
* "seeBodies" - Whether the camera will react to bodies.
* "seeAnimals" - Whether the camera will react to animals.
* "sight_threshold" - From 0.0 to 1.0, how lit up the lightgem has to be for the player to be detected.
* "sightTime" - After seeing the enemy (partial alert), the camera will wait this amount of time. If it still sees the enemy, it will sound the alarm. This gives the enemy some time to hide.
* "sightResume" - If the camera can't see the enemy anymore after a partial alert, pause for this amount of time. When this expires, the camera will resume sweeping.
* "alarm_duration" - Minimum duration of the fully alert state. Will be extended by half if the enemy is still in view at the end or was recently seen.
* "alarm_interval" - Amount of time inbetween each activation of the alarm sound, when fully alerted.
* "trigger_alarm_start" - Trigger targets when an alarm begins.
* "trigger_alarm_end" - Trigger targets when an alarm ends.

===Follow Spawnargs===

The security camera can track the enemy's movements. For as long as the security camera is partially or fully alerted, it will turn to the closest enemy it can see. The models for the camera and mount should be able to support this without clipping into each other. A ceiling-mounted camera will generally have much more freedom to turn than a wall-mounted camera.

* "follow" - Enable to let the camera track the enemy horizontally.
* "follow_tolerance" - How far in degrees the enemy has to move before the camera readjusts its rotation, horizontally.
* "follow_speed_mult" - Speed up horizontal movements by this multiplier when the camera is following the enemy.
* "follow_incline" - The camera will also track the enemy vertically.
* "follow_incline_tolerance" - How far in degrees the enemy has to move before the camera readjusts its rotation, vertically.
* "follow_incline_speed" - Speed of vertical movements to track the enemy. Not affected by 'follow_speed_mult'.
* "follow_constrain_up" - Limit how far the camera can turn upwards from its starting orientation.
* "follow_constrain_down" - Limit how far the camera can turn downwards from its starting orientation.

===Spotlight Spawnargs===

If "spotLight" is set to 1, the security camera's code will spawn a spotlight and align it with its view. This dates back to the Doom 3 days, so it follows different rules from the def_attach systems. If "useColors" is enabled, the spotlight's color will change depending on alert state. Otherwise it will look for a "_color" spawnarg on the camera.

Alternatively you can specify an existing light with the spawnarg "spotlight_custom". Apart from "spotLight" and "useColors", all other spotlight-relevant spawnargs are ignored. If no valid entity of spawnclass idLight is found, it'll spawn a spotlight instead.

* "spotLight" - If "1" the camera will use a spotlight.
* "spotlight_range" - Reach of the spotlight.
* "spotlight_diameter" - Diameter of the spotlight's projection. If 0, will automatically be calculated to match spotlight_range and scanFov, for scanFov up to 90°.
* "spotlight_texture" - Texture used by the spotlight. You should use a texture that's designed for projected lights: one that uses a gradient as its falloff image. This ensures that light intensity gradually fades to black, rather than abruptly cutting to black.
* "spotlight_volumetric" - The spawned spotlight will be volumetric.

===Color Spawnargs===

* "useColors" - If "1" the camera will change the colour of its model and spotlight depending on its alert state.
* "color_sweeping" - Color when the camera is sweeping = unalerted. Default green.
* "color_sighted" - Color when the camera has noticed an enemy = partially alerted. Default yellow.
* "color_alerted" - Color when the camera has sounded the alarm = fully alerted. Default red.
* "_color" - If "useColors" is disabled, the model and spotlight will always have this color.

As an alternative or complement to color spawnargs, you may make use of shaderParm7 in materials used by the security camera. shaderParm7 represents the alert state of the camera:
* 0 = unalerted
* 1 = was partially alerted for "sightTime" seconds but the enemy has disappeared, now waiting "sightResume" seconds before resuming sweeping.
* 2 = partially alerted
* 3 = fully alerted

===Damage Spawnargs===

* "health" - amount of damage the camera can take before being destroyed. Setting to 0 will make the camera invincible. Setting to 0 will make the camera invincible. Default base damage per hit: sword - 42; broadhead - 35; fire arrow direct hit - 400.
* "damage_blackjack" - how much damage the security camera takes from blackjack hits, default: 0.
* "damage_mult_" - a series of spawnargs to multiply how much damage the security camera takes from various damage sources. You can name specific weapon classnames or damageDefs in the spawnarg, i.e. "damage_mult_atdm:weapon_shortsword" "0.5".
* "damage_splash_falloff" - how quickly splash damage from fire arrows exponentially decreases with distance, default: 3.
* "damage_flinderize" - if a security camera is destroyed and the destroying hit (or post-destruction hit) is greater than this value, the security camera explodes into pieces. Default: 90.
* "def_flinder1" - the classname of the flinder pieces generated when a camera is flinderized by a heavy hit. Use "def_flinder2" etc. to generate more flinders.
* "flinder_offset1" - specifies the spawn point of the respective flinder piece relative to the camera's origin. Takes the camera's current rotation into account.
* "broken" - the security camera switches to this model when destroyed
* "broken_flinderized" - Optional. Specify the model of the security camera when destroyed + flinderized.
* "skin_broken" - the security camera switches to this skin when destroyed
* "skin_flinderized" - Optional. Specify the skin of the security camera when destroyed + flinderized.
* "hideModelOnBreak" - the security camera will be hidden when destroyed, default: 0.
* "notice_destroyed" - Whether AIs will become alerted if they find this security camera destroyed.
* "fx_damage" - Fx to play whenever the camera is damaged while power is on.
* "fx_damage_nopower" - Fx to play whenever the camera is damaged while power is off.
* "fx_destroyed" - Fx to play whenever the camera is destroyed while power is on.
* "fx_destroyed_nopower" - Fx to play whenever the camera is destroyed while power is off.
* "break_up_script" - This script is called when the camera is destroyed.
* "break_up_target" - This entity is triggered if the camera is destroyed.

===Sound Spawnargs===

* "snd_sight" - Sound emitted when the camera notices an enemy.
* "snd_moving" - Sound emitted when the camera is rotating.
* "snd_stationary" - Sound emitted by a stationary type of camera.
* "snd_alert" - Alarm sound emitted when fully alerted.
* "snd_end" - Sound emitted when the camera is about to reach the end point of a sweep.
* "snd_death" - Sound emitted when the camera is destroyed.
* "snd_death_nopower" - Sound emitted when the camera is destroyed while power is off.
* "snd_sparks" - Sound emitted when the camera emits sparks after it was destroyed.
* "sprS_alert" - How far snd_alert propagates to AIs, at default this is a few rooms. Higher settings than mild can cause large framedrops due to mass AI alerts.

===Sparks Spawnargs===

The security camera spawns a particle emitter when it's destroyed. By default it uses a single-cycle spark particle which is periodically triggered at random intervals. When power to the camera is switched off, the sparks stop appearing.

* "sparks" - Whether to spawn a particle emitter at all.
* "sparks_particle" - Particle that is spawned.
* "sparks_delay" - Time taken for the particle emitter to spawn initially.
* "sparks_power_dependent" - Only show the particle if power to the destroyed camera is on.
* "sparks_interval" - For non-looping particles, minimum time between triggers.
* "sparks_interval_rand" - For non-looping particles, additional random factor added to the time between triggers.

===Model Spawnargs===

These spawnargs are important if you change the camera model:

* "broken" - Use this model when the camera is destroyed.
* "viewOffset" - A vector that defines the offset of the camera's 'eye' from the camera's origin.
* "lightOffset" - A vector that defines the spotlight offset from the camera's origin.
* "flipAxis" - This and the next spawnarg can be used to turn a model such that it faces forwards. Not needed if the model was created forward-facing.
* "modelAxis"
* "skin" - This is the "on" skin. It may contain materials that make use of the colored keyword or shaderParm7, to change depending on alert state.
* "skin_on_spotlight_off" - This is the "on" skin, but with the spotlight toggled off. This is useful if your model contains inbuilt lightrays that should represent the spotlight.
* "skin_off" - This is the "off" skin. It should not contain materials with the colored keyword or shaderParm7.
* "skin_broken" - When the camera is destroyed it will switch to this skin.

===Misc Spawnargs===

* "start_off" - Whether the camera starts powered on or off.
* "cameraTarget" - Use the view from this entity instead of from self if sending a view to the display screen. See section ''The Display Screen'' for more.
* "gearSpeed" - This spawnarg is set on the ceiling pivot of the 2nd type of security camera. It controls how fast the gears turn when the security camera turns.
* "legacy" - This marks an old version of the security camera, for backwards compatibility with older missions.

The security camera uses spawnargs to place its 'eye' and spotlight in front of the model to ensure the view and spotlight aren't blocked by the model. If you use a different model, you might need to change these.
* "lightOffset"
* "viewOffset"

==Damaging the Camera==

===Damage sources===

By default the security camera is vulnerable only to fire arrows (direct & splash damage). The "damage_" and "damage_mult_" spawnargs allow you to to specify how much damage security cameras take from each weapon, but be sure to communicate the camera's vulnerabilities to the player. You can create your own "damage_mult_" spawnargs by adding the name of a specific weapon classname or damageDef, i.e. "damage_mult_atdm:weapon_shortsword" "0.5". Unfortunately it does not appear to be possible to make water damage the camera, since TDM will crash upon load when a water response is applied to the camera.

Setting "health" to 0 will make the camera totally invicible. Alternatively, you can make the camera immune to everything but fire arrow splash damage by binding a tight-fitting nodrawsolid_metal brush. A similar approach is to bind a brush that leaves parts of the camera exposed, i.e. the lens or face. Note that it will weaken fire arrows considerably if they hit from the wrong angle. A direct hit does up to 400 damage, while the splash does a distance-dependent amount of damage below 100. Note that collision detection is done using the camera's clipmodel, which has a different shape than the visual model.

The player will receive feedback that the camera took damage in the form of spark effects, specified in spawnargs beginning with fx_. An .fx definiton is basically an instruction to emit a sequence of particles and sounds.

===Destroying the Camera===

Security cameras can not only be destroyed, but also be flinderized (burst apart into pieces) which occurs when the security camera takes a hit whose damage is higher than the value of the "damage_flinderize" spawnarg. The "broken" and "skin_broken" spawnargs let you set the model and skin when the camera is destroyed, while the optional "broken_flinderized" and "skin_flinderized" let you set the model and skin when the camera has been flinderized. The "def_flinder" and "flinder_offset" spawnargs allow you to specify the flinder pieces and their spawn point relative to the camera's origin.

==Scripting==

===Script Events===

The security camera supports the following script events:
* getSecurityCameraState() - Returns the security camera's state. 1 = unalerted, 2 = partially alerted, 3 = fully alerted, 4 = inactive (power off), 5 = destroyed, 0 = not a security camera.
* getShaderParm(7) - Returns the current value of shaderParm7 on the camera model. 0 = unalerted, 1 = about to resume sweep after a partial alert, 2 = partially alerted, 3 = fully alerted.
* On() and Off() - Switch the camera's power on or off (note the capitalisation).
* activate() and trigger() - Toggle the camera's power.
* getHealth() and setHealth(float newHealth) - As per the name. Setting health to 0 or lower will destroy the security camera, which is irreversible. setHealth() will make an invincible camera vulnerable.
* getEnemy() - Returns the entity that most recently caused or refreshed the security camera's suspicious or alert state.
* canSee() - Tests whether the security camera is able to see a specific entity. Currently only player1 is supported.
* setSightThreshold() - This changes how lit up the player's lightgem has to be for the security camera to see him, from 0.0 to 1.0.
* state_light(boolean set) - Switch the camera's spotlight on/off, if the camera has one.
* state_sweep(boolean set) - Switch the camera's sweep on/off. This will also affect enemy tracking.
* state_see_player(boolean set) - Toggle whether the camera is able to detect the player. An alternative is just to set "seePlayer" to "1" or "0", since the code monitors this spawnarg.
* toggle_light() - Toggle the spotlight on/off, if the camera has one.
* toggle_sweep() - Toggle the camera's sweep on/off. This will also affect enemy tracking.
* toggle_see_player() - Toggle whether the camera is able to detect the player. An alternative is just to set "seePlayer" to "1" or "0", since the code monitors this spawnarg.

===Object Functions===

The security camera's scriptobject contains the following object functions:
* toggleSCSpotlight() - calls toggle_light() on the camera if it has a spotlight (spawnarg "spotLight" = "1")
* toggleSCSweep() - calls toggle_sweep() on the camera
* toggleSCPlayer() - calls toggle_see_player() on the camera

As you can see, these object functions simply call the toggle script events on the camera they belong to. This allows you to call the script events from i.e. buttons without scripting. To set this up:
# create an atdm:target_callobjectfunction entity
# give it the spawnarg "call" with the name of the desired object function, i.e. "toggleSCSpotlight"
# let it target the security camera
# when desired, trigger this entity (from a script, from a button etc.).

===Scriptobjects===

The security camera's scriptobject only consists of the 3 object functions mentioned above. Beyond some added utility, this scriptobject has no importance for the security camera and you can easily give it your own scriptobject instead.

===Upon Destruction===

You may call a script when the camera is destroyed, as per the spawnarg "break_up_script". This script should be able to receive the name of the destroyed security camera as input, i.e.:
void camera_destroyed ( entity camera )

An alternative is to use the spawnarg "break_up_target" to name an entity that calls the script when triggered, but this will not pass the name of the destroyed security camera unless you use an atdm:target_callscriptfunction entity with the spawnarg "forEach" "1".

==Sending the camera's view to a Display Screen==

You can create a display screen that shows that the camera sees: all that's needed is a func_static patch that uses a texture like ''textures/common/camera/camera1''. It's recommended to put another patch behind it, since this func_static will get hidden if it's switched off. The screen then needs to be given a spawnarg "cameraTarget" that names either a security camera or a different entity, typically a target_null. The screen will display what that entity sees.

To change the screen's field of view, apply the spawnargs "cameraFovX" and "cameraFovY" to the entity sending the view. Otherwise it will default to "scanFov" for security cameras or 120 for other entities.

The screen is hidden or shown automatically if the screen is displaying a security camera's view. The screen can also be switched on/off manually by triggering it, but this requires the screen to start with the spawnarg "hide" "0" or "hide" "1".

===Multiple Display Screens / Reflective Water / Skybox===

If you plan to have multiple security cameras sending to multiple display screens in your mission, or if the camera display will appear in the same player POV as the sky or reflective water surfaces, you'll need to use unique camera materials for each screen. You can find 9 additional camera materials in the textures/common/camera/ folder. If you should need even more, you can simply clone one of the materials and change the name after the ''map'' keyword.

== Examining a Test Map ==

You can obtain a test map with sample cameras in it here: [https://ftp.thedarkmod.com/tutorials/RemoteCamera/camerawiki2.pk4 camerawiki2.pk4]. Similar setups can be found as prefabs in AI/Machines.

Open the map ''camerawiki.map'' in Dark Radiant. In this map, we have examples of the different cameras.

[[Image:Cw1.jpg|256px|thumb|right|cam1]]

=== A rotating camera that sweeps back and forth ===

This camera (''cam1'') starts its rotation at 135 degrees (assuming +X is 0 degrees), and sweeps clockwise until it reaches 45 degrees. It pauses for a moment, then return-sweeps back to 135 degrees. It has a spotlight.

The display for ''cam1'' is on the wall behind it. (Don't worry about the material being displayed backward in the screenshot.)

The display patch uses the material ''camera1'' (provided in the camerawiki/materials/tdm_camera.mtr file).

The four buttons below the display do the following (from left to right):

* Toggle Power - targets ''cam1'' directly. When power is off, the display screen is hidden. You can simulate an "off" screen by making sure there's a black material behind the display. You could also place a glass material behind the display.
* Toggle Spotlight - calls the ''toggleSCSpotlight()'' object function in the camera's scriptobject, turning the spotlight on/off
* Toggle Player Sighting - calls the ''toggleSCPlayer()'' object function in the camera's scriptobject, turning Player detection on/off
* Toggle Sweep - calls the ''toggleSCSweep()'' object function in the camera's scriptobject, turning camera sweep on/off

[[Image:Cw2.jpg|256px|thumb|right|cam1's display]]
{{clear}}
=== A stationary camera that doesn't move ===

[[Image:Cw3.jpg|320px|thumb|right|cam2 and its display]]
This camera (''cam2'') is stationary, w/o a spotlight.

Its display, to its left, uses the material ''camera2''.

The two buttons below the display do the following (from left to right):

* Toggle Power - targets ''cam2'' directly. When power is off, the display screen is hidden.
* Toggle Player Sighting - calls the ''toggleSCPlayer()'' object function in the camera's scriptobject, turning player detection on/off
{{clear}}

=== A screen showing the view from another entity (a target_null) ===

[[Image:Cw6.jpg|320px|thumb|right|a small screen showing what a target_null is seeing]]

This is simply a screen referencing a ''target_null'' as its ''cameraTarget''. The ''target_null'' is in a separate room pointed at a guard.

If you look in the room where the guard is standing, you'll see that the ''target_null'' has the spawnargs ''cameraFovX'' and ''cameraFovY''. These were set because the default field of view for a view from a non-camera entity is 120 by 120, which looks quite zoomed out. For a small screen like this one, 60 by 60 is much better.

Also notice that the screen itself has the spawnarg ''hide'' ''0''. This makes it respond to triggers by hiding or showing itself, allowing you to switch it on or off at the push of a button (see below).

The button below the display does the following:

* Toggle Power - targets the screen directly to show or hide it. This only works because the screen has a ''hide'' spawnarg.

{{clear}}
[[Category:Editing]]

Video Briefing

2026-02-28T18:11:12Z

Datiswous: /* More About Formats */

''by Geep, 2020''

This extends the tutorial on [[Briefing|Briefing]] and serves as a useful bridge to the format specifications given in [[Cutscene video with FFmpeg]].

== Introduction ==
=== Style and Content ===

Like other TDM briefing styles, a video conveys important information or teasers at the game start. After first viewing, the player can subsequently skip it.

A typical "historical documentary" approach to producing a video briefing would be to:
* capture screen shots from within the game
* supplement these with other images
* assemble the results into a timeline and add pans, zooms, rotations, transitions, titles, overlays, and special effects
* possibly include video clips, e.g., video capture during game play; animated logos
* separately develop a soundtrack using standard TDM sound clips and other music, sound effects, and custom narration (with possibly multiple voices). The heart of the briefing is conveyed by the narrator.
* be cognizant of copyright and licensing issues

Specific software systems to do all this - video capture & editing, audio recording & editing, animation, and FX - are beyond our scope here. Also touched on elsewhere are other methods that could convey briefing-like information ''during'' the game, not at the beginning:
* [[Playing ROQ Video Files]] demonstrates in-game video on a small screen. The example uses an in-game laptop model, but is applicable to more "lore friendly" surfaces like magic mirrors.
* [[Full-Screen Video Cutscenes]] uses methodology similar to but different in detail from what is described here.

=== Video and Audio Formats ===

Traditionally, games using the id engine have used the RoQ format for video, with separate .OGG audio. RoQ remains supported in TDM for compatibility with existing FMs. But starting in TDM 2.06, a focused set of more popular formats is preferable with new FMs. The new formats allow a higher quality presentation. The audio source may be either a separate file, or from the video itself.

== Quick Start ==

The quickest way to implement this in your FM is to copy a video briefing from an existing recent FM, then replace the AV media files with your own. We will use as our example [https://forums.thedarkmod.com/index.php?/topic/19936-fan-mission-shadows-of-northdale-act-ii-down-the-rabbit-hole-by-goldwell-20190320 Goldwell's "Shadows of Northdale ACT II" from 2019]. This has a single-mission briefing and uses a .MP4 video with a separate .OGG soundtrack. After you have installed it, look within northdale2.pk4 for these files:

* guis/mainmenu_background.gui
* guis/mainmenu_briefing_video.gui
* guis/mainmenu_custom_defs.gui
* materials/briefing.mtr
* video/briefing.mp4
* sound/video/briefing_video.ogg

Copy these to your own FM, creating folders as needed. When you compile and run your FM, you should see and hear the video briefing (with its quite high production values) instead of a text briefing page.

If you want to change media filenames, or make certain other customizations, mainmenu_custom_defs.gui is where to start. It has documentation on additional configurations, like multiple briefings for multi-mission campaigns, or adding mission debriefing videos, that are not covered here. Some of this info is also documented at page [[Setting up Campaigns]].

== Skipping a Video Briefing ==
The video briefing, once started, can be skipped by either:
* Pressing LMB. This is the best way, though the viewer may not always be aware of it.
* Using the ESC key. This aborts to the text Briefing page, from which the viewer may navigate to the Objectives page. It is not possible to resume the video briefing.

Regarding the latter, note that Goldwell's method includes a special treatment so that when a briefing video ends normally (not skipped), the viewer arrives directly at the Objectives page, not the Briefing page. Unfortunately, that is not the case with ESC skipping. You might accommodate this by editing the xdata/briefing.xd to have either:
* No text
* Something like: "Select 'Objectives' to continue..."
* A text summary or transcript of the video briefing.

== More About Formats ==

When getting set to replace the media assets with your own, you may find it informative to inspect the properties of northdale2's briefing.mp4 and briefing_video.ogg files, e.g.:
* Video has 1920 wide x 1080 high frames, at 29.97 frames per second.
* Audio is stereo, 128kps bit rate, 48.000 kHz sampling.
There are other media options, but in any event be sure to be compliant with format restrictions given in [[Cutscene video with FFmpeg]]. There you will also find details of how to use a video's audio instead of a separate audio file. For still more, see [https://forums.thedarkmod.com/index.php?/topic/19447-206-videos-without-roq/ 2.06 - Videos Without RoQ]

If you do need to work with the RoQ format, you can find similar examples among your installed FMs (i.e., by searching for *.roq files). There is a pioneering (circa 2006, but revised in 2020) TDM report on [[Playing ROQ Video Files]]. This covers RoQ creation with 2006-era and 2015-era tools, the latter from the useful information at [https://openarena.fandom.com/wiki/RoQ RoQ - particularly ZaRR's RoQ How-to for OpenArena Mappers]. Note that RoQ file duration is limited to 1 minute. (Possibly the mainmenu_... guis can be used to sequence multiple RoQ files.)

See also: Overview of [[GUI_Scripting_Language]] and [https://iddevnet.dhewm3.org/doom3/guis.html idDevNet GUIs]

== Debugging Playback ==

If your video shows a black screen, you may have a GUI error. In the console, "testgui guis/xxxx.gui" (note the partial path inclusion) may be helpful to locate where.

== See Also ==

For information about mid-game videos, see [[Video Cutscene Creation]].
{{GUI}}
[[Category:Video and cutscenes]]

Video Briefing

2026-02-28T18:05:50Z

Datiswous: /* Quick Start */

''by Geep, 2020''

This extends the tutorial on [[Briefing|Briefing]] and serves as a useful bridge to the format specifications given in [[Cutscene video with FFmpeg]].

== Introduction ==
=== Style and Content ===

Like other TDM briefing styles, a video conveys important information or teasers at the game start. After first viewing, the player can subsequently skip it.

A typical "historical documentary" approach to producing a video briefing would be to:
* capture screen shots from within the game
* supplement these with other images
* assemble the results into a timeline and add pans, zooms, rotations, transitions, titles, overlays, and special effects
* possibly include video clips, e.g., video capture during game play; animated logos
* separately develop a soundtrack using standard TDM sound clips and other music, sound effects, and custom narration (with possibly multiple voices). The heart of the briefing is conveyed by the narrator.
* be cognizant of copyright and licensing issues

Specific software systems to do all this - video capture & editing, audio recording & editing, animation, and FX - are beyond our scope here. Also touched on elsewhere are other methods that could convey briefing-like information ''during'' the game, not at the beginning:
* [[Playing ROQ Video Files]] demonstrates in-game video on a small screen. The example uses an in-game laptop model, but is applicable to more "lore friendly" surfaces like magic mirrors.
* [[Full-Screen Video Cutscenes]] uses methodology similar to but different in detail from what is described here.

=== Video and Audio Formats ===

Traditionally, games using the id engine have used the RoQ format for video, with separate .OGG audio. RoQ remains supported in TDM for compatibility with existing FMs. But starting in TDM 2.06, a focused set of more popular formats is preferable with new FMs. The new formats allow a higher quality presentation. The audio source may be either a separate file, or from the video itself.

== Quick Start ==

The quickest way to implement this in your FM is to copy a video briefing from an existing recent FM, then replace the AV media files with your own. We will use as our example [https://forums.thedarkmod.com/index.php?/topic/19936-fan-mission-shadows-of-northdale-act-ii-down-the-rabbit-hole-by-goldwell-20190320 Goldwell's "Shadows of Northdale ACT II" from 2019]. This has a single-mission briefing and uses a .MP4 video with a separate .OGG soundtrack. After you have installed it, look within northdale2.pk4 for these files:

* guis/mainmenu_background.gui
* guis/mainmenu_briefing_video.gui
* guis/mainmenu_custom_defs.gui
* materials/briefing.mtr
* video/briefing.mp4
* sound/video/briefing_video.ogg

Copy these to your own FM, creating folders as needed. When you compile and run your FM, you should see and hear the video briefing (with its quite high production values) instead of a text briefing page.

If you want to change media filenames, or make certain other customizations, mainmenu_custom_defs.gui is where to start. It has documentation on additional configurations, like multiple briefings for multi-mission campaigns, or adding mission debriefing videos, that are not covered here. Some of this info is also documented at page [[Setting up Campaigns]].

== Skipping a Video Briefing ==
The video briefing, once started, can be skipped by either:
* Pressing LMB. This is the best way, though the viewer may not always be aware of it.
* Using the ESC key. This aborts to the text Briefing page, from which the viewer may navigate to the Objectives page. It is not possible to resume the video briefing.

Regarding the latter, note that Goldwell's method includes a special treatment so that when a briefing video ends normally (not skipped), the viewer arrives directly at the Objectives page, not the Briefing page. Unfortunately, that is not the case with ESC skipping. You might accommodate this by editing the xdata/briefing.xd to have either:
* No text
* Something like: "Select 'Objectives' to continue..."
* A text summary or transcript of the video briefing.

== More About Formats ==

When getting set to replace the media assets with your own, you may find it informative to inspect the properties of northdale2's briefing.mp4 and briefing_video.ogg files, e.g.:
* Video has 1920 wide x 1080 high frames, at 29.97 frames per second.
* Audio is stereo, 128kps bit rate, 48.000 kHz sampling.
There are other media options, but in any event be sure to be compliant with format restrictions given in [[Cutscene video with FFmpeg]]. There you will also find details of how to use a video's audio instead of a separate audio file. For still more, see [https://forums.thedarkmod.com/index.php?/topic/19447-206-videos-without-roq/ 2.06 - Videos Without RoQ]

If you do need to work with the RoQ format, you can find similar examples among your installed FMs (i.e., by searching for *.roq files). There is a pioneering (circa 2006, but revised in 2020) TDM report on [[Playing ROQ Video Files]]. This covers RoQ creation with 2006-era and 2015-era tools, the latter from the useful information at [https://openarena.fandom.com/wiki/RoQ RoQ - particularly ZaRR's RoQ How-to for OpenArena Mappers]. Note that RoQ file duration is limited to 1 minute. (Possibly the mainmenu_... guis can be used to sequence multiple RoQ files.)

See also: Overview of [https://modwiki.dhewm3.org/GUI_scripting GUI scripting] and [https://iddevnet.dhewm3.org/doom3/guis.html idDevNet GUIs]

== Debugging Playback ==

If your video shows a black screen, you may have a GUI error. In the console, "testgui guis/xxxx.gui" (note the partial path inclusion) may be helpful to locate where.

== See Also ==

For information about mid-game videos, see [[Video Cutscene Creation]].
{{GUI}}
[[Category:Video and cutscenes]]

Video Briefing

2026-02-28T17:59:51Z

Datiswous: /* More About Formats */

''by Geep, 2020''

This extends the tutorial on [[Briefing|Briefing]] and serves as a useful bridge to the format specifications given in [[Cutscene video with FFmpeg]].

== Introduction ==
=== Style and Content ===

Like other TDM briefing styles, a video conveys important information or teasers at the game start. After first viewing, the player can subsequently skip it.

A typical "historical documentary" approach to producing a video briefing would be to:
* capture screen shots from within the game
* supplement these with other images
* assemble the results into a timeline and add pans, zooms, rotations, transitions, titles, overlays, and special effects
* possibly include video clips, e.g., video capture during game play; animated logos
* separately develop a soundtrack using standard TDM sound clips and other music, sound effects, and custom narration (with possibly multiple voices). The heart of the briefing is conveyed by the narrator.
* be cognizant of copyright and licensing issues

Specific software systems to do all this - video capture & editing, audio recording & editing, animation, and FX - are beyond our scope here. Also touched on elsewhere are other methods that could convey briefing-like information ''during'' the game, not at the beginning:
* [[Playing ROQ Video Files]] demonstrates in-game video on a small screen. The example uses an in-game laptop model, but is applicable to more "lore friendly" surfaces like magic mirrors.
* [[Full-Screen Video Cutscenes]] uses methodology similar to but different in detail from what is described here.

=== Video and Audio Formats ===

Traditionally, games using the id engine have used the RoQ format for video, with separate .OGG audio. RoQ remains supported in TDM for compatibility with existing FMs. But starting in TDM 2.06, a focused set of more popular formats is preferable with new FMs. The new formats allow a higher quality presentation. The audio source may be either a separate file, or from the video itself.

== Quick Start ==

The quickest way to implement this in your FM is to copy a video briefing from an existing recent FM, then replace the AV media files with your own. We will use as our example [https://forums.thedarkmod.com/index.php?/topic/19936-fan-mission-shadows-of-northdale-act-ii-down-the-rabbit-hole-by-goldwell-20190320 Goldwell's "Shadows of Northdale ACT II" from 2019]. This has a single-mission briefing and uses a .MP4 video with a separate .OGG soundtrack. After you have installed it, look within northdale2.pk4 for these files:

* guis/mainmenu_background.gui
* guis/mainmenu_briefing_video.gui
* guis/mainmenu_custom_defs.gui
* materials/briefing.mtr
* video/briefing.mp4
* sound/video/briefing_video.ogg

Copy these to your own FM, creating folders as needed. When you compile and run your FM, you should see and hear the video briefing (with its quite high production values) instead of a text briefing page.

If you want to change media filenames, or make certain other customizations, mainmenu_custom_defs.gui is where to start. It has documentation on additional configurations, like multiple briefings for multi-mission campaigns, or adding mission debriefing videos, that are not covered here.

== Skipping a Video Briefing ==
The video briefing, once started, can be skipped by either:
* Pressing LMB. This is the best way, though the viewer may not always be aware of it.
* Using the ESC key. This aborts to the text Briefing page, from which the viewer may navigate to the Objectives page. It is not possible to resume the video briefing.

Regarding the latter, note that Goldwell's method includes a special treatment so that when a briefing video ends normally (not skipped), the viewer arrives directly at the Objectives page, not the Briefing page. Unfortunately, that is not the case with ESC skipping. You might accommodate this by editing the xdata/briefing.xd to have either:
* No text
* Something like: "Select 'Objectives' to continue..."
* A text summary or transcript of the video briefing.

== More About Formats ==

When getting set to replace the media assets with your own, you may find it informative to inspect the properties of northdale2's briefing.mp4 and briefing_video.ogg files, e.g.:
* Video has 1920 wide x 1080 high frames, at 29.97 frames per second.
* Audio is stereo, 128kps bit rate, 48.000 kHz sampling.
There are other media options, but in any event be sure to be compliant with format restrictions given in [[Cutscene video with FFmpeg]]. There you will also find details of how to use a video's audio instead of a separate audio file. For still more, see [https://forums.thedarkmod.com/index.php?/topic/19447-206-videos-without-roq/ 2.06 - Videos Without RoQ]

If you do need to work with the RoQ format, you can find similar examples among your installed FMs (i.e., by searching for *.roq files). There is a pioneering (circa 2006, but revised in 2020) TDM report on [[Playing ROQ Video Files]]. This covers RoQ creation with 2006-era and 2015-era tools, the latter from the useful information at [https://openarena.fandom.com/wiki/RoQ RoQ - particularly ZaRR's RoQ How-to for OpenArena Mappers]. Note that RoQ file duration is limited to 1 minute. (Possibly the mainmenu_... guis can be used to sequence multiple RoQ files.)

See also: Overview of [https://modwiki.dhewm3.org/GUI_scripting GUI scripting] and [https://iddevnet.dhewm3.org/doom3/guis.html idDevNet GUIs]

== Debugging Playback ==

If your video shows a black screen, you may have a GUI error. In the console, "testgui guis/xxxx.gui" (note the partial path inclusion) may be helpful to locate where.

== See Also ==

For information about mid-game videos, see [[Video Cutscene Creation]].
{{GUI}}
[[Category:Video and cutscenes]]

Script objects

2026-02-24T19:42:52Z

Datiswous: changed size of titles/subtitles so it's more clear what belongs to what

== <big>Introduction</big> ==

A '''script object''' is an object that is written in the idTech4 scripting language, and an be attached to arbitrary entities. Each entity can have '''only one''' script object, but one script object can be attached to multiple entities.

To use a script object on an entity, give it the spawnarg '''scriptobject''' set to the name of the script object. For your convience, TDM already contains a few useful script objects, here is a list:

== <big>List of script objects</big> ==

=== <big>tdm_alarm</big> ===

A script object that sounds an alarm sound that can be heard by AI as suspicious sound, as well as a player audible sound.

Functions:

void start_alarm();
void stop_alarm();

See [[atdm:alarm_sound]] on how to use it.

=== <big>tdm_suicide</big> ===

<pre>
"scriptobject" "tdm_suicide"
"remove_delay" "100" // remove this entity 100 seconds after spawning it
</pre>

Note: In TDM v1.03 the delay '''must be''' >= 1, or the script will wait 360 seconds. In TDM v1.04, the time can also be between 0 and 1 second, for instance 0.5 seconds.

Note #3: From TDM v1.04 onwards, any entity with this script object will activate its targets right before it removes itself. This can be used to trigger things after a certain time from map start has passed, and is used f.i. by the new "atdm:vanishing_platform" entity.

=== <big>tdm_light_holder</big> ===

<pre>
"scriptobject" "tdm_light_holder"
"extinguished" "1" // the light starts off, but can be lit by the player
</pre>

This is typical attached to either lights (an electrical lamp f.i.) or light holders (a candle holder with attached candle + flame, or a torch with attached flame). This script object has handy methods to toggle all lights that this holder has, regardless how many (multiple flames?) or where (flame on holder or flame on candle on holder?).

This script object also makes the entity react to triggers like when you link a button/lever/trigger to this entity.

(See also the light_ext and light_moving_ext scriptobjects, used by extinguishable light sources to respond to fire/water/gas stims.)

=== <big>tdm_gui_message</big> ===

This script object is attached to an '''atdm:gui_message''' entity, and the entity shows a message to the player, based on cvars and spawnargs. You can use this script object for the "popup" messages that appear on the upper left corner (f.i. to give the player hints) or for screeen overlays like in a movie, where it says f.i. "Random Town, past midnight". Where the message appears and how it looks is entirely customizable by using a different gui.

See [[Popup messages]] for more information.

==== CVARs ====

* '''tdm_show_trainer_messages''' - if true, trainer messages are shown, if false, suppressed

==== Spawnargs ====

* '''show'''- The time in seconds the message is shown, will be longer by approx. one second to fade the message out. If set to 0, shows the message for 6 seconds plus 1s fade out.
* '''lines''' - Number of lines the text has
* '''text''' - The text to be shown on the message.
* '''gui''' - Name of the GUI file, defaults to ''guis/tdm_message.gui''
* '''wait''', '''delay''' - These two are inherited from '''atdm:target_callobjectfunction''' and set the "wait" between triggers and the initial "delay" before the messsage show.
* '''fade_out_time''' - Defaults to 1, in seconds. This time is waited for the GUI to fade out, then the message is forcefully removed. If you use a different gui with "gui", then set this spawnarg to match the fadeout time of your gui.
* '''auto_trigger''' - Boolean, if true, the msg is triggered "delay" seconds after map load automatically.
* '''force''' - Boolean, if true, the msg is always shown, regardless of the menu setting (e.g. the CVAR).

==== Notes ====

# Currently messages just overlay each other on the screen. So if a later messages is displayed while an old message is still there, they fade over from the old one to the new one.
# If the player then steps back into the first trigger, the old message is not displayed again, because it is still waiting around.

=== <big>tdm_voice</big> ===

A script object for atdm:voice, which can play voices (or any other sounds) so they appear to come from the player. Can be used for voiceovers and narrator effects. These effects use separate volumes defined by two different CVARs.

How to use:

# Place an '''atdm:voice''' entity (in '''Sound''' folder) in your map (location does not matter, and you need only one)
# Place multiple '''atdm:voice_trigger''' entities (in '''Targets''' folder) in your map
# Link your '''atdm:voice_trigger''' entities to your '''atdm:voice''' entity ({{key|CTRL}}+{{key|K}} in [[DarkRadiant]])

Give the following spawnargs to the '''atdm:voice_trigger''' entities:

<pre>
"snd_say" "sound_you_want_to_play" // generic, male or female
"as_player" "1" // if the player should say things
"as_player" "0" // if the narrator should say things
</pre>

When "as_player" is set to "1", the sound volume is controlled by the "Player Voice Volume" slider in the TDM Audio menu.

When "as_player" is set to "0", the sound volume is controlled by the "Narrator Volume" slider in the TDM Audio menu.
==== CVARS ====

* tdm_voice_player_volume // Player Voice Volume
* tdm_voice_from_off_volume // Narrator Volume
* Menu settings

'''Unsupported''' options (taken out because the team doesn't want to add them):

* CVAR: tdm_player_is_female
* Spawnarg: "snd_say_female" "female_sound_you_want_to_play" // overrides snd_say if the player is female

== <big>See also</big> ==

* [[Writing script objects]]

{{scripting}}

Starting to Model for TDM

2026-02-12T21:03:26Z

Datiswous: /* Modeling Software */ added links to orbweaver's import export scripts

== Modeling Software ==

Most modelers on the team use [http://www.lightwave3d.com/ Lightwave] or [http://www.blender.org/ Blender]. Anything that can save in either .lwo (prefered) or .ase format is acceptable. There are ase and lwo exporters and an lwo importer for Blender at [https://gitlab.com/orbweaver/darkblender gitlab.com/orbweaver/darkblender] (up to Blender 5.0.1) and [https://www.katsbits.com/site/category/tools/ katsbits.com] has some import/export scripts for Blender (2.49 or below), otherwise ask somebody in the Dark Mod Forums.
[http://www.autodesk.com/products/autodesk-3ds-max/overview/ 3ds Max] can be used to model and import/export .ase files.

== Making the Model ==

You will need to make, for each individual object:
* a highpoly model. There's no poly limit to this--make it as detailed as possible.
* a lowpoly version of the same size and basic shape (see dimensions below).

The detailed version is used, by Doom 3, or another tool such as ORB or xnormals, to generate a normalmap with all the details on it. This normalmap is then used with the lowpoly model to fake higher detail. See [[Renderbump]] for more information on using D3 to generate normalmaps.

* Lightwave: Your model needs to be tripled before being used in game ({{key-shift}}+{{key|T}}), or D3 will spit out tons of warning messages.
* Blender: The ASE exporter will automatically convert all your faces to triangles.
* 3dsMax: turn to poly, max sides 3, turn to edit mesh before export.

== Model and Texture Dimensions ==

Aim for less than 5000 polys for significant AI, and less than 500 for most common objects. Testing has shown that rendering polys does not slow down FPS much if they don't cast shadows. It is therefore ok to have a higher poly model if you create a low-poly shadowmesh built into it (a 1000 poly model can often have a decent shadowmesh for 300 polys). Generally, objects that might only be used once in a scene (like a well) can have higher polys, but objects that might appear many times (like lights or chairs) should have less than 500. Round objects (vases, plates, etc) should have a minimum of 8-10 sides (depending on the size of the object) to appear fairly smooth. Less important parts of an object (like the legs of a stool) can have fewer sides to keep polys down.

About 200-300 polys is the average for most smallish size props, like weapons or lights. Even our wide bookshelf model is less than 250 polys, so it's not always dependent on size.

You don't generally need to sacrifice detail just to get a model less than 300 polys, however.

Texture sizes go in powers of two: 2, 16, 32, 64, 128, 256, 512, 1024, 2048. D3 will automatically rescale TGA textures that are not in powers of two, which could stretch your texture and waste processing time (and look blurry as well). Note that the dimensions of DDS textures '''absolutely have to''' match powers of two, otherwise they appear black in-game.

== Naming Conventions ==

The following convention should be used for naming all new model additions to TDM (many existing models do not follow this convention, and over time effort will be made to update them). Following this convention will make it easier for mappers to find the models they want in a long list--if they are looking for a chest, they want to look under "c" for chest, not "w" for wooden_chest.

# '''Object Type''' descriptor first. Mappers are generally going to search by object, so they will want to find all objects of a similar type grouped together. It's a window, a plate, a chest, etc. Don't bother duplicating the name of the folder, however. If your object is inside the "lights" folder, then you don't need to call it "light_torch_wood".
# '''Material''' descriptor next. This may be appropriate, but remember that different textures can be used on the same model, so calling something "statue_marble" could be misleading if it also has a metal texture.
# '''Size''' descriptor next. This is primarily useful if there are multiple versions of the same mesh, like "statue_lion_large" and "statue_lion_small".
# '''Quality''' descriptors next. Optional. Remember that skins might exist. However, descriptors like ornate, plain, etc, can help mappers.
# '''Number Increment''' next. Adding a number to the end is useful if there are likely to be more versions of the same kind of object.

If establishing precedent (creating a new '''Size''' descriptor, e.g., "huge"), try to avoid ambiguity and unnecessary overlapping with other descriptors (e.g., "enormous"), and set a good example others will follow.

'''Examples:'''

1. ''apple_001''

This name omits all but the mandatory descriptors. If valuable information about the object can help differentiate it from others, optional descriptors may be added. If it is indeed generic, this name is fine.

2. ''chest_wood_battered_005''

This highly descriptive name omits a '''Size''' descriptor.

It should be noted that a given descriptor can use more than one word if needed, for example, lamp_wall_ (uses two object descriptors), as long as it either follows precedent or establishes a good one.

== Where to Save your Model and Textures ==

Models should be saved in the models/darkmod tree. See [[Model Folder Structure]] for specific information about where to put things.

== Grid Alignment and Origin ==

Please make sure your models are grid-aligned (the bottom of the object rests on a grid line in your modelling software). If they don't, it can be difficult to get the model to sit on the floor or other surfaces in the editor. If the object is likely to have other things placed on top of it (tables, shelves, etc) then it is also helpful if the top surface is grid-aligned as well.

Keep this in mind for all objects. The back of a door handle should sit very close to flush with the grid so it'll align well with doors. The back of a torch should be right on the grid so it doesn't sink into or float away from a wall. objects like chests are made of three different models; A chest, a lid and a lockbar. The chest can be flush to the floor, but the top might not align to the grid, it's best to move the verts to the closest grid line in this case. The lid's pivot needs to be at 0 in the z plane, so the bottom of the lid also needs to hit a grid line so it can sit flush with the top of the chest and not leave a gap. The lock bars pivot also need to be flush with 0 in the z plane (for rotation pivot) but it need sto also align on the grid so it'll match up closely to the lockbox.

Re:'''Grid size''', testing in your 3d program:
An easy way to check your grid is to open a new file in DarkRadiant, choose a large grid size and drag out a cube brush, choose the next smaller grid size and drag out another brush, do this with 3-4 grid sizes. Make each cube as small as possible for that grid size. No need to texture them, place them all close to each other.
Now select all of them and choose '''file/export as obj''', this will make them an obj file that can be imported into most 3d programs, if not you can convert it with a program like Accutrans into a 3ds mesh and import that.
Now these cubes are in your 3d program, do they align to the grid? Don't move them, if they don't align, instead adjust your grid size to match them. In 3ds Max you do this by choosing the customize ''menu/grid and snap settings/home grid tab/'' and for ''grid settings'' use a number in the power of 2, 4, 8,16... (you can use 1, or .5, or0.25 for smaller grids). This sets the alignment equal to DR's grid. 3ds Max is natuarally set at 10 which doesn't DR grid at all. You can set the ''major grid lines'' to something you are comfortable with, 4, 8, ect...That just makes a darker grid line every 4 or 8 lines.
Now any verts placed on a grid line will match the grid in DR.

Re: '''Origins'''. D3 uses the origin of the model to determine physics for movement--moveable objects will rotate around the origin when they are bouncing around. Any model that will likely be made into a moveable object (basically any unattached object smaller than a chair) should have its origin where its center of gravity would be. The frob trace is also done to an object's origin. Typically a player will look at the center of an object to frob it, not the bottom, so having the origin in the center of moveables makes them easier/more realistic to frob.

Large objects that are not likely to be moveables, like desks or wardrobes, can have their origin at the bottom of the object, for easy placement on the floor. An exception would be something like trees that an author might possibly sink into the ground far enough to reach outside the world. In this case have a centered origin would be best so the origin stays inside world.

Objects that might be designed to swing or rotate (like a hanging sign) should have their origin at the point of rotation.

== Collision Meshes ==

Collision models should be used on most objects for several reasons. They can help simplify pathfinding databases for AI and weapons, they also simplify the shape of the object so it can be moveable. If an object is going to be static and not move, like a pillar, its collision model can be as complex as you want, however this defeats the purpose of a collision mesh. Generally you want to make the collision mesh as simple as possible while retaining the basic shape of the model. This will guaranty that arrows will bounce off of it, or stick to it in a realistic way. If the mesh doesn't match the original object close enough you will get things like arrows bouncing off the air next to the model, or arrows that go through the model.

Collision models must be exported with the original object mesh. This makes them hard to see in the editor, but the collision surface can be toggled so it's not a problem. Collision meshes won't be seen in game, nor will their effects if done properly.

A static object can use one or more collision models, the purpose of this is to apply different materials to the colllision model. For instance, the generic Doom collision sounds like stone when an arrow bounces off of it, and arrows will always bounce off of it. However Dark Radiant allows the use of material specific collision shaders. So a chest can be made of metal and wood, an arrow will bounce of the metal parts and stick into the wood parts. The number of collision meshes on a static object is undetermined but should be limitless.
This is a good way to simplify collision while retaining the objects material types. A collision model overrides an objects shader properties (the image will be the same but noise and collision props will not work), so if you export with collision try to seperate it into materials.
Examples of collision shader names: //base/tdm_collision_wood, //base/tdm_collision_ceramic

Moveable objects ''must'' have collision models unlike static objects. These meshes have to be very simple. Currently the exact specs of a moveables collision mesh are under debate. You will often see these specs stated as less than 16 polys, no concave polys, ect... But it is possible to make workable collision models with both of the above rules broken, however it is very unlikely and you are lucky if it works. Most of the time if you do break those rules you will get an unstable mesh that will fly across the room when frobbed, sometimes even resulting in SHAS (Sudden Heart Attack Syndrom) when the player dies without warning. So sticking to those guidlines is usually best and can still result in a decent collision model in most cases. Multiple collision meshes have been successfully exported also, however they only use the material type of the first collision model loaded, this can also lead to instability. Generally simple shapes work best, just try to make it fit your object as close as possible.

Shapes that work well for moveable collision models are cubes, pyramids and cylinders (up to 7 sides seems to work well). An L-shape of 2 collision meshes has proven to work with chairs (basically 2 cubes).

For an idea what will work look at models in the model viewer. Of course a crate has a cube, a gear will have a cylinder, a lamp might have a pyramid. Objects that use unconventional shapes that defy the rules above are keys and the silver teapot.

== Shadow Meshes ==

Shadow meshes are similar to collision meshes. Basically they are just to simplify shadow casting, this can have great benefits to maps, especially if there are multiple lights hitting the object. Doom 3 can handle an enormous amount of polys on screen without flinching, however throw in a couple lights and you can bring it to its knees. This is where the importance of shadow meshes really counts. Doom3 calculates how each triangle is hit by a light and what shadow that triangle will cast, this is no big deal with one triangle, or one light but in a map you are sure to have many lights and many polys. These calculations are done every frame.

We have done tests with 100,000 polys and one light, FPS will be around 60. Add a second light and the FPS will drop to 45, add a 3rd light and FPS will drop to 30 (rough estimates)... So if your objects are 100,000 polys but your shadow meshes only equal 50,000 polys you have already cut the lag in half.

All materials and/or objects (including game created func_static meshes) can have noshadows set to 1. While this really helps performance it can look very bad and have bad effects on gameplay. Darkmod is a game set in very shadowy places and the player uses shadows for stealth, the major gameplay component, hence the importance of shadow meshes once again.

When modeling the shadow mesh try to match the basic shape of your object as close as possible while using as few triangles as possible. Say you have a pipe object that has 20 sides and is very round. You could make a shadow mesh with only 4 sides and for the most part the shadow would look the same, the noticable difference would be that the ends would cast sharp corners, but often times these can be hidden within another shadow and wont be noticeable in game at all. Even the shape of the pipe going into a wall would mask the bad edges of the shadow.

Shadow meshes must be exported with objects and their collision models. Unlike collision shaders the shadow shaders do ''not'' override the objects shadows. So when making a model that uses a shadow mesh you need to use material shaders for the object with noshadows on it, this has to be set in the material file (materials/.mtr). However do not go and start adding ''noshadows'' to all the materials as some objects or terrain might need shadows. Instead copy/paste the shader deffinition into a new .mtr file, give it a new name and add noshadows to it, that way the original material doesn't change. You should also use ''NoSelfShadow'' which will stop the material from casting shadows on itself.

There are 2 material shaders for shadow meshes, they can be combined and both used for one model at the same time. They are '''textures/common/shadow''' and '''textures/common/shadow2'''. ''Shadow'' material casts shadows and self shadows (on the object the mesh is exported with, it is all considered one object although the collision and shadow meshes are not seen in game). Shadow2 casts shadows (on terrain and other objects) but does not cast shadows on itself. This is very handy for things like apples where the player really won't notice if the stem casts a shadow on the apple. Remember, this is one of the most important considerations for performance so if an object can live without shadows, or without casting shadows on itself then use that option first.

Weird lighting issues due to shadow meshes. .Ase files from 3ds max have an issue with shadow meshes clipping outside of an objects mesh which can cause weird shadow fragments on the objects they belong to. The cure for this is to make sure that the shadow mesh is entirely inside the objects mesh. If it sticks out anywhere you will get a weird shadow. A workaround I have found that works good is to model large parts of a shadow mesh that are easy to hide, this can cut down alot of shadow casting polys on an object. Then I will split small details off of the object and give them a material that has shadows, then I don't have to mess with the very hard areas but have still done some good. (example: a small pot with tiny handles, the pot will cast no shadows but will have a shadow mesh to do that, The tiny handles will themselves cast shadows so there is no weird shadow mesh clippling - both use the same base material, but the noshadows and noself shadow lines are removed from a copy of the original shader).
There seems to be no issue with lwo files, I am not sure why this is, but if you are making these files it seems you can be a bit more lax in the overall shape/clipping of your shadow mesh.

{{tutorial-models}}

Console Useful Controls

2026-01-13T01:01:16Z

Datiswous: /* Notes */ tdm_end_mission

==Introduction==

This is a list of common console commands and cvars that are of use to Dark Mod mappers and developers for testing etc. It is in order of key words and meaning. The console can be called by hitting "{{key|CTRL}}+{{key|ALT}}+{{key|~}}" ("{{key|CTRL}}+{{key|ALT}}+{{key|Key left of number 1}}" in general, e.g. "{{key|CTRL}}+{{key|ALT}}+{{key|^}}" on a German keyboard).

This will open the console to cover the upper 50% of the screen. To cover more (80%), also hold down the {{key|SHIFT}} key.

==Notes==

* Where a cvar or command is followed by a 1 (parameter) it can be taken that it is enabled by 1 and disabled by 0 unless otherwise stated. '''N''' indicates a range of values.
* The current value of a cvar can be shown by entering its name without a value.
* Parameters can be toggled between values by preceding the control with 'toggle' and following it with eg, 1 0. Example : toggle r_showtris 3 0
* Controls can be bound to keys to be used in-game, including the toggle command, eg, <tt>bind "v" "toggle r_showportals 1 0"</tt> . See also [[Bindings and User Settings]].
* Many controls can be included in the file <s>Doomconfig.cfg</s> '''Darkmod.cfg''' in the darkmod folder so they are automatically effective.
* Some controls are disabled on exit from a map; others are permanent until manually changed.

{|class="wikitable sortable" border=1 style="border-color: grey; border-collapse: collapse; font-size: 92%; margin-left: 1em" cellspacing=0 cellpadding=3

|-
!bgcolor=#ffdead|Command
!bgcolor=#ffdead|Description

|-
!align=left|noclip
|Player flies through everything.

|-
!align=left|notarget
|AI will not know the player is there.

|-
!align=left|invisible
|AI will not see the player, but can still hear him.

|-
!align=left|inaudible
|AI will not hear the player, but can still see him.

|-
!align=left|god
|Player cannot be harmed.

|-
!align=left|killmonsters
|Removes all AI from a map.

|-
!align=left|tdm_open_doors
|Opens all doors on map: even locked and unpickable ones!

|-
!align=left|tdm_close_doors
|Closes all doors on map

|-
!align=left|tdm_end_mission
|Force a mission ending (handy for testing campaigns and debriefings)

|-
!align=left|trigger entityname
|Triggers the named entity

|-
!align=left|tdm_show_loot
|Shows loot items through walls for a short time.

|-
!align=left|tdm_show_keys
|Shows keys through walls for a short time.

|-
!align=left|g_dragentity 1
|Aim at entity and hold attack control then pull back.

|-
!align=left|pm_noclipspeed N
|Changes the speed of player noclip movement.

|-
!align=left|g_fov N
|N=angle of field of view, eg, '''<code>g_fov 30</code>''' = zoom in to restrict field of view to 30 degrees. Default = 90.

|-
!align=left|g_showEntityInfo 1
|Show info about near entities (as box with classname).

|-
!align=left|com_showfps 1
|Show fps to test performance.

|-
!align=left|com_numQuickSaves N
|How many quicksaves to retain. Reducing the number won't delete any that you already have.

|-
!align=left|g_frametime 1
|Timing info for each frame, see [[Profiling#g_frametime|Profiling]].

|-
!align=left|r_showPrimitives 1
|Show info about number of [[drawcalls]] and tris/shadow tris rendered.

|-
!align=left|con_noprint 0
|Prints console messages to the screen as an overlay.

|-
!align=left|r_showSurfaceInfo 1
|Show info about closest rendered surface under crosshair: model name, index of surface in model, material name

|-
!align=left|r_showskel 1
|Shows skeleton in-game with joint names.

|-
!align=left|g_showCollisionModels 1
|Shows collision models. Use '''g_maxShowDistance N''' to increase the distance where they are shown to.

|-
!align=left|r_showtris N
|(1) Shows triangles being rendered directly.<br>(2) Shows overdrawn tri's.<br>(3) Shows all tri's in scene, direct and indirect.

|-
!align=left|r_showportals N
|(1) Shows all portals in scene (red=closed, green=open). If your portals don't show up they are most likely not sealing. Yellow indicates a portal that is effectively closed but which connects to a visleaf visible through another portal.
(2) Also prints area numbers, mainly where player's eye is right now.

|-
!align=left|r_showlightcount 1
|Using colours, shows the number of lights hitting a surface, black = 0, red = 1, blue = 2... etc.

|-
!align=left|seta tdm_showsprop 1
|Shows the volume of sounds heard by AI.

|-
!align=left|tdm_ai_showbark 1
|Gives the def name (not the soundshader) of barks used by AI.

|-
!align=left|tdm_ai_showalert 1
|Shows the AI's current alert total and alert state.

|-
!align=left|tdm_ai_showdest 1
|Shows the AI's current path destination.

|-
!align=left|bind "f1" "_impulse27"
|Pressing F1 shows the AAS regions.

|-
!align=left|timescale 2
|Double speed, good for testing pathing, 1 = normal speed, 2 = double, 0.5 = half speed. To have an effect, the "Uncapped FPS" setting must be Off.

|-
!align=left|g_timeModifier 2
|Same as timescale 2 but somewhat different

|-
!align=left|g_stopTime 1
|Stops gameplay time, but player can move normally.

|-
!align=left|teleport "entity name"
|teleports the player to the named entity

|-
!align=left|teleportArea N
|teleports the player into the area with number N

|-
!align=left|getviewpos
|get player's position and orientation [[Reporting_Problem#Coordinates|coordinates]]

|-
!align=left|setviewpos X Y Z [P Y R]
|teleports the player to the coordinates and optionally sets camera orientation.

|-
!align=left|tdm_show_viewpos
|show/hide the viewpos on the player HUD, which can be set to the following: 0 (hide), 1 (gray font color), 2 (cyan font color)

|-
!align=left|screenshot_viewpos <gamma>
|takes a screenshot with the viewpos added to it. The <gamma> argument is optional and defaults to the r_ambientGamma value.

|}

== Spawning entities ==

Spawns entity in front of the player. Look up if entity gets spawned under the floor.

{|class="wikitable sortable" border=1 style="border-color: grey; border-collapse: collapse; font-size: 92%; margin-left: 1em" cellspacing=0 cellpadding=3

|-
!bgcolor=#ffdead|Command
!bgcolor=#ffdead|Description

|-
!align=left|spawn atdm:weapon_blackjack
|Spawns blackjack.

|-
!align=left|spawn atdm:weapon_shortsword
|Spawns a sword.

|-
!align=left|spawn atdm:ammo_broadhead
|Spawns one arrow.

|-
!align=left|spawn atdm:ammo_broadhead inv_ammo_amount 50
|Spawns 50 arrows (one entity with 50 ammo). Similar technique can be used for other ammo types.

|-
!align=left|spawn atdm:ammo_firearrow
|

|-
!align=left|spawn atdm:ammo_gasarrow
|

|-
!align=left|spawn atdm:ammo_mossarrow
|

|-
!align=left|spawn atdm:ammo_noisemaker
|

|-
!align=left|spawn atdm:ammo_ropearrow
|

|-
!align=left|spawn atdm:ammo_waterarrow
|

|}

With the TDM console you can press tab after typing something to autocomplete. For example <tt>spawn atdm:<tab></tt> will cycle through the various spawnables. You can also add additional spawnargs using the following syntax: <tt>spawn classname [key value] [key value] ...</tt>.

== Diagnostic information ==

{|class="wikitable sortable" border=1 style="border-color: grey; border-collapse: collapse; font-size: 92%; margin-left: 1em" cellspacing=0 cellpadding=3

|-
!bgcolor=#ffdead|Command
!bgcolor=#ffdead|Description

|-
!align=left|listEntities
|lists all current entities followed by a count.

|-
!align=left|listEntities GLOB
|lists all alive entities whose names match given glob/wildcard (e.g. use asterisks like <tt>*func_static*</tt> to search for substring).

|-
!align=left|countEntities
|displays a count of entities by class. ''TDM 2.03+''

|-
!align=left|listCvars GLOB
|lists all cvars matching the given glob/wildcard (no argument = lists everything).

|-
!align=left|listCmds GLOB
|lists all console commands matching the given glob/wildcard (no argument = lists everything).

|-
!align=left|condump [unwrap] ''filename.txt''
|Writes the text content of the console to text file ''filename.txt'' (you can use any file name). If optional keyword ''unwrap'' is used, full lines from the console will be stitched together with the following line. Useful when exporting long file paths from the console, that have been broken up by its width limit. ''TDM 2.03+''

|}

==See Also==

[[Cvars in The Dark Mod]]

{{editing}}

[[Category:CVARS]]

Setting up Campaigns

2025-12-19T22:38:27Z

Datiswous: /* De-Briefing Videos */ Changed text to new way of specifying de-briefing video's per mission in campaign

This article is an attempt to describe the various options mappers need to consider when setting up campaigns or multi-mission packages (I'll refer to campaigns for both of these for the sake of simplicity). Campaign support has been added in TDM 1.06.

= Map Files =
Regular, single-map TDM missions are packed in PK4 files, campaigns are no different. If your campaign consists of three missions ("red.map", "blue.map" and "green.map"), all three of them still go into the same maps folder in your PK4 file.

The actual order in which the missions are to be played is defined through the <tt>tdm_mapsequence.txt</tt> file, which should be added to the PK4 (just next to the readme.txt). Following the example of the "red", "blue" and "green" maps above the map sequence file would look like this:

Mission 1: red
Mission 2: blue
Mission 3: green

Looking at that, the syntax of the file is pretty much self-explanatory. The first mission has the number one, the map file is mentioned after the colon and the following space. You don't need to specify the ".map" extension of the map file that is handled automatically. See the main [[tdm_mapsequence.txt]] article for further reference, for this article it's enough to have the above lines I suppose.

= Text briefings =
Once the map sequence is defined one needs to take care of the briefing. If you like to keep it simple, just refer to the Briefing article in the [[Briefing#Text-only_Briefing|Text-only Briefing]] section. Each map needs its own xdata block with the briefing and you'll be done.

For advanced setups there are a few modifications to be made. In the briefing gui file mainmenu_briefing.gui you can define what advanced briefing is loaded with every mission in your campaign. It's advised to make seperate missions and then combine them together into a campaing using code inside mainmenu_briefing.gui .
For example you can put every briefing of every seperate mission inside ''mission_briefing_1''.gui, ''mission_briefing_2''.gui, ''mission_briefing_3''.gui, then inside mainmenu_briefing.gui you reference them via #include per MM_CURRENTMISSION .

Example:
<nowiki>

#if MM_CURRENTMISSION == 1
#include mission_briefing_1.gui

#elif MM_CURRENTMISSION == 2
#include mission_briefing_2.gui

#elif MM_CURRENTMISSION == 3
#include mission_briefing_3.gui

#endif
</nowiki>

For each mission inside the campaign you customize settings in file mainmenu_custom_defs.gui .

Example:

<nowiki>

#if MM_CURRENTMISSION == 1
#define ENABLE_MAINMENU_SHOP 1
#define ENABLE_MAINMENU_SUCCESS 0

#elif MM_CURRENTMISSION == 2
#define ENABLE_MAINMENU_BRIEFING_VIDEO 1
#define ENABLE_MAINMENU_BRIEFING 0

#endif
</nowiki>

See for complete information on this text inside mainmenu_custom_defs.gui, which can be found inside file tdm_gui01.pk4 .

<div class="mw-collapsible mw-collapsed" style="width: 60%">
Via the [Expand]-button you can access the old (still viable) method of making advanced text briefings work in campaigns. It's adviced to not use this, because it means more work and is more complicated.

<div class="mw-collapsible-content">
For advanced setups like the "Timed Flowing Briefing" mentioned in the [[Briefing]] article there are a few modifications to be made to your GUI code. As the mainmenu_briefing.gui file is the same for the whole campaign your GUI needs to know which map the player is about to play next. For this purpose a GUI variable <tt>gui::CurrentMission</tt> has been introduced which can be used in if-else GUI code blocks in the BriefingStateInit windowDef. For single-missions, mappers just called the GUI animation block like this:

windowDef BriefingStateInit
{
noTime 1

// Init methods have onTime 10 instead of onTime 0.
onTime 10
{
// ... stuff

set "BriefingAnimation::visible" "1";
resetTime "BriefingAnimation" 0;

// ... stuff
}
}
For multi-mission setups an if-else block should be added to switch to the correct briefing animation for the current map:
windowDef BriefingStateInit
{
noTime 1

// Init methods have onTime 10 instead of onTime 0.
onTime 10
{
// ... stuff

if ("gui::CurrentMission" == 1)
{
set "BriefingMission1Animation::visible" "1";
resetTime "BriefingMission1Animation" 0;
}
else if ("gui::CurrentMission" == 2)
{
set "BriefingMission2Animation::visible" "1";
resetTime "BriefingMission2Animation" 0;
}

// ... stuff
}
}

Of course you'll need to define a <tt>BriefingMissionXAnimation</tt> block for each mission. You can use the instructions in the [[Briefing]] article to learn how to do that, just keep in mind to change the windowDef's name such that you don't end up with duplicate names for your windowDefs (this will lead to warnings in the console at game startup at best).

Starting the correct mission briefing animation is only half the rent, you'll need to stop the correct animation as well when the player proceeds to the objectives screen:
windowDef BriefingStateEnd
{
noTime 1

onTime 0
{
// ... stuff

if ("gui::CurrentMission" == 1)
{
set "BriefingMission1Animation::visible" "0";
set "BriefingMission1Animation::notime" "1";
}
else if ("gui::CurrentMission" == 2)
{
set "BriefingMission2Animation::visible" "0";
set "BriefingMission2Animation::notime" "1";
}

// ... stuff
}
}
If you don't do that the player might see remnants of the previous mission's briefing when proceeding to the next map briefing.

The same holds analogously for the BriefingSkip windowDef which is used to skip the briefing on mouse clicks:

windowDef BriefingSkip
{
notime 1

onTime 0
{
// ... stuff

// Stop the animation
if ("gui::CurrentMission" == 1)
{
resetTime "BriefingMission1Animation" 0;
set "BriefingMission1Animation::notime" "1";
}
else if ("gui::CurrentMission" == 2)
{
set "BriefingMission2Animation::visible" "1";
resetTime "BriefingMission2Animation" 0;
}
}
}
</div>
</div>

= Video briefings =
It's possible to define briefing/intro videos for each mission in a campaign. To enable videos mappers need to include a mainmenu_custom_defs.gui file in their PK4 and define a few variables in there. You can look at the default file <code>tdm_gui01.pk4/guis/mainmenu_custom_defs.gui</code> to get more info and read some comments. I'll include the most important settings briefly here:

You'll need to specify which video to be played for each mission:

#if MM_CURRENTMISSION == 1
#define MM_BRIEFING_VIDEO_MATERIAL_1 "video/briefing_video_1"
#define MM_BRIEFING_VIDEO_SOUND_CMD "music video/briefing_video_1;"

The line <code>#if MM_CURRENTMISSION == 1</code> tells this is the first mission of the campaign. The lines under it are single mission video specifics settings that are only applied to the first mission in the campaign because of the top line.

The last line in this triple is defining the sound to be played along the video: <code>MM_BRIEFING_1_VIDEO_SOUND_CMD</code>. Be sure to include the "music" command in the string and to refer to a valid sound shader.

For the second mission you use line <code>#if MM_CURRENTMISSION == 2</code> and then specify the correct video and sound files for the second mission's video briefing.

= De-Briefing Videos =
It's possible to have a video played back immediately after "Mission Complete". So-called de-briefings.

The mechanism to set these up is very similar to the above briefing videos, all you need is to add the correct lines in your mainmenu_custom_defs.gui file:

#if MM_CURRENTMISSION == 1
#define MM_DEBRIEFING_VIDEO_MATERIAL_1 "guis/video/credits/typing_sequence01"
#define MM_DEBRIEFING_VIDEO_SOUND_CMD "music tdm_mainmenu_background_music;"

This example will play a credits video after "Mission Complete". Please refer to the above "Video briefings" section to learn about the precise meaning of these lines, they are pretty much analogous.

Side note: this option is not exclusive to campaigns, you can have a de-briefing video in single-mission setups just as well.

= Conditional Objectives =
You can have your mission objectives depend on the state of objectives in previous missions. It's possible to set an objective in the second mission to "COMPLETE" if the player managed to fulfill an objective in the first mission.

[[Image:Objective conditions editor.png|400px|right]]

Consider a campaign consisting of two maps: red.map and blue.map, played in this order. You have an optional objective in red.map telling the player to find 50 loot in gold. If the player manages to complete that objective the mandatory objective in mission 2 ''"Find enough gold for your rent"'' should already be marked as ''"Completed"''. Such a thing can be achieved through a set of spawnargs that have been introduced in TDM 1.06 (see the [[Objectives#Objective_Conditions|Objectives]] article for reference), but you can do it through the Objectives Editor just as fine.

I'll assume the use of the Conditions editor is fairly straightforward, but feel free to ask specific questions in our forums.

= Scripting =
There are a few script methods which are specifically designed to be used in maps. See the file tdm_events.script for more details about them.

===== mission number =====
Use the getCurrentMission() method on the sys entity to retrieve the current mission number. Note that the mission numbers are 0-based in the code, the function will return 0 for the first mission in a campaign. The following snippet will print the number to the console:
sys.println("Current Mission: " + sys.getCurrentMissionNum());

===== persistent info =====
There are a couple of script events that can be used to store data in between missions. This data is stored in the so-called "persistent level info", which is designed to store key/value pairs.
See <tt>tdm_events.script</tt> file for further reference:

void setPersistentArg( string key, string value );
string getPersistentString( string key );
float getPersistentFloat( string key );
vector getPersistentVector( string key );

For example, you can store a number value like this (all values are stored as strings):
sys.setPersistentArg("dummyvar", "20");

Later on you receive the number value like this:
float testvar = sys.getPersistentFloat("dummyvar");

If you ever need to clear out the entire level info there's a separate routine for that:
sys.clearPersistentArgs();

===== game & gui =====

Starting with '''TDM 2.13''', persistent information is also provided as GUI variables ([https://bugs.thedarkmod.com/view.php?id=6509 #6509]).
The information is automatically synchronized between game script variables and GUI variables.

For example, here is how you access "killed_berny" persistent argument in game script:
sys.setPersistentArg("killed_berny", "1");
float value = sys.getPersistentFloat("killed_berny");

And here is how you access it in GUI script:
set "gui::persistent_killed_berny" "1";
if ("gui::persistent_killed_berny" == 0) { ... }

You can add a custom checkbox in GUI briefing, and then customize the game depending on whether the player enabled it or not.
Or you can implement game script functions <tt>on_mission_complete</tt> and <tt>on_mission_failed</tt> and save some info about game state in order to customize debriefing.
This feature can be useful for single missions as well.

= Inventory Items =
The player's inventory contains all the keys, tools, lockpicks, lantern as well as all the weapons. The mapper can define which of these should be kept when proceeding to the next mission. Items that are allowed to be kept are called "persistent", and the corresponding spawnarg controlling that property is called "inv_persistent".

== Tools & Items ==
By default regular inventory items are not marked as persistent, i.e. the inv_persistent key is set to "0". Once the mapper flips that spawnarg to "1" the item will be kept throughout the following missions. The item will be kept until the end of the whole campaign, unless:
* the player drops the item
* it is removed from the inventory by script or other events
* a rule on the atdm:campaign_info entity is forcing the item to be removed after "Mission Complete" (see below).

Even though TDM 2.02+ will resolve naming conflicts across maps, map authors should try to make sure that persistent items have unique names. For example, if the first map has a persistent item named "My Water Bottle", none of the subsequent maps should have an item named "My Water Bottle". If you must have a second water bottle, name it "My Second Water Bottle", or something along those lines.

If you have a persistent stackable item in map N, and you don't consume it in that map, and you have another instance of the same stackable item in map N+1 (whether it's marked 'persistent' or not), when you pick it up, it will be added to the stack count of map N's item and become persistent.

== Weapons & Arrows ==
All weapon inventory items are persistent by default including their ammo, so without further action the player will keep all his weapons and all the arrows when proceeding to the next mission. However it's possible to define ammo limits on the atdm:campaign_info entity, which is described below.

Important: it's not advisable to mess with the inv_persistent spawnarg on weapon items - it's recommended to leave that spawnarg at the default value and control the carry-over by the rules on the campaign info entity.

== Inventory Item and Weapon Limits ==
An [[atdm:campaign_info]] entity can be placed in a map to control which items make it to the next mission (and their amount) - and which should be dropped. The rules defined on the [[atdm:campaign_info]] entity will be enforced after the "Mission Complete" event, when the map is still active, i.e. it's "filtering" outgoing items. Each map can have its own campaign info entity to define its own set of rules.

Please refer to the main [[atdm:campaign_info]] article to get precise info on how to set up these rules.

= Loot Limits =
Special handling is possible for the amount of loot that is carried over and usable in the shop of the next mission. These so-called "loot carry-over" rules are defined on the shop entity of the respective map, e.g. the shop entity in Mission B will define the loot carry-over roles applicable to the loot collected in Mission A.

Refer to the [[Shop#Limiting_the_Loot_from_previous_Missions|Shop]] article for further reference.

{{editing}}
[[Category:Campaigns]]

Setting up Campaigns

2025-12-19T22:14:35Z

Datiswous: /* Video briefings */ Changed text to new way of specifying video's per mission in campaign.

This article is an attempt to describe the various options mappers need to consider when setting up campaigns or multi-mission packages (I'll refer to campaigns for both of these for the sake of simplicity). Campaign support has been added in TDM 1.06.

= Map Files =
Regular, single-map TDM missions are packed in PK4 files, campaigns are no different. If your campaign consists of three missions ("red.map", "blue.map" and "green.map"), all three of them still go into the same maps folder in your PK4 file.

The actual order in which the missions are to be played is defined through the <tt>tdm_mapsequence.txt</tt> file, which should be added to the PK4 (just next to the readme.txt). Following the example of the "red", "blue" and "green" maps above the map sequence file would look like this:

Mission 1: red
Mission 2: blue
Mission 3: green

Looking at that, the syntax of the file is pretty much self-explanatory. The first mission has the number one, the map file is mentioned after the colon and the following space. You don't need to specify the ".map" extension of the map file that is handled automatically. See the main [[tdm_mapsequence.txt]] article for further reference, for this article it's enough to have the above lines I suppose.

= Text briefings =
Once the map sequence is defined one needs to take care of the briefing. If you like to keep it simple, just refer to the Briefing article in the [[Briefing#Text-only_Briefing|Text-only Briefing]] section. Each map needs its own xdata block with the briefing and you'll be done.

For advanced setups there are a few modifications to be made. In the briefing gui file mainmenu_briefing.gui you can define what advanced briefing is loaded with every mission in your campaign. It's advised to make seperate missions and then combine them together into a campaing using code inside mainmenu_briefing.gui .
For example you can put every briefing of every seperate mission inside ''mission_briefing_1''.gui, ''mission_briefing_2''.gui, ''mission_briefing_3''.gui, then inside mainmenu_briefing.gui you reference them via #include per MM_CURRENTMISSION .

Example:
<nowiki>

#if MM_CURRENTMISSION == 1
#include mission_briefing_1.gui

#elif MM_CURRENTMISSION == 2
#include mission_briefing_2.gui

#elif MM_CURRENTMISSION == 3
#include mission_briefing_3.gui

#endif
</nowiki>

For each mission inside the campaign you customize settings in file mainmenu_custom_defs.gui .

Example:

<nowiki>

#if MM_CURRENTMISSION == 1
#define ENABLE_MAINMENU_SHOP 1
#define ENABLE_MAINMENU_SUCCESS 0

#elif MM_CURRENTMISSION == 2
#define ENABLE_MAINMENU_BRIEFING_VIDEO 1
#define ENABLE_MAINMENU_BRIEFING 0

#endif
</nowiki>

See for complete information on this text inside mainmenu_custom_defs.gui, which can be found inside file tdm_gui01.pk4 .

<div class="mw-collapsible mw-collapsed" style="width: 60%">
Via the [Expand]-button you can access the old (still viable) method of making advanced text briefings work in campaigns. It's adviced to not use this, because it means more work and is more complicated.

<div class="mw-collapsible-content">
For advanced setups like the "Timed Flowing Briefing" mentioned in the [[Briefing]] article there are a few modifications to be made to your GUI code. As the mainmenu_briefing.gui file is the same for the whole campaign your GUI needs to know which map the player is about to play next. For this purpose a GUI variable <tt>gui::CurrentMission</tt> has been introduced which can be used in if-else GUI code blocks in the BriefingStateInit windowDef. For single-missions, mappers just called the GUI animation block like this:

windowDef BriefingStateInit
{
noTime 1

// Init methods have onTime 10 instead of onTime 0.
onTime 10
{
// ... stuff

set "BriefingAnimation::visible" "1";
resetTime "BriefingAnimation" 0;

// ... stuff
}
}
For multi-mission setups an if-else block should be added to switch to the correct briefing animation for the current map:
windowDef BriefingStateInit
{
noTime 1

// Init methods have onTime 10 instead of onTime 0.
onTime 10
{
// ... stuff

if ("gui::CurrentMission" == 1)
{
set "BriefingMission1Animation::visible" "1";
resetTime "BriefingMission1Animation" 0;
}
else if ("gui::CurrentMission" == 2)
{
set "BriefingMission2Animation::visible" "1";
resetTime "BriefingMission2Animation" 0;
}

// ... stuff
}
}

Of course you'll need to define a <tt>BriefingMissionXAnimation</tt> block for each mission. You can use the instructions in the [[Briefing]] article to learn how to do that, just keep in mind to change the windowDef's name such that you don't end up with duplicate names for your windowDefs (this will lead to warnings in the console at game startup at best).

Starting the correct mission briefing animation is only half the rent, you'll need to stop the correct animation as well when the player proceeds to the objectives screen:
windowDef BriefingStateEnd
{
noTime 1

onTime 0
{
// ... stuff

if ("gui::CurrentMission" == 1)
{
set "BriefingMission1Animation::visible" "0";
set "BriefingMission1Animation::notime" "1";
}
else if ("gui::CurrentMission" == 2)
{
set "BriefingMission2Animation::visible" "0";
set "BriefingMission2Animation::notime" "1";
}

// ... stuff
}
}
If you don't do that the player might see remnants of the previous mission's briefing when proceeding to the next map briefing.

The same holds analogously for the BriefingSkip windowDef which is used to skip the briefing on mouse clicks:

windowDef BriefingSkip
{
notime 1

onTime 0
{
// ... stuff

// Stop the animation
if ("gui::CurrentMission" == 1)
{
resetTime "BriefingMission1Animation" 0;
set "BriefingMission1Animation::notime" "1";
}
else if ("gui::CurrentMission" == 2)
{
set "BriefingMission2Animation::visible" "1";
resetTime "BriefingMission2Animation" 0;
}
}
}
</div>
</div>

= Video briefings =
It's possible to define briefing/intro videos for each mission in a campaign. To enable videos mappers need to include a mainmenu_custom_defs.gui file in their PK4 and define a few variables in there. You can look at the default file <code>tdm_gui01.pk4/guis/mainmenu_custom_defs.gui</code> to get more info and read some comments. I'll include the most important settings briefly here:

You'll need to specify which video to be played for each mission:

#if MM_CURRENTMISSION == 1
#define MM_BRIEFING_VIDEO_MATERIAL_1 "video/briefing_video_1"
#define MM_BRIEFING_VIDEO_SOUND_CMD "music video/briefing_video_1;"

The line <code>#if MM_CURRENTMISSION == 1</code> tells this is the first mission of the campaign. The lines under it are single mission video specifics settings that are only applied to the first mission in the campaign because of the top line.

The last line in this triple is defining the sound to be played along the video: <code>MM_BRIEFING_1_VIDEO_SOUND_CMD</code>. Be sure to include the "music" command in the string and to refer to a valid sound shader.

For the second mission you use line <code>#if MM_CURRENTMISSION == 2</code> and then specify the correct video and sound files for the second mission's video briefing.

= De-Briefing Videos =
With TDM 1.06 and upwards it's possible to have a video played back immediately after "Mission Complete", so-called de-briefings.

The mechanism to set these up is very similar to the above "SDK-controlled" briefing videos, all you need is to add the correct #DEFINE lines in your mainmenu_custom_defs.gui file:

#define MM_DEBRIEFING_1_VIDEO_MATERIALS "guis/video/credits/typing_sequence01;"
#define MM_DEBRIEFING_1_VIDEO_LENGTHS "2000;"
#define MM_DEBRIEFING_1_VIDEO_SOUND_CMD "music tdm_mainmenu_background_music;"

This example will play a credits video after "Mission Complete" for 2 seconds (= 2000 milliseconds). Please refer to the above "Briefings" section to learn about the precise meaning of these lines, they are pretty much analogous.

Side note: this option is not exclusive to campaigns, you can have a de-briefing video in single-mission setups just as well.

= Conditional Objectives =
You can have your mission objectives depend on the state of objectives in previous missions. It's possible to set an objective in the second mission to "COMPLETE" if the player managed to fulfill an objective in the first mission.

[[Image:Objective conditions editor.png|400px|right]]

Consider a campaign consisting of two maps: red.map and blue.map, played in this order. You have an optional objective in red.map telling the player to find 50 loot in gold. If the player manages to complete that objective the mandatory objective in mission 2 ''"Find enough gold for your rent"'' should already be marked as ''"Completed"''. Such a thing can be achieved through a set of spawnargs that have been introduced in TDM 1.06 (see the [[Objectives#Objective_Conditions|Objectives]] article for reference), but you can do it through the Objectives Editor just as fine.

I'll assume the use of the Conditions editor is fairly straightforward, but feel free to ask specific questions in our forums.

= Scripting =
There are a few script methods which are specifically designed to be used in maps. See the file tdm_events.script for more details about them.

===== mission number =====
Use the getCurrentMission() method on the sys entity to retrieve the current mission number. Note that the mission numbers are 0-based in the code, the function will return 0 for the first mission in a campaign. The following snippet will print the number to the console:
sys.println("Current Mission: " + sys.getCurrentMissionNum());

===== persistent info =====
There are a couple of script events that can be used to store data in between missions. This data is stored in the so-called "persistent level info", which is designed to store key/value pairs.
See <tt>tdm_events.script</tt> file for further reference:

void setPersistentArg( string key, string value );
string getPersistentString( string key );
float getPersistentFloat( string key );
vector getPersistentVector( string key );

For example, you can store a number value like this (all values are stored as strings):
sys.setPersistentArg("dummyvar", "20");

Later on you receive the number value like this:
float testvar = sys.getPersistentFloat("dummyvar");

If you ever need to clear out the entire level info there's a separate routine for that:
sys.clearPersistentArgs();

===== game & gui =====

Starting with '''TDM 2.13''', persistent information is also provided as GUI variables ([https://bugs.thedarkmod.com/view.php?id=6509 #6509]).
The information is automatically synchronized between game script variables and GUI variables.

For example, here is how you access "killed_berny" persistent argument in game script:
sys.setPersistentArg("killed_berny", "1");
float value = sys.getPersistentFloat("killed_berny");

And here is how you access it in GUI script:
set "gui::persistent_killed_berny" "1";
if ("gui::persistent_killed_berny" == 0) { ... }

You can add a custom checkbox in GUI briefing, and then customize the game depending on whether the player enabled it or not.
Or you can implement game script functions <tt>on_mission_complete</tt> and <tt>on_mission_failed</tt> and save some info about game state in order to customize debriefing.
This feature can be useful for single missions as well.

= Inventory Items =
The player's inventory contains all the keys, tools, lockpicks, lantern as well as all the weapons. The mapper can define which of these should be kept when proceeding to the next mission. Items that are allowed to be kept are called "persistent", and the corresponding spawnarg controlling that property is called "inv_persistent".

== Tools & Items ==
By default regular inventory items are not marked as persistent, i.e. the inv_persistent key is set to "0". Once the mapper flips that spawnarg to "1" the item will be kept throughout the following missions. The item will be kept until the end of the whole campaign, unless:
* the player drops the item
* it is removed from the inventory by script or other events
* a rule on the atdm:campaign_info entity is forcing the item to be removed after "Mission Complete" (see below).

Even though TDM 2.02+ will resolve naming conflicts across maps, map authors should try to make sure that persistent items have unique names. For example, if the first map has a persistent item named "My Water Bottle", none of the subsequent maps should have an item named "My Water Bottle". If you must have a second water bottle, name it "My Second Water Bottle", or something along those lines.

If you have a persistent stackable item in map N, and you don't consume it in that map, and you have another instance of the same stackable item in map N+1 (whether it's marked 'persistent' or not), when you pick it up, it will be added to the stack count of map N's item and become persistent.

== Weapons & Arrows ==
All weapon inventory items are persistent by default including their ammo, so without further action the player will keep all his weapons and all the arrows when proceeding to the next mission. However it's possible to define ammo limits on the atdm:campaign_info entity, which is described below.

Important: it's not advisable to mess with the inv_persistent spawnarg on weapon items - it's recommended to leave that spawnarg at the default value and control the carry-over by the rules on the campaign info entity.

== Inventory Item and Weapon Limits ==
An [[atdm:campaign_info]] entity can be placed in a map to control which items make it to the next mission (and their amount) - and which should be dropped. The rules defined on the [[atdm:campaign_info]] entity will be enforced after the "Mission Complete" event, when the map is still active, i.e. it's "filtering" outgoing items. Each map can have its own campaign info entity to define its own set of rules.

Please refer to the main [[atdm:campaign_info]] article to get precise info on how to set up these rules.

= Loot Limits =
Special handling is possible for the amount of loot that is carried over and usable in the shop of the next mission. These so-called "loot carry-over" rules are defined on the shop entity of the respective map, e.g. the shop entity in Mission B will define the loot carry-over roles applicable to the loot collected in Mission A.

Refer to the [[Shop#Limiting_the_Loot_from_previous_Missions|Shop]] article for further reference.

{{editing}}
[[Category:Campaigns]]

Xrays in GUIs

2025-12-17T11:37:35Z

Datiswous: /* The scriptobject */

== Xrays in GUIs ==

Xray materials can be part of GUI overlays. This page will describe how the "xray glasses" mentioned in the main [[Xrays]] article were created.

== Creating the GUI ==

=== The image ===

GUI overlays should be 1024x1024 square images with an alpha channel, saved as either:
* .tga without RLE compression or
* .dds with DXT5 compression and generating mipmaps.

The GUI will be designed to apply the xray effect only to transparent parts of the overlay image. If you have artistic details like dirt smudges, it may be useful to also create a clean version of the image for purposes of cleanly restricting the xray effect, like below:

[[File:Glasses overlay.jpg|450px]]
{{clear}}

=== The material ===

The next step is to make a material that uses these images. This is what "xray_glasses_overlay_mixed_warped" from the core assets looks like:

xray_glasses_overlay_mixed_warped
{
description "Xray GUI overlay for glasses that shows both the normal and xray models transparently. No xray vision through opaque obstacles. Has blurred effect."

noshadows
nonsolid

{
blend GL_SRC_ALPHA, GL_ZERO
map makealpha(guis/assets/hud/glasses_overlay)
maskcolor
alpha 0.7
}

{
blend GL_DST_ALPHA, GL_ONE_MINUS_DST_ALPHA
xrayRenderMap inclusive
program heatHazeWithMask.vfp
vertexParm 0 time * 0.008 , time * 0.005 // texture scrolling
vertexParm 1 0.02 // magnitude of the distortion
fragmentMap 0 _xray
fragmentMap 1 textures/sfx/vp1 // the normal map for distortion
fragmentMap 2 guis/assets/hud/glasses_overlay // the distortion blend map
}
}

This material has the following features:
* The first block creates an alpha mask from the white parts of the glasses overlay image. This allows to restrict the xray vision effect to only the central parts of the overlay image, while the black parts of the overlay image will still show normal vision.
* The line "alpha 0.7" determines how opaque the xray vision should be. If a value less than 1, xray models would appear transparent. At values greater than 1, they would appear unnaturally bright.
* The first 2 lines of the second block apply the xray effect to the areas defined by the abovementioned alpha mask.
* All later lines in the second block are optional, applying a heat haze warp to the xray image. The speed of the warp effect can be modified with the "vertexParm0" line, while the strength of the distortion effect can be adjusted with the "vertexParm1" line.

=== The GUI ===

Lastly, create a gui/playertools folder in your FM, add a text file with the intended name of your GUI and change its extension to .gui (in this case: xray_glasses.gui). Then add the following contents to it:

windowDef Desktop
{
rect 0, 0, 640, 480
nocursor 1
background "gui_backdrop_semiopaque"

windowDef SquareFit
{
forceScreenAspect
hcenter
rect 0, 0, 480, 480
background "xray_glasses_overlay_mixed_warped"
}
}

This GUI has the following features:
* it uses a background material called "gui_backdrop_semiopaque" from the core assets, which is simply a pure black image at half transparency. This fills out any space on the screen that's not covered by the overlay image itself. Alternatives would be to delete this line for no background or to use "gui_backdrop_opaque".
* next comes a square window which will contain the overlay material, "xray_glasses_overlay_mixed_warped", which should consist of a square 1024x1024 image with an alpha channel. The keywords "forceScreenAspect" and "hcenter" will stretch the image to match the player's resolution settings.
* the 2nd "rect" line allows to adjust the overlay image. The first 2 numbers control its horizontal/vertical position on the screen, while the 2nd numbers control its horizontal/vertical scale.

The GUI is now ready to use. The most suitable way would be to create and destroy it from within the scriptobject of a "glasses" inventory item.

== The inventory item ==

To make an "xray glasses" inventory item, an entity definition and a scriptobject are needed. The aim is to be able to press the "use" key (default: enter) while it's selected in the inventory to create or destroy the GUI overlay.

=== The def ===

The def should inherit from the "atdm:playertool" and point to a custom scriptobject to be made later on. Apart from that it needs a suitable model and inventory icon.

entityDef atdm:xray_glasses
{
"inherit" "atdm:playertool"

"editor_usage" "X-Ray glasses"
"editor_displayFolder" "playertools"

"model" "models/darkmod/wearables/headgear/spectacles.ase"
"scriptobject" "playertools_xray_glasses"

"gui" "guis/playertools/xray_glasses.gui"

"inv_name" "X-Ray Glasses"

"inv_icon" "guis/assets/hud/inventory_icons/spectacles"
"inv_droppable" "1"
"snd_bounce" "tdm_impact_knife_large"
"snd_bounce_wood" "tdm_impact_knife_large"
}

=== The scriptobject ===

See below for the "xray glasses" scriptobject:

#ifndef __XRAY_GLASSES__
#define __XRAY_GLASSES__

float wearing_xray_glasses;

object playertools_xray_glasses : player_tools
{
void init();
void inventoryUse(entity userEntity, entity frobbedEntity, float buttonState);

float overlayHandle;
};

void playertools_xray_glasses::init()
{
}

void playertools_xray_glasses::inventoryUse(entity userEntity, entity frobbedEntity, float buttonState)
{
if ( !wearing_xray_glasses )
{
wearing_xray_glasses = true;
overlayHandle = $player1.createOverlay(getKey("gui"), ZOOM_GUI_LAYER);
sys.fadeIn('0 0 0', 1);
}

else
{
wearing_xray_glasses = false;
$player1.destroyOverlay(overlayHandle);
sys.fadeIn('0 0 0', 1);
}
}

#endif //__XRAY_GLASSES__

(In '''TDM 2.14''' in the above codeblock code <code>$player1.createOverlay(getKey("gui")</code> should be replaced with <code>$player1.create'''Xray'''Overlay(getKey("gui")</code>. Above codeblock is for TDM 2.10-2.13 )

It has the following features:
* First off, it creates a global variable called "wearing_xray_glasses". Since it's global, other scripts will be able to tell whether the player currently has xray glasses on. This may come in useful for you, depending on what you want to do with xrays in your map.
* The scriptobject itself is fairly barebones: all it needs is a function "inventoryUse" - called whenever the player presses the "use" key with it selected.
* The "inventoryUse" function checks for whether the "wearing_xray_glasses" variable is true. Depending on the result, it chooses to either create or destroy the xray overlay and updates the variable. You may want to add more to these 2 blocks, such as changing the frobability or solidity of certain entities.
* Since models can pop a little when they're loaded in by the xray system, the scriptobject has a short 1s fade from black to hide the transition.

== See also ==

[[Xrays]]: Main article describing the xray feature.

{{GUI}}
[[Category:Tutorial]]

Xrays in GUIs

2025-12-17T11:37:04Z

Datiswous: /* The scriptobject */

== Xrays in GUIs ==

Xray materials can be part of GUI overlays. This page will describe how the "xray glasses" mentioned in the main [[Xrays]] article were created.

== Creating the GUI ==

=== The image ===

GUI overlays should be 1024x1024 square images with an alpha channel, saved as either:
* .tga without RLE compression or
* .dds with DXT5 compression and generating mipmaps.

The GUI will be designed to apply the xray effect only to transparent parts of the overlay image. If you have artistic details like dirt smudges, it may be useful to also create a clean version of the image for purposes of cleanly restricting the xray effect, like below:

[[File:Glasses overlay.jpg|450px]]
{{clear}}

=== The material ===

The next step is to make a material that uses these images. This is what "xray_glasses_overlay_mixed_warped" from the core assets looks like:

xray_glasses_overlay_mixed_warped
{
description "Xray GUI overlay for glasses that shows both the normal and xray models transparently. No xray vision through opaque obstacles. Has blurred effect."

noshadows
nonsolid

{
blend GL_SRC_ALPHA, GL_ZERO
map makealpha(guis/assets/hud/glasses_overlay)
maskcolor
alpha 0.7
}

{
blend GL_DST_ALPHA, GL_ONE_MINUS_DST_ALPHA
xrayRenderMap inclusive
program heatHazeWithMask.vfp
vertexParm 0 time * 0.008 , time * 0.005 // texture scrolling
vertexParm 1 0.02 // magnitude of the distortion
fragmentMap 0 _xray
fragmentMap 1 textures/sfx/vp1 // the normal map for distortion
fragmentMap 2 guis/assets/hud/glasses_overlay // the distortion blend map
}
}

This material has the following features:
* The first block creates an alpha mask from the white parts of the glasses overlay image. This allows to restrict the xray vision effect to only the central parts of the overlay image, while the black parts of the overlay image will still show normal vision.
* The line "alpha 0.7" determines how opaque the xray vision should be. If a value less than 1, xray models would appear transparent. At values greater than 1, they would appear unnaturally bright.
* The first 2 lines of the second block apply the xray effect to the areas defined by the abovementioned alpha mask.
* All later lines in the second block are optional, applying a heat haze warp to the xray image. The speed of the warp effect can be modified with the "vertexParm0" line, while the strength of the distortion effect can be adjusted with the "vertexParm1" line.

=== The GUI ===

Lastly, create a gui/playertools folder in your FM, add a text file with the intended name of your GUI and change its extension to .gui (in this case: xray_glasses.gui). Then add the following contents to it:

windowDef Desktop
{
rect 0, 0, 640, 480
nocursor 1
background "gui_backdrop_semiopaque"

windowDef SquareFit
{
forceScreenAspect
hcenter
rect 0, 0, 480, 480
background "xray_glasses_overlay_mixed_warped"
}
}

This GUI has the following features:
* it uses a background material called "gui_backdrop_semiopaque" from the core assets, which is simply a pure black image at half transparency. This fills out any space on the screen that's not covered by the overlay image itself. Alternatives would be to delete this line for no background or to use "gui_backdrop_opaque".
* next comes a square window which will contain the overlay material, "xray_glasses_overlay_mixed_warped", which should consist of a square 1024x1024 image with an alpha channel. The keywords "forceScreenAspect" and "hcenter" will stretch the image to match the player's resolution settings.
* the 2nd "rect" line allows to adjust the overlay image. The first 2 numbers control its horizontal/vertical position on the screen, while the 2nd numbers control its horizontal/vertical scale.

The GUI is now ready to use. The most suitable way would be to create and destroy it from within the scriptobject of a "glasses" inventory item.

== The inventory item ==

To make an "xray glasses" inventory item, an entity definition and a scriptobject are needed. The aim is to be able to press the "use" key (default: enter) while it's selected in the inventory to create or destroy the GUI overlay.

=== The def ===

The def should inherit from the "atdm:playertool" and point to a custom scriptobject to be made later on. Apart from that it needs a suitable model and inventory icon.

entityDef atdm:xray_glasses
{
"inherit" "atdm:playertool"

"editor_usage" "X-Ray glasses"
"editor_displayFolder" "playertools"

"model" "models/darkmod/wearables/headgear/spectacles.ase"
"scriptobject" "playertools_xray_glasses"

"gui" "guis/playertools/xray_glasses.gui"

"inv_name" "X-Ray Glasses"

"inv_icon" "guis/assets/hud/inventory_icons/spectacles"
"inv_droppable" "1"
"snd_bounce" "tdm_impact_knife_large"
"snd_bounce_wood" "tdm_impact_knife_large"
}

=== The scriptobject ===

See below for the "xray glasses" scriptobject:

#ifndef __XRAY_GLASSES__
#define __XRAY_GLASSES__

float wearing_xray_glasses;

object playertools_xray_glasses : player_tools
{
void init();
void inventoryUse(entity userEntity, entity frobbedEntity, float buttonState);

float overlayHandle;
};

void playertools_xray_glasses::init()
{
}

void playertools_xray_glasses::inventoryUse(entity userEntity, entity frobbedEntity, float buttonState)
{
if ( !wearing_xray_glasses )
{
wearing_xray_glasses = true;
overlayHandle = $player1.createOverlay(getKey("gui"), ZOOM_GUI_LAYER);
sys.fadeIn('0 0 0', 1);
}

else
{
wearing_xray_glasses = false;
$player1.destroyOverlay(overlayHandle);
sys.fadeIn('0 0 0', 1);
}
}

#endif //__XRAY_GLASSES__

In '''TDM 2.14''' in the above codeblock code <code>$player1.createOverlay(getKey("gui")</code> should be replaced with <code>$player1.create'''Xray'''Overlay(getKey("gui")</code>. Above codeblock is for TDM 2.10-2.13 .

It has the following features:
* First off, it creates a global variable called "wearing_xray_glasses". Since it's global, other scripts will be able to tell whether the player currently has xray glasses on. This may come in useful for you, depending on what you want to do with xrays in your map.
* The scriptobject itself is fairly barebones: all it needs is a function "inventoryUse" - called whenever the player presses the "use" key with it selected.
* The "inventoryUse" function checks for whether the "wearing_xray_glasses" variable is true. Depending on the result, it chooses to either create or destroy the xray overlay and updates the variable. You may want to add more to these 2 blocks, such as changing the frobability or solidity of certain entities.
* Since models can pop a little when they're loaded in by the xray system, the scriptobject has a short 1s fade from black to hide the transition.

== See also ==

[[Xrays]]: Main article describing the xray feature.

{{GUI}}
[[Category:Tutorial]]

Xrays in GUIs

2025-12-17T11:36:40Z

Datiswous: /* The scriptobject */ added 2.14 info about code createXrayOverlay

== Xrays in GUIs ==

Xray materials can be part of GUI overlays. This page will describe how the "xray glasses" mentioned in the main [[Xrays]] article were created.

== Creating the GUI ==

=== The image ===

GUI overlays should be 1024x1024 square images with an alpha channel, saved as either:
* .tga without RLE compression or
* .dds with DXT5 compression and generating mipmaps.

The GUI will be designed to apply the xray effect only to transparent parts of the overlay image. If you have artistic details like dirt smudges, it may be useful to also create a clean version of the image for purposes of cleanly restricting the xray effect, like below:

[[File:Glasses overlay.jpg|450px]]
{{clear}}

=== The material ===

The next step is to make a material that uses these images. This is what "xray_glasses_overlay_mixed_warped" from the core assets looks like:

xray_glasses_overlay_mixed_warped
{
description "Xray GUI overlay for glasses that shows both the normal and xray models transparently. No xray vision through opaque obstacles. Has blurred effect."

noshadows
nonsolid

{
blend GL_SRC_ALPHA, GL_ZERO
map makealpha(guis/assets/hud/glasses_overlay)
maskcolor
alpha 0.7
}

{
blend GL_DST_ALPHA, GL_ONE_MINUS_DST_ALPHA
xrayRenderMap inclusive
program heatHazeWithMask.vfp
vertexParm 0 time * 0.008 , time * 0.005 // texture scrolling
vertexParm 1 0.02 // magnitude of the distortion
fragmentMap 0 _xray
fragmentMap 1 textures/sfx/vp1 // the normal map for distortion
fragmentMap 2 guis/assets/hud/glasses_overlay // the distortion blend map
}
}

This material has the following features:
* The first block creates an alpha mask from the white parts of the glasses overlay image. This allows to restrict the xray vision effect to only the central parts of the overlay image, while the black parts of the overlay image will still show normal vision.
* The line "alpha 0.7" determines how opaque the xray vision should be. If a value less than 1, xray models would appear transparent. At values greater than 1, they would appear unnaturally bright.
* The first 2 lines of the second block apply the xray effect to the areas defined by the abovementioned alpha mask.
* All later lines in the second block are optional, applying a heat haze warp to the xray image. The speed of the warp effect can be modified with the "vertexParm0" line, while the strength of the distortion effect can be adjusted with the "vertexParm1" line.

=== The GUI ===

Lastly, create a gui/playertools folder in your FM, add a text file with the intended name of your GUI and change its extension to .gui (in this case: xray_glasses.gui). Then add the following contents to it:

windowDef Desktop
{
rect 0, 0, 640, 480
nocursor 1
background "gui_backdrop_semiopaque"

windowDef SquareFit
{
forceScreenAspect
hcenter
rect 0, 0, 480, 480
background "xray_glasses_overlay_mixed_warped"
}
}

This GUI has the following features:
* it uses a background material called "gui_backdrop_semiopaque" from the core assets, which is simply a pure black image at half transparency. This fills out any space on the screen that's not covered by the overlay image itself. Alternatives would be to delete this line for no background or to use "gui_backdrop_opaque".
* next comes a square window which will contain the overlay material, "xray_glasses_overlay_mixed_warped", which should consist of a square 1024x1024 image with an alpha channel. The keywords "forceScreenAspect" and "hcenter" will stretch the image to match the player's resolution settings.
* the 2nd "rect" line allows to adjust the overlay image. The first 2 numbers control its horizontal/vertical position on the screen, while the 2nd numbers control its horizontal/vertical scale.

The GUI is now ready to use. The most suitable way would be to create and destroy it from within the scriptobject of a "glasses" inventory item.

== The inventory item ==

To make an "xray glasses" inventory item, an entity definition and a scriptobject are needed. The aim is to be able to press the "use" key (default: enter) while it's selected in the inventory to create or destroy the GUI overlay.

=== The def ===

The def should inherit from the "atdm:playertool" and point to a custom scriptobject to be made later on. Apart from that it needs a suitable model and inventory icon.

entityDef atdm:xray_glasses
{
"inherit" "atdm:playertool"

"editor_usage" "X-Ray glasses"
"editor_displayFolder" "playertools"

"model" "models/darkmod/wearables/headgear/spectacles.ase"
"scriptobject" "playertools_xray_glasses"

"gui" "guis/playertools/xray_glasses.gui"

"inv_name" "X-Ray Glasses"

"inv_icon" "guis/assets/hud/inventory_icons/spectacles"
"inv_droppable" "1"
"snd_bounce" "tdm_impact_knife_large"
"snd_bounce_wood" "tdm_impact_knife_large"
}

=== The scriptobject ===

See below for the "xray glasses" scriptobject:

#ifndef __XRAY_GLASSES__
#define __XRAY_GLASSES__

float wearing_xray_glasses;

object playertools_xray_glasses : player_tools
{
void init();
void inventoryUse(entity userEntity, entity frobbedEntity, float buttonState);

float overlayHandle;
};

void playertools_xray_glasses::init()
{
}

void playertools_xray_glasses::inventoryUse(entity userEntity, entity frobbedEntity, float buttonState)
{
if ( !wearing_xray_glasses )
{
wearing_xray_glasses = true;
overlayHandle = $player1.createOverlay(getKey("gui"), ZOOM_GUI_LAYER);
sys.fadeIn('0 0 0', 1);
}

else
{
wearing_xray_glasses = false;
$player1.destroyOverlay(overlayHandle);
sys.fadeIn('0 0 0', 1);
}
}

#endif //__XRAY_GLASSES__

In '''TDM 2.14''' in the above codeblock code <code>$player1.createOverlay(getKey("gui")</code> should be replaced with <code>$player1.create'''Xray'''Overlay(getKey("gui")</code>. Above codeblock is for TDM 2.10-2.13 .

It has the following features:
* First off, it creates a global variable called "wearing_xray_glasses". Since it's global, other scripts will be able to tell whether the player currently has xray glasses on. This may come in useful for you, depending on what you want to do with xrays in your map.
* The scriptobject itself is fairly barebones: all it needs is a function "inventoryUse" - called whenever the player presses the "use" key with it selected.
* The "inventoryUse" function checks for whether the "wearing_xray_glasses" variable is true. Depending on the result, it chooses to either create or destroy the xray overlay and updates the variable. You may want to add more to these 2 blocks, such as changing the frobability or solidity of certain entities.
* Since models can pop a little when they're loaded in by the xray system, the scriptobject has a short 1s fade from black to hide the transition.

== See also ==

[[Xrays]]: Main article describing the xray feature.

{{GUI}}
[[Category:Tutorial]]

Fan Mission Series

2025-12-12T11:18:03Z

Datiswous: /* Volta series */ added Volta 3

This article serves as an overview of the known existing FM series.

Over the years, ''The Dark Mod'' has accumulated a number of Fan Missions that form a larger interconnected series or an overarching/continuing narrative. Many series are connected by their main characters, some by other FM inter-related elements.

The FMs of each series are sorted in chronological order.

The number of each FM includes a link to its page on the official website.

The name of each FM includes a link to its page on the official TDM wiki.

Beware of potential (minor) spoilers behind the character links.

== Official campaigns ==

While all TDM missions are technically Fan Missions, the ones belonging to these official campaigns are as close as TDM will ever get to its own official in-game missions, or in-game story campaigns. These core missions for the base game are in slow and patient continuous development (due to TDM being a hobbyist project of a fan community), and have been gradually added to the base game over the course of several years.

For additional series by TDM authors, please see the next section.

=== Introduction campaign ===

The missions of this campaign serve as a gradual introduction into the setting and gameplay of ''The Dark Mod''. The missions are shorter and fairly easy, and gradually put the player's newly acquired skills to the test.

Currently, this is the only series that is bundled directly as part of the base game. By installing TDM, the first three missions available to you will be part of this official mini-campaign.

'''Series' characters:''' [[Thief Characters#Corbin|Corbin]] (protagonist), Paschal Murnerus, Moorish adventurers (background)

'''Series' status:''' In development, but currently on hiatus. 3 missions currently available, including the (generally plotless) training mission.

{|class="wikitable sortable" border=1 style="border-collapse: collapse;" cellspacing=0 cellpadding=2 width=100%
|-
!bgcolor=#d0d0e0 width="1%"|No.
!bgcolor=#d0d0e0 width="21%"|Fan Mission Title
!bgcolor=#d0d0e0 width="11%"|Author(s)
!bgcolor=#d0d0e0 width="4%" class="unsortable"|Forum link
!bgcolor=#d0d0e0 width="5%"|Releases
!bgcolor=#d0d0e0 width="5%"|Mission Type
!bgcolor=#d0d0e0 width="5%"|Notes
|-

|-
|0
!align=left|[[Training Mission (OM)|Training mission]]
|TDM dev team
|{{Forumlink|http://forums.thedarkmod.com/topic/9932-fan-mission-training-mission-20091017/}}
|2009-10-17 (original version)
|Training <br> Jumping/Platforming
|Unique. The official tutorial mission of TDM, with open-ended gameplay.
|-
|-
|1
!align=left|[[A New Job (OM)|A New Job]]
|Springheel
|{{Forumlink|http://forums.thedarkmod.com/topic/18647-tdm-205-official-introductory-missions/}}
|2017-03-14
|City Missions <br> Inn/Tavern
|
|-
|-
|2
!align=left|[[The Tears of Saint Lucia (OM)|The Tears of Saint Lucia]]
|TDM dev team
|{{Forumlink|http://forums.thedarkmod.com/topic/10579-fan-mission-the-tears-of-st-lucia-20081021/}} (original version), {{Forumlink|http://forums.thedarkmod.com/topic/18647-tdm-205-official-introductory-missions/}} (current version)
|2008-10-21 (original version), 2017-02-14 (current version, 3.0)
|Church/Cathedral
|[https://www.youtube.com/watch?v=yrGxoi3LSGg Briefing] <br> ''{{TDM-FM|15|standalone release link}}''
|-
|}

== Individual authors' series ==

The majority of missions created for ''The Dark Mod''. For the sake of easier searching, these FM series are arranged in alphabetical order, based on their titles. In terms of release, a Single-mission (S) series consists of several single-mission FM releases over time (the commonest sort), while a Campaign (C) series is an FM containing a storyline consisting of several missions.

=== ''The Accountant'' series ===

* '''Release:''' Single-mission (S)
* '''Series' characters:''' [[Thief_Characters#Corbin|Corbin]] (protagonist)
* '''Series' status:''' Currently on hold.

{|class="wikitable sortable" border=1 style="border-collapse: collapse;" cellspacing=0 cellpadding=2 width=100%
|-
!bgcolor=#d0d0e0 width="1%"|No.
!bgcolor=#d0d0e0 width="21%"|Fan Mission Title
!bgcolor=#d0d0e0 width="11%"|Author(s)
!bgcolor=#d0d0e0 width="4%" class="unsortable"|Forum link
!bgcolor=#d0d0e0 width="5%"|Releases
!bgcolor=#d0d0e0 width="5%"|Mission Type
!bgcolor=#d0d0e0 width="5%"|Notes
|-

|-
|{{TDM-FM|ac1|1}}
!align=left|[[The Accountant 1: Thieves and Heirs (FM)|The Accountant 1: Thieves and Heirs]]
|[[:Category:Missions by Goldwell|Goldwell]]
|{{Forumlink|http://forums.thedarkmod.com/topic/19164-fan-mission-the-accountant-1-thieves-and-heirs-by-goldwell-20171108/}}
|2017-11-08
|Mansion/Estate
|[https://www.youtube.com/watch?v=Tk9DtOT4kjc Briefing]
|-

|-
|{{TDM-FM|ac2|2}}
!align=left|[[The Accountant 2: New in Town (FM)|The Accountant 2: New in Town]]
|[[:Category:Missions by Goldwell|Goldwell]]
|{{Forumlink|http://forums.thedarkmod.com/topic/18054-fan-mission-the-accountant-2-new-in-town-by-goldwell-20160509/}}
|2016-05-08
|Mansion/Estate
|[https://www.youtube.com/watch?v=xeuIO_GcYjQ Briefing] <br> [https://www.youtube.com/watch?v=w6e_SJ0_JOM Gameplay trailer]
|-
|}

=== ''Away'' series ===

* '''Release:''' Single-mission (S)
* '''Series' characters:'''
* '''Series' status:''' Currently on hold. Planned to continue.

{|class="wikitable sortable" border=1 style="border-collapse: collapse;" cellspacing=0 cellpadding=2 width=100%
|-
!bgcolor=#d0d0e0 width="1%"|No.
!bgcolor=#d0d0e0 width="21%"|Fan Mission Title
!bgcolor=#d0d0e0 width="11%"|Author(s)
!bgcolor=#d0d0e0 width="4%" class="unsortable"|Forum link
!bgcolor=#d0d0e0 width="5%"|Releases
!bgcolor=#d0d0e0 width="5%"|Mission Type
!bgcolor=#d0d0e0 width="5%"|Notes
|-
|{{TDM-FM|away0|0}}
!align=left|[[Away 0: Stolen Heart (FM)|Away 0: Stolen Heart]]
|[[:Category:Missions by Geep|Geep]]
|{{Forumlink|https://forums.thedarkmod.com/index.php?/topic/20964-away-0-stolen-heart-by-geep-_atti_-20211112/}}
|2021-11-12
|Inn/Tavern, Jail/Prison, Museum Heist, Bank Job
|
|-
|{{TDM-FM|airpocket|1}}
!align=left|[[Away 1: Air Pocket (FM)|Away 1: Air Pocket]]
|[[:Category:Missions by Geep|Geep]]
|{{Forumlink|https://forums.thedarkmod.com/index.php?/topic/20252-fan-mission-away-1-air-pocket-by-geep-20200207/}}
|2020-02-06
|Pirate/Ship
|
|-
|}

=== ''Chronicles of Skulduggery'' series ===

* '''Release:''' Single-mission (S)
* '''Series' characters:''' [[Thief_Characters#Elyas_Thorne|Elyas Thorne]] (protagonist)
* '''Series' status:''' TBA

{|class="wikitable sortable" border=1 style="border-collapse: collapse;" cellspacing=0 cellpadding=2 width=100%
|-
!bgcolor=#d0d0e0 width="1%"|No.
!bgcolor=#d0d0e0 width="21%"|Fan Mission Title
!bgcolor=#d0d0e0 width="11%"|Author(s)
!bgcolor=#d0d0e0 width="4%" class="unsortable"|Forum link
!bgcolor=#d0d0e0 width="5%"|Releases
!bgcolor=#d0d0e0 width="5%"|Mission Type
!bgcolor=#d0d0e0 width="5%"|Notes
|-

|-
|{{TDM-FM|cos0_thief|0}}
!align=left|[[Chronicles of Skulduggery 0: To Catch a Thief (FM)|To Catch a Thief]]
|[[:Category:Missions by Bienie|Bienie]]
|{{Forumlink|https://forums.thedarkmod.com/index.php?/topic/21156-fan-mission-chronicles-of-skulduggery-0-to-catch-a-thief-20211120/}}
|2021-11-20
|City Missions Mansion/Estate
|
|-
|-
|{{TDM-FM|127|1}}
!align=left|[[Chronicles of Skulduggery 1: Pearls and Swine (FM)|Pearls and Swine]]
|[[:Category:Missions by Bienie|Bienie]]
|{{Forumlink|https://forums.thedarkmod.com/topic/19439-chronicles-of-skulduggery-pearls-and-swine/}}
|2018-05-25
|City Missions
|
|-
|-
|{{TDM-FM|137|2}}
!align=left|[[Chronicles of Skulduggery 2: A Precarious Position (FM)|A Precarious Position]]
|[[:Category:Missions by Bienie|Bienie]]
|{{Forumlink|https://forums.thedarkmod.com/topic/19975-fan-mission-chronicles-of-skulduggery-2-a-precarious-position-20190504/}}
|2019-05-03
|City Missions
|
|-
|-
|{{TDM-FM|149|3}}
!align=left|[[Chronicles of Skulduggery 3: Sacricide (FM)|Sacricide]]
|[[:Category:Missions by Bienie|Bienie]]
|{{Forumlink|https://forums.thedarkmod.com/index.php?/topic/20483-fan-mission-chronicles-of-skulduggery-3-sacricide-20200718/}}
|2020-07-18
|City Missions
|
|-
|}

=== ''Corbin'' series ===

* '''Release:''' Single-mission (S)
* '''Series' characters:''' [[Thief_Characters#Corbin|Corbin]] (protagonist), cardinal Laurenti (background), Keshka brotherhood members (antagonists)
* '''Series' status:''' TBA

{|class="wikitable sortable" border=1 style="border-collapse: collapse;" cellspacing=0 cellpadding=2 width=100%
|-
!bgcolor=#d0d0e0 width="1%"|No.
!bgcolor=#d0d0e0 width="21%"|Fan Mission Title
!bgcolor=#d0d0e0 width="11%"|Author(s)
!bgcolor=#d0d0e0 width="4%" class="unsortable"|Forum link
!bgcolor=#d0d0e0 width="5%"|Releases
!bgcolor=#d0d0e0 width="5%"|Mission Type
!bgcolor=#d0d0e0 width="5%"|Notes
|-

|-
|{{TDM-FM|builders_influence|1}}
!align=left|[[The Builder's Influence (FM)|The Builder's Influence]]
|[[:Category:Missions by RailGun|RailGun]], [[:Category:Missions by Springheel|Springheel]]
|{{Forumlink|http://forums.thedarkmod.com/topic/10811-fan-mission-the-builders-influence-20100320/}}
|2010-03-20 (original version), 2010-03-23 (version 2.0)
|Castle/Fortress
|
|-
|-
|{{TDM-FM|score_to_settle|2}}
!align=left|[[A Score to Settle (FM)|A Score to Settle]]
|[[:Category:Missions by Springheel|Springheel]]
|{{Forumlink|http://forums.thedarkmod.com/topic/12894-fan-mission-48-a-score-to-settle-by-springheel-20110701/}}
|2011-07-01
|City Missions
|
|-
|-
|{{TDM-FM|follow|3}}
!align=left|[[A Reputation to Uphold (FM)|A Reputation to Uphold]]
|[[:Category:Missions by Springheel|Springheel]]
|{{Forumlink|http://forums.thedarkmod.com/topic/16204-fan-mission-a-reputation-to-uphold-by-springheel/}}
|2014-04-18
|City Missions
|
|-
|-
|{{TDM-FM|matterofhours|4}}
!align=left|[[A Matter of Hours (FM)|A Matter of Hours]]
|[[:Category:Missions by Springheel|Springheel]]
|{{Forumlink|http://forums.thedarkmod.com/topic/18809-fan-mission-a-matter-of-hours-by-springheel-2842017/}}
|2017-04-28
|Warehouse
|
|-
|}

=== ''Crucible of Omens'' series ===

* '''Description:''' Though originally planned as a major campaign for future releases of TDM, development progress has been halted.
* '''Release:''' Released as Single-mission (S), possibly would have been a Campaign (C) if finished.
* '''Series' status:''' Development halted, campaign apparently cancelled. Only 1 mission has been completed and made available.

{|class="wikitable sortable" border=1 style="border-collapse: collapse;" cellspacing=0 cellpadding=2 width=100%
|-
!bgcolor=#d0d0e0 width="1%"|No.
!bgcolor=#d0d0e0 width="21%"|Fan Mission Title
!bgcolor=#d0d0e0 width="11%"|Author(s)
!bgcolor=#d0d0e0 width="4%" class="unsortable"|Forum link
!bgcolor=#d0d0e0 width="5%"|Releases
!bgcolor=#d0d0e0 width="5%"|Mission Type
!bgcolor=#d0d0e0 width="5%"|Notes
|-

|-
|{{TDM-FM|bcd|1}}
!align=left|[[Crucible of Omens: Behind Closed Doors (FM)|Crucible of Omens: Behind Closed Doors]]
|[[:Category:Missions by Bikerdude|Bikerdude]], Crucible of Omens Team
|{{Forumlink|http://forums.thedarkmod.com/topic/17627-crucible-of-omens-behind-closed-doors-by-bikerdude-the-crucible-team-updated-18122015/}}
|2015-12-19
|City Missions
|-
|}

=== ''Duncan Lynch'' series ===

* '''Release:''' Single-mission (S)
* '''Series' characters:''' [[Thief_Characters#Duncan_Lynch|Duncan Lynch]] (protagonist)
* '''Series' status:''' TBA

{|class="wikitable sortable" border=1 style="border-collapse: collapse;" cellspacing=0 cellpadding=2 width=100%
|-
!bgcolor=#d0d0e0 width="1%"|No.
!bgcolor=#d0d0e0 width="21%"|Fan Mission Title
!bgcolor=#d0d0e0 width="11%"|Author(s)
!bgcolor=#d0d0e0 width="4%" class="unsortable"|Forum link
!bgcolor=#d0d0e0 width="5%"|Releases
!bgcolor=#d0d0e0 width="5%"|Mission Type
!bgcolor=#d0d0e0 width="5%"|Notes
|-

|-
|{{TDM-FM|factoryheist|1}}
!align=left|[[The Factory Heist (FM)|The Factory Heist]]
|[[:Category:Missions by thebigh|thebigh]]
|{{Forumlink|https://forums.thedarkmod.com/index.php?/topic/20562-the-factory-heist-12-sep-2020/}}
|2020-09-12
|Warehouse
|
|-
|-
|{{TDM-FM|housecall|2}}
!align=left|[[A House Call (FM)|A House Call]]
|[[:Category:Missions by thebigh|thebigh]]
|{{Forumlink|https://forums.thedarkmod.com/index.php?/topic/21329-a-house-call-by-thebigh-mar-10-2022/}}
|2022-03-10
|Mansion/Estate
|
|-
|-
|{{TDM-FM|delisle|3}}
!align=left|[[The House of deLisle (FM)|The House of deLisle]]
|[[:Category:Missions by thebigh|thebigh]]
|{{Forumlink|https://forums.thedarkmod.com/index.php?/topic/22227-fan-mission-the-house-of-delisle/}}
|2023-10-01
|Mansion/Estate, City Missions
|
|-
|}

=== ''The Hare in the Snare'' series ===

* '''Release:''' Single-mission (S)
* '''Series' characters:'''
* '''Series' status:''' Planned to continue.

{|class="wikitable sortable" border=1 style="border-collapse: collapse;" cellspacing=0 cellpadding=2 width=100%
|-
!bgcolor=#d0d0e0 width="1%"|No.
!bgcolor=#d0d0e0 width="21%"|Fan Mission Title
!bgcolor=#d0d0e0 width="11%"|Author(s)
!bgcolor=#d0d0e0 width="4%" class="unsortable"|Forum link
!bgcolor=#d0d0e0 width="5%"|Releases
!bgcolor=#d0d0e0 width="5%"|Mission Type
!bgcolor=#d0d0e0 width="5%"|Notes
|-

|-
|{{TDM-FM|hareinthesnare|1}}
!align=left|[[The Hare in the Snare: Part 1 (FM)|The Hare in the Snare: Part 1]]
|[[:Category:Missions by Frost_Salamander|Frost_Salamander]] & [[:Category:Missions by Kerry000|Kerry000]]
|{{Forumlink|https://forums.thedarkmod.com/index.php?/topic/20883-fan-mission-the-hare-in-the-snare-part-1}}
|2021-04-09
|City Missions <br> Inn/Tavern
|
|-
|}

=== ''Hidden Hands'' series ===

* '''Release:''' Single-mission (S)
* '''Series' characters:''' TBA
* '''Series' status:''' TBA

{|class="wikitable sortable" border=1 style="border-collapse: collapse;" cellspacing=0 cellpadding=2 width=100%
|-
!bgcolor=#d0d0e0 width="1%"|No.
!bgcolor=#d0d0e0 width="21%"|Fan Mission Title
!bgcolor=#d0d0e0 width="11%"|Author(s)
!bgcolor=#d0d0e0 width="4%" class="unsortable"|Forum link
!bgcolor=#d0d0e0 width="5%"|Releases
!bgcolor=#d0d0e0 width="5%"|Mission Type
!bgcolor=#d0d0e0 width="5%"|Notes
|-

|-
|{{TDM-FM|hhi|1}}
!align=left|[[Hidden Hands 1: Initiation (FM)|Initiation]]
|[[:Category:Missions by JackFarmer|JackFarmer]]
|{{Forumlink|http://forums.thedarkmod.com/index.php?/topic/19796-hidden-hands-initiation-27122018/}}
|2018-12-27
|Mansion/Estate <br> Ship
|
|-
|-
|{{TDM-FM|hhvf|2}}
!align=left|[[Hidden Hands 2: Vitalic Fever (FM)|Vitalic Fever]]
|[[:Category:Missions by JackFarmer|JackFarmer]]
|{{Forumlink|http://forums.thedarkmod.com/index.php?/topic/20051-hidden-hands-vitalic-fever-20072019/}}
|2019-07-20
|Mansion/Estate
|
|-
|-
|{{TDM-FM|hhtlc|3}}
!align=left|[[Hidden Hands 3: The Lost Citadel (FM)|The Lost Citadel]]
|[[:Category:Missions by JackFarmer|JackFarmer]]
|{{Forumlink|https://forums.thedarkmod.com/index.php?/topic/20490-hidden-hands-the-lost-citadel-23072020}}
|2020-07-23
|Castle/Fortress
|
|-
|-
|-
|{{TDM-FM|hhta|4}}
!align=left|[[Hidden Hands 4: The Anomaly (FM)|The Anomaly]]
|[[:Category:Missions by JackFarmer|JackFarmer]]
|{{Forumlink|https://forums.thedarkmod.com/index.php?/topic/20909-hidden-hands-the-anomaly}}
|2021-05-01
|Castle/Fortress <br> Forest
|
|-
|-
|}

=== ''In A Time of Need'' series ===

* '''Release:''' Single-mission (S)
* '''Series' characters:''' [[Thief_Characters#Terry|Terry]] (supporting)
* '''Series' status:''' TBA

{|class="wikitable sortable" border=1 style="border-collapse: collapse;" cellspacing=0 cellpadding=2 width=100%
|-
!bgcolor=#d0d0e0 width="1%"|No.
!bgcolor=#d0d0e0 width="21%"|Fan Mission Title
!bgcolor=#d0d0e0 width="11%"|Author(s)
!bgcolor=#d0d0e0 width="4%" class="unsortable"|Forum link
!bgcolor=#d0d0e0 width="5%"|Releases
!bgcolor=#d0d0e0 width="5%"|Mission Type
!bgcolor=#d0d0e0 width="5%"|Notes
|-

|-
|{{TDM-FM|timeofneed|1}}
!align=left|[[In A Time of Need 1 (FM)|In A Time Of Need]]
|[[:Category:Missions by Kyyrma|Kyyrma]]
|{{Forumlink|http://forums.thedarkmod.com/topic/15354-fan-mission-in-a-time-of-need-by-kyyrma-20131112/}}
|2013-11-12
|Mansion/Estate
|
|-

|-
|{{TDM-FM|breakingout|2}}
!align=left|[[In A Time of Need 2: Breaking Out the Fence (FM)|Breaking Out the Fence]]
|[[:Category:Missions by Kyyrma|Kyyrma]]
|{{Forumlink|http://forums.thedarkmod.com/topic/16091-fan-mission-breaking-out-the-fence-17032014-by-kyyrma/}}
|2014-03-17
|City Missions
|
|-
|}

=== ''Master thief Corso'' series ===

* '''Release:''' Single-mission (S)
* '''Series' characters:''' [[Thief Characters#Corso|Corso]] (protagonist), [[Thief Characters#Mingus|Mingus]] (background, supporting)
* '''Series' status:''' On hiatus.

{|class="wikitable sortable" border=1 style="border-collapse: collapse;" cellspacing=0 cellpadding=2 width=100%
|-
!bgcolor=#d0d0e0 width="1%"|No.
!bgcolor=#d0d0e0 width="21%"|Fan Mission Title
!bgcolor=#d0d0e0 width="11%"|Author(s)
!bgcolor=#d0d0e0 width="4%" class="unsortable"|Forum link
!bgcolor=#d0d0e0 width="5%"|Releases
!bgcolor=#d0d0e0 width="5%"|Mission Type
!bgcolor=#d0d0e0 width="5%"|Notes
|-

|-
|{{TDM-FM|lockner|1}}
!align=left|[[Lockner Manor (FM)|Lockner Manor]]
|[[:Category:Missions by Buck28|buck28]]
|{{Forumlink|http://forums.thedarkmod.com/topic/16452-new-mission-lockner-manor/}}
|2014-08-02
|Mansion/Estate <br> Inn/Tavern
|
|-

|-
|{{TDM-FM|briarwood|2}}
!align=left|[[Briarwood Cathedral (FM)|Briarwood Cathedral]]
|[[:Category:Missions by Buck28|buck28]]
|{{Forumlink|http://forums.thedarkmod.com/topic/16644-briarwood-cathedral/}}
|2014-10-29
|Church/Cathedral <br> Horror
|Winner of the [[Fan Mission Contests#2014 Halloween Speed-build Contest|2014 Halloween Speed-build Contest]].
|-
|}

=== ''No Honor Among Thieves'' campaign ===

* '''Release:''' Campaign (C)
* '''Series' characters:''' TBA
* '''Series' status:''' TBA

{|class="wikitable sortable" border=1 style="border-collapse: collapse;" cellspacing=0 cellpadding=2 width=100%
|-
!bgcolor=#d0d0e0 width="1%"|No.
!bgcolor=#d0d0e0 width="21%"|Fan Mission Title
!bgcolor=#d0d0e0 width="11%"|Author(s)
!bgcolor=#d0d0e0 width="4%" class="unsortable"|Forum link
!bgcolor=#d0d0e0 width="5%"|Releases
!bgcolor=#d0d0e0 width="5%"|Mission Type
!bgcolor=#d0d0e0 width="5%"|Notes
|-

|-
|{{TDM-FM|nhat3|1}}
!align=left|[[No Honor Among Thieves (FM)|Politics]]
|[[:Category:Missions by Goldchocobo|Goldchocobo]], [[:Category:Missions by RailGun|RailGun]], [[:Category:Missions by Mortem Desino|Mortem Desino]], [[:Category:Missions by Bikerdude|Bikerdude]]
|{{Forumlink|http://forums.thedarkmod.com/topic/10993-fan-mission-no-honor-among-thieves-20100429/}}
|2010-04-29 (original version), 2015-05-30 (current version, 3.0)
|Church/Cathedral
|
|-

|-
|{{TDM-FM|nhat3|2}}
!align=left|[[No Honor Among Thieves (FM)|A Night Out on the Town]]
|[[:Category:Missions by Goldchocobo|Goldchocobo]], [[:Category:Missions by RailGun|RailGun]], [[:Category:Missions by Mortem Desino|Mortem Desino]], [[:Category:Missions by Bikerdude|Bikerdude]]
|{{Forumlink|http://forums.thedarkmod.com/topic/10993-fan-mission-no-honor-among-thieves-20100429/}}
|2010-04-29 (original version), 2015-05-30 (current version, 3.0)
|City Missions
|
|-

|-
|{{TDM-FM|nhat3|3}}
!align=left|[[No Honor Among Thieves (FM)|No Honor Among Anyone <br> (a.k.a. Forest)]]
|[[:Category:Missions by Goldchocobo|Goldchocobo]], [[:Category:Missions by RailGun|RailGun]], [[:Category:Missions by Mortem Desino|Mortem Desino]], [[:Category:Missions by Bikerdude|Bikerdude]]
|{{Forumlink|http://forums.thedarkmod.com/topic/10993-fan-mission-no-honor-among-thieves-20100429/}}
|2010-04-29 (original version), 2015-05-30 (current version, 3.0)
|Outdoor/Pagan, Mansion/Estate
|
|-
|}

=== ''Of Brambles and Thorns'' series ===

* '''Release:''' Single-mission (S)
* '''Series' characters:''' TBA
* '''Series' status:''' TBA

{|class="wikitable sortable" border=1 style="border-collapse: collapse;" cellspacing=0 cellpadding=2 width=100%
|-
!bgcolor=#d0d0e0 width="1%"|No.
!bgcolor=#d0d0e0 width="21%"|Fan Mission Title
!bgcolor=#d0d0e0 width="11%"|Author(s)
!bgcolor=#d0d0e0 width="4%" class="unsortable"|Forum link
!bgcolor=#d0d0e0 width="5%"|Releases
!bgcolor=#d0d0e0 width="5%"|Mission Type
!bgcolor=#d0d0e0 width="5%"|Notes
|-

|-
|{{TDM-FM|onesteptoofar|1}}
!align=left|[[One Step Too Far (FM)|One Step Too Far]]
|[[:Category:Missions by Dragofer|Dragofer]]
|{{Forumlink|http://forums.thedarkmod.com/topic/16457-fan-mission-one-step-too-far-by-dragofer-20140804/}}
|2014-08-04
|Pirate <br> Horror
|
|-

|-
|{{TDM-FM|river|2}}
!align=left|[[Down by the Riverside (FM)|Down by the Riverside]]
|[[:Category:Missions by Dragofer|Dragofer]]
|{{Forumlink|http://forums.thedarkmod.com/topic/18402-fan-mission-down-by-the-riverside-by-dragofer-20160925/}}
|2016-09-25
|Mansion/Estate <br> Ship
|
|-
|}

=== ''Penny Dreadful'' series ===

* '''Release:''' Single-mission (S)
* '''Series' characters:''' Gerald Foxley (protagonist)
* '''Series' status:''' TBA

{|class="wikitable sortable" border=1 style="border-collapse: collapse;" cellspacing=0 cellpadding=2 width=100%
|-
!bgcolor=#d0d0e0 width="1%"|No.
!bgcolor=#d0d0e0 width="21%"|Fan Mission Title
!bgcolor=#d0d0e0 width="11%"|Author(s)
!bgcolor=#d0d0e0 width="4%" class="unsortable"|Forum link
!bgcolor=#d0d0e0 width="5%"|Releases
!bgcolor=#d0d0e0 width="5%"|Mission Type
!bgcolor=#d0d0e0 width="5%"|Notes
|-

|-
|{{TDM-FM|penny1_1|1}}
!align=left|[[Penny Dreadful 1: The Grail of Regrets (FM)|Penny Dreadful 1: The Grail of Regrets]]
|[[:Category:Missions by Melan|Melan]]
|{{Forumlink|http://forums.thedarkmod.com/topic/14952-fan-mission-penny-dreadful-by-melan-20130728/}}
|2013-07-27
|Horror
|
|-
|-
|{{TDM-FM|penny2_1|2}}
!align=left|[[Penny Dreadful 2: All the Way Up (FM)|Penny Dreadful 2: All the Way Up]]
|[[:Category:Missions by Melan|Melan]], [[:Category:Missions by Bikerdude|Bikerdude]]
|{{Forumlink|http://forums.thedarkmod.com/topic/16387-fan-mission-penny-dreadful-2-by-melan-and-bikerdude-2014078/}}
|2014-07-08
|Thieves' Highway (Rooftop)
|[https://www.youtube.com/watch?v=WmPfCfbeWvg Trailer]
|-
|-
|{{TDM-FM|penny3|3}}
!align=left|[[Penny Dreadful 3: Erasing the Trail (FM)|Penny Dreadful 3: Erasing the Trail]]
|[[:Category:Missions by Melan|Melan]], [[:Category:Missions by Bikerdude|Bikerdude]]
|{{Forumlink|http://forums.thedarkmod.com/topic/18200-fan-mission-penny-dreadful-3-by-melan-and-bikerdude-20160710/}}
|2016-07-09
|City Missions
|
|-
|}

=== ''Quinn Co.'' campaign ===

* '''Release:''' Campaign (C) (originally single mission (S))
* '''Series' characters:''' TBA
* '''Series' status:''' Completed and released.

{|class="wikitable sortable" border=1 style="border-collapse: collapse;" cellspacing=0 cellpadding=2 width=100%
|-
!bgcolor=#d0d0e0 width="1%"|No.
!bgcolor=#d0d0e0 width="21%"|Fan Mission Title
!bgcolor=#d0d0e0 width="11%"|Author(s)
!bgcolor=#d0d0e0 width="4%" class="unsortable"|Forum link
!bgcolor=#d0d0e0 width="5%"|Releases
!bgcolor=#d0d0e0 width="5%"|Mission Type
!bgcolor=#d0d0e0 width="5%"|Notes
|-

|-
|{{TDM-FM|quinn|1}}
!align=left|[[Quinn Co. (FM)|La Banque Bienveillante]]
|[[:Category:Missions by Airship Ballet|Airship Ballet]]
|{{Forumlink|http://forums.thedarkmod.com/topic/16702-fan-mission-la-banque-bienveillante-by-airship-ballet-20141122/}}
|2014-11-22 (original version), 2015-02-04 (current version, bundled with Chase Mercantile)
|Bank Jobs
|
|-
|-
|{{TDM-FM|quinn|2}}
!align=left|[[Quinn Co. (FM)|Chase Mercantile]]
|[[:Category:Missions by Airship Ballet|Airship Ballet]]
|{{Forumlink|http://forums.thedarkmod.com/topic/16912-fan-mission-chase-mercantile-by-airship-ballet-20150204/}}
|2015-02-04 (now bundled with La Banque Bienveillante)
|Bank Jobs
|
|-
|}

=== ''Sam Wilson'' series ===

* '''Release:''' Single-mission (S)
* '''Series' characters:''' [[Thief_Characters#Sam Wilson|Samuel "Sam" Wilson]] (protagonist)
* '''Series' status:''' Ongoing.

{|class="wikitable sortable" border=1 style="border-collapse: collapse;" cellspacing=0 cellpadding=2 width=100%
|-
!bgcolor=#d0d0e0 width="1%"|No.
!bgcolor=#d0d0e0 width="21%"|Fan Mission Title
!bgcolor=#d0d0e0 width="11%"|Author(s)
!bgcolor=#d0d0e0 width="4%" class="unsortable"|Forum link
!bgcolor=#d0d0e0 width="5%"|Releases
!bgcolor=#d0d0e0 width="5%"|Mission Type
!bgcolor=#d0d0e0 width="5%"|Notes
|-

|-
|{{TDM-FM|sw1_ebound|1}}
!align=left|[[Sam Wilson 1: Eastbound (FM)|Sam Wilson 1: Eastbound]]
|[[:Category:Missions by jonri|jonri]]
|{{Forumlink|https://forums.thedarkmod.com/index.php?/topic/21402-fan-mission-sam-wilson-1-eastbound-2022-05-07}}
|2022-05-07
|Train
|The first TDM FM to be set on a steam train.
|-
|}

=== ''Selis Woderose'' series ===

* '''Release:''' Single-mission (S)
* '''Series' characters:''' [[Thief_Characters#Selis_Woderose|Selis Woderose]] (protagonist)
* '''Series' status:''' Currently on hiatus.

{|class="wikitable sortable" border=1 style="border-collapse: collapse;" cellspacing=0 cellpadding=2 width=100%
|-
!bgcolor=#d0d0e0 width="1%"|No.
!bgcolor=#d0d0e0 width="21%"|Fan Mission Title
!bgcolor=#d0d0e0 width="11%"|Author(s)
!bgcolor=#d0d0e0 width="4%" class="unsortable"|Forum link
!bgcolor=#d0d0e0 width="5%"|Releases
!bgcolor=#d0d0e0 width="5%"|Mission Type
!bgcolor=#d0d0e0 width="5%"|Notes
|-

|-
|{{TDM-FM|flakebridge|1}}
!align=left|[[Selis Woderose 1: Flakebridge Monastery (FM)|Flakebridge Monastery]]
|[[:Category:Missions by Jesps|Jesps]]
|{{Forumlink|http://forums.thedarkmod.com/topic/11991-fm-flakebridge-monastery-by-jesps/}}
|2010-12-05
|Church/Cathedral
|
|-
|-
|{{TDM-FM|rake_off|2}}
!align=left|[[Selis Woderose 2: Rake-off (FM)|Rake-off]]
|[[:Category:Missions by Jesps|Jesps]]
|{{Forumlink|http://forums.thedarkmod.com/topic/12846-fm-rake-off-19-06-2011/}}
|2011-06-19
|Castle/Fortress
|
|-
|}

=== ''Shadowcursed'' series ===

* '''Release:''' Single-mission (S) for the first mission and Campaign (C) for the second mission.
* '''Series' characters:''' [[Thief_Characters#Bolen|Bolen]] (protagonist)
* '''Series' status:''' Ongoing, currently on hiatus.
* '''Ancilliary materials:''' ''[http://www.amazon.com/Shadowcursed-ebook/dp/B00BYEW02M Shadowcursed]'' novella (e-book)

{|class="wikitable sortable" border=1 style="border-collapse: collapse;" cellspacing=0 cellpadding=2 width=100%
|-
!bgcolor=#d0d0e0 width="1%"|No.
!bgcolor=#d0d0e0 width="21%"|Fan Mission Title
!bgcolor=#d0d0e0 width="11%"|Author(s)
!bgcolor=#d0d0e0 width="4%" class="unsortable"|Forum link
!bgcolor=#d0d0e0 width="5%"|Releases
!bgcolor=#d0d0e0 width="5%"|Mission Type
!bgcolor=#d0d0e0 width="5%"|Notes
|-

|-
|{{TDM-FM|requiem|1}}
!align=left|[[Requiem (FM)|Requiem]]
|[[:Category:Missions by Moonbo|Moonbo]]
|{{Forumlink|http://forums.thedarkmod.com/topic/15101-fan-mission-requiem-by-gelo-moonbo-fleisher-2013106/}}
|2013-10-08
|Church/Cathedral <br> Lost Civilizations
|[https://web.archive.org/web/20160409012413/https://community.eidosmontreal.com/blogs/thief-mod-winners Winner] of the 2014 official ''[http://forums.thedarkmod.com/topic/15956-square-enix-and-amazoncom-announce-thief-mod-contest/ Thief Mod Competition]'' by Square Enix & Amazon.com.
|-
|-
|{{TDM-FM|ahouseoflockedsecrets|2}}
!align=left|[[A House of Locked Secrets (FM)|A House of Locked Secrets]]
|[[:Category:Missions by Moonbo|Moonbo]]
|{{Forumlink|http://forums.thedarkmod.com/topic/17163-fan-mission-a-house-of-locked-secrets-by-gelo-moonbo-fleisher-20150528/}}
|2015-05-29
|Church/Cathedral <br> Mansion/Estate
|[https://www.youtube.com/watch?v=f5NuTJEZ8VE Trailer]
|-
|}

=== ''Shadows of Northdale'' series ===

* '''Release:''' Single-mission (S)
* '''Series' characters:''' [[Thief Characters#Corbin|Corbin]] (protagonist)
* '''Series' status:''' Ongoing, currently in gradual development.

{|class="wikitable sortable" border=1 style="border-collapse: collapse;" cellspacing=0 cellpadding=2 width=100%
|-
!bgcolor=#d0d0e0 width="1%"|No.
!bgcolor=#d0d0e0 width="21%"|Fan Mission Title
!bgcolor=#d0d0e0 width="11%"|Author(s)
!bgcolor=#d0d0e0 width="4%" class="unsortable"|Forum link
!bgcolor=#d0d0e0 width="5%"|Releases
!bgcolor=#d0d0e0 width="5%"|Mission Type
!bgcolor=#d0d0e0 width="5%"|Notes
|-

|-
|{{TDM-FM|northdale1|1}}
!align=left|[[Shadows of Northdale Act I (FM)|Shadows of Northdale ACT I: <br> A Curious Mind]]
|[[:Category:Missions by Goldwell|Goldwell]]
|{{Forumlink|http://forums.thedarkmod.com/topic/19368-fan-mission-shadows-of-northdale-act-i-by-goldwell-20180323/}}
|2018-03-23
|City Missions
|[https://www.youtube.com/watch?v=p4nP3lYd6wg Briefing]
|-

|-
|{{TDM-FM|northdale2|2}}
!align=left|[[Shadows of Northdale Act II (FM)|Shadows of Northdale ACT II: <br> Down the Rabbit Hole]]
|[[:Category:Missions by Goldwell|Goldwell]]
|{{Forumlink|http://forums.thedarkmod.com/topic/19936-fan-mission-shadows-of-northdale-act-ii-by-goldwell-20190320/}}
|2019-03-20
|City Missions
|[https://www.youtube.com/watch?v=KO-eIOX9nqI Briefing]
|-
|}

=== ''St Alban'' series ===

* '''Release:''' Single-mission (S)
* '''Series' characters:''' TBA
* '''Series' status:''' TBA

{|class="wikitable sortable" border=1 style="border-collapse: collapse;" cellspacing=0 cellpadding=2 width=100%
|-
!bgcolor=#d0d0e0 width="1%"|No.
!bgcolor=#d0d0e0 width="21%"|Fan Mission Title
!bgcolor=#d0d0e0 width="11%"|Author(s)
!bgcolor=#d0d0e0 width="4%" class="unsortable"|Forum link
!bgcolor=#d0d0e0 width="5%"|Releases
!bgcolor=#d0d0e0 width="5%"|Mission Type
!bgcolor=#d0d0e0 width="5%"|Notes
|-

|-
|{{TDM-FM|caduceus|1}}
!align=left|[[St Alban 1: The Caduceus of St Alban (FM)|The Caduceus of St. Alban]]
|[[:Category:Missions by Bikerdude|Bikerdude]]
|{{Forumlink|http://forums.thedarkmod.com/topic/11644-the-caduceus-of-st-alban-vertical-fm-contest-entry-aug-8th-2010/}}
|2010-08-23 (original version), 2010-08-26 (version 1.5.5)
|Church/Cathedral
|
|-
|-
|{{TDM-FM|cathedral|2}}
!align=left|[[St Alban 2: St Albans Cathedral (FM)|St. Albans Cathedral]]
|[[:Category:Missions by Bikerdude|Bikerdude]]
|{{Forumlink|http://forums.thedarkmod.com/topic/16343-fan-mission-st-albans-cathedral-v20-11062014/}} (current, 2.0 version)
|2010-11-01 (original version), 2014-06-11 (version 2.0)
|Church/Cathedral
|
|-
|}

=== ''Talbot'' series ===

* '''Release:''' Single-mission (S)
* '''Series' characters:''' Talbot
* '''Series' status:''' Ongoing, currently on hiatus.

{|class="wikitable sortable" border=1 style="border-collapse: collapse;" cellspacing=0 cellpadding=2 width=100%
|-
!bgcolor=#d0d0e0 width="1%"|No.
!bgcolor=#d0d0e0 width="21%"|Fan Mission Title
!bgcolor=#d0d0e0 width="11%"|Author(s)
!bgcolor=#d0d0e0 width="4%" class="unsortable"|Forum link
!bgcolor=#d0d0e0 width="5%"|Releases
!bgcolor=#d0d0e0 width="5%"|Mission Type
!bgcolor=#d0d0e0 width="5%"|Notes
|-

|-
|{{TDM-FM|returntothecity|1}}
!align=left|[[Talbot 2: Return to the City (FM)|Return to the City]]
|[[:Category:Missions by Melan|Melan]]
|{{Forumlink|http://forums.thedarkmod.com/topic/10509-fan-mission-return-to-the-city-by-melan-20100110/}} (original version), {{Forumlink|http://forums.thedarkmod.com/topic/12390-fan-mission-return-to-the-city-v2-01032011/}} (version 2.0)
|2010-01-10 (original version), 2015-01-03 (2.0), 2015-01-03 (current version, 3.0)
|City Missions
|Winner of the [[Fan Mission Contests#2009 Grand Christmas Contest|2009 Grand Christmas Contest]].
|-
|-
|{{TDM-FM|fauchard1_1|2}}
!align=left|[[Talbot 3: Fiasco at Fauchard Street (FM)|Fiasco at Fauchard Street]]
|[[:Category:Missions by Melan|Melan]]
|{{Forumlink|http://forums.thedarkmod.com/topic/12655-fan-mission-fiasco-at-fauchard-street-by-melan-20110501/}}
|2011-05-01
|Thieves' Highway (Rooftop)
|
|-
|}

'''''Note:''' [[Sir Talbot's Collateral (FM)|Sir Talbot's Collateral]] by Bikerdude and Baal is actually an unrelated mission, just with a similarly named character.''

=== ''The Lieutenant'' series ===

* '''Release:''' Single-mission (S)
* '''Description:''' The series follows the cases of an intelligence officer.
* '''Series' characters:''' The titular Lieutenant
* '''Series' status:''' Ongoing.

{|class="wikitable sortable" border=1 style="border-collapse: collapse;" cellspacing=0 cellpadding=2 width=100%
|-
!bgcolor=#d0d0e0 width="1%"|No.
!bgcolor=#d0d0e0 width="21%"|Fan Mission Title
!bgcolor=#d0d0e0 width="11%"|Author(s)
!bgcolor=#d0d0e0 width="4%" class="unsortable"|Forum link
!bgcolor=#d0d0e0 width="5%"|Releases
!bgcolor=#d0d0e0 width="5%"|Mission Type
!bgcolor=#d0d0e0 width="5%"|Notes
|-
|-
|{{TDM-FM|inplainsight|1}}
!align=left|[[The Lieutenant 1: In Plain Sight (FM)|The Lieutenant 1: In Plain Sight]]
|[[:Category:Missions by Frost_Salamander|Frost_Salamander]]
|{{Forumlink|https://forums.thedarkmod.com/index.php?/topic/21549-fan-mission-in-plain-sight-by-frost_salamander-20220807}}
|2022-08-07
|City Missions
|
|-
|-
|{{TDM-FM|highex|2}}
!align=left|[[The Lieutenant 2: High Expectations (FM)|The Lieutenant 2: High Expectations]]
|[[:Category:Missions by Frost_Salamander|Frost_Salamander]]
|{{Forumlink|https://forums.thedarkmod.com/index.php?/topic/21837-fan-mission-the-lieutenant-2-high-expectations-by-frost_salamander-20230424}}
|2023-04-24
|Mansion/Estate <br> City Missions
|
|-
|-
|{{TDM-FM|foreignaffaris|3}}
!align=left|[[The Lieutenant 3: Foreign Affairs (FM)|The Lieutenant 3: Foreign Affairs]]
|[[:Category:Missions by Frost_Salamander|Frost_Salamander]]
|{{Forumlink|https://forums.thedarkmod.com/index.php?/topic/22452-fan-mission-the-lieutenant-3-foreign-affairs-by-frost_salamander}}
|2024/11/08
|City Missions, Moorish Architecture
|
|-
|-
|{{TDM-FM|reciprocalgambit|4}}
!align=left|[[The Lieutenant 4: A Reciprocal Gambit (FM)|The Lieutenant 4: A Reciprocal Gambit]]
|[[:Category:Missions by Frost_Salamander|Frost_Salamander]]
|{{Forumlink|https://forums.thedarkmod.com/index.php?/topic/22945-fan-mission-the-lieutenant-4-a-reciprocal-gambit-by-frost_salamander}}
|2025-06-18
|City Missions, Mansion/Estate
|
|-
|}

=== ''Thief's Den'' series ===

* '''Release:''' Single-mission (S)
* '''Description:''' The ''de facto'' oldest FM series in ''The Dark Mod''. Follow the skillful thief Farrell as he navigates the criminal underworld of [[The City|Bridgeport]] and the surrounding world.
* '''Series' characters:''' [[Thief Characters#Farrell|Farrell]] (protagonist), [[Thief Characters#Sebastian_Creep|Sebastian Creep]] (supporting)
* '''Series' status:''' Currently on hiatus.

{|class="wikitable sortable" border=1 style="border-collapse: collapse;" cellspacing=0 cellpadding=2 width=100%
|-
!bgcolor=#d0d0e0 width="1%"|No.
!bgcolor=#d0d0e0 width="21%"|Fan Mission Title
!bgcolor=#d0d0e0 width="11%"|Author(s)
!bgcolor=#d0d0e0 width="4%" class="unsortable"|Forum link
!bgcolor=#d0d0e0 width="5%"|Releases
!bgcolor=#d0d0e0 width="5%"|Mission Type
!bgcolor=#d0d0e0 width="5%"|Notes
|-
|-
|{{TDM-FM|thiefsden|1}}
!align=left|[[Thief's Den 1: Thief's Den (FM)|Thief's Den]]
|[[:Category:Missions by Fidcal|Fidcal]], [[:Category:Missions by Greebo|Greebo]]
|{{Forumlink|http://forums.thedarkmod.com/topic/11347-fan-mission-thiefs-den-re-release-by-fidcal20100704/}}
|2008-01-18 (original version), 2010-07-04 (version 2.0)
|City Missions
|
|-
|-
|{{TDM-FM|chalice1_1|2}}
!align=left|[[Thief's Den 2: The Chalice of Kings (FM)|The Chalice of Kings]]
|[[:Category:Missions by Fidcal|Fidcal]] (original version), [[:Category:Missions by Bikerdude|Bikerdude]], [[:Category:Missions by Xarg|Xarg]] (edits, version 2.0)
|{{Forumlink|http://forums.thedarkmod.com/topic/9935-fan-mission-chalice-of-kings-by-fidcal-20091017/}}
|2009-10-15 (original version), 2015-09-24 (version 2.0)
|Castle/Fortress
|
|-
|-
|{{TDM-FM|heartv2|3}}
!align=left|[[Thief's Den 3: The Heart of Lone Salvation (FM)|The Heart of Lone Salvation]]
|[[:Category:Missions by Fidcal|Fidcal]], Baddcog, [[:Category:Missions by Bikerdude|Bikerdude]]
|{{Forumlink|http://forums.thedarkmod.com/topic/10878-fan-mission-the-heart-of-lone-salvation-by-fidcal-baddcog-bikerdude-20100402/}}
|2010-04-02 (original version), 2014-04-12 (version 2.0)
|City Missions
|
|-
|-
|{{TDM-FM|alchemist|4}}
!align=left|[[Thief's Den 4: The Alchemist (FM)|The Alchemist]]
|[[:Category:Missions by Sotha|Sotha]], [[:Category:Missions by Fidcal|Fidcal]]
|{{Forumlink|http://forums.thedarkmod.com/topic/11170-fan-mission-the-alchemist-by-sotha-fidcal20100601/}}
|2010-06-01 (original version) 2010-06-04 (update)
|City Missions
|
|-
|}

=== ''Thomas Porter'' series ===

* '''Release:''' Single-mission (S)
* '''Series' characters:''' [[Thief_Characters#Thomas Porter|Thomas Porter]] (protagonist), [[Thief_Characters#Lark Butternose|Lark Butternose]] (supporting), [[Noble/Wealthy_Characters#Godfrey_Knighton|Godfrey Knighton]] (background)
* '''Series' status:''' Concluded.
* '''Overview:''' [http://forums.thedarkmod.com/topic/15179-the-thomas-porter-series/ Courtesy of] Sotha.

{|class="wikitable sortable" border=1 style="border-collapse: collapse;" cellspacing=0 cellpadding=2 width=100%
|-
!bgcolor=#d0d0e0 width="1%"|No.
!bgcolor=#d0d0e0 width="21%"|Fan Mission Title
!bgcolor=#d0d0e0 width="11%"|Author(s)
!bgcolor=#d0d0e0 width="4%" class="unsortable"|Forum link
!bgcolor=#d0d0e0 width="5%"|Releases
!bgcolor=#d0d0e0 width="5%"|Mission Type
!bgcolor=#d0d0e0 width="5%"|Notes
|-

|-
|{{TDM-FM|mandrasola|1}}
!align=left|[[Thomas Porter 1: Mandrasola (FM)|Mandrasola]]
|[[:Category:Missions by Sotha|Sotha]]
|{{Forumlink|http://forums.thedarkmod.com/topic/12575-fan-mission-mandrasola-by-sotha-20110410/}}
|2011-04-10
|City Missions
|
|-
|-
|{{TDM-FM|knighton_manor|2}}
!align=left|[[Thomas Porter 2: Knighton Manor (FM)|Knighton Manor]]
|[[:Category:Missions by Sotha|Sotha]]
|{{Forumlink|http://forums.thedarkmod.com/topic/11898-fan-mission-the-knighton-manor-by-sotha-20101109/}}
|2010-11-09
|Mansion/Estate
|
|-
|-
|{{TDM-FM|beleaguered_fence|3}}
!align=left|[[Thomas Porter 3: The Beleaguered Fence (FM)|The Beleaguered Fence]]
|[[:Category:Missions by Sotha|Sotha]]
|{{Forumlink|http://forums.thedarkmod.com/topic/11298-fan-mission-the-beleaguered-fence-by-sotha-20100623/}}
|2010-06-23
|Jail/Prison
|
|-
|-
|{{TDM-FM|glenham_tower|4}}
!align=left|[[Thomas Porter 4: Glenham Tower (FM)|Glenham Tower]]
|[[:Category:Missions by Sotha|Sotha]]
|{{Forumlink|http://forums.thedarkmod.com/topic/11423-fan-mission-the-glenham-tower-by-sotha-20100717/}}
|2010-07-17
|Castle/Fortress <br> Horror
|Winner of the [[Fan_Mission_Contests#2010_Summer_Vertical_Contest|2010 Summer Vertical Contest]].
|-
|-
|{{TDM-FM|transaction|5}}
!align=left|[[Thomas Porter 5: The Transaction (FM)|The Transaction]]
|[[:Category:Missions by Sotha|Sotha]]
|{{Forumlink|http://forums.thedarkmod.com/topic/12408-fan-mission-the-transaction-by-sotha-20110304/}}
|2011-03-04
|City Missions
|
|-
|-
|{{TDM-FM|phrase_book|6}}
!align=left|[[Thomas Porter 6: The Phrase Book (FM)|The Phrase Book]]
|[[:Category:Missions by Sotha|Sotha]]
|{{Forumlink|http://forums.thedarkmod.com/topic/13799-fan-mission-the-phrase-book-by-sotha-20120512/}}
|2012-05-11
|City Missions <br> Thieves' Highway (Rooftop)
|
|-
|-
|{{TDM-FM|lich_queens_demise|7}}
!align=left|[[Thomas Porter 7: The Lich Queen's Demise (FM)|The Lich Queen's Demise]]
|[[:Category:Missions by Sotha|Sotha]]
|{{Forumlink|http://forums.thedarkmod.com/topic/14826-fan-mission-the-lich-queens-demise-by-sotha-20130520/}}
|2013-05-20
|Horror
|
|-
|}

=== ''Ulysses'' series ===

* '''Release:''' Single-mission (S)
* '''Series' characters:''' Ulysses (protagonist)
* '''Series' status:''' TBA

{|class="wikitable sortable" border=1 style="border-collapse: collapse;" cellspacing=0 cellpadding=2 width=100%
|-
!bgcolor=#d0d0e0 width="1%"|No.
!bgcolor=#d0d0e0 width="21%"|Fan Mission Title
!bgcolor=#d0d0e0 width="11%"|Author(s)
!bgcolor=#d0d0e0 width="4%" class="unsortable"|Forum link
!bgcolor=#d0d0e0 width="5%"|Releases
!bgcolor=#d0d0e0 width="5%"|Mission Type
!bgcolor=#d0d0e0 width="5%"|Notes
|-

|-
|{{TDM-FM|ulysses_genesis|1}}
!align=left|[[Ulysses 1: Genesis (FM)|Ulysses: Genesis]]
|[[:Category:Missions by Sotha|Sotha]]
|{{Forumlink|http://forums.thedarkmod.com/topic/16428-fan-mission-ulysses-genesis-by-sotha-20140724/}}
|2014-07-24
|Mansion/Estate
|
|-

|-
|{{TDM-FM|u2_flock|2}}
!align=left|[[Ulysses 2: Protecting the Flock (FM)|Ulysses: Protecting the Flock]]
|[[:Category:Missions by Sotha|Sotha]]
|{{Forumlink|http://forums.thedarkmod.com/topic/17162-fan-mission-ulysses-2-protecting-the-flock-by-sotha-20150528/}}
|2015-05-28
|Church/Cathedral
|
|-
|}

=== ''Vengeance for a Thief'' campaign ===

* '''Release:''' Single-mission (S) for the first two published missions, Campaign (C) for the final release that also includes a new first mission.
* '''Series' characters:''' TBA
* '''Series' status:''' TBA

{|class="wikitable sortable" border=1 style="border-collapse: collapse;" cellspacing=0 cellpadding=2 width=100%
|-
!bgcolor=#d0d0e0 width="1%"|No.
!bgcolor=#d0d0e0 width="21%"|Fan Mission Title
!bgcolor=#d0d0e0 width="11%"|Author(s)
!bgcolor=#d0d0e0 width="4%" class="unsortable"|Forum link
!bgcolor=#d0d0e0 width="5%"|Releases
!bgcolor=#d0d0e0 width="5%"|Mission Type
!bgcolor=#d0d0e0 width="5%"|Notes
|-

|-
|{{TDM-FM|vfat3|1}}
!align=left|[[Vengeance for a Thief (FM)|The Angel's Tear]]
|[[:Category:Missions by Sir Taffsalot|Sir Taffsalot]]
|{{Forumlink|http://forums.thedarkmod.com/topic/16953-the-complete-vengeance-for-a-thief-campaign/}}
|2015-02-16
|Church/Cathedral
|
|-

|-
|{{TDM-FM|vfat1|2}}
!align=left|[[Vengeance for a Thief (FM)|A Pawn in the Game]]
|[[:Category:Missions by Sir Taffsalot|Sir Taffsalot]]
|{{Forumlink|http://forums.thedarkmod.com/topic/14068-fan-mission-vengeance-for-a-thief-part-1-by-sir-taffsalot-06092012/}}
|2012-09-06
|Jail/Prison
|
|-

|-
|{{TDM-FM|vfat2|3}}
!align=left|[[Vengeance for a Thief (FM)|The Art of Revenge]]
|[[:Category:Missions by Sir Taffsalot|Sir Taffsalot]]
|{{Forumlink|http://forums.thedarkmod.com/topic/15051-fan-mission-vengeance-for-a-thief-part-2-by-sir-taffsalot-06092013/}}
|2013-09-06
|Museum Heists
|
|-

|}

=== ''Volta'' series ===

* '''Release:''' Single-mission (S)
* '''Series' characters:''' TBA
* '''Series' status:''' TBA

{|class="wikitable sortable" border=1 style="border-collapse: collapse;" cellspacing=0 cellpadding=2 width=100%
|-
!bgcolor=#d0d0e0 width="1%"|No.
!bgcolor=#d0d0e0 width="21%"|Fan Mission Title
!bgcolor=#d0d0e0 width="11%"|Author(s)
!bgcolor=#d0d0e0 width="4%" class="unsortable"|Forum link
!bgcolor=#d0d0e0 width="5%"|Releases
!bgcolor=#d0d0e0 width="5%"|Mission Type
!bgcolor=#d0d0e0 width="5%"|Notes
|-

|-
|{{TDM-FM|volta1_3|1}}
!align=left|[[Volta I: The Stone (FM)|Volta and the Stone]]
|[[:Category:Missions by Kingsal|Kingsal]]
|{{Forumlink|http://forums.thedarkmod.com/topic/18087-fan-mission-volta-and-the-stone-by-kingsal-05262016/}}
|2016-05-27
|Mansion/Estate <br> City Missions
|
|-

|-
|{{TDM-FM|cauldron_v2_2|2}}
!align=left|[[Volta II: Cauldron of the Gods (FM)|Volta 2: Cauldron of the Gods]]
|[[:Category:Missions by Kingsal|Kingsal]]
|{{Forumlink|http://forums.thedarkmod.com/topic/19207-fan-mission-volta-ii-cauldron-of-the-gods-by-kingsal-113017-update-v20/}}
|2017-11-30
|Lost Civilizations
|[https://www.youtube.com/watch?v=SRRCRVFHruc Briefing]
|-

|-
|{{TDM-FM|gemcutter|3}}
!align=left|[[Volta III: Gemcutter (FM)|Volta 3: Gemcutter]]
|[[:Category:Missions by Kingsal|Kingsal]]
|{{Forumlink|https://forums.thedarkmod.com/index.php?/topic/22566-fan-mission-volta-iii-gemcutter-15th-anniversary-contest/}}
|2024-10-17
|Ship, City Missions, Moorish Architecture
|[https://www.youtube.com/watch?v=U9TbKihp7qM Briefing]
|-
|}

=== ''William Steele'' series ===

* '''Release:''' Single-mission (S)
* '''Series' characters:''' [[Thief_Characters#William_Steele|William Steele]] (protagonist)
* '''Series' status:''' Concluded.

{|class="wikitable sortable" border=1 style="border-collapse: collapse;" cellspacing=0 cellpadding=2 width=100%
|-
!bgcolor=#d0d0e0 width="1%"|No.
!bgcolor=#d0d0e0 width="21%"|Fan Mission Title
!bgcolor=#d0d0e0 width="11%"|Author(s)
!bgcolor=#d0d0e0 width="4%" class="unsortable"|Forum link
!bgcolor=#d0d0e0 width="5%"|Releases
!bgcolor=#d0d0e0 width="5%"|Mission Type
!bgcolor=#d0d0e0 width="5%"|Notes
|-

|-
|{{TDM-FM|ws1_north|1}}
!align=left|[[William Steele 1: In the North (FM)|In the North]]
|[[:Category:Missions by Grayman|grayman]]
|{{Forumlink|http://forums.thedarkmod.com/topic/14214-fan-mission-in-the-north-by-grayman-20121020/}}
|2012-10-20
|Mansion/Estate
|
|-

|-
|{{TDM-FM|ws2_homeagain|2}}
!align=left|[[William Steele 2: Home Again (FM)|Home Again]]
|[[:Category:Missions by Grayman|grayman]]
|{{Forumlink|http://forums.thedarkmod.com/topic/15919-fan-mission-home-again-by-grayman-2014212/}}
|2014-02-12
|Thieves' Highway (Rooftop)
|
|-

|-
|{{TDM-FM|ws3_cleighmoor|3}}
!align=left|[[William Steele 3: Cleighmoor (FM)|Cleighmoor]]
|[[:Category:Missions by Grayman|grayman]]
|{{Forumlink|http://forums.thedarkmod.com/topic/16011-fan-mission-cleighmoor-by-grayman-201431/}}
|2014-03-01
|Sewers <br> Jail/Prison
|
|-

|-
|{{TDM-FM|ws4_warrens|4}}
!align=left|[[William Steele 4: The Warrens (FM)|The Warrens]]
|[[:Category:Missions by Grayman|grayman]]
|{{Forumlink|http://forums.thedarkmod.com/topic/19618-fan-mission-the-warrens-by-grayman-201891/}}
|2018-09-01
|City Missions
|
|-

|-
|{{TDM-FM|ws5_commerce|5}}
!align=left|[[William Steele 5: Commerce Bank (FM)|Commerce Bank]]
|[[:Category:Missions by Grayman|grayman]]
|{{Forumlink|http://forums.thedarkmod.com/topic/19957-fan-mission-commerce-bank-by-grayman-2019410/}}
|2019-04-10
|Bank Jobs
|
|-

|}

== Note ==

For a key to the descriptions of each Mission Type, please see [[Fan_Missions_for_The_Dark_Mod#Table_notes|this overview]].

== See also ==

*[[Fan Missions for The Dark Mod]] - Main article on TDM fan missions.

[[Category:Fan Missions|S]]

Fan Mission Series

2025-12-12T11:07:05Z

Datiswous: /* Vengeance for a Thief campaign */

This article serves as an overview of the known existing FM series.

Over the years, ''The Dark Mod'' has accumulated a number of Fan Missions that form a larger interconnected series or an overarching/continuing narrative. Many series are connected by their main characters, some by other FM inter-related elements.

The FMs of each series are sorted in chronological order.

The number of each FM includes a link to its page on the official website.

The name of each FM includes a link to its page on the official TDM wiki.

Beware of potential (minor) spoilers behind the character links.

== Official campaigns ==

While all TDM missions are technically Fan Missions, the ones belonging to these official campaigns are as close as TDM will ever get to its own official in-game missions, or in-game story campaigns. These core missions for the base game are in slow and patient continuous development (due to TDM being a hobbyist project of a fan community), and have been gradually added to the base game over the course of several years.

For additional series by TDM authors, please see the next section.

=== Introduction campaign ===

The missions of this campaign serve as a gradual introduction into the setting and gameplay of ''The Dark Mod''. The missions are shorter and fairly easy, and gradually put the player's newly acquired skills to the test.

Currently, this is the only series that is bundled directly as part of the base game. By installing TDM, the first three missions available to you will be part of this official mini-campaign.

'''Series' characters:''' [[Thief Characters#Corbin|Corbin]] (protagonist), Paschal Murnerus, Moorish adventurers (background)

'''Series' status:''' In development, but currently on hiatus. 3 missions currently available, including the (generally plotless) training mission.

{|class="wikitable sortable" border=1 style="border-collapse: collapse;" cellspacing=0 cellpadding=2 width=100%
|-
!bgcolor=#d0d0e0 width="1%"|No.
!bgcolor=#d0d0e0 width="21%"|Fan Mission Title
!bgcolor=#d0d0e0 width="11%"|Author(s)
!bgcolor=#d0d0e0 width="4%" class="unsortable"|Forum link
!bgcolor=#d0d0e0 width="5%"|Releases
!bgcolor=#d0d0e0 width="5%"|Mission Type
!bgcolor=#d0d0e0 width="5%"|Notes
|-

|-
|0
!align=left|[[Training Mission (OM)|Training mission]]
|TDM dev team
|{{Forumlink|http://forums.thedarkmod.com/topic/9932-fan-mission-training-mission-20091017/}}
|2009-10-17 (original version)
|Training <br> Jumping/Platforming
|Unique. The official tutorial mission of TDM, with open-ended gameplay.
|-
|-
|1
!align=left|[[A New Job (OM)|A New Job]]
|Springheel
|{{Forumlink|http://forums.thedarkmod.com/topic/18647-tdm-205-official-introductory-missions/}}
|2017-03-14
|City Missions <br> Inn/Tavern
|
|-
|-
|2
!align=left|[[The Tears of Saint Lucia (OM)|The Tears of Saint Lucia]]
|TDM dev team
|{{Forumlink|http://forums.thedarkmod.com/topic/10579-fan-mission-the-tears-of-st-lucia-20081021/}} (original version), {{Forumlink|http://forums.thedarkmod.com/topic/18647-tdm-205-official-introductory-missions/}} (current version)
|2008-10-21 (original version), 2017-02-14 (current version, 3.0)
|Church/Cathedral
|[https://www.youtube.com/watch?v=yrGxoi3LSGg Briefing] <br> ''{{TDM-FM|15|standalone release link}}''
|-
|}

== Individual authors' series ==

The majority of missions created for ''The Dark Mod''. For the sake of easier searching, these FM series are arranged in alphabetical order, based on their titles. In terms of release, a Single-mission (S) series consists of several single-mission FM releases over time (the commonest sort), while a Campaign (C) series is an FM containing a storyline consisting of several missions.

=== ''The Accountant'' series ===

* '''Release:''' Single-mission (S)
* '''Series' characters:''' [[Thief_Characters#Corbin|Corbin]] (protagonist)
* '''Series' status:''' Currently on hold.

{|class="wikitable sortable" border=1 style="border-collapse: collapse;" cellspacing=0 cellpadding=2 width=100%
|-
!bgcolor=#d0d0e0 width="1%"|No.
!bgcolor=#d0d0e0 width="21%"|Fan Mission Title
!bgcolor=#d0d0e0 width="11%"|Author(s)
!bgcolor=#d0d0e0 width="4%" class="unsortable"|Forum link
!bgcolor=#d0d0e0 width="5%"|Releases
!bgcolor=#d0d0e0 width="5%"|Mission Type
!bgcolor=#d0d0e0 width="5%"|Notes
|-

|-
|{{TDM-FM|ac1|1}}
!align=left|[[The Accountant 1: Thieves and Heirs (FM)|The Accountant 1: Thieves and Heirs]]
|[[:Category:Missions by Goldwell|Goldwell]]
|{{Forumlink|http://forums.thedarkmod.com/topic/19164-fan-mission-the-accountant-1-thieves-and-heirs-by-goldwell-20171108/}}
|2017-11-08
|Mansion/Estate
|[https://www.youtube.com/watch?v=Tk9DtOT4kjc Briefing]
|-

|-
|{{TDM-FM|ac2|2}}
!align=left|[[The Accountant 2: New in Town (FM)|The Accountant 2: New in Town]]
|[[:Category:Missions by Goldwell|Goldwell]]
|{{Forumlink|http://forums.thedarkmod.com/topic/18054-fan-mission-the-accountant-2-new-in-town-by-goldwell-20160509/}}
|2016-05-08
|Mansion/Estate
|[https://www.youtube.com/watch?v=xeuIO_GcYjQ Briefing] <br> [https://www.youtube.com/watch?v=w6e_SJ0_JOM Gameplay trailer]
|-
|}

=== ''Away'' series ===

* '''Release:''' Single-mission (S)
* '''Series' characters:'''
* '''Series' status:''' Currently on hold. Planned to continue.

{|class="wikitable sortable" border=1 style="border-collapse: collapse;" cellspacing=0 cellpadding=2 width=100%
|-
!bgcolor=#d0d0e0 width="1%"|No.
!bgcolor=#d0d0e0 width="21%"|Fan Mission Title
!bgcolor=#d0d0e0 width="11%"|Author(s)
!bgcolor=#d0d0e0 width="4%" class="unsortable"|Forum link
!bgcolor=#d0d0e0 width="5%"|Releases
!bgcolor=#d0d0e0 width="5%"|Mission Type
!bgcolor=#d0d0e0 width="5%"|Notes
|-
|{{TDM-FM|away0|0}}
!align=left|[[Away 0: Stolen Heart (FM)|Away 0: Stolen Heart]]
|[[:Category:Missions by Geep|Geep]]
|{{Forumlink|https://forums.thedarkmod.com/index.php?/topic/20964-away-0-stolen-heart-by-geep-_atti_-20211112/}}
|2021-11-12
|Inn/Tavern, Jail/Prison, Museum Heist, Bank Job
|
|-
|{{TDM-FM|airpocket|1}}
!align=left|[[Away 1: Air Pocket (FM)|Away 1: Air Pocket]]
|[[:Category:Missions by Geep|Geep]]
|{{Forumlink|https://forums.thedarkmod.com/index.php?/topic/20252-fan-mission-away-1-air-pocket-by-geep-20200207/}}
|2020-02-06
|Pirate/Ship
|
|-
|}

=== ''Chronicles of Skulduggery'' series ===

* '''Release:''' Single-mission (S)
* '''Series' characters:''' [[Thief_Characters#Elyas_Thorne|Elyas Thorne]] (protagonist)
* '''Series' status:''' TBA

{|class="wikitable sortable" border=1 style="border-collapse: collapse;" cellspacing=0 cellpadding=2 width=100%
|-
!bgcolor=#d0d0e0 width="1%"|No.
!bgcolor=#d0d0e0 width="21%"|Fan Mission Title
!bgcolor=#d0d0e0 width="11%"|Author(s)
!bgcolor=#d0d0e0 width="4%" class="unsortable"|Forum link
!bgcolor=#d0d0e0 width="5%"|Releases
!bgcolor=#d0d0e0 width="5%"|Mission Type
!bgcolor=#d0d0e0 width="5%"|Notes
|-

|-
|{{TDM-FM|cos0_thief|0}}
!align=left|[[Chronicles of Skulduggery 0: To Catch a Thief (FM)|To Catch a Thief]]
|[[:Category:Missions by Bienie|Bienie]]
|{{Forumlink|https://forums.thedarkmod.com/index.php?/topic/21156-fan-mission-chronicles-of-skulduggery-0-to-catch-a-thief-20211120/}}
|2021-11-20
|City Missions Mansion/Estate
|
|-
|-
|{{TDM-FM|127|1}}
!align=left|[[Chronicles of Skulduggery 1: Pearls and Swine (FM)|Pearls and Swine]]
|[[:Category:Missions by Bienie|Bienie]]
|{{Forumlink|https://forums.thedarkmod.com/topic/19439-chronicles-of-skulduggery-pearls-and-swine/}}
|2018-05-25
|City Missions
|
|-
|-
|{{TDM-FM|137|2}}
!align=left|[[Chronicles of Skulduggery 2: A Precarious Position (FM)|A Precarious Position]]
|[[:Category:Missions by Bienie|Bienie]]
|{{Forumlink|https://forums.thedarkmod.com/topic/19975-fan-mission-chronicles-of-skulduggery-2-a-precarious-position-20190504/}}
|2019-05-03
|City Missions
|
|-
|-
|{{TDM-FM|149|3}}
!align=left|[[Chronicles of Skulduggery 3: Sacricide (FM)|Sacricide]]
|[[:Category:Missions by Bienie|Bienie]]
|{{Forumlink|https://forums.thedarkmod.com/index.php?/topic/20483-fan-mission-chronicles-of-skulduggery-3-sacricide-20200718/}}
|2020-07-18
|City Missions
|
|-
|}

=== ''Corbin'' series ===

* '''Release:''' Single-mission (S)
* '''Series' characters:''' [[Thief_Characters#Corbin|Corbin]] (protagonist), cardinal Laurenti (background), Keshka brotherhood members (antagonists)
* '''Series' status:''' TBA

{|class="wikitable sortable" border=1 style="border-collapse: collapse;" cellspacing=0 cellpadding=2 width=100%
|-
!bgcolor=#d0d0e0 width="1%"|No.
!bgcolor=#d0d0e0 width="21%"|Fan Mission Title
!bgcolor=#d0d0e0 width="11%"|Author(s)
!bgcolor=#d0d0e0 width="4%" class="unsortable"|Forum link
!bgcolor=#d0d0e0 width="5%"|Releases
!bgcolor=#d0d0e0 width="5%"|Mission Type
!bgcolor=#d0d0e0 width="5%"|Notes
|-

|-
|{{TDM-FM|builders_influence|1}}
!align=left|[[The Builder's Influence (FM)|The Builder's Influence]]
|[[:Category:Missions by RailGun|RailGun]], [[:Category:Missions by Springheel|Springheel]]
|{{Forumlink|http://forums.thedarkmod.com/topic/10811-fan-mission-the-builders-influence-20100320/}}
|2010-03-20 (original version), 2010-03-23 (version 2.0)
|Castle/Fortress
|
|-
|-
|{{TDM-FM|score_to_settle|2}}
!align=left|[[A Score to Settle (FM)|A Score to Settle]]
|[[:Category:Missions by Springheel|Springheel]]
|{{Forumlink|http://forums.thedarkmod.com/topic/12894-fan-mission-48-a-score-to-settle-by-springheel-20110701/}}
|2011-07-01
|City Missions
|
|-
|-
|{{TDM-FM|follow|3}}
!align=left|[[A Reputation to Uphold (FM)|A Reputation to Uphold]]
|[[:Category:Missions by Springheel|Springheel]]
|{{Forumlink|http://forums.thedarkmod.com/topic/16204-fan-mission-a-reputation-to-uphold-by-springheel/}}
|2014-04-18
|City Missions
|
|-
|-
|{{TDM-FM|matterofhours|4}}
!align=left|[[A Matter of Hours (FM)|A Matter of Hours]]
|[[:Category:Missions by Springheel|Springheel]]
|{{Forumlink|http://forums.thedarkmod.com/topic/18809-fan-mission-a-matter-of-hours-by-springheel-2842017/}}
|2017-04-28
|Warehouse
|
|-
|}

=== ''Crucible of Omens'' series ===

* '''Description:''' Though originally planned as a major campaign for future releases of TDM, development progress has been halted.
* '''Release:''' Released as Single-mission (S), possibly would have been a Campaign (C) if finished.
* '''Series' status:''' Development halted, campaign apparently cancelled. Only 1 mission has been completed and made available.

{|class="wikitable sortable" border=1 style="border-collapse: collapse;" cellspacing=0 cellpadding=2 width=100%
|-
!bgcolor=#d0d0e0 width="1%"|No.
!bgcolor=#d0d0e0 width="21%"|Fan Mission Title
!bgcolor=#d0d0e0 width="11%"|Author(s)
!bgcolor=#d0d0e0 width="4%" class="unsortable"|Forum link
!bgcolor=#d0d0e0 width="5%"|Releases
!bgcolor=#d0d0e0 width="5%"|Mission Type
!bgcolor=#d0d0e0 width="5%"|Notes
|-

|-
|{{TDM-FM|bcd|1}}
!align=left|[[Crucible of Omens: Behind Closed Doors (FM)|Crucible of Omens: Behind Closed Doors]]
|[[:Category:Missions by Bikerdude|Bikerdude]], Crucible of Omens Team
|{{Forumlink|http://forums.thedarkmod.com/topic/17627-crucible-of-omens-behind-closed-doors-by-bikerdude-the-crucible-team-updated-18122015/}}
|2015-12-19
|City Missions
|-
|}

=== ''Duncan Lynch'' series ===

* '''Release:''' Single-mission (S)
* '''Series' characters:''' [[Thief_Characters#Duncan_Lynch|Duncan Lynch]] (protagonist)
* '''Series' status:''' TBA

{|class="wikitable sortable" border=1 style="border-collapse: collapse;" cellspacing=0 cellpadding=2 width=100%
|-
!bgcolor=#d0d0e0 width="1%"|No.
!bgcolor=#d0d0e0 width="21%"|Fan Mission Title
!bgcolor=#d0d0e0 width="11%"|Author(s)
!bgcolor=#d0d0e0 width="4%" class="unsortable"|Forum link
!bgcolor=#d0d0e0 width="5%"|Releases
!bgcolor=#d0d0e0 width="5%"|Mission Type
!bgcolor=#d0d0e0 width="5%"|Notes
|-

|-
|{{TDM-FM|factoryheist|1}}
!align=left|[[The Factory Heist (FM)|The Factory Heist]]
|[[:Category:Missions by thebigh|thebigh]]
|{{Forumlink|https://forums.thedarkmod.com/index.php?/topic/20562-the-factory-heist-12-sep-2020/}}
|2020-09-12
|Warehouse
|
|-
|-
|{{TDM-FM|housecall|2}}
!align=left|[[A House Call (FM)|A House Call]]
|[[:Category:Missions by thebigh|thebigh]]
|{{Forumlink|https://forums.thedarkmod.com/index.php?/topic/21329-a-house-call-by-thebigh-mar-10-2022/}}
|2022-03-10
|Mansion/Estate
|
|-
|-
|{{TDM-FM|delisle|3}}
!align=left|[[The House of deLisle (FM)|The House of deLisle]]
|[[:Category:Missions by thebigh|thebigh]]
|{{Forumlink|https://forums.thedarkmod.com/index.php?/topic/22227-fan-mission-the-house-of-delisle/}}
|2023-10-01
|Mansion/Estate, City Missions
|
|-
|}

=== ''The Hare in the Snare'' series ===

* '''Release:''' Single-mission (S)
* '''Series' characters:'''
* '''Series' status:''' Planned to continue.

{|class="wikitable sortable" border=1 style="border-collapse: collapse;" cellspacing=0 cellpadding=2 width=100%
|-
!bgcolor=#d0d0e0 width="1%"|No.
!bgcolor=#d0d0e0 width="21%"|Fan Mission Title
!bgcolor=#d0d0e0 width="11%"|Author(s)
!bgcolor=#d0d0e0 width="4%" class="unsortable"|Forum link
!bgcolor=#d0d0e0 width="5%"|Releases
!bgcolor=#d0d0e0 width="5%"|Mission Type
!bgcolor=#d0d0e0 width="5%"|Notes
|-

|-
|{{TDM-FM|hareinthesnare|1}}
!align=left|[[The Hare in the Snare: Part 1 (FM)|The Hare in the Snare: Part 1]]
|[[:Category:Missions by Frost_Salamander|Frost_Salamander]] & [[:Category:Missions by Kerry000|Kerry000]]
|{{Forumlink|https://forums.thedarkmod.com/index.php?/topic/20883-fan-mission-the-hare-in-the-snare-part-1}}
|2021-04-09
|City Missions <br> Inn/Tavern
|
|-
|}

=== ''Hidden Hands'' series ===

* '''Release:''' Single-mission (S)
* '''Series' characters:''' TBA
* '''Series' status:''' TBA

{|class="wikitable sortable" border=1 style="border-collapse: collapse;" cellspacing=0 cellpadding=2 width=100%
|-
!bgcolor=#d0d0e0 width="1%"|No.
!bgcolor=#d0d0e0 width="21%"|Fan Mission Title
!bgcolor=#d0d0e0 width="11%"|Author(s)
!bgcolor=#d0d0e0 width="4%" class="unsortable"|Forum link
!bgcolor=#d0d0e0 width="5%"|Releases
!bgcolor=#d0d0e0 width="5%"|Mission Type
!bgcolor=#d0d0e0 width="5%"|Notes
|-

|-
|{{TDM-FM|hhi|1}}
!align=left|[[Hidden Hands 1: Initiation (FM)|Initiation]]
|[[:Category:Missions by JackFarmer|JackFarmer]]
|{{Forumlink|http://forums.thedarkmod.com/index.php?/topic/19796-hidden-hands-initiation-27122018/}}
|2018-12-27
|Mansion/Estate <br> Ship
|
|-
|-
|{{TDM-FM|hhvf|2}}
!align=left|[[Hidden Hands 2: Vitalic Fever (FM)|Vitalic Fever]]
|[[:Category:Missions by JackFarmer|JackFarmer]]
|{{Forumlink|http://forums.thedarkmod.com/index.php?/topic/20051-hidden-hands-vitalic-fever-20072019/}}
|2019-07-20
|Mansion/Estate
|
|-
|-
|{{TDM-FM|hhtlc|3}}
!align=left|[[Hidden Hands 3: The Lost Citadel (FM)|The Lost Citadel]]
|[[:Category:Missions by JackFarmer|JackFarmer]]
|{{Forumlink|https://forums.thedarkmod.com/index.php?/topic/20490-hidden-hands-the-lost-citadel-23072020}}
|2020-07-23
|Castle/Fortress
|
|-
|-
|-
|{{TDM-FM|hhta|4}}
!align=left|[[Hidden Hands 4: The Anomaly (FM)|The Anomaly]]
|[[:Category:Missions by JackFarmer|JackFarmer]]
|{{Forumlink|https://forums.thedarkmod.com/index.php?/topic/20909-hidden-hands-the-anomaly}}
|2021-05-01
|Castle/Fortress <br> Forest
|
|-
|-
|}

=== ''In A Time of Need'' series ===

* '''Release:''' Single-mission (S)
* '''Series' characters:''' [[Thief_Characters#Terry|Terry]] (supporting)
* '''Series' status:''' TBA

{|class="wikitable sortable" border=1 style="border-collapse: collapse;" cellspacing=0 cellpadding=2 width=100%
|-
!bgcolor=#d0d0e0 width="1%"|No.
!bgcolor=#d0d0e0 width="21%"|Fan Mission Title
!bgcolor=#d0d0e0 width="11%"|Author(s)
!bgcolor=#d0d0e0 width="4%" class="unsortable"|Forum link
!bgcolor=#d0d0e0 width="5%"|Releases
!bgcolor=#d0d0e0 width="5%"|Mission Type
!bgcolor=#d0d0e0 width="5%"|Notes
|-

|-
|{{TDM-FM|timeofneed|1}}
!align=left|[[In A Time of Need 1 (FM)|In A Time Of Need]]
|[[:Category:Missions by Kyyrma|Kyyrma]]
|{{Forumlink|http://forums.thedarkmod.com/topic/15354-fan-mission-in-a-time-of-need-by-kyyrma-20131112/}}
|2013-11-12
|Mansion/Estate
|
|-

|-
|{{TDM-FM|breakingout|2}}
!align=left|[[In A Time of Need 2: Breaking Out the Fence (FM)|Breaking Out the Fence]]
|[[:Category:Missions by Kyyrma|Kyyrma]]
|{{Forumlink|http://forums.thedarkmod.com/topic/16091-fan-mission-breaking-out-the-fence-17032014-by-kyyrma/}}
|2014-03-17
|City Missions
|
|-
|}

=== ''Master thief Corso'' series ===

* '''Release:''' Single-mission (S)
* '''Series' characters:''' [[Thief Characters#Corso|Corso]] (protagonist), [[Thief Characters#Mingus|Mingus]] (background, supporting)
* '''Series' status:''' On hiatus.

{|class="wikitable sortable" border=1 style="border-collapse: collapse;" cellspacing=0 cellpadding=2 width=100%
|-
!bgcolor=#d0d0e0 width="1%"|No.
!bgcolor=#d0d0e0 width="21%"|Fan Mission Title
!bgcolor=#d0d0e0 width="11%"|Author(s)
!bgcolor=#d0d0e0 width="4%" class="unsortable"|Forum link
!bgcolor=#d0d0e0 width="5%"|Releases
!bgcolor=#d0d0e0 width="5%"|Mission Type
!bgcolor=#d0d0e0 width="5%"|Notes
|-

|-
|{{TDM-FM|lockner|1}}
!align=left|[[Lockner Manor (FM)|Lockner Manor]]
|[[:Category:Missions by Buck28|buck28]]
|{{Forumlink|http://forums.thedarkmod.com/topic/16452-new-mission-lockner-manor/}}
|2014-08-02
|Mansion/Estate <br> Inn/Tavern
|
|-

|-
|{{TDM-FM|briarwood|2}}
!align=left|[[Briarwood Cathedral (FM)|Briarwood Cathedral]]
|[[:Category:Missions by Buck28|buck28]]
|{{Forumlink|http://forums.thedarkmod.com/topic/16644-briarwood-cathedral/}}
|2014-10-29
|Church/Cathedral <br> Horror
|Winner of the [[Fan Mission Contests#2014 Halloween Speed-build Contest|2014 Halloween Speed-build Contest]].
|-
|}

=== ''No Honor Among Thieves'' campaign ===

* '''Release:''' Campaign (C)
* '''Series' characters:''' TBA
* '''Series' status:''' TBA

{|class="wikitable sortable" border=1 style="border-collapse: collapse;" cellspacing=0 cellpadding=2 width=100%
|-
!bgcolor=#d0d0e0 width="1%"|No.
!bgcolor=#d0d0e0 width="21%"|Fan Mission Title
!bgcolor=#d0d0e0 width="11%"|Author(s)
!bgcolor=#d0d0e0 width="4%" class="unsortable"|Forum link
!bgcolor=#d0d0e0 width="5%"|Releases
!bgcolor=#d0d0e0 width="5%"|Mission Type
!bgcolor=#d0d0e0 width="5%"|Notes
|-

|-
|{{TDM-FM|nhat3|1}}
!align=left|[[No Honor Among Thieves (FM)|Politics]]
|[[:Category:Missions by Goldchocobo|Goldchocobo]], [[:Category:Missions by RailGun|RailGun]], [[:Category:Missions by Mortem Desino|Mortem Desino]], [[:Category:Missions by Bikerdude|Bikerdude]]
|{{Forumlink|http://forums.thedarkmod.com/topic/10993-fan-mission-no-honor-among-thieves-20100429/}}
|2010-04-29 (original version), 2015-05-30 (current version, 3.0)
|Church/Cathedral
|
|-

|-
|{{TDM-FM|nhat3|2}}
!align=left|[[No Honor Among Thieves (FM)|A Night Out on the Town]]
|[[:Category:Missions by Goldchocobo|Goldchocobo]], [[:Category:Missions by RailGun|RailGun]], [[:Category:Missions by Mortem Desino|Mortem Desino]], [[:Category:Missions by Bikerdude|Bikerdude]]
|{{Forumlink|http://forums.thedarkmod.com/topic/10993-fan-mission-no-honor-among-thieves-20100429/}}
|2010-04-29 (original version), 2015-05-30 (current version, 3.0)
|City Missions
|
|-

|-
|{{TDM-FM|nhat3|3}}
!align=left|[[No Honor Among Thieves (FM)|No Honor Among Anyone <br> (a.k.a. Forest)]]
|[[:Category:Missions by Goldchocobo|Goldchocobo]], [[:Category:Missions by RailGun|RailGun]], [[:Category:Missions by Mortem Desino|Mortem Desino]], [[:Category:Missions by Bikerdude|Bikerdude]]
|{{Forumlink|http://forums.thedarkmod.com/topic/10993-fan-mission-no-honor-among-thieves-20100429/}}
|2010-04-29 (original version), 2015-05-30 (current version, 3.0)
|Outdoor/Pagan, Mansion/Estate
|
|-
|}

=== ''Of Brambles and Thorns'' series ===

* '''Release:''' Single-mission (S)
* '''Series' characters:''' TBA
* '''Series' status:''' TBA

{|class="wikitable sortable" border=1 style="border-collapse: collapse;" cellspacing=0 cellpadding=2 width=100%
|-
!bgcolor=#d0d0e0 width="1%"|No.
!bgcolor=#d0d0e0 width="21%"|Fan Mission Title
!bgcolor=#d0d0e0 width="11%"|Author(s)
!bgcolor=#d0d0e0 width="4%" class="unsortable"|Forum link
!bgcolor=#d0d0e0 width="5%"|Releases
!bgcolor=#d0d0e0 width="5%"|Mission Type
!bgcolor=#d0d0e0 width="5%"|Notes
|-

|-
|{{TDM-FM|onesteptoofar|1}}
!align=left|[[One Step Too Far (FM)|One Step Too Far]]
|[[:Category:Missions by Dragofer|Dragofer]]
|{{Forumlink|http://forums.thedarkmod.com/topic/16457-fan-mission-one-step-too-far-by-dragofer-20140804/}}
|2014-08-04
|Pirate <br> Horror
|
|-

|-
|{{TDM-FM|river|2}}
!align=left|[[Down by the Riverside (FM)|Down by the Riverside]]
|[[:Category:Missions by Dragofer|Dragofer]]
|{{Forumlink|http://forums.thedarkmod.com/topic/18402-fan-mission-down-by-the-riverside-by-dragofer-20160925/}}
|2016-09-25
|Mansion/Estate <br> Ship
|
|-
|}

=== ''Penny Dreadful'' series ===

* '''Release:''' Single-mission (S)
* '''Series' characters:''' Gerald Foxley (protagonist)
* '''Series' status:''' TBA

{|class="wikitable sortable" border=1 style="border-collapse: collapse;" cellspacing=0 cellpadding=2 width=100%
|-
!bgcolor=#d0d0e0 width="1%"|No.
!bgcolor=#d0d0e0 width="21%"|Fan Mission Title
!bgcolor=#d0d0e0 width="11%"|Author(s)
!bgcolor=#d0d0e0 width="4%" class="unsortable"|Forum link
!bgcolor=#d0d0e0 width="5%"|Releases
!bgcolor=#d0d0e0 width="5%"|Mission Type
!bgcolor=#d0d0e0 width="5%"|Notes
|-

|-
|{{TDM-FM|penny1_1|1}}
!align=left|[[Penny Dreadful 1: The Grail of Regrets (FM)|Penny Dreadful 1: The Grail of Regrets]]
|[[:Category:Missions by Melan|Melan]]
|{{Forumlink|http://forums.thedarkmod.com/topic/14952-fan-mission-penny-dreadful-by-melan-20130728/}}
|2013-07-27
|Horror
|
|-
|-
|{{TDM-FM|penny2_1|2}}
!align=left|[[Penny Dreadful 2: All the Way Up (FM)|Penny Dreadful 2: All the Way Up]]
|[[:Category:Missions by Melan|Melan]], [[:Category:Missions by Bikerdude|Bikerdude]]
|{{Forumlink|http://forums.thedarkmod.com/topic/16387-fan-mission-penny-dreadful-2-by-melan-and-bikerdude-2014078/}}
|2014-07-08
|Thieves' Highway (Rooftop)
|[https://www.youtube.com/watch?v=WmPfCfbeWvg Trailer]
|-
|-
|{{TDM-FM|penny3|3}}
!align=left|[[Penny Dreadful 3: Erasing the Trail (FM)|Penny Dreadful 3: Erasing the Trail]]
|[[:Category:Missions by Melan|Melan]], [[:Category:Missions by Bikerdude|Bikerdude]]
|{{Forumlink|http://forums.thedarkmod.com/topic/18200-fan-mission-penny-dreadful-3-by-melan-and-bikerdude-20160710/}}
|2016-07-09
|City Missions
|
|-
|}

=== ''Quinn Co.'' campaign ===

* '''Release:''' Campaign (C) (originally single mission (S))
* '''Series' characters:''' TBA
* '''Series' status:''' Completed and released.

{|class="wikitable sortable" border=1 style="border-collapse: collapse;" cellspacing=0 cellpadding=2 width=100%
|-
!bgcolor=#d0d0e0 width="1%"|No.
!bgcolor=#d0d0e0 width="21%"|Fan Mission Title
!bgcolor=#d0d0e0 width="11%"|Author(s)
!bgcolor=#d0d0e0 width="4%" class="unsortable"|Forum link
!bgcolor=#d0d0e0 width="5%"|Releases
!bgcolor=#d0d0e0 width="5%"|Mission Type
!bgcolor=#d0d0e0 width="5%"|Notes
|-

|-
|{{TDM-FM|quinn|1}}
!align=left|[[Quinn Co. (FM)|La Banque Bienveillante]]
|[[:Category:Missions by Airship Ballet|Airship Ballet]]
|{{Forumlink|http://forums.thedarkmod.com/topic/16702-fan-mission-la-banque-bienveillante-by-airship-ballet-20141122/}}
|2014-11-22 (original version), 2015-02-04 (current version, bundled with Chase Mercantile)
|Bank Jobs
|
|-
|-
|{{TDM-FM|quinn|2}}
!align=left|[[Quinn Co. (FM)|Chase Mercantile]]
|[[:Category:Missions by Airship Ballet|Airship Ballet]]
|{{Forumlink|http://forums.thedarkmod.com/topic/16912-fan-mission-chase-mercantile-by-airship-ballet-20150204/}}
|2015-02-04 (now bundled with La Banque Bienveillante)
|Bank Jobs
|
|-
|}

=== ''Sam Wilson'' series ===

* '''Release:''' Single-mission (S)
* '''Series' characters:''' [[Thief_Characters#Sam Wilson|Samuel "Sam" Wilson]] (protagonist)
* '''Series' status:''' Ongoing.

{|class="wikitable sortable" border=1 style="border-collapse: collapse;" cellspacing=0 cellpadding=2 width=100%
|-
!bgcolor=#d0d0e0 width="1%"|No.
!bgcolor=#d0d0e0 width="21%"|Fan Mission Title
!bgcolor=#d0d0e0 width="11%"|Author(s)
!bgcolor=#d0d0e0 width="4%" class="unsortable"|Forum link
!bgcolor=#d0d0e0 width="5%"|Releases
!bgcolor=#d0d0e0 width="5%"|Mission Type
!bgcolor=#d0d0e0 width="5%"|Notes
|-

|-
|{{TDM-FM|sw1_ebound|1}}
!align=left|[[Sam Wilson 1: Eastbound (FM)|Sam Wilson 1: Eastbound]]
|[[:Category:Missions by jonri|jonri]]
|{{Forumlink|https://forums.thedarkmod.com/index.php?/topic/21402-fan-mission-sam-wilson-1-eastbound-2022-05-07}}
|2022-05-07
|Train
|The first TDM FM to be set on a steam train.
|-
|}

=== ''Selis Woderose'' series ===

* '''Release:''' Single-mission (S)
* '''Series' characters:''' [[Thief_Characters#Selis_Woderose|Selis Woderose]] (protagonist)
* '''Series' status:''' Currently on hiatus.

{|class="wikitable sortable" border=1 style="border-collapse: collapse;" cellspacing=0 cellpadding=2 width=100%
|-
!bgcolor=#d0d0e0 width="1%"|No.
!bgcolor=#d0d0e0 width="21%"|Fan Mission Title
!bgcolor=#d0d0e0 width="11%"|Author(s)
!bgcolor=#d0d0e0 width="4%" class="unsortable"|Forum link
!bgcolor=#d0d0e0 width="5%"|Releases
!bgcolor=#d0d0e0 width="5%"|Mission Type
!bgcolor=#d0d0e0 width="5%"|Notes
|-

|-
|{{TDM-FM|flakebridge|1}}
!align=left|[[Selis Woderose 1: Flakebridge Monastery (FM)|Flakebridge Monastery]]
|[[:Category:Missions by Jesps|Jesps]]
|{{Forumlink|http://forums.thedarkmod.com/topic/11991-fm-flakebridge-monastery-by-jesps/}}
|2010-12-05
|Church/Cathedral
|
|-
|-
|{{TDM-FM|rake_off|2}}
!align=left|[[Selis Woderose 2: Rake-off (FM)|Rake-off]]
|[[:Category:Missions by Jesps|Jesps]]
|{{Forumlink|http://forums.thedarkmod.com/topic/12846-fm-rake-off-19-06-2011/}}
|2011-06-19
|Castle/Fortress
|
|-
|}

=== ''Shadowcursed'' series ===

* '''Release:''' Single-mission (S) for the first mission and Campaign (C) for the second mission.
* '''Series' characters:''' [[Thief_Characters#Bolen|Bolen]] (protagonist)
* '''Series' status:''' Ongoing, currently on hiatus.
* '''Ancilliary materials:''' ''[http://www.amazon.com/Shadowcursed-ebook/dp/B00BYEW02M Shadowcursed]'' novella (e-book)

{|class="wikitable sortable" border=1 style="border-collapse: collapse;" cellspacing=0 cellpadding=2 width=100%
|-
!bgcolor=#d0d0e0 width="1%"|No.
!bgcolor=#d0d0e0 width="21%"|Fan Mission Title
!bgcolor=#d0d0e0 width="11%"|Author(s)
!bgcolor=#d0d0e0 width="4%" class="unsortable"|Forum link
!bgcolor=#d0d0e0 width="5%"|Releases
!bgcolor=#d0d0e0 width="5%"|Mission Type
!bgcolor=#d0d0e0 width="5%"|Notes
|-

|-
|{{TDM-FM|requiem|1}}
!align=left|[[Requiem (FM)|Requiem]]
|[[:Category:Missions by Moonbo|Moonbo]]
|{{Forumlink|http://forums.thedarkmod.com/topic/15101-fan-mission-requiem-by-gelo-moonbo-fleisher-2013106/}}
|2013-10-08
|Church/Cathedral <br> Lost Civilizations
|[https://web.archive.org/web/20160409012413/https://community.eidosmontreal.com/blogs/thief-mod-winners Winner] of the 2014 official ''[http://forums.thedarkmod.com/topic/15956-square-enix-and-amazoncom-announce-thief-mod-contest/ Thief Mod Competition]'' by Square Enix & Amazon.com.
|-
|-
|{{TDM-FM|ahouseoflockedsecrets|2}}
!align=left|[[A House of Locked Secrets (FM)|A House of Locked Secrets]]
|[[:Category:Missions by Moonbo|Moonbo]]
|{{Forumlink|http://forums.thedarkmod.com/topic/17163-fan-mission-a-house-of-locked-secrets-by-gelo-moonbo-fleisher-20150528/}}
|2015-05-29
|Church/Cathedral <br> Mansion/Estate
|[https://www.youtube.com/watch?v=f5NuTJEZ8VE Trailer]
|-
|}

=== ''Shadows of Northdale'' series ===

* '''Release:''' Single-mission (S)
* '''Series' characters:''' [[Thief Characters#Corbin|Corbin]] (protagonist)
* '''Series' status:''' Ongoing, currently in gradual development.

{|class="wikitable sortable" border=1 style="border-collapse: collapse;" cellspacing=0 cellpadding=2 width=100%
|-
!bgcolor=#d0d0e0 width="1%"|No.
!bgcolor=#d0d0e0 width="21%"|Fan Mission Title
!bgcolor=#d0d0e0 width="11%"|Author(s)
!bgcolor=#d0d0e0 width="4%" class="unsortable"|Forum link
!bgcolor=#d0d0e0 width="5%"|Releases
!bgcolor=#d0d0e0 width="5%"|Mission Type
!bgcolor=#d0d0e0 width="5%"|Notes
|-

|-
|{{TDM-FM|northdale1|1}}
!align=left|[[Shadows of Northdale Act I (FM)|Shadows of Northdale ACT I: <br> A Curious Mind]]
|[[:Category:Missions by Goldwell|Goldwell]]
|{{Forumlink|http://forums.thedarkmod.com/topic/19368-fan-mission-shadows-of-northdale-act-i-by-goldwell-20180323/}}
|2018-03-23
|City Missions
|[https://www.youtube.com/watch?v=p4nP3lYd6wg Briefing]
|-

|-
|{{TDM-FM|northdale2|2}}
!align=left|[[Shadows of Northdale Act II (FM)|Shadows of Northdale ACT II: <br> Down the Rabbit Hole]]
|[[:Category:Missions by Goldwell|Goldwell]]
|{{Forumlink|http://forums.thedarkmod.com/topic/19936-fan-mission-shadows-of-northdale-act-ii-by-goldwell-20190320/}}
|2019-03-20
|City Missions
|[https://www.youtube.com/watch?v=KO-eIOX9nqI Briefing]
|-
|}

=== ''St Alban'' series ===

* '''Release:''' Single-mission (S)
* '''Series' characters:''' TBA
* '''Series' status:''' TBA

{|class="wikitable sortable" border=1 style="border-collapse: collapse;" cellspacing=0 cellpadding=2 width=100%
|-
!bgcolor=#d0d0e0 width="1%"|No.
!bgcolor=#d0d0e0 width="21%"|Fan Mission Title
!bgcolor=#d0d0e0 width="11%"|Author(s)
!bgcolor=#d0d0e0 width="4%" class="unsortable"|Forum link
!bgcolor=#d0d0e0 width="5%"|Releases
!bgcolor=#d0d0e0 width="5%"|Mission Type
!bgcolor=#d0d0e0 width="5%"|Notes
|-

|-
|{{TDM-FM|caduceus|1}}
!align=left|[[St Alban 1: The Caduceus of St Alban (FM)|The Caduceus of St. Alban]]
|[[:Category:Missions by Bikerdude|Bikerdude]]
|{{Forumlink|http://forums.thedarkmod.com/topic/11644-the-caduceus-of-st-alban-vertical-fm-contest-entry-aug-8th-2010/}}
|2010-08-23 (original version), 2010-08-26 (version 1.5.5)
|Church/Cathedral
|
|-
|-
|{{TDM-FM|cathedral|2}}
!align=left|[[St Alban 2: St Albans Cathedral (FM)|St. Albans Cathedral]]
|[[:Category:Missions by Bikerdude|Bikerdude]]
|{{Forumlink|http://forums.thedarkmod.com/topic/16343-fan-mission-st-albans-cathedral-v20-11062014/}} (current, 2.0 version)
|2010-11-01 (original version), 2014-06-11 (version 2.0)
|Church/Cathedral
|
|-
|}

=== ''Talbot'' series ===

* '''Release:''' Single-mission (S)
* '''Series' characters:''' Talbot
* '''Series' status:''' Ongoing, currently on hiatus.

{|class="wikitable sortable" border=1 style="border-collapse: collapse;" cellspacing=0 cellpadding=2 width=100%
|-
!bgcolor=#d0d0e0 width="1%"|No.
!bgcolor=#d0d0e0 width="21%"|Fan Mission Title
!bgcolor=#d0d0e0 width="11%"|Author(s)
!bgcolor=#d0d0e0 width="4%" class="unsortable"|Forum link
!bgcolor=#d0d0e0 width="5%"|Releases
!bgcolor=#d0d0e0 width="5%"|Mission Type
!bgcolor=#d0d0e0 width="5%"|Notes
|-

|-
|{{TDM-FM|returntothecity|1}}
!align=left|[[Talbot 2: Return to the City (FM)|Return to the City]]
|[[:Category:Missions by Melan|Melan]]
|{{Forumlink|http://forums.thedarkmod.com/topic/10509-fan-mission-return-to-the-city-by-melan-20100110/}} (original version), {{Forumlink|http://forums.thedarkmod.com/topic/12390-fan-mission-return-to-the-city-v2-01032011/}} (version 2.0)
|2010-01-10 (original version), 2015-01-03 (2.0), 2015-01-03 (current version, 3.0)
|City Missions
|Winner of the [[Fan Mission Contests#2009 Grand Christmas Contest|2009 Grand Christmas Contest]].
|-
|-
|{{TDM-FM|fauchard1_1|2}}
!align=left|[[Talbot 3: Fiasco at Fauchard Street (FM)|Fiasco at Fauchard Street]]
|[[:Category:Missions by Melan|Melan]]
|{{Forumlink|http://forums.thedarkmod.com/topic/12655-fan-mission-fiasco-at-fauchard-street-by-melan-20110501/}}
|2011-05-01
|Thieves' Highway (Rooftop)
|
|-
|}

'''''Note:''' [[Sir Talbot's Collateral (FM)|Sir Talbot's Collateral]] by Bikerdude and Baal is actually an unrelated mission, just with a similarly named character.''

=== ''The Lieutenant'' series ===

* '''Release:''' Single-mission (S)
* '''Description:''' The series follows the cases of an intelligence officer.
* '''Series' characters:''' The titular Lieutenant
* '''Series' status:''' Ongoing.

{|class="wikitable sortable" border=1 style="border-collapse: collapse;" cellspacing=0 cellpadding=2 width=100%
|-
!bgcolor=#d0d0e0 width="1%"|No.
!bgcolor=#d0d0e0 width="21%"|Fan Mission Title
!bgcolor=#d0d0e0 width="11%"|Author(s)
!bgcolor=#d0d0e0 width="4%" class="unsortable"|Forum link
!bgcolor=#d0d0e0 width="5%"|Releases
!bgcolor=#d0d0e0 width="5%"|Mission Type
!bgcolor=#d0d0e0 width="5%"|Notes
|-
|-
|{{TDM-FM|inplainsight|1}}
!align=left|[[The Lieutenant 1: In Plain Sight (FM)|The Lieutenant 1: In Plain Sight]]
|[[:Category:Missions by Frost_Salamander|Frost_Salamander]]
|{{Forumlink|https://forums.thedarkmod.com/index.php?/topic/21549-fan-mission-in-plain-sight-by-frost_salamander-20220807}}
|2022-08-07
|City Missions
|
|-
|-
|{{TDM-FM|highex|2}}
!align=left|[[The Lieutenant 2: High Expectations (FM)|The Lieutenant 2: High Expectations]]
|[[:Category:Missions by Frost_Salamander|Frost_Salamander]]
|{{Forumlink|https://forums.thedarkmod.com/index.php?/topic/21837-fan-mission-the-lieutenant-2-high-expectations-by-frost_salamander-20230424}}
|2023-04-24
|Mansion/Estate <br> City Missions
|
|-
|-
|{{TDM-FM|foreignaffaris|3}}
!align=left|[[The Lieutenant 3: Foreign Affairs (FM)|The Lieutenant 3: Foreign Affairs]]
|[[:Category:Missions by Frost_Salamander|Frost_Salamander]]
|{{Forumlink|https://forums.thedarkmod.com/index.php?/topic/22452-fan-mission-the-lieutenant-3-foreign-affairs-by-frost_salamander}}
|2024/11/08
|City Missions, Moorish Architecture
|
|-
|-
|{{TDM-FM|reciprocalgambit|4}}
!align=left|[[The Lieutenant 4: A Reciprocal Gambit (FM)|The Lieutenant 4: A Reciprocal Gambit]]
|[[:Category:Missions by Frost_Salamander|Frost_Salamander]]
|{{Forumlink|https://forums.thedarkmod.com/index.php?/topic/22945-fan-mission-the-lieutenant-4-a-reciprocal-gambit-by-frost_salamander}}
|2025-06-18
|City Missions, Mansion/Estate
|
|-
|}

=== ''Thief's Den'' series ===

* '''Release:''' Single-mission (S)
* '''Description:''' The ''de facto'' oldest FM series in ''The Dark Mod''. Follow the skillful thief Farrell as he navigates the criminal underworld of [[The City|Bridgeport]] and the surrounding world.
* '''Series' characters:''' [[Thief Characters#Farrell|Farrell]] (protagonist), [[Thief Characters#Sebastian_Creep|Sebastian Creep]] (supporting)
* '''Series' status:''' Currently on hiatus.

{|class="wikitable sortable" border=1 style="border-collapse: collapse;" cellspacing=0 cellpadding=2 width=100%
|-
!bgcolor=#d0d0e0 width="1%"|No.
!bgcolor=#d0d0e0 width="21%"|Fan Mission Title
!bgcolor=#d0d0e0 width="11%"|Author(s)
!bgcolor=#d0d0e0 width="4%" class="unsortable"|Forum link
!bgcolor=#d0d0e0 width="5%"|Releases
!bgcolor=#d0d0e0 width="5%"|Mission Type
!bgcolor=#d0d0e0 width="5%"|Notes
|-
|-
|{{TDM-FM|thiefsden|1}}
!align=left|[[Thief's Den 1: Thief's Den (FM)|Thief's Den]]
|[[:Category:Missions by Fidcal|Fidcal]], [[:Category:Missions by Greebo|Greebo]]
|{{Forumlink|http://forums.thedarkmod.com/topic/11347-fan-mission-thiefs-den-re-release-by-fidcal20100704/}}
|2008-01-18 (original version), 2010-07-04 (version 2.0)
|City Missions
|
|-
|-
|{{TDM-FM|chalice1_1|2}}
!align=left|[[Thief's Den 2: The Chalice of Kings (FM)|The Chalice of Kings]]
|[[:Category:Missions by Fidcal|Fidcal]] (original version), [[:Category:Missions by Bikerdude|Bikerdude]], [[:Category:Missions by Xarg|Xarg]] (edits, version 2.0)
|{{Forumlink|http://forums.thedarkmod.com/topic/9935-fan-mission-chalice-of-kings-by-fidcal-20091017/}}
|2009-10-15 (original version), 2015-09-24 (version 2.0)
|Castle/Fortress
|
|-
|-
|{{TDM-FM|heartv2|3}}
!align=left|[[Thief's Den 3: The Heart of Lone Salvation (FM)|The Heart of Lone Salvation]]
|[[:Category:Missions by Fidcal|Fidcal]], Baddcog, [[:Category:Missions by Bikerdude|Bikerdude]]
|{{Forumlink|http://forums.thedarkmod.com/topic/10878-fan-mission-the-heart-of-lone-salvation-by-fidcal-baddcog-bikerdude-20100402/}}
|2010-04-02 (original version), 2014-04-12 (version 2.0)
|City Missions
|
|-
|-
|{{TDM-FM|alchemist|4}}
!align=left|[[Thief's Den 4: The Alchemist (FM)|The Alchemist]]
|[[:Category:Missions by Sotha|Sotha]], [[:Category:Missions by Fidcal|Fidcal]]
|{{Forumlink|http://forums.thedarkmod.com/topic/11170-fan-mission-the-alchemist-by-sotha-fidcal20100601/}}
|2010-06-01 (original version) 2010-06-04 (update)
|City Missions
|
|-
|}

=== ''Thomas Porter'' series ===

* '''Release:''' Single-mission (S)
* '''Series' characters:''' [[Thief_Characters#Thomas Porter|Thomas Porter]] (protagonist), [[Thief_Characters#Lark Butternose|Lark Butternose]] (supporting), [[Noble/Wealthy_Characters#Godfrey_Knighton|Godfrey Knighton]] (background)
* '''Series' status:''' Concluded.
* '''Overview:''' [http://forums.thedarkmod.com/topic/15179-the-thomas-porter-series/ Courtesy of] Sotha.

{|class="wikitable sortable" border=1 style="border-collapse: collapse;" cellspacing=0 cellpadding=2 width=100%
|-
!bgcolor=#d0d0e0 width="1%"|No.
!bgcolor=#d0d0e0 width="21%"|Fan Mission Title
!bgcolor=#d0d0e0 width="11%"|Author(s)
!bgcolor=#d0d0e0 width="4%" class="unsortable"|Forum link
!bgcolor=#d0d0e0 width="5%"|Releases
!bgcolor=#d0d0e0 width="5%"|Mission Type
!bgcolor=#d0d0e0 width="5%"|Notes
|-

|-
|{{TDM-FM|mandrasola|1}}
!align=left|[[Thomas Porter 1: Mandrasola (FM)|Mandrasola]]
|[[:Category:Missions by Sotha|Sotha]]
|{{Forumlink|http://forums.thedarkmod.com/topic/12575-fan-mission-mandrasola-by-sotha-20110410/}}
|2011-04-10
|City Missions
|
|-
|-
|{{TDM-FM|knighton_manor|2}}
!align=left|[[Thomas Porter 2: Knighton Manor (FM)|Knighton Manor]]
|[[:Category:Missions by Sotha|Sotha]]
|{{Forumlink|http://forums.thedarkmod.com/topic/11898-fan-mission-the-knighton-manor-by-sotha-20101109/}}
|2010-11-09
|Mansion/Estate
|
|-
|-
|{{TDM-FM|beleaguered_fence|3}}
!align=left|[[Thomas Porter 3: The Beleaguered Fence (FM)|The Beleaguered Fence]]
|[[:Category:Missions by Sotha|Sotha]]
|{{Forumlink|http://forums.thedarkmod.com/topic/11298-fan-mission-the-beleaguered-fence-by-sotha-20100623/}}
|2010-06-23
|Jail/Prison
|
|-
|-
|{{TDM-FM|glenham_tower|4}}
!align=left|[[Thomas Porter 4: Glenham Tower (FM)|Glenham Tower]]
|[[:Category:Missions by Sotha|Sotha]]
|{{Forumlink|http://forums.thedarkmod.com/topic/11423-fan-mission-the-glenham-tower-by-sotha-20100717/}}
|2010-07-17
|Castle/Fortress <br> Horror
|Winner of the [[Fan_Mission_Contests#2010_Summer_Vertical_Contest|2010 Summer Vertical Contest]].
|-
|-
|{{TDM-FM|transaction|5}}
!align=left|[[Thomas Porter 5: The Transaction (FM)|The Transaction]]
|[[:Category:Missions by Sotha|Sotha]]
|{{Forumlink|http://forums.thedarkmod.com/topic/12408-fan-mission-the-transaction-by-sotha-20110304/}}
|2011-03-04
|City Missions
|
|-
|-
|{{TDM-FM|phrase_book|6}}
!align=left|[[Thomas Porter 6: The Phrase Book (FM)|The Phrase Book]]
|[[:Category:Missions by Sotha|Sotha]]
|{{Forumlink|http://forums.thedarkmod.com/topic/13799-fan-mission-the-phrase-book-by-sotha-20120512/}}
|2012-05-11
|City Missions <br> Thieves' Highway (Rooftop)
|
|-
|-
|{{TDM-FM|lich_queens_demise|7}}
!align=left|[[Thomas Porter 7: The Lich Queen's Demise (FM)|The Lich Queen's Demise]]
|[[:Category:Missions by Sotha|Sotha]]
|{{Forumlink|http://forums.thedarkmod.com/topic/14826-fan-mission-the-lich-queens-demise-by-sotha-20130520/}}
|2013-05-20
|Horror
|
|-
|}

=== ''Ulysses'' series ===

* '''Release:''' Single-mission (S)
* '''Series' characters:''' Ulysses (protagonist)
* '''Series' status:''' TBA

{|class="wikitable sortable" border=1 style="border-collapse: collapse;" cellspacing=0 cellpadding=2 width=100%
|-
!bgcolor=#d0d0e0 width="1%"|No.
!bgcolor=#d0d0e0 width="21%"|Fan Mission Title
!bgcolor=#d0d0e0 width="11%"|Author(s)
!bgcolor=#d0d0e0 width="4%" class="unsortable"|Forum link
!bgcolor=#d0d0e0 width="5%"|Releases
!bgcolor=#d0d0e0 width="5%"|Mission Type
!bgcolor=#d0d0e0 width="5%"|Notes
|-

|-
|{{TDM-FM|ulysses_genesis|1}}
!align=left|[[Ulysses 1: Genesis (FM)|Ulysses: Genesis]]
|[[:Category:Missions by Sotha|Sotha]]
|{{Forumlink|http://forums.thedarkmod.com/topic/16428-fan-mission-ulysses-genesis-by-sotha-20140724/}}
|2014-07-24
|Mansion/Estate
|
|-

|-
|{{TDM-FM|u2_flock|2}}
!align=left|[[Ulysses 2: Protecting the Flock (FM)|Ulysses: Protecting the Flock]]
|[[:Category:Missions by Sotha|Sotha]]
|{{Forumlink|http://forums.thedarkmod.com/topic/17162-fan-mission-ulysses-2-protecting-the-flock-by-sotha-20150528/}}
|2015-05-28
|Church/Cathedral
|
|-
|}

=== ''Vengeance for a Thief'' campaign ===

* '''Release:''' Single-mission (S) for the first two published missions, Campaign (C) for the final release that also includes a new first mission.
* '''Series' characters:''' TBA
* '''Series' status:''' TBA

{|class="wikitable sortable" border=1 style="border-collapse: collapse;" cellspacing=0 cellpadding=2 width=100%
|-
!bgcolor=#d0d0e0 width="1%"|No.
!bgcolor=#d0d0e0 width="21%"|Fan Mission Title
!bgcolor=#d0d0e0 width="11%"|Author(s)
!bgcolor=#d0d0e0 width="4%" class="unsortable"|Forum link
!bgcolor=#d0d0e0 width="5%"|Releases
!bgcolor=#d0d0e0 width="5%"|Mission Type
!bgcolor=#d0d0e0 width="5%"|Notes
|-

|-
|{{TDM-FM|vfat3|1}}
!align=left|[[Vengeance for a Thief (FM)|The Angel's Tear]]
|[[:Category:Missions by Sir Taffsalot|Sir Taffsalot]]
|{{Forumlink|http://forums.thedarkmod.com/topic/16953-the-complete-vengeance-for-a-thief-campaign/}}
|2015-02-16
|Church/Cathedral
|
|-

|-
|{{TDM-FM|vfat1|2}}
!align=left|[[Vengeance for a Thief (FM)|A Pawn in the Game]]
|[[:Category:Missions by Sir Taffsalot|Sir Taffsalot]]
|{{Forumlink|http://forums.thedarkmod.com/topic/14068-fan-mission-vengeance-for-a-thief-part-1-by-sir-taffsalot-06092012/}}
|2012-09-06
|Jail/Prison
|
|-

|-
|{{TDM-FM|vfat2|3}}
!align=left|[[Vengeance for a Thief (FM)|The Art of Revenge]]
|[[:Category:Missions by Sir Taffsalot|Sir Taffsalot]]
|{{Forumlink|http://forums.thedarkmod.com/topic/15051-fan-mission-vengeance-for-a-thief-part-2-by-sir-taffsalot-06092013/}}
|2013-09-06
|Museum Heists
|
|-

|}

=== ''Volta'' series ===

* '''Release:''' Single-mission (S)
* '''Series' characters:''' TBA
* '''Series' status:''' TBA

{|class="wikitable sortable" border=1 style="border-collapse: collapse;" cellspacing=0 cellpadding=2 width=100%
|-
!bgcolor=#d0d0e0 width="1%"|No.
!bgcolor=#d0d0e0 width="21%"|Fan Mission Title
!bgcolor=#d0d0e0 width="11%"|Author(s)
!bgcolor=#d0d0e0 width="4%" class="unsortable"|Forum link
!bgcolor=#d0d0e0 width="5%"|Releases
!bgcolor=#d0d0e0 width="5%"|Mission Type
!bgcolor=#d0d0e0 width="5%"|Notes
|-

|-
|{{TDM-FM|volta1_3|1}}
!align=left|[[Volta I: The Stone (FM)|Volta and the Stone]]
|[[:Category:Missions by Kingsal|Kingsal]]
|{{Forumlink|http://forums.thedarkmod.com/topic/18087-fan-mission-volta-and-the-stone-by-kingsal-05262016/}}
|2016-05-27
|Mansion/Estate <br> City Missions
|
|-

|-
|{{TDM-FM|cauldron_v2_2|2}}
!align=left|[[Volta II: Cauldron of the Gods (FM)|Volta 2: Cauldron of the Gods]]
|[[:Category:Missions by Kingsal|Kingsal]]
|{{Forumlink|http://forums.thedarkmod.com/topic/19207-fan-mission-volta-ii-cauldron-of-the-gods-by-kingsal-113017-update-v20/}}
|2017-11-30
|Lost Civilizations
|[https://www.youtube.com/watch?v=SRRCRVFHruc Briefing]
|-
|}

=== ''William Steele'' series ===

* '''Release:''' Single-mission (S)
* '''Series' characters:''' [[Thief_Characters#William_Steele|William Steele]] (protagonist)
* '''Series' status:''' Concluded.

{|class="wikitable sortable" border=1 style="border-collapse: collapse;" cellspacing=0 cellpadding=2 width=100%
|-
!bgcolor=#d0d0e0 width="1%"|No.
!bgcolor=#d0d0e0 width="21%"|Fan Mission Title
!bgcolor=#d0d0e0 width="11%"|Author(s)
!bgcolor=#d0d0e0 width="4%" class="unsortable"|Forum link
!bgcolor=#d0d0e0 width="5%"|Releases
!bgcolor=#d0d0e0 width="5%"|Mission Type
!bgcolor=#d0d0e0 width="5%"|Notes
|-

|-
|{{TDM-FM|ws1_north|1}}
!align=left|[[William Steele 1: In the North (FM)|In the North]]
|[[:Category:Missions by Grayman|grayman]]
|{{Forumlink|http://forums.thedarkmod.com/topic/14214-fan-mission-in-the-north-by-grayman-20121020/}}
|2012-10-20
|Mansion/Estate
|
|-

|-
|{{TDM-FM|ws2_homeagain|2}}
!align=left|[[William Steele 2: Home Again (FM)|Home Again]]
|[[:Category:Missions by Grayman|grayman]]
|{{Forumlink|http://forums.thedarkmod.com/topic/15919-fan-mission-home-again-by-grayman-2014212/}}
|2014-02-12
|Thieves' Highway (Rooftop)
|
|-

|-
|{{TDM-FM|ws3_cleighmoor|3}}
!align=left|[[William Steele 3: Cleighmoor (FM)|Cleighmoor]]
|[[:Category:Missions by Grayman|grayman]]
|{{Forumlink|http://forums.thedarkmod.com/topic/16011-fan-mission-cleighmoor-by-grayman-201431/}}
|2014-03-01
|Sewers <br> Jail/Prison
|
|-

|-
|{{TDM-FM|ws4_warrens|4}}
!align=left|[[William Steele 4: The Warrens (FM)|The Warrens]]
|[[:Category:Missions by Grayman|grayman]]
|{{Forumlink|http://forums.thedarkmod.com/topic/19618-fan-mission-the-warrens-by-grayman-201891/}}
|2018-09-01
|City Missions
|
|-

|-
|{{TDM-FM|ws5_commerce|5}}
!align=left|[[William Steele 5: Commerce Bank (FM)|Commerce Bank]]
|[[:Category:Missions by Grayman|grayman]]
|{{Forumlink|http://forums.thedarkmod.com/topic/19957-fan-mission-commerce-bank-by-grayman-2019410/}}
|2019-04-10
|Bank Jobs
|
|-

|}

== Note ==

For a key to the descriptions of each Mission Type, please see [[Fan_Missions_for_The_Dark_Mod#Table_notes|this overview]].

== See also ==

*[[Fan Missions for The Dark Mod]] - Main article on TDM fan missions.

[[Category:Fan Missions|S]]

The Parts and Whole: DR Filters

2025-12-10T00:05:37Z

Datiswous:

''By Geep 2022''

Clicking on "Filter" in the top menu will show a pulldown list of available filters, each of which may be independently toggled on or off with LMB. Any (except custom) filters that are "on" will hide the corresponding map items in all DR views. A variety of filters are built-in and easy to use, and you may add custom ones. Filtering relies on item classnames or other standard attributes (i.e., spawnargs) that are already present. As a result, no extra collection management is needed, unlike, say, Layers.

Need more? See [https://www.darkradiant.net/userguide/#_filtering_map_elements Filtering map elements, in the Dark Radiant’s Users Guide].

=="Activate all Filters" and "Deactivate all Filters" Menu Items==
Found near the bottom of the pulldown menu (and perhaps confusingly shown with always-present funnel icons, even though they are not filters themselves), these are handy to quickly get to a uniform state before toggling individual filters.

=="All entities" and "World geometry" Filters==
Together, these cover all map objects. Individually, they approximate an important distinction between:
* objects needed for sealing (from the void or among locations) or for AI traversal; and
* everything else.

=="Visportal" Filter==
''From [https://forums.thedarkmod.com/index.php?/topic/20104-filters-in-dr/ forum post by Destined].''

A more apt name would be "Visportals and NoDraw", because it also filters out NoDraw surfaces, whether or not they are part of a Visportal brush.

=="Select by filter" and "Deselect by filter"==
The right-click context-menu has two options called "Select by filter" and "Deselect by filter". With it you can select/deselect anything that applies to that filter. So for example: Select by "Lights" will select all light entities in your map.

==Defining Custom Filters==
At the bottom of the Filter pulldown menu, "Edit Filters..." brings up the "Filter Settings" dialog, which lists both built-in filters and any custom ones you added. You can edit, add, and delete custom filters, but the code of built-ins can only be viewed or (to support you making a custom variant) copied.

All filters use a specialized form of scripting for matching. See:
* [[A_-_Z_Beginner_Full_Guide_Page_4#Dark_Radiant_Filters]]
* [[Defining_custom_Filters_in_DarkRadiant]]

==See Also==
* [[The Parts and Whole: Overview]]
* [https://www.darkradiant.net/userguide/#_filtering_map_elements Filtering map elements, in the Dark Radiant’s Users Guide]
* [[A_-_Z_Beginner_Full_Guide_Page_4#Dark_Radiant_Filters]]
* [[Defining_custom_Filters_in_DarkRadiant]]

{{Editing}}

The Parts and Whole: DR Filters

2025-12-10T00:04:37Z

Datiswous: Added "Select by filter" and "Deselect by filter" info

Dmap

2025-11-25T20:20:03Z

Datiswous: /* Even further, advanced mappers can use: */

''started by Fidcal''

This article can include anything about dmap. I just started it as a placeholder to list when and when not to....

Also... do not Dmap while a mission is installed. Uninstall the mission then dmap.

== When do I need to dmap? ==

* After creating new brush or patch worldspawn.
* After moving/rotating new brush or patch worldspawn.
* After renaming a brush or patch entity, eg, func_static.
* After rotating a brush or patch entity, eg, func_static.
* After adding AI may need pathfinding recalculating (included in dmap by default.)
* After adding or moving a light (shadows are precalculated for static, shadowcasting lights).

== When do I NOT need to dmap? ==

* After adding a path_corner or other path entities.
* After moving a brush or patch entity
* After changing a spawnarg (entity keyvalue), unless it affects the origin or rotation of a model.

== Delete Proc, CM, AAS ==

When you dmap, in many cases the existing Proc, CM, and AAS files will not be overwritten.
It is advisable to delete all the files except the map, script, and custom assets.

== Optimization Options ==

Rather that just using the dmap command alone (as shown below):

<pre>

dmap map_name.map

</pre>

You can improve the way the map compiler optimizes the map through the use of "switches".

The most commonly used switch is "shadowopt 2"

(CAUTION: There is one report that this caused pathfinding problems.)

<pre>

dmap shadowopt 2 map_name.map

</pre>

Another more common switch is "lightCarve".

This will split the geometry based on light boundaries.
It can improve performance at the expense of a larger map file.

Mappers who are proficient with this compile method know to arrange and size their lights such that they
are broken via easy symmetry or ratios.

This is primarily beneficial to maps with simple but wide-open areas with large light volumes (example: a large warehouse).

<pre>

dmap lightCarve map_name.map

</pre>

* By most accounts manually splitting light counts is more beneficial than LightCarve so using this switch can be seen as a "lazy technique".
* (Though it's arguably still cumbersome because proper LightCarve application usually requires some pre-planning...).

----

===Even further, advanced mappers can use:===

* The "noFragment" keyword in materials to '''prevent''' some surfaces from splitting during compile
* The "discrete" keyword in materials to ensure that specified surfaces are '''always split''' during compile

These techniques are also referred to as [[Performance:_Essential_Must-Knows#Brush_Carving|"Brush Carving"]]

* More details at: https://modwiki.dhewm3.org/Dmap_(console_command)

== Troubleshooting ==

=== Malloc Errors ===

If you get malloc (memory allocation) errors while dmapping then this might be due to the limitation of the program even if you have plenty of RAM.

If you have more than 4GB of RAM and 64-bit OS, then you should dmap in 64-bit build of DarkMod (starting from 2.06). Keep in mind that memory consumption in 64-bit build is usually higher than in 32-bit build.

If you have 3GB RAM or more then you can get 32-bit build of DarkMod to access up to 4GB by using a 3rd party patch called NTCore. This is a simple Windows application. You just browse to TheDarkMod.exe and click it and it fixes it and makes a backup just in case. That's it! Here is the link: [[http://www.ntcore.com/4gb_patch.php NTCore]]

[[Category:Editing]]

Grouping

2025-11-25T09:42:24Z

Datiswous:

''This article uses "entity" in the broad sense, as a "collection of map objects", which can include, for instance, worldspawn.''

With the release of DarkRadiant 2.2.1 the grouping feature was introduced. This feature lets you group together several individual entities, so they are treated as a single entity in DarkRadiant.
In order to group entities, select all entities, that you want in one group, and then either use the right mouse button and select "Group Selection" or use Edit -> Group Selection in the task bar. The group can be disbandend by using "Ungroup Selection" in the same way.

To change individual parts of the group without ungrouping you have to enter "Selection focus", which can only be accessed via a key (the command is called "ToggleSelectionFocus"). In this mode you can can change grouped parts, but nothing outside of the group. Check the info [https://wiki.thedarkmod.com/index.php?title=The_Parts_and_Whole:_DR_Groups#Selection_focus here] for a longer description.

== Grouping and Prefabs ==
With the introduction of the grouping feature Prefabs are grouped by default, as they usually are used as a single entity. There are examples, where this behaviour is unwanted (e.g. for the key of a chest prefab). It is possible to change this behaviour before inserting the prefab by unticking the Box "Create Group out of Prefab parts" in the "Choose Prefab" window. Please note, that this box remains unticked after inserting the prefab; so if you want to insert a prefab as a group later on, you will have to tick this box again.

== See Also ==
[[The Parts and Whole: DR Groups]]

[[Category:Editing]]
[[Category:Models]]
[[Category:Prefabs]]