Build the Viewer on macOS - Revision history

Signal Linden: Remove dead IRC channel information

2022-11-17T21:41:56Z

Remove dead IRC channel information

← Older revision		Revision as of 14:41, 17 November 2022
Line 133:		Line 133:

	* Subscribe to [[OpenSource-Dev\|OpenSource-Dev Mailing List]] ([https://lists.secondlife.com/cgi-bin/mailman/listinfo/opensource-dev subscribe]) and post your question there.		* Subscribe to [[OpenSource-Dev\|OpenSource-Dev Mailing List]] ([https://lists.secondlife.com/cgi-bin/mailman/listinfo/opensource-dev subscribe]) and post your question there.
	* For faster response, join the general open source viewer discussion and development [[IRC]] channel [irc://irc.freenode.org/opensl #opensl on freenode]. Hopefully a helpful person is online when you ask your question.

	----		----
	[[Category:Compiling viewer]]		[[Category:Compiling viewer]]

Signal Linden: Switch VCS to GitHub

2022-11-17T21:41:27Z

Switch VCS to GitHub

← Older revision		Revision as of 14:41, 17 November 2022
Line 28:		Line 28:

	Open a terminal and checkout the viewer source code:		Open a terminal and checkout the viewer source code:
	git clone https://~~bitbucket~~.~~org~~/~~lindenlab~~/viewer.git		git clone https://github.com/secondlife/viewer.git

	===Build Variables===		===Build Variables===

Signal Linden: Updated instructions for python 3, made mac and windows build instructions match a bit

2022-03-02T04:40:42Z

Updated instructions for python 3, made mac and windows build instructions match a bit

← Older revision		Revision as of 21:40, 1 March 2022
Line 3:		Line 3:
	{{TOC}}		{{TOC}}

	~~{{KBcaution\|custom~~=~~Attend Carefully\|~~		==Step 1. Install Requirements==
	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.}}

	~~==Prerequisites~~==

	* [https://apps.apple.com/us/app/xcode/id497799835?mt=12 Xcode]		* [https://apps.apple.com/us/app/xcode/id497799835?mt=12 Xcode]
	* [https://~~cmake~~.~~org/download~~/ ~~CMake~~] ~~version 3.8 or newer (For OS X use 3.19 or newer)~~		* Python 3.7+
	* [https://~~git-scm~~.~~com~~/download/~~mac git~~]		* [https://git-scm.com/downloads Git]
			* [https://cmake.org/download/ CMake]
	* [[Autobuild]]		* [[Autobuild]]

	You can install git and CMake using [https://brew.sh/ Homebrew] or their official installers.		You can install git and CMake using [https://brew.sh/ Homebrew] or their official installers.

	~~Note~~: ~~Be sure that~~ cmake ~~is available on your system path~~		===Intermediate Check===

			Confirm things are installed properly so far by typing the following in a terminal:
			cmake --version
			python3 --version
			git --version
			autobuild --version

	~~~/ $ which cmake~~		If everything reported sensible values and not "Command not found" errors, then you are in good shape!
	~~/usr/local/bin/cmake~~

	==~~Download Source~~ Code==		==Step 2. Checkout Code==

	~~The canonical viewer repository is https://bitbucket.org/lindenlab/viewer-release~~		===Viewer===

			Open a terminal and checkout the viewer source code:
	git clone https://bitbucket.org/lindenlab/viewer.git		git clone https://bitbucket.org/lindenlab/viewer.git

	===~~Get the viewer-build-variables~~===		===Build Variables===

	See [[Building the Viewer with Autobuild#Select Build Variables]]		See [[Building the Viewer with Autobuild#Select Build Variables]]

	==Configure==		==Step 3. Configure==

	Be sure you have the following environment variables set before continuing:		Be sure you have the following environment variables set before continuing:
Line 41:		Line 45:
	autobuild configure -c RelWithDebInfoOS		autobuild configure -c RelWithDebInfoOS

	==Build==		==Step 4. Build==

	===Option 1: Command Line Build===		===Option 1: Command Line Build===
Line 49:		Line 53:
	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.		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===		===Option 2: Build in Xcode===

	Once you have run the <tt>autobuild configure</tt> 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.		Once you have run the <tt>autobuild configure</tt> 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==		===Running your newly built viewer===

	===Option 1: Command Line===		====Option 1: Command Line====

	To launch the viewer you build, from your source tree root directory, run:		To launch the viewer you build, from your source tree root directory, run:
Line 63:		Line 67:
	where ''configuration-type'' depends on your built configuration ("DebugOS", "ReleaseOS" or "RelWithDebInfoOS").		where ''configuration-type'' depends on your built configuration ("DebugOS", "ReleaseOS" or "RelWithDebInfoOS").

	===Option 2: Running Within Xcode===		====Option 2: Running Within Xcode====

	"secondlife-bin" scheme is what you look for.		"secondlife-bin" scheme is what you look for.
Line 69:		Line 73:
	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. ([https://lists.secondlife.com/pipermail/opensource-dev/2014-February/009784.html See this thread.])		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. ([https://lists.secondlife.com/pipermail/opensource-dev/2014-February/009784.html See this thread.])

	===Option 3: Using Finder===		====Option 3: Using Finder====

	# Navigate to <tt>build-darwin-x86_64/newview/''configuration-type''</tt>.		# Navigate to <tt>build-darwin-x86_64/newview/''configuration-type''</tt>.
Line 75:		Line 79:
	:You can create and put the alias wherever you find convenient.		:You can create and put the alias wherever you find convenient.

	==Running Unit Tests==		===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.		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==		===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.)		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===		====Optional: FMOD Ex====

	Pick somewhere to build your fmodex package:		Pick somewhere to build your fmodex package:

Aura Linden at 23:15, 17 December 2021

2021-12-17T23:15:31Z

← Older revision		Revision as of 16:15, 17 December 2021
Line 9:		Line 9:

	* [https://apps.apple.com/us/app/xcode/id497799835?mt=12 Xcode]		* [https://apps.apple.com/us/app/xcode/id497799835?mt=12 Xcode]
	* [https://cmake.org/download/ CMake] version 3.8 or newer		* [https://cmake.org/download/ CMake] version 3.8 or newer (For OS X use 3.19 or newer)
	* [https://git-scm.com/download/mac git]		* [https://git-scm.com/download/mac git]
	* [[Autobuild]]		* [[Autobuild]]

Signal Linden: Xcode command line tools have been installed by default since 6.1, updated prereqs and made them less pedantic. Noted homebrew is an option, moved proprietary lib instructions to the bottom since they just confuse new developers who think they're required

2021-07-31T21:04:51Z

Xcode command line tools have been installed by default since 6.1, updated prereqs and made them less pedantic. Noted homebrew is an option, moved proprietary lib instructions to the bottom since they just confuse new developers who think they're required

Show changes

Signal Linden: Signal Linden moved page Compiling the viewer (Mac OS X XCode) to Build the Viewer on macOS

2021-01-27T21:59:22Z

Signal Linden moved page Compiling the viewer (Mac OS X XCode) to Build the Viewer on macOS

← Older revision	Revision as of 14:59, 27 January 2021
(No difference)

AndreyK ProductEngine: /* Getting Development Tools */

2019-04-02T17:51:33Z

Getting Development Tools

← Older revision		Revision as of 10:51, 2 April 2019
Line 15:		Line 15:
	:Accept the xcode license by running the command <tt>sudo xcodebuild -license</tt> ; this diplays the license: page to the end and type <tt>agree</tt>		:Accept the xcode license by running the command <tt>sudo xcodebuild -license</tt> ; this diplays the license: page to the end and type <tt>agree</tt>
	;CMake		;CMake
	:Install CMake (at least version 3.4) from [http://www.cmake.org cmake.org]		:Install CMake (at least version 3.8) from [http://www.cmake.org cmake.org]
	:You will need to arrange for the cmake executable to be in your PATH.		:You will need to arrange for the cmake executable to be in your PATH.
	:The executable is '<tt>/Applications/CMake.app/Contents/bin/cmake</tt>'. Add that directory to your PATH, or create a symlink to the cmake executable in some directory that's in your PATH		:The executable is '<tt>/Applications/CMake.app/Contents/bin/cmake</tt>'. Add that directory to your PATH, or create a symlink to the cmake executable in some directory that's in your PATH

Vir Linden at 20:07, 18 December 2018

2018-12-18T20:07:29Z

← Older revision		Revision as of 13:07, 18 December 2018
Line 26:		Line 26:
	==Downloading Source Code==		==Downloading Source Code==

	The canonical viewer repository is https://bitbucket.org/lindenlab/viewer-release ~~'''but for these instructions use https://bitbucket.org/lindenlab/viewer64'''~~		The canonical viewer repository is https://bitbucket.org/lindenlab/viewer-release

	===Get the viewer-build-variables===		===Get the viewer-build-variables===

Aura Linden: /* Getting Development Tools */

2018-05-29T23:49:47Z