Compiling the viewer (MSVS2005)

From Second Life Wiki
Jump to navigation Jump to search
Open Source Portal

This page explains how you can compile the viewer on Microsoft Windows using Visual Studio 2005 or Visual C++ Express 2005. If you are using Visual Studio 2003, you should read another page. Note that Lindens are using VS2003, and you will get less trouble with it than with VS2005.

The following explanation is for Viewer release 1.14.0.0 or later. See an older version of this page for the Viewer releases before Mar. 2007.

Development Environment

You need to setup the compiler and Microsoft Development tools as follows:

Note: If you have previously installed an older version of the DirectX 9.0 SDK, remove it first (from Control Panel -> Add or Remove Programs) before installing this version. Installing the new SDK "on top" of an older version may cause problems.
  • Set up the project globals:
    • Start Microsoft Visual Studio 2005
    • Go to Tools > Options > Projects > VC++ Directories
    • Make sure that the includes (screen shot) and libraries (screen shot) paths have the Platform SDK paths first, then the DirectX SDK paths, and then the Visual C++ paths. You may need to check "Show All Settings" at the bottom for VC++ Directories to show.
    • If the DirectX SDK paths aren't present, add them to both includes and libraries.
    Note: The newest DirectX SDK ("December 2006") lib folder has two sub-folders, x64 and x86. Make sure your path goes to one of them, rather than the lib folder itself, or you will get a Link error.

You will also need some open source development tools.

  • AcrivePython 2.3x
  • ActivePerl
  • Cygwin
    • When you run the cygwin setup utility make sure you have selected to install patchutils, flex, and bison (all located under "devel") which are not part of the default install. The project files use several hardcoded references that expect Cygwin to be installed at C:\cygwin, if it's not you'll need to edit those references.

Source Files

You can download the Viewer source codes on official source downloads page. You can also use some version controlled repository run by the community. (See Get source and compile#Getting the source).

WARNING:

  • If the path you unzip the SL source to has a space in it, the batch file that copies message_template.msg will fail. So, if you unzip it to C:\Projects\Dir with space in name\Etc\linden, it won't work!
  • You should also avoid using non-ASCII (national) characters in the paths, although some localized versions of the tool puts some as a default...
  • Unzip your source tree into a directory that has as short full pathname as possible, since long paths cause some unexpected trouble during the build.
  • At a minimum, grab the source package and the artwork package. Many of the libraries can either be compiled from source or downloaded from other sites, but it's easiest to also grab the provided library package.

Libraries

SL Viewer depends on some third party libraries. Some of them are open source, some others are not.

Open Source Libraries

You can download the pre-build open source libraries from LL. They are available on source downloads page. Unzip them into your SL viewer source code directory, maintaining the same directory structure.

Alternatively, it may be possible to get the source files for the libraries and build by yourself. See the instruction for VS2003 users if you try it. Please note, however, it is not known that VS2005 can successfully compile the libraries. You have been warned. (If you can make it, please write the info on this wiki...)

Proprietary Libraries

Lindens does not inlcude the following proprietary libraries. You will need to follow the instructions to acquire below:

Fmod

  • Download & extract fmod 3.75 api for win32.
  • Copy "fmodapi375win\api\inc\fmod.h" to "linden\libraries\include"
  • Copy "fmodapi375win\api\inc\fmod_errors.h" to "linden\libraries\include"
  • Copy "fmodapi375win\api\lib\fmodvc.lib" to "linden\libraries\i686-win32\lib_release"
  • Copy "fmodapi375win\api\lib\fmodvc.lib" to "linden\libraries\i686-win32\lib_debug"
  • Copy "fmodapi375win\api\fmod.dll" to "linden\indra\newview"

OpenGL

Quicktime

  • Download & install the Quicktime SDK for Windows
  • Copy "QuicktimeSDK\Libraries\QTMLClient.lib" to "linden\libraries\i686-win32\lib_release".
  • Copy "QuicktimeSDK\Libraries\QTMLClient.lib" to "linden\libraries\i686-win32\lib_debug".
  • Copy the contents of "QuicktimeSDK\CIncludes" into "linden\libraries\i686-win32\include\quicktime".

Note that you can avoid using QuickTime if you want to do so. See below for details.

First Steps

Environment Setup

Lindens use VS2003 to develop the viewer. You need to convert solution file and project files from VS2003 format to VS2005 format. You also need to modify project files to work around the incompatibility between VS2003 and VS2005.

Note: linden\indra\indra_complete_vs8.sln is a solution file intended for the Visual Studio 2005, but it doesn't work (at least in 1.14.0.1 distribution.) You need to convert from 2003 version by yourself.

  • Start Visual Studio 2005 (or VC++ Express).
  • Use "File > Open > Project/Solution" to open the linden\indra\indra_complete\indra_complete.sln
  • Visual Studio prompts to update your project files. Allow it to do so. When the results are displayed, you may see warnings, but you should not see any errors.
  • Right click newview in the frame Solution Explorer and click "Set as StartUp Project".
  • Pick ReleaseNoOpt in the Solution Configurations drop-down box beside the green arrow under the tool bar, and do the followings on the Solution Explorer frame:
    1. Select all projects, i.e., llaudio, llcharacter, ..., win_updater, except for lscript_compile_fb and test. (You can do it by control-clicking on the projects.) Then, right click on the selection and choose Properties.
    2. On the Property Pages dialog box, under the Configuration Properties > C/C++ > General, change Treat Warnings As Errors to "No". (screen shot)
    3. Under the Configuration Properties > C/C++ > Language, change Treat wchar_t as Build-in Type to "No (/Zc:wchar_t-)" (screen shot).
    4. Click OK.
    5. Click newview to select it alone. Right click on it again and choose Properties. Under Configuration Properties > Linker > Input, click Additional Dependencies on the right to show a button labeled "..." on it at the very right on the line, then click the ... button. Scroll down the list to find libboost_regex-vc71-mt-s.lib. Rewrite it to libboost_regex-vc80-mt-s.lib. Click OK to close the "Additional Dependencies" dialog, then click OK again to close the "newview Property Pages" dialog box.
    6. Do the same thing for test.
    7. Now, the tough part. Do the following for all projects in the solution except for lscript_compile_fb, one project at a time:
      • Right click on a project and choose Properties
      • Under Configuration Properties > C/C++ > PreProcessor, append ";_CRT_SECURE_NO_DEPRECATE;_CRT_NONSTDC_NO_DEPRECATE;_USE_32BIT_TIME_T" at the end of the Preprocessor Definitions.(screen shot)
      • Click OK.
  • Pick ReleaseForDownload in the Solution COnfigurations drop-down box. Do the same thing (as 1 to 7 above) again.

Congratulations! You've converted solution file and project files.

NOTE: You need to do this by hand everytime a new viewer version is released...

Workarounds

There are more compatibility problems between VS2003 and VS2005. You need the following code edits.

unistd.h (Express only)

  • If you are using Visual C++ Express, create an empty file at "linden\libraries\include\unistd.h"
  • This should not be needed if you are using Visual Studio.

llwindowwin32.cpp

  • Two redeclared consts cause VS2005 to get confused during parsing (syntax errors, missing ;'s, etc.) Comment out:
    • const S32 WM_MOUSEWHEEL = 0x020A;
    • const S32 WHEEL_DELTA = 120;
  • This might be dependent on the version of the platform SDK you have installed (happens with Windows SDK v6.0 for Vista).

Disable/Change llMozLib

Disable

LL supplied pre-compiled llMozLib requires C++ class library come with VS2003. You can't link it with VS2005 class library. Workaround is to disable it as follows:

  • linden\indra\llcommon\llpreprocessor.h @ line 51 (two lines below #elif LL_WINDOWS)
--51: #define LL_LIBXUL_ENABLED		1
++51: #define LL_LIBXUL_ENABLED		0
Change

In version 1.14.0.2 (possibly earlier, but I didn't check), there is a llmozlib-vc80.lib which works with VS2005. If you have a copy of this, then instead of disabling as above simply change the dependency reference:

  • Select the ReleaseNoOpt configuration:
  1. On the newview project go to Properties->Configuration Properties->Linker->Input.
  2. In Additional Dependencies find llmozlib.lib and change it to llmozlib-vc80.lib.
  • Select the ReleaseForDownload configuration, and repeat steps 1-2.

You may need additional dll's to make this work at runtime (e.g. smime3.dll). The easiest thing to do is check linden\newview\postbuild.bat and ensure that you have all of the listed dll's in the debug and release library directories. They can be copied from the program directory of a Mozilla Firefox install to avoid having to compile Mozilla's NSS libraries.

Disable QuickTime

If you don't want to get Apple QuickTime SDK, you can disable it as follows:

  • linden\indra\llcommon\llpreprocessor.h @ line 50 (the line below #elif LL_WINDOWS)
--50: #define LL_QUICKTIME_ENABLED	1
++50: #define LL_QUICKTIME_ENABLED	0


Ignore test project

For whatever reason, the test project doesn't work under VS2005. Workaround is to disable it as follows:

  • Right click on the test and choose Unload Project.

Using Recent Windows SDK

  • See VWR-426 if you have recent Windows SDK.

Ready, Set, Build!

  • Build either ReleaseNoOpt (for debugging) or ReleaseForDownload (for production).
  • SecondLife.exe will be built in linden\indra\newview\ReleaseNoOpt or linden\indra\newview\ReleaseForDownload
  • Create a shortcut to SecondLife.exe, and change the start location to linden\indra\newview\ (all the .dll will be found there.)

Problems Running?

If you can't connect once you've built the viewer:

Cannot open include file: 'windows.h' problem

If you run into this problem: 

..\..\..\boost/regex/v4/fileiter.hpp(44) : fatal error C1083: Cannot open include file: 'windows.h': No such file or directory

Fix it with this: (thanks Fairlight!) 

set INCLUDE=C:\Program Files\Microsoft Platform SDK for Windows Server 2003 R2\Include;%INCLUDE%
set LIB=C:\Program Files\Microsoft Platform SDK for Windows Server 2003 R2\Lib;%LIB%
Retrieved from "https://wiki.secondlife.com/w/index.php?title=Compiling_the_viewer_(MSVS2005)&oldid=19353"