Difference between revisions of "Get source and compile"

Latest revision as of 13:40, 17 November 2022

This information is for people who want to work with the source code for the viewer.

Open Source Viewer

Viewer code is hosted by GitHub using git.

Second Life Viewer

Other repositories where development for future features can be seen are listed on the Release Notes Repositories page. If you have not worked with GitHub or distributed version control you may be interested in GitHub's introductory material.

Checking out Code

To clone the current release repository:

git clone https://github.com/secondlife/viewer.git

Compiling

Per platform instructions are available in these topics:

Notes

Common compilation problems

Autobuild

Autobuild is the new Linden Lab framework to maintain and build everything, from viewer to 3rd party libraries.

Instructions:

Channels and Versions

Channels are just groupings of versions. Linden Lab uses channels to track and supply updates for Project, Beta, and Release Viewers separately.

On login, the combination of channel plus version is checked against a set of rules in the Viewer Version Management service. Within each channel, some versions are allowed and some are blocked. Viewers are blocked if they are too old, are unsafe (security issues), incompatible (the protocol has been changed in some fundamental way), or are a test version and Linden Lab only wants data from the most recent. See Viewer Integration and Release Processes for an explanation of how different versions are managed by Linden Lab.

If you are building a viewer, the Policy on Third Party Viewers requires that you set your own channel name.

See:

Channel and Version Requirements: a detailed explanation and official policy on channels and versions in Second Life, and an explanation of how to set your channel name when building.

@@ Line 1: / Line 1: @@
-{{multi-lang}}
+{{multi-lang|Get source and compile|pt}}
 {{OSWikiContribBox}}
-Even if you don't plan to develop, just the act of downloading and compiling can uncover problems. If the version you download doesn't build on your platform, file a bug.
+This information is for people who want to work with the source code for the viewer.
-= Getting the source =
+==Open Source Viewer==
-== Download Source Archives (Zipfile/Tarball) ==
+Viewer code is hosted by [https://github.com/secondlife GitHub] using [https://en.wikipedia.org/wiki/Git git].
-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.
+* [https://github.com/secondlife/viewer Second Life Viewer]
-== Version Control ==
+Other repositories where development for future features can be seen are listed on the [https://releasenotes.secondlife.com/repositories.html Release Notes Repositories] page. If you have not worked with GitHub or distributed version control you may be interested in [https://docs.github.com/en/get-started GitHub's introductory material].
-Linden Lab also maintains a version control repository.  There are some ''unofficial'' repositories, too.  See the [[version control repository]] page and [[source version control]] for more details.
+=== Checking out Code ===
-= Compiling =
+To clone the current release repository:
+ git clone https://github.com/secondlife/viewer.git
+== Compiling ==
 Per platform instructions are available in these topics:
-* [[Microsoft Windows Builds|Microsoft Windows]]
+* [[Build the Viewer on Windows|Windows]]
-* [[Compiling the viewer (Mac OS X)|Mac OS X]]
+* [[Build the Viewer on macOS|macOS]]
-* [[Compiling the viewer (Linux)|Linux]]
-== Notes ==
+=== Notes ===
-*  [[Common compilation problems]] if you run into errors while building.
+*  [[Common compilation problems]]
-*  [[Improving compilation time]] for information on how to compile faster
-*  [[LLMozLib2]] for building LLMozLib2.
-= Hints on running =
+=== Autobuild ===
+[[Autobuild]] is the new Linden Lab framework to maintain and build everything, from viewer to 3rd party libraries.
+Instructions:
+* [[Build Viewer With Autobuild]]
+* [[Build_3rd_Party_lib_with_Autobuild]]
 == 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.
+Channels are just groupings of versions. Linden Lab uses channels to track and supply updates for Project, Beta, and Release Viewers separately.
-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.
-Since this is a convenience for the residents and Linden, but (in most
-cases) not a technical requirement, if the channel/version pair doesn't
-match, then the viewer is let through.
-So: simply change the channel to anything else, e.g. "My Most
-Excellent SL Viewer" and you won't get blocked.
-You can do that in the source code or on the command line.  See [[Channel_and_Version_Requirements#Setting_a_Channel_and_Version_for_an_Open_Source_Viewer | Setting a Channel and Version for an Open Source Viewer]] for an explanation of how to do it in the source code.
-On the command line, you simply add a parameter
- -channel "My Most Excellent SL Viewer"
-On Microsoft Windows, you can incorporate this parameter into the desktop icon that you use to start your viewer.  Just edit the Properties for the shortcut and add (or change) the parameter in the Target field.
-You can also stick command-line arguments in arguments.txt in the
+On login, the combination of channel plus version is checked against a set of rules in the Viewer Version Management service. Within each channel, some versions are allowed and some are blocked. Viewers are blocked if they are too old, are unsafe (security issues),
-application bundle (.app directory) on MacOS X or in gridargs.dat in the Second Life install directory on Linux.
+incompatible (the protocol has been changed in some fundamental way), or
+are a test version and Linden Lab only wants data from the most recent.  See [[Viewer Integration and Release Processes]] for an explanation of how different versions are managed by Linden Lab.
-See [[Channel and Version Requirements]] for a detailed explanation and official policy on how Linden Lab deals with channels and versions in Second Life.
+'''If you are building a viewer, the [http://secondlife.com/corporate/tpv.php Policy on Third Party Viewers] requires that you set your own channel name.'''
-Please note, however, if you plan to distribute your viewer binary, changing the channel permanently (i.e., editing the source) is not recommended; if you did so, any security problems found in a future would not be checked by the grid, and residents who received your viewer might use that vulnerable version forever.
+See:
+:;[[Channel and Version Requirements]]
+::a detailed explanation and official policy on channels and versions in Second Life, and an explanation of how to set your channel name when building.
 [[Category:Compiling viewer]]