Running Oolite-Mac

From Elite Wiki
Revision as of 07:16, 8 August 2012 by Eric Walch (talk | contribs) (Added note that trunk no longer compiles on the older Xcode 3.x)

Overview

Oolite was originally developed for OS X, and as such, OS X is Oolite's home operating system. The OS X version can be considered the reference version for all other ports. It has some specific Mac OS X only support such as speech synthesis, iTunes integration and Growl integration. Joysticks are not directly supported - however, there are programs that convert joystick inputs into mouse and keyboard inputs, and these programs are reported to work well with Oolite.

Getting and installing the game

You can get the most recent release of the game from BerliOS.

Installation is the standard method of dragging the Oolite folder to your Applications or Games folder.

Installing OXPs (add ons)

In the Oolite folder that you dragged from the disk image, you will find an Oolite application and an AddOns folder. Place OXPs in the AddOns folder, and they will be loaded the next time you start the game.

Building Oolite from source

Development Environment (Xcode)

The supported development environment for Oolite trunk is Xcode 4.2 or later under Mac OS X 10.7. At the time of writing, earlier versions of Xcode running under Mac OS X 10.6 or later will only work after some additional changes, but are no longer supported. Xcode 4 is available for free from the Mac App Store.

Earlier versions of Oolite, including the 1.76-maintenace branch, require Xcode 3.2.6, even under Mac OS X 10.7. For more information, see this earlier version of this page.

You will also require the Subversion version control tool; an up-to-date binary is available here.

Getting the source

The source code and data files are available from the oolite-linux BerliOS project. Don't be confused by the name 'oolite-linux'; at one point there were three separate repositories for Oolite, but the Linux one was where they ended up being merged together. The SVN url for the current development line is:

svn://svn.berlios.de/oolite-linux/trunk

Version 1.76 is:

svn://svn.berlios.de/oolite-linux/tags/1.76

The 1.76.x maintenance branch is:

svn://svn.berlios.de/oolite-linux/branches/1.76-maintenance

Note that the 1.76 versions require Xcode 3.2.6 as mentioned above.


To download the source with Subversion, the quickest way to do it is to open a Terminal window, and run the following command:

svn checkout svn://svn.berlios.de/oolite-linux/trunk

If you have a BerliOS account and are a project member, you can get it with:

svn checkout svn+ssh://accountname@svn.berlios.de/svnroot/repos/oolite-linux/trunk

Developers should also checkout the relevant maintenance branch:

svn checkout svn+ssh://accountname@svn.berlios.de/svnroot/repos/oolite-linux/branches/1.76-maintenance/

Building Oolite

For a trunk build, open Oolite.xcodeproj, select the Oolite – Debug or Oolite – Test Release scheme from the Scheme pop-up menu, and hit Build. Dependencies will be downloaded automatically (in the deps folder inside the Oolite repository).

When you open the project for the first time, Xcode will generate build schemes for all the subprojects used to build Oolite. It is unlikely that you will ever need this, so it’s a good idea to hide them. Select Manage Schemes from the Product menu and uncheck the checkboxes in the Show column, except for the schemes marked Shared.

Building earlier versions

For instructions on building earlier versions of Oolite, see this earlier version of this page.

Build products

Building any of the shared build schemes in trunk will result in the following being created in the build results folder: AddOns, Debug.oxp, include (with subfolders js, ogg, png and vorbis), jskwgen, jsoplengen, libjs_for_oolite.a, libnspr4_for_oolite.a, libogg_for_oolite.a, libpng_for_oolite.a, libvorbis_for_oolite.a, Oolite.app, Oolite.docktileplugin and Oolite.mdimporter. AddOns contains a copy of Debug.oxp. Oolite.app contains a copy of Oolite.mdimporter and Oolite.docktileplugin, and static libraries (.a files) are linked into the Oolite executable. Everything except Oolite.app and AddOns can be considered side effects of the build process.