The DarkMod Wiki - User contributions [en]

Player Guide

2019-01-28T17:37:24Z

Destined:

Now covered by: [[The Dark Mod Gameplay]]

Provisionally this is just a list of things that players possibly should know to be drawn upon nearer launch so nothing is overlooked. Please add anything you think they should know. To clarify - this is not a guide at the moment but a reminder list to making a possible guide.

* Consideration need to be addressed to three audiences : Those familiar with Doom; those familiar with Thief, and complete newcomers who might not have any concept of mantling, rope arrows, stealth, importance of light gem, noise, etc. etc. I knew someone who had played Thief a few times but never knew what moss arrows were for.
** If possible, an in-game tutorial (aka a training mission could well cover the basics)
* Maybe the original T1/T2 player guide is worth a read to see what they thought essential to tell gamers?
* Intro ?
* install links re: Doom, DM, etc?
* Tactics, strategy?
* All controls (these might be covered in the main menu)
** Especially...
:# There is a separate control for frobbing items in the
:# Rotate and pull towards and push away controls for carried objects
:# Three ways to release a carried item depending on the object - 'Use' to release, 'Drop', or hold 'attack' for power through. An inventory, if it is droppable, can be dropped by first using the 'drop' control to 'carry' it and then 'use' or 'throw'.
* Doors can be opened or closed partially using a second frob while it is opening or closing.
* inventory: groups, etc.

==part 2 temp - helps edit==
=== Climbing, Jumping, Moving ===

* You can mantle from the jump key or there is a separate mantle-only key. This is helpful on noisy ground so if you misjudge you will not drop back with a clatter.
* You gain no extra mantling height from a jump or from a running jump.
* The player's direction of view can affect mantling - you can choose from more than one mantle, eg, facing a four poster bed you can mantle on to it. From the same position if you look up at its canopy then you can mantle on to that instead. If you find you can't mantle in a situation where you would expect to then you might be looking at another unmantleable edge without realizing it - so look up or down so you are looking at the edge you ''do'' want to mantle onto then try again.
* The player can mantle into low gaps automatically into a crouch.
* The player can turn while mantling so continue scrambling up a side roof.
* Pressing the 'crouch' key while mantling will detach the player from the climb. This is so you can drop cleanly without having to jump sideways.

===Ladders===

* You need only contact a ladder to get on it. If positioned correctly you generally should be able to walk off it.

* On ropes and ladders the 'crouch' key has two functions:
** Tap the 'crouch' key briefly to toggle 'crouch-intent'. This means whether you will be crouched or not when you get off. Jumping, walking, or sliding off in crouch mode is quieter.
** Hold the 'crouch' key to slide the player down the ladder or rope and eventually off the bottom. It can also just be used to detach at the bottom if you can't walk off cleanly and don't want to jump. This is different from normal moving down in that you can be facing in any direction.

===Rope Arrows===
* Unlike ladders, you cannot get on a rope just by contact. You need to get close then jump else ''jump at'' the rope. In other words you need to make contact while off the ground.
* Arrows will only stick in certain materials.
* Rope arrows can be shot into moveables such as crates (at player's risk) and also ''over'' barriers such as ledges - they will then drape back down over those edges.
* On ropes and ladders the 'crouch' key has two functions:
** Tap the 'crouch' key briefly to toggle 'crouch-intent'. This means whether you will be crouched or not when you get off. Jumping, walking, or sliding off in crouch mode is quieter.
** Hold the 'crouch' key to slide the player down the ladder or rope and eventually off the bottom. It can also just be used to detach at the bottom if you can't walk off cleanly and don't want to jump. This is different from normal moving down in that you can be facing in any direction.
* Not only ladders may be climbable - worth checking drainpipes, ivy, and anything that might be climbable in real life.

====Swinging on Ropes====

You can swing on ropes to get to otherwise unreachable areas:

* Use the move keys but replace 'forwards' with 'attack' to start swinging.
* Repeat each time the rope reaches its central position to increase the swing.

=== Player Tools ===

You can zoom the spyglass with the mouse wheel

You can still access the compass when looking at a map.

lockpicking ...

=== Carryable Objects ===

Carryable objects can be rotated by holding down the middle mouse button and pulled towards or pushed away with the mose wheel.

The short matches available in some missions have to be carried and rotated, so the glowing end is brought to the item you want to light with them.

=== AI ===

AI can be knocked out with the blackjack if not alert. It is still possible if they are alert but more difficult. Otherwise, the blackjack just causes damage.

Damage is blocked by armour, helmets etc.

* Bodies can be dragged but they can also be turned with careful manoeuvring.

===Lockpicking===
* How to Lockpick needs a good description.

....more to come.

{{todo}}
[[Category:Tutorial]]

Popup messages

2019-01-09T06:41:33Z

Destined: /* text (string) */

== Introduction ==

Often it can be useful to show the player messages on the screen, this is used for instance for instructions in the training mission. This article describes how to make this work.

== Usage ==

For each message you want to show, insert one '''atdm:gui_message''' entity in your map. The place does not matter, but putting it near the location where the message appears makes sense. Set the proper spawnargs, then simply target that entity from any trigger.

You can also use '''atdm:target_message_enable''' and '''atdm:target_message_enable''' entities to disable/enable a certain message.

If you want your message to appear only once, no matter what, use '''trigger_once'''. If it should appear multiple times until a certain condition is fulfilled, use a '''trigger_multiple''' and then a '''atdm:target_message_disable''' entity to disable the message entity.

[[Image:Messages.jpg|right|400px]]

Here is an example screenshot from <code>maps/test/trigger_messages.map</code>. The highlighted entity itself is the message. It is targeted by the trigger in the door, showing the message everytime the player steps through the door. The red and green boxes are the '''atdm:target_message_disable''' and '''atdm:target_message_enable''' entities, that are targeted by two levers.

== Reappearing Messages ==

By default, each message entity shows the message only once, when triggered.

This means:

* if you use a '''atdm:trigger_once''' to trigger it, it will be shown '''exactly once'''
* if you use a '''atdm:trigger_multiple''' to trigger it, it will be shown '''one time whenever the trigger fires''' (which is typically when the player steps through the trigger)
* if you use a '''atdm:trigger_once''' to trigger it, and set '''wait''' on the message entity, it will be shown '''multiple times''' and the time between each showing is '''wait''' seconds long.

== Spawnargs ==

=== show (float, default: 0) ===

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.

=== delay (float, default: 0) ===

Time in seconds before the message will appear.

=== wait (float, default: 0) ===

If set to a value > 0, the message entity will display the same message after the specified time '''again'''. If you use this, make sure '''wait''' is longer than '''show''', or the message might flicker.

Please see also the section about "reappearing messages".

=== text (string) ===

The text to display.

The displayed text can be changed during gameplay (e.g. to use variables like "X of 3 objects found"), by using a script with the "setKey" script command before activating the message entity.

=== lines (int, default: 1) ===

The number of lines, will is relayed to the GUI and can influence the vertical alignment of the text.

=== force (boolean, default: 0) ===

If true, the message is always shown, regardless of the CVAR. It is wise to set force to 1 for messages that are not pop-up messages, but instead overlay titles. Think of the "movie titles" '''Brideport, late night" that appear transparent over the entire screen. You don't want these to disappear just because the user has the CVAR (see below) set to off.

=== gui (string, filename, default "guis/tdm_message.gui") ===

Name of the GUI file, which is used to display the message.

== CVAR ==

=== tdm_show_trainer_messages ===

If true, the messages are shown, if false, suppressed unless they have "force" on them.

{{editing}}

Popup messages

2019-01-09T06:40:28Z

Destined: /* text (string) */

== Introduction ==

Often it can be useful to show the player messages on the screen, this is used for instance for instructions in the training mission. This article describes how to make this work.

== Usage ==

For each message you want to show, insert one '''atdm:gui_message''' entity in your map. The place does not matter, but putting it near the location where the message appears makes sense. Set the proper spawnargs, then simply target that entity from any trigger.

You can also use '''atdm:target_message_enable''' and '''atdm:target_message_enable''' entities to disable/enable a certain message.

If you want your message to appear only once, no matter what, use '''trigger_once'''. If it should appear multiple times until a certain condition is fulfilled, use a '''trigger_multiple''' and then a '''atdm:target_message_disable''' entity to disable the message entity.

[[Image:Messages.jpg|right|400px]]

Here is an example screenshot from <code>maps/test/trigger_messages.map</code>. The highlighted entity itself is the message. It is targeted by the trigger in the door, showing the message everytime the player steps through the door. The red and green boxes are the '''atdm:target_message_disable''' and '''atdm:target_message_enable''' entities, that are targeted by two levers.

== Reappearing Messages ==

By default, each message entity shows the message only once, when triggered.

This means:

* if you use a '''atdm:trigger_once''' to trigger it, it will be shown '''exactly once'''
* if you use a '''atdm:trigger_multiple''' to trigger it, it will be shown '''one time whenever the trigger fires''' (which is typically when the player steps through the trigger)
* if you use a '''atdm:trigger_once''' to trigger it, and set '''wait''' on the message entity, it will be shown '''multiple times''' and the time between each showing is '''wait''' seconds long.

== Spawnargs ==

=== show (float, default: 0) ===

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.

=== delay (float, default: 0) ===

Time in seconds before the message will appear.

=== wait (float, default: 0) ===

If set to a value > 0, the message entity will display the same message after the specified time '''again'''. If you use this, make sure '''wait''' is longer than '''show''', or the message might flicker.

Please see also the section about "reappearing messages".

=== text (string) ===

The text to display.

If you want to change the displayed text during gameplay (e.g. to use variables like "X of 3 objects found"), you can use the "setKey" script command before activating the message entity.

=== lines (int, default: 1) ===

The number of lines, will is relayed to the GUI and can influence the vertical alignment of the text.

=== force (boolean, default: 0) ===

If true, the message is always shown, regardless of the CVAR. It is wise to set force to 1 for messages that are not pop-up messages, but instead overlay titles. Think of the "movie titles" '''Brideport, late night" that appear transparent over the entire screen. You don't want these to disappear just because the user has the CVAR (see below) set to off.

=== gui (string, filename, default "guis/tdm_message.gui") ===

Name of the GUI file, which is used to display the message.

== CVAR ==

=== tdm_show_trainer_messages ===

If true, the messages are shown, if false, suppressed unless they have "force" on them.

{{editing}}

Popup messages

2019-01-09T06:39:19Z

Destined: /* text (string) */

== Introduction ==

Often it can be useful to show the player messages on the screen, this is used for instance for instructions in the training mission. This article describes how to make this work.

== Usage ==

For each message you want to show, insert one '''atdm:gui_message''' entity in your map. The place does not matter, but putting it near the location where the message appears makes sense. Set the proper spawnargs, then simply target that entity from any trigger.

You can also use '''atdm:target_message_enable''' and '''atdm:target_message_enable''' entities to disable/enable a certain message.

If you want your message to appear only once, no matter what, use '''trigger_once'''. If it should appear multiple times until a certain condition is fulfilled, use a '''trigger_multiple''' and then a '''atdm:target_message_disable''' entity to disable the message entity.

[[Image:Messages.jpg|right|400px]]

Here is an example screenshot from <code>maps/test/trigger_messages.map</code>. The highlighted entity itself is the message. It is targeted by the trigger in the door, showing the message everytime the player steps through the door. The red and green boxes are the '''atdm:target_message_disable''' and '''atdm:target_message_enable''' entities, that are targeted by two levers.

== Reappearing Messages ==

By default, each message entity shows the message only once, when triggered.

This means:

* if you use a '''atdm:trigger_once''' to trigger it, it will be shown '''exactly once'''
* if you use a '''atdm:trigger_multiple''' to trigger it, it will be shown '''one time whenever the trigger fires''' (which is typically when the player steps through the trigger)
* if you use a '''atdm:trigger_once''' to trigger it, and set '''wait''' on the message entity, it will be shown '''multiple times''' and the time between each showing is '''wait''' seconds long.

== Spawnargs ==

=== show (float, default: 0) ===

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.

=== delay (float, default: 0) ===

Time in seconds before the message will appear.

=== wait (float, default: 0) ===

If set to a value > 0, the message entity will display the same message after the specified time '''again'''. If you use this, make sure '''wait''' is longer than '''show''', or the message might flicker.

Please see also the section about "reappearing messages".

=== text (string) ===

The text to display.

If you want to change the displayed text during gameplay, you can use the "setKey" script command before activating the message entity.

=== lines (int, default: 1) ===

The number of lines, will is relayed to the GUI and can influence the vertical alignment of the text.

=== force (boolean, default: 0) ===

If true, the message is always shown, regardless of the CVAR. It is wise to set force to 1 for messages that are not pop-up messages, but instead overlay titles. Think of the "movie titles" '''Brideport, late night" that appear transparent over the entire screen. You don't want these to disappear just because the user has the CVAR (see below) set to off.

=== gui (string, filename, default "guis/tdm_message.gui") ===

Name of the GUI file, which is used to display the message.

== CVAR ==

=== tdm_show_trainer_messages ===

If true, the messages are shown, if false, suppressed unless they have "force" on them.

{{editing}}

Creating Multiple Skins For A Model

2018-10-28T22:53:18Z

Destined:

The skins functionality in D3 allows a single model to have a number of textures ("skins") which can be selected from a dialog in the editor. This provides ease-of-use for mappers and provides a great variability for the models.

=File Structure=
An entry in the skin file has the following basic structure:
skin [name]
{
model [complete path of the model]
[name of material definition to be replaced] [name of replacement material definition]
}

=Creating a New Skin=
The header has the format
skin [your_skin_name]
Your skin name has to be unique and (like all definitions in TDM) should not contain any hyphens (-).

In the inner part of the brackets, you first define for which model the skin can be applied. If you do not define this, the skin will not show in the model menu in DR. Regardless, it can still be applied via the skin spawnarg. In this place you can define several models at once, if they share textures. Make sure to use the complete path inside the TDM folder and to include the file extension of the model. The easiest way to do this (and to avoid any spelling errors) is by inserting the model into DR and copying the "model" spawnarg to your skin file. Note that the file ending is not recognised if written in caps.

In order to replace materials, you first need to know which materials are present in a given model. One easy way to do that is to open the model preview window in DR. On the left side, directly beneath the models list, there is a list of all materials used in the selected model. To replace one or several of these, you insert the whole path of the material you want to replace and, separated with a space (or for better readability a tab), write the path of the material you want as a replacement behind it. If you want to replace more than one material you can simply list the materials in the aforementioned style beneath each other. Each texture that gets not listed here, is not replaced. If you want any part of the model to not appear at all you can use the nodraw material ("textures/common/nodraw").

=Common Errors=
If the model should appear completely black in game, this means that TDM cannot find your definition for the skin. Check for spelling errors! Similarly, if any part of your model appears black, the defined texture cannot be found. Keep in mind, that any custom texture you want to use has to have a material definition!
If the skin does not show up as an option for your model, you have an error in the "model" line. Make sure you have included the file extension of the model and that this is in lower cases, as an upper case file extension might not be registered.

=Example=
Let's say you want to exchange one material of Springheel's module "mansion01_wall04", so the white part is stone instead.

First, create a file named "stone_wall.skin" (or any other name) in the folder [your_FM]/skins and open it.
Then, create a skin entry:
<pre>
skin mansion01_stone
{
}
</pre>
Personally, I would recommend to write the bracketts right away, so you will not forget it later.
In order to show the skin in DR, give the complete path of mansion01_wall04, including its file extension:
<pre>
skin mansion01_stone
{
model models/darkmod/architecture/modules/interior_mansion01/mansion01_wall04.lwo
}
</pre>
As described before, the easiest way to find the material you want to exchange is to choose "Create model..." and search for the model you want to work on. In the "Choose Model" window, you can find all used materials in the model; in this case:

"textures/darkmod/wood/boards/white_painted_wood01"

"textures/darkmod/wood/panels/molding_walnut"

"textures/darkmod/wood/panels/panel_carved_rectangles_01_walnut"

"textures/darkmod/wood/panels/walnut_panel01"

"textures/darkmod/wood/panels/wood_walnut_panel02"

By unticking each "Visible" mark, we can see, which material we need. The white part is "textures/darkmod/wood/boards/white_painted_wood01". As a stone material I have chosen "textures/darkmod/stone/brick/blocks_brown". This will just be put into the next line (for better readability, I recommend to leave one line free in between) and we get:
<pre>
skin mansion01_stone
{
model models/darkmod/architecture/modules/interior_mansion01/mansion01_wall04.lwo

textures/darkmod/wood/boards/white_painted_wood01 textures/darkmod/stone/brick/blocks_brown
}
</pre>
When you want to test, if your skin is registered and works, you can update all existing skins in DR via File -> Reload Skins

= Wildcard skins =

(Note added by VanishedOne)

If you want to replace every material on a model with the same material, you can use the * character like this:

skin all_dark_rough_stone {
* textures/darkmod/stone/natural/dark_rough
}

This skin will turn any entire model to stone, regardless of what materials it used originally.

{{tutorial-models}}

Creating Multiple Skins For A Model

2018-10-28T09:04:01Z

Destined:

Traps

2018-10-14T09:34:59Z

Destined:

Up to now the following trap types have been realised:
*Pressure plate with projectile shooter [https://youtu.be/0H9BkPED9yQ Video] [http://forums.thedarkmod.com/topic/19570-pressure-plate-traps/ Forum-Thread]

*Chest armed with springloaded spike [https://youtu.be/6ki9oJX2pBs Video] [http://forums.thedarkmod.com/topic/19586-springloaded-spike-trap/ Forum Thread]

*Flame Jet [https://youtu.be/Z-MYfPkG8PI Video] [http://forums.thedarkmod.com/topic/19597-flame-jet-trap/ Forum-Thread]

*Tripwire with crossbow [https://www.youtube.com/watch?time_continue=14&v=vqM5YHW0V7s Video] [http://forums.thedarkmod.com/topic/19568-crossbow-trap/ Forum-Thread]

The tutorials are in video forat and can be watched by clicking on the appropriate link.

Traps

2018-10-14T09:34:08Z

Destined: Created page with "Up to now the following trap types were made: *Pressure plate with projectile shooter [https://youtu.be/0H9BkPED9yQ Video] [http://forums.thedarkmod.com/topic/19570-pressure-p..."

Up to now the following trap types were made:
*Pressure plate with projectile shooter [https://youtu.be/0H9BkPED9yQ Video] [http://forums.thedarkmod.com/topic/19570-pressure-plate-traps/ Forum-Thread]

*Chest armed with springloaded spike [https://youtu.be/6ki9oJX2pBs Video] [http://forums.thedarkmod.com/topic/19586-springloaded-spike-trap/ Forum Thread]

*Flame Jet [https://youtu.be/Z-MYfPkG8PI Video] [http://forums.thedarkmod.com/topic/19597-flame-jet-trap/ Forum-Thread]

*Tripwire with crossbow [https://www.youtube.com/watch?time_continue=14&v=vqM5YHW0V7s Video] [http://forums.thedarkmod.com/topic/19568-crossbow-trap/ Forum-Thread]

The tutorials are in video forat and can be watched by clicking on the appropriate link.

AI stats

2018-05-04T09:20:50Z

Destined:

<pre style="color: red">THIS PAGE IS A WORK IN PROGRESS</pre>
== Spawnargs and Game Mechanics ==
In order to understand the influence of the spawnargs on game mechanics, I want to give a simple insight into the mechanics. For this I have decided to categorise them into four subgroups: AI perception, Combat, and Interaction between AIs and player out of combat.
=== AI perception ===
In the centre of each stealth game lies the perception of the AIs. This includes the ability of AIs to see, hear, and touch its environment. The chance to percieve anything with the respective sense is multiplied with the respective acuity_* spawnarg at some point. If the AI is drunk all these factors are multiplied with the drunk_acuity_factor (default 0.5), which reduces the chance of the AI to notice the player.
==== Visual perception ====
In general, when an object with an AIUse spawnarg comes into the field of vision of an AI, the AI gets a visual STIM. The chancenotice* spawnargs influence if the AI reacts to the STIM and the argument of the AIuse spawnarg (not listed in the table) determines how the AI reacts. For example if the AI gets a visual STIM of another friendly AI it will greet, while it will attack a hostile AI on sight. The chance to spot the player follows a more complex algorithm and is influenced by the brightness of the light gem, the distance to the AI and the visual acuity of the AI (acuity_vis). You can check the [[Visual scan]] article for further information.
==== Aural perception ====
Noises made by the player as well as thrown objects or noise arrows produce a propagated sound of a specified volume. The propagated sound's volume decreases linearly with increasing distance from the source. When it reaches an AI the alert_aud_thresh value is subtracted and the remaining volume (if it is greater than 0) is added to the alert level of an AI.
==== Tactile perception ====
Tactile perception gets triggered, when the AI collision model touches the player's collision model.
==== Perception and Alarms ====
When an AI perceives anything suspicious, it adds to the AI's alert level. When this counter exceeds a certain amount (alert_thresh#), the AI will reach the next alert stage. In order to prevent the alert level to ramp up too quickly there is a grace period (alert_gracetime#) during which a new suspicious stim will not further alert the AI. This period can be terminated if the new stim during the grace period is too strong (exceeds the former addition to the alert level multiplied with the "alert_gracefrac#" value) or if there are too many stims in quick succession (exceeding the alert_gracecount#). Above the "idle" state (0) there are five alert stages:
*1: Observant (bark, but otherwise no reaction)
*2: Suspicious (bark, look, may stop and turn)
*3: Searching (Investigation)
*4: Agitated Searching (Investigation, Weapon out, AI is quite sure that there is someone around)
*5: Combat.
The AI will stay in this alert state for a time determined by "alert_time#". Please note, that as soon as an AI has drawn its weapon it will not recede to the regular idle state, but instead to the "alert idle" state, which results in a hightened senses and possibly different behaviour of the AI (e.g. a former stationary AI starts patroling).
{| class="wikitable"
|+Spawnargs related to AI perception
|-
|acuity_aud
|AI aural acuity (in percent)
|-
|acuity_env
|AI environmental acuity. How sensitive the AI is to things that have changed in its environment.
|-
|acuity_other
|AI generic acuity for scripted events. You can call this alert type on an entity with entity.Alert( <char *type>, <float amount>). This will alert the entity by amount * acuity_other in your script.
|-
|acuity_tact
|AI tactile acuity (in percent)
|-
|acuity_vis
|AI visual acuity (in percent)
|-
|alert_aud_thresh
|Threshold of audibility for the AI. This is in dB of sound pressure level (SPL). The real life value for humans is around 20 (a barely heard whisper). Changing this by even 0.1 has a large effect on sound propagation behavior, because propagated sounds below this volume are not heard at all. NOTE if this is not set, it gets the value from soundprop global settings.
|-
|alert_gracecount#
|If the number of additional alerts for an AI in alert state # during the grace period exceeds the grace count, the grace period will be terminated.
|-
|alert_gracefrac#
|An alert that is higher than the last increase times the grace fraction will terminate the grace period for an AI in alert state #.
|-
|alert_gracetime#
|After being alerted, the AI in alert state # will ignore additional alerts during the grace period (in seconds), to avoid adding up the alert level too quickly.
|-
|alert_thresh#
|The alert level threshold for reaching alert state #.
|-
|alert_time#
|The time it takes for the alert level to ramp down from the upper to the lower threshold in alert state # (in seconds).
|-
|chancenoticeblood
|Chance to notice the visual stim of blood
|-
|chancenoticebrokenitem
|Chance to notice the visual stim of a broken item
|-
|chancenoticedoor
|Chance to notice the visual stim of an open door that should be closed
|-
|chancenoticelight
|Chance to notice the visual stim of a light that should be on
|-
|chancenoticemissingitem
|Chance to notice the visual stim of a missing item
|-
|chancenoticemonster
|Chance to notice the visual stim of a monster
|-
|chancenoticeperson
|Chance to notice the visual stim of other persons
|-
|chancenoticepickedpocket
|Chance to notice that an object bound to the AI has been stolen
|-
|chancenoticerope
|Chance to notice the visual stim of a rope created by a rope arrow
|-
|chancenoticesuspiciousitem
|Chance to notice the visual stim of suspicious items
|-
|chancenoticeundead
|Chance to notice the visual stim on an undead
|-
|chancenoticeweapon
|Chance to notice the visual stim of suspicious weapons
|-
|drunk_acuity_factor
|If the AI is drunk, their acuities (visual, hearing, tactile) will be reduced by this factor.
|-
|fov
|Full field of view in degrees. Will be used for both horizontal and vertical fov unless vertical is explicitly specified.
|-
|fov_rotation
|A vector of 3 space-delimited angles applied to rotate the AI's field of view relative to their head joint. For most heads, the angles are: yaw pitch roll.
|-
|fov_vert
|Full vertical field of view in degrees. Leave blank or set to -1 to use the same value as the horizontal fov.
|-
|headturn_chance_idle
|The chance for random head turning while idle (0 0-1 0)
|-
|headturn_factor_alerted
|The headturning chance gets multiplied by this amount when the AI is alerted
|-
|}
=== Interaction between AI and player ===
Apart from percieving their surroundings, there are several ways the AIs and the player can interact with each other and the environment. What an AI can do is defined by the "can*" spawnargs. If it is set to "1" an AI can for example use a light switch (like most humans can). If it is set to "0" it cannot do that. For example zombies are not able to operate switches or elevators.
=== Stealth Combat ===
A player may want to be sure that AI will not bother him/her any more. . It is possible to knock it out, as long as they are below their "ko_alert_immune_state". In order to achieve that, the player has to hit the AI with the blackjack in an area around the "ko_zone" (usually the head), that is defined by the two "ko_angle_horiz/vert" spawnargs. This area can change, when the AI is alerted to the values defined via the "ko_angle_alert_horiz/vert" spawnargs. An alternative way to knock out AI is with gas arrows, except if the AI has the spawnarg "gas_immune" set to 1 (e.g. as most undead have). For the more ruthless player, it is also possible to kill AIs. As long as AIs are not alerted (i.e. below the "sneak_attack_alert_state") the damage of each of the player's attacks is multiplied with a factor defined in "sneak_attack_mult", which can lead to one-shot kills, if the hit-zone does not reduce the damage too much. Sneak damage to the head should almost always result in death for the AI. Should the AI not be killed, it will be alerted, of course, and following attacks will not deal additional damage. For a short term distraction of AIs, the player can blind AI with flash bombs or distract them with noise arrows. Note that the flash bombs will only be dropped, when the "use" button in tapped. Holding the button for a longer time will resilt in a farther throwing distance. The AI will be bilnded for a time defined as "blind_time" that is randomized by the "blind_time_fuzzyness".
{| class="wikitable"
|+Spawnargs related to AI interactions with the player and vice versa
|-
|blind_time
|The time span in seconds the AI is staying in 'blinded' state when hit by a flashbomb or -mine.
|-
|can_drown
|If true, the AI will drown if it gets under water, either by walking in or by being dropped in unconsciously. Set to '0' to make them breathe under water.
|-
|canlighttorches
|AI ability to switch on torches
|-
|canoperatedoors
|AI ability to handle doors
|-
|canoperateelevators
|AI ability to handle elevators
|-
|canoperateswitchlights
|AI ability to operate light switches
|-
|cansearch
|Whether the AI can conduct a search or not
|-
|cansearchcooperatively
|ability to participate in a coordinated search
|-
|gas_immune
|0 = not immune, 1 = immune to gas
|-
|ko_alert_immune
|If true, the AI is immune to knockouts when alerted at or above the alert state defined in 'ko_alert_state'.
|-
|ko_alert_immune_state
|Alert state number at which immunity behavior changes.
|-
|ko_alert_state
|Alert state number at which knockout behavior changes.
|-
|ko_angle_alert_horiz
|Horizontal knockout cone angle when the AI is alerted at or above 'ko_alert_state'.
|-
|ko_angle_alert_vert
|Vertical knockout cone angle when the AI is alerted at or above 'ko_alert_state'.
|-
|ko_angle_horiz
|Defines a horizontal cone angle extending backwards from the direction AI is looking. Anywhere within this cone and the vertical cone is a valid KO.
|-
|ko_angle_vert
|Defines a vertical cone angle extending backwards from the direction AI is looking. Anywhere within this cone and the horizontal cone is a valid KO.
|-
|ko_immune
|0 = not immune, 1 = immune to blackjack
|-
|ko_rotation
|A vector of 3 space-delimited angles applied to rotate the AI's blackjack acceptance cone relative to their head joint. For most heads, the angles are: yaw pitch roll.
|-
|ko_spot_offset
|Defines the center of the head for knockout testing purposes. Vector offset from the head attachment joint to the desired head center point. The possible knockout cone extends back from this point.
|-
|ko_zone
|Name of the damage zone that must be hit for a possible knockout. Set this blank (i.e. : 'ko_zone' '') to make the AI immune to KOs from the blackjack.
|-
|pickpocket_alert
|Incremental alert value to be added to an AI's current alert level
|-
|pickpocket_delay_max
|Maximum delay before reacting to a picked pocket in milliseconds
|-
|picpocket_delay_min
|Minimum delay before reacting to a picked pocket in milliseconds
|-
|push_player
|Set this to 1 to let this entity push the player (default is 0).
|-
|sneak_attack_alert_state
|Alert state number at which the AI can no longer be sneak attacked.
|-
|sneak_attack_mult
|Damage multiplier applied to ALL damage when AI is damaged at an alert level below that defined in 'sneak_attack_alert_state'.
|-
|team
|Monsters do not actively attack players or monsters with the same team number. For common team numbers see [[AI Relations (Editing)]].
|-
|}
=== Open Combat ===
When stealth fails, the player always has the option to openly fight AIs instead of fleeing. However, combat in TDM is meant as a last resort and will ruin any stealth scores and will most likely kill you, when you face more than one guard. Also, common settings prohibit killing civilians (AI with the spawnarg "is_civilian" set to 1) and even guards on higher difficulties. The difficulty of a melee fight is influenced by three factors (not counting the player's skills): The combat difficulty setting in the menu (which can be set by the player), the melee skills of the AI (novice, trained, skilled, see Melee sets, are usually set for specific AI, but can be changed by the map author), and the difficulty setting of the current map (also chosen by the player). For a more detailed description on what to keep in mind while fighting, see [[The Dark Mod Gameplay#Combat|Combat]]. A hit by the player will deal damage. The damage reduces the amount of health of the AI by the base damage, scaled by the "damage_scale" of the zone hit. When the dealt damage surpasses the pain_threshold, the pain animation of the AI will be played. As soon as the health of the AI reaches the health_critical value, the AI will flee. Each successful hit or parry by the player will render an AI "flatfooted", which means it will not move for an amount of time defined as flatfooted_time (it can still attack, though). This time can be used to flee from the AI instead of continuing fighting. If the player gets outside the melee reange of an AI (e.g. by climbing somewhere the AI cannot reach), the AI will start throwing stones at the player if "outofreach_projectile_enabled" is set to "1". It will wait a random amount of time between "outofreach_projectile_delay_min" and "outofreach_projectile_delay_max" before doing so. The "attack_cone" determines in which region the AI can throw (or shoot in case of bowmen). Additionally, each shot will be offset by a random amount of up to "attack_accuracy" degrees, so not each shot will hit the player.
{| class="wikitable"
|+Spawnargs realted to combat
|-
|Spawnarg
|Explanation
|-
|armor
|Type of armor the AI is wearing (may vary depending on hit zone). The damage multipliers are: leather 0.75, chain 0.5, plate 0.
|-
|attack_accuracy
|Maximum angular offset to randomly offset the monster's aim when firing missiles
|-
|attack_cone
|Monster can only throw projectile within this cone relative to his direction.
|-
|bleed
|If set to true, this entity will bleed, e.g. spawn blood particles and decals when hurt.
|-
|can_be_flatfooted
|If set to true, the AI becomes flat-footed in certain combat situations. This means they're unable to run at the player, but can still turn to face the player.
|-
|damage
|Damage definition if it damages things it collides with.
|-
|damage_zones
|There are different hit zones for AI that vary the damage recieved from the player.
|-
|damage_scale "zone"
|Factor by which damage in the given zone is multiplied.
|-
|def_melee_set
|The defined melee set that describes the fighting skills. The levels are "novice", "trained", and "skilled" and are further modiefied by the difficulty of the game.
|-
|flatfooted_time
|The duration in milliseconds that this AI remains flat footed after a combat action triggers this state.
|-
|health
|Amount of damage to receive before dying.
|-
|health_critical
|When the health drops below this value, the AI will flee. Set this to 0 for AI that don't wet their pants.
|-
|is_civilian
|If true, the AI is a civilian. Defaults to 0.
|-
|move_speed
|The movement speed of AIs is dependent on their animations and animation rate. The animation rate can be changed with the anim_rate_X (X = animation name).
|-
|outofreach_projectile_delay_max
|Maximum period to wait between throwing player-out-of-reach projectiles in seconds
|-
|outofreach_projectile_delay_min
|Minimum period to wait between throwing player-out-of-reach projectiles in seconds
|-
|outofreach_projectile_enabled
|Ability to throw player-out-of-reach projectiles at the player.
|-
|pain_threshold
|How much damage monster has to receive in one blow for it to play a pain animation.
|-
|unarmed_melee
|Set this to 1 when this type of AI doesn't need melee weapons to fight. This is usually true for spiders, undead and such. Humans are wimps and need weapons.
|-
|unarmed_ranged
|Set this to 1 when this type of AI doesn't need weapons for ranged combat. This is usually true for belchers.
|}
== Human AIs ==
Human AIs are somewhat special as the spawnargs are defined by the entity definition as well as the definition of the head. This leads to a great number of combinations and is the reason that heads are discussed here as well as the various human classes. In order to make this article as clear as possible, in the first table the base values for human AIs are stated. In the class specific tables only changes to these base values are listed.
=== Base Values ===
This table lists all base values for human AIs in alphabetical order.
{| class="wikitable"
|+Humanoid AIs
|Spawnarg
|Base Value
|-
|acuity_aud
|100
|-
|acuity_env
|100
|-
|acuity_other
|100
|-
|acuity_tact
|100
|-
|acuity_vis
|100
|-
|alert_aud_thresh
|18.8
|-
|alert_gracecount1
|5
|-
|alert_gracecount2
|5
|-
|alert_gracecount3
|4
|-
|alert_gracecount4
|4
|-
|alert_gracefrac1
|1.2
|-
|alert_gracefrac2
|1.2
|-
|alert_gracefrac3
|1.2
|-
|alert_gracefrac4
|1.0
|-
|alert_gracetime1
|2
|-
|alert_gracetime2
|2
|-
|alert_gracetime3
|3
|-
|alert_gracetime4
|2
|-
|alert_thresh1
|1.5
|-
|alert_thresh2
|6
|-
|alert_thresh3
|10
|-
|alert_thresh4
|18
|-
|alert_thresh5
|23
|-
|alert_time1
|5 +/- 1.5
|-
|alert_time2
|8 +/- 2
|-
|alert_time3
|25 +/- 8
|-
|alert_time4
|65 +/- 20
|-
|alert_time5
|
|-
|armor
|variable
|-
|attack_accuracy
|2.3
|-
|attack_cone
|70
|-
|bleed
|1
|-
|blind_time
|8 +/- 4
|-
|can_be_flatfooted
|1
|-
|can_drown
|1
|-
|canlighttorches
|1
|-
|canoperatedoors
|1
|-
|canoperateelevators
|1
|-
|canoperateswitchlights
|1
|-
|cansearch
|1
|-
|cansearchcooperatively
|1
|-
|chancenoticeblood
|1.0
|-
|chancenoticebrokenitem
|1.0
|-
|chancenoticedoor
|1.0
|-
|chancenoticelight
|0.9
|-
|chancenoticemissingitem
|1.0
|-
|chancenoticemonster
|1.0
|-
|chancenoticeperson
|1.0
|-
|chancenoticepickedpocket
|0.5
|-
|chancenoticerope
|1.0
|-
|chancenoticesuspiciousitem
|1.0
|-
|chancenoticeundead
|1.0
|-
|chancenoticeweapon
|1.0
|-
|damage
|34
|-
|damage_zone
|head, chest, torso_low, left_arm, right_arm, legs
|-
|damage_scale head
|2
|-
|damage_scale chest
|1.5
|-
|damage_scale torso_low
|1.0
|-
|damage_scale left_arm
|0.3
|-
|damage_scale right_arm
|0.3
|-
|damage_scale legs
|0.4
|-
|def_melee_set
|variable
|-
|drunk_acuity_factor
|0.5
|-
|fov
|150
|-
|fov_rotation
|0 -20 0
|-
|fov_vert
|120
|-
|gas_immune
|0
|-
|headturn_chance_idle
|0.3
|-
|headturn_factor_alerted
|2
|-
|health
| variable
|-
|health_critical
|15
|-
|is_civilian
|0
|-
|is_mantleable
|0
|-
|ko_alert_immune
|0
|-
|ko_alert_immune_state
|5
|-
|ko_alert_state
|4 (as soon as weapon is drawn)
|-
|ko_angle_alert_horiz
|110
|-
|ko_angle_alert_vert
|180
|-
|ko_angle_horiz
|360
|-
|ko_angle_vert
|360
|-
|ko_immune
|0
|-
|ko_rotation
|0 0 0
|-
|ko_spot_offset
|2 -2.5 0
|-
|ko_zone
|head
|-
|melee_damage
|variable
|-
|melee_damage_mod
|0.6 - 1.4
|-
|melee_predicts_proximity
|1
|-
|melee_predicted_attack_time
|750
|-
|melee_range
|0
|-
|melee_rep_attack_time
|10000
|-
|outofreach_projectile_delay_max
|7.0
|-
|outofreach_projectile_delay_min
|10.0
|-
|outofreach_projectile_enabled
|1
|-
|pain_threshold
|1
|-
|pickpocket_alert
|0
|-
|pickpocket_delay_max
|25000
|-
|picpocket_delay_min
|5000
|-
|push_player
|
|-
|sneak_attack_alert_state
|2
|-
|sneak_attack_mult
|2.0
|-
|stamina
|player only
|-
|team
| variable
|-
|unarmed_melee
|0
|-
|unarmed_ranged
|0
|-
|}
=== Heads ===
Different heads can change the cones of the field of vision and the ko volume, so it it is advisable to check if any AI you encounter wears a hat or helmet and/or an eye patch. Please note that even though many AIs wear helmets, this only reduces the cone in which you can knock out the guard. Only the ones with neck protecting elite helmets (see [[Heads Available for AI#Elite Guard Heads|Heads Available for AI]]) are in general immune to being knocked out (i.e. the cone you have to hit with the blackjack is reduced to 0).
{| class="wikitable"
|+Heads
|Spawnarg
|Heads with an eye patch
|Heads with hoods
|Head with a straw hat
|Heads with non-brimmed helmet
|Heads with non-brimmed saxon helmet
|Heads with brimmed City Watch helmet
|Heads with elite helmet
|Heads with brimmed City Watch helmet and an eye-patch
|Heads with elite helmet and an eye-patch
|-
|Heads
|[[Heads Available for AI#Builder Guard Heads|Builder Guard Head 6]],[[Heads Available for AI#Generic Guard Heads|Commoner Default Heads 2, 12]], [[Heads Available for AI#Commoner Default Heads|Commoner Default Head 12]]
|[[Heads Available for AI#Commoner Default Heads|Commoner Default Heads 1,10]]
|[[Heads Available for AI#Commoner Default Heads|Commoner Default Head 3]]
|[[Heads Available for AI#Generic Guard Heads|Commoner Default Heads 6, 7, 13, 16]]
|[[Heads Available for AI#Generic Guard Heads|Commoner Default Heads 14, 15]]
|[[Heads Available for AI#City Watch Heads|City Watch Heads 1 - 4, 6 - 8]]
|[[Heads Available for AI#Elite Guard Heads|Elite Guard Heads 1,2]]
|[[Heads Available for AI#City Watch Heads|City Watch Heads 5, 10]]
|[[Heads Available for AI#Elite Guard Heads|Elite Guard Heads 3]]
|-
|fov
|110
|80
|150
|150
|110
|150
|150
|110
|110
|-
|fov_rotaion
| -30 -20 0
|0 -35 0
|0 -35 0
|0 -30 0
|0 -30 0
|0 -30 0
|0 -30 0
| 0 -30 0
|-30 -20 0
|-
|fov_vert
|120
|95
|100
| 120
|120
|100
|120
|100
|120
|-
|ko_angle_alert_horiz
|110
|110
|110
|110
|110
|110
|0
|110
|0
|-
|ko_angle_alert_vert
|180
|180
|180
|180
|180
|180
|0
|180
|0
|-
|ko_angle_horiz
|360
|360
|360
|110
|110
|110
|0
|110
|0
|-
|ko_angle_vert
|360
|360
|360
|180
|180
|180
|0
|180
|0
|-
|ko_alert_immune_state
|5
|5
|5
|4
|4
|4
|all
|4
|all
|-
|}
=== Builders ===
=== Guards ===
=== Mages ===
=== Moors ===
=== Pagans ===
=== Thieves ===
=== Townsfolk ===
== Non-human AIs ==
=== Monster ===
=== Steambots ===
=== Undead ===

Glossary

2018-03-07T06:53:12Z

Destined:

''started by Fidcal''

The world of 3D game editing has inherited much confusing terminology to confuse the beginner. They often have little or no relationship to their normal dictionary definition. Here are a few common ones explained...

== AI ==
These are the functioning characters or creatures having AI - artificial intelligence to represent living sentient beings in the game: humans, animals, monsters. [[#NPC|NPC]] is another abbreviation for AI.

== Brush ==

A brush is normally an ''applicator'' to apply paint, ink, glue but in 3D gaming it means a raw shape. The most common shape is a simple block but Dark Mod provides pyramids, cones, spheres.

All Dark Mod brushes must be convex so you cannot have any recesses or concave angles such as in an L shape, a bowl, a hole in a wall. Instead multiple brushes must be used as building blocks to form these shapes.

Brushes are intended for simple shapes. More complex, detailed shapes like trees, AI characters, etc. are created externally as 'models'

A brush is a ''primitive'' and begins as a child of the worldspawn entity. This means it is a direct offshoot of the game world and inherits any properties applied to the worldspawn. If you select a brush and look in the Entity Inspector you will see the worldspawn properties.

A brush may be parented to another entity when it will inherit its properties.

== Entity ==

A functioning item. (Multiple) [[#Primitives|primitives]] such as brushes and patches, and also models, can be parented to it and thus inherit its properties and functions. Examples: working doors, moveable items (ie, not fixed, unmoving) lights, readable items, and so on.

Some do not have a visible form in-game at all but only a function such as to trigger an event when the player approaches or to hold the objectives (quests) information sound speakers etc.

A func_static is a passive entity that does nothing but remain fixed in place - it will not even fall if placed in mid-air.

== Frob ==

Frob is shortened for "frobnicate", which means to adjust/manipulate. In The Dark Mod, "frob" describes the interaction of the player with entities in the world. The possibility to interact with (or frob) an entity is indicated by the entity being highlighted when it is centred on the screen and the player is close enough to interact with it. This behaviour of the entity is called "frob highlight".

== func_static ==

A func_static is an [[#Entity]] which has no special function other than to be static but which nevertheless has the advantages of being an entity, such as it can group multiple brushes and patches together and many properties can be added that cannot be added to a plain worldspawn brush.

== Key ==

The property of an item (see [[#Spawnarg|Spawnarg]]).

Also used in-game for door and container keys etc.

== NPC ==

Stands for Non-Player Character and refers to basically [[#AI|AI]].

== Map ==

A game file. In Dark Mod saved with the suffix .map. A mission or a game level.

Also used in-game for city, treasure maps, etc.

== Materials ==

Materials are plain text definitions contained within files suffixed .mtr and stored in the darkmod/materials folder (within a pk4 zip archive by default.) They are often called material shaders or just shaders (not to be confused with sound shaders.) Sometimes they are just called textures but materials include other properties as well as the visible texture.

Material definitions include many properties such as textures, contour information, shinyness, sound, climbability, slippiness, translucency, as well as dynamic features such as animated water ripples.

Materials are initially selected from Dark Radiant's Media Browser. Textures already used in a map also show in the Texture Browser as a kind of shortcut. Both browsers are on the same panel as the Entity Inspector.

== Model ==

A model is an item that is designed externally in a modelling program. It is not a raw shape. It is pre-designed. Lots of models are provided in Dark Mod, just right click the grid view in Dark Radiant and select create model. For example furniture, decorative items, physical lights, and so on. These often have fine detail whereas building with brushes is mostly (but not always) more suited to larger, simpler shapes like terrain, walls, etc.

When creating a model, by default it becomes a func_static entity which is just passive and inactive. But you can change that eg, a door model can then be changed to be a door entity so it functions as an openable, lockable door in-game.

== Patch ==

A two dimensional surface

A patch is a ''primitive'' - a child of the worldspawn entity. This means it is a direct offshoot of the game world and inherits any properties applied to the worldspawn. If you select a brush and look in the Entity Inspector you will see the worldspawn properties.

A patch may be parented to another entity when it will inherit its properties.

Also may be used in-game by pirates!

== Prefab ==

A prefab is a prefabricated map section that can be imported into your map. It can include any game elements; lights, terrain, entities, models. Examples: an openable, lockable chest, shelves filled with kitchen items, a stairway with steps and railings, and so on. These can be modified by the mapper, eg, retextured, if they include brush or patch items.

You can create your own prefabs by selecting items and using menu > file > save selected as prefab. Example, if you built an archway it might be useful in another map so could be saved as a prefab and used again and again.

Dark Mod comes with many prefabs included. (you might need to extract these from their pk4 zip archive if using early versions of Dark Radiant before you can see them.)

If '''imported''' via the file menu they will be placed at the same position from where they were exported. They remain selected so you can move them.

If '''inserted''' via the right mouse button in grid view then their original position will be added as an offset to where your mouse is pointing. For this reason is it very important to alway move items to position 0, 0, 0 before saving as a prefab.

== Primitive ==

Initially a child of the worldspawn entity. This means it is a direct offshoot of the game world and inherits any properties applied to the worldspawn. [[#Brushes]] and [[#Patches]] are primitives.

== Shaders ==

Shaders may be ''sound shaders'' (see [[#Sound Shaders]] or ''material shaders'' (see [[#Materials]])

==Sound Shaders==

Sound shaders are plain text definitions stored in files suffixed .sndshd in the darkmod/sound folder (may be in a pk4 zip archive.) They include information about sound files and how they should be played in the game.

== Spawnarg ==

A spawnarg is an argument (in the mathematical sense) given to an entity or primitive when it is first created (spawned.) These are the properties of the item and consist of a property name and its value (quantity, type, description or nature.) It is often referred to as a ''key value pair'' as it represented in the software code in that form. The ''key'' is the property name such as origin, rotation, team. After creation the key value pair is referred to as arg. The value can be numerical: 99 - or a string of alphanumeric character abcd99_xyz. There can be one or more values. Examples:

Name (property, key): origin

Value: 496 656 128

Name: team

Value: 2

Name: head_joint

Value: Head

see also [[Spawnarg]]

== Textures ==

See [[#Materials]]

[[Category:Documentation]]
{{editing}}

Glossary

2018-03-07T06:50:18Z

Destined:

''started by Fidcal''

The world of 3D game editing has inherited much confusing terminology to confuse the beginner. They often have little or no relationship to their normal dictionary definition. Here are a few common ones explained...

== AI ==
These are the functioning characters or creatures having AI - artificial intelligence to represent living sentient beings in the game: humans, animals, monsters. [[#NPC|NPC]] is another abbreviation for AI.

== Brush ==

A brush is normally an ''applicator'' to apply paint, ink, glue but in 3D gaming it means a raw shape. The most common shape is a simple block but Dark Mod provides pyramids, cones, spheres.

All Dark Mod brushes must be convex so you cannot have any recesses or concave angles such as in an L shape, a bowl, a hole in a wall. Instead multiple brushes must be used as building blocks to form these shapes.

Brushes are intended for simple shapes. More complex, detailed shapes like trees, AI characters, etc. are created externally as 'models'

A brush is a ''primitive'' and begins as a child of the worldspawn entity. This means it is a direct offshoot of the game world and inherits any properties applied to the worldspawn. If you select a brush and look in the Entity Inspector you will see the worldspawn properties.

A brush may be parented to another entity when it will inherit its properties.

== Entity ==

A functioning item. (Multiple) [[#Primitives|primitives]] such as brushes and patches, and also models, can be parented to it and thus inherit its properties and functions. Examples: working doors, moveable items (ie, not fixed, unmoving) lights, readable items, and so on.

Some do not have a visible form in-game at all but only a function such as to trigger an event when the player approaches or to hold the objectives (quests) information sound speakers etc.

A func_static is a passive entity that does nothing but remain fixed in place - it will not even fall if placed in mid-air.

== Frob ==

Frob is shortened for "frobnicate", which means to adjust/manipulate. In The Dark Mod, "frob" describes the interaction of the player with entities in the world. The possibility to interact with (or frob) an entity is indicated by the entity being highlighted when it is centred on the screen and the player is close enough to interact with it. This behaviour of the entity is called "frob highlight".

== func_static ==

A func_static is an [[#Entity]] which has no special function other than to be static but which nevertheless has the advantages of being an entity, such as it can group multiple brushes and patches together and many properties can be added that cannot be added to a plain worldspawn brush.

== Key ==

The property of an item (see [[#Spawnarg|Spawnarg]]).

Also used in-game for door and container keys etc.

== NPC ==

Stands for Non-Player Character and refers to basically [[#AI|AI]].

== Map ==

A game file. In Dark Mod saved with the suffix .map. A mission or a game level.

Also used in-game for city, treasure maps, etc.

== Materials ==

Materials are plain text definitions contained within files suffixed .mtr and stored in the darkmod/materials folder (within a pk4 zip archive by default.) They are often called material shaders or just shaders (not to be confused with sound shaders.) Sometimes they are just called textures but materials include other properties as well as the visible texture.

Material definitions include many properties such as textures, contour information, shinyness, sound, climbability, slippiness, translucency, as well as dynamic features such as animated water ripples.

Materials are initially selected from Dark Radiant's Media Browser. Textures already used in a map also show in the Texture Browser as a kind of shortcut. Both browsers are on the same panel as the Entity Inspector.

== Model ==

A model is an item that is designed externally in a modelling program. It is not a raw shape. It is pre-designed. Lots of models are provided in Dark Mod, just right click the grid view in Dark Radiant and select create model. For example furniture, decorative items, physical lights, and so on. These often have fine detail whereas building with brushes is mostly (but not always) more suited to larger, simpler shapes like terrain, walls, etc.

When creating a model, by default it becomes a func_static entity which is just passive and inactive. But you can change that eg, a door model can then be changed to be a door entity so it functions as an openable, lockable door in-game.

== Patch ==

A two dimensional surface

A patch is a ''primitive'' - a child of the worldspawn entity. This means it is a direct offshoot of the game world and inherits any properties applied to the worldspawn. If you select a brush and look in the Entity Inspector you will see the worldspawn properties.

A patch may be parented to another entity when it will inherit its properties.

Also may be used in-game by pirates!

== Prefab ==

A prefab is a prefabricated map section that can be imported into your map. It can include any game elements; lights, terrain, entities, models. Examples: an openable, lockable chest, shelves filled with kitchen items, a stairway with steps and railings, and so on. These can be modified by the mapper, eg, retextured, if they include brush or patch items.

You can create your own prefabs by selecting items and using menu > file > save selected as prefab. Example, if you built an archway it might be useful in another map so could be saved as a prefab and used again and again.

Dark Mod comes with many prefabs included. (you might need to extract these from their pk4 zip archive if using early versions of Dark Radiant before you can see them.)

If '''imported''' via the file menu they will be placed at the same position from where they were exported. They remain selected so you can move them.

If '''inserted''' via the right mouse button in grid view then their original position will be added as an offset to where your mouse is pointing. For this reason is it very important to alway move items to position 0, 0, 0 before saving as a prefab.

== Primitive ==

Initially a child of the worldspawn entity. This means it is a direct offshoot of the game world and inherits any properties applied to the worldspawn. [[#Brushes]] and [[#Patches]] are primitives.

== Shaders ==

Shaders may be ''sound shaders'' (see [[#Sound Shaders]] or ''material shaders'' (see [[#Materials]])

==Sound Shaders==

Sound shaders are plain text definitions stored in files suffixed .sndshd in the darkmod/sound folder (may be in a pk4 zip archive.) They include information about sound files and how they should be played in the game.

== Spawnarg ==

A spawnarg is an argument (in the mathematical sense) given to an entity or primitive when it is first created (spawned.) These are the properties of the item and consist of a property name and its value (quantity, type, description or nature.) It is often referred to as a ''key value pair'' as it represented in the software code in that form. The ''key'' is the property name such as origin, rotation, team. The value can be numerical: 99 - or a string of alphanumeric character abcd99_xyz. There can be one or more values. Examples:

Name (property, key): origin

Value: 496 656 128

Name: team

Value: 2

Name: head_joint

Value: Head

see also [[Spawnarg]]

== Textures ==

See [[#Materials]]

[[Category:Documentation]]
{{editing}}

Stim/Response Editor

2018-03-04T16:04:08Z

Destined: /* Examples: */

==== Stim / Response Editor ===

The Stim/Response Editor was introduced to save typing each arg for every stim and response on the page, [[Stim/Response Key/Values]] that also contains more specific descriptions as to what each Stim/Response [[Glossary#Spawnarg|arg]] does.

For more general reading on stims and responses, please see also the pages [[Stim/Response]] and [[Stim/Response Key/Values]].

== Stims ==

To add a stim or response to an entity, open the Stim/Response editor:
Select the entity and - from the menu bar - go to Entity > Stim/Response.
The Stim/Response Editor has three tabs: Stims, Responses and Custom Stims.
As stated on the [[Stim/Response]] page, an entity can have either or both Stims and Responses, but is not able to crate a Response through a Stim fired on itself.

To add a non-custom Stim, select the "Stims" tab.
From here, it is possible to add a Stim from the drop-down menu next to the "Add" button, clicking the Add button and choosing a stim from the "Type" drop-down menu at the top ("Frob" being the default) or using a keyboard shortcut by pressing the initial letter of the Stim type you'd like to add.

Select the Stim to edit from the numbered list on the left.
If no Stim type is selected, all options presented on the right are greyed out.
The options on the right side of the editor allow changes to all key values of the Stim, removing the need to type and enter manually all key values as listed and described in [[Stim/Response Key/Values]].

== Responses ==

The Response Editor is a simplified way to create basic scripts without need for deeper knowledge on scripting for TDM.
It works similar to the Stim Editor, but for adding Stims that will act as entity responses.
In the Responses tab, the Stim to which the selected entity should respond is selected in the same way as the Stims tab.

However, this only tells the entity that it must show a response to a certain Stim type. For a response to happen, there must be an effect.
To add an effect, right-click in the "Response Effects" window and press, "Add new Effect".
Double-clicking the numbered Response, or right-clicking it and choosing "Edit", open the "Edit Response Effect" box in which it is possible to select the target entity, type of Stim (as args) and the Response effect itself.

----

=== Available effects are: ===

* '''Activate Response:''' Activates the Response for the stated Stim Type on the stated Entity.
** E.g. the player must give a fire stim to a furnace in order to have a door react to a frob Stim.
* '''Activate Shooter:''' Activates the named Shooter entity.
** E.g. Can be used to activate a trap.
* '''Activate Stim:''' Activates the Stim for the stated Stim Type on the named Entity.
** E.g. Adds a damage stim to the furnace after a fire stim is given.
* '''Add Target: ''' Adds the stated Target to the named Entity.
** E.g. Add a new path_corner to a patrol route.
* '''Apply Stim:''' Fires a Stim of the stated Stim Type to the named Target.
** The Source can be changed, but is not necessary.
* '''Blind AI:''' Blinds the named AI as if a flash bomb has been used on it.
* '''Clear Targets:''' Removes all Target-args from the named Entity.
* '''Damage:''' Applies a damage type to the stated Target.
** Damage Defs can be found in the def file "darkmod/tdm_defs01.pk4/defs/tdm_damage.def".
* '''Deactivate Response:''' Deactivates the Response for the stated Stim Type on the named Entity.
* '''Deactivate Shooter:''' Deactivates the stated Shooter.
** E.g. Can be used to disarm a trap.
* '''Deactivate Stim:''' Deactivates the Stim for the stated Stim Type on the named Entity.
* '''Disable Effect:''' Disables only one Effect on the named Entity.
** The Effect is defined by two numbers (e.g. 2_3), meaning that the Effect numbered 3 on the Response number 2 is disabled. The respective numbers can be found in the first column of the Response Effects window.
* '''Enable Effect:''' Enables only one Effect on the stated Entity.
** The Effect is defined by two numbers (e.g. 2_3), meaning that the Effect numbered 3 on the Response numbered 2 is enabled. The respective numbers can be found in the first column of the Response Effects window.
* '''Fade Light Color:''' Changes the colour of the named Target Light to the stated Color over a time of Fade Time seconds.
* '''Frob:''' Frobs the named Entity as if it had been frobbed by the player.
* '''Gas Knockout:''' Knocks out the named Target as if it had been hit with a gas arrow.
* '''Heal:''' Heals the named Target by the stated Amount.
* '''Kill:''' Kills the named Target.
* '''Knockout:''' Knocks out the named Target as if it had been hit with the blackjack.
* '''Turn extinguishable Light Off:''' Extinguishes the named extinguishable Light.
* '''Turn extinguishable Light On:''' (Re)ignites the named extinguishable Light.
* '''Turn Light Off:''' Turns off the named Light.
* '''Turn Light On:''' Turns on the named Light.
* '''Move To Position:''' Moves the named Entity to the stated Position (coordinates: X Y Z).
** If the box "Relative to old origin" is ticked, the Entity is moved (X Y Z) units from its current location.
* '''Move To Random Position:''' Moves the named Entity to a random position inside the "Within Radius" range.
* '''Play Animation:''' Plays the stated Animation for the stated Entity.
** The Animation can be limited to only one channel (such as only the head or similar), but is best left this blank, unless sure of intent.
* '''Play Sound:''' Play the named entity's stated Sound.
** The channel can be limited (e.g. to the player voice or ambient), but this can also be left blank.
* '''Play Sound Shader:''' Plays the named Sound Shader on the stated channel (as before the channel does not need not be defined). This is not limited to inherited sounds of the entity.
* '''Remove:''' Removes the named Target from the map.
* '''Run Script:''' Runs the named Script. For more information on scripts refer to [[Scripting basics]].
* '''Set AI Team:''' Change the named AI's team to the stated Team.
** For a list of which AI belongs to which team by default, refer to [[AI_Relations_(Editing)#AI_Types_.28Teams.29|AI Relations]]
* '''Set Angles:''' Set the named Target's rotation to the stated Angles (in pitch/yaw/roll).
** As with Move To Position, this is also possible relative to the entity's current angles.
* '''Set Frobable:''' Sets the named Entity as frobable (box checked) or unfrobable (box unchecked).
* '''Set Light Color:''' Changes the colour of the named Target Light to the stated Color.
** In contrast to "Fade to Color", this happens without any transition.
* '''Set Model:''' Changes the current model of the named Target to the stated Model.
** E.g. Can be used to change a model to a broken model after recieving damage.
* '''Set Skin:''' Changes the current skin of the stated Target to the stated Skin.
* '''Set Spawnarg:''' Changes the value of a Key (Spawnarg) on the stated Target to a stated Value.
* '''Spawn Entity:''' Creates an [[entity]] of the stated Entity Class at a given location Origin (X Y Z). E.g. can be used to create new loot through an event.
* '''Spawn Particle:''' Creates an emitter that will emit the named [[Particles|particle]] (including its .prt extension) at the location Origin (X Y Z) that stay there for stated Lifetime seconds. If no Lifetime is given it stays infinitely.
* '''Start Stim Timer:''' Starts the timer of the stated Stim on the named Entity.
** For information about how a timer on a Stim works, refer to [[Stim/Response Key/Values]], E.g. Key: sr_timer_time_N.
* '''Stop Stim Timer:''' Stops the timer of the stated Stim on the named Entity.
** For information about how a timer on a Stim works, refer to [[Stim/Response Key/Values]], E.g. Key: sr_timer_time_N.
* '''Teleport (Set Origin):''' Moves the named Entity to the stated location's New Origin (coordinates: X Y Z).
** If the box "Relative to old origin" is checked, the Entity is moved (X Y Z) units from its current location.
* '''Toggle Effect:''' Disables the stated Effect if enabled or enables the stated Effect if disabled on the named Entity.
** The Effect is defined by two numbers (e.g. 2_3), meaning that the Effect numbered 3 on the Response numbered 2 is disabled. The respective numbers can be found in the first column of the Response Effects window.
* '''Toggle Light:''' Turns off the named Light if on or turns on the named Light if off.
* '''Trigger:''' Activates the named Target Trigger entity as if activated by the stated Activator. (If I remember correctly, this does not count as a trigger Stim. For this you would have to target a trigger entity, that then targets the entity you wish to receive the trigger Stim).

The Response list gives a variety of options that allows for many effects without the need to write scripts.

It is possible to add several effects with one response type by checking the box, "Random Effects" and entering the number of random effects to be used.
Note that each effect can be used multiple times. E.g. Selecting only one effect and setting "Random Effects: 3" will use the same effect three times.

----

=== Examples: ===

== Arrow Trap: ==

First, create an "atdm:func_shooter" entity and position it so that the arrow points in the desired direction to shoot.
''Note that this entity does not have a model. If a model is required, the shooter can be placed in front of the approriate model''.
Define the projectile to be fired (the default is a fire arrow) and check the pitch for the projectile's trajectory.

Next, it is necessary to create an activator, that can be achieved with the Stim/Response Editor as follows:
* Create a brush, giving it a NoDraw texture and convert it to a [[Glossary#func_static|func_static]].
* Place this func_static entity, where the shooter is to be activated (note that the radius of the Player Stim is 350 with a Falloff Exponent of 3 around the player. This results in an effective radius of around 100 [[Limits,_Max,_Min,_Stats,_etc#Conversion_of_game units|units]]).
* Open the Stim/Response Editor.
* Add a Response "Player" to the NoDraw func_static entity.
* To that Response, add the Effect "Activate Shooter" with the name of the shooter as "Shooter Entity".

Now the shooter will start firing as soon as the player comes withing 100 units of the NoDraw func_static entity.

There are three options:

* If the the setup is left as it is, the shooter will continuously fire.
* If the shooter is given an ammo value that is not -1, the shooter will stop firing some time, depending on if the ammo is depleted, after the player moves away from the NoDraw func_static entity.
* If the shooter is to fire only once, it is necessary to add the Effect, "Disable Effect" and target the first effect that activates the shooter or give an ammo value of 1.

It may also possible for the player to disarm the trap:

* Create a response on another entity that the player will use to do to disarm the trap.

''E.g. Frob, if the player is to push a button or use a switch or lever, or a Water response if the player is to shoot a water arrow on a circuit board or a furnace. The possibilities are endless.''

* Add the same "Disable Effect" effect as before.
* It is also possible to use the Effect, "Remove shooter". But if this is used, the shooter will not be reactivated (E.g. if the player re-arms the trap, as above).
''Note that using this setup, where the Response is "Player", the trap will exclusively react to the player and not to any AI.''

----

== Change Patrol: ==
An AI's behaviour, such as its [[AI_Patrol|patrol route]], may be altered through a response.
E.g. If the player has taken a specific loot item.

* Give the loot item a Response "Frob".
* Add the effect "Add Target".
* As the "Entity" do not use the AI, but the path_corner from which the AI is to leave its original path to enter the new one.
* As "Target" put in the first path_corner of the new path.

If the new path circles back to the original path, the path will fork at this point:
if the new path does not target any path_corner of the original path, the AI will remain patrolling the new path.

Stim/Response Editor

2018-03-04T16:03:40Z

Destined: /* Available effects are: = */

==== Stim / Response Editor ===

The Stim/Response Editor was introduced to save typing each arg for every stim and response on the page, [[Stim/Response Key/Values]] that also contains more specific descriptions as to what each Stim/Response [[Glossary#Spawnarg|arg]] does.

For more general reading on stims and responses, please see also the pages [[Stim/Response]] and [[Stim/Response Key/Values]].

== Stims ==

To add a stim or response to an entity, open the Stim/Response editor:
Select the entity and - from the menu bar - go to Entity > Stim/Response.
The Stim/Response Editor has three tabs: Stims, Responses and Custom Stims.
As stated on the [[Stim/Response]] page, an entity can have either or both Stims and Responses, but is not able to crate a Response through a Stim fired on itself.

To add a non-custom Stim, select the "Stims" tab.
From here, it is possible to add a Stim from the drop-down menu next to the "Add" button, clicking the Add button and choosing a stim from the "Type" drop-down menu at the top ("Frob" being the default) or using a keyboard shortcut by pressing the initial letter of the Stim type you'd like to add.

Select the Stim to edit from the numbered list on the left.
If no Stim type is selected, all options presented on the right are greyed out.
The options on the right side of the editor allow changes to all key values of the Stim, removing the need to type and enter manually all key values as listed and described in [[Stim/Response Key/Values]].

== Responses ==

The Response Editor is a simplified way to create basic scripts without need for deeper knowledge on scripting for TDM.
It works similar to the Stim Editor, but for adding Stims that will act as entity responses.
In the Responses tab, the Stim to which the selected entity should respond is selected in the same way as the Stims tab.

However, this only tells the entity that it must show a response to a certain Stim type. For a response to happen, there must be an effect.
To add an effect, right-click in the "Response Effects" window and press, "Add new Effect".
Double-clicking the numbered Response, or right-clicking it and choosing "Edit", open the "Edit Response Effect" box in which it is possible to select the target entity, type of Stim (as args) and the Response effect itself.

----

=== Available effects are: ===

* '''Activate Response:''' Activates the Response for the stated Stim Type on the stated Entity.
** E.g. the player must give a fire stim to a furnace in order to have a door react to a frob Stim.
* '''Activate Shooter:''' Activates the named Shooter entity.
** E.g. Can be used to activate a trap.
* '''Activate Stim:''' Activates the Stim for the stated Stim Type on the named Entity.
** E.g. Adds a damage stim to the furnace after a fire stim is given.
* '''Add Target: ''' Adds the stated Target to the named Entity.
** E.g. Add a new path_corner to a patrol route.
* '''Apply Stim:''' Fires a Stim of the stated Stim Type to the named Target.
** The Source can be changed, but is not necessary.
* '''Blind AI:''' Blinds the named AI as if a flash bomb has been used on it.
* '''Clear Targets:''' Removes all Target-args from the named Entity.
* '''Damage:''' Applies a damage type to the stated Target.
** Damage Defs can be found in the def file "darkmod/tdm_defs01.pk4/defs/tdm_damage.def".
* '''Deactivate Response:''' Deactivates the Response for the stated Stim Type on the named Entity.
* '''Deactivate Shooter:''' Deactivates the stated Shooter.
** E.g. Can be used to disarm a trap.
* '''Deactivate Stim:''' Deactivates the Stim for the stated Stim Type on the named Entity.
* '''Disable Effect:''' Disables only one Effect on the named Entity.
** The Effect is defined by two numbers (e.g. 2_3), meaning that the Effect numbered 3 on the Response number 2 is disabled. The respective numbers can be found in the first column of the Response Effects window.
* '''Enable Effect:''' Enables only one Effect on the stated Entity.
** The Effect is defined by two numbers (e.g. 2_3), meaning that the Effect numbered 3 on the Response numbered 2 is enabled. The respective numbers can be found in the first column of the Response Effects window.
* '''Fade Light Color:''' Changes the colour of the named Target Light to the stated Color over a time of Fade Time seconds.
* '''Frob:''' Frobs the named Entity as if it had been frobbed by the player.
* '''Gas Knockout:''' Knocks out the named Target as if it had been hit with a gas arrow.
* '''Heal:''' Heals the named Target by the stated Amount.
* '''Kill:''' Kills the named Target.
* '''Knockout:''' Knocks out the named Target as if it had been hit with the blackjack.
* '''Turn extinguishable Light Off:''' Extinguishes the named extinguishable Light.
* '''Turn extinguishable Light On:''' (Re)ignites the named extinguishable Light.
* '''Turn Light Off:''' Turns off the named Light.
* '''Turn Light On:''' Turns on the named Light.
* '''Move To Position:''' Moves the named Entity to the stated Position (coordinates: X Y Z).
** If the box "Relative to old origin" is ticked, the Entity is moved (X Y Z) units from its current location.
* '''Move To Random Position:''' Moves the named Entity to a random position inside the "Within Radius" range.
* '''Play Animation:''' Plays the stated Animation for the stated Entity.
** The Animation can be limited to only one channel (such as only the head or similar), but is best left this blank, unless sure of intent.
* '''Play Sound:''' Play the named entity's stated Sound.
** The channel can be limited (e.g. to the player voice or ambient), but this can also be left blank.
* '''Play Sound Shader:''' Plays the named Sound Shader on the stated channel (as before the channel does not need not be defined). This is not limited to inherited sounds of the entity.
* '''Remove:''' Removes the named Target from the map.
* '''Run Script:''' Runs the named Script. For more information on scripts refer to [[Scripting basics]].
* '''Set AI Team:''' Change the named AI's team to the stated Team.
** For a list of which AI belongs to which team by default, refer to [[AI_Relations_(Editing)#AI_Types_.28Teams.29|AI Relations]]
* '''Set Angles:''' Set the named Target's rotation to the stated Angles (in pitch/yaw/roll).
** As with Move To Position, this is also possible relative to the entity's current angles.
* '''Set Frobable:''' Sets the named Entity as frobable (box checked) or unfrobable (box unchecked).
* '''Set Light Color:''' Changes the colour of the named Target Light to the stated Color.
** In contrast to "Fade to Color", this happens without any transition.
* '''Set Model:''' Changes the current model of the named Target to the stated Model.
** E.g. Can be used to change a model to a broken model after recieving damage.
* '''Set Skin:''' Changes the current skin of the stated Target to the stated Skin.
* '''Set Spawnarg:''' Changes the value of a Key (Spawnarg) on the stated Target to a stated Value.
* '''Spawn Entity:''' Creates an [[entity]] of the stated Entity Class at a given location Origin (X Y Z). E.g. can be used to create new loot through an event.
* '''Spawn Particle:''' Creates an emitter that will emit the named [[Particles|particle]] (including its .prt extension) at the location Origin (X Y Z) that stay there for stated Lifetime seconds. If no Lifetime is given it stays infinitely.
* '''Start Stim Timer:''' Starts the timer of the stated Stim on the named Entity.
** For information about how a timer on a Stim works, refer to [[Stim/Response Key/Values]], E.g. Key: sr_timer_time_N.
* '''Stop Stim Timer:''' Stops the timer of the stated Stim on the named Entity.
** For information about how a timer on a Stim works, refer to [[Stim/Response Key/Values]], E.g. Key: sr_timer_time_N.
* '''Teleport (Set Origin):''' Moves the named Entity to the stated location's New Origin (coordinates: X Y Z).
** If the box "Relative to old origin" is checked, the Entity is moved (X Y Z) units from its current location.
* '''Toggle Effect:''' Disables the stated Effect if enabled or enables the stated Effect if disabled on the named Entity.
** The Effect is defined by two numbers (e.g. 2_3), meaning that the Effect numbered 3 on the Response numbered 2 is disabled. The respective numbers can be found in the first column of the Response Effects window.
* '''Toggle Light:''' Turns off the named Light if on or turns on the named Light if off.
* '''Trigger:''' Activates the named Target Trigger entity as if activated by the stated Activator. (If I remember correctly, this does not count as a trigger Stim. For this you would have to target a trigger entity, that then targets the entity you wish to receive the trigger Stim).

The Response list gives a variety of options that allows for many effects without the need to write scripts.

It is possible to add several effects with one response type by checking the box, "Random Effects" and entering the number of random effects to be used.
Note that each effect can be used multiple times. E.g. Selecting only one effect and setting "Random Effects: 3" will use the same effect three times.

----

== Examples: ==

=== Arrow Trap: ===

First, create an "atdm:func_shooter" entity and position it so that the arrow points in the desired direction to shoot.
''Note that this entity does not have a model. If a model is required, the shooter can be placed in front of the approriate model''.
Define the projectile to be fired (the default is a fire arrow) and check the pitch for the projectile's trajectory.

Next, it is necessary to create an activator, that can be achieved with the Stim/Response Editor as follows:
* Create a brush, giving it a NoDraw texture and convert it to a [[Glossary#func_static|func_static]].
* Place this func_static entity, where the shooter is to be activated (note that the radius of the Player Stim is 350 with a Falloff Exponent of 3 around the player. This results in an effective radius of around 100 [[Limits,_Max,_Min,_Stats,_etc#Conversion_of_game units|units]]).
* Open the Stim/Response Editor.
* Add a Response "Player" to the NoDraw func_static entity.
* To that Response, add the Effect "Activate Shooter" with the name of the shooter as "Shooter Entity".

Now the shooter will start firing as soon as the player comes withing 100 units of the NoDraw func_static entity.

There are three options:

* If the the setup is left as it is, the shooter will continuously fire.
* If the shooter is given an ammo value that is not -1, the shooter will stop firing some time, depending on if the ammo is depleted, after the player moves away from the NoDraw func_static entity.
* If the shooter is to fire only once, it is necessary to add the Effect, "Disable Effect" and target the first effect that activates the shooter or give an ammo value of 1.

It may also possible for the player to disarm the trap:

* Create a response on another entity that the player will use to do to disarm the trap.

''E.g. Frob, if the player is to push a button or use a switch or lever, or a Water response if the player is to shoot a water arrow on a circuit board or a furnace. The possibilities are endless.''

* Add the same "Disable Effect" effect as before.
* It is also possible to use the Effect, "Remove shooter". But if this is used, the shooter will not be reactivated (E.g. if the player re-arms the trap, as above).
''Note that using this setup, where the Response is "Player", the trap will exclusively react to the player and not to any AI.''

----

=== Change Patrol: ===
An AI's behaviour, such as its [[AI_Patrol|patrol route]], may be altered through a response.
E.g. If the player has taken a specific loot item.

* Give the loot item a Response "Frob".
* Add the effect "Add Target".
* As the "Entity" do not use the AI, but the path_corner from which the AI is to leave its original path to enter the new one.
* As "Target" put in the first path_corner of the new path.

If the new path circles back to the original path, the path will fork at this point:
if the new path does not target any path_corner of the original path, the AI will remain patrolling the new path.

Stim/Response Editor

2018-03-04T16:01:50Z

Destined:

==== Stim / Response Editor ===

The Stim/Response Editor was introduced to save typing each arg for every stim and response on the page, [[Stim/Response Key/Values]] that also contains more specific descriptions as to what each Stim/Response [[Glossary#Spawnarg|arg]] does.

For more general reading on stims and responses, please see also the pages [[Stim/Response]] and [[Stim/Response Key/Values]].

== Stims ==

To add a stim or response to an entity, open the Stim/Response editor:
Select the entity and - from the menu bar - go to Entity > Stim/Response.
The Stim/Response Editor has three tabs: Stims, Responses and Custom Stims.
As stated on the [[Stim/Response]] page, an entity can have either or both Stims and Responses, but is not able to crate a Response through a Stim fired on itself.

To add a non-custom Stim, select the "Stims" tab.
From here, it is possible to add a Stim from the drop-down menu next to the "Add" button, clicking the Add button and choosing a stim from the "Type" drop-down menu at the top ("Frob" being the default) or using a keyboard shortcut by pressing the initial letter of the Stim type you'd like to add.

Select the Stim to edit from the numbered list on the left.
If no Stim type is selected, all options presented on the right are greyed out.
The options on the right side of the editor allow changes to all key values of the Stim, removing the need to type and enter manually all key values as listed and described in [[Stim/Response Key/Values]].

== Responses ==

The Response Editor is a simplified way to create basic scripts without need for deeper knowledge on scripting for TDM.
It works similar to the Stim Editor, but for adding Stims that will act as entity responses.
In the Responses tab, the Stim to which the selected entity should respond is selected in the same way as the Stims tab.

However, this only tells the entity that it must show a response to a certain Stim type. For a response to happen, there must be an effect.
To add an effect, right-click in the "Response Effects" window and press, "Add new Effect".
Double-clicking the numbered Response, or right-clicking it and choosing "Edit", open the "Edit Response Effect" box in which it is possible to select the target entity, type of Stim (as args) and the Response effect itself.

----

=== Available effects are: ====

* '''Activate Response:''' Activates the Response for the stated Stim Type on the stated Entity.
** E.g. the player must give a fire stim to a furnace in order to have a door react to a frob Stim.
* '''Activate Shooter:''' Activates the named Shooter entity.
** E.g. Can be used to activate a trap.
* '''Activate Stim:''' Activates the Stim for the stated Stim Type on the named Entity.
** E.g. Adds a damage stim to the furnace after a fire stim is given.
* '''Add Target: ''' Adds the stated Target to the named Entity.
** E.g. Add a new path_corner to a patrol route.
* '''Apply Stim:''' Fires a Stim of the stated Stim Type to the named Target.
** The Source can be changed, but is not necessary.
* '''Blind AI:''' Blinds the named AI as if a flash bomb has been used on it.
* '''Clear Targets:''' Removes all Target-args from the named Entity.
* '''Damage:''' Applies a damage type to the stated Target.
** Damage Defs can be found in the def file "darkmod/tdm_defs01.pk4/defs/tdm_damage.def".
* '''Deactivate Response:''' Deactivates the Response for the stated Stim Type on the named Entity.
* '''Deactivate Shooter:''' Deactivates the stated Shooter.
** E.g. Can be used to disarm a trap.
* '''Deactivate Stim:''' Deactivates the Stim for the stated Stim Type on the named Entity.
* '''Disable Effect:''' Disables only one Effect on the named Entity.
** The Effect is defined by two numbers (e.g. 2_3), meaning that the Effect numbered 3 on the Response number 2 is disabled. The respective numbers can be found in the first column of the Response Effects window.
* '''Enable Effect:''' Enables only one Effect on the stated Entity.
** The Effect is defined by two numbers (e.g. 2_3), meaning that the Effect numbered 3 on the Response numbered 2 is enabled. The respective numbers can be found in the first column of the Response Effects window.
* '''Fade Light Color:''' Changes the colour of the named Target Light to the stated Color over a time of Fade Time seconds.
* '''Frob:''' Frobs the named Entity as if it had been frobbed by the player.
* '''Gas Knockout:''' Knocks out the named Target as if it had been hit with a gas arrow.
* '''Heal:''' Heals the named Target by the stated Amount.
* '''Kill:''' Kills the named Target.
* '''Knockout:''' Knocks out the named Target as if it had been hit with the blackjack.
* '''Turn extinguishable Light Off:''' Extinguishes the named extinguishable Light.
* '''Turn extinguishable Light On:''' (Re)ignites the named extinguishable Light.
* '''Turn Light Off:''' Turns off the named Light.
* '''Turn Light On:''' Turns on the named Light.
* '''Move To Position:''' Moves the named Entity to the stated Position (coordinates: X Y Z).
** If the box "Relative to old origin" is ticked, the Entity is moved (X Y Z) units from its current location.
* '''Move To Random Position:''' Moves the named Entity to a random position inside the "Within Radius" range.
* '''Play Animation:''' Plays the stated Animation for the stated Entity.
** The Animation can be limited to only one channel (such as only the head or similar), but is best left this blank, unless sure of intent.
* '''Play Sound:''' Play the named entity's stated Sound.
** The channel can be limited (e.g. to the player voice or ambient), but this can also be left blank.
* '''Play Sound Shader:''' Plays the named Sound Shader on the stated channel (as before the channel does not need not be defined). This is not limited to inherited sounds of the entity.
* '''Remove:''' Removes the named Target from the map.
* '''Run Script:''' Runs the named Script. For more information on scripts refer to [[Scripting basics]].
* '''Set AI Team:''' Change the named AI's team to the stated Team.
** For a list of which AI belongs to which team by default, refer to [[AI_Relations_(Editing)#AI_Types_.28Teams.29|AI Relations]]
* '''Set Angles:''' Set the named Target's rotation to the stated Angles (in pitch/yaw/roll).
** As with Move To Position, this is also possible relative to the entity's current angles.
* '''Set Frobable:''' Sets the named Entity as frobable (box checked) or unfrobable (box unchecked).
* '''Set Light Color:''' Changes the colour of the named Target Light to the stated Color.
** In contrast to "Fade to Color", this happens without any transition.
* '''Set Model:''' Changes the current model of the named Target to the stated Model.
** E.g. Can be used to change a model to a broken model after recieving damage.
* '''Set Skin:''' Changes the current skin of the stated Target to the stated Skin.
* '''Set Spawnarg:''' Changes the value of a Key (Spawnarg) on the stated Target to a stated Value.
* '''Spawn Entity:''' Creates an [[entity]] of the stated Entity Class at a given location Origin (X Y Z). E.g. can be used to create new loot through an event.
* '''Spawn Particle:''' Creates an emitter that will emit the named [[Particles|particle]] (including its .prt extension) at the location Origin (X Y Z) that stay there for stated Lifetime seconds. If no Lifetime is given it stays infinitely.
* '''Start Stim Timer:''' Starts the timer of the stated Stim on the named Entity.
** For information about how a timer on a Stim works, refer to [[Stim/Response Key/Values]], E.g. Key: sr_timer_time_N.
* '''Stop Stim Timer:''' Stops the timer of the stated Stim on the named Entity.
** For information about how a timer on a Stim works, refer to [[Stim/Response Key/Values]], E.g. Key: sr_timer_time_N.
* '''Teleport (Set Origin):''' Moves the named Entity to the stated location's New Origin (coordinates: X Y Z).
** If the box "Relative to old origin" is checked, the Entity is moved (X Y Z) units from its current location.
* '''Toggle Effect:''' Disables the stated Effect if enabled or enables the stated Effect if disabled on the named Entity.
** The Effect is defined by two numbers (e.g. 2_3), meaning that the Effect numbered 3 on the Response numbered 2 is disabled. The respective numbers can be found in the first column of the Response Effects window.
* '''Toggle Light:''' Turns off the named Light if on or turns on the named Light if off.
* '''Trigger:''' Activates the named Target Trigger entity as if activated by the stated Activator. (If I remember correctly, this does not count as a trigger Stim. For this you would have to target a trigger entity, that then targets the entity you wish to receive the trigger Stim).

The Response list gives a variety of options that allows for many effects without the need to write scripts.

It is possible to add several effects with one response type by checking the box, "Random Effects" and entering the number of random effects to be used.
Note that each effect can be used multiple times. E.g. Selecting only one effect and setting "Random Effects: 3" will use the same effect three times.

----

== Examples: ==

=== Arrow Trap: ===

First, create an "atdm:func_shooter" entity and position it so that the arrow points in the desired direction to shoot.
''Note that this entity does not have a model. If a model is required, the shooter can be placed in front of the approriate model''.
Define the projectile to be fired (the default is a fire arrow) and check the pitch for the projectile's trajectory.

Next, it is necessary to create an activator, that can be achieved with the Stim/Response Editor as follows:
* Create a brush, giving it a NoDraw texture and convert it to a [[Glossary#func_static|func_static]].
* Place this func_static entity, where the shooter is to be activated (note that the radius of the Player Stim is 350 with a Falloff Exponent of 3 around the player. This results in an effective radius of around 100 [[Limits,_Max,_Min,_Stats,_etc#Conversion_of_game units|units]]).
* Open the Stim/Response Editor.
* Add a Response "Player" to the NoDraw func_static entity.
* To that Response, add the Effect "Activate Shooter" with the name of the shooter as "Shooter Entity".

Now the shooter will start firing as soon as the player comes withing 100 units of the NoDraw func_static entity.

There are three options:

* If the the setup is left as it is, the shooter will continuously fire.
* If the shooter is given an ammo value that is not -1, the shooter will stop firing some time, depending on if the ammo is depleted, after the player moves away from the NoDraw func_static entity.
* If the shooter is to fire only once, it is necessary to add the Effect, "Disable Effect" and target the first effect that activates the shooter or give an ammo value of 1.

It may also possible for the player to disarm the trap:

* Create a response on another entity that the player will use to do to disarm the trap.

''E.g. Frob, if the player is to push a button or use a switch or lever, or a Water response if the player is to shoot a water arrow on a circuit board or a furnace. The possibilities are endless.''

* Add the same "Disable Effect" effect as before.
* It is also possible to use the Effect, "Remove shooter". But if this is used, the shooter will not be reactivated (E.g. if the player re-arms the trap, as above).
''Note that using this setup, where the Response is "Player", the trap will exclusively react to the player and not to any AI.''

----

=== Change Patrol: ===
An AI's behaviour, such as its [[AI_Patrol|patrol route]], may be altered through a response.
E.g. If the player has taken a specific loot item.

* Give the loot item a Response "Frob".
* Add the effect "Add Target".
* As the "Entity" do not use the AI, but the path_corner from which the AI is to leave its original path to enter the new one.
* As "Target" put in the first path_corner of the new path.

If the new path circles back to the original path, the path will fork at this point:
if the new path does not target any path_corner of the original path, the AI will remain patrolling the new path.

Console Useful Controls

2018-01-23T07:00:26Z

Destined: /* Introduction */

==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).

==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>
* Many controls can be included in the file '''Doomconfig.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_show_loot
|Shows loot items 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|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|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. (2) Shows overdrawn tri's. (3) Shows all tri's in scene, direct and indirect.

|-
!align=left|r_showportals 1
|Shows all portals in scene (red=closed,green=open). If your portals don't show up they are most likely not sealing.

|-
!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.

|}

== Spawning entities ==

{|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 in front of the player. Look up if entity gets spawned under the floor.

|-
!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|countEntities
|displays a count of entities by class. ''TDM 2.03+''

|-
!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]]

Console Useful Controls

2018-01-23T06:59:40Z

Destined: /* Introduction */

==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).

==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>
* Many controls can be included in the file '''Doomconfig.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_show_loot
|Shows loot items 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|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|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. (2) Shows overdrawn tri's. (3) Shows all tri's in scene, direct and indirect.

|-
!align=left|r_showportals 1
|Shows all portals in scene (red=closed,green=open). If your portals don't show up they are most likely not sealing.

|-
!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.

|}

== Spawning entities ==

{|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 in front of the player. Look up if entity gets spawned under the floor.

|-
!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|countEntities
|displays a count of entities by class. ''TDM 2.03+''

|-
!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]]

Console Useful Controls

2018-01-23T06:56:07Z

Destined: /* Introduction */

==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|^}}" on European keyboards).

==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>
* Many controls can be included in the file '''Doomconfig.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_show_loot
|Shows loot items 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|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|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. (2) Shows overdrawn tri's. (3) Shows all tri's in scene, direct and indirect.

|-
!align=left|r_showportals 1
|Shows all portals in scene (red=closed,green=open). If your portals don't show up they are most likely not sealing.

|-
!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.

|}

== Spawning entities ==

{|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 in front of the player. Look up if entity gets spawned under the floor.

|-
!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|countEntities
|displays a count of entities by class. ''TDM 2.03+''

|-
!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]]

Sleeping AI

2017-12-12T10:04:49Z

Destined: /* Sleeping While Sitting */

==Introduction==

Sleeping AI are (mostly) working now. They can either put themselves to bed at map start and remain there (unless alerted) or else patrol, sleep for a while, then patrol again.

==Non-patrolling sleepers==

These are defined as sleepers at the start and immediately lay down. They only will get up if alerted.

Set on the AI the spawn arg:

''sleeping 1''

==Patrol Sleepers==

This is done by targeting a path_sleep entity which then targets a path_wait to define how long they will sleep before getting up again.

==Sleep Location==

''sleep_location 0'' - sleep on the floor

''sleep_location 1'' - sleep on a bed

==Setting up==

By default, place the AI on the right side of the bed (as you look towards the head of the bed) and '''facing away''' from the bed.

===Direction===

If you want the AI to start from the left side of the bed (as you look towards the head of the bed) then add:

''lay_down_left 0'' (note this goes on the AI if the AI is using sleeping 1 BUT on the path_sleep if you are using a path_sleep)

===Sleeping position in the bed===

====Head to Toe====

Stand the AI close to the bed facing away from it and about half way between the head and the foot; adjust as needed towards the head or foot direction of the bed.

====Sideways====

The distance the AI slides across onto the bed can be controlled by

''lay_down_slide_dist 16'' (default)

(note this goes on the AI if the AI is using sleeping 1 BUT on the path_sleep if you are using a path_sleep)

==Monster clip the bed or not?==

Yes, monster clip should not directly affect the sleep animation and the bed should normally be monsterclipped anyway. The only way it might affect it is if the clip sticks out too far and stops the AI getting near enough. In that case reduce the clip close to the bed edge and/or adjust the slide value (see [[#Sleeping position in the bed]])

==Problems, Troubleshooting==

There are a few known problems:

===AI is sinking into the bed or floating high===

AI animate to the same height so if they are slightly high the first thing to check is the bed surface height. Most Dark Mod beds are a standard height which is correct for sleepers. One known bed (at time of writing) is a little high so AI will animate into it so be sunk a little low. This bed can be sunk a little into the floor to compensate. If they are floating slightly high then the bed can be lifted a little and perhaps some wood brushes under the legs make it right.

If the AI are floating '''very''' high then this is most likely caused by the AI clipping into the bed at the start so they are lifted up to stand on its edge before they animate. They then animate up even higher. Solution: move them further out at the start. Note: this problem probably only affects AI that start off sleeping rather than patrol to a bed.

===AI lays down too far to one side of the bed===

To move an AI across the bed see [[#Sleeping position in the bed]]

===AI lays wrong way head to foot===

If the AI is laying the wrong way with his head at the foot of the bed and his feet at the head then see [[#Direction]]

==Sleeping While Sitting==

The following pertains to TDM versions 2.05 or earlier. See below for 2.06 and later behavior.

It is also possible to put an AI to sleep on a chair. This requires a more elaborate setup than the regular sleeping while lying down, as the animations of the sleeping behaviour have to be exchanged. In order to achieve this, a dummy entity is required. Up to now, this entity is not part of the core mod, so the following has to be copy/pasted into a def file, that then has to be put into the folder "def" of the mod or the FM that uses it:

entityDef atdm:animation_sleep_sit {
"inherit" "atdm:prop_base"
"editor_usage" "Used to make AI sleep in a sitting position instead of laying down"
"model" "models/darkmod/misc/system/empty.lwo"
"joint" "RightHand"

"replace_anim_sit_2_sleep_lft" "sit_2_sleep_on_chair"
"replace_anim_sit_2_sleep_rgt" "sit_2_sleep_on_chair"
"replace_anim_sleep_idle_lft" "sit_sleep_idle"
"replace_anim_sleep_idle_rgt" "sit_sleep_idle"
"replace_anim_sleep_2_sit_lft" "sleep_2_sit_on_chair"
"replace_anim_sleep_2_sit_rgt" "sleep_2_sit_on_chair"

"origin" "0 0 0"
"angles" "0 0 0"
"remove" "0"
}

The AI has to get the following spawnargs:

"def_attach5" "atdm:animation_sleep_sit"
"pos_attach5" "hand_r"
"lay_down_slide_dist" "0"

The first two spawnargs attach the dummy entity to the AI, while the third spawnarg prevents the AI from sliding into the chair. This method works with both patrol sleepers as well as non-patroling AI.

'''PLEASE NOTE:'''

This method replaces the "sleeping on a bed" behaviour. This means that the spawnarg "sleep_location" has to be set to "1". Setting it to 0 will still lead to the AI sleeping on the ground. The AI will only be able to sleep in a sitting position as long as the entity "atdm:animation_sleep_sit" is attached to it. Removing the entity will revert the sleeping behaviour, so the AI will sleep on a bed again.

The AI sitting down is part of the sleeping behaviour, much like it is part of "sleeping on the bed". This means, with this method the AI will sit down and immedaitely go to sleep. It is ''NOT'' possible to play other sitting animations in between.

The following pertains to TDM versions 2.06 or later

Use this sequence of path nodes if you want a patrolling AI to sit and take a nap for a while, then resume his patrol:

* path_corner (AI walks to this)
* path_sit ('angle' provides the sitting angle)
* path_sleep ('sleep_location' '2' tells the AI to fall asleep after sitting)
* path_wait ('wait' and 'wait_max' determine how long the AI sleeps; he will wake up and stand up when finished)
* path_corner (AI walks to this)

Use this sequence of path nodes if you want the AI to stay seated after he wakes up:

* path_corner (AI walks to this)
* path_sit ('angle' provides the sitting angle)
* path_sleep ('sleep_location' '2' tells the AI to fall asleep after sitting)
* path_wait ('wait' and 'wait_max' determine how long the AI sleeps)
* path_wakeup (he will wake up and not stand up)

Use these spawnargs on an AI who will start a mission sitting and sleeping, and will stay that way until roused:

* 'sleep_location' '2'
* 'sleeping' '1'

In contrast to the system used in version 2.05 and earlier, it is possible to interrupt other sitting behaviour like reading or writing with the sleeping behaviour. The earlier versions only allowed for an AI to directly sit down and sleep, then wake up and stand up again.

==Known bugs==

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

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

When you KO a sleeping AI, they may drop down through the bed, pop back to standing, like they did in Thief,

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

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

{{tutorial-ai}}

DarkRadiant Video Tutorials

2017-07-03T10:13:12Z

Destined:

On this page you will find video tutorials for DarkRadiant.

== KomagB ==

'''Komag Tutorial: Dark Mod'''

https://www.youtube.com/watch?v=4jutSmdqBVY

https://www.youtube.com/watch?v=e_eiW15WiAI

https://www.youtube.com/watch?v=I2CT030YwG0

== mh444 ==

https://www.youtube.com/watch?v=mDJqeCod0qQ

https://www.youtube.com/watch?v=U7BZupigomU

https://www.youtube.com/watch?v=nYiHCOoDmT8

== Springheel ==

'''TDM New Mappers Workshop:'''

https://www.youtube.com/watch?v=6m-yq4hH81Y (Lesson 1: Planning)

https://youtu.be/RmKjmt7IJr8 (Lesson 2: Visportals)

https://youtu.be/o1lheOJTGgI (Lesson 3: Setting up Dark Radiant, building basics)

'''The Dark Mod: Springheel's Speed Build Challenge:'''

''A step by Step Let's Build, attempting to use modules and prefabs to build a mission in under 4 hours.''

https://www.youtube.com/watch?v=I-phQ4B9shY

https://www.youtube.com/watch?v=PlRCBDcWKXI

https://www.youtube.com/watch?v=uyMx9dvnPgY

https://www.youtube.com/watch?v=BUqFfmIA0_A

https://www.youtube.com/watch?v=7FXDE6La15o

https://www.youtube.com/watch?v=HkKnveFjMDg

https://www.youtube.com/watch?v=UPRxUgbGGfY

https://www.youtube.com/watch?v=Lg2NCpyN4rw

https://www.youtube.com/watch?v=DVILKge4Yog

https://www.youtube.com/watch?v=tVbJ2Mx9kMU

'''TDM 2.05: Springheel's Modules:'''

https://www.youtube.com/watch?v=n9Bbp7fFljc

https://www.youtube.com/watch?v=tVUyv6REzjg

https://www.youtube.com/watch?v=RJZshJg-JpM

https://www.youtube.com/watch?v=RRIY0K_8B2A

https://www.youtube.com/watch?v=hyXOG94lkXQ

== Sotha ==

'''Sotha's Let's Map videos:'''

https://youtu.be/gem2sHGhfZE (Part 1: Introduction)

https://youtu.be/29qvoenDy6U (Part 2: Mdoules)

https://www.youtube.com/watch?v=W3kArUySuF8 (Part 3: Basic Geometry)

https://www.youtube.com/watch?v=aqzVRzqAcEg (Part 4: Basic Backyard)

https://www.youtube.com/watch?v=dW3uvCJOH_I (Part 5: Interior Details)

https://www.youtube.com/watch?v=f-oFxWs8cWQ (Part 6: Backyard Details)

https://www.youtube.com/watch?v=NWthnjWVUhA (Part 7: Lights)

https://youtu.be/mzpsVyhzz7E (Part 8: Monsterclip & AI)

https://youtu.be/79L1BGyM9kY (Part 9: Objectives & Readables)

https://youtu.be/Pt3Nd9vYMtA (Part 10: Sounds)

https://youtu.be/UKiWL6HewAM (Part 11: Finishing Touches)

https://youtu.be/XTkrFjit-RM (Part 12: Briefing & Packaging)

https://youtu.be/iBsVo3qQXaM (Part 13: Betatest Fixes)

== Demo videos ==

'''DarkRadiant Simple House test (level editor open source) [idtech4]'''

https://www.youtube.com/watch?v=2k2YcXNSYfA

== Obsttorte ==

'''Let's Map video series'''

''The first three of these are in German with English subtitles, but they are in English after that.''

https://www.youtube.com/watch?v=QOVslsHBXcI&list=PLrQt-qjh-krYU2kpnJJRHUO8P4xPG5I9X&index=1&t=10s (Part 001)

https://www.youtube.com/watch?v=GfBh6Lhox7o&list=PLrQt-qjh-krYU2kpnJJRHUO8P4xPG5I9X&index=2 (Part 002)

https://www.youtube.com/watch?v=PuVCrrjbEkI&list=PLrQt-qjh-krYU2kpnJJRHUO8P4xPG5I9X&index=3 (Part 003)

https://www.youtube.com/watch?v=FVTBKuHPPGY&list=PLrQt-qjh-krYU2kpnJJRHUO8P4xPG5I9X&index=4 (Part 004 -- Material files)

https://www.youtube.com/watch?v=JmWFMBY2oS0&list=PLrQt-qjh-krYU2kpnJJRHUO8P4xPG5I9X&index=5&t=14s (Part 005 -- Making custom arrows)

https://www.youtube.com/playlist?list=PLrQt-qjh-krYU2kpnJJRHUO8P4xPG5I9X

== Bikerdude ==

'''The Dark Mod: Bikerdude's Speed Build challenge:'''

''A similar step by Step Let's Build, attempting to use modules and prefabs to build a mission in a relatively short time.''

https://www.youtube.com/watch?v=dvzbz_-QVN8 (Part 1. Build Time Total: 40 minutes)

https://www.youtube.com/watch?v=XbbGrPQoJx8 (Part 2. Build Time Total: 1hr 49mins)

https://www.youtube.com/watch?v=XbbGrPQoJx8 (Part 3. Build Time Total: 33mins)

https://www.youtube.com/watch?v=iG5ahPs6VqA (Part 4. Build Time Total: 34mins)

https://www.youtube.com/watch?v=uQaYTpTJPQs (Part 5. Build Time Total: 1hr)

https://www.youtube.com/watch?v=WNoiwYWssac (Part 6. Build Time Total: 1hr 30 mins)

https://www.youtube.com/watch?v=XpcAo48PYxg (Part 7. Build Time Total: 30mins)

https://www.youtube.com/watch?v=LMJ616E8jHg (Part 8. Build Time Total: 1hr 4 mins)

https://www.youtube.com/watch?v=JfsXtyqTypo (Part 9. Build Time Total: 2hrs - (video is only 30mins))

https://www.youtube.com/watch?v=pG3aqzqpkkQ (Part 10. Build Time Total: 1hr 10 mins)

https://www.youtube.com/watch?v=dWe9wQzkGu8 (Part 11. Build Time Total: 40 mins)

https://www.youtube.com/watch?v=KETY43j8o30 (Part 12. Build Time Total: 45 mins)

https://www.youtube.com/watch?v=dSvY0cJEt7o (Part 13. Build Time Total: 35 mins)

https://www.youtube.com/watch?v=Yk62qY_6Ldo (Part 13. Build Time Total: 45 mins)

https://www.youtube.com/watch?v=DGgZEWCF8vo (Part 14. Build Time Total: 53 mins)

https://www.youtube.com/watch?v=2a3Puxpr9Xw (Part 15. Build time Total: 60mins)

https://www.youtube.com/watch?v=2a3Puxpr9Xw (Part 16. Build time Total: 55mins)

https://www.youtube.com/watch?v=75GpgKuL6tY (Part 17. Build time Total: 55mins)

DarkRadiant Video Tutorials

2017-07-02T13:56:07Z

Destined:

On this page you will find video tutorials for DarkRadiant.

== KomagB ==

'''Komag Tutorial: Dark Mod'''

https://www.youtube.com/watch?v=4jutSmdqBVY

https://www.youtube.com/watch?v=e_eiW15WiAI

https://www.youtube.com/watch?v=I2CT030YwG0

== mh444 ==

https://www.youtube.com/watch?v=mDJqeCod0qQ

https://www.youtube.com/watch?v=U7BZupigomU

https://www.youtube.com/watch?v=nYiHCOoDmT8

== Springheel ==

'''TDM New Mappers Workshop:'''

https://www.youtube.com/watch?v=6m-yq4hH81Y (Lesson 1: Planning)

https://youtu.be/RmKjmt7IJr8 (Lesson 2: Visportals)

'''The Dark Mod: Springheel's Speed Build Challenge:'''

''A step by Step Let's Build, attempting to use modules and prefabs to build a mission in under 4 hours.''

https://www.youtube.com/watch?v=I-phQ4B9shY

https://www.youtube.com/watch?v=PlRCBDcWKXI

https://www.youtube.com/watch?v=uyMx9dvnPgY

https://www.youtube.com/watch?v=BUqFfmIA0_A

https://www.youtube.com/watch?v=7FXDE6La15o

https://www.youtube.com/watch?v=HkKnveFjMDg

https://www.youtube.com/watch?v=UPRxUgbGGfY

https://www.youtube.com/watch?v=Lg2NCpyN4rw

https://www.youtube.com/watch?v=DVILKge4Yog

https://www.youtube.com/watch?v=tVbJ2Mx9kMU

'''TDM 2.05: Springheel's Modules:'''

https://www.youtube.com/watch?v=n9Bbp7fFljc

https://www.youtube.com/watch?v=tVUyv6REzjg

https://www.youtube.com/watch?v=RJZshJg-JpM

https://www.youtube.com/watch?v=RRIY0K_8B2A

https://www.youtube.com/watch?v=hyXOG94lkXQ

== Sotha ==

'''Sotha's Let's Map videos:'''

https://youtu.be/gem2sHGhfZE (Part 1: Introduction)

https://youtu.be/29qvoenDy6U (Part 2: Mdoules)

https://www.youtube.com/watch?v=W3kArUySuF8 (Part 3: Basic Geometry)

https://www.youtube.com/watch?v=aqzVRzqAcEg (Part 4: Basic Backyard)

https://www.youtube.com/watch?v=dW3uvCJOH_I (Part 5: Interior Details)

https://www.youtube.com/watch?v=f-oFxWs8cWQ (Part 6: Backyard Details)

https://www.youtube.com/watch?v=NWthnjWVUhA (Part 7: Lights)

https://youtu.be/mzpsVyhzz7E (Part 8: Monsterclip & AI)

https://youtu.be/79L1BGyM9kY (Part 9: Objectives & Readables)

https://youtu.be/Pt3Nd9vYMtA (Part 10: Sounds)

https://youtu.be/UKiWL6HewAM (Part 11: Finishing Touches)

https://youtu.be/XTkrFjit-RM (Part 12: Briefing & Packaging)

https://youtu.be/iBsVo3qQXaM (Part 13: Betatest Fixes)

== Demo videos ==

'''DarkRadiant Simple House test (level editor open source) [idtech4]'''

https://www.youtube.com/watch?v=2k2YcXNSYfA

== Obsttorte ==

'''Let's Map video series'''

''The first three of these are in German with English subtitles, but they are in English after that.''

https://www.youtube.com/watch?v=QOVslsHBXcI&list=PLrQt-qjh-krYU2kpnJJRHUO8P4xPG5I9X&index=1&t=10s (Part 001)

https://www.youtube.com/watch?v=GfBh6Lhox7o&list=PLrQt-qjh-krYU2kpnJJRHUO8P4xPG5I9X&index=2 (Part 002)

https://www.youtube.com/watch?v=PuVCrrjbEkI&list=PLrQt-qjh-krYU2kpnJJRHUO8P4xPG5I9X&index=3 (Part 003)

https://www.youtube.com/watch?v=FVTBKuHPPGY&list=PLrQt-qjh-krYU2kpnJJRHUO8P4xPG5I9X&index=4 (Part 004 -- Material files)

https://www.youtube.com/watch?v=JmWFMBY2oS0&list=PLrQt-qjh-krYU2kpnJJRHUO8P4xPG5I9X&index=5&t=14s (Part 005 -- Making custom arrows)

https://www.youtube.com/playlist?list=PLrQt-qjh-krYU2kpnJJRHUO8P4xPG5I9X

== Bikerdude ==

'''The Dark Mod: Bikerdude's Speed Build challenge:'''

''A similar step by Step Let's Build, attempting to use modules and prefabs to build a mission in a relatively short time.''

https://www.youtube.com/watch?v=dvzbz_-QVN8 (Part 1. Build Time Total: 40 minutes)

https://www.youtube.com/watch?v=XbbGrPQoJx8 (Part 2. Build Time Total: 1hr 49mins)

https://www.youtube.com/watch?v=XbbGrPQoJx8 (Part 3. Build Time Total: 33mins)

https://www.youtube.com/watch?v=iG5ahPs6VqA (Part 4. Build Time Total: 34mins)

https://www.youtube.com/watch?v=uQaYTpTJPQs (Part 5. Build Time Total: 1hr)

https://www.youtube.com/watch?v=WNoiwYWssac (Part 6. Build Time Total: 1hr 30 mins)

https://www.youtube.com/watch?v=XpcAo48PYxg (Part 7. Build Time Total: 30mins)

https://www.youtube.com/watch?v=LMJ616E8jHg (Part 8. Build Time Total: 1hr 4 mins)

https://www.youtube.com/watch?v=JfsXtyqTypo (Part 9. Build Time Total: 2hrs - (video is only 30mins))

https://www.youtube.com/watch?v=pG3aqzqpkkQ (Part 10. Build Time Total: 1hr 10 mins)

https://www.youtube.com/watch?v=dWe9wQzkGu8 (Part 11. Build Time Total: 40 mins)

https://www.youtube.com/watch?v=KETY43j8o30 (Part 12. Build Time Total: 45 mins)

https://www.youtube.com/watch?v=dSvY0cJEt7o (Part 13. Build Time Total: 35 mins)

https://www.youtube.com/watch?v=Yk62qY_6Ldo (Part 13. Build Time Total: 45 mins)

https://www.youtube.com/watch?v=DGgZEWCF8vo (Part 14. Build Time Total: 53 mins)

https://www.youtube.com/watch?v=2a3Puxpr9Xw (Part 15. Build time Total: 60mins)

https://www.youtube.com/watch?v=2a3Puxpr9Xw (Part 16. Build time Total: 55mins)

https://www.youtube.com/watch?v=75GpgKuL6tY (Part 17. Build time Total: 55mins)

DarkRadiant Video Tutorials

2017-07-02T13:55:52Z

Destined:

On this page you will find video tutorials for DarkRadiant.

== KomagB ==

'''Komag Tutorial: Dark Mod'''

https://www.youtube.com/watch?v=4jutSmdqBVY

https://www.youtube.com/watch?v=e_eiW15WiAI

https://www.youtube.com/watch?v=I2CT030YwG0

== mh444 ==

https://www.youtube.com/watch?v=mDJqeCod0qQ

https://www.youtube.com/watch?v=U7BZupigomU

https://www.youtube.com/watch?v=nYiHCOoDmT8

== Springheel ==

'''TDM New Mappers Workshop:'''

https://www.youtube.com/watch?v=6m-yq4hH81Y (Lesson 1: Planning)
https://youtu.be/RmKjmt7IJr8 (Lesson 2: Visportals)

'''The Dark Mod: Springheel's Speed Build Challenge:'''

''A step by Step Let's Build, attempting to use modules and prefabs to build a mission in under 4 hours.''

https://www.youtube.com/watch?v=I-phQ4B9shY

https://www.youtube.com/watch?v=PlRCBDcWKXI

https://www.youtube.com/watch?v=uyMx9dvnPgY

https://www.youtube.com/watch?v=BUqFfmIA0_A

https://www.youtube.com/watch?v=7FXDE6La15o

https://www.youtube.com/watch?v=HkKnveFjMDg

https://www.youtube.com/watch?v=UPRxUgbGGfY

https://www.youtube.com/watch?v=Lg2NCpyN4rw

https://www.youtube.com/watch?v=DVILKge4Yog

https://www.youtube.com/watch?v=tVbJ2Mx9kMU

'''TDM 2.05: Springheel's Modules:'''

https://www.youtube.com/watch?v=n9Bbp7fFljc

https://www.youtube.com/watch?v=tVUyv6REzjg

https://www.youtube.com/watch?v=RJZshJg-JpM

https://www.youtube.com/watch?v=RRIY0K_8B2A

https://www.youtube.com/watch?v=hyXOG94lkXQ

== Sotha ==

'''Sotha's Let's Map videos:'''

https://youtu.be/gem2sHGhfZE (Part 1: Introduction)

https://youtu.be/29qvoenDy6U (Part 2: Mdoules)

https://www.youtube.com/watch?v=W3kArUySuF8 (Part 3: Basic Geometry)

https://www.youtube.com/watch?v=aqzVRzqAcEg (Part 4: Basic Backyard)

https://www.youtube.com/watch?v=dW3uvCJOH_I (Part 5: Interior Details)

https://www.youtube.com/watch?v=f-oFxWs8cWQ (Part 6: Backyard Details)

https://www.youtube.com/watch?v=NWthnjWVUhA (Part 7: Lights)

https://youtu.be/mzpsVyhzz7E (Part 8: Monsterclip & AI)

https://youtu.be/79L1BGyM9kY (Part 9: Objectives & Readables)

https://youtu.be/Pt3Nd9vYMtA (Part 10: Sounds)

https://youtu.be/UKiWL6HewAM (Part 11: Finishing Touches)

https://youtu.be/XTkrFjit-RM (Part 12: Briefing & Packaging)

https://youtu.be/iBsVo3qQXaM (Part 13: Betatest Fixes)

== Demo videos ==

'''DarkRadiant Simple House test (level editor open source) [idtech4]'''

https://www.youtube.com/watch?v=2k2YcXNSYfA

== Obsttorte ==

'''Let's Map video series'''

''The first three of these are in German with English subtitles, but they are in English after that.''

https://www.youtube.com/watch?v=QOVslsHBXcI&list=PLrQt-qjh-krYU2kpnJJRHUO8P4xPG5I9X&index=1&t=10s (Part 001)

https://www.youtube.com/watch?v=GfBh6Lhox7o&list=PLrQt-qjh-krYU2kpnJJRHUO8P4xPG5I9X&index=2 (Part 002)

https://www.youtube.com/watch?v=PuVCrrjbEkI&list=PLrQt-qjh-krYU2kpnJJRHUO8P4xPG5I9X&index=3 (Part 003)

https://www.youtube.com/watch?v=FVTBKuHPPGY&list=PLrQt-qjh-krYU2kpnJJRHUO8P4xPG5I9X&index=4 (Part 004 -- Material files)

https://www.youtube.com/watch?v=JmWFMBY2oS0&list=PLrQt-qjh-krYU2kpnJJRHUO8P4xPG5I9X&index=5&t=14s (Part 005 -- Making custom arrows)

https://www.youtube.com/playlist?list=PLrQt-qjh-krYU2kpnJJRHUO8P4xPG5I9X

== Bikerdude ==

'''The Dark Mod: Bikerdude's Speed Build challenge:'''

''A similar step by Step Let's Build, attempting to use modules and prefabs to build a mission in a relatively short time.''

https://www.youtube.com/watch?v=dvzbz_-QVN8 (Part 1. Build Time Total: 40 minutes)

https://www.youtube.com/watch?v=XbbGrPQoJx8 (Part 2. Build Time Total: 1hr 49mins)

https://www.youtube.com/watch?v=XbbGrPQoJx8 (Part 3. Build Time Total: 33mins)

https://www.youtube.com/watch?v=iG5ahPs6VqA (Part 4. Build Time Total: 34mins)

https://www.youtube.com/watch?v=uQaYTpTJPQs (Part 5. Build Time Total: 1hr)

https://www.youtube.com/watch?v=WNoiwYWssac (Part 6. Build Time Total: 1hr 30 mins)

https://www.youtube.com/watch?v=XpcAo48PYxg (Part 7. Build Time Total: 30mins)

https://www.youtube.com/watch?v=LMJ616E8jHg (Part 8. Build Time Total: 1hr 4 mins)

https://www.youtube.com/watch?v=JfsXtyqTypo (Part 9. Build Time Total: 2hrs - (video is only 30mins))

https://www.youtube.com/watch?v=pG3aqzqpkkQ (Part 10. Build Time Total: 1hr 10 mins)

https://www.youtube.com/watch?v=dWe9wQzkGu8 (Part 11. Build Time Total: 40 mins)

https://www.youtube.com/watch?v=KETY43j8o30 (Part 12. Build Time Total: 45 mins)

https://www.youtube.com/watch?v=dSvY0cJEt7o (Part 13. Build Time Total: 35 mins)

https://www.youtube.com/watch?v=Yk62qY_6Ldo (Part 13. Build Time Total: 45 mins)

https://www.youtube.com/watch?v=DGgZEWCF8vo (Part 14. Build Time Total: 53 mins)

https://www.youtube.com/watch?v=2a3Puxpr9Xw (Part 15. Build time Total: 60mins)

https://www.youtube.com/watch?v=2a3Puxpr9Xw (Part 16. Build time Total: 55mins)

https://www.youtube.com/watch?v=75GpgKuL6tY (Part 17. Build time Total: 55mins)

Tool, Key, custom used by inventory actions

2017-06-26T07:20:07Z

Destined:

PLACEHOLDER but fairly complete:

DOES NOT WORK FOR DOORS - use the normal key method

Note, this describes how to trigger a script by using any custom 'tool' on an object in the world so you either need some knowledge of scripting or have one available.

You're probably familiar with how you can set used_by and an entity name on a door to make it open with that key. Well, now you can set used_by and an entity name on any entity, and it will call the script in spawnarg "used_action_script" when it is frobhilighted and used by that inventory item.

Note: The inventory item will have to have the spawnarg "usable" set to "1" in order to be used. This spawnarg is not automatically included in the custom item entities. Furthermore, when the item gets used, it will get called once per frame for as long as the item is used. Please take precautions if you want your script to only run once.

But wait, there's more. You can also specify an entity in different ways:

"used_by_inv_name" : specify by inventory name in inv_name spawnarg
"used_by_category" : specify by inventory category
"used_by_classname" : specify by classname spawnarg or entityDef name, e.g., atdm:playertools_compass

Also, if you have multiple items in the used_by arguments, you can specify different scripts to call for different items. Instead of "used_action_script", add on the specifier to the key name afterwards, like "used_action_script_<specifier> " Where the specifier can be the entity name, inv name, category or classname.

The order it checks for scripts in is this:
# entity name (used_by)
# inventory name (used_by_inv_name)
# classname (used_by_classname)
# inventory category (used_by_category)

And if it doesn't find one, it executes the general "used_action_script" by default.

For example, putting these spawnargs on a frobable entity you want to be usable by stuff:
"used_by" "key_12"
"used_by1" "key_13"
"used_by_inv_name" "Foo" [NOTE THIS MAY BE REPLACED BY inv_id to avoid translation conflict]
"used_by_classname" "atdm:playertools_lantern"

"used_action_script_key_12" "UsedByKey12Script"
"used_action_script_atdm:playertools_lantern" "UsedByLanternScript"
"used_action_script_Keys" "UsedByGenericKey"
"used_action_script" "UsedByGeneric"

These scripts could be in the map's script file, for example. Or they could be globally defined scripts if you want to create a new player tool.

In this example, if you call UsedByKey12Script if you use it with an entity named key_12. You can use it with key_13, and it will notice that the inventory category matches Keys, and call UsedByGenericKey. (NOTE: You don't need to set used_by_category to specify by category if it's already covered by another specifier, in this case entity name). If you use it with the lantern, you will call UsedByLanternScript. Finally, if you use it with an inventory item whose inventory name is "Foo", it will call the default script, UsedByGeneric.

This should help a lot with scripting FMs where you have to use item A on item B. Although a lot of you will probably set up fancy stuff where you have to put a moveable into place with the Grabber instead of using an inventory item, so you won't use this. But that's okay.

Additional:

# All frobable entities (except doors/locks/handles) have a default used_action_script that triggers their targets. (Just like frobbing something triggers its targets by default). So all you have to do is set a used_by variable and it will trigger its targets when inventory used by that item.
# Don't change anything about the way you handle doors, locks and handles. Because doors work differently, the used_by_* variables won't work, and the script won't get triggered. Just keep using used_by, and the usual methods to call a script when a door is opened.

Extra examples:

So say I wanted to brighten a light with a magic amulet. I add to the light used_by amulet and used_action_script myscript and brighten the light in myscript.

If I also want a skull ring to darken the light I would add used_by1 amulet and usedby2 skullring. Then used_action_script_amulet myscript_amulet and used_action_script_skullring myscript_skullring.

[[Category:Editing]]

Tool, Key, custom used by inventory actions

2017-06-26T07:19:50Z

Destined:

PLACEHOLDER but fairly complete:

DOES NOT WORK FOR DOORS - use the normal key method

Note, this describes how to trigger a script by using any custom 'tool' on an object in the world so you either need some knowledge of scripting or have one available.

You're probably familiar with how you can set used_by and an entity name on a door to make it open with that key. Well, now you can set used_by and an entity name on any entity, and it will call the script in spawnarg "used_action_script" when it is frobhilighted and used by that inventory item.
Note: The inventory item will have to have the spawnarg "usable" set to "1" in order to be used. This spawnarg is not automatically included in the custom item entities. Furthermore, when the item gets used, it will get called once per frame for as long as the item is used. Please take precautions if you want your script to only run once.

But wait, there's more. You can also specify an entity in different ways:

"used_by_inv_name" : specify by inventory name in inv_name spawnarg
"used_by_category" : specify by inventory category
"used_by_classname" : specify by classname spawnarg or entityDef name, e.g., atdm:playertools_compass

Also, if you have multiple items in the used_by arguments, you can specify different scripts to call for different items. Instead of "used_action_script", add on the specifier to the key name afterwards, like "used_action_script_<specifier> " Where the specifier can be the entity name, inv name, category or classname.

The order it checks for scripts in is this:
# entity name (used_by)
# inventory name (used_by_inv_name)
# classname (used_by_classname)
# inventory category (used_by_category)

And if it doesn't find one, it executes the general "used_action_script" by default.

For example, putting these spawnargs on a frobable entity you want to be usable by stuff:
"used_by" "key_12"
"used_by1" "key_13"
"used_by_inv_name" "Foo" [NOTE THIS MAY BE REPLACED BY inv_id to avoid translation conflict]
"used_by_classname" "atdm:playertools_lantern"

"used_action_script_key_12" "UsedByKey12Script"
"used_action_script_atdm:playertools_lantern" "UsedByLanternScript"
"used_action_script_Keys" "UsedByGenericKey"
"used_action_script" "UsedByGeneric"

These scripts could be in the map's script file, for example. Or they could be globally defined scripts if you want to create a new player tool.

In this example, if you call UsedByKey12Script if you use it with an entity named key_12. You can use it with key_13, and it will notice that the inventory category matches Keys, and call UsedByGenericKey. (NOTE: You don't need to set used_by_category to specify by category if it's already covered by another specifier, in this case entity name). If you use it with the lantern, you will call UsedByLanternScript. Finally, if you use it with an inventory item whose inventory name is "Foo", it will call the default script, UsedByGeneric.

This should help a lot with scripting FMs where you have to use item A on item B. Although a lot of you will probably set up fancy stuff where you have to put a moveable into place with the Grabber instead of using an inventory item, so you won't use this. But that's okay.

Additional:

# All frobable entities (except doors/locks/handles) have a default used_action_script that triggers their targets. (Just like frobbing something triggers its targets by default). So all you have to do is set a used_by variable and it will trigger its targets when inventory used by that item.
# Don't change anything about the way you handle doors, locks and handles. Because doors work differently, the used_by_* variables won't work, and the script won't get triggered. Just keep using used_by, and the usual methods to call a script when a door is opened.

Extra examples:

So say I wanted to brighten a light with a magic amulet. I add to the light used_by amulet and used_action_script myscript and brighten the light in myscript.

If I also want a skull ring to darken the light I would add used_by1 amulet and usedby2 skullring. Then used_action_script_amulet myscript_amulet and used_action_script_skullring myscript_skullring.

[[Category:Editing]]

Tool, Key, custom used by inventory actions

2017-06-26T07:13:39Z

Destined:

PLACEHOLDER but fairly complete:

DOES NOT WORK FOR DOORS - use the normal key method

Note, this describes how to trigger a script by using any custom 'tool' on an object in the world so you either need some knowledge of scripting or have one available.

You're probably familiar with how you can set used_by and an entity name on a door to make it open with that key. Well, now you can set used_by and an entity name on any entity, and it will call the script in spawnarg "used_action_script" when it is frobhilighted and used by that inventory item. The inventory item will have to have the spawnarg "usable" set to "1" in order to be used. This spawnarg is not automatically included in the custom item entities.

But wait, there's more. You can also specify an entity in different ways:

"used_by_inv_name" : specify by inventory name in inv_name spawnarg
"used_by_category" : specify by inventory category
"used_by_classname" : specify by classname spawnarg or entityDef name, e.g., atdm:playertools_compass

Also, if you have multiple items in the used_by arguments, you can specify different scripts to call for different items. Instead of "used_action_script", add on the specifier to the key name afterwards, like "used_action_script_<specifier> " Where the specifier can be the entity name, inv name, category or classname.

The order it checks for scripts in is this:
# entity name (used_by)
# inventory name (used_by_inv_name)
# classname (used_by_classname)
# inventory category (used_by_category)

And if it doesn't find one, it executes the general "used_action_script" by default.

For example, putting these spawnargs on a frobable entity you want to be usable by stuff:
"used_by" "key_12"
"used_by1" "key_13"
"used_by_inv_name" "Foo" [NOTE THIS MAY BE REPLACED BY inv_id to avoid translation conflict]
"used_by_classname" "atdm:playertools_lantern"

"used_action_script_key_12" "UsedByKey12Script"
"used_action_script_atdm:playertools_lantern" "UsedByLanternScript"
"used_action_script_Keys" "UsedByGenericKey"
"used_action_script" "UsedByGeneric"

These scripts could be in the map's script file, for example. Or they could be globally defined scripts if you want to create a new player tool.

In this example, if you call UsedByKey12Script if you use it with an entity named key_12. You can use it with key_13, and it will notice that the inventory category matches Keys, and call UsedByGenericKey. (NOTE: You don't need to set used_by_category to specify by category if it's already covered by another specifier, in this case entity name). If you use it with the lantern, you will call UsedByLanternScript. Finally, if you use it with an inventory item whose inventory name is "Foo", it will call the default script, UsedByGeneric.

This should help a lot with scripting FMs where you have to use item A on item B. Although a lot of you will probably set up fancy stuff where you have to put a moveable into place with the Grabber instead of using an inventory item, so you won't use this. But that's okay.

Additional:

# All frobable entities (except doors/locks/handles) have a default used_action_script that triggers their targets. (Just like frobbing something triggers its targets by default). So all you have to do is set a used_by variable and it will trigger its targets when inventory used by that item.
# Don't change anything about the way you handle doors, locks and handles. Because doors work differently, the used_by_* variables won't work, and the script won't get triggered. Just keep using used_by, and the usual methods to call a script when a door is opened.

Extra examples:

So say I wanted to brighten a light with a magic amulet. I add to the light used_by amulet and used_action_script myscript and brighten the light in myscript.

If I also want a skull ring to darken the light I would add used_by1 amulet and usedby2 skullring. Then used_action_script_amulet myscript_amulet and used_action_script_skullring myscript_skullring.

[[Category:Editing]]

DarkRadiant Video Tutorials

2017-06-21T20:45:57Z

Destined: /* DarkRadiant Video Tutorials */

== DarkRadiant Video Tutorials ==

On this page you will find video tutorials for DarkRadiant.

'''KomagB'''

Komag Tutorial: Dark Mod

https://www.youtube.com/watch?v=4jutSmdqBVY

https://www.youtube.com/watch?v=e_eiW15WiAI

https://www.youtube.com/watch?v=I2CT030YwG0

'''mh444'''

https://www.youtube.com/watch?v=mDJqeCod0qQ

https://www.youtube.com/watch?v=U7BZupigomU

https://www.youtube.com/watch?v=nYiHCOoDmT8

''' Springheel '''

TDM New Mappers Workshop:

https://www.youtube.com/watch?v=6m-yq4hH81Y (Lesson 1: Planning)

The Dark Mod: Springheel's Speed Build Challenge:

https://www.youtube.com/watch?v=I-phQ4B9shY

https://www.youtube.com/watch?v=PlRCBDcWKXI

https://www.youtube.com/watch?v=uyMx9dvnPgY

https://www.youtube.com/watch?v=BUqFfmIA0_A

https://www.youtube.com/watch?v=7FXDE6La15o

https://www.youtube.com/watch?v=HkKnveFjMDg

https://www.youtube.com/watch?v=UPRxUgbGGfY

https://www.youtube.com/watch?v=Lg2NCpyN4rw

https://www.youtube.com/watch?v=DVILKge4Yog

https://www.youtube.com/watch?v=tVbJ2Mx9kMU

TDM 2.05: Springheel's Modules:

https://www.youtube.com/watch?v=n9Bbp7fFljc

https://www.youtube.com/watch?v=tVUyv6REzjg

https://www.youtube.com/watch?v=RJZshJg-JpM

https://www.youtube.com/watch?v=RRIY0K_8B2A

https://www.youtube.com/watch?v=hyXOG94lkXQ

''' Sotha '''

Sotha's Let's Map videos:

https://youtu.be/gem2sHGhfZE (Part 1: Introduction)

https://youtu.be/29qvoenDy6U (Part 2: Mdoules)

https://www.youtube.com/watch?v=W3kArUySuF8 (Part 3: Basic Geometry)

https://www.youtube.com/watch?v=aqzVRzqAcEg (Part 4: Basic Backyard)

https://www.youtube.com/watch?v=dW3uvCJOH_I (Part 5: Interior Details)

https://www.youtube.com/watch?v=f-oFxWs8cWQ (Part 6: Backyard Details)

https://www.youtube.com/watch?v=NWthnjWVUhA (Part 7: Lights)

https://youtu.be/mzpsVyhzz7E (Part 8: Monsterclip & AI)

https://youtu.be/79L1BGyM9kY (Part 9: Objectives & Readables)

https://youtu.be/Pt3Nd9vYMtA (Part 10: Sounds)

https://youtu.be/UKiWL6HewAM (Part 11: Finishing Touches)

https://youtu.be/XTkrFjit-RM (Part 12: Briefing & Packaging)

https://youtu.be/iBsVo3qQXaM (Part 13: Betatest Fixes)

''' Demo videos '''

DarkRadiant Simple House test (level editor open source) [idtech4]

https://www.youtube.com/watch?v=2k2YcXNSYfA

DarkRadiant Video Tutorials

2017-06-21T20:44:28Z

Destined:

== DarkRadiant Video Tutorials ==

On this page you will find video tutorials for DarkRadiant.

'''KomagB'''

Komag Tutorial: Dark Mod

https://www.youtube.com/watch?v=4jutSmdqBVY

https://www.youtube.com/watch?v=e_eiW15WiAI

https://www.youtube.com/watch?v=I2CT030YwG0

'''mh444'''

https://www.youtube.com/watch?v=mDJqeCod0qQ

https://www.youtube.com/watch?v=U7BZupigomU

https://www.youtube.com/watch?v=nYiHCOoDmT8

''' Springheel '''

TDM New Mappers Workshop:

https://www.youtube.com/watch?v=6m-yq4hH81Y (Lesson 1: Planning)

The Dark Mod: Springheel's Speed Build Challenge:

https://www.youtube.com/watch?v=I-phQ4B9shY

https://www.youtube.com/watch?v=PlRCBDcWKXI

https://www.youtube.com/watch?v=uyMx9dvnPgY

https://www.youtube.com/watch?v=BUqFfmIA0_A

https://www.youtube.com/watch?v=7FXDE6La15o

https://www.youtube.com/watch?v=HkKnveFjMDg

https://www.youtube.com/watch?v=UPRxUgbGGfY

https://www.youtube.com/watch?v=Lg2NCpyN4rw

https://www.youtube.com/watch?v=DVILKge4Yog

https://www.youtube.com/watch?v=tVbJ2Mx9kMU

TDM 2.05: Springheel's Modules:

https://www.youtube.com/watch?v=n9Bbp7fFljc

https://www.youtube.com/watch?v=tVUyv6REzjg

https://www.youtube.com/watch?v=RJZshJg-JpM

https://www.youtube.com/watch?v=RRIY0K_8B2A

https://www.youtube.com/watch?v=hyXOG94lkXQ

''' Sotha '''

Sotha's Let's Map videos

https://youtu.be/gem2sHGhfZE (Part 1: Introduction)

https://youtu.be/29qvoenDy6U (Part 2: Mdoules)

https://www.youtube.com/watch?v=W3kArUySuF8 (Part 3: Basic Geometry)

https://www.youtube.com/watch?v=aqzVRzqAcEg (Part 4: Basic Backyard)

https://www.youtube.com/watch?v=dW3uvCJOH_I (Part 5: Interior Details)

https://www.youtube.com/watch?v=f-oFxWs8cWQ (Part 6: Backyard Details)

https://www.youtube.com/watch?v=NWthnjWVUhA (Part 7: Lights)

https://youtu.be/mzpsVyhzz7E (Part 8: Monsterclip & AI)

https://youtu.be/79L1BGyM9kY (Part 9: Objectives & Readables)

https://youtu.be/Pt3Nd9vYMtA (Part 10: Sounds)

https://youtu.be/UKiWL6HewAM (Part 11: Finishing Touches)

https://youtu.be/XTkrFjit-RM (Part 12: Briefing & Packaging)

https://youtu.be/iBsVo3qQXaM (Part 13: Betatest Fixes)

''' Demo videos '''

DarkRadiant Simple House test (level editor open source) [idtech4]

https://www.youtube.com/watch?v=2k2YcXNSYfA

DarkRadiant Video Tutorials

2017-06-21T20:42:06Z

Destined:

== DarkRadiant Video Tutorials ==

On this page you will find video tutorials for DarkRadiant.

'''KomagB'''

Komag Tutorial: Dark Mod

https://www.youtube.com/watch?v=4jutSmdqBVY

https://www.youtube.com/watch?v=e_eiW15WiAI

https://www.youtube.com/watch?v=I2CT030YwG0

'''mh444'''

https://www.youtube.com/watch?v=mDJqeCod0qQ

https://www.youtube.com/watch?v=U7BZupigomU

https://www.youtube.com/watch?v=nYiHCOoDmT8

''' Springheel '''

TDM New Mappers Workshop:

https://www.youtube.com/watch?v=6m-yq4hH81Y

The Dark Mod: Springheel's Speed Build Challenge:

https://www.youtube.com/watch?v=I-phQ4B9shY

https://www.youtube.com/watch?v=PlRCBDcWKXI

https://www.youtube.com/watch?v=uyMx9dvnPgY

https://www.youtube.com/watch?v=BUqFfmIA0_A

https://www.youtube.com/watch?v=7FXDE6La15o

https://www.youtube.com/watch?v=HkKnveFjMDg

https://www.youtube.com/watch?v=UPRxUgbGGfY

https://www.youtube.com/watch?v=Lg2NCpyN4rw

https://www.youtube.com/watch?v=DVILKge4Yog

https://www.youtube.com/watch?v=tVbJ2Mx9kMU

TDM 2.05: Springheel's Modules:

https://www.youtube.com/watch?v=n9Bbp7fFljc

https://www.youtube.com/watch?v=tVUyv6REzjg

https://www.youtube.com/watch?v=RJZshJg-JpM

https://www.youtube.com/watch?v=RRIY0K_8B2A

https://www.youtube.com/watch?v=hyXOG94lkXQ

''' Sotha '''

Sotha's Let's Map videos

https://youtu.be/gem2sHGhfZE (Part 1: Introduction)

https://youtu.be/29qvoenDy6U (Part 2: Mdoules)

https://www.youtube.com/watch?v=W3kArUySuF8 (Part 3: Basic Geometry)

https://www.youtube.com/watch?v=aqzVRzqAcEg (Part 4: Basic Backyard)

https://www.youtube.com/watch?v=dW3uvCJOH_I (Part 5: Interior Details)

https://www.youtube.com/watch?v=f-oFxWs8cWQ (Part 6: Backyard Details)

https://www.youtube.com/watch?v=NWthnjWVUhA (Part 7: Lights)

https://youtu.be/mzpsVyhzz7E (Part 8: Monsterclip & AI)

https://youtu.be/79L1BGyM9kY (Part 9: Objectives & Readables)

https://youtu.be/Pt3Nd9vYMtA (Part 10: Sounds)

https://youtu.be/UKiWL6HewAM (Part 11: Finishing Touches)

https://youtu.be/XTkrFjit-RM (Part 12: Briefing & Packaging)

https://youtu.be/iBsVo3qQXaM (Part 13: Betatest Fixes)

''' Demo videos '''

DarkRadiant Simple House test (level editor open source) [idtech4]

https://www.youtube.com/watch?v=2k2YcXNSYfA

Rooms and Furniture

2017-06-06T14:53:42Z

Destined: /* Furniture per Room */

==Rooms per Household==
Depending on the size and wealth of the household, it will contain different rooms. Here is an exemplary list of which rooms should be present in which type of household. Especially in poor households, room is sparse and, consequently, man rooms are stuffed together to save room.
===Low income/poor===

*very few rooms, mostly functional
*Should include kitchen and bedroom

===Merchants/Craftsmen===

*few rooms
*kitchen and bedroom
*workshop and/or
*room for selling should be included

===Tavern/Inn===

*kitchen,
*storage room
*taproom
*bedrooms for guests and owners,
*bathroom (optional, may be exchanged with basins in guests' rooms)

===Nobles===

*kitchen and seperate dining room,
*several bedrooms (number depending on family size: seperate rooms for adilts and each child, additional bedrooms for guests possible),
*at least one bathroom (toilet included or seperate),
*further rooms like office/library, sitting room

==Furniture per Room==
Each room should have a furniture in accordance with the function of the room. Depending on the household the quality and quantity of the furniture should be chosen.

===Kitchen===

*stove
*working space
*cupboard for cutlery and dishes (may be placed in a seperate dining room)
*table and chairs/stools (may be placed in a seperate dining room)

===Storage Room===

*shelves and hooks for food stuff
*bottles (various)
*barrels (especially in taverns)
*various containers (boxes etc)

===Bathroom===

*bathtub
*basin for washing
*cupboard for bathing supplies

===Bedroom===

*bed(s)
*nightstand
*cupboard for clothing

===Living Room===

*table
*armchairs
*bookshelve(s)
*lamps or similar for light
*other leisure time stuff (instruments, knitting needles, board games, stuff like that)

===Office / Study===

*desk with chair
*bookshelve(s)

===Workshop===

*tools of the trade (see the [[Jobs]] page for inspiration)
*workbench
*stool

===Taproom===

*several tables with chairs
*open fireplace with armchairs (optional)
*bar

Rooms and Furniture

2017-06-06T12:23:31Z

Destined:

==Rooms per Household==
Depending on the size and wealth of the household, it will contain different rooms. Here is an exemplary list of which rooms should be present in which type of household. Especially in poor households, room is sparse and, consequently, man rooms are stuffed together to save room.
===Low income/poor===

*very few rooms, mostly functional
*Should include kitchen and bedroom

===Merchants/Craftsmen===

*few rooms
*kitchen and bedroom
*workshop and/or
*room for selling should be included

===Tavern/Inn===

*kitchen,
*storage room
*taproom
*bedrooms for guests and owners,
*bathroom (optional, may be exchanged with basins in guests' rooms)

===Nobels===

*kitchen and seperate dining room,
*several bedrooms (number depending on family size: seperate rooms for adilts and each child, additional bedrooms for guests possible),
*at least one bathroom (toilet included or seperate),
*further rooms like office/library, sitting room

==Furniture per Room==
Each room should have a furniture in accordance with the function of the room. Depending on the household the quality and quantity of the furniture should be chosen.

===Kitchen===

*stove
*working space
*cupboard for cutlery and dishes (may be placed in a seperate dining room)
*table and chairs/stools (may be placed in a seperate dining room)

===Storage Room===

*shelves and hooks for food stuff
*bottles (various)
*barrels (especially in taverns)
*various containers (boxes etc)

===Bathroom===

*bathtub
*basin for washing
*cupboard for bathing supplies

===Bedroom===

*bed(s)
*nightstand
*cupboard for clothing

===Living Room===

*table
*armchairs
*bookshelve(s)
*lamps or similar for light
*other leisure time stuff (instruments, knitting needles, board games, stuff like that)

===Office / Study===

*desk with chair
*bookshelve(s)

===Workshop===

*tools of the trade (see the [[Jobs]] page for inspiration)
*workbench
*stool

===Taproom===

*several tables with chairs
*open fireplace with armchairs (optional)
*bar

Rooms and Furniture

2017-06-06T12:20:56Z

Destined:

==Rooms per Household==
Depending on the size and wealth of the household, it will contain different rooms. Here is an exemplary list of which rooms should be present in which type of household.
===Low income/poor===

*very few rooms, mostly functional
*Should include kitchen and bedroom

===Merchants/Craftsmen===

*few rooms
*kitchen and bedroom
*workshop and/or
*room for selling should be included

===Tavern/Inn===

*kitchen,
*storage room
*taproom
*bedrooms for guests and owners,
*bathroom (optional, may be exchanged with basins in guests' rooms)

===Nobels===

*kitchen and seperate dining room,
*several bedrooms (number depending on family size: seperate rooms for adilts and each child, additional bedrooms for guests possible),
*at least one bathroom (toilet included or seperate),
*further rooms like office/library, sitting room

==Furniture per Room==
Each room should have a furniture in accordance with the function of the room. Depending on the household the quality and quantity of the furniture should be chosen.

===Kitchen===

*stove
*working space
*cupboard for cutlery and dishes (may be placed in a seperate dining room)
*table and chairs/stools (may be placed in a seperate dining room)

===Storage Room===

*shelves and hooks for food stuff
*bottles (various)
*barrels (especially in taverns)
*various containers (boxes etc)

===Bathroom===

*bathtub
*basin for washing
*cupboard for bathing supplies

===Bedroom===

*bed(s)
*nightstand
*cupboard for clothing

===Living Room===

*table
*armchairs
*bookshelve(s)
*lamps or similar for light
*other leisure time stuff (instruments, knitting needles, board games, stuff like that)

===Office / Study===

*desk with chair
*bookshelve(s)

===Workshop===

*tools of the trade (see the [[Jobs]] page for inspiration)
*workbench
*stool

===Taproom===

*several tables with chairs
*open fireplace with armchairs (optional)
*bar

Rooms and Furniture

2017-06-06T12:15:46Z

Destined: /* Furniture per Room */

==Rooms per Household==
Depending n the size and wealth of the household, it will contain different rooms. Here is an exemplary list of which rooms should be present in which type of household.
===Low income/poor===

*very few rooms, mostly functional
*Should include kitchen and bedroom

===Merchants/Craftsmen===

*few rooms
*kitchen and bedroom
*workshop and/or
*room for selling should be included

===Tavern/Inn===

*kitchen,
*storage room
*taproom
*bedrooms for guests and owners,
*bathroom (optional, may be exchanged with basins in guests' rooms)

===Nobels===

*kitchen and seperate dining room,
*several bedrooms (number depending on family size: seperate rooms for adilts and each child, additional bedrooms for guests possible),
*at least one bathroom (toilet included or seperate),
*further rooms like office/library, sitting room

==Furniture per Room==
Each room should have a furniture in accordance with the function of the room. Depending on the household the quality and quantity of the furniture should be chosen.

===Kitchen===

*stove
*working space
*cupboard for cutlery and dishes (may be placed in a seperate dining room)
*table and chairs/stools (may be placed in a seperate dining room)

===Storage Room===

*shelves and hooks for food stuff
*bottles (various)
*barrels (especially in taverns)
*various containers (boxes etc)

===Bathroom===

*bathtub
*basin for washing
*cupboard for bathing supplies

===Bedroom===

*bed(s)
*nightstand
*cupboard for clothing

===Living Room===

*table
*armchairs
*bookshelve(s)
*lamps or similar for light
*other leisure time stuff (instruments, knitting needles, board games, stuff like that)

===Office / Study===

*desk with chair
*bookshelve(s)

===Workshop===

*tools of the trade (see the [[Jobs]] page for inspiration)
*workbench
*stool

===Taproom===

*several tables with chairs
*open fireplace with armchairs (optional)
*bar

Rooms and Furniture

2017-06-06T07:37:16Z

Destined:

==Rooms per Household==
Depending n the size and wealth of the household, it will contain different rooms. Here is an exemplary list of which rooms should be present in which type of household.
===Low income/poor===

*very few rooms, mostly functional
*Should include kitchen and bedroom

===Merchants/Craftsmen===

*few rooms
*kitchen and bedroom
*workshop and/or
*room for selling should be included

===Tavern/Inn===

*kitchen,
*storage room
*taproom
*bedrooms for guests and owners,
*bathroom (optional, may be exchanged with basins in guests' rooms)

===Nobels===

*kitchen and seperate dining room,
*several bedrooms (number depending on family size: seperate rooms for adilts and each child, additional bedrooms for guests possible),
*at least one bathroom (toilet included or seperate),
*further rooms like office/library, sitting room

==Furniture per Room==
each room should have a furniture in accordance with the function of the room. Depending ong the household the quality and quantity of the furniture should be chosen.

===Kitchen===

*stove
*working space
*cupboard for cutlery and dishes (may be placed in a seperate dining room)
*table and chairs/stools (may be placed in a seperate dining room)

===Storage Room===

*shelves and hooks for food stuff
*bottles (various)
*barrels (especially in taverns)
*various containers (boxes etc)

===Bathroom===

*bathtub
*basin for washing
*cupboard for bathing supplies

===Bedroom===

*bed(s)
*nightstand
*cupboard for clothing

===Living Room===

*table
*armchairs
*bookshelve(s)
*lamps or similar for light
*other leisure time stuff (instruments, knitting needles, board games, stuff like that)

===Office / Study===

*desk with chair
*bookshelve(s)

===Workshop===

*tools of the trade (see the [[Jobs]] page for inspiration)
*workbench
*stool

===Taproom===

*several tables with chairs
*open fireplace with armchairs (optional)
*bar

Rooms and furniture

2017-06-06T07:34:27Z

Destined: Destined moved page Rooms and furniture to Rooms and Furniture

#REDIRECT [[Rooms and Furniture]]

Rooms and Furniture

2017-06-06T07:34:27Z

Destined: Destined moved page Rooms and furniture to Rooms and Furniture

==Rooms per Household==
Depending n the size and wealth of the household, it will contain different rooms. Here is an exemplary list of which rooms should be present in which type of household.
===Low income/poor===

*Very few rooms, mostly functional
*Should include kitchen and bedroom

===Merchants/Craftsmen===

*Few rooms
*kitchen and bedroom
*workshop and/or
*room for selling should be included

===Tavern/Inn===

*Kitchen,
*storage room
*taproom
*bedrooms for guests and owners,
*bathroom (optional, may be exchanged with basins in guests' rooms)

===Nobels===

*Kitchen and seperate dining room,
*several bedrooms (number depending on family size: seperate rooms for adilts and each child, additional bedrooms for guests possible),
*at least one bathroom (toilet included or seperate),
*further rooms like office/library, sitting room

==Furniture per Room==
Each room should have a furniture in accordance with the function of the room. Depending ong the household the quality and quantity of the furniture should be chosen.

===Kitchen===

*stove
*working space
*cupboard for cutlery and dishes (may be placed in a seperate dining room)
*table and chairs/stools (may be placed in a seperate dining room)

===Storage Room===

*shelves and hooks for food stuff
*bottles (various)
*barrels (especially in taverns)
*various containers (boxes etc)

===Bathroom===

*bathtub
*basin for washing
*cupboard for bathing supplies

===Bedroom===

*bed(s)
*nightstand
*cupboard for clothing

===Living Room===

*table
*armchairs
*bookshelve(s)
*lamps or similar for light
*other leisure time stuff (instruments, knitting needles, board games, stuff like that)

===Office / Study===

*desk with chair
*bookshelve(s)

===Workshop===

*tools of the trade (see the [[Jobs]] page for inspiration)
*workbench
*stool

===Taproom===

*several tables with chairs
*open fireplace with armchairs (optional)
*bar

Rooms and Furniture

2017-06-06T07:33:51Z

Destined: Created page with "==Rooms per Household== Depending n the size and wealth of the household, it will contain different rooms. Here is an exemplary list of which rooms should be present in which..."

==Rooms per Household==
Depending n the size and wealth of the household, it will contain different rooms. Here is an exemplary list of which rooms should be present in which type of household.
===Low income/poor===

*Very few rooms, mostly functional
*Should include kitchen and bedroom

===Merchants/Craftsmen===

*Few rooms
*kitchen and bedroom
*workshop and/or
*room for selling should be included

===Tavern/Inn===

*Kitchen,
*storage room
*taproom
*bedrooms for guests and owners,
*bathroom (optional, may be exchanged with basins in guests' rooms)

===Nobels===

*Kitchen and seperate dining room,
*several bedrooms (number depending on family size: seperate rooms for adilts and each child, additional bedrooms for guests possible),
*at least one bathroom (toilet included or seperate),
*further rooms like office/library, sitting room

==Furniture per Room==
Each room should have a furniture in accordance with the function of the room. Depending ong the household the quality and quantity of the furniture should be chosen.

===Kitchen===

*stove
*working space
*cupboard for cutlery and dishes (may be placed in a seperate dining room)
*table and chairs/stools (may be placed in a seperate dining room)

===Storage Room===

*shelves and hooks for food stuff
*bottles (various)
*barrels (especially in taverns)
*various containers (boxes etc)

===Bathroom===

*bathtub
*basin for washing
*cupboard for bathing supplies

===Bedroom===

*bed(s)
*nightstand
*cupboard for clothing

===Living Room===

*table
*armchairs
*bookshelve(s)
*lamps or similar for light
*other leisure time stuff (instruments, knitting needles, board games, stuff like that)

===Office / Study===

*desk with chair
*bookshelve(s)

===Workshop===

*tools of the trade (see the [[Jobs]] page for inspiration)
*workbench
*stool

===Taproom===

*several tables with chairs
*open fireplace with armchairs (optional)
*bar

Jobs

2017-05-26T08:22:23Z

Destined:

APOTHECARY
An Apothecary dispensed remedies made from herbs, plants and roots. Physicians were expensive and a priest often held this occupation, often the only recourse for sick, poor people.

ARTIST
Artists were employed by the aristocracy, especially for portraits.

ASTROLOGER
An astrologer studied the stars and planets but regarded as a mystical person.

BAKER
Bread was a daily staple of Elizabethan life, and good bakers were employed by Nobles in their castles.

BARBER
A Barber had many occupations in relation to personal care. Barbers would cut hair but would also serve as dentists, surgeons and blood-letters.

BLACKSMITH
The Blacksmith was one of the most important, albeit lowly, occupations of the Elizabethan era. Blacksmiths forged weapons, sharpened weapons, repaired armor.

BOTTLER
A Bottler had a responsible occupation and was in charge of the Bottlery which was intended for storing and dispensing wines and other expensive provisions.

BUTLER
The Butler was responsible for the castle cellar and was in charge of large butts of beer. The room in the castle called the Buttery was intended for storing and dispensing beverages, especially ale.

BOWER OR BOWYER
The Bowyer manufactured bows, arrows and crossbows.

CANDLEMAKER
The Candlemaker made candles to light a castle or palace. Candles were supplemented by lighting from torches, lanterns and rush dips.

CARPENTER
The occupation of the Carpenter was diverse. Carpenters built furniture, roofing, and wood panelling. Carpenter: a skilled craftsman who shaped or made things of wood. Carpenters were highly skilled and considered to be elite tradesmen.

CHAMBERLAIN
Chamberlain - The title originated with an officer of a royal household who was responsible for the Chamber, which included the administration of the Queen's household's budget. This occupation was later extended to collecting revenues and paying expenses.

CHANCELLOR
A chancellor was a secretary to a Noble or Royal person.

CHAPLAIN
The Chaplain was responsible for the religious activities of a castle servants and Men at arms. The duties might also include that of a clerk and keeping accounts. A Priest would usually looked after the spiritual needs and confessions of the Nobles and their families.

CLERK
A Clerk was employed to keep accounts.

CLOTHIER
Clothiers made clothes for the nobles and required having a knowledge of various fine and expensive materials.

CONSTABLE
Constable was the occupation of the person who had been appointed as Custodian, or in charge of, the castle.

COOK
Cook was employed in the castle kitchens roasting, broiling, and baking food in the fireplaces and ovens.

CORDWAINER
A Cordwainer was a Shoemaker or Cobbler, a craftsman who made shoes.

COTTAR
A Cottar was one of the lowest peasant occupations, undertaken by the old or infirm, who had a series of low duties including swine-herd,, prison guard and menial tasks.

EWERER
A Ewerer brought and heated water for nobles.

FISHERMAN
Fishermen capture fish and other animals from a body of water, or gather shellfish.

FLETCHER
The Fletcher crafted and manufactured bows and the flights of arrows.

GARDENER
The Elizabethan Gardener needed a knowledge of herbs and plants.

GONG FARMER
Gong was another name for dung.

HERALD OR HARKER
A Herald was a knights assistant and an expert advisor on heraldry. The Herald (or Harker) would declare announcements on behalf of the Queen or Noble to the public. Normally this was done on a given day when the public would assemble at the base of a castle tower or in the town square and the Herald would shout out the news.

HERBALIST
A Herbalist was usually a member of a religious order such as a monk or friar who would plant and maintainmedicinal plants, roots and herbs.

JANITOR
The Janitor, or Porter, was responsible for a main Castle entrance and for the guardrooms. The Janitor also insured that no one entered or left the castle without permission.

JESTER
The Jester also referred to as the Fool entertained the Queen and the court.

KEEPER OF THE WARDROBE
The room in the castle called the wardrobe was intended as a dressing room and storage room for clothes and used by the Queen and Upper Classes. The Keeper of the Wardrobe was in charge of the tailors and laundress.

KNIGHT
It was the duty of a Knight to learn how to fight and so serve their Queen according to the Code of Chivalry. Weapon practise included enhancing skills in the sword, battle axe, dagger and lance.

MARSHAL
Marshal was the officer in charge of a household's horses, carts, wagons, containers and the transporting of goods.

MESSENGER
Messengers were lesser diplomats of the lord who carried receipts, letters, and commodities.

MINSTREL
Minstrels provided Castle entertainment in the form of singing and playing musical instruments. Minstrels often would record the deeds of heroic knights in songs giving the knight great publicity and establishing respect and additional status.

MONEYLENDER
Moneylenders were the Elizabethan bankers.

PAGE
The life of a castle Page would start at a very young age - seven years old. A Page was junior to a Squire. It was the duty of a Page to wait at table, care for the Lord's clothes and assist them in dressing. The Page was provided with a uniform of the colours and livery of the Lord.

PAINTER
Elizabethan castles ere highly colorful and the services of painters were often required.

PORTER
The Janitor, or Porter, was responsible for a Castle entrance and for the guardrooms. The Porter also insured that no one entered or left the castle without permission.

PHYSICIAN
Physicians were a very highly regarded and respected occupation. Bleeding, lancing and surgical procedures were practised.

POTTER
Potters were craftsmen of in clay, porcelain and early forms of ceramics. Basically they produced pots for cooking and storage and occasionally worked as sculptors. Potters were members of craft guilds.

REEVE
The Reeve supervised all work on a lord's property. The Reeve ensured that everyone began and stopped work on time.

SCRIBE
Most Scribes came from religious establishments where reading, writing and comprehension skills were learned.

SCULLION
Scullions were the lowest of kitchen workers whose duties included washing and cleaning the kitchen.

SHOEMAKER
A Shoemaker or Cobbler or Cordwainer was a craftsman who made shoes.

SPINSTER
Spinster was the name of the occupation given to a woman who earned her living spinning yarn. The Spinning Wheel was invented during the Elizabethan era. Later the term Spinster was used to describe any unmarried woman.

STEWARD
The Steward took care of castle estates and household administration including the events in the Great Hall.

SQUIRE
A Squire was junior to a Knight. It was the duty of a Squire to learn about the Code of Chivalry, the rules of Heraldry, horsemanship and practise the use of weapons. It was also their duty to enter into court life and learn courtly etiquette, music and dancing.

WATCHMAN
Watchmen was an official at the castle responsible for security. Also night-watchman.

Jobs

2017-05-26T08:17:45Z

Destined:

APOTHECARY
An Apothecary dispensed remedies made from herbs, plants and roots. Physicians were expensive and a priest often held this occupation, often the only recourse for sick, poor people

ARTIST
Artists were employed by the aristocracy, especially for portraits.

ASTROLOGER
An astrologer studied the stars and planets but regarded as a mystical person.

BAKER
Bread was a daily staple of Elizabethan life, and good bakers were employed by Nobles in their castles.

BARBER
A Barber had many occupations in relation to personal care. Barbers would cut hair but would also serve as dentists, surgeons and blood-letters.

BLACKSMITH
The Blacksmith was one of the most important, albeit lowly, occupations of the Elizabethan era. Blacksmiths forged weapons, sharpened weapons, repaired armor.

BOTTLER
A Bottler had a responsible occupation and was in charge of the Bottlery which was intended for storing and dispensing wines and other expensive provisions.

BUTLER
The Butler was responsible for the castle cellar and was in charge of large butts of beer. The room in the castle called the Buttery was intended for storing and dispensing beverages, especially ale.

BOWER OR BOWYER
The Bowyer manufactured bows, arrows and crossbows

CANDLEMAKER
The Candlemaker made candles to light a castle or palace. Candles were supplemented by lighting from torches, lanterns and rush dips.

CARPENTER
The occupation of the Carpenter was diverse. Carpenters built furniture, roofing, and wood panelling. Carpenter: a skilled craftsman who shaped or made things of wood. Carpenters were highly skilled and considered to be elite tradesmen

CHAMBERLAIN
Chamberlain - The title originated with an officer of a royal household who was responsible for the Chamber, which included the administration of the Queen's household's budget. This occupation was later extended to collecting revenues and paying expenses

CHANCELLOR
A chancellor was a secretary to a Noble or Royal person

CHAPLAIN
The Chaplain was responsible for the religious activities of a castle servants and Men at arms. The duties might also include that of a clerk and keeping accounts. A Priest would usually looked after the spiritual needs and confessions of the Nobles and their families

CLERK
A Clerk was employed to keep accounts

CLOTHIER
Clothiers made clothes for the nobles and required having a knowledge of various fine and expensive materials

CONSTABLE
Constable was the occupation of the person who had been appointed as Custodian, or in charge of, the castle

COOK
Cook was employed in the castle kitchens roasting, broiling, and baking food in the fireplaces and ovens.

CORDWAINER
A Cordwainer was a Shoemaker or Cobbler, a craftsman who made shoes

COTTAR
A Cottar was one of the lowest peasant occupations, undertaken by the old or infirm, who had a series of low duties including swine-herd,, prison guard and menial tasks

EWERER
A Ewerer brought and heated water for nobles

FLETCHER
The Fletcher crafted and manufactured bows and the flights of arrows

GARDENER
The Elizabethan Gardener needed a knowledge of herbs and plants.

GONG FARMER
Gong was another name for dung.

HERALD OR HARKER
A Herald was a knights assistant and an expert advisor on heraldry. The Herald (or Harker) would declare announcements on behalf of the Queen or Noble to the public. Normally this was done on a given day when the public would assemble at the base of a castle tower or in the town square and the Herald would shout out the news

HERBALIST
A Herbalist was usually a member of a religious order such as a monk or friar who would plant and maintainmedicinal plants, roots and herbs.

JANITOR
The Janitor, or Porter, was responsible for a main Castle entrance and for the guardrooms. The Janitor also insured that no one entered or left the castle without permission

JESTER
The Jester also referred to as the Fool entertained the Queen and the court

KEEPER OF THE WARDROBE
The room in the castle called the wardrobe was intended as a dressing room and storage room for clothes and used by the Queen and Upper Classes. The Keeper of the Wardrobe was in charge of the tailors and laundress.

KNIGHT
It was the duty of a Knight to learn how to fight and so serve their Queen according to the Code of Chivalry. Weapon practise included enhancing skills in the sword, battle axe, dagger and lance.

MARSHAL
Marshal was the officer in charge of a household's horses, carts, wagons, containers and the transporting of goods.

MESSENGER
Messengers were lesser diplomats of the lord who carried receipts, letters, and commodities.

MINSTREL
Minstrels provided Castle entertainment in the form of singing and playing musical instruments. Minstrels often would record the deeds of heroic knights in songs giving the knight great publicity and establishing respect and additional status

MONEYLENDER
Moneylenders were the Elizabethan bankers.

PAGE
The life of a castle Page would start at a very young age - seven years old. A Page was junior to a Squire. It was the duty of a Page to wait at table, care for the Lord's clothes and assist them in dressing. The Page was provided with a uniform of the colours and livery of the Lord.

PAINTER
Elizabethan castles ere highly colorful and the services of painters were often required

PORTER
The Janitor, or Porter, was responsible for a Castle entrance and for the guardrooms. The Porter also insured that no one entered or left the castle without permission

PHYSICIAN
Physicians were a very highly regarded and respected occupation. Bleeding, lancing and surgical procedures were practised.

POTTER
Potters were craftsmen of in clay, porcelain and early forms of ceramics. Basically they produced pots for cooking and storage and occasionally worked as sculptors. Potters were members of craft guilds

REEVE
The Reeve supervised all work on a lord's property. The Reeve ensured that everyone began and stopped work on time

SCRIBE
Most Scribes came from religious establishments where reading, writing and comprehension skills were learned.

SCULLION
Scullions were the lowest of kitchen workers whose duties included washing and cleaning the kitchen

SHOEMAKER
A Shoemaker or Cobbler or Cordwainer was a craftsman who made shoes

SPINSTER
Spinster was the name of the occupation given to a woman who earned her living spinning yarn. The Spinning Wheel was invented during the Elizabethan era. Later the term Spinster was used to describe any unmarried woman

STEWARD
The Steward took care of castle estates and household administration including the events in the Great Hall.

SQUIRE
A Squire was junior to a Knight. It was the duty of a Squire to learn about the Code of Chivalry, the rules of Heraldry, horsemanship and practise the use of weapons. It was also their duty to enter into court life and learn courtly etiquette, music and dancing.

WATCHMAN
Watchmen was an official at the castle responsible for security. Also night-watchman

Sleeping AI

2017-05-19T15:54:17Z

Destined:

==Introduction==

Sleeping AI are (mostly) working now. They can either put themselves to bed at map start and remain there (unless alerted) or else patrol there, sleep for a while, then patrol again.

==Non-patrolling sleepers==

These are defined as sleepers at the start and immediately lay down. They only will get up if alerted.

Set on the AI the spawn arg:

''sleeping 1''

==Patrol Sleepers==

This is done by targeting a path_sleep entity which then targets a path_wait to define how long they will sleep before getting up again.

==Sleep Location==

''sleep_location 0'' - sleep on the floor

''sleep_location 1'' - sleep on a bed

==Setting up==

By default, place the AI on the right side of the bed (as you look towards the head of the bed) and '''facing away''' from the bed.

===Direction===

If you want the AI to start from the left side of the bed (as you look towards the head of the bed) then add:

''lay_down_left 0'' (note this goes on the AI if the AI is using sleeping 1 BUT on the path_sleep if you are using a path_sleep)

===Sleeping position in the bed===

====Head to Toe====

Stand the AI close to the bed facing away from it and about half way between the head and the foot; adjust as needed towards the head or foot direction of the bed.

====Sideways====

The distance the AI slides across onto the bed can be controlled by

''lay_down_slide_dist 16'' (default)

(note this goes on the AI if the AI is using sleeping 1 BUT on the path_sleep if you are using a path_sleep)

==Monster clip the bed or not?==

Yes, monster clip should not directly effect the sleep animation and the bed should normally be monsterclipped anyway. The only way it might affect it is if the clip sticks out too far and stops the AI getting near enough. In that case reduce narrow the clip close to the bed edge and/or adjust the slide value (see [[#Sleeping position in the bed]])

==Problems, Troubleshooting==

There are a few known problems:

===AI is sinking into the bed or floating high===

AI animate to the same height so if they are slightly high the first thing to check is the bed surface height. Most Dark Mod beds are a standard height which is correct for sleepers. One known bed (at time of writing) is a little high so AI will animate into it so be sunk a little low. This bed can be sunk a little into the floor to compensate. If they are floating slightly high then the bed can be lifted a little and perhaps some wood brushes under the legs make it right.

If the AI are floating '''very''' high then this is most likely caused by the AI clipping into the bed at the start so they are lifted up to stand on its edge before they animate. They then animate up even higher. Solution: move them further out at the start. Note: this problem probably only affects AI that start off sleeping rather than patrol to a bed.

===AI lays down too far to one side of the bed===

To move an AI across the bed see [[#Sleeping position in the bed]]

===AI lays wrong way head to foot===

If the AI is laying the wrong way with his head at the foot of the bed and his feet at the head then see [[#Direction]]

==Sleeping While Sitting==

It is also possible to put an AI to sleep on a chair. This requires a more elaborate setup than the regular sleeping while lying down, as the animations of the sleeping behaviour have to be exchanged. In order to achieve this, a dummy entity is required. Up to now, this entity is not part of the core mod, so the following has to be copy/pasted into a def file, that then has to be put into the folder "def" of the mod or the FM that uses it:

entityDef atdm:animation_sleep_sit {
"inherit" "atdm:prop_base"
"editor_usage" "Used to make AI sleep in a sitting position instead of laying down"
"model" "models/darkmod/misc/system/empty.lwo"
"joint" "RightHand"

"replace_anim_sit_2_sleep_lft" "sit_2_sleep_on_chair"
"replace_anim_sit_2_sleep_rgt" "sit_2_sleep_on_chair"
"replace_anim_sleep_idle_lft" "sit_sleep_idle"
"replace_anim_sleep_idle_rgt" "sit_sleep_idle"
"replace_anim_sleep_2_sit_lft" "sleep_2_sit_on_chair"
"replace_anim_sleep_2_sit_rgt" "sleep_2_sit_on_chair"

"origin" "0 0 0"
"angles" "0 0 0"
"remove" "0"
}

The AI has to get the following spawnargs:

"def_attach5" "atdm:animation_sleep_sit"
"pos_attach5" "hand_r"
"lay_down_slide_dist" "0"

The first two spawnargs attach the dummy entity to the AI, while the third spawnarg prevents the AI from sliding into the chair. This method works with both patrol sleepers as well as non-patroling AI.

'''PLEASE NOTE:'''

This method replaces the "sleeping on a bed" behaviour. This means that the spawnarg "sleep_location" has to be set to "1". Setting it to 0 will still lead to the AI sleeping on the ground. The AI will only be able to sleep in a sitting position as long as the entity "atdm:animation_sleep_sit" is attached to it. Removing the entity will revert the sleeping behaviour, so the AI will sleep on a bed again.

The AI sitting down is part of the sleeping behaviour, much like it is part of "sleeping on the bed". This means, with this method the AI will sit down and immedaitely go to sleep. It is ''NOT'' possible to play other sitting animations in between.

==Known bugs==

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

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

When you KO a sleeping AI, they may drop down through the bed, pop back to standing, like they did in Thief,

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

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

{{tutorial-ai}}

Sleeping AI

2017-05-19T15:23:38Z

Destined:

==Introduction==

Sleeping AI are (mostly) working now. They can either put themselves to bed at map start and remain there (unless alerted) or else patrol there, sleep for a while, then patrol again.

==Non-patrolling sleepers==

These are defined as sleepers at the start and immediately lay down. They only will get up if alerted.

Set on the AI the spawn arg:

''sleeping 1''

==Patrol Sleepers==

This is done by targeting a path_sleep entity which then targets a path_wait to define how long they will sleep before getting up again.

==Sleep Location==

''sleep_location 0'' - sleep on the floor

''sleep_location 1'' - sleep on a bed

==Setting up==

By default, place the AI on the right side of the bed (as you look towards the head of the bed) and '''facing away''' from the bed.

===Direction===

If you want the AI to start from the left side of the bed (as you look towards the head of the bed) then add:

''lay_down_left 0'' (note this goes on the AI if the AI is using sleeping 1 BUT on the path_sleep if you are using a path_sleep)

===Sleeping position in the bed===

====Head to Toe====

Stand the AI close to the bed facing away from it and about half way between the head and the foot; adjust as needed towards the head or foot direction of the bed.

====Sideways====

The distance the AI slides across onto the bed can be controlled by

''lay_down_slide_dist 16'' (default)

(note this goes on the AI if the AI is using sleeping 1 BUT on the path_sleep if you are using a path_sleep)

==Monster clip the bed or not?==

Yes, monster clip should not directly effect the sleep animation and the bed should normally be monsterclipped anyway. The only way it might affect it is if the clip sticks out too far and stops the AI getting near enough. In that case reduce narrow the clip close to the bed edge and/or adjust the slide value (see [[#Sleeping position in the bed]])

==Problems, Troubleshooting==

There are a few known problems:

===AI is sinking into the bed or floating high===

AI animate to the same height so if they are slightly high the first thing to check is the bed surface height. Most Dark Mod beds are a standard height which is correct for sleepers. One known bed (at time of writing) is a little high so AI will animate into it so be sunk a little low. This bed can be sunk a little into the floor to compensate. If they are floating slightly high then the bed can be lifted a little and perhaps some wood brushes under the legs make it right.

If the AI are floating '''very''' high then this is most likely caused by the AI clipping into the bed at the start so they are lifted up to stand on its edge before they animate. They then animate up even higher. Solution: move them further out at the start. Note: this problem probably only affects AI that start off sleeping rather than patrol to a bed.

===AI lays down too far to one side of the bed===

To move an AI across the bed see [[#Sleeping position in the bed]]

===AI lays wrong way head to foot===

If the AI is laying the wrong way with his head at the foot of the bed and his feet at the head then see [[#Direction]]

==Sleeping While Sitting==

It is also possible to put an AI to sleep on a chair. This requires a more elaborate setup than the regular sleeping while lying down, as the animations of the sleeping behaviour have to be exchanged. In order to achieve this, a dummy entity is required. Up to now, this entity is not part of the core mod, so the following has to be copy/pasted into a def file, that then has to be put into the folder "def" of the mod or the FM that uses it:

entityDef atdm:animation_sleep_sit {
"inherit" "atdm:prop_base"
"editor_usage" "Used to make AI sleep in a sitting position instead of laying down"
"model" "models/darkmod/misc/system/empty.lwo"
"joint" "RightHand"

"replace_anim_sit_2_sleep_lft" "sit_2_sleep_on_chair"
"replace_anim_sit_2_sleep_rgt" "sit_2_sleep_on_chair"
"replace_anim_sleep_idle" "sit_sleep_idle"
"replace_anim_sleep_idle_lft" "sit_sleep_idle"
"replace_anim_sleep_idle_rgt" "sit_sleep_idle"
"replace_anim_sleep_2_sit_lft" "sleep_2_sit_on_chair"
"replace_anim_sleep_2_sit_rgt" "sleep_2_sit_on_chair"

"origin" "0 0 0"
"angles" "0 0 0"
"remove" "0"
}

The AI has to get the following spawnargs:

"def_attach5" "atdm:animation_sleep_sit"
"pos_attach5" "hand_r"
"lay_down_slide_dist" "0"

The first two spawnargs attach the dummy entity to the AI, while the third spawnarg prevents the AI from sliding into the chair. This method works with both patrol sleepers as well as non-patroling AI.

'''PLEASE NOTE:'''

This method replaces the "sleeping on a bed" behaviour. This means that the spawnarg "sleep_location" has to be set to "1". Setting it to 0 will still lead to the AI sleeping on the ground. The AI will only be able to sleep in a sitting position as long as the entity "atdm:animation_sleep_sit" is attached to it. Removing the entity will revert the sleeping behaviour, so the AI will sleep on a bed again.

The AI sitting down is part of the sleeping behaviour, much like it is part of "sleeping on the bed". This means, with this method the AI will sit down and immedaitely go to sleep. It is ''NOT'' possible to play other sitting animations in between.

==Known bugs==

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

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

When you KO a sleeping AI, they may drop down through the bed, pop back to standing, like they did in Thief,

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

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

{{tutorial-ai}}

Grouping

2017-04-22T10:10:02Z

Destined: Created page with "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 en..."

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. Note that it is not possible to change individual parts of the group without ungrouping.

== Grouping and Prefabs ==
With the introduction of the grouping feature Prefabs are grouped by default, as they ususally are used as a single entity. There a re 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.

AI stats

2017-04-21T12:35:46Z

Destined:

<pre style="color: red">THIS PAGE IS A WORK IN PROGRESS</pre>
== Spawnargs and Game Mechanics ==
In order to understand the influence of the spawnargs on game mechanics, I want to give a simple insight into the mechanics. For this I have decided to categorise them into four subgroups: AI perception, Combat, and Interaction between AIs and player out of combat.
=== AI perception ===
In the centre of each stealth game lies the perception of the AIs. This includes the ability of AIs to see, hear, and touch its environment. The chance to percieve anything with the respective sense is multiplied with the respective acuity_* spawnarg at some point. If the AI is drunk all these factors are multiplied with the drunk_acuity_factor (default 0.5), which reduces the chance of the AI to notice the player.
==== Visual perception ====
In general, when an object with an AIUse spawnarg comes into the field of vision of an AI, the AI gets a visual STIM. The chancenotice* spawnargs influence if the AI reacts to the STIM and the argument of the AIuse spawnarg (not listed in the table) determines how the AI reacts. For example if the AI gets a visual STIM of another friendly AI it will greet, while it will attack a hostile AI on sight. The chance to spot the player follows a more complex algorithm and is influenced by the brightness of the light gem, the distance to the AI and the visual acuity of the AI (acuity_vis). You can check the [[Visual scan]] article for further information.
==== Aural perception ====
Noises made by the player as well as thrown objects or noise arrows produce a propagated sound of a specified volume. The propagated sound's volume decreases linearly with increasing distance from the source. When it reaches an AI the alert_aud_thresh value is subtracted and the remaining volume (if it is greater than 0) is added to the alert level of an AI.
==== Tactile perception ====
Tactile perception gets triggered, when the AI collision model touches the player's collision model.
==== Perception and Alarms ====
When an AI perceives anything suspicious, it adds to the AI's alert level. When this counter exceeds a certain amount (alert_thresh#), the AI will reach the next alert stage. In order to prevent the alert level to ramp up too quickly there is a grace period (alert_gracetime#) during which a new suspicious stim will not further alert the AI. This period can be termintaed if the new stim during the grace period is too strong (exceeds the former addition to the alert level multiplied with the "alert_gracefrac#" value) or if there are too many stims in quick succession (exceeding the alert_gracvecount#). Above the "idle" state (0) there are five alert stages:
*1: Observant (bark, but otherwise no reaction)
*2: Suspicious (bark, look, may stop and turn)
*3: Searching (Investigation)
*4: Agitated Searching (Investigation, Weapon out, AI is quite sure that there is someone around)
*5: Combat.
The AI will stay in this alert state for a time determined by "alert_time#". Please note, that as soon as an AI has drawn its weapon it will not recede to the regular idle state, but instead to the "alert idle" state, which results in a hightened senses and possibly different behaviour of the AI (e.g. a former stationary AI starts patroling).
{| class="wikitable"
|+Spawnargs related to AI perception
|-
|acuity_aud
|AI aural acuity (in percent)
|-
|acuity_env
|AI environmental acuity. How sensitive the AI is to things that have changed in its environment.
|-
|acuity_other
|AI generic acuity for scripted events. You can call this alert type on an entity with entity.Alert( <char *type>, <float amount>). This will alert the entity by amount * acuity_other in your script.
|-
|acuity_tact
|AI tactile acuity (in percent)
|-
|acuity_vis
|AI visual acuity (in percent)
|-
|alert_aud_thresh
|Threshold of audibility for the AI. This is in dB of sound pressure level (SPL). The real life value for humans is around 20 (a barely heard whisper). Changing this by even 0.1 has a large effect on sound propagation behavior, because propagated sounds below this volume are not heard at all. NOTE if this is not set, it gets the value from soundprop global settings.
|-
|alert_gracecount#
|If the number of additional alerts for an AI in alert state # during the grace period exceeds the grace count, the grace period will be terminated.
|-
|alert_gracefrac#
|An alert that is higher than the last increase times the grace fraction will terminate the grace period for an AI in alert state #.
|-
|alert_gracetime#
|After being alerted, the AI in alert state # will ignore additional alerts during the grace period (in seconds), to avoid adding up the alert level too quickly.
|-
|alert_thresh#
|The alert level threshold for reaching alert state #.
|-
|alert_time#
|The time it takes for the alert level to ramp down from the upper to the lower threshold in alert state # (in seconds).
|-
|chancenoticeblood
|Chance to notice the visual stim of blood
|-
|chancenoticebrokenitem
|Chance to notice the visual stim of a broken item
|-
|chancenoticedoor
|Chance to notice the visual stim of an open door that should be closed
|-
|chancenoticelight
|Chance to notice the visual stim of a light that should be on
|-
|chancenoticemissingitem
|Chance to notice the visual stim of a missing item
|-
|chancenoticemonster
|Chance to notice the visual stim of a monster
|-
|chancenoticeperson
|Chance to notice the visual stim of other persons
|-
|chancenoticepickedpocket
|Chance to notice that an object bound to the AI has been stolen
|-
|chancenoticerope
|Chance to notice the visual stim of a rope created by a rope arrow
|-
|chancenoticesuspiciousitem
|Chance to notice the visual stim of suspicious items
|-
|chancenoticeundead
|Chance to notice the visual stim on an undead
|-
|chancenoticeweapon
|Chance to notice the visual stim of suspicious weapons
|-
|drunk_acuity_factor
|If the AI is drunk, their acuities (visual, hearing, tactile) will be reduced by this factor.
|-
|fov
|Full field of view in degrees. Will be used for both horizontal and vertical fov unless vertical is explicitly specified.
|-
|fov_rotation
|A vector of 3 space-delimited angles applied to rotate the AI's field of view relative to their head joint. For most heads, the angles are: yaw pitch roll.
|-
|fov_vert
|Full vertical field of view in degrees. Leave blank or set to -1 to use the same value as the horizontal fov.
|-
|headturn_chance_idle
|The chance for random head turning while idle (0 0-1 0)
|-
|headturn_factor_alerted
|The headturning chance gets multiplied by this amount when the AI is alerted
|-
|}
=== Interaction between AI and player ===
Apart from percieving their surroundings, there are several ways the AIs and the player can interact with each other and the environment. What an AI can do is defined by the "can*" spawnargs. If it is set to "1" an AI can for example use a light switch (like most humans can). If it is set to "0" it cannot do that. For example zombies are not able to operate switches or elevators.
=== Stealth Combat ===
A player may want to be sure that AI will not bother him/her any more. . It is possible to knock it out, as long as they are below their "ko_alert_immune_state". In order to achieve that, the player has to hit the AI with the blackjack in an area around the "ko_zone" (usually the head), that is defined by the two "ko_angle_horiz/vert" spawnargs. This area can change, when the AI is alerted to the values defined via the "ko_angle_alert_horiz/vert" spawnargs. An alternative way to knock out AI is with gas arrows, except if the AI has the spawnarg "gas_immune" set to 1 (e.g. as most undead have). For the more ruthless player, it is also possible to kill AIs. As long as AIs are not alerted (i.e. below the "sneak_attack_alert_state") the damage of each of the player's attacks is multiplied with a factor defined in "sneak_attack_mult", which can lead to one-shot kills, if the hit-zone does not reduce the damage too much. Sneak damage to the head should almost always result in death for the AI. Should the AI not be killed, it will be alerted, of course, and following attacks will not deal additional damage. For a short term distraction of AIs, the player can blind AI with flash bombs or distract them with noise arrows. Note that the flash bombs will only be dropped, when the "use" button in tapped. Holding the button for a longer time will resilt in a farther throwing distance. The AI will be bilnded for a time defined as "blind_time" that is randomized by the "blind_time_fuzzyness".
{| class="wikitable"
|+Spawnargs related to AI interactions with the player and vice versa
|-
|blind_time
|The time span in seconds the AI is staying in 'blinded' state when hit by a flashbomb or -mine.
|-
|can_drown
|If true, the AI will drown if it gets under water, either by walking in or by being dropped in unconsciously. Set to '0' to make them breathe under water.
|-
|canlighttorches
|AI ability to switch on torches
|-
|canoperatedoors
|AI ability to handle doors
|-
|canoperateelevators
|AI ability to handle elevators
|-
|canoperateswitchlights
|AI ability to operate light switches
|-
|cansearch
|Whether the AI can conduct a search or not
|-
|cansearchcooperatively
|ability to participate in a coordinated search
|-
|gas_immune
|0 = not immune, 1 = immune to gas
|-
|ko_alert_immune
|If true, the AI is immune to knockouts when alerted at or above the alert state defined in 'ko_alert_state'.
|-
|ko_alert_immune_state
|Alert state number at which immunity behavior changes.
|-
|ko_alert_state
|Alert state number at which knockout behavior changes.
|-
|ko_angle_alert_horiz
|Horizontal knockout cone angle when the AI is alerted at or above 'ko_alert_state'.
|-
|ko_angle_alert_vert
|Vertical knockout cone angle when the AI is alerted at or above 'ko_alert_state'.
|-
|ko_angle_horiz
|Defines a horizontal cone angle extending backwards from the direction AI is looking. Anywhere within this cone and the vertical cone is a valid KO.
|-
|ko_angle_vert
|Defines a vertical cone angle extending backwards from the direction AI is looking. Anywhere within this cone and the horizontal cone is a valid KO.
|-
|ko_immune
|0 = not immune, 1 = immune to blackjack
|-
|ko_rotation
|A vector of 3 space-delimited angles applied to rotate the AI's blackjack acceptance cone relative to their head joint. For most heads, the angles are: yaw pitch roll.
|-
|ko_spot_offset
|Defines the center of the head for knockout testing purposes. Vector offset from the head attachment joint to the desired head center point. The possible knockout cone extends back from this point.
|-
|ko_zone
|Name of the damage zone that must be hit for a possible knockout. Set this blank (i.e. : 'ko_zone' '') to make the AI immune to KOs from the blackjack.
|-
|pickpocket_alert
|Incremental alert value to be added to an AI's current alert level
|-
|pickpocket_delay_max
|Maximum delay before reacting to a picked pocket in milliseconds
|-
|picpocket_delay_min
|Minimum delay before reacting to a picked pocket in milliseconds
|-
|push_player
|Set this to 1 to let this entity push the player (default is 0).
|-
|sneak_attack_alert_state
|Alert state number at which the AI can no longer be sneak attacked.
|-
|sneak_attack_mult
|Damage multiplier applied to ALL damage when AI is damaged at an alert level below that defined in 'sneak_attack_alert_state'.
|-
|team
|Monsters do not actively attack players or monsters with the same team number. For common team numbers see [[AI Relations (Editing)]].
|-
|}
=== Open Combat ===
When stealth fails, the player always has the option to openly fight AIs instead of fleeing. However, combat in TDM is meant as a last resort and will ruin any stealth scores and will most likely kill you, when you face more than one guard. Also, common settings prohibit killing civilians (AI with the spawnarg "is_civilian" set to 1) and even guards on higher difficulties. The difficulty of a melee fight is influenced by three factors (not counting the player's skills): The combat difficulty setting in the menu (which can be set by the player), the melee skills of the AI (novice, trained, skilled, see Melee sets, are usually set for specific AI, but can be changed by the map author), and the difficulty setting of the current map (also chosen by the player). For a more detailed description on what to keep in mind while fighting, see [[The Dark Mod Gameplay#Combat|Combat]]. A hit by the player will deal damage. The damage reduces the amount of health of the AI by the base damage, scaled by the "damage_scale" of the zone hit. When the dealt damage surpasses the pain_threshold, the pain animation of the AI will be played. As soon as the health of the AI reaches the health_critical value, the AI will flee. Each successful hit or parry by the player will render an AI "flatfooted", which means it will not move for an amount of time defined as flatfooted_time (it can still attack, though). This time can be used to flee from the AI instead of continuing fighting. If the player gets outside the melee reange of an AI (e.g. by climbing somewhere the AI cannot reach), the AI will start throwing stones at the player if "outofreach_projectile_enabled" is set to "1". It will wait a random amount of time between "outofreach_projectile_delay_min" and "outofreach_projectile_delay_max" before doing so. The "attack_cone" determines in which region the AI can throw (or shoot in case of bowmen). Additionally, each shot will be offset by a random amount of up to "attack_accuracy" degrees, so not each shot will hit the player.
{| class="wikitable"
|+Spawnargs realted to combat
|-
|Spawnarg
|Explanation
|-
|armor
|Type of armor the AI is wearing (may vary depending on hit zone). The damage multipliers are: leather 0.75, chain 0.5, plate 0.
|-
|attack_accuracy
|Maximum angular offset to randomly offset the monster's aim when firing missiles
|-
|attack_cone
|Monster can only throw projectile within this cone relative to his direction.
|-
|bleed
|If set to true, this entity will bleed, e.g. spawn blood particles and decals when hurt.
|-
|can_be_flatfooted
|If set to true, the AI becomes flat-footed in certain combat situations. This means they're unable to run at the player, but can still turn to face the player.
|-
|damage
|Damage definition if it damages things it collides with.
|-
|damage_zones
|There are different hit zones for AI that vary the damage recieved from the player.
|-
|damage_scale "zone"
|Factor by which damage in the given zone is multiplied.
|-
|def_melee_set
|The defined melee set that describes the fighting skills. The levels are "novice", "trained", and "skilled" and are further modiefied by the difficulty of the game.
|-
|flatfooted_time
|The duration in milliseconds that this AI remains flat footed after a combat action triggers this state.
|-
|health
|Amount of damage to receive before dying.
|-
|health_critical
|When the health drops below this value, the AI will flee. Set this to 0 for AI that don't wet their pants.
|-
|is_civilian
|If true, the AI is a civilian. Defaults to 0.
|-
|move_speed
|The movement speed of AIs is dependent on their animations and animation rate. The animation rate can be changed with the anim_rate_X (X = animation name).
|-
|outofreach_projectile_delay_max
|Maximum period to wait between throwing player-out-of-reach projectiles in seconds
|-
|outofreach_projectile_delay_min
|Minimum period to wait between throwing player-out-of-reach projectiles in seconds
|-
|outofreach_projectile_enabled
|Ability to throw player-out-of-reach projectiles at the player.
|-
|pain_threshold
|How much damage monster has to receive in one blow for it to play a pain animation.
|-
|unarmed_melee
|Set this to 1 when this type of AI doesn't need melee weapons to fight. This is usually true for spiders, undead and such. Humans are wimps and need weapons.
|-
|unarmed_ranged
|Set this to 1 when this type of AI doesn't need weapons for ranged combat. This is usually true for belchers.
|}
== Human AIs ==
Human AIs are somewhat special as the spawnargs are defined by the entity definition as well as the definition of the head. This leads to a great number of combinations and is the reason that heads are discussed here as well as the various human classes. In order to make this article as clear as possible, in the first table the base values for human AIs are stated. In the class specific tables only changes to these base values are listed.
=== Base Values ===
This table lists all base values for human AIs in alphabetical order.
{| class="wikitable"
|+Humanoid AIs
|Spawnarg
|Base Value
|-
|acuity_aud
|100
|-
|acuity_env
|100
|-
|acuity_other
|100
|-
|acuity_tact
|100
|-
|acuity_vis
|100
|-
|alert_aud_thresh
|18.8
|-
|alert_gracecount1
|5
|-
|alert_gracecount2
|5
|-
|alert_gracecount3
|4
|-
|alert_gracecount4
|4
|-
|alert_gracefrac1
|1.2
|-
|alert_gracefrac2
|1.2
|-
|alert_gracefrac3
|1.2
|-
|alert_gracefrac4
|1.0
|-
|alert_gracetime1
|2
|-
|alert_gracetime2
|2
|-
|alert_gracetime3
|3
|-
|alert_gracetime4
|2
|-
|alert_thresh1
|1.5
|-
|alert_thresh2
|6
|-
|alert_thresh3
|10
|-
|alert_thresh4
|18
|-
|alert_thresh5
|23
|-
|alert_time1
|5 +/- 1.5
|-
|alert_time2
|8 +/- 2
|-
|alert_time3
|25 +/- 8
|-
|alert_time4
|65 +/- 20
|-
|alert_time5
|
|-
|armor
|variable
|-
|attack_accuracy
|2.3
|-
|attack_cone
|70
|-
|bleed
|1
|-
|blind_time
|8 +/- 4
|-
|can_be_flatfooted
|1
|-
|can_drown
|1
|-
|canlighttorches
|1
|-
|canoperatedoors
|1
|-
|canoperateelevators
|1
|-
|canoperateswitchlights
|1
|-
|cansearch
|1
|-
|cansearchcooperatively
|1
|-
|chancenoticeblood
|1.0
|-
|chancenoticebrokenitem
|1.0
|-
|chancenoticedoor
|1.0
|-
|chancenoticelight
|0.9
|-
|chancenoticemissingitem
|1.0
|-
|chancenoticemonster
|1.0
|-
|chancenoticeperson
|1.0
|-
|chancenoticepickedpocket
|0.5
|-
|chancenoticerope
|1.0
|-
|chancenoticesuspiciousitem
|1.0
|-
|chancenoticeundead
|1.0
|-
|chancenoticeweapon
|1.0
|-
|damage
|34
|-
|damage_zone
|head, chest, torso_low, left_arm, right_arm, legs
|-
|damage_scale head
|2
|-
|damage_scale chest
|1.5
|-
|damage_scale torso_low
|1.0
|-
|damage_scale left_arm
|0.3
|-
|damage_scale right_arm
|0.3
|-
|damage_scale legs
|0.4
|-
|def_melee_set
|variable
|-
|drunk_acuity_factor
|0.5
|-
|fov
|150
|-
|fov_rotation
|0 -20 0
|-
|fov_vert
|120
|-
|gas_immune
|0
|-
|headturn_chance_idle
|0.3
|-
|headturn_factor_alerted
|2
|-
|health
| variable
|-
|health_critical
|15
|-
|is_civilian
|0
|-
|is_mantleable
|0
|-
|ko_alert_immune
|0
|-
|ko_alert_immune_state
|5
|-
|ko_alert_state
|4 (as soon as weapon is drawn)
|-
|ko_angle_alert_horiz
|110
|-
|ko_angle_alert_vert
|180
|-
|ko_angle_horiz
|360
|-
|ko_angle_vert
|360
|-
|ko_immune
|0
|-
|ko_rotation
|0 0 0
|-
|ko_spot_offset
|2 -2.5 0
|-
|ko_zone
|head
|-
|melee_damage
|variable
|-
|melee_damage_mod
|0.6 - 1.4
|-
|melee_predicts_proximity
|1
|-
|melee_predicted_attack_time
|750
|-
|melee_range
|0
|-
|melee_rep_attack_time
|10000
|-
|outofreach_projectile_delay_max
|7.0
|-
|outofreach_projectile_delay_min
|10.0
|-
|outofreach_projectile_enabled
|1
|-
|pain_threshold
|1
|-
|pickpocket_alert
|0
|-
|pickpocket_delay_max
|25000
|-
|picpocket_delay_min
|5000
|-
|push_player
|
|-
|sneak_attack_alert_state
|2
|-
|sneak_attack_mult
|2.0
|-
|stamina
|player only
|-
|team
| variable
|-
|unarmed_melee
|0
|-
|unarmed_ranged
|0
|-
|}
=== Heads ===
Different heads can change the cones of the field of vision and the ko volume, so it it is advisable to check if any AI you encounter wears a hat or helmet and/or an eye patch. Please note that even though many AIs wear helmets, this only reduces the cone in which you can knock out the guard. Only the ones with neck protecting elite helmets (see [[Heads Available for AI#Elite Guard Heads|Heads Available for AI]]) are in general immune to being knocked out (i.e. the cone you have to hit with the blackjack is reduced to 0).
{| class="wikitable"
|+Heads
|Spawnarg
|Heads with an eye patch
|Heads with hoods
|Head with a straw hat
|Heads with non-brimmed helmet
|Heads with non-brimmed saxon helmet
|Heads with brimmed City Watch helmet
|Heads with elite helmet
|Heads with brimmed City Watch helmet and an eye-patch
|Heads with elite helmet and an eye-patch
|-
|Heads
|[[Heads Available for AI#Builder Guard Heads|Builder Guard Head 6]],[[Heads Available for AI#Generic Guard Heads|Commoner Default Heads 2, 12]], [[Heads Available for AI#Commoner Default Heads|Commoner Default Head 12]]
|[[Heads Available for AI#Commoner Default Heads|Commoner Default Heads 1,10]]
|[[Heads Available for AI#Commoner Default Heads|Commoner Default Head 3]]
|[[Heads Available for AI#Generic Guard Heads|Commoner Default Heads 6, 7, 13, 16]]
|[[Heads Available for AI#Generic Guard Heads|Commoner Default Heads 14, 15]]
|[[Heads Available for AI#City Watch Heads|City Watch Heads 1 - 4, 6 - 8]]
|[[Heads Available for AI#Elite Guard Heads|Elite Guard Heads 1,2]]
|[[Heads Available for AI#City Watch Heads|City Watch Heads 5, 10]]
|[[Heads Available for AI#Elite Guard Heads|Elite Guard Heads 3]]
|-
|fov
|110
|80
|150
|150
|110
|150
|150
|110
|110
|-
|fov_rotaion
| -30 -20 0
|0 -35 0
|0 -35 0
|0 -30 0
|0 -30 0
|0 -30 0
|0 -30 0
| 0 -30 0
|-30 -20 0
|-
|fov_vert
|120
|95
|100
| 120
|120
|100
|120
|100
|120
|-
|ko_angle_alert_horiz
|110
|110
|110
|110
|110
|110
|0
|110
|0
|-
|ko_angle_alert_vert
|180
|180
|180
|180
|180
|180
|0
|180
|0
|-
|ko_angle_horiz
|360
|360
|360
|110
|110
|110
|0
|110
|0
|-
|ko_angle_vert
|360
|360
|360
|180
|180
|180
|0
|180
|0
|-
|ko_alert_immune_state
|5
|5
|5
|4
|4
|4
|all
|4
|all
|-
|}
=== Builders ===
=== Guards ===
=== Mages ===
=== Moors ===
=== Pagans ===
=== Thieves ===
=== Townsfolk ===
== Non-human AIs ==
=== Monster ===
=== Steambots ===
=== Undead ===

Prefabs

2017-03-29T15:54:21Z

Destined:

{{Original_Reference|all|3008}}

(see also [[Prefab Comments]])

A prefab is basically a map file with a different extension ('''.pfb'''). It can be used to pack a collection of brushes/patches and entities into a file so that it can be re-used again. This can be useful for complex setups like doors or entities with a complex Stim/Response setup and might save a bit of work.

To create a prefab, just select your items in DarkRadiant and choose '''File''' > '''Save Selected as Prefab...'''. It's recommended to save them into the darkmod/prefabs folder which is the default in DarkRadiant.

To import a prefab, go to <code>File > Import Prefab</code>. (Note that you may need to extract provided Dark Mod prefabs first from the zip file darkmod/tdm_prefabs01.pk4 before they are visible to earlier versions of Dark Radiant.)

If you want to save a collection of entities as a group, you just select them all, go to file-save selected as... save them as a .map, ideally called something appropriate like prefab_myobject.map

This means I can set up something like a streetlight mesh, two particle effects for the electric, a sound speaker, and the light entity for it, and then save it as one prefab object, so mappers can just drop it into their map.

To open the prefab you use file--load rather than file--open.

Notice there's also a 'save selection as prefab' and 'load prefab' buttons in the edit menu.

When creating prefabs with multiple components of the same name, eg, a cupboard with two doors, don't name them eg, door1 & door2 as although the prefab may insert and work correctly you may find the renumbering confusing, especially if they have handles bound to them and targets. door2 handle may work correctly and be bound to the correct door but it might be named handle1. Instead, name them eg, doorA & doorB so if they then get renumbering on insertion doorA2 & doorB2 with handleA2 & handleB2 then there is no confusion as to what goes where.

See also [[Prefab Comments]]

== Grouped Prefabs ==
With Dark Radiant 2.2.1 it is possible to group multiple entities, so they can be handled as one. As many prefabs are intended to work as one entity, the grouping feature is applied to prefabs upon import from this version on. It is possible to insert prefabs ungrouped by unticking the box labled "Create Group out of Prefab parts" in the bottom left corner of the prefab import screen. It is also possible to ungroup the prefab later on by right-clicking on the group and selecting "Ungroup Selection" or via "Edit -> Ungroup Selection".

== Rotating Prefabs ==
Hit {{key-ctrl}}+{{key|name=R}} to change rotation modes. They'll collectively use a single axis.

{{editing}}

A - Z Beginner Full Guide Page 2

2017-03-07T17:04:56Z

Destined:

{{A-Z Beginner Guide TOC}}

== Backups ==

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

== Adding Objects, AI ==

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

===Static Models===

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

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

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

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

* Press Esc to DEselect everything
* RMB menu > Create Entity > darkmod > AI > Commoners Unarmed > atdm:ai_townsfolk_commoner
* Put it where you like in the room and remember {{key|CTRL}} + {{key|TAB}} to get a side view to place it on the ground.
* Turn him around to face whichever way you like.
* Likewise, under darkmod > moveables > Containers add an atdm_moveable_crate01.
** Under darkmod > moveables > Kitchen > Utensils add an atdm:moveable_small_spoon_ornamental
** Under darkmod > moveables > Furniture add an atdm:moveable_chair_dining_2_red.

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

* Select the AI by pointing at it and {{key|SHIFT}}+{{key|ALT}}+{{LMB}}. This is an exclusive select and automatically deselects everything else.
* In the Entity Inspector on the panel check the 'Show inherited properties' at the top.
* Scroll down to see the word 'team' and select it to highlight it.
* In the box at the bottom change the team from 3 to 0 which is the player's 'team' and click the check button at its right. This will not change the greyed value itself, but instead create a new line named "team" with the new value. You can easily see it, if you untick the 'Show inherited properties' panel.
* Alternatively you can add/change properties by just typing the name and value in directly - just clear the box and type in team and the value below and click the check button. Yet another way is to right click the classname at the top and select Add property.

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

{{key|CTRL}}+{{key|S}} to save and feel free to play it in game to see how it's looking. No need to dmap after adding objects - just use the map command as described before. (pathfinding might fail sometimes if you don't dmap so don't worry if the AI characters turn in circles or don't move while testing. This may also be the source of the problem if you get the message "Warning AAS32 is out of date!" at the top of the screen after starting the map.)

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

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

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

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

== New Rooms: Extending the Mission ==

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

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

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

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

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

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

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

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

== Doorways ==

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

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

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

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

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

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

== Making the Door Open ==

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

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

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

=== Doorframe ===

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

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

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

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

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

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

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

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

==Texture adjustment==

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

===Texture Lock===

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

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

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

=== Texture Alignment with Surface Inspector ===

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

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

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

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

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

Likewise do the side brushes of the doorframe.

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

== Corridors, Recesses ==

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

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

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

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

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

Ctrl+S to resave the mission.

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

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

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

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

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

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

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

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

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

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

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

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

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

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

{{key|CTRL}}+{{key|S}} to save and then Save As with a new name.

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

Map to play through and check it looks OK.

== Ambient Light: Gloom not Doom ==

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

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

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

===ambient_world helps performance===

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

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

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

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

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

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

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

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

{{A-Z Beginner Guide TOC}}

AI stats

2017-03-06T07:45:34Z

Destined:

<pre style="color: red">THIS PAGE IS A WORK IN PROGRESS</pre>
== Spawnargs and Game Mechanics ==
In order to understand the influence of the spawnargs on game mechanics, I want to give a simple insight into the mechanics. For this I have decided to categorise them into four subgroups: AI perception, Combat, and Interaction between AIs and player out of combat.
=== AI perception ===
In the centre of each stealth game lies the perception of the AIs. This includes the ability of AIs to see, hear, and touch its environment. The chance to percieve anything with the respective sense is multiplied with the respective acuity_* spawnarg at some point. If the AI is drunk all these factors are multiplied with the drunk_acuity_factor (default 0.5), which reduces the chance of the AI to notice the player.
==== Visual perception ====
In general, when an object with an AIUse spawnarg comes into the field of vision of an AI, the AI gets a visual STIM. The chancenotice* spawnargs influence if the AI reacts to the STIM and the argument of the AIuse spawnarg (not listed in the table) determines how the AI reacts. For example if the AI gets a visual STIM of another friendly AI it will greet, while it will attack a hostile AI on sight. The chance to spot the player follows a more complex algorithm and is influenced by the brightness of the light gem, the distance to the AI and the visual acuity of the AI (acuity_vis). You can check the [[Visual scan]] article for further information.
==== Aural perception ====
Noises made by the player as well as thrown objects or noise arrows produce a propagated sound of a specified volume. The propagated sound's volume decreases linearly with increasing distance from the source. When it reaches an AI the alert_aud_thresh value is subtracted and the remaining volume (if it is greater than 0) is added to the alert level of an AI.
==== Tactile perception ====
Tactile perception gets triggered, when the AI collision model touches the player's collision model.
==== Perception and Alarms ====
When an AI perceives anything suspicious, it adds to the AI's alert level. When this counter exceeds a certain amount (alert_thresh#), the AI will reach the next alert stage. In order to prevent the alert level to ramp up too quickly there is a grace period (alert_gracetime#) during which a new suspicious stim will not further alert the AI. This period can be termintaed if the new stim during the grace period is too strong (exceeds the former addition to the alert level multiplied with the "alert_gracefrac#" value) or if there are too many stims in quick succession (exceeding the alert_gracvecount#). Above the "idle" state (0) there are five alert stages:
*1: Observant (bark, but otherwise no reaction)
*2: Suspicious (bark, look, may stop and turn)
*3: Searching (Investigation)
*4: Agitated Searching (Investigation, Weapon out, AI is quite sure that there is someone around)
*5: Combat.
The AI will stay in this alert state for a time determined by "alert_time#". Please note, that as soon as an AI has drawn its weapon it will not recede to the regular idle state, but instead to the "alert idle" state, which results in a hightened senses and possibly different behaviour of the AI (e.g. a former stationary AI starts patroling).
{| class="wikitable"
|+Spawnargs related to AI perception
|-
|acuity_aud
|AI aural acuity (in percent)
|-
|acuity_env
|AI environmental acuity. How sensitive the AI is to things that have changed in its environment.
|-
|acuity_other
|AI generic acuity for scripted events. You can call this alert type on an entity with entity.Alert( <char *type>, <float amount>). This will alert the entity by amount * acuity_other in your script.
|-
|acuity_tact
|AI tactile acuity (in percent)
|-
|acuity_vis
|AI visual acuity (in percent)
|-
|alert_aud_thresh
|Threshold of audibility for the AI. This is in dB of sound pressure level (SPL). The real life value for humans is around 20 (a barely heard whisper). Changing this by even 0.1 has a large effect on sound propagation behavior, because propagated sounds below this volume are not heard at all. NOTE if this is not set, it gets the value from soundprop global settings.
|-
|alert_gracecount#
|If the number of additional alerts for an AI in alert state # during the grace period exceeds the grace count, the grace period will be terminated.
|-
|alert_gracefrac#
|An alert that is higher than the last increase times the grace fraction will terminate the grace period for an AI in alert state #.
|-
|alert_gracetime#
|After being alerted, the AI in alert state # will ignore additional alerts during the grace period (in seconds), to avoid adding up the alert level too quickly.
|-
|alert_thresh#
|The alert level threshold for reaching alert state #.
|-
|alert_time#
|The time it takes for the alert level to ramp down from the upper to the lower threshold in alert state # (in seconds).
|-
|chancenoticeblood
|Chance to notice the visual stim of blood
|-
|chancenoticebrokenitem
|Chance to notice the visual stim of a broken item
|-
|chancenoticedoor
|Chance to notice the visual stim of an open door that should be closed
|-
|chancenoticelight
|Chance to notice the visual stim of a light that should be on
|-
|chancenoticemissingitem
|Chance to notice the visual stim of a missing item
|-
|chancenoticemonster
|Chance to notice the visual stim of a monster
|-
|chancenoticeperson
|Chance to notice the visual stim of other persons
|-
|chancenoticepickedpocket
|Chance to notice that an object bound to the AI has been stolen
|-
|chancenoticerope
|Chance to notice the visual stim of a rope created by a rope arrow
|-
|chancenoticesuspiciousitem
|Chance to notice the visual stim of suspicious items
|-
|chancenoticeundead
|Chance to notice the visual stim on an undead
|-
|chancenoticeweapon
|Chance to notice the visual stim of suspicious weapons
|-
|drunk_acuity_factor
|If the AI is drunk, their acuities (visual, hearing, tactile) will be reduced by this factor.
|-
|fov
|Full field of view in degrees. Will be used for both horizontal and vertical fov unless vertical is explicitly specified.
|-
|fov_rotation
|A vector of 3 space-delimited angles applied to rotate the AI's field of view relative to their head joint. For most heads, the angles are: yaw pitch roll.
|-
|fov_vert
|Full vertical field of view in degrees. Leave blank or set to -1 to use the same value as the horizontal fov.
|-
|headturn_chance_idle
|The chance for random head turning while idle (0 0-1 0)
|-
|headturn_factor_alerted
|The headturning chance gets multiplied by this amount when the AI is alerted
|-
|}
=== Combat ===
When stealth fails, the player always has the option to fight AIs instead of fleeing. However, combat in TDM is meant as a last resort and will ruin any stealth scores and will most likely kill you, when you face more than on guard. Also, common settings prohibit killing civilians (AI with the spawnarg "is_civilian" set to 1) and even guards on higher difficulties. The difficulty of a melee fight is influenced by two factors (not counting the player's skills): The difficulty setting in the menu (which can be set by the player) and the difficulty setting of the AI (novice, trained, skilled, see Melee sets, can be set by the map author). For a more detailed description on what to keep in mind while fighting, see [[The Dark Mod Gameplay#Combat|Combat]]. A hit by the player will deal damage. The damage reduces the amount of health of the AI by the base damage, scaled by the "damage_scale" of the zone hit. When the dealt damage surpasses the pain_threshold, the pain animation of the AI will be played. As soon as the health of the AI reaches the health_critical value, the AI will flee. Each successful hit or parry by the player will render an AI "flatfooted", which means it will not move for an amount of time defined as flatfooted_time (it can still attack, though). This time can be used to flee from the AI instead of continuing fighting. If the player gets outside the melee reange of an AI (e.g. by climbing somewhere the AI cannot reach), the AI will start throwing stones at the player if "outofreach_projectile_enabled" is set to "1". It will wait a random amount of time between "outofreach_projectile_delay_min" and "outofreach_projectile_delay_max" before doing so. The "attack_cone" determines in which region the AI can throw (or shoot in case of bowmen). Additionally, each shot will be offset by a random amount of up to "attack_accuracy" degrees, so not each shot will hit the player.
{| class="wikitable"
|+Spawnargs realted to combat
|-
|Spawnarg
|Explanation
|-
|armor
|Type of armor the AI is wearing (may vary depending on hit zone). The damage multipliers are: leather 0.75, chain 0.5, plate 0.
|-
|attack_accuracy
|Maximum angular offset to randomly offset the monster's aim when firing missiles
|-
|attack_cone
|Monster can only throw projectile within this cone relative to his direction.
|-
|bleed
|If set to true, this entity will bleed, e.g. spawn blood particles and decals when hurt.
|-
|can_be_flatfooted
|If set to true, the AI becomes flat-footed in certain combat situations. This means they're unable to run at the player, but can still turn to face the player.
|-
|damage
|Damage definition if it damages things it collides with.
|-
|damage_zones
|There are different hit zones for AI that vary the damage recieved from the player.
|-
|damage_scale "zone"
|Factor by which damage in the given zone is multiplied.
|-
|def_melee_set
|The defined melee set that describes the fighting skills. The levels are "novice", "trained", and "skilled" and are further modiefied by the difficulty of the game.
|-
|flatfooted_time
|The duration in milliseconds that this AI remains flat footed after a combat action triggers this state.
|-
|health
|Amount of damage to receive before dying.
|-
|health_critical
|When the health drops below this value, the AI will flee. Set this to 0 for AI that don't wet their pants.
|-
|is_civilian
|If true, the AI is a civilian. Defaults to 0.
|-
|move_speed
|The movement speed of AIs is dependent on their animations and animation rate. The animation rate can be changed with the anim_rate_X (X = animation name).
|-
|outofreach_projectile_delay_max
|Maximum period to wait between throwing player-out-of-reach projectiles in seconds
|-
|outofreach_projectile_delay_min
|Minimum period to wait between throwing player-out-of-reach projectiles in seconds
|-
|outofreach_projectile_enabled
|Ability to throw player-out-of-reach projectiles at the player.
|-
|pain_threshold
|How much damage monster has to receive in one blow for it to play a pain animation.
|-
|unarmed_melee
|Set this to 1 when this type of AI doesn't need melee weapons to fight. This is usually true for spiders, undead and such. Humans are wimps and need weapons.
|-
|unarmed_ranged
|Set this to 1 when this type of AI doesn't need weapons for ranged combat. This is usually true for belchers.
|}
=== Interaction between AI and player ===
Apart from combat there are other ways the AIs and the player can interact with each other and the environment. The player can blind or knock out an AI, the AI can get alerted (through seeing the player as well as other clues that someone is sneaking about) and both can switch lights on or off, etc.
{| class="wikitable"
|+Spawnargs related to AI interactions with the player and vice versa
|-
|blind_time
|The time span in seconds the AI is staying in 'blinded' state when hit by a flashbomb or -mine.
|-
|can_drown
|If true, the AI will drown if it gets under water, either by walking in or by being dropped in unconsciously. Set to '0' to make them breathe under water.
|-
|canlighttorches
|AI ability to switch on torches
|-
|canoperatedoors
|AI ability to handle doors
|-
|canoperateelevators
|AI ability to handle elevators
|-
|canoperateswitchlights
|AI ability to operate light switches
|-
|cansearch
|Whether the AI can conduct a search or not
|-
|cansearchcooperatively
|ability to participate in a coordinated search
|-
|gas_immune
|0 = not immune, 1 = immune to gas
|-
|is_mantleable
|If set to 1, this entity is not mantleable by the player. Defaults to 0.
|-
|ko_alert_immune
|If true, the AI is immune to knockouts when alerted at or above the alert state defined in 'ko_alert_state'.
|-
|ko_alert_immune_state
|Alert state number at which immunity behavior changes.
|-
|ko_alert_state
|Alert state number at which knockout behavior changes.
|-
|ko_angle_alert_horiz
|Horizontal knockout cone angle when the AI is alerted at or above 'ko_alert_state'.
|-
|ko_angle_alert_vert
|Vertical knockout cone angle when the AI is alerted at or above 'ko_alert_state'.
|-
|ko_angle_horiz
|Defines a horizontal cone angle extending backwards from the direction AI is looking. Anywhere within this cone and the vertical cone is a valid KO.
|-
|ko_angle_vert
|Defines a vertical cone angle extending backwards from the direction AI is looking. Anywhere within this cone and the horizontal cone is a valid KO.
|-
|ko_immune
|0 = not immune, 1 = immune to blackjack
|-
|ko_rotation
|A vector of 3 space-delimited angles applied to rotate the AI's blackjack acceptance cone relative to their head joint. For most heads, the angles are: yaw pitch roll.
|-
|ko_spot_offset
|Defines the center of the head for knockout testing purposes. Vector offset from the head attachment joint to the desired head center point. The possible knockout cone extends back from this point.
|-
|ko_zone
|Name of the damage zone that must be hit for a possible knockout. Set this blank (i.e. : 'ko_zone' '') to make the AI immune to KOs from the blackjack.
|-
|pickpocket_alert
|Incremental alert value to be added to an AI's current alert level
|-
|pickpocket_delay_max
|Maximum delay before reacting to a picked pocket in milliseconds
|-
|picpocket_delay_min
|Minimum delay before reacting to a picked pocket in milliseconds
|-
|push_player
|Set this to 1 to let this entity push the player (default is 0).
|-
|sneak_attack_alert_state
|Alert state number at which the AI can no longer be sneak attacked.
|-
|sneak_attack_mult
|Damage multiplier applied to ALL damage when AI is damaged at an alert level below that defined in 'sneak_attack_alert_state'.
|-
|team
|Monsters do not actively attack players or monsters with the same team number. For common team numbers see [[AI Relations (Editing)]].
|-
|}
== Human AIs ==
Human AIs are somewhat special as the spawnargs are defined by the entity definition as well as the definition of the head. This leads to a great number of combinations and is the reason that heads are discussed here as well as the various human classes. In order to make this article as clear as possible, in the first table the base values for human AIs are stated. In the class specific tables only changes to these base values are listed.
=== Base Values ===
This table lists all base values for human AIs in alphabetical order.
{| class="wikitable"
|+Humanoid AIs
|Spawnarg
|Base Value
|-
|acuity_aud
|100
|-
|acuity_env
|100
|-
|acuity_other
|100
|-
|acuity_tact
|100
|-
|acuity_vis
|100
|-
|alert_aud_thresh
|18.8
|-
|alert_gracecount1
|5
|-
|alert_gracecount2
|5
|-
|alert_gracecount3
|4
|-
|alert_gracecount4
|4
|-
|alert_gracefrac1
|1.2
|-
|alert_gracefrac2
|1.2
|-
|alert_gracefrac3
|1.2
|-
|alert_gracefrac4
|1.0
|-
|alert_gracetime1
|2
|-
|alert_gracetime2
|2
|-
|alert_gracetime3
|3
|-
|alert_gracetime4
|2
|-
|alert_thresh1
|1.5
|-
|alert_thresh2
|6
|-
|alert_thresh3
|10
|-
|alert_thresh4
|18
|-
|alert_thresh5
|23
|-
|alert_time1
|5 +/- 1.5
|-
|alert_time2
|8 +/- 2
|-
|alert_time3
|25 +/- 8
|-
|alert_time4
|65 +/- 20
|-
|alert_time5
|
|-
|armor
|variable
|-
|attack_accuracy
|2.3
|-
|attack_cone
|70
|-
|bleed
|1
|-
|blind_time
|8 +/- 4
|-
|can_be_flatfooted
|1
|-
|can_drown
|1
|-
|canlighttorches
|1
|-
|canoperatedoors
|1
|-
|canoperateelevators
|1
|-
|canoperateswitchlights
|1
|-
|cansearch
|1
|-
|cansearchcooperatively
|1
|-
|chancenoticeblood
|1.0
|-
|chancenoticebrokenitem
|1.0
|-
|chancenoticedoor
|1.0
|-
|chancenoticelight
|0.9
|-
|chancenoticemissingitem
|1.0
|-
|chancenoticemonster
|1.0
|-
|chancenoticeperson
|1.0
|-
|chancenoticepickedpocket
|0.5
|-
|chancenoticerope
|1.0
|-
|chancenoticesuspiciousitem
|1.0
|-
|chancenoticeundead
|1.0
|-
|chancenoticeweapon
|1.0
|-
|damage
|34
|-
|damage_zone
|head, chest, torso_low, left_arm, right_arm, legs
|-
|damage_scale head
|2
|-
|damage_scale chest
|1.5
|-
|damage_scale torso_low
|1.0
|-
|damage_scale left_arm
|0.3
|-
|damage_scale right_arm
|0.3
|-
|damage_scale legs
|0.4
|-
|def_melee_set
|variable
|-
|drunk_acuity_factor
|0.5
|-
|fov
|150
|-
|fov_rotation
|0 -20 0
|-
|fov_vert
|120
|-
|gas_immune
|0
|-
|headturn_chance_idle
|0.3
|-
|headturn_factor_alerted
|2
|-
|health
| variable
|-
|health_critical
|15
|-
|is_civilian
|0
|-
|is_mantleable
|0
|-
|ko_alert_immune
|0
|-
|ko_alert_immune_state
|5
|-
|ko_alert_state
|4 (as soon as weapon is drawn)
|-
|ko_angle_alert_horiz
|110
|-
|ko_angle_alert_vert
|180
|-
|ko_angle_horiz
|360
|-
|ko_angle_vert
|360
|-
|ko_immune
|0
|-
|ko_rotation
|0 0 0
|-
|ko_spot_offset
|2 -2.5 0
|-
|ko_zone
|head
|-
|melee_damage
|variable
|-
|melee_damage_mod
|0.6 - 1.4
|-
|melee_predicts_proximity
|1
|-
|melee_predicted_attack_time
|750
|-
|melee_range
|0
|-
|melee_rep_attack_time
|10000
|-
|outofreach_projectile_delay_max
|7.0
|-
|outofreach_projectile_delay_min
|10.0
|-
|outofreach_projectile_enabled
|1
|-
|pain_threshold
|1
|-
|pickpocket_alert
|0
|-
|pickpocket_delay_max
|25000
|-
|picpocket_delay_min
|5000
|-
|push_player
|
|-
|sneak_attack_alert_state
|2
|-
|sneak_attack_mult
|2.0
|-
|stamina
|player only
|-
|team
| variable
|-
|unarmed_melee
|0
|-
|unarmed_ranged
|0
|-
|}
=== Heads ===
Different heads can change the cones of the field of vision and the ko volume, so it it is advisable to check if any AI you encounter wears a hat or helmet and/or an eye patch. Please note that even though many AIs wear helmets, this only reduces the cone in which you can knock out the guard. Only the ones with neck protecting elite helmets (see [[Heads Available for AI#Elite Guard Heads|Heads Available for AI]]) are in general immune to being knocked out (i.e. the cone you have to hit with the blackjack is reduced to 0).
{| class="wikitable"
|+Heads
|Spawnarg
|Heads with an eye patch
|Heads with hoods
|Head with a straw hat
|Heads with non-brimmed helmet
|Heads with non-brimmed saxon helmet
|Heads with brimmed City Watch helmet
|Heads with elite helmet
|Heads with brimmed City Watch helmet and an eye-patch
|Heads with elite helmet and an eye-patch
|-
|Heads
|[[Heads Available for AI#Builder Guard Heads|Builder Guard Head 6]],[[Heads Available for AI#Generic Guard Heads|Commoner Default Heads 2, 12]], [[Heads Available for AI#Commoner Default Heads|Commoner Default Head 12]]
|[[Heads Available for AI#Commoner Default Heads|Commoner Default Heads 1,10]]
|[[Heads Available for AI#Commoner Default Heads|Commoner Default Head 3]]
|[[Heads Available for AI#Generic Guard Heads|Commoner Default Heads 6, 7, 13, 16]]
|[[Heads Available for AI#Generic Guard Heads|Commoner Default Heads 14, 15]]
|[[Heads Available for AI#City Watch Heads|City Watch Heads 1 - 4, 6 - 8]]
|[[Heads Available for AI#Elite Guard Heads|Elite Guard Heads 1,2]]
|[[Heads Available for AI#City Watch Heads|City Watch Heads 5, 10]]
|[[Heads Available for AI#Elite Guard Heads|Elite Guard Heads 3]]
|-
|fov
|110
|80
|150
|150
|110
|150
|150
|110
|110
|-
|fov_rotaion
| -30 -20 0
|0 -35 0
|0 -35 0
|0 -30 0
|0 -30 0
|0 -30 0
|0 -30 0
| 0 -30 0
|-30 -20 0
|-
|fov_vert
|120
|95
|100
| 120
|120
|100
|120
|100
|120
|-
|ko_angle_alert_horiz
|110
|110
|110
|110
|110
|110
|0
|110
|0
|-
|ko_angle_alert_vert
|180
|180
|180
|180
|180
|180
|0
|180
|0
|-
|ko_angle_horiz
|360
|360
|360
|110
|110
|110
|0
|110
|0
|-
|ko_angle_vert
|360
|360
|360
|180
|180
|180
|0
|180
|0
|-
|ko_alert_immune_state
|5
|5
|5
|4
|4
|4
|all
|4
|all
|-
|}
=== Builders ===
=== Guards ===
=== Mages ===
=== Moors ===
=== Pagans ===
=== Thieves ===
=== Townsfolk ===
== Non-human AIs ==
=== Monster ===
=== Steambots ===
=== Undead ===

A - Z Beginner Full Guide Start Here!

2017-03-02T19:28:35Z

Destined:

{{A-Z Beginner Guide TOC}}
'''''PLEASE NOTE: THIS GUIDE CONTAINS SPOILERS FOR THE "THIEF'S DEN" DEMO MISSION RELEASED JAN 18TH, 2008.'''''

== Introduction ==

Since writing this I've created a [[Startpack Mappers' Guide]] which is a ready made FM template with a set of ready made components to make it even easier to make a Dark Mod FM because it already includes things like objectives, briefing, readables, etc. etc and you just modify them and concentrate on building. However, I recommend you first follow this guide so you have some understanding of the basics and then the startpack will make more sense.

This is an easy guide for complete beginners to Dark Mod. It will lead you from start to finish, 'push that button, click that menu' and at the end you will have a fully working (but tiny) Dark Mod mission with all the main essential features including objectives all zipped up. You will be able to include variations of your own as you progress if you wish. Links to more detailed info is included but ignore those first time if you wish. Creating this mission is a learning process: although others will be able to play it, it will be too simple for that purpose - though it might be fun to see how varied the results might be from different players following the same instructions! When finished you can modify it and customise it to learn more or just shelve it for reference while you start your ''real'' mission!

This tutorial does not describe how to make your mission architecturally beautiful - just the opposite; the build may be as crude, quick, and ugly as you like. Nor does it advise how to design for good gameplay, etc. For that you should go to [[Mission Design Tips]] after you have mastered the basics. This is a ''method'' tutorial, not a ''design'' tutorial. Nor can it answer every question. It will merely present the most basic information for making a complete mission.

Feel free to experiment, add to, or even skip parts you already know or seem obvious, especially if you have a background producing Doom or Quake maps.

This guide was inspired by Komag's famous tutorial which helped a great many Dromeders (including myself) to get started producing Thief 2 FMs. If you are or were a Dromeder then you might first like to browse quickly through [[Dromed - Dark Mod Differences]] before proceeding - though it is not essential for this tutorial as I am trying to make few assumptions of prior knowledge. It will refer to default keys/mouse settings in Dard Radiant (editor - see later) so if you have changed any hot keys in Dark Radiant's help menu then keep that in mind. Also note that any screenshots might be in a different colour to your settings of course.

== Installation ==

This tutorial assumes that you have Dark Mod already installed. If not, please refer to [http://www.thedarkmod.com The Dark Mod] website for information.

Alternatively you can use the limited Dark Mod resources provided by the pre-release demo mission [[Thief's Den]]

== The Dark Mod Editor ==

To edit Dark Mod missions you will need a game editor. '''This tutorial is based on the [[Dark Radiant]] editor''' (hereinafter may be called DR) but you can possibly follow most of it in other editors like DoomEd. Variations might be shown where possible but it will mainly assume Dark Radiant. If you haven't got Dark Radiant yet, consult the [[Dark Radiant]] sections, install it and set it up how you like it. If you want to use DoomEd then you need to look elsewhere first. DoomEd of course is supplied with Doom.

You might wish to open the [[Dark Radiant Controls, Keys & Mouse|DR Controls]] page in a new window in your web browser for quick reference while following this tutorial. I'll try to make it so you don't need to!

Make sure you can run Dark Mod and your editor before proceeding. In particular remember you can undo your last step(s) (edit menu or {{key|CTRL}}+{{key|Z}})

== Folder Structure ==

[Added by Destined]
This section was added later and overlaps with the contents of the section "Dmap: Compiling the Mission"
* All main resources and executables are stored in the TDM root folder (this is where you have installed The Dark Mod, e.g. C:/Darkmod). The recources are stored in pk4-files. These are simply renamed zip-files and can be opened with any common unpacking program like Winzip, Winrar or 7zip.
* The "maps" folder is where Dark Radiant saves maps by default.
* All fan missions are stored in the "fms" folder as pk4-files. Upon installing a mission in-game, a sub-folder is created and the pk4-file as well as the readme.txt, the description file, and any savegames belonging to this mission are saved there.
* If you open a mission pk4-file (e.g. the Training Mission or Tears of St. Lucia), you can see the folder structure used for fan missions. It contains folders like "maps", "textures", or "materials", that you need for custom assets in your mission.
* Create a folder for your new map in "fms" and name it accordingly (e.g. Tut), then create a sub-folder "maps" and open Dark Radiant.
* With File->Select Game... you can open a window to configure basic settings (this might open automatically when you start Dark Radiant for the first time).
* For "Select a Game" choose "The Dark Mod 2.0 (Standalone).
* For "Engine Path" browse to the root folder of your installation (e.g. C:/Darkmod).
* "Mod(fs_game)" is the path to your current FM (e.g. fms/Tut). This path is relative to the given "Engine Path".
* Now the editor will use resources you point to in this folder. Otherwise a pk4-package in the root folder would be needed.
* In order to have these new settings take effect, restart Dark Radiant.
* Save the blank file under fms/yourmapfolder/maps (e.g. fms/Tut/maps). It is recommended to choose a short name for your mission as you will type it a lot in the game console.

== Your First Mission ==

Let's get started.

* Open Dark Radiant (hereinafter DR) and also open Dark Mod for quick testing.
* If you have a mission already open in DR then select File menu > New Map to clear it.
* Save it now as any suitable name. You might prefer to save later but I always do it immediately. All missions must go (with exceptions I will describe later in [[A - Z Beginner Full Guide Page 5#Managing your Mission Files|Managing your Mission Files]]) in the darkmod\maps folder or a folder within that. I urge you to create a new folder for each project within that maps folder. In this case:
# Open File Menu > Save As
# Make sure you are in the 'maps' folder.
# Select 'Create Folder' and type in say 'tutorial'. You might prefer 'Tut' or even 'T' because you have to keep typing it over and over in the Dark Mod console when testing!
# Select that folder
# Enter the name of your mission at the top.
* The game will be saved as a 'map' file with a .map suffix and is commonly called a 'map' in Doom circles. But I will use the term 'mission' or 'FM' (Fan Mission) or maybe 'game' for the map file to try to avoid confusion with actual 'city' or 'treasure' maps within the mission.

First, let's consider our rough storyline so we have some idea what to build...

== Story, Briefing ==

Formal mission objectives will be described much later in this tutorial. But before you begin your mission you will obviously need to have at least some idea of storyline and plot else you will have no idea what to build. You might have a detailed story or just some simple ideas which you can develop later.

Ultimately, you will need to brief the player with information about the story, characters, and the main purpose of the mission. It probably makes sense to write that fully when you are nearly finished the mission because new ideas or even technical difficulties might make you change your story. However, in this tutorial I'll describe it early so as you build the mission the layout and objects make sense.

Your briefing text should eventually be entered as described at [[Briefing]] but temporarily you might just write it in a plain text document for reference.

This mini tutorial mission is called 'Thief's Den' so here is an example briefing ('''not''' in correct format for the gui or .xd file):

"I had a nice haul the other night including a grand scepter from Lord Frothley. But a low-life named Creep who had given me the info, then stole it from ME! Never trust a thief I say. But I know where he lives...

I also still have his message in his own hand, giving the low-down. If I can dispose of Creep and drop the message nearby then he should take the heat for the heist diverting all suspicion from me.

Creep is a nasty piece of work who is handy with a blade. He can be dangerous and may be expecting me - may even have recruited a thug or two as back up - but he has badly underestimated my stealth skills..."

== Preparing to Build ==

When you open Dark Radiant it will default to a grid size (in the XYZ orthoview) of 8 units by 8 (changeable from version 0.9.5 onwards.) These [[Conversion of Game Units|units]] are 1.1 inches. Check your preference (default key P) in DR as it will be easier during this tutorial if you have the following checked (ticked) in Preferences > Orthoview...

* Show Grid
* Show Size Info
* Show Coordinates

'''Important:''' It is recommend you generally build with the grid set reasonably to a large size such as the default 8 or 16 for all walls, floors, etc. This makes alignment easier. You can reduce this in the grid menu for fine placement but don't leave it like that generally or you will have complexity problems. Snap to grid ([[Image:DRsnapGrid.jpg]], {{key|CTRL}}+{{key|G}}) will re-align a selection to the current grid size.

We'll mostly be working in the XYZ grid orthoview but if you have room for the camera view at the side so much the better. The camera view does a rough render in 3D (F3 toggles a better rendering with lighting etc but keep that off if it slows things down which it is likely to and just use it now and again.)

* Note the origin icon of the 'world' at 0,0,0 in the grid view
* Zoom in and out with the mouse wheel
* Right mouse drag the grid view to scroll around (zoom out further to scroll around faster)
* Use ''Change views'' tool ([[Image:DRnextViewBut.jpg]], {{key|CTRL}}+{{key|Tab}}) to toggle between top (XY), front (XZ), and side (YZ) views (you can open aditional windows using menu <tt>View > New XY view</tt>).

The blank windows in the grid and camera views can be regarded as empty void - the space in which we shall build. We have to build in bubbles sealed off from that void like an airtight spaceship or a submarine. Any gaps will cause leaks and crash your game so it's obviously the first major rule to learn: always build inner spaces sealed off from the outer void

Apart from special materials like water and weather, all the raw material you will use is 'solid' to form different shapes. So we can make panels and place them together to form lots of floating airtight boxes and these can be linked together. The entire game then takes place inside those boxes. One box can hold a tiny cupboard or an entire cathedral and a lot of boxes can hold a city. Inside those boxes you cannot see the void.

A shortcut to putting panels together is to make one solid block and hollow it out to form a box and this is what we are going to do now to form our first room.

== Making Your First Room ==

First we make a rough solid block...

* Select the top view (XY) in the grid view (toggle with [[Image:DRnextViewBut.jpg]]).
* Left mouse drag out a rectangle any few grid units across in the middle somewhere.
* This rectangle is called a 'brush' and used to define raw shapes for walls, floors etc.
* Left drag ''within'' that brush to drag the brush around
* Select the ''Resize'' tool ([[Image:DRdragResize.jpg]], {{key|Q}}).
* Now left drag ''outside'' that brush to resize it.

Now we adjust its top view area...

* Left drag outside that brush to resize it to 256 across left to right (X direction) by 192 up and down (Y direction in top view.) You should see those dimensions at the sides of the rectangle if you have 'Show Size Info' set in Edit > Preferences > Orthoview. The position of the top left corner is in brackets at top left.
* Left drag within the brush to move it so its sides fit on the bigger grid. If all sides don't fit then check your dimensions and that you are still in grid size 8 (see grid menu.)
* I prefer to build up in the top right corner from the world 0,0,0 so none of the values are negatives but you decide for yourself. Move it where you want but ideally so the sides are on the big grid.

Now we adjust its height to get our finished block (brush)...

* Use [[Image:DRnextViewBut.jpg]] ({{key|CTRL}}+{{key|Tab}}) to switch to side (YZ) or front (XZ) view and left drag outside the brush to change its height to 128
* Left drag inside the brush to move it up and down so its sides are on a big grid same as you did in the top view.
* You should now have brush 256 x 192 x 128 (see [[Conversion of Game Units#Tips|Unit Tips]])

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

== Selecting and DEselecting ==

We only have one item in our view but eventually many. Operations only work on what is currently selected. When you have just created something as we just have it is automatically the current selection and should be highlighted in your views (see DR Preferences for colour.)

* To DEselect it, point your mouse at it in either the grid or camera view and use {{key|SHIFT}}+{{key|ALT}}+{{LMB}} (or just press the {{key|Esc}} key.)
*To select it again, point your mouse at it and use {{key|SHIFT}}+{{key|ALT}}+{{LMB}} again.

Selecting is something you'll do a lot of so get familiar with that {{key|SHIFT}}+{{key|ALT}}+{{LMB}}. It's an exclusive select to get just one item. There are other selects I'll describe later. The {{key|Esc}} key always deselects and it is vitally important to get into the habit of DEselecting before you select or create something new or in some cases you will have multiple selections without knowing it and can delete or change something you didn't want to. This is why the {{key|SHIFT}}+{{key|ALT}}+{{LMB}} is the safest select as it is exclusive and will automatically DEselect anything else that was left selected. But it won't protect an item when creating. Yes, it is possible to have say a brush selected, forget it is selected, then create say, a new light. Oh! what happened to the brush? It's gone - replaced by the light. Develop a nervous habit of keep hitting {{key|Esc}} to deselect when you go to create!

From now on I'll use LMB, MMB, and RMB to refer to the mouse buttons.

== Camera View ==

You should be able to see this block in the camera view. If the camera view is just black remember {{key|F3}} toggles true light rendering and we don't yet have a light so hit {{key|F3}} to get a constant bright test light throughout. I won't go into details of all the camera controls suffice to say use the arrow keys and {{key|D}} and {{key|C}} to move vertically. But scroll down to 'camera' in [[Dark Radiant Controls, Keys & Mouse]] and you will see a fantastic amount of control you have in DR's camera view - especially with the mouse. It will take time to get used to them all so for now perhaps just learn enough to move around to see what you've done so far.

If you can see your block(brush) in the camera view then it is likely not to have any particular texture unless you were doing something before this tutorial. Close up you may see it is covered in a checkered blue 'shader not found' message. Don't worry if it's covered in something else like stone or wood though. Since it will eventually be hollowed out to form a room, let's paint it now with some material more suitable to the Dark Mod universe...

== Materials, Textures, Painting the Block ==

This is the tiny home of a cheap thief so we'll use some old stonework.

I've mentioned 'textures', 'shaders', and 'materials'; what do these terms mean? A 'material' or 'shader' is the properties of a surface, including (but not necessarily) texture, sound, and others. To 'paint' our block we...

* Select the Media Browser. This is one of the tabs on a panel. Pressing N or T hides/shows the whole panel but I guess most people leave the panel showing all the time and just select the tab they want.
* Allow a few seconds for DR to read in the media first time and then you should see 'textures' listed
* Click 'textures' and it opens up to show all available textures. Many of the ones you see are Doom textures. Scroll down and select 'darkmod' which reveals the ones most suitable for our use. Scroll down to stone, open it, then cobblestones and select blocks_mixed_multicolour. Right click it and select 'Apply to selection'. This covers all surfaces of the block because we have still got selected the whole block not just one surface. You should see this in the camera view. Use this throughout the house (and eventually on its outside surface for consistency.)
* Select the Texture Browser. This is one of the tabs on the same panel as Media Browser. The Texture Browser only shows recently used textures. You should see only the one texture you selected so it's handy for future use. Odds are you will want to re-use the same textures. It will also show other textures if you clicked on them in the media browser plus any others if you were using DR before this tutorial. You can also copy and paste textures onto single or multiple surfaces (see later.)
* Hover the mouse over the four little buttons at the top of the Texture Browser and read the text so you have some idea of what features are there for the future. For now, click on the one that says 'Flush and Reload Shaders' and it should clear all of them except the one we put on our brush. As we add others they will appear in the texture browser so you can get to them more quickly.
* Now, press S for Surface Inspector (or View menu)
* If you have only one face selected (more about this later) you can set Horiz and Vert scale. Value like 0.3 makes it harder for the player to see any pattern repetition (in this situation and in my opinion - use your own judgement with other textures and wall sizes.) In the mean time you can use arrow buttons to adjust the scale for the whole selected brush. Whatever scale you use, generally you should be consistent with it for the same texture wherever used in a mission. If you use copy and paste then it will transfer the scale as well which is far easier.
* There will be more on texture adjustment later in this tutorial.

== Hollowing out a Room from the Block ==

Building to a large grid size helps performance. The outside of our block will never be seen in the game. Once we hollow it out then the player will only see the inside so that is the surface that is rendered and that we need to align to the large grid. There are two tools to hollow out a block, both activated by a button on the left button bar: one called 'hollow' and the other 'room'. Don't use 'hollow' as it reduces the internal sides so they don't fit the big grid AND it overlaps the corners which can cause rendering errors like so....

<center>BAD!</center> 
<center>[[Image:AZhollow.jpg]]</center> 

Instead use the 'room' button which does the job right (note the increased size so the ''internal'' dimensions will be the same as our original block and align to the big grid... 

<center>GOOD!</center> 
<center>[[Image:AZroom.jpg]]</center> 

All brushes in Doom must be convex. They cannot have any inward angles (like an L shape which would have to be two brushes together) and cannot actually be hollow. The above tools really create new side panel brushes to replace the original brush. In the case of our six-sided block that is six new brushes positioned as walls, floor, and ceiling. ''The walls they create are one small grid line wide so their width will vary depending on your grid size setting.''

Examine the block in the camera view and zoom right inside so you can see it internally which is where it will be seen in game. Note the texture aligns nicely because we stuck to a big grid size. The stone is appropriate for all four walls (which is why I textured the whole block in one go rather than one surface at a time) but now we need different textures for floor and ceiling...

== Selecting and Texturing Individual Surfaces ==

'''You cannot select a surface in the grid view''' so move inside the room in the camera view.

'''To texture the floor...'''

* Press Esc to make sure everything is DEselected
* Point at the floor and use {{key|SHIFT}}+{{LMB}}. Repeat a few times and you will see it selects/DEselects the surface. Keep it selected.
* Select the Media Browser again (on the tabbed panel)
* In the darkmod section select say stone/cobblestones or maybe you would like some wood/boards/worn_01 ? You choose but something like carpet might need special alignment so stick with stones or boards maybe for now? Remember - RIGHT click the texture name and select 'Apply to Selection'
* Alternatively you can click on several possibles then select them with one LMB in the Texture Browser on the other tab. In the Texture Browser you can enlarge the textures if preferred to see them better.
* Esc to DEselect so you can see it better in camera view.

'''To texture the ceiling...'''

* Press Esc to make sure everything is DEselected
* Point at the ceiling and use {{key|SHIFT}}+{{LMB}} again to select its surface.
* Select the Media Browser again (on the tabbed panel)
* In the darkmod section select say plaster/plaster01 and apply it.

'''If you change your mind about the walls you can change them to something else...'''

* Press Esc to make sure everything is DEselected
* Point at one wall and use {{key|SHIFT}}+{{LMB}} again to select its surface.
* Point at another wall use {{key|SHIFT}}+{{LMB}} again so now both surfaces are selected
* 'Accidentally' select the ceiling. No problem. Just use {{key|SHIFT}}+{{LMB}} on it again to DEselect it but the walls are still selected. In this way you can select which surfaces you want to select.
* Select the Media Browser again and just apply another type of stone, perhaps brick, to the walls if you want or just leave it as it is.

Now press {{key|CTRL}}+{{key|S}} to resave the mission or use the File menu. Get into the habit of doing this often unless you have autosave set. Now and again you can also save with a new name so you can go back to an earlier one if you totally mess up. Note: There is also a backup file made automatically by DR.

== Adding the Player's Start Point ==

One more thing is ''essential'' to play this in Dark Mod and that is the Player's starting position.

* Press Esc to DEselect everything.
* In the TOP grid view, point the mouse in the middle of the room and RMB to get a pop up menu. This menu is important so glance at some of the other items on it while you're here. 'Entities' are special function items and the player start is amongst them but there is a shortcut on the menu so instead...
* Select "Create Player Start here" on the menu. This will create the playerstart entity (red box) and put it where you clicked. Drag the entity around to the point where you want the player to start.
* You should see an arrow on the red box indicating the way the player will face at the start. If you cannot see the arrow then menu <tt>View > Show > Show Angles</tt> will reveal it. You can rotate the player by selecting ''Rotate'' tool ([[Image:DRrotate.jpg]], {{key|R}}) and dragging with the mouse.
* Use {{key|CTRL}}+{{key|Tab}} to switch to the side view (YZ) and use LMB to drag the ''inside'' of the player start box so its base is on the floor of the room (you can also use ''Translate'' tool, [[Image:DRtranslate.jpg]], {{key|W}}). Make sure you do not go below or the floor or the player might be stuck with his feet in concrete! Tip: In Thief games it was common to start just dropping over a wall with this player start a few feet above the ground. You might note that entities do not directly resize like brushes so LMB dragging on the ''outside'' of the box does nothing (unless you have selected the ''Translate'' tool).
* RMB in the grid view again and you will see there is now a ''Move player start here'' option so you can quickly move its position while testing different areas of your mission. But always remember to check both the side and top view when moving things around, to make sure the vertical position is also valid. (Also note that ''Move player start here'' does not ''select'' the player start - you will need to select it if you need to adjust its position by dragging.)
* With the player start still selected you can select the Entity Inspector (on the panel, or {{key|N}} to hide/show it) and see the properties of your first entity.

The game could now be played but it will be totally dark so we need to create at least one light.....

== Creating a Light ==

* Press Esc to DEselect everything.
* In the TOP grid view, point the mouse in the ''middle'' of the room and RMB to get the pop up menu.
* Select "Create Light" on the menu.
* A large red box appears with diagonals representing the light's centre and its rough 'radius'. The default light is more like six pyramids pointing out to their peaks in the centre of each side of the box. This gives a rough impression of a sphere of light and helps performance.
* {{key|CTRL}}+{{key|TAB}} to get a side view and LMB drag ''right in the centre of the light'' to move it up/down to centre it in the room if it is not already. Just dragging inside the radius box won't move it - you have to point at the centre.

== Resizing a Light ==

Resizing a light is awkward because dragging any side moves the centre (this might be changed in a later Dark Radiant.) Two ways of dealing with this. Just roughly drag it about and keep moving the light back to where you want it. But if you have very precisely positioned a light then you don't want to have to keep doing that so this is what I do...

* Select the Entity Inspector on the panel
* You should see it has a light radius property with three values for XYZ for the three dimensions. They are north and south for Y, east and west for X, and up and down for Z. (those are the compass directions in game by the way.)
* Click on the light radius property to highlight it.
* Note that its values appear in a choice of inputs at the bottom - You can type new values in a line with a space in between then click the check(tick) button or enter them as separate values or even use the little scrolly buttons at the side and then click the Apply button.
* The room interior is 192 x 256 x 128 (in XYZ order) so give the light radius the values 200 260 133 so it protrudes outside the walls (we're setting radius - so the light diameter will be twice that size). We may well change this again later if we want the light to spill out through a doorway or something.
* You can now toggle light rendering in the preview using {{Key|F3}} (or an icon in the preview toolbar) to see how the light affects the walls.

The light radius is not just a cut-off point. It can be regarded as a 'fade to zero point'. What this means is that the light is at maximum brightness at its centre and fades to zero at the limit of the radius. So in a big open area, if you extend the radius you will 'stretch the brightness' further. Imagine the scale from max to min compacted in a small radius or expanded in a large one. More on this later when we place wall torches.

== Changing a Light's Brightness ==

The light may be a little bright. To change it...

* Press L (or View menu)* to call up the Light Inspector
* Click on the white rectangle button just below where it says 'Colour'
* The brightness value is called 'Lum:' (luminosity) and should default to 100. Reduce it to 90, by overtyping it or using the slider to the far right. It might not matter. I'm just showing you where the control is for now.
* Fool around with the colours if you want - there are extensive features I won't cover here.

Hey! We should have your first working mission! Do a {{key|CTRL}}+{{key|S}} to save it and then follow the next sections in Dark Mod itself not in Dark Radiant.....

== Sound ==

There is no need to do anything special about ''hearing'' sounds such as footsteps, collision sounds, etc. at this stage as it will work automatically. Adding custom sounds will be dealt with later.

== Pathfinding ==

Pathfinding data to tell the AI characters where they can move is created by dmap by default when compiling in the next section...

== Dmap: Compiling the Mission ==
* Your mission file cannot be played itself; it is simply the directions to create a game file. To do this...
* Start up The Dark Mod. From any Dark Mod menu go to the console. By default, the console is {{key|CTRL}}+{{key|ALT}}+{{key|~}} (US Keyboards) or {{key|CTRL}}+{{key|ALT}}+{{key|'}} (UK Keyboards). This key is the top left below Esc and to the left of "1" on all keyboards I believe. But most people set up a shortcut to just use the ~ (` in UK) on its own so:

For single key click to get the console:
In your desktop shortcut to TheDarkMod.exe add this argument to its properties (right click shortcut): '''''+set com_allowConsole 1''''' so the target line would be something like:

'''''C:\Darkmod\TheDarkMod.exe +set com_allowConsole 1'''''

(plus any other arguments you might want)
* In the console type and Enter dmap Tut/T001 where you should substitute your subfolder name for Tut and your mission filename for T001. So, if you created your mission file directly in the maps folder then you do not need a folder name and can put dmap T001. If you made a subfolder in maps called MyMaps and named your mission MissionImpossible999.map then enter dmap MyMaps/MissionImpossible999. I recommend you do not use upper case in filenames in Doom as I think it can cause problems on other platforms.
* Wait while dmap compiles the mission. This should only be a few seconds with this tiny mission but will be much longer for big missions.
* If you get a 'leaked' error or some other serious red warning then recheck your work; look for gaps in the wall or a wrong texture like nodraw or have you got an entity outside in the void? See [[Performance: Essential Must-Knows#How to detect and fix leaks|HERE]] for more about fixing leaks but at this stage of this tutorial it might be easier just to redo. What I have laboured over is basically make a block, texture it, hollow it, stick in a player start and a light. As you get more proficient you can do it in less than a minute.
* Assuming there were no dmap red "ERROR"s then you should be returned to the Dark Mod menus and are now able to play the mission.
* Return to the console.
* Type and Enter map Tut/T001. Tip: Press the up arrow key toggles back through the history of what you have typed before so your dmap should re-appear. Just press the Home key and delete the 'd'. An alternative is to use 'testmap' instead of dmap which does both dmap and map but I prefer to see dmap's results.
* You should now be able to walk around in the room. If you have a player shadow set then you might notice that walking through that light looks odd so keep that in mind for light placement. But most lights you will place close to a visible source like a gaslight or wall torch.

That's the first part done!

{{A-Z Beginner Guide TOC}}

{{tutorial-editing}}

A - Z Beginner Full Guide Start Here!

2017-03-02T19:26:21Z

Destined:

{{A-Z Beginner Guide TOC}}
'''''PLEASE NOTE: THIS GUIDE CONTAINS SPOILERS FOR THE "THIEF'S DEN" DEMO MISSION RELEASED JAN 18TH, 2008.'''''

== Introduction ==

Since writing this I've created a [[Startpack Mappers' Guide]] which is a ready made FM template with a set of ready made components to make it even easier to make a Dark Mod FM because it already includes things like objectives, briefing, readables, etc. etc and you just modify them and concentrate on building. However, I recommend you first follow this guide so you have some understanding of the basics and then the startpack will make more sense.

This is an easy guide for complete beginners to Dark Mod. It will lead you from start to finish, 'push that button, click that menu' and at the end you will have a fully working (but tiny) Dark Mod mission with all the main essential features including objectives all zipped up. You will be able to include variations of your own as you progress if you wish. Links to more detailed info is included but ignore those first time if you wish. Creating this mission is a learning process: although others will be able to play it, it will be too simple for that purpose - though it might be fun to see how varied the results might be from different players following the same instructions! When finished you can modify it and customise it to learn more or just shelve it for reference while you start your ''real'' mission!

This tutorial does not describe how to make your mission architecturally beautiful - just the opposite; the build may be as crude, quick, and ugly as you like. Nor does it advise how to design for good gameplay, etc. For that you should go to [[Mission Design Tips]] after you have mastered the basics. This is a ''method'' tutorial, not a ''design'' tutorial. Nor can it answer every question. It will merely present the most basic information for making a complete mission.

Feel free to experiment, add to, or even skip parts you already know or seem obvious, especially if you have a background producing Doom or Quake maps.

This guide was inspired by Komag's famous tutorial which helped a great many Dromeders (including myself) to get started producing Thief 2 FMs. If you are or were a Dromeder then you might first like to browse quickly through [[Dromed - Dark Mod Differences]] before proceeding - though it is not essential for this tutorial as I am trying to make few assumptions of prior knowledge. It will refer to default keys/mouse settings in Dard Radiant (editor - see later) so if you have changed any hot keys in Dark Radiant's help menu then keep that in mind. Also note that any screenshots might be in a different colour to your settings of course.

== Installation ==

This tutorial assumes that you have Dark Mod already installed. If not, please refer to [http://www.thedarkmod.com The Dark Mod] website for information.

Alternatively you can use the limited Dark Mod resources provided by the pre-release demo mission [[Thief's Den]]

== The Dark Mod Editor ==

To edit Dark Mod missions you will need a game editor. '''This tutorial is based on the [[Dark Radiant]] editor''' (hereinafter may be called DR) but you can possibly follow most of it in other editors like DoomEd. Variations might be shown where possible but it will mainly assume Dark Radiant. If you haven't got Dark Radiant yet, consult the [[Dark Radiant]] sections, install it and set it up how you like it. If you want to use DoomEd then you need to look elsewhere first. DoomEd of course is supplied with Doom.

You might wish to open the [[Dark Radiant Controls, Keys & Mouse|DR Controls]] page in a new window in your web browser for quick reference while following this tutorial. I'll try to make it so you don't need to!

Make sure you can run Dark Mod and your editor before proceeding. In particular remember you can undo your last step(s) (edit menu or {{key|CTRL}}+{{key|Z}})

== Folder Structure ==

[Added by Destined]
This section was added later and overlaps with the contents of the section "Dmap: Compiling the Mission"
* All main resources and executables are stored in the TDM root folder (this is where you have installed The Dark Mod, e.g. C:/Darkmod). The recources are stored in pk4-files. These are simply renamed zip-files and can be opened with any common unpacking program like Winzip, Winrar or 7zip.
* The "maps" folder is where Dark Radiant saves maps by default.
* All fan missions are stored in the "fms" folder as pk4-files. Upon installing a mission in-game, a sub-folder is created and the pk4-file as well as the readme.txt, the description file, and any savegames belonging to this mission are saved there.
* If you open a mission pk4-file (e.g. the Training Mission or Tears of St. Lucia), you can see the folder structure used for fan missions. It contains folders like "maps", "textures", or "materials", that you need for custom assets in your mission.
* Create a folder for your new map in "fms" and name it accordingly (e.g. Tut), then create a sub-folder "maps" and open Dark Radiant.
* With File->Select Game... you can open a window to configure basic settings (this might open automatically when you start Dark Radiant for the first time).
* For "Select a Game" choose "The Dark Mod 2.0 (Standalone).
* For "Engine Path" browse to the root folder of your installation (e.g. C:/Darkmod).
* "Mod(fs_game)" is the path to your current FM (e.g. fms/Tut). This path is relative to the given "Engine Path".
* Now the editor will use resources you point to in this folder. Otherwise a pk4-package in the root folder would be needed.
* In order to have these new settings take effect, restart Dark Radiant.
* Save the blank file under fms/yourmapfolder/maps (e.g. fms/Tut/maps). It is recommended to choose a short name for your mission as you will type it a lot in the game console.

== Your First Mission ==

Let's get started.

* Open Dark Radiant (hereinafter DR) and also open Dark Mod for quick testing.
* If you have a mission already open in DR then select File menu > New Map to clear it.
* Save it now as any suitable name. You might prefer to save later but I always do it immediately. All missions must go (with exceptions I will describe later in [[A - Z Beginner Full Guide Page 5#Managing your Mission Files|Managing your Mission Files]]) in the darkmod\maps folder or a folder within that. I urge you to create a new folder for each project within that maps folder. In this case:
# Open File Menu > Save As
# Make sure you are in the 'maps' folder.
# Select 'Create Folder' and type in say 'tutorial'. You might prefer 'Tut' or even 'T' because you have to keep typing it over and over in the Dark Mod console when testing!
# Select that folder
# Enter the name of your mission at the top.
* The game will be saved as a 'map' file with a .map suffix and is commonly called a 'map' in Doom circles. But I will use the term 'mission' or 'FM' (Fan Mission) or maybe 'game' for the map file to try to avoid confusion with actual 'city' or 'treasure' maps within the mission.

First, let's consider our rough storyline so we have some idea what to build...

== Story, Briefing ==

Formal mission objectives will be described much later in this tutorial. But before you begin your mission you will obviously need to have at least some idea of storyline and plot else you will have no idea what to build. You might have a detailed story or just some simple ideas which you can develop later.

Ultimately, you will need to brief the player with information about the story, characters, and the main purpose of the mission. It probably makes sense to write that fully when you are nearly finished the mission because new ideas or even technical difficulties might make you change your story. However, in this tutorial I'll describe it early so as you build the mission the layout and objects make sense.

Your briefing text should eventually be entered as described at [[Briefing]] but temporarily you might just write it in a plain text document for reference.

This mini tutorial mission is called 'Thief's Den' so here is an example briefing ('''not''' in correct format for the gui or .xd file):

"I had a nice haul the other night including a grand scepter from Lord Frothley. But a low-life named Creep who had given me the info, then stole it from ME! Never trust a thief I say. But I know where he lives...

I also still have his message in his own hand, giving the low-down. If I can dispose of Creep and drop the message nearby then he should take the heat for the heist diverting all suspicion from me.

Creep is a nasty piece of work who is handy with a blade. He can be dangerous and may be expecting me - may even have recruited a thug or two as back up - but he has badly underestimated my stealth skills..."

== Preparing to Build ==

When you open Dark Radiant it will default to a grid size (in the XYZ orthoview) of 8 units by 8 (changeable from version 0.9.5 onwards.) These [[Conversion of Game Units|units]] are 1.1 inches. Check your preference (default key P) in DR as it will be easier during this tutorial if you have the following checked (ticked) in Preferences > Orthoview...

* Show Grid
* Show Size Info
* Show Coordinates

'''Important:''' It is recommend you generally build with the grid set reasonably to a large size such as the default 8 or 16 for all walls, floors, etc. This makes alignment easier. You can reduce this in the grid menu for fine placement but don't leave it like that generally or you will have complexity problems. Snap to grid ([[Image:DRsnapGrid.jpg]], {{key|CTRL}}+{{key|G}}) will re-align a selection to the current grid size.

We'll mostly be working in the XYZ grid orthoview but if you have room for the camera view at the side so much the better. The camera view does a rough render in 3D (F3 toggles a better rendering with lighting etc but keep that off if it slows things down which it is likely to and just use it now and again.)

* Note the origin icon of the 'world' at 0,0,0 in the grid view
* Zoom in and out with the mouse wheel
* Right mouse drag the grid view to scroll around (zoom out further to scroll around faster)
* Use ''Change views'' tool ([[Image:DRnextViewBut.jpg]], {{key|CTRL}}+{{key|Tab}}) to toggle between top (XY), front (XZ), and side (YZ) views (you can open aditional windows using menu <tt>View > New XY view</tt>).

The blank windows in the grid and camera views can be regarded as empty void - the space in which we shall build. We have to build in bubbles sealed off from that void like an airtight spaceship or a submarine. Any gaps will cause leaks and crash your game so it's obviously the first major rule to learn: always build inner spaces sealed off from the outer void

Apart from special materials like water and weather, all the raw material you will use is 'solid' to form different shapes. So we can make panels and place them together to form lots of floating airtight boxes and these can be linked together. The entire game then takes place inside those boxes. One box can hold a tiny cupboard or an entire cathedral and a lot of boxes can hold a city. Inside those boxes you cannot see the void.

A shortcut to putting panels together is to make one solid block and hollow it out to form a box and this is what we are going to do now to form our first room.

== Making Your First Room ==

First we make a rough solid block...

* Select the top view (XY) in the grid view (toggle with [[Image:DRnextViewBut.jpg]]).
* Left mouse drag out a rectangle any few grid units across in the middle somewhere.
* This rectangle is called a 'brush' and used to define raw shapes for walls, floors etc.
* Left drag ''within'' that brush to drag the brush around
* Select the ''Resize'' tool ([[Image:DRdragResize.jpg]], {{key|Q}}).
* Now left drag ''outside'' that brush to resize it.

Now we adjust its top view area...

* Left drag outside that brush to resize it to 256 across left to right (X direction) by 192 up and down (Y direction in top view.) You should see those dimensions at the sides of the rectangle if you have 'Show Size Info' set in Edit > Preferences > Orthoview. The position of the top left corner is in brackets at top left.
* Left drag within the brush to move it so its sides fit on the bigger grid. If all sides don't fit then check your dimensions and that you are still in grid size 8 (see grid menu.)
* I prefer to build up in the top right corner from the world 0,0,0 so none of the values are negatives but you decide for yourself. Move it where you want but ideally so the sides are on the big grid.

Now we adjust its height to get our finished block (brush)...

* Use [[Image:DRnextViewBut.jpg]] ({{key|CTRL}}+{{key|Tab}}) to switch to side (YZ) or front (XZ) view and left drag outside the brush to change its height to 128
* Left drag inside the brush to move it up and down so its sides are on a big grid same as you did in the top view.
* You should now have brush 256 x 192 x 128 (see [[Conversion of Game Units#Tips|Unit Tips]])

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

== Selecting and DEselecting ==

We only have one item in our view but eventually many. Operations only work on what is currently selected. When you have just created something as we just have it is automatically the current selection and should be highlighted in your views (see DR Preferences for colour.)

* To DEselect it, point your mouse at it in either the grid or camera view and use {{key|SHIFT}}+{{key|ALT}}+{{LMB}} (or just press the {{key|Esc}} key.)
*To select it again, point your mouse at it and use {{key|SHIFT}}+{{key|ALT}}+{{LMB}} again.

Selecting is something you'll do a lot of so get familiar with that {{key|SHIFT}}+{{key|ALT}}+{{LMB}}. It's an exclusive select to get just one item. There are other selects I'll describe later. The {{key|Esc}} key always deselects and it is vitally important to get into the habit of DEselecting before you select or create something new or in some cases you will have multiple selections without knowing it and can delete or change something you didn't want to. This is why the {{key|SHIFT}}+{{key|ALT}}+{{LMB}} is the safest select as it is exclusive and will automatically DEselect anything else that was left selected. But it won't protect an item when creating. Yes, it is possible to have say a brush selected, forget it is selected, then create say, a new light. Oh! what happened to the brush? It's gone - replaced by the light. Develop a nervous habit of keep hitting {{key|Esc}} to deselect when you go to create!

From now on I'll use LMB, MMB, and RMB to refer to the mouse buttons.

== Camera View ==

You should be able to see this block in the camera view. If the camera view is just black remember {{key|F3}} toggles true light rendering and we don't yet have a light so hit {{key|F3}} to get a constant bright test light throughout. I won't go into details of all the camera controls suffice to say use the arrow keys and {{key|D}} and {{key|C}} to move vertically. But scroll down to 'camera' in [[Dark Radiant Controls, Keys & Mouse]] and you will see a fantastic amount of control you have in DR's camera view - especially with the mouse. It will take time to get used to them all so for now perhaps just learn enough to move around to see what you've done so far.

If you can see your block(brush) in the camera view then it is likely not to have any particular texture unless you were doing something before this tutorial. Close up you may see it is covered in a checkered blue 'shader not found' message. Don't worry if it's covered in something else like stone or wood though. Since it will eventually be hollowed out to form a room, let's paint it now with some material more suitable to the Dark Mod universe...

== Materials, Textures, Painting the Block ==

This is the tiny home of a cheap thief so we'll use some old stonework.

I've mentioned 'textures', 'shaders', and 'materials'; what do these terms mean? A 'material' or 'shader' is the properties of a surface, including (but not necessarily) texture, sound, and others. To 'paint' our block we...

* Select the Media Browser. This is one of the tabs on a panel. Pressing N or T hides/shows the whole panel but I guess most people leave the panel showing all the time and just select the tab they want.
* Allow a few seconds for DR to read in the media first time and then you should see 'textures' listed
* Click 'textures' and it opens up to show all available textures. Many of the ones you see are Doom textures. Scroll down and select 'darkmod' which reveals the ones most suitable for our use. Scroll down to stone, open it, then cobblestones and select blocks_mixed_multicolour. Right click it and select 'Apply to selection'. This covers all surfaces of the block because we have still got selected the whole block not just one surface. You should see this in the camera view. Use this throughout the house (and eventually on its outside surface for consistency.)
* Select the Texture Browser. This is one of the tabs on the same panel as Media Browser. The Texture Browser only shows recently used textures. You should see only the one texture you selected so it's handy for future use. Odds are you will want to re-use the same textures. It will also show other textures if you clicked on them in the media browser plus any others if you were using DR before this tutorial. You can also copy and paste textures onto single or multiple surfaces (see later.)
* Hover the mouse over the four little buttons at the top of the Texture Browser and read the text so you have some idea of what features are there for the future. For now, click on the one that says 'Flush and Reload Shaders' and it should clear all of them except the one we put on our brush. As we add others they will appear in the texture browser so you can get to them more quickly.
* Now, press S for Surface Inspector (or View menu)
* If you have only one face selected (more about this later) you can set Horiz and Vert scale. Value like 0.3 makes it harder for the player to see any pattern repetition (in this situation and in my opinion - use your own judgement with other textures and wall sizes.) In the mean time you can use arrow buttons to adjust the scale for the whole selected brush. Whatever scale you use, generally you should be consistent with it for the same texture wherever used in a mission. If you use copy and paste then it will transfer the scale as well which is far easier.
* There will be more on texture adjustment later in this tutorial.

== Hollowing out a Room from the Block ==

Building to a large grid size helps performance. The outside of our block will never be seen in the game. Once we hollow it out then the player will only see the inside so that is the surface that is rendered and that we need to align to the large grid. There are two tools to hollow out a block, both activated by a button on the left button bar: one called 'hollow' and the other 'room'. Don't use 'hollow' as it reduces the internal sides so they don't fit the big grid AND it overlaps the corners which can cause rendering errors like so....

<center>BAD!</center> 
<center>[[Image:AZhollow.jpg]]</center> 

Instead use the 'room' button which does the job right (note the increased size so the ''internal'' dimensions will be the same as our original block and align to the big grid... 

<center>GOOD!</center> 
<center>[[Image:AZroom.jpg]]</center> 

All brushes in Doom must be convex. They cannot have any inward angles (like an L shape which would have to be two brushes together) and cannot actually be hollow. The above tools really create new side panel brushes to replace the original brush. In the case of our six-sided block that is six new brushes positioned as walls, floor, and ceiling. ''The walls they create are one small grid line wide so their width will vary depending on your grid size setting.''

Examine the block in the camera view and zoom right inside so you can see it internally which is where it will be seen in game. Note the texture aligns nicely because we stuck to a big grid size. The stone is appropriate for all four walls (which is why I textured the whole block in one go rather than one surface at a time) but now we need different textures for floor and ceiling...

== Selecting and Texturing Individual Surfaces ==

'''You cannot select a surface in the grid view''' so move inside the room in the camera view.

'''To texture the floor...'''

* Press Esc to make sure everything is DEselected
* Point at the floor and use {{key|SHIFT}}+{{LMB}}. Repeat a few times and you will see it selects/DEselects the surface. Keep it selected.
* Select the Media Browser again (on the tabbed panel)
* In the darkmod section select say stone/cobblestones or maybe you would like some wood/boards/worn_01 ? You choose but something like carpet might need special alignment so stick with stones or boards maybe for now? Remember - RIGHT click the texture name and select 'Apply to Selection'
* Alternatively you can click on several possibles then select them with one LMB in the Texture Browser on the other tab. In the Texture Browser you can enlarge the textures if preferred to see them better.
* Esc to DEselect so you can see it better in camera view.

'''To texture the ceiling...'''

* Press Esc to make sure everything is DEselected
* Point at the ceiling and use {{key|SHIFT}}+{{LMB}} again to select its surface.
* Select the Media Browser again (on the tabbed panel)
* In the darkmod section select say plaster/plaster01 and apply it.

'''If you change your mind about the walls you can change them to something else...'''

* Press Esc to make sure everything is DEselected
* Point at one wall and use {{key|SHIFT}}+{{LMB}} again to select its surface.
* Point at another wall use {{key|SHIFT}}+{{LMB}} again so now both surfaces are selected
* 'Accidentally' select the ceiling. No problem. Just use {{key|SHIFT}}+{{LMB}} on it again to DEselect it but the walls are still selected. In this way you can select which surfaces you want to select.
* Select the Media Browser again and just apply another type of stone, perhaps brick, to the walls if you want or just leave it as it is.

Now press {{key|CTRL}}+{{key|S}} to resave the mission or use the File menu. Get into the habit of doing this often unless you have autosave set. Now and again you can also save with a new name so you can go back to an earlier one if you totally mess up. Note: There is also a backup file made automatically by DR.

== Adding the Player's Start Point ==

One more thing is ''essential'' to play this in Dark Mod and that is the Player's starting position.

* Press Esc to DEselect everything.
* In the TOP grid view, point the mouse in the middle of the room and RMB to get a pop up menu. This menu is important so glance at some of the other items on it while you're here. 'Entities' are special function items and the player start is amongst them but there is a shortcut on the menu so instead...
* Select "Create Player Start here" on the menu. This will create the playerstart entity (red box) and put it where you clicked. Drag the entity around to the point where you want the player to start.
* You should see an arrow on the red box indicating the way the player will face at the start. If you cannot see the arrow then menu <tt>View > Show > Show Angles</tt> will reveal it. You can rotate the player by selecting ''Rotate'' tool ([[Image:DRrotate.jpg]], {{key|R}}) and dragging with the mouse.
* Use {{key|CTRL}}+{{key|Tab}} to switch to the side view (YZ) and use LMB to drag the ''inside'' of the player start box so its base is on the floor of the room (you can also use ''Translate'' tool, [[Image:DRtranslate.jpg]], {{key|W}}). Make sure you do not go below or the floor or the player might be stuck with his feet in concrete! Tip: In Thief games it was common to start just dropping over a wall with this player start a few feet above the ground. You might note that entities do not directly resize like brushes so LMB dragging on the ''outside'' of the box does nothing (unless you have selected the ''Translate'' tool).
* RMB in the grid view again and you will see there is now a ''Move player start here'' option so you can quickly move its position while testing different areas of your mission. But always remember to check both the side and top view when moving things around, to make sure the vertical position is also valid. (Also note that ''Move player start here'' does not ''select'' the player start - you will need to select it if you need to adjust its position by dragging.)
* With the player start still selected you can select the Entity Inspector (on the panel, or {{key|N}} to hide/show it) and see the properties of your first entity.

The game could now be played but it will be totally dark so we need to create at least one light.....

== Creating a Light ==

* Press Esc to DEselect everything.
* In the TOP grid view, point the mouse in the ''middle'' of the room and RMB to get the pop up menu.
* Select "Create Light" on the menu.
* A large red box appears with diagonals representing the light's centre and its rough 'radius'. The default light is more like six pyramids pointing out to their peaks in the centre of each side of the box. This gives a rough impression of a sphere of light and helps performance.
* {{key|CTRL}}+{{key|TAB}} to get a side view and LMB drag ''right in the centre of the light'' to move it up/down to centre it in the room if it is not already. Just dragging inside the radius box won't move it - you have to point at the centre.

== Resizing a Light ==

Resizing a light is awkward because dragging any side moves the centre (this might be changed in a later Dark Radiant.) Two ways of dealing with this. Just roughly drag it about and keep moving the light back to where you want it. But if you have very precisely positioned a light then you don't want to have to keep doing that so this is what I do...

* Select the Entity Inspector on the panel
* You should see it has a light radius property with three values for XYZ for the three dimensions. They are north and south for Y, east and west for X, and up and down for Z. (those are the compass directions in game by the way.)
* Click on the light radius property to highlight it.
* Note that its values appear in a choice of inputs at the bottom - You can type new values in a line with a space in between then click the check(tick) button or enter them as separate values or even use the little scrolly buttons at the side and then click the Apply button.
* The room interior is 192 x 256 x 128 (in XYZ order) so give the light radius the values 200 260 133 so it protrudes outside the walls (we're setting radius - so the light diameter will be twice that size). We may well change this again later if we want the light to spill out through a doorway or something.
* You can now toggle light rendering in the preview using {{Key|F3}} (or an icon in the preview toolbar) to see how the light affects the walls.

The light radius is not just a cut-off point. It can be regarded as a 'fade to zero point'. What this means is that the light is at maximum brightness at its centre and fades to zero at the limit of the radius. So in a big open area, if you extend the radius you will 'stretch the brightness' further. Imagine the scale from max to min compacted in a small radius or expanded in a large one. More on this later when we place wall torches.

== Changing a Light's Brightness ==

The light may be a little bright. To change it...

* Press L (or View menu)* to call up the Light Inspector
* Click on the white rectangle button just below where it says 'Colour'
* The brightness value is called 'Lum:' (luminosity) and should default to 100. Reduce it to 90, by overtyping it or using the slider to the far right. It might not matter. I'm just showing you where the control is for now.
* Fool around with the colours if you want - there are extensive features I won't cover here.

Hey! We should have your first working mission! Do a {{key|CTRL}}+{{key|S}} to save it and then follow the next sections in Dark Mod itself not in Dark Radiant.....

== Sound ==

There is no need to do anything special about ''hearing'' sounds such as footsteps, collision sounds, etc. at this stage as it will work automatically. Adding custom sounds will be dealt with later.

== Pathfinding ==

Pathfinding data to tell the AI characters where they can move is created by dmap by default when compiling in the next section...

== Dmap: Compiling the Mission ==
* Your mission file cannot be played itself; it is simply the directions to create a game file. To do this...
* Start up The Dark Mod. From any Dark Mod menu go to the console. By default, the console is {{key|CTRL}}+{{key|ALT}}+{{key|~}} (US Keyboards) or {{key|CTRL}}+{{key|ALT}}+{{key|'}} (UK Keyboards). This key is the top left below Esc and to the left of "1" on all keyboards I believe. But most people set up a shortcut to just use the ~ (` in UK) on its own so:

For single key click to get the console:
In your desktop shortcut to Doom3.exe add this argument to its properties (right click shortcut): '''''+set com_allowConsole 1''''' so the target line would be something like:

'''''C:\Doom3\doom3.exe +set com_allowConsole 1'''''

(plus any other arguments you might want)
* In the console type and Enter dmap Tut/T001 where you should substitute your subfolder name for Tut and your mission filename for T001. So, if you created your mission file directly in the maps folder then you do not need a folder name and can put dmap T001. If you made a subfolder in maps called MyMaps and named your mission MissionImpossible999.map then enter dmap MyMaps/MissionImpossible999. I recommend you do not use upper case in filenames in Doom as I think it can cause problems on other platforms.
* Wait while dmap compiles the mission. This should only be a few seconds with this tiny mission but will be much longer for big missions.
* If you get a 'leaked' error or some other serious red warning then recheck your work; look for gaps in the wall or a wrong texture like nodraw or have you got an entity outside in the void? See [[Performance: Essential Must-Knows#How to detect and fix leaks|HERE]] for more about fixing leaks but at this stage of this tutorial it might be easier just to redo. What I have laboured over is basically make a block, texture it, hollow it, stick in a player start and a light. As you get more proficient you can do it in less than a minute.
* Assuming there were no dmap red "ERROR"s then you should be returned to the Dark Mod menus and are now able to play the mission.
* Return to the console.
* Type and Enter map Tut/T001. Tip: Press the up arrow key toggles back through the history of what you have typed before so your dmap should re-appear. Just press the Home key and delete the 'd'. An alternative is to use 'testmap' instead of dmap which does both dmap and map but I prefer to see dmap's results.
* You should now be able to walk around in the room. If you have a player shadow set then you might notice that walking through that light looks odd so keep that in mind for light placement. But most lights you will place close to a visible source like a gaslight or wall torch.

That's the first part done!

{{A-Z Beginner Guide TOC}}

{{tutorial-editing}}

A - Z Beginner Full Guide Start Here!

2017-03-01T21:04:02Z

Destined:

{{A-Z Beginner Guide TOC}}
'''''PLEASE NOTE: THIS GUIDE CONTAINS SPOILERS FOR THE "THIEF'S DEN" DEMO MISSION RELEASED JAN 18TH, 2008.'''''

== Introduction ==

Since writing this I've created a [[Startpack Mappers' Guide]] which is a ready made FM template with a set of ready made components to make it even easier to make a Dark Mod FM because it already includes things like objectives, briefing, readables, etc. etc and you just modify them and concentrate on building. However, I recommend you first follow this guide so you have some understanding of the basics and then the startpack will make more sense.

This is an easy guide for complete beginners to Dark Mod. It will lead you from start to finish, 'push that button, click that menu' and at the end you will have a fully working (but tiny) Dark Mod mission with all the main essential features including objectives all zipped up. You will be able to include variations of your own as you progress if you wish. Links to more detailed info is included but ignore those first time if you wish. Creating this mission is a learning process: although others will be able to play it, it will be too simple for that purpose - though it might be fun to see how varied the results might be from different players following the same instructions! When finished you can modify it and customise it to learn more or just shelve it for reference while you start your ''real'' mission!

This tutorial does not describe how to make your mission architecturally beautiful - just the opposite; the build may be as crude, quick, and ugly as you like. Nor does it advise how to design for good gameplay, etc. For that you should go to [[Mission Design Tips]] after you have mastered the basics. This is a ''method'' tutorial, not a ''design'' tutorial. Nor can it answer every question. It will merely present the most basic information for making a complete mission.

Feel free to experiment, add to, or even skip parts you already know or seem obvious, especially if you have a background producing Doom or Quake maps.

This guide was inspired by Komag's famous tutorial which helped a great many Dromeders (including myself) to get started producing Thief 2 FMs. If you are or were a Dromeder then you might first like to browse quickly through [[Dromed - Dark Mod Differences]] before proceeding - though it is not essential for this tutorial as I am trying to make few assumptions of prior knowledge. It will refer to default keys/mouse settings in Dard Radiant (editor - see later) so if you have changed any hot keys in Dark Radiant's help menu then keep that in mind. Also note that any screenshots might be in a different colour to your settings of course.

== Installation ==

This tutorial assumes that you have Dark Mod already installed. If not, please refer to [http://www.thedarkmod.com The Dark Mod] website for information.

Alternatively you can use the limited Dark Mod resources provided by the pre-release demo mission [[Thief's Den]]

== The Dark Mod Editor ==

To edit Dark Mod missions you will need a game editor. '''This tutorial is based on the [[Dark Radiant]] editor''' (hereinafter may be called DR) but you can possibly follow most of it in other editors like DoomEd. Variations might be shown where possible but it will mainly assume Dark Radiant. If you haven't got Dark Radiant yet, consult the [[Dark Radiant]] sections, install it and set it up how you like it. If you want to use DoomEd then you need to look elsewhere first. DoomEd of course is supplied with Doom.

You might wish to open the [[Dark Radiant Controls, Keys & Mouse|DR Controls]] page in a new window in your web browser for quick reference while following this tutorial. I'll try to make it so you don't need to!

Make sure you can run Dark Mod and your editor before proceeding. In particular remember you can undo your last step(s) (edit menu or {{key|CTRL}}+{{key|Z}})

== Folder Structure ==

[Added by Destined]

All main resources and executables are stored in the TDM root folder (this is where you have installed The Dark Mod, e.g. C:/Darkmod). The recources are stored in pk4-files. These are simply renamed zip-files and can be opened with any common unpacking program like Winzip, Winrar or 7zip. The "maps" folder is where Dark Radiant saves maps by default. All fan missions are stored in the "fms" folder as pk4-files. Upon installing a mission in-game, a sub-folder is created and the pk4-file as well as the readme.txt, the description file, and any savegames belonging to this mission are saved there. If you open a mission pk4-file (e.g. the Training Mission or Tears of St. Lucia), you can see the folder structure used for fan missions. It contains folders like "maps", "textures", or "materials", that you need for custom assets in your mission. Create a folder for your new map in "fms" and name it accordingly (e.g. Tut). Create a sub-folder "maps" and open Dark Radiant. With File->Select Game... you can open a window to configure basic settings (this might open automatically when you start Dark Radiant for the first time). For "Select a Game" choose "The Dark Mod 2.0 (Standalone). For "Engine Path" browse to the root folder of your installation (e.g. C:/Darkmod). "Mod(fs_game)" is the path to your current FM (e.g. fms/Tut). This path is relative to the given "Engine Path". Now the editor will use resources you point to in this folder. Otherwise a pk4-package in the root folder would be needed. In order to have these new settings take effect, restart Dark Radiant. Save the blank file under fms/yourmapfolder/maps (e.g. fms/Tut/maps). Choose a short name for your mission as you will type it a lot in the game console.

== Your First Mission ==

Let's get started.

* Open Dark Radiant (hereinafter DR) and also open Dark Mod for quick testing.
* If you have a mission already open in DR then select File menu > New Map to clear it.
* Save it now as any suitable name. You might prefer to save later but I always do it immediately. All missions must go (with exceptions I will describe later in [[A - Z Beginner Full Guide Page 5#Managing your Mission Files|Managing your Mission Files]]) in the darkmod\maps folder or a folder within that. I urge you to create a new folder for each project within that maps folder. In this case:
# Open File Menu > Save As
# Make sure you are in the 'maps' folder.
# Select 'Create Folder' and type in say 'tutorial'. You might prefer 'Tut' or even 'T' because you have to keep typing it over and over in the Dark Mod console when testing!
# Select that folder
# Enter the name of your mission at the top.
* The game will be saved as a 'map' file with a .map suffix and is commonly called a 'map' in Doom circles. But I will use the term 'mission' or 'FM' (Fan Mission) or maybe 'game' for the map file to try to avoid confusion with actual 'city' or 'treasure' maps within the mission.

First, let's consider our rough storyline so we have some idea what to build...

== Story, Briefing ==

Formal mission objectives will be described much later in this tutorial. But before you begin your mission you will obviously need to have at least some idea of storyline and plot else you will have no idea what to build. You might have a detailed story or just some simple ideas which you can develop later.

Ultimately, you will need to brief the player with information about the story, characters, and the main purpose of the mission. It probably makes sense to write that fully when you are nearly finished the mission because new ideas or even technical difficulties might make you change your story. However, in this tutorial I'll describe it early so as you build the mission the layout and objects make sense.

Your briefing text should eventually be entered as described at [[Briefing]] but temporarily you might just write it in a plain text document for reference.

This mini tutorial mission is called 'Thief's Den' so here is an example briefing ('''not''' in correct format for the gui or .xd file):

"I had a nice haul the other night including a grand scepter from Lord Frothley. But a low-life named Creep who had given me the info, then stole it from ME! Never trust a thief I say. But I know where he lives...

I also still have his message in his own hand, giving the low-down. If I can dispose of Creep and drop the message nearby then he should take the heat for the heist diverting all suspicion from me.

Creep is a nasty piece of work who is handy with a blade. He can be dangerous and may be expecting me - may even have recruited a thug or two as back up - but he has badly underestimated my stealth skills..."

== Preparing to Build ==

When you open Dark Radiant it will default to a grid size (in the XYZ orthoview) of 8 units by 8 (changeable from version 0.9.5 onwards.) These [[Conversion of Game Units|units]] are 1.1 inches. Check your preference (default key P) in DR as it will be easier during this tutorial if you have the following checked (ticked) in Preferences > Orthoview...

* Show Grid
* Show Size Info
* Show Coordinates

'''Important:''' It is recommend you generally build with the grid set reasonably to a large size such as the default 8 or 16 for all walls, floors, etc. This makes alignment easier. You can reduce this in the grid menu for fine placement but don't leave it like that generally or you will have complexity problems. Snap to grid ([[Image:DRsnapGrid.jpg]], {{key|CTRL}}+{{key|G}}) will re-align a selection to the current grid size.

We'll mostly be working in the XYZ grid orthoview but if you have room for the camera view at the side so much the better. The camera view does a rough render in 3D (F3 toggles a better rendering with lighting etc but keep that off if it slows things down which it is likely to and just use it now and again.)

* Note the origin icon of the 'world' at 0,0,0 in the grid view
* Zoom in and out with the mouse wheel
* Right mouse drag the grid view to scroll around (zoom out further to scroll around faster)
* Use ''Change views'' tool ([[Image:DRnextViewBut.jpg]], {{key|CTRL}}+{{key|Tab}}) to toggle between top (XY), front (XZ), and side (YZ) views (you can open aditional windows using menu <tt>View > New XY view</tt>).

The blank windows in the grid and camera views can be regarded as empty void - the space in which we shall build. We have to build in bubbles sealed off from that void like an airtight spaceship or a submarine. Any gaps will cause leaks and crash your game so it's obviously the first major rule to learn: always build inner spaces sealed off from the outer void

Apart from special materials like water and weather, all the raw material you will use is 'solid' to form different shapes. So we can make panels and place them together to form lots of floating airtight boxes and these can be linked together. The entire game then takes place inside those boxes. One box can hold a tiny cupboard or an entire cathedral and a lot of boxes can hold a city. Inside those boxes you cannot see the void.

A shortcut to putting panels together is to make one solid block and hollow it out to form a box and this is what we are going to do now to form our first room.

== Making Your First Room ==

First we make a rough solid block...

* Select the top view (XY) in the grid view (toggle with [[Image:DRnextViewBut.jpg]]).
* Left mouse drag out a rectangle any few grid units across in the middle somewhere.
* This rectangle is called a 'brush' and used to define raw shapes for walls, floors etc.
* Left drag ''within'' that brush to drag the brush around
* Select the ''Resize'' tool ([[Image:DRdragResize.jpg]], {{key|Q}}).
* Now left drag ''outside'' that brush to resize it.

Now we adjust its top view area...

* Left drag outside that brush to resize it to 256 across left to right (X direction) by 192 up and down (Y direction in top view.) You should see those dimensions at the sides of the rectangle if you have 'Show Size Info' set in Edit > Preferences > Orthoview. The position of the top left corner is in brackets at top left.
* Left drag within the brush to move it so its sides fit on the bigger grid. If all sides don't fit then check your dimensions and that you are still in grid size 8 (see grid menu.)
* I prefer to build up in the top right corner from the world 0,0,0 so none of the values are negatives but you decide for yourself. Move it where you want but ideally so the sides are on the big grid.

Now we adjust its height to get our finished block (brush)...

* Use [[Image:DRnextViewBut.jpg]] ({{key|CTRL}}+{{key|Tab}}) to switch to side (YZ) or front (XZ) view and left drag outside the brush to change its height to 128
* Left drag inside the brush to move it up and down so its sides are on a big grid same as you did in the top view.
* You should now have brush 256 x 192 x 128 (see [[Conversion of Game Units#Tips|Unit Tips]])

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

== Selecting and DEselecting ==

We only have one item in our view but eventually many. Operations only work on what is currently selected. When you have just created something as we just have it is automatically the current selection and should be highlighted in your views (see DR Preferences for colour.)

* To DEselect it, point your mouse at it in either the grid or camera view and use {{key|SHIFT}}+{{key|ALT}}+{{LMB}} (or just press the {{key|Esc}} key.)
*To select it again, point your mouse at it and use {{key|SHIFT}}+{{key|ALT}}+{{LMB}} again.

Selecting is something you'll do a lot of so get familiar with that {{key|SHIFT}}+{{key|ALT}}+{{LMB}}. It's an exclusive select to get just one item. There are other selects I'll describe later. The {{key|Esc}} key always deselects and it is vitally important to get into the habit of DEselecting before you select or create something new or in some cases you will have multiple selections without knowing it and can delete or change something you didn't want to. This is why the {{key|SHIFT}}+{{key|ALT}}+{{LMB}} is the safest select as it is exclusive and will automatically DEselect anything else that was left selected. But it won't protect an item when creating. Yes, it is possible to have say a brush selected, forget it is selected, then create say, a new light. Oh! what happened to the brush? It's gone - replaced by the light. Develop a nervous habit of keep hitting {{key|Esc}} to deselect when you go to create!

From now on I'll use LMB, MMB, and RMB to refer to the mouse buttons.

== Camera View ==

You should be able to see this block in the camera view. If the camera view is just black remember {{key|F3}} toggles true light rendering and we don't yet have a light so hit {{key|F3}} to get a constant bright test light throughout. I won't go into details of all the camera controls suffice to say use the arrow keys and {{key|D}} and {{key|C}} to move vertically. But scroll down to 'camera' in [[Dark Radiant Controls, Keys & Mouse]] and you will see a fantastic amount of control you have in DR's camera view - especially with the mouse. It will take time to get used to them all so for now perhaps just learn enough to move around to see what you've done so far.

If you can see your block(brush) in the camera view then it is likely not to have any particular texture unless you were doing something before this tutorial. Close up you may see it is covered in a checkered blue 'shader not found' message. Don't worry if it's covered in something else like stone or wood though. Since it will eventually be hollowed out to form a room, let's paint it now with some material more suitable to the Dark Mod universe...

== Materials, Textures, Painting the Block ==

This is the tiny home of a cheap thief so we'll use some old stonework.

I've mentioned 'textures', 'shaders', and 'materials'; what do these terms mean? A 'material' or 'shader' is the properties of a surface, including (but not necessarily) texture, sound, and others. To 'paint' our block we...

* Select the Media Browser. This is one of the tabs on a panel. Pressing N or T hides/shows the whole panel but I guess most people leave the panel showing all the time and just select the tab they want.
* Allow a few seconds for DR to read in the media first time and then you should see 'textures' listed
* Click 'textures' and it opens up to show all available textures. Many of the ones you see are Doom textures. Scroll down and select 'darkmod' which reveals the ones most suitable for our use. Scroll down to stone, open it, then cobblestones and select blocks_mixed_multicolour. Right click it and select 'Apply to selection'. This covers all surfaces of the block because we have still got selected the whole block not just one surface. You should see this in the camera view. Use this throughout the house (and eventually on its outside surface for consistency.)
* Select the Texture Browser. This is one of the tabs on the same panel as Media Browser. The Texture Browser only shows recently used textures. You should see only the one texture you selected so it's handy for future use. Odds are you will want to re-use the same textures. It will also show other textures if you clicked on them in the media browser plus any others if you were using DR before this tutorial. You can also copy and paste textures onto single or multiple surfaces (see later.)
* Hover the mouse over the four little buttons at the top of the Texture Browser and read the text so you have some idea of what features are there for the future. For now, click on the one that says 'Flush and Reload Shaders' and it should clear all of them except the one we put on our brush. As we add others they will appear in the texture browser so you can get to them more quickly.
* Now, press S for Surface Inspector (or View menu)
* If you have only one face selected (more about this later) you can set Horiz and Vert scale. Value like 0.3 makes it harder for the player to see any pattern repetition (in this situation and in my opinion - use your own judgement with other textures and wall sizes.) In the mean time you can use arrow buttons to adjust the scale for the whole selected brush. Whatever scale you use, generally you should be consistent with it for the same texture wherever used in a mission. If you use copy and paste then it will transfer the scale as well which is far easier.
* There will be more on texture adjustment later in this tutorial.

== Hollowing out a Room from the Block ==

Building to a large grid size helps performance. The outside of our block will never be seen in the game. Once we hollow it out then the player will only see the inside so that is the surface that is rendered and that we need to align to the large grid. There are two tools to hollow out a block, both activated by a button on the left button bar: one called 'hollow' and the other 'room'. Don't use 'hollow' as it reduces the internal sides so they don't fit the big grid AND it overlaps the corners which can cause rendering errors like so....

<center>BAD!</center> 
<center>[[Image:AZhollow.jpg]]</center> 

Instead use the 'room' button which does the job right (note the increased size so the ''internal'' dimensions will be the same as our original block and align to the big grid... 

<center>GOOD!</center> 
<center>[[Image:AZroom.jpg]]</center> 

All brushes in Doom must be convex. They cannot have any inward angles (like an L shape which would have to be two brushes together) and cannot actually be hollow. The above tools really create new side panel brushes to replace the original brush. In the case of our six-sided block that is six new brushes positioned as walls, floor, and ceiling. ''The walls they create are one small grid line wide so their width will vary depending on your grid size setting.''

Examine the block in the camera view and zoom right inside so you can see it internally which is where it will be seen in game. Note the texture aligns nicely because we stuck to a big grid size. The stone is appropriate for all four walls (which is why I textured the whole block in one go rather than one surface at a time) but now we need different textures for floor and ceiling...

== Selecting and Texturing Individual Surfaces ==

'''You cannot select a surface in the grid view''' so move inside the room in the camera view.

'''To texture the floor...'''

* Press Esc to make sure everything is DEselected
* Point at the floor and use {{key|SHIFT}}+{{LMB}}. Repeat a few times and you will see it selects/DEselects the surface. Keep it selected.
* Select the Media Browser again (on the tabbed panel)
* In the darkmod section select say stone/cobblestones or maybe you would like some wood/boards/worn_01 ? You choose but something like carpet might need special alignment so stick with stones or boards maybe for now? Remember - RIGHT click the texture name and select 'Apply to Selection'
* Alternatively you can click on several possibles then select them with one LMB in the Texture Browser on the other tab. In the Texture Browser you can enlarge the textures if preferred to see them better.
* Esc to DEselect so you can see it better in camera view.

'''To texture the ceiling...'''

* Press Esc to make sure everything is DEselected
* Point at the ceiling and use {{key|SHIFT}}+{{LMB}} again to select its surface.
* Select the Media Browser again (on the tabbed panel)
* In the darkmod section select say plaster/plaster01 and apply it.

'''If you change your mind about the walls you can change them to something else...'''

* Press Esc to make sure everything is DEselected
* Point at one wall and use {{key|SHIFT}}+{{LMB}} again to select its surface.
* Point at another wall use {{key|SHIFT}}+{{LMB}} again so now both surfaces are selected
* 'Accidentally' select the ceiling. No problem. Just use {{key|SHIFT}}+{{LMB}} on it again to DEselect it but the walls are still selected. In this way you can select which surfaces you want to select.
* Select the Media Browser again and just apply another type of stone, perhaps brick, to the walls if you want or just leave it as it is.

Now press {{key|CTRL}}+{{key|S}} to resave the mission or use the File menu. Get into the habit of doing this often unless you have autosave set. Now and again you can also save with a new name so you can go back to an earlier one if you totally mess up. Note: There is also a backup file made automatically by DR.

== Adding the Player's Start Point ==

One more thing is ''essential'' to play this in Dark Mod and that is the Player's starting position.

* Press Esc to DEselect everything.
* In the TOP grid view, point the mouse in the middle of the room and RMB to get a pop up menu. This menu is important so glance at some of the other items on it while you're here. 'Entities' are special function items and the player start is amongst them but there is a shortcut on the menu so instead...
* Select "Create Player Start here" on the menu. This will create the playerstart entity (red box) and put it where you clicked. Drag the entity around to the point where you want the player to start.
* You should see an arrow on the red box indicating the way the player will face at the start. If you cannot see the arrow then menu <tt>View > Show > Show Angles</tt> will reveal it. You can rotate the player by selecting ''Rotate'' tool ([[Image:DRrotate.jpg]], {{key|R}}) and dragging with the mouse.
* Use {{key|CTRL}}+{{key|Tab}} to switch to the side view (YZ) and use LMB to drag the ''inside'' of the player start box so its base is on the floor of the room (you can also use ''Translate'' tool, [[Image:DRtranslate.jpg]], {{key|W}}). Make sure you do not go below or the floor or the player might be stuck with his feet in concrete! Tip: In Thief games it was common to start just dropping over a wall with this player start a few feet above the ground. You might note that entities do not directly resize like brushes so LMB dragging on the ''outside'' of the box does nothing (unless you have selected the ''Translate'' tool).
* RMB in the grid view again and you will see there is now a ''Move player start here'' option so you can quickly move its position while testing different areas of your mission. But always remember to check both the side and top view when moving things around, to make sure the vertical position is also valid. (Also note that ''Move player start here'' does not ''select'' the player start - you will need to select it if you need to adjust its position by dragging.)
* With the player start still selected you can select the Entity Inspector (on the panel, or {{key|N}} to hide/show it) and see the properties of your first entity.

The game could now be played but it will be totally dark so we need to create at least one light.....

== Creating a Light ==

* Press Esc to DEselect everything.
* In the TOP grid view, point the mouse in the ''middle'' of the room and RMB to get the pop up menu.
* Select "Create Light" on the menu.
* A large red box appears with diagonals representing the light's centre and its rough 'radius'. The default light is more like six pyramids pointing out to their peaks in the centre of each side of the box. This gives a rough impression of a sphere of light and helps performance.
* {{key|CTRL}}+{{key|TAB}} to get a side view and LMB drag ''right in the centre of the light'' to move it up/down to centre it in the room if it is not already. Just dragging inside the radius box won't move it - you have to point at the centre.

== Resizing a Light ==

Resizing a light is awkward because dragging any side moves the centre (this might be changed in a later Dark Radiant.) Two ways of dealing with this. Just roughly drag it about and keep moving the light back to where you want it. But if you have very precisely positioned a light then you don't want to have to keep doing that so this is what I do...

* Select the Entity Inspector on the panel
* You should see it has a light radius property with three values for XYZ for the three dimensions. They are north and south for Y, east and west for X, and up and down for Z. (those are the compass directions in game by the way.)
* Click on the light radius property to highlight it.
* Note that its values appear in a choice of inputs at the bottom - You can type new values in a line with a space in between then click the check(tick) button or enter them as separate values or even use the little scrolly buttons at the side and then click the Apply button.
* The room interior is 192 x 256 x 128 (in XYZ order) so give the light radius the values 200 260 133 so it protrudes outside the walls (we're setting radius - so the light diameter will be twice that size). We may well change this again later if we want the light to spill out through a doorway or something.
* You can now toggle light rendering in the preview using {{Key|F3}} (or an icon in the preview toolbar) to see how the light affects the walls.

The light radius is not just a cut-off point. It can be regarded as a 'fade to zero point'. What this means is that the light is at maximum brightness at its centre and fades to zero at the limit of the radius. So in a big open area, if you extend the radius you will 'stretch the brightness' further. Imagine the scale from max to min compacted in a small radius or expanded in a large one. More on this later when we place wall torches.

== Changing a Light's Brightness ==

The light may be a little bright. To change it...

* Press L (or View menu)* to call up the Light Inspector
* Click on the white rectangle button just below where it says 'Colour'
* The brightness value is called 'Lum:' (luminosity) and should default to 100. Reduce it to 90, by overtyping it or using the slider to the far right. It might not matter. I'm just showing you where the control is for now.
* Fool around with the colours if you want - there are extensive features I won't cover here.

Hey! We should have your first working mission! Do a {{key|CTRL}}+{{key|S}} to save it and then follow the next sections in Dark Mod itself not in Dark Radiant.....

== Sound ==

There is no need to do anything special about ''hearing'' sounds such as footsteps, collision sounds, etc. at this stage as it will work automatically. Adding custom sounds will be dealt with later.

== Pathfinding ==

Pathfinding data to tell the AI characters where they can move is created by dmap by default when compiling in the next section...

== Dmap: Compiling the Mission ==
* Your mission file cannot be played itself; it is simply the directions to create a game file. To do this...
* Start up The Dark Mod. From any Dark Mod menu go to the console. By default, the console is {{key|CTRL}}+{{key|ALT}}+{{key|~}} (US Keyboards) or {{key|CTRL}}+{{key|ALT}}+{{key|'}} (UK Keyboards). This key is the top left below Esc and to the left of "1" on all keyboards I believe. But most people set up a shortcut to just use the ~ (` in UK) on its own so:

For single key click to get the console:
In your desktop shortcut to Doom3.exe add this argument to its properties (right click shortcut): '''''+set com_allowConsole 1''''' so the target line would be something like:

'''''C:\Doom3\doom3.exe +set com_allowConsole 1'''''

(plus any other arguments you might want)
* In the console type and Enter dmap Tut/T001 where you should substitute your subfolder name for Tut and your mission filename for T001. So, if you created your mission file directly in the maps folder then you do not need a folder name and can put dmap T001. If you made a subfolder in maps called MyMaps and named your mission MissionImpossible999.map then enter dmap MyMaps/MissionImpossible999. I recommend you do not use upper case in filenames in Doom as I think it can cause problems on other platforms.
* Wait while dmap compiles the mission. This should only be a few seconds with this tiny mission but will be much longer for big missions.
* If you get a 'leaked' error or some other serious red warning then recheck your work; look for gaps in the wall or a wrong texture like nodraw or have you got an entity outside in the void? See [[Performance: Essential Must-Knows#How to detect and fix leaks|HERE]] for more about fixing leaks but at this stage of this tutorial it might be easier just to redo. What I have laboured over is basically make a block, texture it, hollow it, stick in a player start and a light. As you get more proficient you can do it in less than a minute.
* Assuming there were no dmap red "ERROR"s then you should be returned to the Dark Mod menus and are now able to play the mission.
* Return to the console.
* Type and Enter map Tut/T001. Tip: Press the up arrow key toggles back through the history of what you have typed before so your dmap should re-appear. Just press the Home key and delete the 'd'. An alternative is to use 'testmap' instead of dmap which does both dmap and map but I prefer to see dmap's results.
* You should now be able to walk around in the room. If you have a player shadow set then you might notice that walking through that light looks odd so keep that in mind for light placement. But most lights you will place close to a visible source like a gaslight or wall torch.

That's the first part done!

{{A-Z Beginner Guide TOC}}

{{tutorial-editing}}

A - Z Beginner Full Guide Start Here!

2017-03-01T21:03:34Z

Destined:

{{A-Z Beginner Guide TOC}}
'''''PLEASE NOTE: THIS GUIDE CONTAINS SPOILERS FOR THE "THIEF'S DEN" DEMO MISSION RELEASED JAN 18TH, 2008.'''''

== Introduction ==

Since writing this I've created a [[Startpack Mappers' Guide]] which is a ready made FM template with a set of ready made components to make it even easier to make a Dark Mod FM because it already includes things like objectives, briefing, readables, etc. etc and you just modify them and concentrate on building. However, I recommend you first follow this guide so you have some understanding of the basics and then the startpack will make more sense.

This is an easy guide for complete beginners to Dark Mod. It will lead you from start to finish, 'push that button, click that menu' and at the end you will have a fully working (but tiny) Dark Mod mission with all the main essential features including objectives all zipped up. You will be able to include variations of your own as you progress if you wish. Links to more detailed info is included but ignore those first time if you wish. Creating this mission is a learning process: although others will be able to play it, it will be too simple for that purpose - though it might be fun to see how varied the results might be from different players following the same instructions! When finished you can modify it and customise it to learn more or just shelve it for reference while you start your ''real'' mission!

This tutorial does not describe how to make your mission architecturally beautiful - just the opposite; the build may be as crude, quick, and ugly as you like. Nor does it advise how to design for good gameplay, etc. For that you should go to [[Mission Design Tips]] after you have mastered the basics. This is a ''method'' tutorial, not a ''design'' tutorial. Nor can it answer every question. It will merely present the most basic information for making a complete mission.

Feel free to experiment, add to, or even skip parts you already know or seem obvious, especially if you have a background producing Doom or Quake maps.

This guide was inspired by Komag's famous tutorial which helped a great many Dromeders (including myself) to get started producing Thief 2 FMs. If you are or were a Dromeder then you might first like to browse quickly through [[Dromed - Dark Mod Differences]] before proceeding - though it is not essential for this tutorial as I am trying to make few assumptions of prior knowledge. It will refer to default keys/mouse settings in Dard Radiant (editor - see later) so if you have changed any hot keys in Dark Radiant's help menu then keep that in mind. Also note that any screenshots might be in a different colour to your settings of course.

== Installation ==

This tutorial assumes that you have Dark Mod already installed. If not, please refer to [http://www.thedarkmod.com The Dark Mod] website for information.

Alternatively you can use the limited Dark Mod resources provided by the pre-release demo mission [[Thief's Den]]

== The Dark Mod Editor ==

To edit Dark Mod missions you will need a game editor. '''This tutorial is based on the [[Dark Radiant]] editor''' (hereinafter may be called DR) but you can possibly follow most of it in other editors like DoomEd. Variations might be shown where possible but it will mainly assume Dark Radiant. If you haven't got Dark Radiant yet, consult the [[Dark Radiant]] sections, install it and set it up how you like it. If you want to use DoomEd then you need to look elsewhere first. DoomEd of course is supplied with Doom.

You might wish to open the [[Dark Radiant Controls, Keys & Mouse|DR Controls]] page in a new window in your web browser for quick reference while following this tutorial. I'll try to make it so you don't need to!

Make sure you can run Dark Mod and your editor before proceeding. In particular remember you can undo your last step(s) (edit menu or {{key|CTRL}}+{{key|Z}})

== Folder Structure == [Added by Destined]

All main resources and executables are stored in the TDM root folder (this is where you have installed The Dark Mod, e.g. C:/Darkmod). The recources are stored in pk4-files. These are simply renamed zip-files and can be opened with any common unpacking program like Winzip, Winrar or 7zip. The "maps" folder is where Dark Radiant saves maps by default. All fan missions are stored in the "fms" folder as pk4-files. Upon installing a mission in-game, a sub-folder is created and the pk4-file as well as the readme.txt, the description file, and any savegames belonging to this mission are saved there. If you open a mission pk4-file (e.g. the Training Mission or Tears of St. Lucia), you can see the folder structure used for fan missions. It contains folders like "maps", "textures", or "materials", that you need for custom assets in your mission. Create a folder for your new map in "fms" and name it accordingly (e.g. Tut). Create a sub-folder "maps" and open Dark Radiant. With File->Select Game... you can open a window to configure basic settings (this might open automatically when you start Dark Radiant for the first time). For "Select a Game" choose "The Dark Mod 2.0 (Standalone). For "Engine Path" browse to the root folder of your installation (e.g. C:/Darkmod). "Mod(fs_game)" is the path to your current FM (e.g. fms/Tut). This path is relative to the given "Engine Path". Now the editor will use resources you point to in this folder. Otherwise a pk4-package in the root folder would be needed. In order to have these new settings take effect, restart Dark Radiant. Save the blank file under fms/yourmapfolder/maps (e.g. fms/Tut/maps). Choose a short name for your mission as you will type it a lot in the game console.

== Your First Mission ==

Let's get started.

* Open Dark Radiant (hereinafter DR) and also open Dark Mod for quick testing.
* If you have a mission already open in DR then select File menu > New Map to clear it.
* Save it now as any suitable name. You might prefer to save later but I always do it immediately. All missions must go (with exceptions I will describe later in [[A - Z Beginner Full Guide Page 5#Managing your Mission Files|Managing your Mission Files]]) in the darkmod\maps folder or a folder within that. I urge you to create a new folder for each project within that maps folder. In this case:
# Open File Menu > Save As
# Make sure you are in the 'maps' folder.
# Select 'Create Folder' and type in say 'tutorial'. You might prefer 'Tut' or even 'T' because you have to keep typing it over and over in the Dark Mod console when testing!
# Select that folder
# Enter the name of your mission at the top.
* The game will be saved as a 'map' file with a .map suffix and is commonly called a 'map' in Doom circles. But I will use the term 'mission' or 'FM' (Fan Mission) or maybe 'game' for the map file to try to avoid confusion with actual 'city' or 'treasure' maps within the mission.

First, let's consider our rough storyline so we have some idea what to build...

== Story, Briefing ==

Formal mission objectives will be described much later in this tutorial. But before you begin your mission you will obviously need to have at least some idea of storyline and plot else you will have no idea what to build. You might have a detailed story or just some simple ideas which you can develop later.

Ultimately, you will need to brief the player with information about the story, characters, and the main purpose of the mission. It probably makes sense to write that fully when you are nearly finished the mission because new ideas or even technical difficulties might make you change your story. However, in this tutorial I'll describe it early so as you build the mission the layout and objects make sense.

Your briefing text should eventually be entered as described at [[Briefing]] but temporarily you might just write it in a plain text document for reference.

This mini tutorial mission is called 'Thief's Den' so here is an example briefing ('''not''' in correct format for the gui or .xd file):

"I had a nice haul the other night including a grand scepter from Lord Frothley. But a low-life named Creep who had given me the info, then stole it from ME! Never trust a thief I say. But I know where he lives...

I also still have his message in his own hand, giving the low-down. If I can dispose of Creep and drop the message nearby then he should take the heat for the heist diverting all suspicion from me.

Creep is a nasty piece of work who is handy with a blade. He can be dangerous and may be expecting me - may even have recruited a thug or two as back up - but he has badly underestimated my stealth skills..."

== Preparing to Build ==

When you open Dark Radiant it will default to a grid size (in the XYZ orthoview) of 8 units by 8 (changeable from version 0.9.5 onwards.) These [[Conversion of Game Units|units]] are 1.1 inches. Check your preference (default key P) in DR as it will be easier during this tutorial if you have the following checked (ticked) in Preferences > Orthoview...

* Show Grid
* Show Size Info
* Show Coordinates

'''Important:''' It is recommend you generally build with the grid set reasonably to a large size such as the default 8 or 16 for all walls, floors, etc. This makes alignment easier. You can reduce this in the grid menu for fine placement but don't leave it like that generally or you will have complexity problems. Snap to grid ([[Image:DRsnapGrid.jpg]], {{key|CTRL}}+{{key|G}}) will re-align a selection to the current grid size.

We'll mostly be working in the XYZ grid orthoview but if you have room for the camera view at the side so much the better. The camera view does a rough render in 3D (F3 toggles a better rendering with lighting etc but keep that off if it slows things down which it is likely to and just use it now and again.)

* Note the origin icon of the 'world' at 0,0,0 in the grid view
* Zoom in and out with the mouse wheel
* Right mouse drag the grid view to scroll around (zoom out further to scroll around faster)
* Use ''Change views'' tool ([[Image:DRnextViewBut.jpg]], {{key|CTRL}}+{{key|Tab}}) to toggle between top (XY), front (XZ), and side (YZ) views (you can open aditional windows using menu <tt>View > New XY view</tt>).

The blank windows in the grid and camera views can be regarded as empty void - the space in which we shall build. We have to build in bubbles sealed off from that void like an airtight spaceship or a submarine. Any gaps will cause leaks and crash your game so it's obviously the first major rule to learn: always build inner spaces sealed off from the outer void

Apart from special materials like water and weather, all the raw material you will use is 'solid' to form different shapes. So we can make panels and place them together to form lots of floating airtight boxes and these can be linked together. The entire game then takes place inside those boxes. One box can hold a tiny cupboard or an entire cathedral and a lot of boxes can hold a city. Inside those boxes you cannot see the void.

A shortcut to putting panels together is to make one solid block and hollow it out to form a box and this is what we are going to do now to form our first room.

== Making Your First Room ==

First we make a rough solid block...

* Select the top view (XY) in the grid view (toggle with [[Image:DRnextViewBut.jpg]]).
* Left mouse drag out a rectangle any few grid units across in the middle somewhere.
* This rectangle is called a 'brush' and used to define raw shapes for walls, floors etc.
* Left drag ''within'' that brush to drag the brush around
* Select the ''Resize'' tool ([[Image:DRdragResize.jpg]], {{key|Q}}).
* Now left drag ''outside'' that brush to resize it.

Now we adjust its top view area...

* Left drag outside that brush to resize it to 256 across left to right (X direction) by 192 up and down (Y direction in top view.) You should see those dimensions at the sides of the rectangle if you have 'Show Size Info' set in Edit > Preferences > Orthoview. The position of the top left corner is in brackets at top left.
* Left drag within the brush to move it so its sides fit on the bigger grid. If all sides don't fit then check your dimensions and that you are still in grid size 8 (see grid menu.)
* I prefer to build up in the top right corner from the world 0,0,0 so none of the values are negatives but you decide for yourself. Move it where you want but ideally so the sides are on the big grid.

Now we adjust its height to get our finished block (brush)...

* Use [[Image:DRnextViewBut.jpg]] ({{key|CTRL}}+{{key|Tab}}) to switch to side (YZ) or front (XZ) view and left drag outside the brush to change its height to 128
* Left drag inside the brush to move it up and down so its sides are on a big grid same as you did in the top view.
* You should now have brush 256 x 192 x 128 (see [[Conversion of Game Units#Tips|Unit Tips]])

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

== Selecting and DEselecting ==

We only have one item in our view but eventually many. Operations only work on what is currently selected. When you have just created something as we just have it is automatically the current selection and should be highlighted in your views (see DR Preferences for colour.)

* To DEselect it, point your mouse at it in either the grid or camera view and use {{key|SHIFT}}+{{key|ALT}}+{{LMB}} (or just press the {{key|Esc}} key.)
*To select it again, point your mouse at it and use {{key|SHIFT}}+{{key|ALT}}+{{LMB}} again.

Selecting is something you'll do a lot of so get familiar with that {{key|SHIFT}}+{{key|ALT}}+{{LMB}}. It's an exclusive select to get just one item. There are other selects I'll describe later. The {{key|Esc}} key always deselects and it is vitally important to get into the habit of DEselecting before you select or create something new or in some cases you will have multiple selections without knowing it and can delete or change something you didn't want to. This is why the {{key|SHIFT}}+{{key|ALT}}+{{LMB}} is the safest select as it is exclusive and will automatically DEselect anything else that was left selected. But it won't protect an item when creating. Yes, it is possible to have say a brush selected, forget it is selected, then create say, a new light. Oh! what happened to the brush? It's gone - replaced by the light. Develop a nervous habit of keep hitting {{key|Esc}} to deselect when you go to create!

From now on I'll use LMB, MMB, and RMB to refer to the mouse buttons.

== Camera View ==

You should be able to see this block in the camera view. If the camera view is just black remember {{key|F3}} toggles true light rendering and we don't yet have a light so hit {{key|F3}} to get a constant bright test light throughout. I won't go into details of all the camera controls suffice to say use the arrow keys and {{key|D}} and {{key|C}} to move vertically. But scroll down to 'camera' in [[Dark Radiant Controls, Keys & Mouse]] and you will see a fantastic amount of control you have in DR's camera view - especially with the mouse. It will take time to get used to them all so for now perhaps just learn enough to move around to see what you've done so far.

If you can see your block(brush) in the camera view then it is likely not to have any particular texture unless you were doing something before this tutorial. Close up you may see it is covered in a checkered blue 'shader not found' message. Don't worry if it's covered in something else like stone or wood though. Since it will eventually be hollowed out to form a room, let's paint it now with some material more suitable to the Dark Mod universe...

== Materials, Textures, Painting the Block ==

This is the tiny home of a cheap thief so we'll use some old stonework.

I've mentioned 'textures', 'shaders', and 'materials'; what do these terms mean? A 'material' or 'shader' is the properties of a surface, including (but not necessarily) texture, sound, and others. To 'paint' our block we...

* Select the Media Browser. This is one of the tabs on a panel. Pressing N or T hides/shows the whole panel but I guess most people leave the panel showing all the time and just select the tab they want.
* Allow a few seconds for DR to read in the media first time and then you should see 'textures' listed
* Click 'textures' and it opens up to show all available textures. Many of the ones you see are Doom textures. Scroll down and select 'darkmod' which reveals the ones most suitable for our use. Scroll down to stone, open it, then cobblestones and select blocks_mixed_multicolour. Right click it and select 'Apply to selection'. This covers all surfaces of the block because we have still got selected the whole block not just one surface. You should see this in the camera view. Use this throughout the house (and eventually on its outside surface for consistency.)
* Select the Texture Browser. This is one of the tabs on the same panel as Media Browser. The Texture Browser only shows recently used textures. You should see only the one texture you selected so it's handy for future use. Odds are you will want to re-use the same textures. It will also show other textures if you clicked on them in the media browser plus any others if you were using DR before this tutorial. You can also copy and paste textures onto single or multiple surfaces (see later.)
* Hover the mouse over the four little buttons at the top of the Texture Browser and read the text so you have some idea of what features are there for the future. For now, click on the one that says 'Flush and Reload Shaders' and it should clear all of them except the one we put on our brush. As we add others they will appear in the texture browser so you can get to them more quickly.
* Now, press S for Surface Inspector (or View menu)
* If you have only one face selected (more about this later) you can set Horiz and Vert scale. Value like 0.3 makes it harder for the player to see any pattern repetition (in this situation and in my opinion - use your own judgement with other textures and wall sizes.) In the mean time you can use arrow buttons to adjust the scale for the whole selected brush. Whatever scale you use, generally you should be consistent with it for the same texture wherever used in a mission. If you use copy and paste then it will transfer the scale as well which is far easier.
* There will be more on texture adjustment later in this tutorial.

== Hollowing out a Room from the Block ==

Building to a large grid size helps performance. The outside of our block will never be seen in the game. Once we hollow it out then the player will only see the inside so that is the surface that is rendered and that we need to align to the large grid. There are two tools to hollow out a block, both activated by a button on the left button bar: one called 'hollow' and the other 'room'. Don't use 'hollow' as it reduces the internal sides so they don't fit the big grid AND it overlaps the corners which can cause rendering errors like so....

<center>BAD!</center> 
<center>[[Image:AZhollow.jpg]]</center> 

Instead use the 'room' button which does the job right (note the increased size so the ''internal'' dimensions will be the same as our original block and align to the big grid... 

<center>GOOD!</center> 
<center>[[Image:AZroom.jpg]]</center> 

All brushes in Doom must be convex. They cannot have any inward angles (like an L shape which would have to be two brushes together) and cannot actually be hollow. The above tools really create new side panel brushes to replace the original brush. In the case of our six-sided block that is six new brushes positioned as walls, floor, and ceiling. ''The walls they create are one small grid line wide so their width will vary depending on your grid size setting.''

Examine the block in the camera view and zoom right inside so you can see it internally which is where it will be seen in game. Note the texture aligns nicely because we stuck to a big grid size. The stone is appropriate for all four walls (which is why I textured the whole block in one go rather than one surface at a time) but now we need different textures for floor and ceiling...

== Selecting and Texturing Individual Surfaces ==

'''You cannot select a surface in the grid view''' so move inside the room in the camera view.

'''To texture the floor...'''

* Press Esc to make sure everything is DEselected
* Point at the floor and use {{key|SHIFT}}+{{LMB}}. Repeat a few times and you will see it selects/DEselects the surface. Keep it selected.
* Select the Media Browser again (on the tabbed panel)
* In the darkmod section select say stone/cobblestones or maybe you would like some wood/boards/worn_01 ? You choose but something like carpet might need special alignment so stick with stones or boards maybe for now? Remember - RIGHT click the texture name and select 'Apply to Selection'
* Alternatively you can click on several possibles then select them with one LMB in the Texture Browser on the other tab. In the Texture Browser you can enlarge the textures if preferred to see them better.
* Esc to DEselect so you can see it better in camera view.

'''To texture the ceiling...'''

* Press Esc to make sure everything is DEselected
* Point at the ceiling and use {{key|SHIFT}}+{{LMB}} again to select its surface.
* Select the Media Browser again (on the tabbed panel)
* In the darkmod section select say plaster/plaster01 and apply it.

'''If you change your mind about the walls you can change them to something else...'''

* Press Esc to make sure everything is DEselected
* Point at one wall and use {{key|SHIFT}}+{{LMB}} again to select its surface.
* Point at another wall use {{key|SHIFT}}+{{LMB}} again so now both surfaces are selected
* 'Accidentally' select the ceiling. No problem. Just use {{key|SHIFT}}+{{LMB}} on it again to DEselect it but the walls are still selected. In this way you can select which surfaces you want to select.
* Select the Media Browser again and just apply another type of stone, perhaps brick, to the walls if you want or just leave it as it is.

Now press {{key|CTRL}}+{{key|S}} to resave the mission or use the File menu. Get into the habit of doing this often unless you have autosave set. Now and again you can also save with a new name so you can go back to an earlier one if you totally mess up. Note: There is also a backup file made automatically by DR.

== Adding the Player's Start Point ==

One more thing is ''essential'' to play this in Dark Mod and that is the Player's starting position.

* Press Esc to DEselect everything.
* In the TOP grid view, point the mouse in the middle of the room and RMB to get a pop up menu. This menu is important so glance at some of the other items on it while you're here. 'Entities' are special function items and the player start is amongst them but there is a shortcut on the menu so instead...
* Select "Create Player Start here" on the menu. This will create the playerstart entity (red box) and put it where you clicked. Drag the entity around to the point where you want the player to start.
* You should see an arrow on the red box indicating the way the player will face at the start. If you cannot see the arrow then menu <tt>View > Show > Show Angles</tt> will reveal it. You can rotate the player by selecting ''Rotate'' tool ([[Image:DRrotate.jpg]], {{key|R}}) and dragging with the mouse.
* Use {{key|CTRL}}+{{key|Tab}} to switch to the side view (YZ) and use LMB to drag the ''inside'' of the player start box so its base is on the floor of the room (you can also use ''Translate'' tool, [[Image:DRtranslate.jpg]], {{key|W}}). Make sure you do not go below or the floor or the player might be stuck with his feet in concrete! Tip: In Thief games it was common to start just dropping over a wall with this player start a few feet above the ground. You might note that entities do not directly resize like brushes so LMB dragging on the ''outside'' of the box does nothing (unless you have selected the ''Translate'' tool).
* RMB in the grid view again and you will see there is now a ''Move player start here'' option so you can quickly move its position while testing different areas of your mission. But always remember to check both the side and top view when moving things around, to make sure the vertical position is also valid. (Also note that ''Move player start here'' does not ''select'' the player start - you will need to select it if you need to adjust its position by dragging.)
* With the player start still selected you can select the Entity Inspector (on the panel, or {{key|N}} to hide/show it) and see the properties of your first entity.

The game could now be played but it will be totally dark so we need to create at least one light.....

== Creating a Light ==

* Press Esc to DEselect everything.
* In the TOP grid view, point the mouse in the ''middle'' of the room and RMB to get the pop up menu.
* Select "Create Light" on the menu.
* A large red box appears with diagonals representing the light's centre and its rough 'radius'. The default light is more like six pyramids pointing out to their peaks in the centre of each side of the box. This gives a rough impression of a sphere of light and helps performance.
* {{key|CTRL}}+{{key|TAB}} to get a side view and LMB drag ''right in the centre of the light'' to move it up/down to centre it in the room if it is not already. Just dragging inside the radius box won't move it - you have to point at the centre.

== Resizing a Light ==

Resizing a light is awkward because dragging any side moves the centre (this might be changed in a later Dark Radiant.) Two ways of dealing with this. Just roughly drag it about and keep moving the light back to where you want it. But if you have very precisely positioned a light then you don't want to have to keep doing that so this is what I do...

* Select the Entity Inspector on the panel
* You should see it has a light radius property with three values for XYZ for the three dimensions. They are north and south for Y, east and west for X, and up and down for Z. (those are the compass directions in game by the way.)
* Click on the light radius property to highlight it.
* Note that its values appear in a choice of inputs at the bottom - You can type new values in a line with a space in between then click the check(tick) button or enter them as separate values or even use the little scrolly buttons at the side and then click the Apply button.
* The room interior is 192 x 256 x 128 (in XYZ order) so give the light radius the values 200 260 133 so it protrudes outside the walls (we're setting radius - so the light diameter will be twice that size). We may well change this again later if we want the light to spill out through a doorway or something.
* You can now toggle light rendering in the preview using {{Key|F3}} (or an icon in the preview toolbar) to see how the light affects the walls.

The light radius is not just a cut-off point. It can be regarded as a 'fade to zero point'. What this means is that the light is at maximum brightness at its centre and fades to zero at the limit of the radius. So in a big open area, if you extend the radius you will 'stretch the brightness' further. Imagine the scale from max to min compacted in a small radius or expanded in a large one. More on this later when we place wall torches.

== Changing a Light's Brightness ==

The light may be a little bright. To change it...

* Press L (or View menu)* to call up the Light Inspector
* Click on the white rectangle button just below where it says 'Colour'
* The brightness value is called 'Lum:' (luminosity) and should default to 100. Reduce it to 90, by overtyping it or using the slider to the far right. It might not matter. I'm just showing you where the control is for now.
* Fool around with the colours if you want - there are extensive features I won't cover here.

Hey! We should have your first working mission! Do a {{key|CTRL}}+{{key|S}} to save it and then follow the next sections in Dark Mod itself not in Dark Radiant.....

== Sound ==

There is no need to do anything special about ''hearing'' sounds such as footsteps, collision sounds, etc. at this stage as it will work automatically. Adding custom sounds will be dealt with later.

== Pathfinding ==

Pathfinding data to tell the AI characters where they can move is created by dmap by default when compiling in the next section...

== Dmap: Compiling the Mission ==
* Your mission file cannot be played itself; it is simply the directions to create a game file. To do this...
* Start up The Dark Mod. From any Dark Mod menu go to the console. By default, the console is {{key|CTRL}}+{{key|ALT}}+{{key|~}} (US Keyboards) or {{key|CTRL}}+{{key|ALT}}+{{key|'}} (UK Keyboards). This key is the top left below Esc and to the left of "1" on all keyboards I believe. But most people set up a shortcut to just use the ~ (` in UK) on its own so:

For single key click to get the console:
In your desktop shortcut to Doom3.exe add this argument to its properties (right click shortcut): '''''+set com_allowConsole 1''''' so the target line would be something like:

'''''C:\Doom3\doom3.exe +set com_allowConsole 1'''''

(plus any other arguments you might want)
* In the console type and Enter dmap Tut/T001 where you should substitute your subfolder name for Tut and your mission filename for T001. So, if you created your mission file directly in the maps folder then you do not need a folder name and can put dmap T001. If you made a subfolder in maps called MyMaps and named your mission MissionImpossible999.map then enter dmap MyMaps/MissionImpossible999. I recommend you do not use upper case in filenames in Doom as I think it can cause problems on other platforms.
* Wait while dmap compiles the mission. This should only be a few seconds with this tiny mission but will be much longer for big missions.
* If you get a 'leaked' error or some other serious red warning then recheck your work; look for gaps in the wall or a wrong texture like nodraw or have you got an entity outside in the void? See [[Performance: Essential Must-Knows#How to detect and fix leaks|HERE]] for more about fixing leaks but at this stage of this tutorial it might be easier just to redo. What I have laboured over is basically make a block, texture it, hollow it, stick in a player start and a light. As you get more proficient you can do it in less than a minute.
* Assuming there were no dmap red "ERROR"s then you should be returned to the Dark Mod menus and are now able to play the mission.
* Return to the console.
* Type and Enter map Tut/T001. Tip: Press the up arrow key toggles back through the history of what you have typed before so your dmap should re-appear. Just press the Home key and delete the 'd'. An alternative is to use 'testmap' instead of dmap which does both dmap and map but I prefer to see dmap's results.
* You should now be able to walk around in the room. If you have a player shadow set then you might notice that walking through that light looks odd so keep that in mind for light placement. But most lights you will place close to a visible source like a gaslight or wall torch.

That's the first part done!

{{A-Z Beginner Guide TOC}}

{{tutorial-editing}}

A - Z Beginner Full Guide Start Here!

2017-03-01T21:03:02Z

Destined:

{{A-Z Beginner Guide TOC}}
'''''PLEASE NOTE: THIS GUIDE CONTAINS SPOILERS FOR THE "THIEF'S DEN" DEMO MISSION RELEASED JAN 18TH, 2008.'''''

== Introduction ==

Since writing this I've created a [[Startpack Mappers' Guide]] which is a ready made FM template with a set of ready made components to make it even easier to make a Dark Mod FM because it already includes things like objectives, briefing, readables, etc. etc and you just modify them and concentrate on building. However, I recommend you first follow this guide so you have some understanding of the basics and then the startpack will make more sense.

This is an easy guide for complete beginners to Dark Mod. It will lead you from start to finish, 'push that button, click that menu' and at the end you will have a fully working (but tiny) Dark Mod mission with all the main essential features including objectives all zipped up. You will be able to include variations of your own as you progress if you wish. Links to more detailed info is included but ignore those first time if you wish. Creating this mission is a learning process: although others will be able to play it, it will be too simple for that purpose - though it might be fun to see how varied the results might be from different players following the same instructions! When finished you can modify it and customise it to learn more or just shelve it for reference while you start your ''real'' mission!

This tutorial does not describe how to make your mission architecturally beautiful - just the opposite; the build may be as crude, quick, and ugly as you like. Nor does it advise how to design for good gameplay, etc. For that you should go to [[Mission Design Tips]] after you have mastered the basics. This is a ''method'' tutorial, not a ''design'' tutorial. Nor can it answer every question. It will merely present the most basic information for making a complete mission.

Feel free to experiment, add to, or even skip parts you already know or seem obvious, especially if you have a background producing Doom or Quake maps.

This guide was inspired by Komag's famous tutorial which helped a great many Dromeders (including myself) to get started producing Thief 2 FMs. If you are or were a Dromeder then you might first like to browse quickly through [[Dromed - Dark Mod Differences]] before proceeding - though it is not essential for this tutorial as I am trying to make few assumptions of prior knowledge. It will refer to default keys/mouse settings in Dard Radiant (editor - see later) so if you have changed any hot keys in Dark Radiant's help menu then keep that in mind. Also note that any screenshots might be in a different colour to your settings of course.

== Installation ==

This tutorial assumes that you have Dark Mod already installed. If not, please refer to [http://www.thedarkmod.com The Dark Mod] website for information.

Alternatively you can use the limited Dark Mod resources provided by the pre-release demo mission [[Thief's Den]]

== The Dark Mod Editor ==

To edit Dark Mod missions you will need a game editor. '''This tutorial is based on the [[Dark Radiant]] editor''' (hereinafter may be called DR) but you can possibly follow most of it in other editors like DoomEd. Variations might be shown where possible but it will mainly assume Dark Radiant. If you haven't got Dark Radiant yet, consult the [[Dark Radiant]] sections, install it and set it up how you like it. If you want to use DoomEd then you need to look elsewhere first. DoomEd of course is supplied with Doom.

You might wish to open the [[Dark Radiant Controls, Keys & Mouse|DR Controls]] page in a new window in your web browser for quick reference while following this tutorial. I'll try to make it so you don't need to!

Make sure you can run Dark Mod and your editor before proceeding. In particular remember you can undo your last step(s) (edit menu or {{key|CTRL}}+{{key|Z}})

== Folder Structure [Added by Destined]

All main resources and executables are stored in the TDM root folder (this is where you have installed The Dark Mod, e.g. C:/Darkmod). The recources are stored in pk4-files. These are simply renamed zip-files and can be opened with any common unpacking program like Winzip, Winrar or 7zip. The "maps" folder is where Dark Radiant saves maps by default. All fan missions are stored in the "fms" folder as pk4-files. Upon installing a mission in-game, a sub-folder is created and the pk4-file as well as the readme.txt, the description file, and any savegames belonging to this mission are saved there. If you open a mission pk4-file (e.g. the Training Mission or Tears of St. Lucia), you can see the folder structure used for fan missions. It contains folders like "maps", "textures", or "materials", that you need for custom assets in your mission. Create a folder for your new map in "fms" and name it accordingly (e.g. Tut). Create a sub-folder "maps" and open Dark Radiant. With File->Select Game... you can open a window to configure basic settings (this might open automatically when you start Dark Radiant for the first time). For "Select a Game" choose "The Dark Mod 2.0 (Standalone). For "Engine Path" browse to the root folder of your installation (e.g. C:/Darkmod). "Mod(fs_game)" is the path to your current FM (e.g. fms/Tut). This path is relative to the given "Engine Path". Now the editor will use resources you point to in this folder. Otherwise a pk4-package in the root folder would be needed. In order to have these new settings take effect, restart Dark Radiant. Save the blank file under fms/yourmapfolder/maps (e.g. fms/Tut/maps). Choose a short name for your mission as you will type it a lot in the game console.

== Your First Mission ==

Let's get started.

* Open Dark Radiant (hereinafter DR) and also open Dark Mod for quick testing.
* If you have a mission already open in DR then select File menu > New Map to clear it.
* Save it now as any suitable name. You might prefer to save later but I always do it immediately. All missions must go (with exceptions I will describe later in [[A - Z Beginner Full Guide Page 5#Managing your Mission Files|Managing your Mission Files]]) in the darkmod\maps folder or a folder within that. I urge you to create a new folder for each project within that maps folder. In this case:
# Open File Menu > Save As
# Make sure you are in the 'maps' folder.
# Select 'Create Folder' and type in say 'tutorial'. You might prefer 'Tut' or even 'T' because you have to keep typing it over and over in the Dark Mod console when testing!
# Select that folder
# Enter the name of your mission at the top.
* The game will be saved as a 'map' file with a .map suffix and is commonly called a 'map' in Doom circles. But I will use the term 'mission' or 'FM' (Fan Mission) or maybe 'game' for the map file to try to avoid confusion with actual 'city' or 'treasure' maps within the mission.

First, let's consider our rough storyline so we have some idea what to build...

== Story, Briefing ==

Formal mission objectives will be described much later in this tutorial. But before you begin your mission you will obviously need to have at least some idea of storyline and plot else you will have no idea what to build. You might have a detailed story or just some simple ideas which you can develop later.

Ultimately, you will need to brief the player with information about the story, characters, and the main purpose of the mission. It probably makes sense to write that fully when you are nearly finished the mission because new ideas or even technical difficulties might make you change your story. However, in this tutorial I'll describe it early so as you build the mission the layout and objects make sense.

Your briefing text should eventually be entered as described at [[Briefing]] but temporarily you might just write it in a plain text document for reference.

This mini tutorial mission is called 'Thief's Den' so here is an example briefing ('''not''' in correct format for the gui or .xd file):

"I had a nice haul the other night including a grand scepter from Lord Frothley. But a low-life named Creep who had given me the info, then stole it from ME! Never trust a thief I say. But I know where he lives...

I also still have his message in his own hand, giving the low-down. If I can dispose of Creep and drop the message nearby then he should take the heat for the heist diverting all suspicion from me.

Creep is a nasty piece of work who is handy with a blade. He can be dangerous and may be expecting me - may even have recruited a thug or two as back up - but he has badly underestimated my stealth skills..."

== Preparing to Build ==

When you open Dark Radiant it will default to a grid size (in the XYZ orthoview) of 8 units by 8 (changeable from version 0.9.5 onwards.) These [[Conversion of Game Units|units]] are 1.1 inches. Check your preference (default key P) in DR as it will be easier during this tutorial if you have the following checked (ticked) in Preferences > Orthoview...

* Show Grid
* Show Size Info
* Show Coordinates

'''Important:''' It is recommend you generally build with the grid set reasonably to a large size such as the default 8 or 16 for all walls, floors, etc. This makes alignment easier. You can reduce this in the grid menu for fine placement but don't leave it like that generally or you will have complexity problems. Snap to grid ([[Image:DRsnapGrid.jpg]], {{key|CTRL}}+{{key|G}}) will re-align a selection to the current grid size.

We'll mostly be working in the XYZ grid orthoview but if you have room for the camera view at the side so much the better. The camera view does a rough render in 3D (F3 toggles a better rendering with lighting etc but keep that off if it slows things down which it is likely to and just use it now and again.)

* Note the origin icon of the 'world' at 0,0,0 in the grid view
* Zoom in and out with the mouse wheel
* Right mouse drag the grid view to scroll around (zoom out further to scroll around faster)
* Use ''Change views'' tool ([[Image:DRnextViewBut.jpg]], {{key|CTRL}}+{{key|Tab}}) to toggle between top (XY), front (XZ), and side (YZ) views (you can open aditional windows using menu <tt>View > New XY view</tt>).

The blank windows in the grid and camera views can be regarded as empty void - the space in which we shall build. We have to build in bubbles sealed off from that void like an airtight spaceship or a submarine. Any gaps will cause leaks and crash your game so it's obviously the first major rule to learn: always build inner spaces sealed off from the outer void

Apart from special materials like water and weather, all the raw material you will use is 'solid' to form different shapes. So we can make panels and place them together to form lots of floating airtight boxes and these can be linked together. The entire game then takes place inside those boxes. One box can hold a tiny cupboard or an entire cathedral and a lot of boxes can hold a city. Inside those boxes you cannot see the void.

A shortcut to putting panels together is to make one solid block and hollow it out to form a box and this is what we are going to do now to form our first room.

== Making Your First Room ==

First we make a rough solid block...

* Select the top view (XY) in the grid view (toggle with [[Image:DRnextViewBut.jpg]]).
* Left mouse drag out a rectangle any few grid units across in the middle somewhere.
* This rectangle is called a 'brush' and used to define raw shapes for walls, floors etc.
* Left drag ''within'' that brush to drag the brush around
* Select the ''Resize'' tool ([[Image:DRdragResize.jpg]], {{key|Q}}).
* Now left drag ''outside'' that brush to resize it.

Now we adjust its top view area...

* Left drag outside that brush to resize it to 256 across left to right (X direction) by 192 up and down (Y direction in top view.) You should see those dimensions at the sides of the rectangle if you have 'Show Size Info' set in Edit > Preferences > Orthoview. The position of the top left corner is in brackets at top left.
* Left drag within the brush to move it so its sides fit on the bigger grid. If all sides don't fit then check your dimensions and that you are still in grid size 8 (see grid menu.)
* I prefer to build up in the top right corner from the world 0,0,0 so none of the values are negatives but you decide for yourself. Move it where you want but ideally so the sides are on the big grid.

Now we adjust its height to get our finished block (brush)...

* Use [[Image:DRnextViewBut.jpg]] ({{key|CTRL}}+{{key|Tab}}) to switch to side (YZ) or front (XZ) view and left drag outside the brush to change its height to 128
* Left drag inside the brush to move it up and down so its sides are on a big grid same as you did in the top view.
* You should now have brush 256 x 192 x 128 (see [[Conversion of Game Units#Tips|Unit Tips]])

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

== Selecting and DEselecting ==

We only have one item in our view but eventually many. Operations only work on what is currently selected. When you have just created something as we just have it is automatically the current selection and should be highlighted in your views (see DR Preferences for colour.)

* To DEselect it, point your mouse at it in either the grid or camera view and use {{key|SHIFT}}+{{key|ALT}}+{{LMB}} (or just press the {{key|Esc}} key.)
*To select it again, point your mouse at it and use {{key|SHIFT}}+{{key|ALT}}+{{LMB}} again.

Selecting is something you'll do a lot of so get familiar with that {{key|SHIFT}}+{{key|ALT}}+{{LMB}}. It's an exclusive select to get just one item. There are other selects I'll describe later. The {{key|Esc}} key always deselects and it is vitally important to get into the habit of DEselecting before you select or create something new or in some cases you will have multiple selections without knowing it and can delete or change something you didn't want to. This is why the {{key|SHIFT}}+{{key|ALT}}+{{LMB}} is the safest select as it is exclusive and will automatically DEselect anything else that was left selected. But it won't protect an item when creating. Yes, it is possible to have say a brush selected, forget it is selected, then create say, a new light. Oh! what happened to the brush? It's gone - replaced by the light. Develop a nervous habit of keep hitting {{key|Esc}} to deselect when you go to create!

From now on I'll use LMB, MMB, and RMB to refer to the mouse buttons.

== Camera View ==

You should be able to see this block in the camera view. If the camera view is just black remember {{key|F3}} toggles true light rendering and we don't yet have a light so hit {{key|F3}} to get a constant bright test light throughout. I won't go into details of all the camera controls suffice to say use the arrow keys and {{key|D}} and {{key|C}} to move vertically. But scroll down to 'camera' in [[Dark Radiant Controls, Keys & Mouse]] and you will see a fantastic amount of control you have in DR's camera view - especially with the mouse. It will take time to get used to them all so for now perhaps just learn enough to move around to see what you've done so far.

If you can see your block(brush) in the camera view then it is likely not to have any particular texture unless you were doing something before this tutorial. Close up you may see it is covered in a checkered blue 'shader not found' message. Don't worry if it's covered in something else like stone or wood though. Since it will eventually be hollowed out to form a room, let's paint it now with some material more suitable to the Dark Mod universe...

== Materials, Textures, Painting the Block ==

This is the tiny home of a cheap thief so we'll use some old stonework.

I've mentioned 'textures', 'shaders', and 'materials'; what do these terms mean? A 'material' or 'shader' is the properties of a surface, including (but not necessarily) texture, sound, and others. To 'paint' our block we...

* Select the Media Browser. This is one of the tabs on a panel. Pressing N or T hides/shows the whole panel but I guess most people leave the panel showing all the time and just select the tab they want.
* Allow a few seconds for DR to read in the media first time and then you should see 'textures' listed
* Click 'textures' and it opens up to show all available textures. Many of the ones you see are Doom textures. Scroll down and select 'darkmod' which reveals the ones most suitable for our use. Scroll down to stone, open it, then cobblestones and select blocks_mixed_multicolour. Right click it and select 'Apply to selection'. This covers all surfaces of the block because we have still got selected the whole block not just one surface. You should see this in the camera view. Use this throughout the house (and eventually on its outside surface for consistency.)
* Select the Texture Browser. This is one of the tabs on the same panel as Media Browser. The Texture Browser only shows recently used textures. You should see only the one texture you selected so it's handy for future use. Odds are you will want to re-use the same textures. It will also show other textures if you clicked on them in the media browser plus any others if you were using DR before this tutorial. You can also copy and paste textures onto single or multiple surfaces (see later.)
* Hover the mouse over the four little buttons at the top of the Texture Browser and read the text so you have some idea of what features are there for the future. For now, click on the one that says 'Flush and Reload Shaders' and it should clear all of them except the one we put on our brush. As we add others they will appear in the texture browser so you can get to them more quickly.
* Now, press S for Surface Inspector (or View menu)
* If you have only one face selected (more about this later) you can set Horiz and Vert scale. Value like 0.3 makes it harder for the player to see any pattern repetition (in this situation and in my opinion - use your own judgement with other textures and wall sizes.) In the mean time you can use arrow buttons to adjust the scale for the whole selected brush. Whatever scale you use, generally you should be consistent with it for the same texture wherever used in a mission. If you use copy and paste then it will transfer the scale as well which is far easier.
* There will be more on texture adjustment later in this tutorial.

== Hollowing out a Room from the Block ==

Building to a large grid size helps performance. The outside of our block will never be seen in the game. Once we hollow it out then the player will only see the inside so that is the surface that is rendered and that we need to align to the large grid. There are two tools to hollow out a block, both activated by a button on the left button bar: one called 'hollow' and the other 'room'. Don't use 'hollow' as it reduces the internal sides so they don't fit the big grid AND it overlaps the corners which can cause rendering errors like so....

<center>BAD!</center> 
<center>[[Image:AZhollow.jpg]]</center> 

Instead use the 'room' button which does the job right (note the increased size so the ''internal'' dimensions will be the same as our original block and align to the big grid... 

<center>GOOD!</center> 
<center>[[Image:AZroom.jpg]]</center> 

All brushes in Doom must be convex. They cannot have any inward angles (like an L shape which would have to be two brushes together) and cannot actually be hollow. The above tools really create new side panel brushes to replace the original brush. In the case of our six-sided block that is six new brushes positioned as walls, floor, and ceiling. ''The walls they create are one small grid line wide so their width will vary depending on your grid size setting.''

Examine the block in the camera view and zoom right inside so you can see it internally which is where it will be seen in game. Note the texture aligns nicely because we stuck to a big grid size. The stone is appropriate for all four walls (which is why I textured the whole block in one go rather than one surface at a time) but now we need different textures for floor and ceiling...

== Selecting and Texturing Individual Surfaces ==

'''You cannot select a surface in the grid view''' so move inside the room in the camera view.

'''To texture the floor...'''

* Press Esc to make sure everything is DEselected
* Point at the floor and use {{key|SHIFT}}+{{LMB}}. Repeat a few times and you will see it selects/DEselects the surface. Keep it selected.
* Select the Media Browser again (on the tabbed panel)
* In the darkmod section select say stone/cobblestones or maybe you would like some wood/boards/worn_01 ? You choose but something like carpet might need special alignment so stick with stones or boards maybe for now? Remember - RIGHT click the texture name and select 'Apply to Selection'
* Alternatively you can click on several possibles then select them with one LMB in the Texture Browser on the other tab. In the Texture Browser you can enlarge the textures if preferred to see them better.
* Esc to DEselect so you can see it better in camera view.

'''To texture the ceiling...'''

* Press Esc to make sure everything is DEselected
* Point at the ceiling and use {{key|SHIFT}}+{{LMB}} again to select its surface.
* Select the Media Browser again (on the tabbed panel)
* In the darkmod section select say plaster/plaster01 and apply it.

'''If you change your mind about the walls you can change them to something else...'''

* Press Esc to make sure everything is DEselected
* Point at one wall and use {{key|SHIFT}}+{{LMB}} again to select its surface.
* Point at another wall use {{key|SHIFT}}+{{LMB}} again so now both surfaces are selected
* 'Accidentally' select the ceiling. No problem. Just use {{key|SHIFT}}+{{LMB}} on it again to DEselect it but the walls are still selected. In this way you can select which surfaces you want to select.
* Select the Media Browser again and just apply another type of stone, perhaps brick, to the walls if you want or just leave it as it is.

Now press {{key|CTRL}}+{{key|S}} to resave the mission or use the File menu. Get into the habit of doing this often unless you have autosave set. Now and again you can also save with a new name so you can go back to an earlier one if you totally mess up. Note: There is also a backup file made automatically by DR.

== Adding the Player's Start Point ==

One more thing is ''essential'' to play this in Dark Mod and that is the Player's starting position.

* Press Esc to DEselect everything.
* In the TOP grid view, point the mouse in the middle of the room and RMB to get a pop up menu. This menu is important so glance at some of the other items on it while you're here. 'Entities' are special function items and the player start is amongst them but there is a shortcut on the menu so instead...
* Select "Create Player Start here" on the menu. This will create the playerstart entity (red box) and put it where you clicked. Drag the entity around to the point where you want the player to start.
* You should see an arrow on the red box indicating the way the player will face at the start. If you cannot see the arrow then menu <tt>View > Show > Show Angles</tt> will reveal it. You can rotate the player by selecting ''Rotate'' tool ([[Image:DRrotate.jpg]], {{key|R}}) and dragging with the mouse.
* Use {{key|CTRL}}+{{key|Tab}} to switch to the side view (YZ) and use LMB to drag the ''inside'' of the player start box so its base is on the floor of the room (you can also use ''Translate'' tool, [[Image:DRtranslate.jpg]], {{key|W}}). Make sure you do not go below or the floor or the player might be stuck with his feet in concrete! Tip: In Thief games it was common to start just dropping over a wall with this player start a few feet above the ground. You might note that entities do not directly resize like brushes so LMB dragging on the ''outside'' of the box does nothing (unless you have selected the ''Translate'' tool).
* RMB in the grid view again and you will see there is now a ''Move player start here'' option so you can quickly move its position while testing different areas of your mission. But always remember to check both the side and top view when moving things around, to make sure the vertical position is also valid. (Also note that ''Move player start here'' does not ''select'' the player start - you will need to select it if you need to adjust its position by dragging.)
* With the player start still selected you can select the Entity Inspector (on the panel, or {{key|N}} to hide/show it) and see the properties of your first entity.

The game could now be played but it will be totally dark so we need to create at least one light.....

== Creating a Light ==

* Press Esc to DEselect everything.
* In the TOP grid view, point the mouse in the ''middle'' of the room and RMB to get the pop up menu.
* Select "Create Light" on the menu.
* A large red box appears with diagonals representing the light's centre and its rough 'radius'. The default light is more like six pyramids pointing out to their peaks in the centre of each side of the box. This gives a rough impression of a sphere of light and helps performance.
* {{key|CTRL}}+{{key|TAB}} to get a side view and LMB drag ''right in the centre of the light'' to move it up/down to centre it in the room if it is not already. Just dragging inside the radius box won't move it - you have to point at the centre.

== Resizing a Light ==

Resizing a light is awkward because dragging any side moves the centre (this might be changed in a later Dark Radiant.) Two ways of dealing with this. Just roughly drag it about and keep moving the light back to where you want it. But if you have very precisely positioned a light then you don't want to have to keep doing that so this is what I do...

* Select the Entity Inspector on the panel
* You should see it has a light radius property with three values for XYZ for the three dimensions. They are north and south for Y, east and west for X, and up and down for Z. (those are the compass directions in game by the way.)
* Click on the light radius property to highlight it.
* Note that its values appear in a choice of inputs at the bottom - You can type new values in a line with a space in between then click the check(tick) button or enter them as separate values or even use the little scrolly buttons at the side and then click the Apply button.
* The room interior is 192 x 256 x 128 (in XYZ order) so give the light radius the values 200 260 133 so it protrudes outside the walls (we're setting radius - so the light diameter will be twice that size). We may well change this again later if we want the light to spill out through a doorway or something.
* You can now toggle light rendering in the preview using {{Key|F3}} (or an icon in the preview toolbar) to see how the light affects the walls.

The light radius is not just a cut-off point. It can be regarded as a 'fade to zero point'. What this means is that the light is at maximum brightness at its centre and fades to zero at the limit of the radius. So in a big open area, if you extend the radius you will 'stretch the brightness' further. Imagine the scale from max to min compacted in a small radius or expanded in a large one. More on this later when we place wall torches.

== Changing a Light's Brightness ==

The light may be a little bright. To change it...

* Press L (or View menu)* to call up the Light Inspector
* Click on the white rectangle button just below where it says 'Colour'
* The brightness value is called 'Lum:' (luminosity) and should default to 100. Reduce it to 90, by overtyping it or using the slider to the far right. It might not matter. I'm just showing you where the control is for now.
* Fool around with the colours if you want - there are extensive features I won't cover here.

Hey! We should have your first working mission! Do a {{key|CTRL}}+{{key|S}} to save it and then follow the next sections in Dark Mod itself not in Dark Radiant.....

== Sound ==

There is no need to do anything special about ''hearing'' sounds such as footsteps, collision sounds, etc. at this stage as it will work automatically. Adding custom sounds will be dealt with later.

== Pathfinding ==

Pathfinding data to tell the AI characters where they can move is created by dmap by default when compiling in the next section...

== Dmap: Compiling the Mission ==
* Your mission file cannot be played itself; it is simply the directions to create a game file. To do this...
* Start up The Dark Mod. From any Dark Mod menu go to the console. By default, the console is {{key|CTRL}}+{{key|ALT}}+{{key|~}} (US Keyboards) or {{key|CTRL}}+{{key|ALT}}+{{key|'}} (UK Keyboards). This key is the top left below Esc and to the left of "1" on all keyboards I believe. But most people set up a shortcut to just use the ~ (` in UK) on its own so:

For single key click to get the console:
In your desktop shortcut to Doom3.exe add this argument to its properties (right click shortcut): '''''+set com_allowConsole 1''''' so the target line would be something like:

'''''C:\Doom3\doom3.exe +set com_allowConsole 1'''''

(plus any other arguments you might want)
* In the console type and Enter dmap Tut/T001 where you should substitute your subfolder name for Tut and your mission filename for T001. So, if you created your mission file directly in the maps folder then you do not need a folder name and can put dmap T001. If you made a subfolder in maps called MyMaps and named your mission MissionImpossible999.map then enter dmap MyMaps/MissionImpossible999. I recommend you do not use upper case in filenames in Doom as I think it can cause problems on other platforms.
* Wait while dmap compiles the mission. This should only be a few seconds with this tiny mission but will be much longer for big missions.
* If you get a 'leaked' error or some other serious red warning then recheck your work; look for gaps in the wall or a wrong texture like nodraw or have you got an entity outside in the void? See [[Performance: Essential Must-Knows#How to detect and fix leaks|HERE]] for more about fixing leaks but at this stage of this tutorial it might be easier just to redo. What I have laboured over is basically make a block, texture it, hollow it, stick in a player start and a light. As you get more proficient you can do it in less than a minute.
* Assuming there were no dmap red "ERROR"s then you should be returned to the Dark Mod menus and are now able to play the mission.
* Return to the console.
* Type and Enter map Tut/T001. Tip: Press the up arrow key toggles back through the history of what you have typed before so your dmap should re-appear. Just press the Home key and delete the 'd'. An alternative is to use 'testmap' instead of dmap which does both dmap and map but I prefer to see dmap's results.
* You should now be able to walk around in the room. If you have a player shadow set then you might notice that walking through that light looks odd so keep that in mind for light placement. But most lights you will place close to a visible source like a gaslight or wall torch.

That's the first part done!

{{A-Z Beginner Guide TOC}}

{{tutorial-editing}}

A - Z Beginner Full Guide Start Here!

2017-03-01T19:58:20Z

Destined:

{{A-Z Beginner Guide TOC}}
'''''PLEASE NOTE: THIS GUIDE CONTAINS SPOILERS FOR THE "THIEF'S DEN" DEMO MISSION RELEASED JAN 18TH, 2008.'''''

== Introduction ==

Since writing this I've created a [[Startpack Mappers' Guide]] which is a ready made FM template with a set of ready made components to make it even easier to make a Dark Mod FM because it already includes things like objectives, briefing, readables, etc. etc and you just modify them and concentrate on building. However, I recommend you first follow this guide so you have some understanding of the basics and then the startpack will make more sense.

This is an easy guide for complete beginners to Dark Mod. It will lead you from start to finish, 'push that button, click that menu' and at the end you will have a fully working (but tiny) Dark Mod mission with all the main essential features including objectives all zipped up. You will be able to include variations of your own as you progress if you wish. Links to more detailed info is included but ignore those first time if you wish. Creating this mission is a learning process: although others will be able to play it, it will be too simple for that purpose - though it might be fun to see how varied the results might be from different players following the same instructions! When finished you can modify it and customise it to learn more or just shelve it for reference while you start your ''real'' mission!

This tutorial does not describe how to make your mission architecturally beautiful - just the opposite; the build may be as crude, quick, and ugly as you like. Nor does it advise how to design for good gameplay, etc. For that you should go to [[Mission Design Tips]] after you have mastered the basics. This is a ''method'' tutorial, not a ''design'' tutorial. Nor can it answer every question. It will merely present the most basic information for making a complete mission.

Feel free to experiment, add to, or even skip parts you already know or seem obvious, especially if you have a background producing Doom or Quake maps.

This guide was inspired by Komag's famous tutorial which helped a great many Dromeders (including myself) to get started producing Thief 2 FMs. If you are or were a Dromeder then you might first like to browse quickly through [[Dromed - Dark Mod Differences]] before proceeding - though it is not essential for this tutorial as I am trying to make few assumptions of prior knowledge. It will refer to default keys/mouse settings in Dard Radiant (editor - see later) so if you have changed any hot keys in Dark Radiant's help menu then keep that in mind. Also note that any screenshots might be in a different colour to your settings of course.

== Installation ==

This tutorial assumes that you have Dark Mod already installed. If not, please refer to [http://www.thedarkmod.com The Dark Mod] website for information.

Alternatively you can use the limited Dark Mod resources provided by the pre-release demo mission [[Thief's Den]]

== The Dark Mod Editor ==

To edit Dark Mod missions you will need a game editor. '''This tutorial is based on the [[Dark Radiant]] editor''' (hereinafter may be called DR) but you can possibly follow most of it in other editors like DoomEd. Variations might be shown where possible but it will mainly assume Dark Radiant. If you haven't got Dark Radiant yet, consult the [[Dark Radiant]] sections, install it and set it up how you like it. If you want to use DoomEd then you need to look elsewhere first. DoomEd of course is supplied with Doom.

You might wish to open the [[Dark Radiant Controls, Keys & Mouse|DR Controls]] page in a new window in your web browser for quick reference while following this tutorial. I'll try to make it so you don't need to!

Make sure you can run Dark Mod and your editor before proceeding. In particular remember you can undo your last step(s) (edit menu or {{key|CTRL}}+{{key|Z}})

== Your First Mission ==

Let's get started.

* Open Dark Radiant (hereinafter DR) and also open Dark Mod for quick testing.
* If you have a mission already open in DR then select File menu > New Map to clear it.
* Save it now as any suitable name. You might prefer to save later but I always do it immediately. All missions must go (with exceptions I will describe later in [[A - Z Beginner Full Guide Page 5#Managing your Mission Files|Managing your Mission Files]]) in the darkmod\maps folder or a folder within that. I urge you to create a new folder for each project within that maps folder. In this case:
# Open File Menu > Save As
# Make sure you are in the 'maps' folder.
# Select 'Create Folder' and type in say 'tutorial'. You might prefer 'Tut' or even 'T' because you have to keep typing it over and over in the Dark Mod console when testing!
# Select that folder
# Enter the name of your mission at the top.
* The game will be saved as a 'map' file with a .map suffix and is commonly called a 'map' in Doom circles. But I will use the term 'mission' or 'FM' (Fan Mission) or maybe 'game' for the map file to try to avoid confusion with actual 'city' or 'treasure' maps within the mission.

First, let's consider our rough storyline so we have some idea what to build...

== Story, Briefing ==

Formal mission objectives will be described much later in this tutorial. But before you begin your mission you will obviously need to have at least some idea of storyline and plot else you will have no idea what to build. You might have a detailed story or just some simple ideas which you can develop later.

Ultimately, you will need to brief the player with information about the story, characters, and the main purpose of the mission. It probably makes sense to write that fully when you are nearly finished the mission because new ideas or even technical difficulties might make you change your story. However, in this tutorial I'll describe it early so as you build the mission the layout and objects make sense.

Your briefing text should eventually be entered as described at [[Briefing]] but temporarily you might just write it in a plain text document for reference.

This mini tutorial mission is called 'Thief's Den' so here is an example briefing ('''not''' in correct format for the gui or .xd file):

"I had a nice haul the other night including a grand scepter from Lord Frothley. But a low-life named Creep who had given me the info, then stole it from ME! Never trust a thief I say. But I know where he lives...

I also still have his message in his own hand, giving the low-down. If I can dispose of Creep and drop the message nearby then he should take the heat for the heist diverting all suspicion from me.

Creep is a nasty piece of work who is handy with a blade. He can be dangerous and may be expecting me - may even have recruited a thug or two as back up - but he has badly underestimated my stealth skills..."

== Preparing to Build ==

When you open Dark Radiant it will default to a grid size (in the XYZ orthoview) of 8 units by 8 (changeable from version 0.9.5 onwards.) These [[Conversion of Game Units|units]] are 1.1 inches. Check your preference (default key P) in DR as it will be easier during this tutorial if you have the following checked (ticked) in Preferences > Orthoview...

* Show Grid
* Show Size Info
* Show Coordinates

'''Important:''' It is recommend you generally build with the grid set reasonably to a large size such as the default 8 or 16 for all walls, floors, etc. This makes alignment easier. You can reduce this in the grid menu for fine placement but don't leave it like that generally or you will have complexity problems. Snap to grid ([[Image:DRsnapGrid.jpg]], {{key|CTRL}}+{{key|G}}) will re-align a selection to the current grid size.

We'll mostly be working in the XYZ grid orthoview but if you have room for the camera view at the side so much the better. The camera view does a rough render in 3D (F3 toggles a better rendering with lighting etc but keep that off if it slows things down which it is likely to and just use it now and again.)

* Note the origin icon of the 'world' at 0,0,0 in the grid view
* Zoom in and out with the mouse wheel
* Right mouse drag the grid view to scroll around (zoom out further to scroll around faster)
* Use ''Change views'' tool ([[Image:DRnextViewBut.jpg]], {{key|CTRL}}+{{key|Tab}}) to toggle between top (XY), front (XZ), and side (YZ) views (you can open aditional windows using menu <tt>View > New XY view</tt>).

The blank windows in the grid and camera views can be regarded as empty void - the space in which we shall build. We have to build in bubbles sealed off from that void like an airtight spaceship or a submarine. Any gaps will cause leaks and crash your game so it's obviously the first major rule to learn: always build inner spaces sealed off from the outer void

Apart from special materials like water and weather, all the raw material you will use is 'solid' to form different shapes. So we can make panels and place them together to form lots of floating airtight boxes and these can be linked together. The entire game then takes place inside those boxes. One box can hold a tiny cupboard or an entire cathedral and a lot of boxes can hold a city. Inside those boxes you cannot see the void.

A shortcut to putting panels together is to make one solid block and hollow it out to form a box and this is what we are going to do now to form our first room.

== Making Your First Room ==

First we make a rough solid block...

* Select the top view (XY) in the grid view (toggle with [[Image:DRnextViewBut.jpg]]).
* Left mouse drag out a rectangle any few grid units across in the middle somewhere.
* This rectangle is called a 'brush' and used to define raw shapes for walls, floors etc.
* Left drag ''within'' that brush to drag the brush around
* Select the ''Resize'' tool ([[Image:DRdragResize.jpg]], {{key|Q}}).
* Now left drag ''outside'' that brush to resize it.

Now we adjust its top view area...

* Left drag outside that brush to resize it to 256 across left to right (X direction) by 192 up and down (Y direction in top view.) You should see those dimensions at the sides of the rectangle if you have 'Show Size Info' set in Edit > Preferences > Orthoview. The position of the top left corner is in brackets at top left.
* Left drag within the brush to move it so its sides fit on the bigger grid. If all sides don't fit then check your dimensions and that you are still in grid size 8 (see grid menu.)
* I prefer to build up in the top right corner from the world 0,0,0 so none of the values are negatives but you decide for yourself. Move it where you want but ideally so the sides are on the big grid.

Now we adjust its height to get our finished block (brush)...

* Use [[Image:DRnextViewBut.jpg]] ({{key|CTRL}}+{{key|Tab}}) to switch to side (YZ) or front (XZ) view and left drag outside the brush to change its height to 128
* Left drag inside the brush to move it up and down so its sides are on a big grid same as you did in the top view.
* You should now have brush 256 x 192 x 128 (see [[Conversion of Game Units#Tips|Unit Tips]])

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

== Selecting and DEselecting ==

We only have one item in our view but eventually many. Operations only work on what is currently selected. When you have just created something as we just have it is automatically the current selection and should be highlighted in your views (see DR Preferences for colour.)

* To DEselect it, point your mouse at it in either the grid or camera view and use {{key|SHIFT}}+{{key|ALT}}+{{LMB}} (or just press the {{key|Esc}} key.)
*To select it again, point your mouse at it and use {{key|SHIFT}}+{{key|ALT}}+{{LMB}} again.

Selecting is something you'll do a lot of so get familiar with that {{key|SHIFT}}+{{key|ALT}}+{{LMB}}. It's an exclusive select to get just one item. There are other selects I'll describe later. The {{key|Esc}} key always deselects and it is vitally important to get into the habit of DEselecting before you select or create something new or in some cases you will have multiple selections without knowing it and can delete or change something you didn't want to. This is why the {{key|SHIFT}}+{{key|ALT}}+{{LMB}} is the safest select as it is exclusive and will automatically DEselect anything else that was left selected. But it won't protect an item when creating. Yes, it is possible to have say a brush selected, forget it is selected, then create say, a new light. Oh! what happened to the brush? It's gone - replaced by the light. Develop a nervous habit of keep hitting {{key|Esc}} to deselect when you go to create!

From now on I'll use LMB, MMB, and RMB to refer to the mouse buttons.

== Camera View ==

You should be able to see this block in the camera view. If the camera view is just black remember {{key|F3}} toggles true light rendering and we don't yet have a light so hit {{key|F3}} to get a constant bright test light throughout. I won't go into details of all the camera controls suffice to say use the arrow keys and {{key|D}} and {{key|C}} to move vertically. But scroll down to 'camera' in [[Dark Radiant Controls, Keys & Mouse]] and you will see a fantastic amount of control you have in DR's camera view - especially with the mouse. It will take time to get used to them all so for now perhaps just learn enough to move around to see what you've done so far.

If you can see your block(brush) in the camera view then it is likely not to have any particular texture unless you were doing something before this tutorial. Close up you may see it is covered in a checkered blue 'shader not found' message. Don't worry if it's covered in something else like stone or wood though. Since it will eventually be hollowed out to form a room, let's paint it now with some material more suitable to the Dark Mod universe...

== Materials, Textures, Painting the Block ==

This is the tiny home of a cheap thief so we'll use some old stonework.

I've mentioned 'textures', 'shaders', and 'materials'; what do these terms mean? A 'material' or 'shader' is the properties of a surface, including (but not necessarily) texture, sound, and others. To 'paint' our block we...

* Select the Media Browser. This is one of the tabs on a panel. Pressing N or T hides/shows the whole panel but I guess most people leave the panel showing all the time and just select the tab they want.
* Allow a few seconds for DR to read in the media first time and then you should see 'textures' listed
* Click 'textures' and it opens up to show all available textures. Many of the ones you see are Doom textures. Scroll down and select 'darkmod' which reveals the ones most suitable for our use. Scroll down to stone, open it, then cobblestones and select blocks_mixed_multicolour. Right click it and select 'Apply to selection'. This covers all surfaces of the block because we have still got selected the whole block not just one surface. You should see this in the camera view. Use this throughout the house (and eventually on its outside surface for consistency.)
* Select the Texture Browser. This is one of the tabs on the same panel as Media Browser. The Texture Browser only shows recently used textures. You should see only the one texture you selected so it's handy for future use. Odds are you will want to re-use the same textures. It will also show other textures if you clicked on them in the media browser plus any others if you were using DR before this tutorial. You can also copy and paste textures onto single or multiple surfaces (see later.)
* Hover the mouse over the four little buttons at the top of the Texture Browser and read the text so you have some idea of what features are there for the future. For now, click on the one that says 'Flush and Reload Shaders' and it should clear all of them except the one we put on our brush. As we add others they will appear in the texture browser so you can get to them more quickly.
* Now, press S for Surface Inspector (or View menu)
* If you have only one face selected (more about this later) you can set Horiz and Vert scale. Value like 0.3 makes it harder for the player to see any pattern repetition (in this situation and in my opinion - use your own judgement with other textures and wall sizes.) In the mean time you can use arrow buttons to adjust the scale for the whole selected brush. Whatever scale you use, generally you should be consistent with it for the same texture wherever used in a mission. If you use copy and paste then it will transfer the scale as well which is far easier.
* There will be more on texture adjustment later in this tutorial.

== Hollowing out a Room from the Block ==

Building to a large grid size helps performance. The outside of our block will never be seen in the game. Once we hollow it out then the player will only see the inside so that is the surface that is rendered and that we need to align to the large grid. There are two tools to hollow out a block, both activated by a button on the left button bar: one called 'hollow' and the other 'room'. Don't use 'hollow' as it reduces the internal sides so they don't fit the big grid AND it overlaps the corners which can cause rendering errors like so....

<center>BAD!</center> 
<center>[[Image:AZhollow.jpg]]</center> 

Instead use the 'room' button which does the job right (note the increased size so the ''internal'' dimensions will be the same as our original block and align to the big grid... 

<center>GOOD!</center> 
<center>[[Image:AZroom.jpg]]</center> 

All brushes in Doom must be convex. They cannot have any inward angles (like an L shape which would have to be two brushes together) and cannot actually be hollow. The above tools really create new side panel brushes to replace the original brush. In the case of our six-sided block that is six new brushes positioned as walls, floor, and ceiling. ''The walls they create are one small grid line wide so their width will vary depending on your grid size setting.''

Examine the block in the camera view and zoom right inside so you can see it internally which is where it will be seen in game. Note the texture aligns nicely because we stuck to a big grid size. The stone is appropriate for all four walls (which is why I textured the whole block in one go rather than one surface at a time) but now we need different textures for floor and ceiling...

== Selecting and Texturing Individual Surfaces ==

'''You cannot select a surface in the grid view''' so move inside the room in the camera view.

'''To texture the floor...'''

* Press Esc to make sure everything is DEselected
* Point at the floor and use {{key|SHIFT}}+{{LMB}}. Repeat a few times and you will see it selects/DEselects the surface. Keep it selected.
* Select the Media Browser again (on the tabbed panel)
* In the darkmod section select say stone/cobblestones or maybe you would like some wood/boards/worn_01 ? You choose but something like carpet might need special alignment so stick with stones or boards maybe for now? Remember - RIGHT click the texture name and select 'Apply to Selection'
* Alternatively you can click on several possibles then select them with one LMB in the Texture Browser on the other tab. In the Texture Browser you can enlarge the textures if preferred to see them better.
* Esc to DEselect so you can see it better in camera view.

'''To texture the ceiling...'''

* Press Esc to make sure everything is DEselected
* Point at the ceiling and use {{key|SHIFT}}+{{LMB}} again to select its surface.
* Select the Media Browser again (on the tabbed panel)
* In the darkmod section select say plaster/plaster01 and apply it.

'''If you change your mind about the walls you can change them to something else...'''

* Press Esc to make sure everything is DEselected
* Point at one wall and use {{key|SHIFT}}+{{LMB}} again to select its surface.
* Point at another wall use {{key|SHIFT}}+{{LMB}} again so now both surfaces are selected
* 'Accidentally' select the ceiling. No problem. Just use {{key|SHIFT}}+{{LMB}} on it again to DEselect it but the walls are still selected. In this way you can select which surfaces you want to select.
* Select the Media Browser again and just apply another type of stone, perhaps brick, to the walls if you want or just leave it as it is.

Now press {{key|CTRL}}+{{key|S}} to resave the mission or use the File menu. Get into the habit of doing this often unless you have autosave set. Now and again you can also save with a new name so you can go back to an earlier one if you totally mess up. Note: There is also a backup file made automatically by DR.

== Adding the Player's Start Point ==

One more thing is ''essential'' to play this in Dark Mod and that is the Player's starting position.

* Press Esc to DEselect everything.
* In the TOP grid view, point the mouse in the middle of the room and RMB to get a pop up menu. This menu is important so glance at some of the other items on it while you're here. 'Entities' are special function items and the player start is amongst them but there is a shortcut on the menu so instead...
* Select "Create Player Start here" on the menu. This will create the playerstart entity (red box) and put it where you clicked. Drag the entity around to the point where you want the player to start.
* You should see an arrow on the red box indicating the way the player will face at the start. If you cannot see the arrow then menu <tt>View > Show > Show Angles</tt> will reveal it. You can rotate the player by selecting ''Rotate'' tool ([[Image:DRrotate.jpg]], {{key|R}}) and dragging with the mouse.
* Use {{key|CTRL}}+{{key|Tab}} to switch to the side view (YZ) and use LMB to drag the ''inside'' of the player start box so its base is on the floor of the room (you can also use ''Translate'' tool, [[Image:DRtranslate.jpg]], {{key|W}}). Make sure you do not go below or the floor or the player might be stuck with his feet in concrete! Tip: In Thief games it was common to start just dropping over a wall with this player start a few feet above the ground. You might note that entities do not directly resize like brushes so LMB dragging on the ''outside'' of the box does nothing (unless you have selected the ''Translate'' tool).
* RMB in the grid view again and you will see there is now a ''Move player start here'' option so you can quickly move its position while testing different areas of your mission. But always remember to check both the side and top view when moving things around, to make sure the vertical position is also valid. (Also note that ''Move player start here'' does not ''select'' the player start - you will need to select it if you need to adjust its position by dragging.)
* With the player start still selected you can select the Entity Inspector (on the panel, or {{key|N}} to hide/show it) and see the properties of your first entity.

The game could now be played but it will be totally dark so we need to create at least one light.....

== Creating a Light ==

* Press Esc to DEselect everything.
* In the TOP grid view, point the mouse in the ''middle'' of the room and RMB to get the pop up menu.
* Select "Create Light" on the menu.
* A large red box appears with diagonals representing the light's centre and its rough 'radius'. The default light is more like six pyramids pointing out to their peaks in the centre of each side of the box. This gives a rough impression of a sphere of light and helps performance.
* {{key|CTRL}}+{{key|TAB}} to get a side view and LMB drag ''right in the centre of the light'' to move it up/down to centre it in the room if it is not already. Just dragging inside the radius box won't move it - you have to point at the centre.

== Resizing a Light ==

Resizing a light is awkward because dragging any side moves the centre (this might be changed in a later Dark Radiant.) Two ways of dealing with this. Just roughly drag it about and keep moving the light back to where you want it. But if you have very precisely positioned a light then you don't want to have to keep doing that so this is what I do...

* Select the Entity Inspector on the panel
* You should see it has a light radius property with three values for XYZ for the three dimensions. They are north and south for Y, east and west for X, and up and down for Z. (those are the compass directions in game by the way.)
* Click on the light radius property to highlight it.
* Note that its values appear in a choice of inputs at the bottom - You can type new values in a line with a space in between then click the check(tick) button or enter them as separate values or even use the little scrolly buttons at the side and then click the Apply button.
* The room interior is 192 x 256 x 128 (in XYZ order) so give the light radius the values 200 260 133 so it protrudes outside the walls (we're setting radius - so the light diameter will be twice that size). We may well change this again later if we want the light to spill out through a doorway or something.
* You can now toggle light rendering in the preview using {{Key|F3}} (or an icon in the preview toolbar) to see how the light affects the walls.

The light radius is not just a cut-off point. It can be regarded as a 'fade to zero point'. What this means is that the light is at maximum brightness at its centre and fades to zero at the limit of the radius. So in a big open area, if you extend the radius you will 'stretch the brightness' further. Imagine the scale from max to min compacted in a small radius or expanded in a large one. More on this later when we place wall torches.

== Changing a Light's Brightness ==

The light may be a little bright. To change it...

* Press L (or View menu)* to call up the Light Inspector
* Click on the white rectangle button just below where it says 'Colour'
* The brightness value is called 'Lum:' (luminosity) and should default to 100. Reduce it to 90, by overtyping it or using the slider to the far right. It might not matter. I'm just showing you where the control is for now.
* Fool around with the colours if you want - there are extensive features I won't cover here.

Hey! We should have your first working mission! Do a {{key|CTRL}}+{{key|S}} to save it and then follow the next sections in Dark Mod itself not in Dark Radiant.....

== Sound ==

There is no need to do anything special about ''hearing'' sounds such as footsteps, collision sounds, etc. at this stage as it will work automatically. Adding custom sounds will be dealt with later.

== Pathfinding ==

Pathfinding data to tell the AI characters where they can move is created by dmap by default when compiling in the next section...

== Dmap: Compiling the Mission ==
* Your mission file cannot be played itself; it is simply the directions to create a game file. To do this...
[Edit by Destined:]
*Save your map in the folder "maps" in your Dark Mod folder (e.g. C:\Darkmod\maps\). The console will have this folder set as a staring point by default
[End of Edit]
* Start up The Dark Mod. From any Dark Mod menu go to the console. By default, the console is {{key|CTRL}}+{{key|ALT}}+{{key|~}} (US Keyboards) or {{key|CTRL}}+{{key|ALT}}+{{key|'}} (UK Keyboards). This key is the top left below Esc and to the left of "1" on all keyboards I believe. But most people set up a shortcut to just use the ~ (` in UK) on its own so:

For single key click to get the console:
In your desktop shortcut to Doom3.exe add this argument to its properties (right click shortcut): '''''+set com_allowConsole 1''''' so the target line would be something like:

'''''C:\Doom3\doom3.exe +set com_allowConsole 1'''''

(plus any other arguments you might want)
* In the console type and Enter dmap Tut/T001 where you should substitute your subfolder name for Tut and your mission filename for T001. So, if you created your mission file directly in the maps folder then you do not need a folder name and can put dmap T001. If you made a subfolder in maps called MyMaps and named your mission MissionImpossible999.map then enter dmap MyMaps/MissionImpossible999. I recommend you do not use upper case in filenames in Doom as I think it can cause problems on other platforms.
* Wait while dmap compiles the mission. This should only be a few seconds with this tiny mission but will be much longer for big missions.
* If you get a 'leaked' error or some other serious red warning then recheck your work; look for gaps in the wall or a wrong texture like nodraw or have you got an entity outside in the void? See [[Performance: Essential Must-Knows#How to detect and fix leaks|HERE]] for more about fixing leaks but at this stage of this tutorial it might be easier just to redo. What I have laboured over is basically make a block, texture it, hollow it, stick in a player start and a light. As you get more proficient you can do it in less than a minute.
* Assuming there were no dmap red "ERROR"s then you should be returned to the Dark Mod menus and are now able to play the mission.
* Return to the console.
* Type and Enter map Tut/T001. Tip: Press the up arrow key toggles back through the history of what you have typed before so your dmap should re-appear. Just press the Home key and delete the 'd'. An alternative is to use 'testmap' instead of dmap which does both dmap and map but I prefer to see dmap's results.
* You should now be able to walk around in the room. If you have a player shadow set then you might notice that walking through that light looks odd so keep that in mind for light placement. But most lights you will place close to a visible source like a gaslight or wall torch.

That's the first part done!

{{A-Z Beginner Guide TOC}}

{{tutorial-editing}}