Difference between revisions of "Mac OS X"

From Armagetron
(Made more concise and clear. Took out commentary.)
Line 1: Line 1:
This page will help you get up and running to hack [[Armagetron]] on [[Mac OS X]]
+
This page will help you get up and running to hack Armagetron on Mac OS X.
  
 
= Prerequisites =
 
= Prerequisites =
  
 
== Xcode ==
 
== Xcode ==
You'll need Apple's [http://developer.apple.com/tools/xcodeXcode], this guide was written for version 3.1 on Mac OS X Leopard (10.5.4).
+
You'll need Apple's [http://developer.apple.com/tools/xcode Xcode] ≥ 2.4.  
  
 
== Libraries and dependancies ==
 
== Libraries and dependancies ==
  
All the external libraries you'll need are on the [http://sourceforge.net/project/showfiles.php?group_id=110997&package_id=266788 SourceForge.net project page]
+
All the external libraries you'll need are on the [http://sourceforge.net/project/showfiles.php?group_id=110997&package_id=266788 SourceForge.net armagetronad project page].
* SDL
 
* libpng
 
* libxml
 
* zthreads
 
* libfreetype
 
* ftgl
 
  
Extract the archive and copy the ArmagetronAdvanced to <pre>/Library/Frameworks/ArmagetronAdvanced</pre> as stated in the <tt>README</tt> file.
+
Extract the archive and copy the ArmagetronAdvanced to <pre>/Library/Frameworks/ArmagetronAdvanced</pre> as stated in the <tt>README.txt</tt> file.
 
 
You could also install everything using [[MacPorts]].
 
  
 
== MacPorts ==
 
== MacPorts ==
[[MacPorts]] may come in handy for installing external libraries and stuff like Subversion and Bazaar. You can get MacPorts from [http://www.macports.org/ their offical website].
+
[http://www.macports.org MacPorts] comes in handy for installing software, like Bazaar. It is optional, but it reduces the maintance of keeping your installed software up-to-date.
 
 
= Getting into it =
 
 
 
== Checking out a working copy ==
 
=== SVN ===
 
You should probably use [[Bazaar]] to get the workspace but I [http://www.urbandictionary.com/define.php?term=cba CBA] so I use SVN like everybody else.
 
  
==== Installing ====
+
= Getting the Source =
Grab the package with MacPorts : <pre>sudo port install subversion</pre>
 
You can also find <tt>.dmg</tt> distributions [http://www.google.com/search?q=subversion+dmg on the web].
 
  
==== Usage ====
+
The armagetronad source code is available from two sources: subversion and bazaar. Bazaar offers more features for developers wanting to work on and improve the game.
  
You can check out the stable branch ''a la mano'' like so:
+
== [[Working with SVN | Subversion]] ==
<pre>
 
svn co svn co https://svn.sourceforge.net/svnroot/armagetronad/armagetronad/trunk/armagetronad
 
</pre>
 
  
However, I recommend using Xcode's SCM repository manager (<tt>SCM -> Configure SCM Repositories...</tt> to set it up) to check out the same folder as above.
+
If you are running Mac OS X 10.5, you already have subversion. If you are running an older version of Mac OS X, install svn with macports, using the command <code>sudo port install subversion</code>.
  
Check out [[working with SVN]] for more "information".
+
To get the unstable trunk branch:
 +
<pre>svn co https://armagetronad.svn.sourceforge.net/svnroot/armagetronad/armagetronad/trunk/armagetronad</pre>
  
=== Bazaar ===
+
To get the stable 0.2.8 branch:
==== Installing this crap ====
+
<pre>svn co https://armagetronad.svn.sourceforge.net/svnroot/armagetronad/armagetronad/branches/0.2.8/armagetronad</pre>
If you installed [[MacPorts]] you can install [[Bazaar]] like so :
 
<pre>
 
sudo port -v install bzr
 
</pre>
 
  
'''WARNING!''' Be careful not to install the <tt>bazaar</tt> package as it is a deprecated version of Bazaar! Use the <tt>bzr</tt> package.
+
Check out [[Working with SVN]] for more information.
  
Having trouble? Check out [http://bazaar-vcs.org/MacPorts the guide to installing Bazaar with MacPorts] from the Bazaar website.
+
== [[Bazaar]] ==
I recommend you use the .dmg available for download if you're having any trouve installing.
 
  
==== Usage ====
+
[http://bazaar-vcs.org Bazaar] can be installed by using the command <code>sudo port install bzr</code>. If you did not install Macports, you can download an install dmg from the [http://bazaar-vcs.org Bazaar website].
  
Check out from the repository rather like you would with SVN, just there's fancy urls thanks to [[Launchpad]] :
+
To get the unstable trunk branch:
<pre>bzr checkout lp:armagetronad</pre>
+
<pre>bzr branch lp:armagetronad</pre>
  
== Creating the project ==
+
To get the stable 0.2.8 branch:
 +
<pre>bzr branch lp:armagetronad/0.2.8</pre>
  
To open the project in Xcode, easy as pie : just open the <tt>Armagetron Advanced.xcodeproj</tt> in the <tt>MacOS</tt> folder where you checked out.
+
Check out [[Bazaar]] for more information.
  
 
== Building ==
 
== Building ==
  
Click the '''Build''' button ! Easy !
+
Open the <code>MacOS/Armagetron Advanced.xcodeproj</code> and build.

Revision as of 20:12, 19 December 2008

This page will help you get up and running to hack Armagetron on Mac OS X.

Prerequisites

Xcode

You'll need Apple's Xcode ≥ 2.4.

Libraries and dependancies

All the external libraries you'll need are on the SourceForge.net armagetronad project page.

Extract the archive and copy the ArmagetronAdvanced to

/Library/Frameworks/ArmagetronAdvanced

as stated in the README.txt file.

MacPorts

MacPorts comes in handy for installing software, like Bazaar. It is optional, but it reduces the maintance of keeping your installed software up-to-date.

Getting the Source

The armagetronad source code is available from two sources: subversion and bazaar. Bazaar offers more features for developers wanting to work on and improve the game.

Subversion

If you are running Mac OS X 10.5, you already have subversion. If you are running an older version of Mac OS X, install svn with macports, using the command sudo port install subversion.

To get the unstable trunk branch:

svn co https://armagetronad.svn.sourceforge.net/svnroot/armagetronad/armagetronad/trunk/armagetronad

To get the stable 0.2.8 branch:

svn co https://armagetronad.svn.sourceforge.net/svnroot/armagetronad/armagetronad/branches/0.2.8/armagetronad

Check out Working with SVN for more information.

Bazaar

Bazaar can be installed by using the command sudo port install bzr. If you did not install Macports, you can download an install dmg from the Bazaar website.

To get the unstable trunk branch:

bzr branch lp:armagetronad

To get the stable 0.2.8 branch:

bzr branch lp:armagetronad/0.2.8

Check out Bazaar for more information.

Building

Open the MacOS/Armagetron Advanced.xcodeproj and build.