Compiling under VS2005: Difference between revisions

Latest revision as of 02:32, 3 October 2024

Visual Studio compilers:

This page was written for Source 2007 or earlier. It may not be applicable to newer versions of the Source SDK.
For more up-to-date information, see Compiler choices.

Visual Studio 2005 is the officially-supported IDE of the Source SDK, and if all is well you won't need to do anything special to use it. If you're using Visual C++ 2005 Express or if something is awry, however, you'll need to do some work to get it up and running. This page assumes you are compiling the latest Orange Box source code.

Supported versions

Installing

Is it recommended to obtain the full Visual Studio 2005 Professional since it includes the Windows/Platform SDK. Both VS2005 and VCE2005 is no longer supported by or officially available from Microsoft. User will need to obtain VCE2005 at Internet Archive (Mount the downloaded ISO and go to Visual C++ 2005 Express Edition folder, and move the VC.iso to any folder before mounting it and run setup.exe). Alternatively, users can also get VS2005 Professional here.

Note:On Windows 10 and later, Program Compatibility Assistant will pop-up when you trying to install (and run) Visual Studio/VCE 2005. You can ignore these but if the program doesnt run, try to disable Program Compatibility Assistant in Windows Services and then run VS2005 again.

After Visual Studio or VCE has been installed, it is recommended to install SP1 (Be warned that it has a install bug of consuming a lot of space!) and SP1 Vista Update (Note that this update also applies to Win7 and later). Then run Windows Update to finish patching it. (If there are no updates for VS/VCE, try to enable "Receive updates for other Microsoft products". Also if you already installed everything above, there will be no updates.)

Visual Studio 2005 SP1

Get Visual Studio 2005 SP1
- For Microsoft Visual Studio 2005 Standard, Professional, Team Editions, get Visual Studio 2005 Service Pack 1.
- For Microsoft Visual Studio 2005 Express Editions, get Visual Studio 2005 Express Editions Service Pack 1.
- For systems running Windows Vista, 7 and later, get the SP1 Vista update (SP1 update must be installed first).

Note:Alternatively, you can use Windows Update (with "Receive updates for other Microsoft products" enabled), to get SP1.

Windows SDK (Express Only)

If you're using Visual C++ Express 2005 you need to install the Windows SDK.

Be warned that the Windows 7 SDK offered below is known to cause issues with Visual Studio 2010 SP1.

~~It doesn't matter which version you download~~*; this one does the job well enough. Don't worry that it talks about Vista - it also covers XP.

Windows 2000 users however should follow instructions in Older SDK

*: I'm pretty sure it does matter which version you download. See below. -- Neverender 17:26, 6 October 2012 (PDT)

Note:You only need the "headers and libraries" component, about half-way through the list that the installer will present. They're about a 20MB download...the complete SDK is over 2GB!

Note:If you are installing on a 64bit OS, remember that it is still the 32bit (x86) libraries that you want. They aren't selected by default.

Once you have the Windows SDK installed, you need to tell Visual C++ where the SDK is located. To do this, navigate to Tools > Options > Projects and Solutions > VC++ Directories. Add the Windows SDK's \bin folder to the list. The default location is C:\Program Files\Microsoft SDKs\Windows\v6.1\bin.

Click on the drop-down list that currently says "Executable files". You need to add the \include folder to the 'Includes' list and the \lib folder to the 'Library' list.

Tip:You'll need to go through a similar process if you've installed the DirectX SDK.

Open the Solution

Launch your copy of Microsoft Visual Studio.
Select File->Open->Project/Solution from the menu and open the Game_Episodic-2005.sln solution located in your mod's src directory, select the one that matches your version of Microsoft Visual Studio. If you selected mod from scratch, "Scratch" will appear there instead.

LNK2019 Errors

If you receive these errors, right-click on the client and server projects in turn and select the last option in the menu, Properties. Then navigate to Configuration properties > Linker > Input and make the first item, "Additional Dependencies", read winmm.lib user32.lib. Make sure you've done this for both Debug and Release mode (switch between them in the top left of the Properties window).

If you get "unresolved external" errors, try adding advapi32.lib and kernel32.lib as well.

`error C2733 referring to winnt.h or intrin.h`

You may receive an error such as: "error C2733: second C linkage of overloaded function '_interlockedbittestandreset' not allowed"

This error is caused by trying to build against an incompatible version of the Windows SDK/Platform SDK. When using the full version of Visual C++ 2005, your Visual C++ directories (in "Options") should not refer to any newer external SDK include/lib paths; only the ones included with the Visual C++ 2005 installation by default. Reverting the "VC++ Directories" settings to default should solve this problem.

For Express users ONLY, since you have no choice but to install an external SDK, this version may help. If all else fails, some users have resorted to working around this problem by editing their SDK headers.

Warning:Editing vendor provided header files is a BAD idea. This is a hack of last resort; however, by using Visual C++ Express, you are already working in an unsupported configuration.

Here are the previous instructions given:

"Open C:\Program Files\Microsoft Visual Studio 8\VC\include\intrin.h and comment out lines 944 and 945. If you continue to receive errors, comment out the referenced lines (typically 913 and 912) and recompile."

You put the same download before in Windows SDK Express Only. : MatiasKiller21 [1] : July 01 2015.

Running Your Mod

Remember to run with -allowdebug if you've got debug builds!

@@ Line 1: / Line 1: @@
-{{toc|right}}
+{{LanguageBar}}
+{{TabsBar|main=Visual Studio}}
+{{Outdated sdk|{{src07|4.1}}|newer-sdk-equivalent=[[Compiler choices]]}}
+{{toc-right}}
-== Introduction ==
+Visual Studio 2005 is the officially-supported [[Wikipedia:Integrated development environment|IDE]] of the Source SDK, and if all is well you won't need to do anything special to use it. If you're using Visual C++ 2005 Express or if something is awry, however, you'll need to do some work to get it up and running. '''This page assumes you are compiling the latest Orange Box source code.'''
-The following is a general guide to getting [[HL2]] compiling under VS 2005. Its important to note that the SDK code for HL2 supports VS2005, but only in the <code>the _2005.sln</code> files. Compiling <code>a _2003.sln</code> under 2005 and visa versa will only generate problems and errors. Older versions of the source code did not support 2005, to get them working with 2005 go [[Compiling under VS2005/Older SDK|here]].
-== What's working ==
+== Supported versions ==
-=== Single-player ===
+* {{Srcsdk06|2}}
-*Release - client - VS Studio: '''working''' & playable
+* {{Srcsdk07|2}}
-*Release - hl - VS Studio: '''working''' & playable
-*Release - client - V C++ Express: '''working''' & playable (after [[Compiling_under_VS2005#Requirements|requirements]] are fullfilled)
-*Release - hl - V C++ Express: '''working''' & playable (after [[Compiling_under_VS2005#Requirements|requirements]] are fullfilled)
-=== Multiplayer ===
+== Installing ==
-*Release - client - VS Studio: '''working'''  & playable
+Is it recommended to obtain the full Visual Studio 2005 Professional since it includes the Windows/Platform SDK.
-*Release - hl - VS Studio: '''working''' & playable
+Both VS2005 and VCE2005 is no longer supported by or officially available from Microsoft. User will need to obtain VCE2005 at [https://archive.org/details/mvs-2005-ee Internet Archive] (Mount the downloaded ISO and go to {{path|Visual C++ 2005 Express Edition}} folder, and move the {{code|VC.iso}} to any folder before mounting it and run setup.exe). Alternatively, users can also get VS2005 Professional [https://archive.org/details/en_vs_2005_cd here].
-*Release - client - V C++ Express: '''working''' & playable (after [[Compiling_under_VS2005#Requirements|requirements]] are fullfilled)
-*Release - hl - V C++ Express: '''working''' & playable (after [[Compiling_under_VS2005#Requirements|requirements]] are fulfilled)
-== Requirements ==
+{{Note|On Windows 10 and later, Program Compatibility Assistant will pop-up when you trying to install (and run) Visual Studio/VCE 2005. You can ignore these but if the program doesnt run, try to disable Program Compatibility Assistant in Windows Services and then run VS2005 again.}}
-Necessary steps are needed to enable compiling with the Visual Studio C++ 2005 Express Edition:
-=== Files ===
+After Visual Studio or VCE has been installed, it is recommended to install [[#Visual Studio 2005 SP1|SP1]] ([https://blogs.msdn.microsoft.com/heaths/2006/10/06/vs-2005-sp1-requires-a-lot-of-disk-space/ Be warned that it has a install bug of consuming a lot of space!]) and [https://web.archive.org/web/20121114020440/https://www.microsoft.com/en-us/download/details.aspx?id=7524 SP1 Vista Update] (Note that this update also applies to Win7 and later). Then run Windows Update to finish patching it. (If there are no updates for VS/VCE, try to enable '''"Receive updates for other Microsoft products'''". Also if you already installed everything above, there will be no updates.)
-*[http://msdn.microsoft.com/directx/sdk/ MS DirectX SDK]
-*[http://www.microsoft.com/downloads/details.aspx?FamilyId=0BAF2B35-C656-4969-ACE8-E4C0C0716ADB&displaylang=en Microsoft Platform SDK] For Windows 2000/XP/Server 2003
-*[http://www.microsoft.com/downloads/details.aspx?familyid=4377F86D-C913-4B5C-B87E-EF72E5B4E065&displaylang=en Microsoft Windows SDK] For Windows Vista
-=== Setup ===
+=== Visual Studio 2005 SP1 ===
-Go to Tools - Options: Projects and Solutions - VC++ Directories
+* [https://www.catalog.update.microsoft.com/Search.aspx?q=visual%20studio%202005 Get Visual Studio 2005 SP1]
+** For Microsoft Visual Studio 2005 Standard, Professional, Team Editions, get '''Visual Studio 2005 Service Pack 1'''.
+** For Microsoft Visual Studio 2005 Express Editions, get '''Visual Studio 2005 Express Editions Service Pack 1'''.
+** For systems running Windows Vista, 7 and later, get the '''[https://web.archive.org/web/20121114020440/https://www.microsoft.com/en-us/download/details.aspx?id=7524 SP1 Vista]''' update (SP1 update must be installed first).
+{{Note|Alternatively, you can use Windows Update (with '''"Receive updates for other Microsoft products'''" enabled), to get SP1.}}
-{{note|Vista users, having downloaded the Microsoft Windows SDK, will not have a path containing Microsoft Platform SDK. The correct path (if the Windows SDK is installed with the download above and it's default install paths), to substitute in to the appropriate paths below, appears to be "...\Microsoft SDKs\Windows\v''x.x''\..." Installing the Windows SDK does not make a difference in paths to the DirectX SDK, except the version may not have been released in the same month and hence may not have the same month in parenthesis in the folder path. }}
+== Windows SDK (Express Only) ==
-{{note|Vista 64 users,By default the Platform SDK does not install the 32 bit libs. Make sure to select them when you install. Select Developer tools -> Windows Vista Headers and Libraries -> x86 Libraries.}}
+If you're using Visual C++ Express 2005 you need to install the Windows SDK.
-* In the upper right drop down box, select "Executable files" and add "...\Microsoft Platform SDK\Bin" (replace with the correct path)
-* Then select "Include files" and add "...\Microsoft Platform SDK\Include" and "...\Microsoft DirectX SDK (November 2007)\Include"
+Be warned that the Windows 7 SDK offered below is known to cause issues with Visual Studio 2010 SP1.
-* Then select "Library files" and add "...\Microsoft Platform SDK\Lib" and "...\Microsoft DirectX SDK (November 2007)\Lib\x86"
+<strike>It doesn't matter which version you download</strike>*; [http://web.archive.org/web/20161108080358/http://www.microsoft.com/en-us/download/details.aspx?id=24826 this one does the job] well enough.  Don't worry that it talks about Vista - it also covers XP.
+Windows 2000 users however should follow instructions in [[Compiling under VS2005/Older SDK|Older SDK]]
-{{Warning|You need to do this for both Debug and Release builds (You can select these at the top in the toolbar. Do the Debug server/client and then do the Release server/client.}}
+:''*: I'm pretty sure it does matter which version you download. See [[#error C2733 referring to winnt.h or intrin.h|below]]. -- [[User:Neverender|Neverender]] 17:26, 6 October 2012 (PDT)''
+{{note|You only need the "headers and libraries" component, about half-way through the list that the installer will present. They're about a 20MB download...the complete SDK is over 2GB!}}
-* Finally, in the Solution Explorer right click 'client_hl2', and select Properties, then:
+{{note|If you are installing on a 64bit OS, remember that it is still the 32bit (x86) libraries that you want. They aren't selected by default.}}
-:* In the client_hl2 properties window, navigate to Linker -> Input
-:* Select the 'Additional Dependencies' box. Then click the '...' on the right hand side of the box
-:* If there is already an entry here, take a new line after it (a space will suffice if you cannot create a new line), and type 'user32.lib' and 'kernel32.lib' with a space between them, and without the quotes.
-:* Repeat these steps for 'server_hl2'
-== Potential problems ==
+Once you have the Windows SDK installed, you need to tell Visual C++ where the SDK is located. To do this, navigate to ''Tools > Options > Projects and Solutions > VC++ Directories''. Add the Windows SDK's <code>\bin</code> folder to the list. The default location is <code>C:\Program Files\Microsoft SDKs\Windows\v6.1\bin</code>.
-''Correcting Custom Build Step''
-The Custom Build step which copies the DLLs to your mod's directory is incorrect in the 2005 solution. When you attempt to run your game, it will crash upon trying to access <code>gpGlobals</code>, with an access violation at memory location 0x0000038.
+Click on the drop-down list that ''currently'' says "Executable files". You need to add the <code>\include</code> folder to the 'Includes' list and the <code>\lib</code> folder to the 'Library' list.
-{{note|Only follow this step if you encounter this issue. Often, it is not required}}
-Right-click on the <code>client_sdk</code> project, and go to Configuration Properties -> Custom Build Step -> General. Set the "Command Line" to:
+[[File:Vc2005 dirs.png|center|Adding the Windows SDK's includes.]]
- if exist "c:\program files\steam\steamapps\SourceMods\MyMod\bin\client.dll" attrib -r "c:\program files\steam\steamapps\SourceMods\MyMod\bin\client.dll"
+{{tip|You'll need to go through a similar process if you've installed the DirectX SDK.}}
- if exist "$(TargetDir)"client.dll copy "$(TargetDir)"client.dll "c:\program files\steam\steamapps\SourceMods\MyMod\bin\client.dll"
- if exist "c:\program files\steam\steamapps\SourceMods\MyMod\bin\client.pdb" attrib -r "c:\program files\steam\steamapps\SourceMods\MyMod\bin\client.pdb"
- if exist "$(TargetDir)"client.pdb copy "$(TargetDir)"client.pdb "c:\program files\steam\steamapps\SourceMods\MyMod\bin"
-Set Outputs to:
+== Open the Solution ==
-  "c:\program files\steam\steamapps\SourceMods\MyMod\bin\client.dll";"c:\program files\steam\steamapps\SourceMods\MyMod\bin\client.pdb"
+# Launch your copy of '''Microsoft Visual Studio'''.
+# Select '''File-&gt;Open-&gt;Project/Solution''' from the menu and open the '''Game_Episodic-2005.sln''' solution located in your mod's <code>src</code> directory, select the one that matches your version of '''Microsoft Visual Studio'''.  If you selected mod from scratch, "Scratch" will appear there instead.
-(In both cases, replace the "MyMod" entry with the actual name of your mod directory.)
+== LNK2019 Errors ==
-Click "Apply" (you ''will'' lose your changes if you skip this step). At the top-left, bring down the "Configuration" combo box, set it to "Release SDK", and set Command Line and Outputs to the same values. The <code>server_sdk</code>'s custom build steps should be correct.
+If you receive these errors, right-click on the client and server projects in turn and select the last option in the menu, Properties. Then navigate to ''Configuration properties > Linker > Input'' and make the first item, "Additional Dependencies", read <code>winmm.lib user32.lib</code>. Make sure you've done this for both Debug and Release mode (switch between them in the top left of the Properties window).
+If you get "unresolved external" errors, try adding <code>advapi32.lib</code> and <code>kernel32.lib</code> as well.
+== <code>error C2733 referring to winnt.h or intrin.h</code> ==
+You may receive an error such as: "<code>error C2733: second C linkage of overloaded function '_interlockedbittestandreset' not allowed</code>"
+This error is caused by trying to build against an incompatible version of the Windows SDK/Platform SDK. When using the full version of Visual C++ 2005, your Visual C++ directories (in "Options") should not refer to any newer external SDK include/lib paths; only the ones included with the Visual C++ 2005 installation by default. Reverting the "VC++ Directories" settings to default should solve this problem.
+For '''Express users ONLY''', since you have no choice but to install an external SDK, [https://web.archive.org/web/20200722172850/http://www.microsoft.com/en-us/download/details.aspx?id=6510 this version] may help. If '''all else fails''', some users have resorted to working around this problem by editing their SDK headers.
+{{warning|Editing vendor provided header files is a '''BAD''' idea. This is a hack of last resort; however, by using Visual C++ Express, you are already working in an unsupported configuration.}}
+Here are the previous instructions given:
+:''"Open <code>C:\Program Files\Microsoft Visual Studio 8\VC\include\intrin.h</code> and comment out lines 944 and 945. If you continue to receive errors, comment out the referenced lines (typically 913 and 912) and recompile."''
+''You put the same download before in Windows SDK Express Only. : MatiasKiller21 [https://developer.valvesoftware.com/wiki/User:MatiasKiller21] : July 01 2015.''
+== Running Your Mod ==
+Remember to run with -allowdebug if you've got debug builds!
 == See also ==
-* [[Microsoft Visual Studio 6.0 Usage]]
+* For other versions of Visual Studio, see the tab above.
-* [[Compiling under VS2008]]
-* [[Compiling under VS2002]]
 * [[Compiling under VS2005/Older SDK]]
+* [[My First Mod]]
-{{otherlang:en}}
-{{otherlang:en:de|Compiling_under_VS2005:de}}
 [[Category:Tutorials]]
 [[Category:Programming]]
+[[Category:Source SDK FAQ]]
+[[Category:Source 2006]]
+[[Category:Source 2007]]