Microsoft Windows Builds
On Windows, there are several options on build (compile) environment of the Second Life.
This page explains how you can compile the Viewer on Microsoft Windows.
Currently, only 32 bit binary is tested. There seems to be several trials to produce 64 bit Windows .EXE of the Viewer. If you did, please write your experience on the discussion page (regardless it was successful or not!)
- 1 Choosing and preparing a compiler
- 2 Getting other development tools
- 3 Downloading source code
- 4 Installing libraries
- 5 Building with CMake
- 6 What to do if it doesn't work for you
Choosing and preparing a compiler
Supported compiler: Visual Studio .NET 2005 Professional
You need to setup the compiler and Microsoft Development tools as follows:
- Setup Microsoft Visual Studio
Community experimental compilers
If you don't have Visual Studio .NET 2005 Professional, you may wish to try one of the following alternatives.
- Visual C++ 2005 Express (instructions, but the screenshots for VS2008 are worth a glance too)
- Visual Studio 2008 (instructions)
- Visual C++ 2008 Express (instructions)
NOTE: Make sure you install to paths without spaces in it.
Getting other development tools
You will need to install the following tools to compile the Viewer:
- UniCode NSIS(download Unicode NSIS)
- This is the package installer used to build Setup.exe. Note: As of this writing the file is downloaded with an *.exec extension that needs renamed *.exe.--Nicky Perian 16:22, 30 March 2010 (UTC)
- CMake (download CMake)
- As of this writing, the latest version is 2.6.2. Note: There are many known issues with CMake 2.6.0 and 2.6.1 in conjunction with building the Second Life Viewer. CMake 2.4.8 is supported for compiling the 1.21 version of the Second Life Viewer, but 2.6.2 is likely to become the new minimum requirement in the near future.
- Cygwin (download 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. (If you missed one of these, the easiest thing to do is to re-run the entire installation.)
- Python (download either Python.org Standard Python or ActivePython
- If you are using a version of Python newer than v2.5, you may need to change the Python.cmake file. See the CMake discussion for details (this change was necessary as of 1.21-r99587 source branch). )
- The Windows Platform SDK
- Get the latest version (as of 23 March 2010) here: Windows SDK for Windows Server 2008 and .NET Framework 3.5 SP1
- DirectX 9.0 SDK
- Get the latest version (as of 29 Oct 2008) here: DirectX 9.0 SDK (August 2008)
Verify that Cygwin, CMake, and Python are in the windows "PATH".
NOTE: DO NOT use the Cygwin version of CMake or Python. The Build will fail. (CMake specifically excludes the Cygwin version of Python, in the
Downloading source code
You can download the Viewer source code on the source downloads page. You can also use a version control repository. If you're just starting out, it's probably best to get the latest Release version, rather than a Release Candidate, because the Release Candidates get updated quite often. But if you would rather work with the latest code, go for the version control repository "trunk".
If you're downloading from the source downloads page, there are three packages to get: the source package, the artwork package, and the library package. In versions 1.20 and earlier, Linden packaged the library binaries in the Libs package. For 1.21 and beyond, the CMake develop.py script now downloads most of the libraries that were previously in the libs zip file. This saves developers who are tracking trunk from constantly downloading them every update and only downloads updated libraries. As of this writing, there are some pieces packages that still require downloading, so be sure to grab the library and artwork bundles from the source downloads page.
- If the directory path you keep the SL source in has a space in it, the batch file that copies message_template.msg will fail. So, if you unzip or checkout the source tree into, e.g., "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 or checkout your source tree into a directory that has as short full pathname as possible, since long paths cause some unexpected trouble during the build.
In other words, the easiest way to get this working is to get source, artwork, and libs from the source downloads page and unpack them all into the same directory/folder, which ideally would be a folder in (or near) the root directory with a short name like sl_1_21_6.
SL Viewer depends on some third party libraries. Some of them are open source, some others are not.
Open source libraries
As of Viewer version 1.21, all open source libraries are automatically downloaded as part of the build process, unless you choose to configure a standalone build.
Linden does not include the following proprietary libraries. You will need to follow the instructions to acquire below and copy them to the source path.
However, it probably is a good idea to build an empty directory tree for the files below and first copy the files there and once completed, copy the whole tree to the actual source folder (like XCOPY OLIB SL_1_16_0_5 /S). The reason is, that these steps are cumbersome and will have to be repeated for each new release (at least if you keep the source for each release in it's own folder). If you do not want to do this, of course you can just copy the files directly into the linden source paths.
rem OLIBS.CMD to build a folder tree for 3rd party libraries and includes md olibs md olibs\linden\ md olibs\linden\libraries md olibs\linden\libraries\include md olibs\linden\libraries\i686-win32 md olibs\linden\libraries\i686-win32\lib_release md olibs\linden\libraries\i686-win32\lib_debug md olibs\linden\libraries\i686-win32\include md olibs\linden\libraries\i686-win32\include\GL md olibs\linden\libraries\i686-win32\include\quicktime md olibs\linden\indra md olibs\linden\indra\newview
- Download & extract FMOD3.75 API for Windows. (later versions, like FMOD Ex, are incompatible).
- Copy "fmodapi375win\api\inc\fmod.h" to "linden\libraries\include"
- Copy "fmodapi375win\api\inc\fmod_errors.h" to "linden\libraries\include"
- Copy "fmodapi375win\api\inc\fmoddyn.h" to "linden\libraries\include"
- Copy "fmodapi375win\api\lib\fmodvc.lib" to "linden\libraries\i686-win32\lib_release" and to "linden\libraries\i686-win32\lib_debug"
(If using cmake, copy "fmodapi375win\api\lib\fmodvc.lib" to "linden\libraries\i686-win32\lib\release" and to "linden\libraries\i686-win32\lib\debug")
- Copy "fmodapi375win\api\fmod.dll" to "linden\indra\newview"
Currently - as of version 1.21 - CMake requires Quicktime to be installed.
Note: This download requires a registration at the Apple Quicktime website and take a bit of time. You can avoid using QuickTime if you want, see this for details. Remember that your Viewer can't play in-world movies if you do so.
- Download & install the Quicktime SDK for Windows
- Copy "QuicktimeSDK\Libraries\QTMLClient.lib" to "linden\libraries\i686-win32\lib_release" and to "linden\libraries\i686-win32\lib_debug".
(If using CMake, copy "QuicktimeSDK\Libraries\QTMLClient.lib" to "linden\libraries\i686-win32\lib\release" and to "linden\libraries\i686-win32\lib\debug" instead)
- Copy the contents of "QuicktimeSDK\CIncludes" into "linden\libraries\i686-win32\include\quicktime".
Building with CMake
At this point, you should be ready to use CMake. NOTE: CMake is only supported for Viewer versions 1.21 and beyond. Before you first run a build, you'll need to configure things. There's a
develop.py script that will create a reasonably sane default configuration for you.
You must make sure that cmake is registered in the Windows environment, or you will get strange errors from develop.py. Right click My Computer -> Properties -> Advanced -> Environment Variables -> Inside System Variables choose PATH (case insensitive) and click Edit. Now in the value field, go to the end of the value and add a semicolon (;), and then the folder containing necessary binaries (example: C:\Program Files\CMake 2.8\bin). This might already have been set by the cmake installer.
From the command line, cd into the indra subdirectory and run one of the following commands (depending on your choice of platform and build environment):
- VisualStudio 2005:
"python develop.py -G VC80"
- VisualStudio 2008:
"python develop.py -G VC90"
- VisualStudio 2005:
NOTE: The above commands will configure a "non-standalone" version of the source code tree. This means that the required third party library packages (as built by Linden Lab) will be downloaded during the CMake process.
Finding your build directory
In the CMake world, we keep source and object files separate. The
develop.py script will create and populate a build directory for you. It should be in one of the following locations:
- VS 2005:
- VS 2008:
To start a build, do one of the following:
python develop.py buildin the indra directory.
- Load it into your IDE. For MSVS VC++:
- Use "File -> Open -> Project/Solution", and navigate to linden/indra/build-VC80/Viewer.vcproj (or build-VC90, as appropriate).
- In the MSVS toolbar, just to the right of the triangular "Start Debugging" arrow, is a text box whose tooltip is "Solution Configurations". Select RelWithDebugInfo.
- If ALL_BUILD is not set as your StartUp Project (the StartUp Project is displayed in bold font), right-click on ALL_BUILD and choose "Set as StartUp Project".
- Right-click on ALL_BUILD and choose "Properties". In "Configuration Properties -> Debugging", find "Working Directory" and navigate to "linden\indra\newview".
- (For Snowglobe 1.x) In the Solution Explorer pane, right-click on the project named "prepare" and select Project Only -> Build Only prepare. This downloads and installs precompiled libraries and only needs to be done when the source tree is clean or if libraries in the list included in the source tree get updated. Running this when not required is brief and causes no harm.
- Build -> Build Solution (F7)
- Debug -> "Start Debugging" or "Start without debugging".
- MSVC might not be able to find the executable. If not, point it to "linden\indra\build-VC80\newview\relwithdebinfo\secondlife-bin.exe", and try again.
- You may see an error due to not being able to find fmod.dll. If so, find a copy (remember, you copied this in a step above) and copy it into "indra\build-VC80\newview\relwithdebinfo". Try again.
- You may see an error due to not finding llkdu.dll. If so, find it in the normal installed version (make sure it's the same version as your source) and copy it into "indra\build-VC80\newview\relwithdebinfo". Try again.
- Good luck!
Where's the built Viewer?
On Windows, the built Viewer ought to run from VS2005.
To run outside MS VS, see Discussion tab: Talk:Microsoft_Windows_Builds#Running_Viewer_outside_of_MS_VC
Build instructions for 1.20 and earlier
See Compiling older Viewers (1.20 and earlier with MSVS) if you'd like to compile a version of the Viewer older than 1.20.
What to do if it doesn't work for you
- Ask for help on IRC (irc.freenode.net #opensl)
- Find someone on the SLDev mailing list
- Fix it: Modifying CMake Files (and please, submit a patch!)
Please also see the (user contributed) instructions at User:Michelle2_Zenovka/cmake