Compiling the viewer (Mac OS X)

From Second Life Wiki
Revision as of 14:26, 26 February 2013 by Gwyneth Llewelyn (talk | contribs) (→‎Fmod method 1 (using autobuild): Added link to missing fmodapi375mac.zip)
Jump to navigation Jump to search
Open Source Portal

For recent information check the Project Snowstorm page.

Getting Development Tools

  • Xcode 3: Most Lindens use Xcode 3.2 on Snow Leopard (OS X 10.6) for building on Macintosh computers. For simplicity, we suggest installing everything from the mpkg. Note that later versions of Xcode have build options to be backwards compatible to 3.1. (See Talk:Compiling_the_viewer_(Mac_OS_X)#Trying_newer_versions_of_tools. Later versions of Xcode (3.2.4) work fine.)
  • Xcode 4: As of July 15 2012, XCode 4 is not yet officially supported. Still, experimental support is offered for 4.2 on Lion. Some users find the patch there work even in 4.3.3.
  • CMake: Install CMake from cmake.org, or using MacPorts with 'port install cmake'. You will need at least CMake 2.6; CMake 2.8 may be required in the future.
  • Command line Makefiles: These are included in Apple's Xcode product. Download and install Xcode from Apple.


Downloading Source Code

Linden Lab Project Snowstorm uses Mercurial and Bit Bucket for the version control repository. The repository is here. Look vor viewer-development, viewer-beta, viewer-release, and others, as your needs dictate. If you're just starting out, it's probably best to get viewer-release or viewer-beta , because viewer-developer gets updated several times per week. But if you would rather work with the latest code, look for the latest builds on Project Snowstorm and viewer-developer on bitbucket.


Applying Patch (only for Xcode 4.2 and above, experimental)

If you use Xcode 4.2 and above, you need to do these additional steps to succeed in building:

  1. Visit to https://codereview.secondlife.com/r/502/
  2. Login with your Review Board account. If you don't have it, click "Create one now" link and create one with your Second Life name.
  3. Right-click on Download Diff link on the right side and download the .diff file.
  4. CD into your downloaded source tree root directory and run:
$ hg import --no-commit xcode-4.2-diff


Installing Proprietary Libraries

Some builds of the the Viewer depends on proprietary libraries (alternative open source libraries are also provided for developers who prefer or are not licensed to use the proprietary libraries). Lindens do not distribute these libraries, so you will need to fetch and install these even if you download the libraries packages. (This is due to licensing restrictions. Don't ask, Lindens already did, and can't get permission. So you do have to get them yourself.)

Fmod

Fmod method 1 (using autobuild)

CD to where you want to install the 3p-fmod repository and do: 

$ hg clone https://bitbucket.org/lindenlab/3p-fmod
$ cd 3p-fmod
$ autobuild build --all
$ autobuild package

You will see the result looks like: 

packing fmod
wrote  /3p-fmod/fmod-3.75-darwin-20120614.tar.bz2
md5    527422281dbe49abac29380996d41230

CD to your repository root and update autobuild configulation file with the filename and hash just displayed. For the example above, run: 

 
$ autobuild installables edit fmod platform=darwin hash=527422281dbe49abac29380996d41230 url=file:///3p-fmod/fmod-3.75-darwin-20120614.tar.bz2

Note: FMOD does not host the appropriate version any longer. You will need fmodapi375mac.zip from elsewhere; currently, Kitti Ninetails is hosting it on her SkyDrive.

Fmod method 2 (using system module)

(to be written)


Configuration and Building

With Autobuild

Configuring and building with autobuild works the same on all platforms. Full instructions may be found at Build_Viewer_With_Autobuild.

Example: 

autobuild configure -c RelWithDebInfoOS -- -DLL_TESTS:BOOL=FALSE -DPACKAGE:BOOL=FALSE -DFMOD:BOOL=TRUE
autobuild build -c RelWithDebInfoOS --no-configure

On Xcode

If you have followed the configure instructions from Build_Viewer_With_Autobuild, the directory build-darwin-i386 will have been created in the root of your source distribution. Inside that directory you will find the SecondLife.xcodeproj project file which can be used with Xcode. When opened it should be configured correctly to build, so just Build and Run.


Running your newly built viewer

On Console

In your source tree root directory, run: 

$build-darwin-i386/newview/[CONFIGURATION]/Second\ Life.app/Contents/MacOS/Second\ Life

where [CONFIGURATION] depends on your built configuration ("Debug", "Release" or "RelWithDebInfo").

On Xcode

"secondlife-bin" scheme is what you look for.

Using Finder

  1. Navigate to build-darwin-i386/newview/[CONFIGURATION].
  2. Double click the application.
You can create and put the alias wherever you find convenient.


Running the Unit Tests

From Xcode, open the project build-darwin-i386/test/test.xcodeproj and select "test" for scheme and run. SecondLife.xcodeproj project also has "test" scheme.


Handling Problems

Seeking Solution

If you encounter errors or run into problems following the instructions above, please first check whether someone else already had the same issue. A solution might be known already.

You may find the solution in any of these resources:

Getting Help

Even when no description of your problem has been written down yet, someone might know about it, so get in touch with the community to get help.

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=Compiling_the_viewer_(Mac_OS_X)&oldid=1177055"