Build the Viewer on macOS
- 1 Prerequisites
- 2 Download Source Code
- 3 Configure
- 4 Build
- 5 Running your newly built viewer
- 6 Running Unit Tests
- 7 Optional: Installing Proprietary Libraries
- 8 Handling Problems
|Attend Carefully The package versions and bit-widths listed below have been carefully selected and tested. If you decide to install a different version of a given package (even a minor update), you are on your own (but feel free to share your results.|
You can install git and CMake using Homebrew or their official installers.
Note: Be sure that cmake is available on your system path
~/ $ which cmake /usr/local/bin/cmake
Download Source Code
The canonical viewer repository is https://bitbucket.org/lindenlab/viewer-release
Get the viewer-build-variables
Be sure you have the following environment variables set before continuing:
AUTOBUILD_ADDRSIZE=64 AUTOBUILD_VARIABLES_FILE=<path to autobuild viewer variables>
Configuring and building with autobuild works the same on all platforms. Full instructions may be found at Build_Viewer_With_Autobuild.
autobuild configure -c RelWithDebInfoOS
Option 1: Command Line Build
autobuild build --no-configure
you can omit the --no-configure option: if you do, autobuild will implicitly run the configuration step before building. That's harmless, it just takes some extra time, but be sure to include any configuration options such as that for fmodex above.
Option 2: Build Within Xcode
Once you have run the autobuild configure step, the directory build-darwin-x86_64 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. If it prompts you to automatically create schemes, let it do so.
Running your newly built viewer
Option 1: Command Line
To launch the viewer you build, from your source tree root directory, run:
open build-darwin-x86_64/newview/configuration-type/Second\ Life.app
where configuration-type depends on your built configuration ("DebugOS", "ReleaseOS" or "RelWithDebInfoOS").
Option 2: Running Within Xcode
"secondlife-bin" scheme is what you look for.
When running from the XCode IDE be sure to go to Product → Scheme → Edit Scheme menu. Select the Run section and uncheck the box labeled "Allow debugging when using document Versions Browser" on the Options tab. (See this thread.)
Option 3: Using Finder
- Navigate to build-darwin-x86_64/newview/configuration-type.
- Double click the application.
- You can create and put the alias wherever you find convenient.
Running Unit Tests
From Xcode, open the project build-darwin-x86_64/test/test.xcodeproj and select "test" for scheme and run. SecondLife.xcodeproj project also has "test" scheme.
Optional: 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.)
Optional: FMOD Ex
Pick somewhere to build your fmodex package:
hg clone https://bitbucket.org/lindenlab/3p-fmodex cd 3p-fmodex autobuild build autobuild package
If it works, it will produce a package archive file with a name like fmodex-126.96.36.199503051234-darwin-201503051234.tar.bz2
CD to your viewer repository root; you can either just override the configured archive with a --local install:
autobuild install --local path-to-your-fmodex-archive
That will cause autobuild to ignore the configured value and use your local package archive; if you delete your build directory, you'll need to repeat the override command.
To reconfigure your autobuild configuration file to use that archive:
autobuild installables edit fmodex url=file:///path-to-your-fmodex-archive
but be careful not to commit that change, since it will be useless to anyone who can't access the path you configured.
Now, reconfigure your viewer build to use FMod instead of the open source OpenAL library:
cd viewer # Go back to viewer checkout directory autobuild configure -c RelWithDebInfoOS -- -DFMODEX:BOOL=TRUE
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:
- This talk page (Report useful experiences there)
- Issue list below (If new issues, please add it to talk page above instead of there)
- Old talk page
- Common compilation problems (Rather old)
- Issue tracker
- Fix it: Modifying CMake Files and please, submit a patch!
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.
- Subscribe to OpenSource-Dev Mailing List (subscribe) and post your question there.
- For faster response, join the general open source viewer discussion and development IRC channel #opensl on freenode. Hopefully a helpful person is online when you ask your question.