Mac Development Guide - Revision history

Echelon9: Reflect source code hosting via Git

2015-05-03T04:22:59Z

Reflect source code hosting via Git

← Older revision		Revision as of 04:22, 3 May 2015
Line 29:		Line 29:
	==Getting FreeSpace 2 Open SCP source code==		==Getting FreeSpace 2 Open SCP source code==

	Open Terminal.app through Spotlight, or it can be found in /Applications/Utilities/Terminal.app. This is the console command line for Mac OS. You will need a location to save the checked out source code. The following commands will create a new folder in your personal Documents called 'coding' and then within a subfolder specific for FS2_Open called 'fs2_open' checkout the latest ~~Subversion revision~~.		Open Terminal.app through Spotlight, or it can be found in /Applications/Utilities/Terminal.app. This is the console command line for Mac OS. You will need a location to save the checked out source code. The following commands will create a new folder in your personal Documents called 'coding' and then within a subfolder specific for FS2_Open called 'fs2_open' checkout the latest source code.

	cd Documents		$ cd Documents
	mkdir coding		$ mkdir coding
	cd coding		$ cd coding
	~~svn checkout svn~~://~~svn~~.~~icculus.org~~/fs2open/~~trunk/fs2_open fs2_open~~		$ git clone https://github.com/scp-fs2open/fs2open.github.com.git fs2open


	Open Finder and browse to ~/Documents/coding/~~fs2_open/~~ to see the new files that have been downloaded from the FS2_Open ~~Subversion~~ source code repository.		Open Finder and browse to ~/Documents/coding/fs2open to see the new files that have been downloaded from the FS2_Open source code repository.

	FS2_Open currently uses some precompiled third party Frameworks to handle music and video on Mac OS, which are stored in compressed form within ~~Subversion~~. Open the 'projects' folder and then 'Xcode4'. This is the location of recent Xcode specific project files and settings. For now, double click on Frameworks.tgz to uncompress these Frameworks to a new folder called Frameworks.		FS2_Open currently uses some precompiled third party Frameworks to handle music and video on Mac OS, which are stored in compressed form within the source code repository. Open the 'projects' folder and then 'Xcode4'. This is the location of recent Xcode specific project files and settings. For now, double click on Frameworks.tgz to uncompress these Frameworks to a new folder called Frameworks.

	Your local ~~SVN~~ checkout of the ~~FreeSpace 2 Open SCP~~ code can be keep up to date with the latest changes by opening Terminal.app again, and running the following commands		Your local checkout of the source code can be keep up to date with the latest changes by opening Terminal.app again, and running the following commands

	cd Documents/coding/~~fs2_open~~		$ cd Documents/coding/fs2open
	~~svn up~~		$ git pull

	Xcode and the FreeSpace 2 Open SCP source code is now setup, so let's start our first compilation by double clicking on the FS2_Open.xcodeproj Xcode project file.		Xcode and the FreeSpace 2 Open SCP source code is now setup, so let's start our first compilation by double clicking on the FS2_Open.xcodeproj Xcode project file.

Chief1983: /* Getting Xcode */ Add info about acquiring Xcode 3.2.6.

2014-06-30T21:48:57Z

Getting Xcode: Add info about acquiring Xcode 3.2.6.

← Older revision		Revision as of 21:48, 30 June 2014
Line 6:		Line 6:
	Xcode is the integrated development environment (IDE) that Apple provides free of charge for the Mac OS platform. It is the Mac equivalent to Microsoft Visual Studio. In practice, Xcode provides a graphical interface to an underlying Clang/LLVM compiler; with the addition of platform libraries (Frameworks), code completion, project management and the other features you would expect of a modern IDE.		Xcode is the integrated development environment (IDE) that Apple provides free of charge for the Mac OS platform. It is the Mac equivalent to Microsoft Visual Studio. In practice, Xcode provides a graphical interface to an underlying Clang/LLVM compiler; with the addition of platform libraries (Frameworks), code completion, project management and the other features you would expect of a modern IDE.

	Xcode is available free from the Mac App Store.		The latest Xcode is available free from the Mac App Store. Xcode 3.2.6 is available to those with a free Apple Developer account on the [https://developer.apple.com/downloads/index.action Apple Developer Downloads] page, search for 'Xcode 3.2.6' and it should be the only result. This may be useful for those with older hardware/software needs.

	It is '''strongly recommended''' that you update to the latest version of Xcode compatible with your Mac OS version, as prior versions have bugs which prevent FS2_Open from compiling properly.		It is '''strongly recommended''' that you update to the latest version of Xcode compatible with your Mac OS version, as prior versions have bugs which prevent FS2_Open from compiling properly.

Chief1983: /* Getting Xcode */ 3.2.6 works on 10.8 just fine, and I'll hopefully be able to test 10.9 soon.

2014-06-30T21:44:37Z

Getting Xcode: 3.2.6 works on 10.8 just fine, and I'll hopefully be able to test 10.9 soon.

← Older revision		Revision as of 21:44, 30 June 2014
Line 24:		Line 24:
	\|-		\|-
	! Xcode 3.2.6		! Xcode 3.2.6
	\| n/a \|\| n/a \|\| <font color=green>Yes</font>		\| n/a \|\| <font color=green>Yes</font> \|\| <font color=green>Yes</font>
	\|}		\|}


	==Getting FreeSpace 2 Open SCP source code==		==Getting FreeSpace 2 Open SCP source code==

Echelon9: Reflect latest Xcode version number and the path naming of trunk LLVM

2014-04-20T08:57:29Z

Reflect latest Xcode version number and the path naming of trunk LLVM

← Older revision		Revision as of 08:57, 20 April 2014
Line 14:		Line 14:
	! !! OS X 10.9 !! OS X 10.8 !! OS X 10.7		! !! OS X 10.9 !! OS X 10.8 !! OS X 10.7
	\|-		\|-
	! Xcode 5.1		! Xcode 5.1.1
	\| <font color=green>Yes</font> \|\| <font color=green>Yes</font> \|\| n/a		\| <font color=green>Yes</font> \|\| <font color=green>Yes</font> \|\| n/a
	\|-		\|-
Line 78:		Line 78:
	You may need to open the Xcode GUI and copy the following file into the Linked Frameworks		You may need to open the Xcode GUI and copy the following file into the Linked Frameworks

	/path/to/llvm/build/Debug+Asserts/lib/clang/3.5/lib/darwin/libclang_rt.asan_osx_dynamic.dylib		/path/to/llvm/build/Debug+Asserts/lib/clang/3.5.0/lib/darwin/libclang_rt.asan_osx_dynamic.dylib

	FS2_Open must be run from the Terminal to enable to AddressSanitizer feature at runtime. Additionally, to ensure line references and the like are cleanly shown the output must be piped to a Python script which symobilizes line references		FS2_Open must be run from the Terminal to enable to AddressSanitizer feature at runtime. Additionally, to ensure line references and the like are cleanly shown the output must be piped to a Python script which symobilizes line references

	./FS2_Open\ $debug$.app/Contents/MacOS/FS2_Open\ $debug$ 2>&1 \| /path/to/llvm/projects/compiler-rt/lib/asan/scripts/asan_symbolize.py \| c++filt		./FS2_Open\ $debug$.app/Contents/MacOS/FS2_Open\ $debug$ 2>&1 \| /path/to/llvm/projects/compiler-rt/lib/asan/scripts/asan_symbolize.py \| c++filt

Echelon9: Revise and update the OSX and Xcode support table to reflect the modern reality of developer systems (95% confidence interval)

2014-03-15T11:26:52Z

Revise and update the OSX and Xcode support table to reflect the modern reality of developer systems (95% confidence interval)

← Older revision		Revision as of 11:26, 15 March 2014
Line 12:		Line 12:
	{\| style="text-align:center"		{\| style="text-align:center"
	\|+ ''Known working combinations''		\|+ ''Known working combinations''
	! !! OS X 10.9 !! OS X 10.8.5 !! OS X 10.7 !~~! OS X 10.6~~.8		! !! OS X 10.9 !! OS X 10.8 !! OS X 10.7
			\|-
			! Xcode 5.1
			\| <font color=green>Yes</font> \|\| <font color=green>Yes</font> \|\| n/a
	\|-		\|-
	! Xcode 5.0.2		! Xcode 5.0.2
	\| <font color=green>Yes</font> \|\| <font color=green>Yes</font> ~~\|\| n/a~~ \|\| n/a		\| <font color=green>Yes</font> \|\| <font color=green>Yes</font> \|\| n/a
	\|-		\|-
	! Xcode 4.2.1		! Xcode 4.2.1
	\| n/a \|\| n/a \|\| <font color=orange>Partially~~</font> \|\| <font color=red>Not as yet~~</font>		\| n/a \|\| n/a \|\| <font color=orange>Partially</font>
	\|-		\|-
	! Xcode 3.2.6		! Xcode 3.2.6
	\| n/a \|\| n/a \|\| <font color=green>Yes</font> ~~\|\| <font color=green>Yes</font>~~		\| n/a \|\| n/a \|\| <font color=green>Yes</font>
	\|-
	~~! Xcode 3.1.4~~
	~~\| n/a \|\| n/a \|\| n/a \|\| <font color=red>No</font>~~
	\|-
	~~! Xcode 3.0.0~~
	~~\| n/a \|\| n/a \|\| n/a \|\| Unknown~~
	\|}		\|}

Echelon9: /* Compiling FreeSpace 2 Open SCP source code (Command line) */ Pick up latest Clang version upstream

2014-01-26T11:45:14Z

Compiling FreeSpace 2 Open SCP source code (Command line): Pick up latest Clang version upstream

← Older revision		Revision as of 11:45, 26 January 2014
Line 81:		Line 81:
	You may need to open the Xcode GUI and copy the following file into the Linked Frameworks		You may need to open the Xcode GUI and copy the following file into the Linked Frameworks

	/path/to/llvm/build/Debug+Asserts/lib/clang/3.4/lib/darwin/libclang_rt.asan_osx_dynamic.dylib		/path/to/llvm/build/Debug+Asserts/lib/clang/3.5/lib/darwin/libclang_rt.asan_osx_dynamic.dylib

	FS2_Open must be run from the Terminal to enable to AddressSanitizer feature at runtime. Additionally, to ensure line references and the like are cleanly shown the output must be piped to a Python script which symobilizes line references		FS2_Open must be run from the Terminal to enable to AddressSanitizer feature at runtime. Additionally, to ensure line references and the like are cleanly shown the output must be piped to a Python script which symobilizes line references

	./FS2_Open\ $debug$.app/Contents/MacOS/FS2_Open\ $debug$ 2>&1 \| /path/to/llvm/projects/compiler-rt/lib/asan/scripts/asan_symbolize.py \| c++filt		./FS2_Open\ $debug$.app/Contents/MacOS/FS2_Open\ $debug$ 2>&1 \| /path/to/llvm/projects/compiler-rt/lib/asan/scripts/asan_symbolize.py \| c++filt

Echelon9: The default build of Clang/LLVM will be Debug+Asserts

2013-11-16T07:28:25Z

The default build of Clang/LLVM will be Debug+Asserts

← Older revision		Revision as of 07:28, 16 November 2013
Line 73:		Line 73:

	cd Documents/coding/fs2_open/projects/Xcode4		cd Documents/coding/fs2_open/projects/Xcode4
	export CC=/path/to/llvm/../build/~~[Release~~+Asserts]/bin/clang		export CC=/path/to/llvm/../build/Debug+Asserts/bin/clang
	export CXX=/path/to/llvm/../build/~~[Release~~+Asserts]/bin/clang++		export CXX=/path/to/llvm/../build/Debug+Asserts/bin/clang++
	export CFLAGS=-fsanitize=address		export CFLAGS=-fsanitize=address
	export LDFLAGS=-fsanitize=address		export LDFLAGS=-fsanitize=address
Line 81:		Line 81:
	You may need to open the Xcode GUI and copy the following file into the Linked Frameworks		You may need to open the Xcode GUI and copy the following file into the Linked Frameworks

	/path/to/llvm/build/~~Release~~+Asserts/lib/clang/3.4/lib/darwin/libclang_rt.asan_osx_dynamic.dylib		/path/to/llvm/build/Debug+Asserts/lib/clang/3.4/lib/darwin/libclang_rt.asan_osx_dynamic.dylib

	FS2_Open must be run from the Terminal to enable to AddressSanitizer feature at runtime. Additionally, to ensure line references and the like are cleanly shown the output must be piped to a Python script which symobilizes line references		FS2_Open must be run from the Terminal to enable to AddressSanitizer feature at runtime. Additionally, to ensure line references and the like are cleanly shown the output must be piped to a Python script which symobilizes line references

	./FS2_Open\ $debug$.app/Contents/MacOS/FS2_Open\ $debug$ 2>&1 \| /path/to/llvm/projects/compiler-rt/lib/asan/scripts/asan_symbolize.py \| c++filt		./FS2_Open\ $debug$.app/Contents/MacOS/FS2_Open\ $debug$ 2>&1 \| /path/to/llvm/projects/compiler-rt/lib/asan/scripts/asan_symbolize.py \| c++filt

Echelon9: /* Compiling FreeSpace 2 Open SCP source code (Command line) */

2013-11-16T07:19:25Z

Compiling FreeSpace 2 Open SCP source code (Command line)

← Older revision		Revision as of 07:19, 16 November 2013
Line 73:		Line 73:

	cd Documents/coding/fs2_open/projects/Xcode4		cd Documents/coding/fs2_open/projects/Xcode4
	export CC=/path/to/llvm/../build/[Release+~~Assert~~]/bin/clang		export CC=/path/to/llvm/../build/[Release+Asserts]/bin/clang
	export CXX=/path/to/llvm/../build/[Release+~~Assert~~]/bin/clang++		export CXX=/path/to/llvm/../build/[Release+Asserts]/bin/clang++
	export CFLAGS=-fsanitize=address		export CFLAGS=-fsanitize=address
	export LDFLAGS=-fsanitize=address		export LDFLAGS=-fsanitize=address

Echelon9: Demonstrate steps for building from Command line and AddressSanitizer builds of FS2_Open

2013-11-16T07:18:27Z

Demonstrate steps for building from Command line and AddressSanitizer builds of FS2_Open

@@ Line 31: / Line 31: @@
-==Getting the FreeSpace 2 Open SCP source code==
+==Getting FreeSpace 2 Open SCP source code==
 Open Terminal.app through Spotlight, or it can be found in /Applications/Utilities/Terminal.app. This is the console command line for Mac OS. You will need a location to save the checked out source code. The following commands will create a new folder in your personal Documents called 'coding' and then within a subfolder specific for FS2_Open called 'fs2_open' checkout the latest Subversion revision.
@@ Line 52: / Line 52: @@
 Xcode and the FreeSpace 2 Open SCP source code is now setup, so let's start our first compilation by double clicking on the FS2_Open.xcodeproj Xcode project file.
-Once picked, click the 'Build' button. For the first time, this will take some time (dependent upon the speed of your hardware). This should complete successfully, and once done the binary application can be found within 'projects/Xcode/build/'. Open the folder with the same name as the build type you selected previously to find the compiled FS2_Open application.
+==Compiling FreeSpace 2 Open SCP source code (GUI)==
 [[Category:Source Code Project]][[Category:FreeSpace_Open_on_Mac]]

Echelon9: Clean up comments referable to very old versions of OS X and Xcode only

2013-11-16T07:03:28Z

Clean up comments referable to very old versions of OS X and Xcode only

← Older revision		Revision as of 07:03, 16 November 2013
Line 1:		Line 1:
	This page provides background and instructions to setup the ~~Apple~~ Xcode development environment in order to compile FreeSpace 2 Open SCP. After following these instructions you will have a working Xcode build environment, a checked out copy of the latest FS2_Open source code, and compiled binaries of the latest revision of the FS2_Open engine.		This page provides background and instructions to setup the Xcode development environment in order to compile FreeSpace 2 Open SCP. After following these instructions you will have a working Xcode build environment, a checked out copy of the latest FS2_Open source code, and compiled binaries of the latest revision of the FS2_Open engine.

	[[Image:Xcode icon.png‎\|right\|110px]]		[[Image:Xcode icon.png‎\|right\|110px]]

	==Getting ~~Apple~~ Xcode==		==Getting Xcode==
	Xcode is the integrated development environment (IDE) that Apple provides free of charge for the Mac OS platform. It is the Mac equivalent to Microsoft Visual Studio. In practice, Xcode provides a graphical interface to an underlying Clang/LLVM compiler; with the addition of platform libraries (Frameworks), code completion, project management and the other features you would expect of a modern IDE.		Xcode is the integrated development environment (IDE) that Apple provides free of charge for the Mac OS platform. It is the Mac equivalent to Microsoft Visual Studio. In practice, Xcode provides a graphical interface to an underlying Clang/LLVM compiler; with the addition of platform libraries (Frameworks), code completion, project management and the other features you would expect of a modern IDE.

Line 12:		Line 12:
	{\| style="text-align:center"		{\| style="text-align:center"
	\|+ ''Known working combinations''		\|+ ''Known working combinations''
	! !! OS X 10.9 !! OS X 10.8.5 !! OS X 10.7 !! OS X 10.6.8 ~~!! OS X 10.5.8 !! OS X 10.4.11~~		! !! OS X 10.9 !! OS X 10.8.5 !! OS X 10.7 !! OS X 10.6.8
	\|-		\|-
	! Xcode 5.0.2		! Xcode 5.0.2
	\| <font color=green>Yes</font> \|\| <font color=green>Yes</font> ~~\|\| n/a \|\| n/a~~ \|\| n/a \|\| n/a		\| <font color=green>Yes</font> \|\| <font color=green>Yes</font> \|\| n/a \|\| n/a
	\|-		\|-
	! Xcode 4.2.1		! Xcode 4.2.1
	\| n/a \|\| n/a \|\| <font color=orange>Partially</font> \|\| <font color=red>Not as yet</font> ~~\|\| n/a \|\| n/a~~		\| n/a \|\| n/a \|\| <font color=orange>Partially</font> \|\| <font color=red>Not as yet</font>
	\|-		\|-
	! Xcode 3.2.6		! Xcode 3.2.6
	\| n/a \|\| n/a \|\| <font color=green>Yes</font> \|\| <font color=green>Yes</font> ~~\|\| n/a \|\| n/a~~		\| n/a \|\| n/a \|\| <font color=green>Yes</font> \|\| <font color=green>Yes</font>
	\|-		\|-
	! Xcode 3.1.4		! Xcode 3.1.4
	\| n/a \|\| n/a \|\| n/a \|\| <font color=red>No</font> ~~\|\| Unknown \|\| Unknown~~		\| n/a \|\| n/a \|\| n/a \|\| <font color=red>No</font>
	\|-		\|-
	! Xcode 3.0.0		! Xcode 3.0.0
	\| n/a \|\| n/a \|\| n/a ~~\|\| Unknown \|\| <font color=green>Yes</font> \|\| Unknown~~		\| n/a \|\| n/a \|\| n/a \|\| Unknown
	\|-
	~~! Xcode 2.5~~
	~~\| n/a \|\| n/a \|\| n/a \|\| Unknown \|\| Unknown~~ \|\| Unknown
	\|}		\|}

Line 46:		Line 43:
	Open Finder and browse to ~/Documents/coding/fs2_open/ to see the new files that have been downloaded from the FS2_Open Subversion source code repository.		Open Finder and browse to ~/Documents/coding/fs2_open/ to see the new files that have been downloaded from the FS2_Open Subversion source code repository.

	FS2_Open currently uses some precompiled third party Frameworks to handle music and video on Mac OS, which are stored in compressed form within Subversion. Open the 'projects' folder and then '~~Xcode~~'. This is the location of ~~all Apple~~ Xcode specific project files and settings. For now, double click on Frameworks.tgz to uncompress these Frameworks to a new folder called Frameworks.		FS2_Open currently uses some precompiled third party Frameworks to handle music and video on Mac OS, which are stored in compressed form within Subversion. Open the 'projects' folder and then 'Xcode4'. This is the location of recent Xcode specific project files and settings. For now, double click on Frameworks.tgz to uncompress these Frameworks to a new folder called Frameworks.

	Your local SVN checkout of the FreeSpace 2 Open SCP code can be keep up to date with the latest changes by opening Terminal.app again, and running the following commands		Your local SVN checkout of the FreeSpace 2 Open SCP code can be keep up to date with the latest changes by opening Terminal.app again, and running the following commands