Viewer 2 Microsoft Windows Builds

Template:Needs Translation/de Template:Needs Translation/es Template:Needs Translation/el Template:Needs Translation/fr Template:Needs Translation/he Template:Needs Translation/it Template:Needs Translation/ko Template:Needs Translation/nl Template:Needs Translation/hu Template:Needs Translation/no Template:Needs Translation/da Template:Needs Translation/sv Template:Needs Translation/tr Template:Needs Translation/pl Template:Needs Translation/pt Template:Needs Translation/ru Template:Needs Translation/th Template:Needs Translation/uk Template:Needs Translation/zh-Hans Template:Needs Translation/zh-Hant

THESE INSTRUCTIONS ARE NOT YET COMPLETE OR DEBUGGED as of 18 April 2010.

When finished, we hope this page will constitute a complete recipe for compiling viewer 2 from source on a Windows machine.

Philosophy: to keep it brief, this page should only include steps we KNOW ARE NEEDED, not random hints. Extra details or open issues can go on the talk page.

Following this recipe will probably take 6 to 12 hours of wall-clock time, and 2 to 6 hours of your time, if you're starting from a fresh Windows XP/Vista/7 system.

Establish your programming environment

This is needed for compiling any viewer based on the LL open source code, but only needs to be done once.

• Obtain Visual Studio (2005, 2008, 2010) (Express is OK)
  • Click here to download Visual C++ Express - current version is VS2010
  • Note: LL still uses VS2005 internally, which uses the VC80 libraries. VS2008 uses the VC90 libraries. VS2010 TBD (test with the VC90 libraries new ones for VC100 may need to be made).
• Install Microsoft Platform & DirectX SDKs
  • Download and install Windows SDK for Windows Server 2008 and .NET Framework 3.5
  • Download and install DirectX SDK (August 2008)

• Install other development tools
  • CMake (download CMake)
    • must be version 2.6.2 or higher
  • 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.
  • Python (download either Python.org Standard Python or ActivePython

Download and compile libraries that must be manually added to each LL source release

It is probably 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. Then, if you obtain a new batch of source code, you can save some steps.

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

SVN folder tree - for simplicity of coping files to your build folder
  trunk\indra\newview
  trunk\libraries\i686-win32\include\GL
  trunk\libraries\i686-win32\include\quicktime
  trunk\libraries\i686-win32\lib\debug
  trunk\libraries\i686-win32\lib\release
            

Quicktime

• 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"
• Copy the contents of "QuicktimeSDK\CIncludes" into "linden\libraries\i686-win32\include\quicktime".

Fmod

• 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"
• Copy "fmodapi375win\api\fmod.dll" to "linden\indra\newview"

Boost

• Grab the files that Robin Cornelius has precompiled at

http://www.byteme.org.uk/downloads/boost_1_39_VC90_no_scl_shared_crt_static_link.zip

• If you get the zip file from Robin Cornelius copy the libraries folder in the the tree you made above for fmod and QuickTime files that way you have a ready back up of those files for if you update your build directory from the SVN server.
• or alternatively follow the instructions from the 25/Feb/10 and 15/Apr/10 entries of http://jira.secondlife.com/browse/VWR-9541

((TBD: verify, simplify, fix))

cares

TBD

Set up your source code tree

LL distributes the source code in three parts: the source package, the artwork package, and the library package. You should choose whether to use a snapshot or SVN checkout. You'll need art and libraries from a snapshot if you use the SVN method.

• Unzip or checkout your source tree into a directory that has as short full pathname as possible, with NO SPACES in it, to avoid trouble in the build scripts. A sugestion would be to use the same dev tree as LL as all folder names are short and do not have any spaces.

• Example: ((specific snapshot example TBD; SVN example also ))

• Copy your "olibs" from above into the source tree.

Fix known problems with the source code tree

TBD - edits to scripts that must be made for windows VC90 builds to succeed?

Known Problems:

• boost.make file has to be edited as shown in the JIRA mentioned in the above section in order to use the boost files in VS2008.

Initial build steps using develop.py and CMake

You may notice that there's no Visual Studio project file as part of the distributed source tree. That's because it is GENERATED in this step using command-line tools. Only after this step can you begin using the IDE.

• open a Command Prompt window

• Run develop.py --
  • From the command line, cd into the indra subdirectory
  • Run "develop.py -G VC90" or "python develop.py -G VC90"
  • The develop.py script will create and populate a build directory for you. It should be in 'build-vc90'

((TBD: how to tell if you succeeded))

Compile using the IDE

• Run Visual Studio.
• Use "File -> Open -> Project/Solution", navigate to linden/indra/build-VC90/Viewer.vcproj, and open it.
  • if you can't find this file, perhaps your previous run of develop.py failed.
• Project ALL_BUILD and configuration RelWithDebugInfo should be selected, and the working directory for ALL_BUILD should be "linden\indra\newview".
• Build -> Build Solution (F7)

Iteratively fix things until the compile succeeds

((TBD - add any fixup steps here. e.g. does fmod375.dll need to be moved into RelWithDbgInfo at this step?))

• report your experiences, if useful, on the talk page, https://wiki.secondlife.com/wiki/Talk:Viewer_2_Microsoft_Windows_Builds
• ask for help on the SL "Snowglobe" group or the opensource-dev mailing list.

References

These instructions are condensed from about a dozen previous pages of info:

• https://wiki.secondlife.com/wiki/Microsoft_Windows_Builds
• https://wiki.secondlife.com/wiki/Compiling_the_Viewer_%28MSVS2008%29
• https://wiki.secondlife.com/wiki/User:Jodiah_Jensen#UPDATING_BOOST_LIBRARIES_TO_WORK_WITH_VS2008
  • now partially incorrect
• http://jira.secondlife.com/browse/VWR-9541

((add other references here))