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}}
-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.
+This information is for people who want to work with the source code for the viewer.
-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==
+==Open Source Viewer==
-This is the latest Viewer 2 code that LindenLab has.
+Viewer code is hosted by [https://github.com/secondlife GitHub] using [https://en.wikipedia.org/wiki/Git git].
-Viewer 2 source code is stored in a Mercurial (hg) repository on [http://bitbucket.org/lindenlab 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
-* [http://bitbucket.org/lindenlab/viewer-release Viewer2 Release]
+* [https://github.com/secondlife/viewer Second Life Viewer]
-* [http://bitbucket.org/lindenlab/viewer-beta Viewer2 Beta]
-* [http://bitbucket.org/lindenlab/viewer-development The latest developer test builds]
-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.
+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].
-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  [http://dimentox.com/snowstorm/ Doxygen].
+=== Checking out Code ===
-Be sure to read [[Creating a version control repository]].
+To clone the current release repository:
+  git clone https://github.com/secondlife/viewer.git
-=== 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 ===
-Viewer development uses the Mercurial (hg) distributed version control system.  To clone the current primary development repository, use:
-  hg clone http://hg.secondlife.com/viewer-development
 == 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]]
-* [[Viewer 2 Microsoft Windows Builds|Viewer 2 Microsoft Windows Builds - under construction]]
 === 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 ==
-=== Channels and Versions ===
+=== Autobuild ===
+[[Autobuild]] is the new Linden Lab framework to maintain and build everything, from viewer to 3rd party libraries.
-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.
+Instructions:
+* [[Build Viewer With Autobuild]]
+* [[Build_3rd_Party_lib_with_Autobuild]]
-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.
+== Channels and Versions ==
-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),
+Channels are just groupings of versions. Linden Lab uses channels to track and supply updates for Project, Beta, and Release Viewers separately.
-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 [[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 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.
-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.'''
-The Third Party Viewer Policy requires that all viewers use a unique channel name.  Please see [http://secondlife.com/corporate/tpv.php here] for more information.
+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]]