Setting up Source SDK Base 2013 Multiplayer: Difference between revisions

From Valve Developer Community
Jump to navigation Jump to search
Line 107: Line 107:


At this point you should have client.so and server.so files to load with the Source SDK Base 2013 of your choice. More instructions on using the Steam runtime can be found in README.txt in the installed runtime directory.
At this point you should have client.so and server.so files to load with the Source SDK Base 2013 of your choice. More instructions on using the Steam runtime can be found in README.txt in the installed runtime directory.
==Windows==
=== Prerequisites ===
To build the Source SDK 2013 on Windows you will need [http://www.microsoft.com/visualstudio/eng/downloads#d-2010-express Microsoft Visual Studio 2010] with [http://www.microsoft.com/en-us/download/details.aspx?id=23691 Service Pack 1]. It's also possible to use Visual Studio 2012 with the Visual Studio 2010 compiler by not "updating" the project settings to the new compiler.
If you want to build the phonemeextractor project you will need to download [http://www.microsoft.com/en-us/download/details.aspx?id=10121 SAPI 5.1] from Microsoft. We aren't able to ship the Speech SDK with the Source SDK. Just download SpeechSDK51.exe, choose an extraction directory, and hit "Extract". Go to the directory with the extracted files and run the MSI installer. Locate "C:/Program Files (x86)/Microsoft Speech SDK 5.1" (or your desired installation path), copy it to "src/utils/", then rename the "Microsoft Speech SDK 5.1" folder to "sapi51" and phonemeextractor will be able to link.
=== Building Shaders ===
See [[Source SDK 2013: Shader Authoring]].
===Compiling Source SDK 2013 with Visual Studio 2012===
Valve recommends that mod creators should use Visual Studio 2010 with Service Pack 1 to create a mod. However, this section describes how to compile a mod using Visual Studio 2012. Follow the guide on this page up until the [[#Prerequisites|Windows - Prerequisites]] section. In the [[#Prerequisites|Windows - Prerequisites]] section, it recommends that the mod creator does not update the Visual Studio projects and touches on the fact that the mod creator will have to obtain sapi.lib from Microsoft's Speech SDK. This section will describe instead how to 1. obtain and setup the Speech SDK library, 2. setup the necessary protobuf library and 3. setup and compile the Source SDK 2013 with Visual Studio 2012.
{{note|Avoid errors by only compiling the solution after setting up Speech API and protobuf.}}
==== Setting up Microsoft Speech SDK (SAPI) ====
The Source SDK requires the Microsoft Speech SDK but doesn't come with it for licensing reasons. Download the Speech SDK 5.1 from [http://www.microsoft.com/en-us/download/details.aspx?id=10121 here]. This should download the SpeechSDK51.exe file. Run this and it should unzip contents to a selected folder. One of the contents it unzips is Microsoft SDK 5.1.msi. Running this with the default settings should create a directory in <code>C:\Program Files (x86)</code> called <code>Microsoft Speech SDK 5.1</code>. Copy the <code>Microsoft Speech SDK 5.1</code> directory into the <code>src/utils</code> directory and rename it <code>sapi51</code>.
Compiling now shows a number of errors in the <code>sphelper.h</code> file. There is [http://stackoverflow.com/questions/7224902/how-to-fix-compiler-errors-in-sapi-5-1-header-files more than one way] to fix these errors. This section will describe how to fix them manually.
Change the following lines t have the code shown below.
Line 769
<code>
    const size_t ulLenVendorPreferred = wcslen(pszVendorPreferred); // no size_t
Line 1418
<code>
    static long CoMemCopyWFEX(const WAVEFORMATEX * pSrc, WAVEFORMATEX ** ppCoMemWFEX) // missing long
</code>
Line 2368
<code>
    const WCHAR * PropertyStringValue() const
    {
        // Search for the first NULL and return pointer to the char past it.
        SPDBG_ASSERT(eEventId == SPEI_PROPERTY_STRING_CHANGE);
        const WCHAR * psz = (const WCHAR *)lParam; // moved this from for init
        for (; *psz; psz++) {}
        return psz + 1;
    }
</code>
Line 2560
<code>
    SPPHONEID* pphoneId = (SPPHONEID*)((WCHAR *)dsPhoneId); // improper casting
</code>
Line 2634
<code>
    pphoneId += wcslen((const wchar_t *)pphoneId) + 1; // improper casting
</code>
{{note|Building now might generate an error <code>unresolved symbol _IID_IspPhoneticAlphabetSelection</code>. This was perhaps caused because you had already built and the partial build is broken. This could be fixed by rebuilding the <code>phonemeextractor</code> project.}}
==== Setting up protobuff ====
The Source SDK 2013 requires a protobuff version 2.3.0 library. A detailed set of instructions on obtaining and compiling the protobuf library can be found [https://wiki.alliedmods.net/Compiling_libprotobuf here] on the Allied Modders Wiki.
Once compiled, copy the <code>libprotobuf.lib</code> file from <code>protobuf-2.3.0\vsprojects\Debug</code> or <code>protobuf-2.3.0\vsprojects\Release</code>, depending on which configuration it was built in, and paste it into the <code>src\lib\public</code> directory.
==== Setting up the Visual Studio Projects ====
Open everything.sln in either the <code>source-sdk-2013\sp\src</code> or <code>source-sdk-2013\mp\src</code> directory depending on if your mod is a single player or multiplayer mod, respectively. A [http://i.imgur.com/1iZJmsd.png prompt] should appear asking if you want to update the VC++ compiler and libraries for each project in the solution. More details of this process can be found [http://msdn.microsoft.com/en-us/library/hh690665(v=vs.110).aspx here]. Click the <code>Update</code> button to update the projects and solution. If you don't get such a prompt or earlier chose not to update, the projects within the solution can be updated to the newest Visual Studio at any time by right-clicking on the solution and selecting <code>Update VC++ Projects</code>.
Select the project configuration to be build, either Debug or Release. This is done by right-clicking on the <code>everything</code> solution in the solution explorer, selecting <code>properties</code>, then navigating to <code>Configuration Properties/Configuration Manager/Active Solution Configuration</code>, selecting either Debug or Release (Debug is default), pressing <code>Close</code> and then <code>Ok</code>.
Now build the solution by right-clicking on the <code>everything</code> solution in the solution explorer and clicking <code>Build All</code>. Now close the <code>everything</code> solution, open the <code>games</code> solution and update the projects as you did for the <code>everything</code> solution. Continue the guided setup process from the [[#Building Shaders|Building Shaders]] section.
{{note|Building the solution before updating sapi and updating the protobuf library may cause a number of compiler errors including <code>missing sapi.lib</code> and <code>_MSC_VER: value '1600' doesn't match value '1700'</code>. The following sections should fix these errors.}}
{{note|Once the build is complete, consider [[Installing and Debugging the Source Code#Debugging| setting up your mod for debugging]].}}


==Other information==
==Other information==

Revision as of 07:59, 27 September 2015

Broom icon.png
This article or section needs to be cleaned up to conform to a higher standard of quality because:
Outdated, poorly written instructions.
For help, see the VDC Editing Help and Wikipedia cleanup process. Also, remember to check for any notes left by the tagger at this article's talk page.

Template:Otherlang2

Setting Up

Windows and OS X

  1. Download GitHub for Windows or OS X depending on the operating system and install it.
  2. Open the following page, then click the Clone in Desktop button.

Linux

  1. See these are instructions.
  2. Use the following command.
 > git clone '''git@github.com:ValveSoftware/source-sdk-2013.git'''


Source SDK 2013 on Windows

Step One

  1. Download and install Visual Studio 2013.

Step Two

  1. Download the following archive, then extract the sapi51 folder to <path-to-git>\sp\src\utils.
  2. Run the following bat files, located here.
// Singleplay Projects
<path-to-git>/sp/src/creategameprojects.bat
<path-to-git>/sp/src/createallprojects.bat

// Multiplayer Projects
<path-to-git>/mp/src/creategameprojects.bat
<path-to-git>/mp/src/createallprojects.bat

Notes Will create Visual Studio Project (.vcxproj) and Solution (.sln) files in the SRC directory.

Step Three

  1. Open the "everything" solution file for the project type you wish to make.
    • everything.sln
  2. Build the above solution.
  3. Open the solution file for the game you are building the mod for.
    • games.sln
  4. Build the above solution.

At this point you should have client.dll and server.dll to load with the Source Engine game you based the mod on.

Source SDK 2013 on OS X

Note: OS X Mavericks users need to change some files in order to compile the project: Remove the -fpredictive-commoning flag from OTHER_CFLAGS in src/devtools/release.xcconfig. Change SDKROOT to macosx10.8 in src/devtools/base.xcconfig. 

# Single Player Project
> <SDK_ROOT>/sp/src/creategameprojects
> <SDK_ROOT>/sp/src/createallprojects

# Multiplayer Project
> <SDK_ROOT>/mp/src/creategameprojects
> <SDK_ROOT>/mp/src/createallprojects

On OS X, this will create src/games.xcodeproj and src/everything.xcodeproj.

Environment & Tools Setup

OS X, you will need Xcode 4.2 installed. You will also need to have "Command Line Tools" installed. You can find this at:

XCode Preferences -> "Downloads" -> "Components"

Building The Tools

Remember to create project & make files first!

To run the tools, run this command under Terminal: 

> make -f games.mak

When successfully built, you should have client.dylib and server.dylib files to load with the Source SDK Base 2013 of your choice.

Source SDK 2013 on Linux

On Linux, this will create src/games.mak and src/everything.mak.

Steam Client Runtime

To build the Source SDK 2013 on Linux you should use the Steam Client Runtime to guarantee compatibility with most Linux distributions. It will only work on Debian-/Ubuntu-based systems though.

  1. Download the Steam Client Runtime Installer/Updater
  2. Run the following commands to extract the runtime, replace <version> with the version you just unpacked:
> tar xvf steam-runtime-sdk_latest.tar.xz
> cd steam-runtime-sdk_<version>

Download and setup the runtime, pick your architecture and debug/release preferences. Then answer Y to everything else. 

> ./setup.sh

Run the (chroot) environment. This environment should be used to build your the SDK. 

> ./shell.sh --arch=i386

SDK Build

Remember to create project & make files first!

With the above prerequisite installed, run the following: 

> make -f games.mak

At this point you should have client.so and server.so files to load with the Source SDK Base 2013 of your choice. More instructions on using the Steam runtime can be found in README.txt in the installed runtime directory.

Other information

Information about VPC

For more information on how to use VPC, look at the scripts themselves or run the following command on any platform: 

> <SDK_ROOT>/<gameType>/src/devtools/bin/vpc /help

Note on Git Repository & Ignored Files

The project files generated by VPC are listed in the .gitignore file so that they won't be committed to the repository. Individuals wanting to submit changes via a pull request should be aware of this when commiting.

Adding files to your project with VPC

VPC generates project files for all of the platforms that the SDK supports, so if you want to add files to your project in a way that will allow you to easily build on other platforms, consider using VPC. For example, to add a file to a multiplayer game, you could add a line to src/game/client/client_hl2mp.vpc.

Directory structure

* game - Runtime files for the mods themselves. Any mod content will go in here. 
* src - All the source code for that kind of mod. The root of the src directory contains .sln or root level .mak files for building the source.
** common - A few files used by the server and client DLLs
** devtools - Scripts and utilities that are used to build the source. These are called by the makefiles and projects and you probably won't need to interact with them directly.
** game - All of the source code for the DLLs. 
*** client - Code used by client.dll (or client.dylib or client.so). There are also game-specific directories under here.
*** server - Code used by server.dll. There are also game-specific directories under here.
*** shared - Code used by both client.dll and server.dll.
** gcsdk - A couple of tools used to build the DLLs.
** lib - Binary versions of the libraries that the source code depends on. This is also the build target for vgui_controls, tier1, and mathlib.
** mathlib - Math utilities used by the game.
** public - Header files for all of the DLLs and libraries that are used by the game. Also includes a few source files.
** thirdparty - Third party libraries needed to build the source. At the moment this contains only the [https://code.google.com/p/protobuf/ Google Protocol Buffers (protobuf)] library.
** tier1 - Useful utility classes. Builds into tier1.lib
** utils - Various development utilities
** vgui2 - Source code for vgui_controls, which is used by client.dll.

Naming convention

The Source SDK is split into two directories at the root for <gameType>, followed by source for <gameName>. If you are building a single player mod, use the "sp" directory. If you are building a multi-player mod you should base yourself on the code in the "mp" directory.

  • <gameType>
    • sp (singleplayer)
    • mp (multiplayer)
  • <gameName>
    • hl2 (Half-Life 2)
    • episodic (Half-Life 2 Episodes)
    • hl2mp (Half-Life 2: Deathmatch)

Each directory has a matching Source SDK 2013 Base appID to use to get the base mod files:

These two base apps are very similar, differing mostly in update schedule. The Singleplayer base will only update with HL2 and the Episodes do, which isn't very often. The Multiplayer base will update a few times a year to incorporate engine changes from TF2 and Counter-Strike: Source. None of these updates should break mod compatibility.

Issues fixed

Fatal Error: CDEFS.h No such file or directory (Linux)

> /usr/include/features.h:374:25: fatal error: sys/cdefs.h: No such file or directory

See [Steam steam runtime commands].

RegKey Errors While Generating Project Files

ERROR: Unable to find RegKey for .vcproj files in solutions."

Install Visual Studio 2013.Template:CN


error MSB8008: Specified platform toolset (v120_xp) or (v120)

Tip.pngTip:If you have a problem in Microsoft visual C++ 2010 SP1 with the error MSB8008: Specified platform toolset (v120_xp), it can be corrected as follows:


1 - Select all Project Files

2 - Right-click on the file, then choose "Properties"

3 - Choose "Configuration Properties"

4 - And the last, choose in "Platform toolset" this -> (v100)


(Project->Properties->Configuration Properties->General->Platform toolset = Visual Studio 2010(v100))


Fix error MSB8008

You can also see action in this screenshot.

It works with Microsoft visual C++ 2010 SP1, as in the "release" and in the "debug"

Visual Studio 2012

A tool has been created by a member of the community to fix this type of error on Visual Studio 2012. Use at your own risk. Download source from GitHub (AutoIt v3 is needed).

Retrieved from "https://developer.valvesoftware.com/w/index.php?title=Setting_up_Source_SDK_Base_2013_Multiplayer&oldid=193608"