Compiling the viewer (MSVS2003)

The following instructions are for compiling the Second Life viewer on Windows. For other platforms, see Compiling the viewer

Windows

Development Environment

The following dev environment is what LL uses for Windows development. There is no reason that the Second Life viewer can not be built using other enviroments, but it will take some extra work. We should soon have instructions for building the viewer using Microsoft's Visual Studio .NET 2005 Express, which at the time of writing, was freely available.

• Visual Studio .NET 2003 Professional
  • Microsoft Platform SDK
  • NEED NEWER DIRECTX DirectX 9.0 SDK Update (Summer 2003)
  • Set up the project globals:
    • Start Visual C++
    • Go to Tools/Options/Projects/VC++ Directories
    • Make sure that the includes and libraries paths have the DirectX SDK paths first, then the Platform SDK paths, and then the Visual C++ paths.
• ActivePython 2.3x
• ActivePerl
• Cygwin
  • When you run the cygwin setup utility make sure you have selected to install patchutil, flex, and bison (all located under "devel").

Libraries

In the source directory, there are several empty placeholder folders for libraries which the Second Life viewer relies upon, but which Linden Lab can not ship the source. This section describes how to acquire the code, and how to install it. It is a good idea to install in order, as some libraries will rely on previous installs (ie, libcurl needs opensll and zlib).

• DLLs
  • xul.dll - build moz?
  • js3250.dll
  • nspr4.dll
  • plc4.dll
  • plds4.dll
  • smime2.dll
  • nss3.dll
  • softokn3.dll
  • ssl3.dll
  • those are all the moz
  • fmod.dll
  • freetype6.dll
  • zlib1.dll

Boost

• Download & extract Boost source for win32.
• Copy the "boost_X_XX_X\boost" folder to "libraries\include\".
• Run "boost_X_XX_X\tools\build\jam_src\build".
• Copy "boost_X_XX_X\tools\build\jam_src\bin.ntx86\bjam.exe" to "boost_X_XX_X\".
• Using the command prompt, build the static libraries:
  • cd linden\libraries\boost-X_XX_X\
  • set PYTHON_ROOT=C:\Python23
  • set PYTHON_VERSION=2.3
  • bjam stage
• copy "boost_X_XX_X\stage\lib\libboost_python-vc71-mt.lib" to "\libraries\i686-win32\lib_release\"
• copy "boost_X_XX_X\stage\lib\libboost_python-vc71-mt-gd.lib" to "\libraries\i686-win32\lib_release\libboost_python-vc71-mt.lib"
• copy "boost_X_XX_X\stage\lib\libboost_regex-vc71-mt-s.lib" to "\libraries\i686-win32\lib_release\"
• copy "boost_X_XX_X\stage\lib\libboost_regex-vc71-mt-sgd.lib" to "\libraries\i686-win32\lib_release\libboost_regex-vc71-mt-s.lib"

Expat

• Download and run Expat Win32 Binary
• copy "Expat-X.X.X\Source\lib\expat.h" to "libraries\include\expat\".
• copy "Expat-X.X.X\Source\lib\expat_external.h" to "libraries\include\expat\".
• copy "Expat-X.X.X\StaticLibs\libexpatMT.lib" to "libraries\i686-win32\lib_release\".
• copy "Expat-X.X.X\StaticLibs\libexpatMT.lib" to "libraries\i686-win32\lib_debug\".

ZLib

• Download & extract Zlib
• copy "zlibXXX\zlib.h" to "libraries\include\zlib\".
• copy "zlibXXX\zconf.h" to "libraries\include\zlib\".
• Using the command prompt, build the static libraries:
  • "C:\Program Files\Microsoft Visual Studio .net 2003\Common7\Tools\vsvars32.bat"
  • cd %ZLIB_FOLDER%
  • nmake -f win32/Makefile.msc
• copy "zlibXXX\zlib.lib" to "libraries\i686-win32\lib_release\".
• copy "zlibXXX\zlib.lib" to "libraries\i686-win32\lib_debug\".

Apache Portable Runtime

• Take out XML dependancies, move expat headers!!!!
• Download & extract apr, apr-util, and apr-iconv.
• For simplicity place all three in a parallel directory structure, and rename the directories:
  • C:\work\apr\
  • C:\work\apr-iconv\
  • C:\work\apr-util\
• Open the "\apr-util\aprutil.dsp" project in VS2003.
• For the apr, apr-util & aper-iconv projects, change the Runtime Library from Multi-threaded DLL to Multi-threaded:
  • Right click each project in the Solution Explorer, choose properties.
  • In the C/C++ folder, choose Code Generation.
  • Change the Runtime Library to Muli-threaded.
  • Repeat for both debug and release.
• Remove the apr-util's dependency on xml:
  • Right click the apr-util project, and choose dependencies.
  • Uncheck xml.
  • Right click the xml project in the Solution Explorer.
  • Choose Remove.
• copy "Expat-X.X.X\Source\lib\expat.h" to "apr\apr-util\xml".
• copy "Expat-X.X.X\Source\lib\expat_external.h" to "apr\apr-util\xml\".
• Build Solution for Debug, and build solution for release.
• copy "\apr-util\LibR\aprutil-1.lib" to "libraries\i686-win32\lib_release".
• copy "\apr-util\LibR\aprutil_src.pdb" to "libraries\i686-win32\lib_release".
• copy "\apr\LibR\apr-1.lib" to "libraries\i686-win32\lib_release".
• copy "\apr\LibR\apr_src.pdb" to "libraries\i686-win32\lib_release".
• copy "\apr-util\LibD\aprutil-1.lib" to "libraries\i686-win32\lib_debug".
• copy "\apr-util\LibD\aprutil_src.pdb" to "libraries\i686-win32\lib_debug".
• copy "\apr\LibD\apr-1.lib" to "libraries\i686-win32\lib_debug".
• copy "\apr\LibD\apr_src.pdb" to "libraries\i686-win32\lib_debug".
• copy header files:
  • copy the contents of "apr\include" to "libraries\i686-win32\include\apr-1".
  • in "libraries\i686-win32\include\apr-1\arch\" only the "win32" dir and "apr_private_common.h" are required.
  • copy the contents of "apr-util\include" to "libraries\i686-win32\include\apr-1".

Freetype

• Download and run FreeType for Windows.
• copy the contents of "GnuWin32\include\freetype2\freetype" into "\libraries\include\freetype"
• copy "GnuWin32\libfreetype.lib" to "libraries\i686-win32\lib_release".
• copy "GnuWin32\libfreetype.lib" to "libraries\i686-win32\lib_debug".
• copy "GnuWin32\include\ft2build.h" to "libraries\include".

gl

• Download glext.h, glxext.h, and wglext.h
• Copy them to "libraries\i686-win32\include\GL"
• WE PACK THE REST

OpenSSL

• Download and extract
• Using the command prompt, build the static libraries:
  • cd %PATH%
  • perl Configure VC-WIN32
  • ms\do_masm
• Edit openssl-X.X.Xy\ms\nt.mak
  • Change /MD to /MT in CFLAGS
• back in the command prompt:
  • nmake -f ms\nt.mak
  • copy all the ".lib" files from "openssl-X.X.Xy\out32" to "libraries\i686-win32\lib_release"

cURL

• Download & extract the curl source.
• Edit "curl-X.XX.X\lib\Makefile.vc6"
  • Change OPENSSL_PATH to ../../../openssl-<version>
  • Change the ZLIB_PATH to ../../../zlib-<version>/src
  • Change RTLIB to /MT
  • Change RTLIBD to /MTd
• Using the command prompt, build the static libraries:
  • "C:\Program Files\Microsoft Visual Studio .net 2003\Common7\Tools\vsvars32.bat"
  • cd %PATH%\lib\
  • nmake /f Makefile.vc6 CFG=release-ssl-zlib
  • Copy "curl-X.XX.X\lib\release-ssl-zlib\libcurl.lib" to "libraries\i686-win32\lib_debug"
  • Copy "curl-X.XX.X\lib\release-ssl-zlib\libcurl.lib" to "libraries\i686-win32\lib_release"
  • Copy all the header files in "curl-X.XX.X\include\curl" to "libraries\include\curl"

XMLRPC-epi

• WE SHOULD SHIP THIS

Vorbis & Ogg

• Download & extract libvorbis.
• Download & extract libogg.
• Build & copy libogg first:
  • Open "libogg-X.X.X\win32\ogg_static.dsp" in visual studio.
  • Build both debug and release solutions.
  • Copy "libogg-X.X.X\include\ogg" into "libvorbis-X.X.X\include"
  • Copy "libogg-X.X.X\include\ogg\ogg.h" to "libraries\include\ogg"
  • Copy "libogg-X.X.X\include\ogg\os_types.h" to "libraries\include\ogg"
  • Copy "libogg-X.X.X\win32\Static_Release\ogg_static.lib" to "libraries\i686-win32\lib_release"
  • Copy "libogg-X.X.X\win32\Static_Debug\ogg_static_d.lib" to "libraries\i686-win32\lib_debug\ogg_static.lib"
• Build & copy libvorbis:
  • Build release & debug "libvorbis-X.X.X\win32\vorbis_static.dsp"
  • Build release & debug "libvorbis-X.X.X\win32\vorbisfile_static.dsp"
  • Build release & debug "libvorbis-X.X.X\win32\vorbisenc_static.dsp"
  • copy "libvorbis-X.X.X\include\vorbis\codec.h" to "libraries\include\vorbis"
  • copy "libvorbis-X.X.X\include\vorbis\vorbisfile.h" to "libraries\include\vorbis"
  • copy "libvorbis-X.X.X\include\vorbis\vorbisenc.h" to "libraries\include\vorbis"
  • copy "libvorbis-1.1.2\win32\Vorbis_Static_Release\vorbis_static.lib" to "libraries\i686-win32\lib_release"
  • copy "libvorbis-1.1.2\win32\VorbisEnc_Static_Release\vorbisenc_static.lib" to "libraries\i686-win32\lib_release"
  • copy "libvorbis-1.1.2\win32\VorbisFile_Static_Release\vorbisfile_static.lib" to "libraries\i686-win32\lib_release"
  • copy "libvorbis-1.1.2\win32\Vorbis_Static_Debug\vorbis_static_d.lib" to "libraries\i686-win32\lib_debug\vorbis_static.lib"
  • copy "libvorbis-1.1.2\win32\VorbisEnc_Static_Debug\vorbisenc_static_d.lib" to "libraries\i686-win32\lib_debug\vorbisenc_static.lib"
  • copy "libvorbis-1.1.2\win32\VorbisFile_Static_Debug\vorbisfile_static_d.lib" to "libraries\i686-win32\lib_debug\vorbisfile_static.lib"

JPEGlib

• Download & extract jpeglib.
• Copy "jpegsr6\jpeg-6b\makefile.vc" to the file "jpegsr6\jpeg-6b\Makefile"
• Copy "jpegsr6\jpeg-6b\jconfig.vc" to "jpegsr6\jpeg-6b\jconfig.h"
• At the command prompt:
  • "C:\Program Files\Microsoft Visual Studio .net 2003\Common7\Tools\vsvars32.bat"
  • cd %ZLIB_FOLDER%
  • nmake -f Makefile
• copy "jconfig.h", "jerror.h", "jmorecfg.h", "jpeglib.h", and "jinclude.h" from * to "libraries\include\jpeglib"
• copy "jpegsr6\jpeg-6b\libjpeg.lib" to "libraries\i686-win32\lib_release"
• copy "jpegsr6\jpeg-6b\libjpeg.lib" to "libraries\i686-win32\lib_debug"
• Patch jpeglib
• RENAME??

Fmod

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

MKS

• need to seperate this from the build?

Quicktime

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

OpenJPEG

• Download and extract openjpeg for win32.
• Copy "openjpeg10_win32\openjpeg.h" to ""\libraries\include\openjpeg"
• Copy "openjpeg10_win32\LibOpenJPEG.lib" to "\libraries\i686-win32\lib_release".
• Copy "openjpeg10_win32\LibOpenJPEG.lib" to "\libraries\i686-win32\lib_debug".
• might need to compile by hand

TUT

• Download and extract tut
• Copy "tut.h", "tut_reporter.h", and "tut_restartable.h" to "libraries\include\tut"
• Errors in test?

Mozilla

• We need to ship llmozlib.h and llmozlib.lib
• Is there an easier way to get the .dll's then building mozilla?

Other Notes

For everything that doesn't fall under dev environment or libs

lscript_compile_ly

• Open up the indra.sln solution in visual studio
• Expand the lscript_compile_ly project in the Solution Explorer
• Edit the properties of indra.l & indra.y to use flex and bison:
  • Right click on indra.l and select properties.
  • Select the General category under Custom Build Step
  • Edit the command line - change

    ..\..\..\libraries\i686-win32\mks\lex.exe -o lex_yy.cpp indra.l

    to

    C:\cygwin\bin\flex.exe -olex_yy.cpp indra.l