Hammer Manual Configuration: Difference between revisions

From Valve Developer Community
Jump to navigation Jump to search
m (Nesciuse moved page Hammer Manual Configuration/en to Hammer Manual Configuration without leaving a redirect: Move en subpage to basepage)
No edit summary
 
(5 intermediate revisions by the same user not shown)
Line 5: Line 5:
==Read This First!==
==Read This First!==


If you launch the Hammer editor with no proper game configurations set up, the Hammer Editor has not automatically configured itself after installing the '''Source SDK'''. You can follow these steps to manually configure it. Before following these steps to repair a bad configuration, it is ''strongly suggested'' that you first attempt to fix your configuration by following the steps outlined in [[Reset the Source SDK Game Configuration]].
If you launch the Hammer editor with no proper game configurations set up, the Hammer Editor has not automatically configured itself after installing the game '''Authoring Tools''' or '''Source SDK'''. You can follow these steps to manually configure it. Before following these steps to repair a bad configuration, it is ''strongly suggested'' that you first attempt to fix your configuration by following the steps outlined in [[Reset the Source SDK Game Configuration]].


{{warning|In most cases, Hammer will configure itself and you '''do not''' need to follow this procedure. If you have problems, it is much simpler to [[Reset the Source SDK Game Configuration|reset the game configuration]] instead. Doing this, however will remove your mod configurations}}
{{warning|In most cases, Hammer will configure itself and you '''do not''' need to follow this procedure. If you have problems, it is much simpler to [[Reset the Source SDK Game Configuration|reset the game configuration]] instead. Doing this, however will remove your mod configurations}}
{{Note|In all games on {{src13|1}} or {{tf2branch|1}}, if the {{code|Hammer.bat}} file is available, always launch Hammer using {{code|Hammer.bat}}, to make sure that Hammer properly detects the game and automatically configuring itself. Note that certain games like {{hls|1}} may not be automatically configurated, and you will need to [[Configuring_Hammer_for_Half-Life:_Source|configure HL:S manually]].}}
{{note|The Source SDK Launcher is no longer used with {{src13|4}} games and mods, so the above warning does not apply to them.}}
{{note|The Source SDK Launcher is no longer used with {{src13|4}} games and mods, so the above warning does not apply to them.}}
== Game-specific Configuration ==
*[[Configuring Hammer for Half-Life: Source]] - for {{hls|1}} and {{hldms|1}}.


==Adding a New Game Configuration==
==Adding a New Game Configuration==
Line 30: Line 34:
#: [[File:Setup_AddGameOpen.png]]
#: [[File:Setup_AddGameOpen.png]]
# Select the appropriate .FGD file for your game or mod:
# Select the appropriate .FGD file for your game or mod:
#* For a '''Counter-Strike: Source''' configuration, click on <code>cstrike.fgd</code> and then the '''Open''' button.
#* For a '''Counter-Strike: Source''' configuration, click on {{code|[[cstrike.fgd]]}} and then the '''Open''' button.
#* For a '''Half-Life 2''' configuration, click on <code>halflife2.fgd</code> and then the '''Open''' button.
#* For a '''Half-Life 2''' (or {{ep1}}{{ep2}} episodes) configuration, click on {{code|[[halflife2.fgd]]}} and then the '''Open''' button.
#* For a '''Half-Life 2 Deathmatch''' configuration, click on <code>hl2mp.fgd</code> and then the '''Open''' button.
#* For a '''Half-Life 2 Deathmatch''' configuration, click on {{code|[[hl2mp.fgd]]}} and then the '''Open''' button.
#* For a '''Team Fortress 2''' configuration, click on <code>tf.fgd</code> and then the '''Open''' button.
#* For a '''Portal''' configuration, click on{{code|[[portal.fgd]]}} and then the '''Open''' button.
#* For a '''Team Fortress 2''' configuration, click on{{code|[[tf.fgd]]}} and then the '''Open''' button.
# Now you'll be back in the '''Configure Hammer''' dialog with these fields filled out:
# Now you'll be back in the '''Configure Hammer''' dialog with these fields filled out:
#: [[File:Setup_GameConfig_03.png]]
#: [[File:Setup_GameConfig_03.png]]
# Type <code>0.25</code> into the '''Default texture scale''' field. Type <code>tools\toolsskybox</code> into the '''Cordon texture''' field.
# Type <code>0.25</code> into the '''Default texture scale''' field. Paste <code>tools\toolsskybox</code> into the '''Cordon texture''' field.
# Under '''Game Executable Directory''', hit '''Browse''' and select the folder where the game executable (such as hl2.exe) is located.
# Under '''Game Executable Directory''', hit '''Browse''' and select the folder where the game executable (such as {{code|hl2.exe}}) is located.
#: For example, the directory for a '''Counter-Strike''' configuration might be:
#: For example, the directory for a '''Counter-Strike: Source''' configuration might be:
#:: <code>$SteamUserDir\Counter-Strike Source</code>
#:: <code>$SteamUserDir\Counter-Strike Source</code>
# Under '''Game Directory''', enter the path of the folder that contains <code>gameinfo.txt</code>.
# Under '''Game Directory''', enter the path of the folder that contains <code>gameinfo.txt</code>.
Line 46: Line 51:
#:: <code>C:\Program Files (x86)\Steam\steamapps\sourcemods\mod</code>
#:: <code>C:\Program Files (x86)\Steam\steamapps\sourcemods\mod</code>
# Under '''Hammer Map Directory''', you should enter the folder where you wish to save your .VMF map source files.
# Under '''Hammer Map Directory''', you should enter the folder where you wish to save your .VMF map source files.
#* Example for '''Counter-Strike''':
#* Example for '''Counter-Strike: Source''':
#: <code>C:\Program Files (x86)\Steam\steamapps\common\Counter-Strike Source\cstrike\mapsrc</code> or
#: <code>C:\Program Files (x86)\Steam\steamapps\common\sourcesdk_content\cstrike\mapsrc</code>
#: <code>C:\Program Files (x86)\Steam\steamapps\common\sourcesdk_content\cstrike\mapsrc</code>
#* Example for '''Half-Life 2''':
#* Example for '''Half-Life 2''':
#: <code>C:\Program Files (x86)\Steam\steamapps\common\Half-Life 2\hl2\mapsrc</code> or
#: <code>C:\Program Files (x86)\Steam\steamapps\common\sourcesdk_content\hl2\mapsrc</code>
#: <code>C:\Program Files (x86)\Steam\steamapps\common\sourcesdk_content\hl2\mapsrc</code>
#* Example for '''Half-Life 2 Deathmatch''':
#* Example for '''Half-Life 2 Deathmatch''':
#: <code>C:\Program Files (x86)\Steam\steamapps\common\Half-Life 2 Deathmatch\hl2\mapsrc</code> or
#: <code>C:\Program Files (x86)\Steam\steamapps\common\sourcesdk_content\hl2mp\mapsrc</code>
#: <code>C:\Program Files (x86)\Steam\steamapps\common\sourcesdk_content\hl2mp\mapsrc</code>
#* Example for '''Team Fortress 2''':
#: <code>C:\Program Files (x86)\Steam\steamapps\common\Team Fortress 2\tf\mapsrc</code> or
#: <code>C:\Program Files (x86)\Steam\steamapps\common\sourcesdk_content\tf\mapsrc</code>


== Setting up the Build Programs ==
== Setting up the Build Programs ==
Line 57: Line 68:
#: [[File:Setup_BuildPrograms.png]]
#: [[File:Setup_BuildPrograms.png]]
# In '''Game Executable''', enter the path of the .exe file used to launch the game.
# In '''Game Executable''', enter the path of the .exe file used to launch the game.
#* For example, for a '''Counter-Strike''' configuration, your '''Game Executable ''' might be:
#* For example, for a '''Counter-Strike: Source''' configuration, your '''Game Executable ''' will be:
#: <code>$SteamUserDir\counter-strike source\hl2.exe</code>
#: <code>$SteamUserDir\counter-strike source\cstrike_win64.exe (64-bit)</code>
#* For a '''Half-Life 2''' configuration, your '''Game Executable''' might be:
#: <code>$SteamUserDir\counter-strike source\cstrike.exe (32-bit)</code>
#* For a '''Half-Life 2''' configuration, your '''Game Executable''' will be:
#: <code>$SteamUserDir\half-life 2\hl2.exe</code>
#: <code>$SteamUserDir\half-life 2\hl2.exe</code>
#* For a '''Half-Life 2 Deathmatch''' configuration, your '''Game Executable''' might be:
#* For a '''Half-Life 2 Deathmatch''' configuration, your '''Game Executable''' will be:
#: <code>$SteamUserDir\half-life 2 deathmatch\hl2.exe</code>
#: <code>$SteamUserDir\half-life 2 deathmatch\hl2mp_win64.exe (64-bit)</code>
#: <code>$SteamUserDir\half-life 2 deathmatch\hl2mp.exe (32-bit)</code>
#* For a '''Team Fortress 2''' configuration, your '''Game Executable''' will be:
#: <code>$SteamUserDir\team fortress 2\tf_win64.exe</code> (64-bit)
#: <code>$SteamUserDir\team fortress 2\tf.exe</code> (32-bit)
#* {{Note|All versions of multiplayer Source games before {{tf2branch|1}} update always have it's executable set to {{code|hl2.exe}}.}}
# In '''BSP executable''', enter the location of <code>vbsp.exe</code>:
# In '''BSP executable''', enter the location of <code>vbsp.exe</code>:
#: ''EXEDIR''\bin\vbsp.exe</code>
#: ''EXEDIR''\bin\vbsp.exe</code>
#:: ''EXEDIR''</code> is the value that was entered into '''Game Executable Directory''' field earlier.
#:: ''EXEDIR''</code> is the value that was entered into '''Game Executable Directory''' field earlier, usually where the game is installed.
# In '''VIS executable''', enter the location of the <code>vvis.exe</code>:
# In '''VIS executable''', enter the location of the <code>vvis.exe</code>:
#: ''EXEDIR''\bin\vvis.exe</code>
#: ''EXEDIR''\bin\vvis.exe</code>
#:: ''EXEDIR''</code> is the value that was entered into '''Game Executable Directory''' field earlier.
#:: ''EXEDIR''</code> is the value that was entered into '''Game Executable Directory''' field earlier, usually where the game is installed.
# In '''RAD executable''', enter the location of the <code>vrad.exe</code>:
# In '''RAD executable''', enter the location of the <code>vrad.exe</code>:
#: ''EXEDIR''\bin\vrad.exe</code>
#: ''EXEDIR''\bin\vrad.exe</code>
#:: ''EXEDIR''</code> is the value that was entered into '''Game Executable Directory''' field earlier.
#:: ''EXEDIR''</code> is the value that was entered into '''Game Executable Directory''' field earlier, usually where the game is installed.
# In '''Place compiled maps in this directory before running the game''', enter the '''Game Directory''' with <code>\maps</code> appended to the end of it:
# In '''Place compiled maps in this directory before running the game''', enter the '''Game Directory''' with <code>\maps</code> appended to the end of it:
#* Example for '''Counter-Strike''':
#* Example for '''Counter-Strike: Source''':
#: <code>$SteamUserDir\counter-strike source\cstrike\maps</code>
#: <code>$SteamUserDir\counter-strike source\cstrike\maps</code>
#* Example for '''Half-Life 2''':
#* Example for '''Half-Life 2''':
Line 79: Line 96:
#* Example for '''Half-Life 2 Deathmatch''':
#* Example for '''Half-Life 2 Deathmatch''':
#: <code>$SteamUserDir\half-life 2 deathmatch\hl2mp\maps</code>
#: <code>$SteamUserDir\half-life 2 deathmatch\hl2mp\maps</code>
#* Example for '''MOD''':
#* Example for '''Source SDK mod''':
#: <code>C:\Program Files (x86)\Steam\steamapps\sourcemods\''MODDIR''\maps</code>
#: <code>C:\Program Files (x86)\Steam\steamapps\sourcemods\''MODDIR''\maps</code>
#:: ''MODDIR'' is the name of your game directory for your mod.
#:: ''MODDIR'' is the name of your game directory for your mod.
# Press '''OK'''. Hammer is now configured for use. [[Category:Hammer Dialogs]][[Category:Source SDK FAQ]][[Category:Tutorials]]
# Press '''OK'''. Hammer is now configured for use. [[Category:Hammer Dialogs]][[Category:Source SDK FAQ]][[Category:Tutorials]]

Latest revision as of 23:53, 8 September 2025

English (en)Español (es)한국어 (ko)Русский (ru)中文 (zh)Translate (Translate)
Broom icon.png
This article or section needs to be updated to include current information regarding the subject because:
This needs to better explain each game now having its own copy of Hammer and the compile tools.
Remember to check for any notes left by the tagger at this article's talk page.

Read This First!

If you launch the Hammer editor with no proper game configurations set up, the Hammer Editor has not automatically configured itself after installing the game Authoring Tools or Source SDK. You can follow these steps to manually configure it. Before following these steps to repair a bad configuration, it is strongly suggested that you first attempt to fix your configuration by following the steps outlined in Reset the Source SDK Game Configuration.

Warning.pngWarning:In most cases, Hammer will configure itself and you do not need to follow this procedure. If you have problems, it is much simpler to reset the game configuration instead. Doing this, however will remove your mod configurations
Note.pngNote:In all games on Source 2013 or Team Fortress 2 branch, if the Hammer.bat file is available, always launch Hammer using Hammer.bat, to make sure that Hammer properly detects the game and automatically configuring itself. Note that certain games like Half-Life: Source may not be automatically configurated, and you will need to configure HL:S manually.
Note.pngNote:The Source SDK Launcher is no longer used with Source 2013 Source 2013 games and mods, so the above warning does not apply to them.

Game-specific Configuration

Adding a New Game Configuration

  1. Launch Hammer.
  2. The First Time Setup dialog box may appear. If it does, click the No button:
    Setup NoGameConfig.png
  3. If the First Time Setup window did appear, this Configure Hammer dialog should now be open. Otherwise, click Options in the Tools menu, and then open the Game Configurations tab.
    Setup GameConfig 01.png
  4. Click on the Edit button to the right of the Configuration drop-down list, which will open the Edit Game Configurations dialog:
    Setup EditGameConfig.png
  5. Press the Add button. This will open the Add a game dialog:
    Setup AddGame.png
  6. Enter a name for the new configuration, usually the name of the game or mod. Press OK to confirm your choice and close the dialog.
  7. Press the Close button in the Edit Game Configurations dialog.

Setting Game Directory and Basic Parameters

  1. You should now be back in the Configure Hammer dialog with your configuration selected in the Configuration drop-down list:
    Setup GameConfig 02.png
  2. Press Add to the right of the Game Data files list. An Open dialog will appear:
    Setup AddGameOpen.png
  3. Select the appropriate .FGD file for your game or mod:
    • For a Counter-Strike: Source configuration, click on cstrike.fgd and then the Open button.
    • For a Half-Life 2 (or Half-Life 2: Episode OneHalf-Life 2: Episode Two episodes) configuration, click on halflife2.fgd and then the Open button.
    • For a Half-Life 2 Deathmatch configuration, click on hl2mp.fgd and then the Open button.
    • For a Portal configuration, click onportal.fgd and then the Open button.
    • For a Team Fortress 2 configuration, click ontf.fgd and then the Open button.
  4. Now you'll be back in the Configure Hammer dialog with these fields filled out:
    Setup GameConfig 03.png
  5. Type 0.25 into the Default texture scale field. Paste tools\toolsskybox into the Cordon texture field.
  6. Under Game Executable Directory, hit Browse and select the folder where the game executable (such as hl2.exe) is located.
    For example, the directory for a Counter-Strike: Source configuration might be:
    $SteamUserDir\Counter-Strike Source
  7. Under Game Directory, enter the path of the folder that contains gameinfo.txt.
    For example, the game directory for a Half-Life 2 configuration might be:
    $SteamUserDir\Half-Life 2\hl2
    For mods located in the sourcemods folder, the game directory would be of the form:
    C:\Program Files (x86)\Steam\steamapps\sourcemods\mod
  8. Under Hammer Map Directory, you should enter the folder where you wish to save your .VMF map source files.
    • Example for Counter-Strike: Source:
    C:\Program Files (x86)\Steam\steamapps\common\Counter-Strike Source\cstrike\mapsrc or
    C:\Program Files (x86)\Steam\steamapps\common\sourcesdk_content\cstrike\mapsrc
    • Example for Half-Life 2:
    C:\Program Files (x86)\Steam\steamapps\common\Half-Life 2\hl2\mapsrc or
    C:\Program Files (x86)\Steam\steamapps\common\sourcesdk_content\hl2\mapsrc
    • Example for Half-Life 2 Deathmatch:
    C:\Program Files (x86)\Steam\steamapps\common\Half-Life 2 Deathmatch\hl2\mapsrc or
    C:\Program Files (x86)\Steam\steamapps\common\sourcesdk_content\hl2mp\mapsrc
    • Example for Team Fortress 2:
    C:\Program Files (x86)\Steam\steamapps\common\Team Fortress 2\tf\mapsrc or
    C:\Program Files (x86)\Steam\steamapps\common\sourcesdk_content\tf\mapsrc

Setting up the Build Programs

  1. Click on the Build Programs tab:
    Setup BuildPrograms.png
  2. In Game Executable, enter the path of the .exe file used to launch the game.
    • For example, for a Counter-Strike: Source configuration, your Game Executable will be:
    $SteamUserDir\counter-strike source\cstrike_win64.exe (64-bit)
    $SteamUserDir\counter-strike source\cstrike.exe (32-bit)
    • For a Half-Life 2 configuration, your Game Executable will be:
    $SteamUserDir\half-life 2\hl2.exe
    • For a Half-Life 2 Deathmatch configuration, your Game Executable will be:
    $SteamUserDir\half-life 2 deathmatch\hl2mp_win64.exe (64-bit)
    $SteamUserDir\half-life 2 deathmatch\hl2mp.exe (32-bit)
    • For a Team Fortress 2 configuration, your Game Executable will be:
    $SteamUserDir\team fortress 2\tf_win64.exe (64-bit)
    $SteamUserDir\team fortress 2\tf.exe (32-bit)
    • Note.pngNote:All versions of multiplayer Source games before Team Fortress 2 branch update always have it's executable set to hl2.exe.
  3. In BSP executable, enter the location of vbsp.exe:
    EXEDIR\bin\vbsp.exe
    EXEDIR is the value that was entered into Game Executable Directory field earlier, usually where the game is installed.
  4. In VIS executable, enter the location of the vvis.exe:
    EXEDIR\bin\vvis.exe
    EXEDIR is the value that was entered into Game Executable Directory field earlier, usually where the game is installed.
  5. In RAD executable, enter the location of the vrad.exe:
    EXEDIR\bin\vrad.exe
    EXEDIR is the value that was entered into Game Executable Directory field earlier, usually where the game is installed.
  6. In Place compiled maps in this directory before running the game, enter the Game Directory with \maps appended to the end of it:
    • Example for Counter-Strike: Source:
    $SteamUserDir\counter-strike source\cstrike\maps
    • Example for Half-Life 2:
    $SteamUserDir\half-life 2\hl2\maps
    • Example for Half-Life 2 Deathmatch:
    $SteamUserDir\half-life 2 deathmatch\hl2mp\maps
    • Example for Source SDK mod:
    C:\Program Files (x86)\Steam\steamapps\sourcemods\MODDIR\maps
    MODDIR is the name of your game directory for your mod.
  7. Press OK. Hammer is now configured for use.