Difference between revisions of "Build the Viewer on Linux"

From Second Life Wiki
Jump to navigation Jump to search
Line 2: Line 2:


The following are instructions for building the Second Life viewer on linux. This process has been used on [http://www.debian.org/ debian] and debian based systems like [http://www.ubuntu.com/ ubuntu], and also on [http://www.fedoraproject.org/ Fedora]. For other platforms, see [[Get source and compile]].
The following are instructions for building the Second Life viewer on linux. This process has been used on [http://www.debian.org/ debian] and debian based systems like [http://www.ubuntu.com/ ubuntu], and also on [http://www.fedoraproject.org/ Fedora]. For other platforms, see [[Get source and compile]].
{{vital-info|How to compile '''with''' llmozlib (see [[Talk:Compiling_the_viewer_%28Linux%29#llmozlib|discussion]])}}


= Building the client =
= Building the client =
Line 245: Line 243:
== Compiling ==
== Compiling ==
=== Build Types ===
=== Build Types ===
The ''BUILD'' parameter specifies the build type. For normal usage, use '''release'''. If you plan to work on the source, choose '''releasenoopt''' or '''debug''', as these versions are unoptimized and much easier to debug.
The ''BUILD'' parameter specifies the build type. For normal usage, use '''release'''. If you plan to work on the source, choose '''releasenoopt''' or '''debug''', as these versions are unoptimized and much easier to debug. 
 
You can also edit the scons file to cause releasefordownload to skip the "stripping" step, for a version that is relatively easy to debug, yet still performs well.


* '''release''': Optimized build for release.
* '''release''': Optimized build for release.
Line 253: Line 253:
<br />
<br />
=== Building ===
=== Building ===
=== Disable llMozLib ===
=== Enabling llMozLib ===
Add MOZLIB=no to your Scons build command when compiling the source.
Add MOZLIB=yes to your Scons build command when compiling the source.  Failure to do this will cause errors on some versions, due to badly structured ifdefs in the code.  If you really don't want mozlib you must apply the patches attached to VWR-3748.
<br />
<br />
<code>
<code>
  $ cd indra
  $ cd indra
  $ scons DISTCC=no BTARGET=client BUILD=release MOZLIB=no
  $ scons DISTCC=no BTARGET=client BUILD=release MOZLIB=yes
</code>
</code>
Expect a build time of a couple of hours.  The resulting unstripped Second Life Viewer binary is <b>newview/secondlife-i686-bin</b>. Note that temporary object code is compiled into <b>/tmp/$USER</b> by default (where $USER is your username) - this can be changed by prefixing the <b>scons</b> command above with <b>TEMP_BUILD_DIR="<i>[full directory path]</i>"</b>. For example:
Expect a build time of a couple of hours.  The resulting unstripped Second Life Viewer binary is <b>newview/secondlife-i686-bin</b>. Note that temporary object code is compiled into <b>/tmp/$USER</b> by default (where $USER is your username) - this can be changed by prefixing the <b>scons</b> command above with <b>TEMP_BUILD_DIR="<i>[full directory path]</i>"</b>. For example:

Revision as of 08:05, 23 December 2007

Open Source Portal

The following are instructions for building the Second Life viewer on linux. This process has been used on debian and debian based systems like ubuntu, and also on Fedora. For other platforms, see Get source and compile.

Building the client

To build the Second Life Viewer you will first need to install the required tools and libraries. The following sections outline steps to build the client from source. To simplify building, Linden labs has been nice enough to prepackage some of the libraries and bundled them up in an additional tar file.

And while The Second Life Viewer is not a trivial build, and experience with building large software packages will help you greatly - but don't be daunted, it should be simple once the dependencies are in the right place.

The tasks are:

  1. Install required tools.
  2. Unpack source and art trees from Linden Labs.
  3. Install libraries not shipped by Linden Labs.
  4. Unpack or install the other required libraries and headers.
  5. Compile.



Required tools

There are a number of tools that need to be installed first.

  • SCons build tool [package: scons]
  • GCC 3.4 C/C++ compiler
    • [debian/ubuntu: g++-3.4]
    • [fedora: compat-gcc-34-c++]
      • [on line 342 of indra/SConstruct (Branch_1-18-2-Viewer, Fedora7):
      • change gcc_bin = 'g++-3.4' to gcc_bin = 'g++34']
    • other GCC versions are not well-tested; GCC 4.x will NOT currently build the viewer without a few simple code adjustments. {link to them pls}
  • yacc [suggest packages: bison]
  • lex [suggest packages: flex]



Unpack the source tree

You can get the source either from the source archives available at Source downloads, or you can get it from Subversion.

Using a source archive is the easier option, but if you plan to do active development and want to make your own modifications, while merging LL's changes, subversion will probably be much more convenient on the long term.

Getting the source from the source archives

Get the source from Source downloads. You will need all 3 archives: source, artwork and libraries.

Choose a location and unpack the source tree and the art work. They will be extracted into a directory call linden. 

% tar -xzf slviewer-src-<version>.tar.gz
% tar -xzf slviewer-<os>-libs-<version>.tar.gz
% unzip slviewer-artwork-<version>.zip


Getting the source from Subversion

Select a source branch to check out.

Check it out with: 

% svn co http://svn.secondlife.com/svn/linden/<branch> [directory]

If you don't specify the directory, it'll use the name of the branch as the default.

Now you will have a directory with the source code. This only includes the source code itself, without the libraries or artwork. You will have to get them from the Source downloads and unpack them into the tree.

If the directory SVN created is called 'linden' then you can directly unzip and untar the archives on top of it. If it's called something else, create a symlink: 

% ln -sf <branch> linden

Now unpack the libraries and artwork: 

% tar -xzf slviewer-<os>-libs-<version>.tar.gz
% unzip slviewer-artwork-<version>.zip


Installing the required libraries (that Linden labs can not or does not provide)

Libraries and header files that usually come with a Linux distribution

Make sure the libraries and header files for the following packages are installed on your system:

GL
[ubuntu: mesa-common-dev, fedora: mesa-libGL-devel]
GLU
[ubuntu: libglu1-mesa-dev, fedora: mesa-libGLU-devel]
glibc
[fedora: glibc-devel]
stdc++ library
[fedora: libstdc++-devel]
X11
[ubuntu: libx11-dev, fedora: libX11-devel]
zlib
[fedora: zlib-devel]
openssl
[ubuntu: libssl-dev redhat: openssl-devel]

FMOD (audio)

  • FMOD provides audio output, but (although 'free' in some senses) is not itself open-source. If you wish to avoid FMOD, thus disabling audio, you may make these changes:
    • Comment-out the libfmod line in indra/newview/viewer_manifest.py
    • Add FMOD=no to your Scons build command when compiling the source.
  • If you want to use FMOD, fetch and unpack FMOD 3.75 <http://www.fmod.org/>

% wget http://www.fmod.org/index.php/release/version/fmodapi375linux.tar.gz
% tar -xzvf fmodapi375linux.tar.gz
% cd fmodapi375linux/
% cp api/inc/* ../linden/libraries/i686-linux/include/
% cp api/libfmod-3.75.so ../linden/libraries/i686-linux/lib_release_client/



Installing the required dependencies (prepackaged by Linden labs)

The Second Life Viewer has a number of compile/link dependencies on external libraries which are needed - to help you, the source download page contains a link to a slviewer-linux-libs package which you unpack over the source tree to fill most of the dependencies (and thus avoid most of the fiddly work described on this page).

If you download the libs to the top folder, where the linden folder is after getting and extracting the viewer source code tarball, the following command should unpack everything to the right spot. 

tar xvfz slviewer-linux-libs-<version>.tar.gz

If you choose to use the provided libraries you can skip to Compiling the client.

Doing yourself

If you are porting to a new architecture or wish to make a package tailored to your Linux distribution's own libraries. You will have to install the following additional dependencies listed below. Paths and package names given here are based on Ubuntu 7.04 and may vary according to your Linux distribution.

List of libraries

  • apr-1 [ubuntu: libapr1-dev, fedora: apr-devel]
  • aprutil-1 [ubuntu: libaprutil1-dev, fedora: apr-util-devel]
  • boost [ubuntu: libboost-dev, fedora: boost-devel]
  • boost-regex [ubuntu: libboost-regex-dev]
  • curl library at least version 7.15.4 is recommended, 7.16.x is ideal.
    • [ubuntu: libcurl3-dev, fedora: curl-devel]
    • If you are compiling your own version of Curl, then you should consider configuring it to use the c-ares library so that DNS lookups will be asynchronous.

% cd ELFIO && g++-3.4 -shared *.o -o libELFIO.so

  • expat [ubuntu: libexpat1-dev, fedora: expat-devel]
  • google-perftools library for the tcmalloc and stacktrace libraries. (memory checking)
    • [ubuntu: libgoogle-perftools-dev, fedora: google-perftools-devel.i386
  • GTK 2.x development headers [ubuntu: libgtk2.0-dev, fedora: gtk2-devel]
  • jpeglib [ubuntu: libjpeg62-dev, fedora: libjpeg-devel]


  • OpenJPEG <http://www.openjpeg.org/>
    • note: OpenJPEG 1.1.1 or greater is required which has the macro OPJ_PATH_LEN, if the header has MAX_PATH, then upgrade or it will crash with a divide by zero error as the structures would be two different sizes.
      • what does this mean?
  • SDL [ubuntu libsdl1.2-dev, fedora: SDL-devel]
  • Vorbis [ubuntu: libvorbis-dev, fedora: libvorbis-devel]
  • xmlrpc-epi 0.51 <http://xmlrpc-epi.sourceforge.net/>
    • note: not xmlrpc-c (xmlrpc-c has a library and headers with the same name but is not compatible)
    • Apply patches from the instructions in patch xmlrpc-epi
      • does this still work?
        • The patches applied OK for me, but didn't result in a usable library. The patches below appear to work better, except that xmlrpc-epi-0.51-rename.patch didn't apply cleanly (but the manual changes were easy). I'll update once I get the other dependencies worked out. Jackson Sadovnycha 21:39, 30 August 2007 (PDT)
    • See also:



Copy headers and libraries into the source tree

Here is a guide to the sequence of shell commands needed to copy the required headers and libraries into the Second Life Viewer source tree for building. Actual paths to system headers may vary according to Linux distribution.

If you are using the easy slviewer-linux-libs bundle then you can skip the rest of this section, otherwise you will also need to perform the following:

  • ${SLSRC} refers to the top-level directory of the Second Life Viewer source tree.
  • ${OPENJPEG} refers to the top-level directory of your completed OpenJPEG build.
  • ${ELFIO} refers to the top-level directory of your completed ELFIO build.

cp -a /usr/include/atk-1.0 ${SLSRC}/libraries/i686-linux/include/
cp -a /usr/include/gtk-2.0 ${SLSRC}/libraries/i686-linux/include/
cp -a /usr/lib/gtk-2.0/include/* ${SLSRC}/libraries/i686-linux/include/gtk-2.0/
cp -a /usr/include/glib-2.0 ${SLSRC}/libraries/i686-linux/include/
cp -a /usr/lib/glib-2.0/include/* ${SLSRC}/libraries/i686-linux/include/glib-2.0/
cp -a /usr/include/pango-1.0 ${SLSRC}/libraries/i686-linux/include/

if your GTK is fairly recent and thus needs Cairo: 

cp -a /usr/include/cairo/* ${SLSRC}/libraries/i686-linux/include



cp -a /usr/include/apr-1.0/ ${SLSRC}/libraries/i686-linux/include/apr-1

mkdir ${SLSRC}/libraries/i686-linux/include/expat
cp -a /usr/include/expat*.h ${SLSRC}/libraries/i686-linux/include/expat/

mkdir ${SLSRC}/libraries/i686-linux/include/zlib
cp -a /usr/include/zlib*.h ${SLSRC}/libraries/i686-linux/include/zlib/

mkdir ${SLSRC}/libraries/i686-linux/include/openjpeg
cp ${OPENJPEG}/libopenjpeg/openjpeg.h ${SLSRC}/libraries/i686-linux/include/openjpeg/
cp ${OPENJPEG}/libopenjpeg.a ${SLSRC}/libraries/i686-linux/lib_release_client/

mkdir ${SLSRC}/libraries/i686-linux/include/ELFIO
cp ${ELFIO}/ELFIO/*.h ${SLSRC}/libraries/i686-linux/include/ELFIO/
cp ${ELFIO}/ELFIO/libelfio.so ${SLSRC}/libraries/i686-linux/lib_release_client/

mkdir ${SLSRC}/libraries/i686-linux/include/jpeglib
cp -a /usr/include/j*.h ${SLSRC}/libraries/i686-linux/include/jpeglib/
touch ${SLSRC}/libraries/i686-linux/include/jpeglib/jinclude.h

mkdir ${SLSRC}/libraries/i686-linux/include/llfreetype2
cp -a /usr/include/freetype2/freetype/ ${SLSRC}/libraries/i686-linux/include/llfreetype2/
cp -a /usr/include/ft2build.h ${SLSRC}/libraries/i686-linux/include/llfreetype2/freetype/

mkdir ${SLSRC}/libraries/i686-linux/include/xmlrpc-epi
cp -a /usr/include/xmlrpc*.h ${SLSRC}/libraries/i686-linux/include/xmlrpc-epi/

# For SL v1.18.4.0:
mkdir ${SLSRC}/libraries/i686-linux/include/ares
cp -a /usr/include/ares* ${SLSRC}/libraries/i686-linux/include/ares/
cp -a /usr/lib/libcares.* ${SLSRC}/libraries/i686-linux/lib_release_client/



Compiling

Build Types

The BUILD parameter specifies the build type. For normal usage, use release. If you plan to work on the source, choose releasenoopt or debug, as these versions are unoptimized and much easier to debug.

You can also edit the scons file to cause releasefordownload to skip the "stripping" step, for a version that is relatively easy to debug, yet still performs well.

  • release: Optimized build for release.
  • releasenoopt: Unoptimized build.
  • debug: Debug build with assertions.
  • releasefordownload: Optimized build for release, will create a .tar.gz with the files for distribution.


Building

Enabling llMozLib

Add MOZLIB=yes to your Scons build command when compiling the source. Failure to do this will cause errors on some versions, due to badly structured ifdefs in the code. If you really don't want mozlib you must apply the patches attached to VWR-3748. 

$ cd indra
$ scons DISTCC=no BTARGET=client BUILD=release MOZLIB=yes

Expect a build time of a couple of hours. The resulting unstripped Second Life Viewer binary is newview/secondlife-i686-bin. Note that temporary object code is compiled into /tmp/$USER by default (where $USER is your username) - this can be changed by prefixing the scons command above with TEMP_BUILD_DIR="[full directory path]". For example: 

$ TEMP_BUILD_DIR="/home/fred/secondlife/temp-build" scons DISTCC=no BTARGET=client BUILD=release

To build a release that has all of the shaders and optimizations enabled and resembles the official shipped Linux alpha client, use BUILD=releasefordownload

Be sure to read the Common compilation problems page if you have problems - we'll try to keep the page up to date with known problems and solutions.

Testing and packaging the client

Testing the result from inside the tree

You may find it simpler and less error-prone to follow the instructions in the Packaging the client section below to run the client under the same conditions as an end-user would. Otherwise:

  • Preparing to run 'in-tree'
    • ensure that you have indra/newview/app_settings/static_*.db2 - if not, you'll find it in the 'slviewer-artwork' download (a zip file).
    • now, from the indra directory:

$ cp ../scripts/messages/message_template.msg newview/app_settings/
$ cp ../etc/message.xml newview/app_settings/

Important: Starting from version 1.18.0, copying message.xml is also required. Missing it will cause group IMs to fail to work, although the viewer will run fine otherwise.

  • Running it: The LD_LIBRARY_PATH stuff ensures that the binary looks for its libraries in the right places. From the indra directory:

$ ( cd newview && LD_LIBRARY_PATH="`pwd`"/../../libraries/i686-linux/lib_release_client:"`pwd`"/app_settings/mozilla-runtime-linux-i686:${LD_LIBRARY_PATH}:/usr/local/lib  ./secondlife-i686-bin )


The client seems kinda slow.

By default, the open-source Second Life Viewer uses the open-source OpenJPEG library to decode the (many) JPEG-2000 texture images it receives from the servers. This isn't quite of comparable speed to the proprietary third-party library which the Linden Lab viewer builds have traditionally used, for which we are not permitted to redistribute the source.

However, the slviewer-linux-libs package includes two pre-built libraries which facilitate the use of this slightly faster image decoding method: libkdu_v42R.so and libllkdu.so. These are provided for your testing; again, we are not permitted to grant you the right to re-distribute these libraries to downstream users, but the viewer will still work (albeit slightly slower) without them.

To use these faster image-decoding libraries, they simply need to be put into the right places relative to the viewer runtime directory - nothing needs to be reconfigured or recompiled. If you're running the client from the source tree, the following will make the KDU libraries available: 

cp "$SLSRC/libraries/i686-linux/lib_release_client/libllkdu.so" "$SLSRC/indra/newview/libllkdu.so"
mkdir "$SLSRC/indra/lib"
cp "$SLSRC/libraries/i686-linux/lib_release_client/libkdu_v42R.so" "$SLSRC/indra/lib/libkdu_v42R.so"

The file indra/newview/viewer_manifest.py contains some commented-out entries describing where these libraries belong; if you uncomment the two lines corresponding to libllkdu and libkdu then they will be automatically copied into the right place in the runtime directory when you follow the 'Packaging the client' instructions below.

File Dialogs Don't Work on 64 bit system

If you run a 64 bit system, and your file dialogs don't work, or they worked before and stopped after you installed an update, it may be due to a mismatch between the headers used to compile the viewer and the library it's using. The log will contain something like this: 

2007-06-21T01:28:35Z INFO: ll_try_gtk_init: Starting GTK Initialization.
2007-06-21T01:28:36Z INFO: ll_try_gtk_init: GTK Initialized.
2007-06-21T01:28:36Z INFO: ll_try_gtk_init: - Compiled against GTK version 2.10.11
2007-06-21T01:28:36Z INFO: ll_try_gtk_init: - Running against GTK version 2.10.6
2007-06-21T01:28:36Z WARNING: ll_try_gtk_init: - GTK COMPATIBILITY WARNING: Gtk+ version too old (micro mismatch)

What happens here is that your distribution includes 32 bit GTK libraries, but the package only includes the libraries themselves and not the headers. When building, the SL client will build against the headers included with the main 64 bit GTK package. This will work if the 64 bit version of the library is the same or older than the 32 bit one. However, if your 32 bit library is older, then the viewer will detect the mismatch (built with headers for a newer version of GTK than it's using) and turn GTK off.

Possible solutions:

  • Download the source for the version of the 32 bit GTK libraries your distribution comes with, and build your viewer against those headers.
  • Upgrade your 32 bit GTK package so that it's the same or newer as the 64 bit one.
  • Downgrade your 64 bit package (may not be a good idea).

Packaging the client

If you substitute 'BUILD=release' with 'BUILD=releasefordownload' in the 'Compiling' section above, then packaging the resulting code, libraries, data and documentation into a tarball for the end-user will be done automatically as the final stage of the build process; the pristine end-user client distribution has been assembled into the directory indra/newview/SecondLife_i686_1_X_Y_Z/ and has also been tarred into indra/newview/SecondLife_i686_1_X_Y_Z.tar.bz2

The file which controls what (and where) files go into the end-user runtime viewer directory is indra/newview/viewer_manifest.py


Automated libraries and headers adjustments, compilation and packaging


Here is a bash script that could save you a lot of time... It basically does all what is described above, and more, and entitles you to compile a SL client very easily:

IMPORTANT NOTE:

This script includes instructions which have the potential to remove MANY files on your system should you modify it without understanding exactly what it does (i.e. rm -rf $VARIABLE/ where entire portions of your filesystem *will* be deleted without warning). This is not a theoretical problem, this script has caused damage to unwary users already.

Although some basic checks are done to avoid removing an entire home directory, or even the root tree, this script is not meant to be tweaked without a very good knowledge of bash scripting. It is therefore highly recommended that you use it without modifying the PATH_TO_SOURCES and TEMP_BUILD_DIR variables (modifying the USE_* and TUNE_FLAGS variables is safe). 


#!/bin/bash

# make-SL v1.81 (c)2007 Henri Beauchamp. Released under GPL license v2:
# http://www.gnu.org/licenses/gpl.txt

###############################################################################
######## THIS IS QUICK'N DIRTY ALPHA SOFTWARE. USE AT YOUR OWN RISKS ! ########
###############################################################################

###############################################################################
# BEWARE: this script is meant to compile a -personal- SL client. It is -NOT- #
#         suitable to build client versions meant for public release, because #
#         non-open source code is packaged by this script (e.g. libkdu).      #
###############################################################################

# This bash script is aimed at easying up the build process of a SL client.
# It does not cover building it with custom/system openjpeg, elfio or fmodapi
# (we use the provided libraries).
# You may enable or disable the use of your system's library by editing
# the USE_SYSTEM_* variable ("yes" --> use the system library, "no" --> use
# LL's provided ones).
# The script also takes care of updating properly the viewer_manifest.py script
# accordingly, so that you (should) end up with a properly packaged client.

# To use this script, simply make it executable (chmod +x make-SL) and
# put it into /usr/local/bin (or any other directory in your PATH).
# Then, download the slviewer-src-*.tar.gz, slviewer-linux-libs-*.tar.gz,
# slviewer-artwork-*.zip and fmodapi*.tar.gz archives, and finally, invoke
# make-SL as follow:
#   make-SL path_to_archives  (example: make-SL ~/downloads)
# or simply:
#   make-SL
# when invoking from the directory where the archives are.
# The sources will be installed into the PATH_TO_SOURCES directory,
# and the client will be built into the TEMP_BUILD_DIR directory.
# The packaged build will be moved to your home directory.
# If you want to retry a compilation after fixing something manually and
# don't want make-SL to start all over again, overwriting everything,
# you may invoke it with the --retry option, like this:
#   make-SL --retry
# This script has been tested by the author, on a (very customized)
# Mandrake 10.2 distro, and a (no less customized but yet more standard)
# Mandriva 2007.1 distro.
# Tested with SL v1.17 & v1.18 sources.

# Where the sources of the client will be held (defaults to "./linden"):
PATH_TO_SOURCES="/usr/src/SL"
# Where to build the client:
export TEMP_BUILD_DIR="$PATH_TO_SOURCES/build"

USE_SYSTEM_GTK="yes"
USE_SYSTEM_SDL="yes"
USE_SYSTEM_SSL="yes"
# Beware: libdb4 makes use of libapr, and libapr makes use of libexpat... so
# you should keep USE_SYSTEM_APR, USE_SYSTEM_DB4 and USE_SYSTEM_EXPAT in sync.
USE_SYSTEM_APR="no"
USE_SYSTEM_DB4="no"
USE_SYSTEM_EXPAT="no"
USE_SYSTEM_OGG="yes"
USE_SYSTEM_ZLIB="yes"
USE_SYSTEM_UUID="yes"
# If your system libcurl does not use c-ares (non-blocking DNS calls), better
# using LL's provided library...
USE_SYSTEM_CURL="no"
USE_SYSTEM_VORBIS="yes"
USE_SYSTEM_XMLRPC="yes"
USE_SYSTEM_JPEGLIB="yes"
# Enabling the system freetype2 prevents the client from using the SL fonts,
# or at least, this is what happens on my system (Mandrake 10.2 and Mandriva
# 2007.1 with PLF's freetype2).
USE_SYSTEM_FREETYPE2="no"
USE_SYSTEM_PERFTOOLS="yes"

# You may add tune flags here, to optimize the code for your processor.
# Example, for an Athlon XP:
# TUNE_FLAGS="-march=athlon-xp"
# BEWARE: because of a bug in the v1.17.2.0 SConstruct file, you MUST keep at
# least an -O2 flag in the TUNE_FLAGS, to avoid getting a very slooooow client...
# This problem was apparently fixed in v1.17.3.0.
TUNE_FLAGS="-fomit-frame-pointer -frename-registers -fweb -fexpensive-optimizations"

# Whether to build with the browser login screen or not:
WITH_MOZILLA="yes"

########### functions definitions ###########

function check() {
    if [ "$1" == "yes" ] ; then
        if [ -f $2 ] ; then
            echo "Using the system $3..."
            return 0
        else
            echo "WARNING: system $3 requested but not available..."
        fi
    fi
    return 1
}

function update_manifest() {
    grep -v $1 $PATH_TO_SOURCES/indra/newview/viewer_manifest.py >$TEMP_BUILD_DIR/viewer_manifest.py
    mv -f $TEMP_BUILD_DIR/viewer_manifest.py $PATH_TO_SOURCES/indra/newview/viewer_manifest.py
    chmod +x $PATH_TO_SOURCES/indra/newview/viewer_manifest.py
}

function compile() {
    cd $PATH_TO_SOURCES/indra
    echo "Compiling the client into $TEMP_BUILD_DIR..."
    scons DISTCC=no BTARGET=client OPENSOURCE=no BUILD=releasefordownload CHANNEL=Release MOZLIB=$WITH_MOZILLA
    if (($? == 0)) ; then
        mv $PATH_TO_SOURCES/indra/newview/SecondLife*.tar.bz2 $HOME/
    fi
}

########### end of functions ###########

if [ "$TEMP_BUILD_DIR" == "" ] ; then
    export TEMP_BUILD_DIR=/tmp/$USER/SL
fi

# Check to see if we simply want to retry a compilation:
if [ "$1" == "--retry" ] ; then
    compile
    exit $?
fi

# Make sure we don't unpack over an old source tree:
if [ -d linden ] ; then
    rm -rf linden/
fi

if [ -d $PATH_TO_SOURCES ] && [ "$PATH_TO_SOURCES" != "" ] && [ "$PATH_TO_SOURCES" != "/" ] && [ "$PATH_TO_SOURCES" != "." ] && [ "$PATH_TO_SOURCES" != ".." ] && [ "$PATH_TO_SOURCES" != "$HOME" ] ; then
    rm -rf $PATH_TO_SOURCES/
fi

# Use the parameter (if any) as the path to the archives:

PATH_TO_ARCHIVES="."
if [ "$1" != "" ]; then
    if [ -d $1 ] ; then
        PATH_TO_ARCHIVES=$1
    fi
fi

# Let's first unpack everything:
if ! [ -f $PATH_TO_ARCHIVES/slviewer-src-*.tar.gz ] ; then
    echo "You need slviewer-src !"
    exit 1
fi
if ! [ -f $PATH_TO_ARCHIVES/slviewer-linux-libs-*.tar.gz ] ; then
    echo "You need slviewer-linux-libs !"
    exit 1
fi
if ! [ -f $PATH_TO_ARCHIVES/slviewer-artwork-*.zip ] ; then
    echo "You need slviewer-artwork !"
    exit 1
fi
if ! [ -f $PATH_TO_ARCHIVES/fmodapi*.tar.gz ] ; then
    echo "You need fmodapi !"
    exit 1
fi
echo "Extracting the files from the archives..."
tar xzf $PATH_TO_ARCHIVES/slviewer-src-*.tar.gz
tar xzf $PATH_TO_ARCHIVES/slviewer-linux-libs-*.tar.gz
unzip $PATH_TO_ARCHIVES/slviewer-artwork-*.zip >/dev/null
tar xzf $PATH_TO_ARCHIVES/fmodapi*.tar.gz

# fmodapi:
echo "Copying fmodapi files..."
cp -a fmodapi*/api/inc/* linden/libraries/i686-linux/include/
cp fmodapi*/api/libfmod-*.so linden/libraries/i686-linux/lib_release_client/
rm -rf fmodapi*/

# Move the sources to where we want to hold them:
if [ "$PATH_TO_SOURCES" != "linden" ] && [ "$PATH_TO_SOURCES" != "" ] ; then
    echo "Moving the sources to $PATH_TO_SOURCES..."
    mv -f linden $PATH_TO_SOURCES
fi

# Let's own the files:
chown -R $USER: $PATH_TO_SOURCES/

# Check for patches to apply. The names of the patches must be in the form
# slviewer-*.patch* (Example: slviewer-v117-EmbbededNotecard.patch.bz2).
# They must be applicable from inside the source directory with the -p1
# option, i.e. they have been built from outside the source directory
# with a diff command such as:
# diff -urN linden/ linden-patched/ >slviewer-whatever.patch
# And they may be gzipped or bzipped.
PATCHES=`/bin/ls $PATH_TO_ARCHIVES/slviewer-*.patch* 2>/dev/null`
if [ "$PATCHES" != "" ] ; then
    echo "Applying patches..."
    cd $PATH_TO_SOURCES
    PATCHES=`/bin/ls $PATH_TO_ARCHIVES/slviewer-*.patch*`
    for i in $PATCHES; do
        echo "Patch: $i"
        if echo $i | grep ".gz" &>/dev/null ; then
            gunzip -c $i | patch -p1 -s
        elif echo $i | grep ".bz2" &>/dev/null ; then
            bzcat $i | patch -p1 -s
        else
            patch -p1 -s <$i
        fi
    done
fi

# Make a clean build:
if [ -d $TEMP_BUILD_DIR ] && [ "$TEMP_BUILD_DIR" != "" ] && [ "$TEMP_BUILD_DIR" != "/" ] && [ "$TEMP_BUILD_DIR" != "." ] && [ "$TEMP_BUILD_DIR" != ".." ] && [ "$TEMP_BUILD_DIR" != "$HOME" ] ; then
    rm -rf $TEMP_BUILD_DIR/
fi
mkdir -p $TEMP_BUILD_DIR

# In v1.18.4.0, they use c-ares but fail to provide it in the library package...
if [ -f $PATH_TO_SOURCES/indra/llcommon/llares.cpp ] ; then
    if ! [ -f $PATH_TO_SOURCES/libraries/i686-linux/include/ares/ares_dns.h ] && ! [ -f $PATH_TO_SOURCES/libraries/include/ares/ares_dns.h ] ; then
        if [ -f /usr/include/ares_dns.h ] && [ -f /usr/lib/libcares.a ] ; then
            echo "Copying missing c-ares files from the system..."
            cd $PATH_TO_SOURCES/libraries/i686-linux
            mkdir include/ares
            cp -a /usr/include/ares* include/ares/
            cp -a /usr/lib/libcares* lib_release_client/
        else
            echo "Sorry... You need c-ares installed in your system to compile this version of the client."
            echo "Try: http://daniel.haxx.se/projects/c-ares/"
            exit 1
        fi
    fi
fi

# Let's use the system GTK+ if available:
if check $USE_SYSTEM_GTK /usr/include/atk-1.0/atk/atk.h "GTK+" ; then
    cd $PATH_TO_SOURCES/libraries/i686-linux/lib_release_client
    rm -f libgtk* libgdk* libglib* libgmodule* libgobject* libgthread* libpango* libatk*
    cd ../include
    rm -rf atk-1.0/ gtk-2.0/ glib-2.0/ pango-1.0/
    cp -a /usr/include/atk-1.0 .
    cp -a /usr/include/gtk-2.0 .
    cp -a /usr/lib/gtk-2.0/include/* gtk-2.0/
    cp -a /usr/include/glib-2.0 .
    cp -a /usr/lib/glib-2.0/include/* glib-2.0/
    cp -a /usr/include/pango-1.0 .
    if [ -d /usr/include/cairo ] ; then
        cp -a /usr/include/cairo/* .
    fi
fi

# Let's use the system freetype2 if available:
if check $USE_SYSTEM_FREETYPE2 /usr/include/ft2build.h "freetype2" ; then
    cd $PATH_TO_SOURCES/libraries
    rm -rf include/freetype/ i686-linux/include/llfreetype2/*
    rm -f include/ft2build.h i686-linux/lib_release_client/libfreetype.a
    cp -a /usr/include/freetype2/freetype/ i686-linux/include/llfreetype2/
    cp -a /usr/include/ft2build.h i686-linux/include/llfreetype2/freetype/
fi

# Let's use the system zlib if available:
if check $USE_SYSTEM_ZLIB /usr/include/zlib.h "zlib" ; then
    cd $PATH_TO_SOURCES/libraries
    rm -rf include/zlib/
    mkdir -p i686-linux/include/zlib
    cp -a /usr/include/zlib*.h i686-linux/include/zlib/
fi

# Let's use the system jpeglib if available:
if check $USE_SYSTEM_JPEGLIB /usr/include/jpeglib.h "jpeglib" ; then
    cd $PATH_TO_SOURCES/libraries
    rm -rf include/jpeglib/ i686-linux/lib_release_client/libjpeg.a
    mkdir -p i686-linux/include/jpeglib
    cp -a /usr/include/j*.h i686-linux/include/jpeglib/
    touch i686-linux/include/jpeglib/jinclude.h
fi

# Let's use the system xmlrpc-epi if available:
if check $USE_SYSTEM_XMLRPC /usr/include/xmlrpc.h "xmlrpc-epi" ; then
    cd $PATH_TO_SOURCES/libraries
    rm -rf include/xmlrpc-epi/ i686-linux/lib_release_client/libxmlrpc.a
    mkdir -p i686-linux/include/xmlrpc-epi
    cp -a /usr/include/xmlrpc*.h i686-linux/include/xmlrpc-epi/
fi

# Let's use the system ogg if available:
if check $USE_SYSTEM_OGG /usr/include/ogg/ogg.h "ogg" ; then
    cd $PATH_TO_SOURCES/libraries
    rm -rf include/ogg/ i686-linux/lib_release_client/libogg*
    update_manifest libogg
fi

# Let's use the system vorbis if available:
if check $USE_SYSTEM_VORBIS /usr/include/vorbis/vorbisenc.h "vorbis" ; then
    cd $PATH_TO_SOURCES/libraries
    rm -rf include/vorbis/ i686-linux/lib_release_client/libvorbis*
    update_manifest libvorbis
fi

# Let's use the system SDL if available:
if check $USE_SYSTEM_SDL /usr/include/SDL/SDL.h "SDL" ; then
    cd $PATH_TO_SOURCES/libraries/i686-linux
    rm -rf include/SDL/ lib_release_client/libSDL*
    update_manifest libSDL
fi

# Let's use the system openssl if available:
if check $USE_SYSTEM_SSL /usr/include/openssl/opensslconf.h "openssl" ; then
    cd $PATH_TO_SOURCES/libraries/i686-linux/lib_release_client
    rm -f libssl.* libcrypto.*
    update_manifest libssl
    update_manifest libcrypto
fi

# Let's use the system apr if available:
if check $USE_SYSTEM_APR /usr/include/apr*/apr_base64.h "apr" ; then
    cd $PATH_TO_SOURCES/libraries/i686-linux
    rm -rf include/apr-1/*
    rm -f lib_release_client/libapr*
    cp -a /usr/include/apr*/* include/apr-1/
    update_manifest libapr
fi

# Let's use the system db4 if available:
if check $USE_SYSTEM_DB4 /usr/include/db4/db.h "db4" ; then
    rm -f $PATH_TO_SOURCES/libraries/i686-linux/lib_release_client/libdb*.so
    update_manifest libdb
fi

# Let's use the system expat if available:
if check $USE_SYSTEM_EXPAT /usr/include/expat.h "expat" ; then
    cd $PATH_TO_SOURCES/libraries
    rm -rf include/expat/
    rm -f i686-linux/lib_release_client/libexpat*
    mkdir -p i686-linux/include/expat
    cp -a /usr/include/expat*.h i686-linux/include/expat/
    update_manifest libexpat
fi

# Let's use the system curl if available:
if check $USE_SYSTEM_CURL /usr/include/curl/curl.h "curl" ; then
    cd $PATH_TO_SOURCES/libraries
    rm -rf include/curl/
    rm -f i686-linux/lib_release_client/libcurl.*
    update_manifest libcurl
fi

# Let's use the system uuid if available:
if check $USE_SYSTEM_UUID /lib/libuuid.so.1 "libuuid" ; then
    rm -f $PATH_TO_SOURCES/libraries/i686-linux/lib_release_client/libuuid.*
    update_manifest libuuid
fi

if grep tcmalloc $PATH_TO_SOURCES/indra/SConstruct &>/dev/null ; then
    if check $USE_SYSTEM_PERFTOOLS /usr/include/google/malloc_hook.h "google-perftools" ; then
        cd $PATH_TO_SOURCES/libraries/i686-linux
        rm -f lib_release_client/libtcmalloc.* lib_release_client/libstacktrace.*
        rm -rf include/google/
        cp -a /usr/lib/libstacktrace.* /usr/lib/libtcmalloc.so* lib_release_client/
        cp -a /usr/include/google include/
        update_manifest tcmalloc
        update_manifest stacktrace
    else
        # Remove the google-perftools stuff if not present in the libraries package
        # (problem seen in SL v1.17):
        if ! [ -f $PATH_TO_SOURCES/libraries/i686-linux/lib_release_client/libtcmalloc.so ] ; then
            update_manifest tcmalloc
            update_manifest stacktrace
            # The following lines remove the
            #   "external_libs += ['tcmalloc', 'stacktrace']"
            # line from SConstruct... and many other lines which renders SConstruct
            # unusable to build anything else than the client... this is a quick'n
            # dirty patch. :-P
            grep -v tcmalloc $PATH_TO_SOURCES/indra/SConstruct >$TEMP_BUILD_DIR/SConstruct
            mv -f $TEMP_BUILD_DIR/SConstruct $PATH_TO_SOURCES/indra/SConstruct
        fi
    fi
fi

# Fix a bug in v1.17.1 and later SConstruct file, where some libraries are
# compiled as shared instead of static, and are yet not packaged, and where
# fmod can't be enabled for OPENSOURCE:
sed -e "s/create_dynamic_module(module=module, module_libs=module_libs)/create_static_module(module)/" $PATH_TO_SOURCES/indra/SConstruct >$TEMP_BUILD_DIR/SConstruct
sed -e "s/enable_fmod = not opensource and/enable_fmod =/" $TEMP_BUILD_DIR/SConstruct >$PATH_TO_SOURCES/indra/SConstruct
rm -f $TEMP_BUILD_DIR/SConstruct

# Add tune flags, if any:
if [ "$TUNE_FLAGS" != "" ] ; then
    sed -e "s/-g -pipe/$TUNE_FLAGS -pipe/" $PATH_TO_SOURCES/indra/SConstruct >$TEMP_BUILD_DIR/SConstruct
    mv -f $TEMP_BUILD_DIR/SConstruct $PATH_TO_SOURCES/indra/SConstruct
fi

# Use whatever gcc version we got, and not just v3.4. SL now compiles cleanly with v4.1.
sed -e "s/g++-3.4/g++/" $PATH_TO_SOURCES/indra/SConstruct >$TEMP_BUILD_DIR/SConstruct
mv -f $TEMP_BUILD_DIR/SConstruct $PATH_TO_SOURCES/indra/SConstruct

# Update the manifest file and enable libkdu packaging. I'm too lazy to use
# awk or perl, here, but that's indeed what should be done...
# The following (very dirty) code may break at some point, depending on what
# LL will put in comments in the manifest file...
# First, remove the lines with libstdc++.so.6 and the crash logger:
update_manifest libstdc
update_manifest crash_logger
# Now, any line with a '#' followed with several spaces _should_ be dealing
# with the libkdu stuff... So, we simply remove the '#"...
sed -e "s/#        them/# them/" $PATH_TO_SOURCES/indra/newview/viewer_manifest.py >$TEMP_BUILD_DIR/viewer_manifest.py
sed -e "s/#   /   /" $TEMP_BUILD_DIR/viewer_manifest.py >$PATH_TO_SOURCES/indra/newview/viewer_manifest.py
#mv -f $TEMP_BUILD_DIR/viewer_manifest.py $PATH_TO_SOURCES/indra/newview/viewer_manifest.py
rm -f $TEMP_BUILD_DIR/viewer_manifest.py
chmod +x $PATH_TO_SOURCES/indra/newview/viewer_manifest.py

# Comment out "export LL_GL_BASICEXT=x" in the wrapper script:
sed -e "s/export LL_GL_BASICEXT=x/#export LL_GL_BASICEXT=x/" $PATH_TO_SOURCES/indra/newview/linux_tools/wrapper.sh >$TEMP_BUILD_DIR/wrapper.sh
mv -f $TEMP_BUILD_DIR/wrapper.sh $PATH_TO_SOURCES/indra/newview/linux_tools/wrapper.sh
chmod +x $PATH_TO_SOURCES/indra/newview/linux_tools/wrapper.sh

# Missing file... at least in v1.17.0.0
if grep "secondlife-i686.supp" $PATH_TO_SOURCES/indra/newview/viewer_manifest.py &>/dev/null ; then
    if ! [ -f $PATH_TO_SOURCES/indra/newview/secondlife-i686.supp ] ; then
        touch $PATH_TO_SOURCES/indra/newview/secondlife-i686.supp
    fi
fi

# LL makes the assumption that a certain unicode true type font is installed
# on all Linux systems... which is of course wrong !  Let's check, and when
# this font is absent, replace the broken soft link with an empty file: this
# at least will prevent the viewer to issue many warnings about not being able
# to load the unicode.ttf font.
if ! [ -r $PATH_TO_SOURCES/indra/newview/linux_tools/unicode.ttf ] ; then
    rm -f $PATH_TO_SOURCES/indra/newview/linux_tools/unicode.ttf
    touch $PATH_TO_SOURCES/indra/newview/linux_tools/unicode.ttf
fi

compile



FreeBSD

A list of patches is given for Compiling the viewer (FreeBSD).

Submitting Patches

This is probably far down the road, but if you make changes to the source and want to submit them, see the page about submitting patches.

Retrieved from "https://wiki.secondlife.com/w/index.php?title=Build_the_Viewer_on_Linux&oldid=45549"