Get source and compile

From Second Life Wiki
Revision as of 08:54, 23 September 2010 by Lee Ponzu (talk | contribs) (→‎Project Snowstorm: adding doxygen link)
Jump to navigation Jump to search

This information is for people who want to look at the actual source code for the viewer. Just the act of downloading and compiling can uncover problems. If the version you download doesn't build on your platform, file a bug. If you have time and skill, adding a feature that you've always wanted, or fixing a bug that most annoys you is welcome. There is a process for uploading your changes and getting them accepted for a merge into a future release viewer.

Project Snowstorm

This is the latest Viewer 2 code that LindenLab has. Viewer 2 source code is stored in a Mercurial (hg) repository on bitbucket, one of the main Open Source repository web sites. There are many versions there, with the ones you are most likely interested in being

You can browse the source code using an ordinary web browser, download it to your machine, or use Mercurial to manage the process for you. One of the interesting features of the Viewer-Development branch is that you can literally watch Lindens merging bug fixes and new features into the code before your very eyes.

Another good way to browse the source code, including UML diagrams, is using Doxygen.

Be sure to read Creating a version control repository.

Download Source Archives (Zipfile/Tarball)

OBSOLETE! Linden Lab provides current and past downloads in an archived format, see the source downloads page. Be sure to get all three: source, artwork, and libraries.

Version Control

OBSOLETE!

Linden Lab maintains a version control repository containing various (experimental) branches. See the version control repository page for the correct repository url.

Subsequently, if you are using a command line, you could check out the source code with

svn checkout repository-url target-directory

For example to checkout snowglobe 1.4:

cd snowglobe-1.x-svn
svn checkout https://svn.secondlife.com/svn/linden/projects/2009/snowglobe/trunk linden

Note that using 'https://' as opposed to 'http://' is only really necessary if you are a committer and need repository write access.

Compiling

Per platform instructions are available in these topics:

Notes

Hints on running

Channels and Versions

Channels are just groupings of versions. Linden Lab uses channels to track and supply updates for First Look viewers separately from Release and Release Candidate viewers.

If you get a message while trying to start your compiled viewer that there is a required update, don't panic. All of your work is not lost. You (usually) don't have to apply your changes to a new source release to test your code. That's where channels come in.

On login, the combination of channel plus version is checked against a list. Within each channel, some versions are allowed and some are blocked. Viewers are blocked that are unsafe (security issues), incompatible (the protocol has been changed in some fundamental way), not supported (so old Linden Lab can't afford to provide support resources), or (most relevant here) are in a test channel (Release Candidate, First Look) and Linden Lab only wants test data from the most recent.

See Setting a Channel and Version for an Open Source Viewer for an explanation of how to do it in the source code.

See Channel and Version Requirements for a detailed explanation and official policy on how Linden Lab deals with channels and versions in Second Life.

The Third Party Viewer Policy requires that all viewers use a unique channel name. Please see here for more information.