2016-05-29 11:19:01 +02:00
[](https://travis-ci.org/OoliteProject/oolite)
2016-07-25 12:42:33 +02:00
[](https://github.com/OoliteProject/Oolite/releases/latest)
2016-07-27 09:38:22 +02:00
| Windows | Linux | OSX |
|---------------------|---------------------|----------------|
2018-10-28 09:05:05 +01:00
| [](https://github.com/OoliteProject/oolite/releases/latest) | [](https://github.com/OoliteProject/oolite/releases/latest) | [](https://github.com/OoliteProject/oolite/releases/latest) |
[](https://github.com/OoliteProject/oolite/releases/latest)| [](https://github.com/OoliteProject/oolite/releases/latest) | [](https://github.com/OoliteProject/oolite/releases/latest) |
| | [](https://github.com/OoliteProject/oolite/releases/latest) | |
| | [](https://github.com/OoliteProject/oolite/releases/latest) | |
2016-07-27 09:38:22 +02:00
2016-07-25 12:42:33 +02:00
2007-06-12 08:43:59 +00:00
Oolite for all platforms can be built from this repository. Here is a quick
guide to the source tree.
2016-05-29 12:42:57 +02:00
For end-user documentation, see [oolite.org ](http://www.oolite.org/ ) and
[Elite Wiki ](http://wiki.alioth.net/index.php/Oolite_Main_Page ).
2006-03-05 16:26:25 +00:00
2016-05-29 11:17:21 +02:00
## Contents
2016-05-29 12:42:57 +02:00
- **debian**: Files to enable automatic setup under Linux using dpkg (Debian package manager) tools
- **DebugOXP**: [Debug.oxp ](http://wiki.alioth.net/index.php/Debug_OXP ), the expansion pack that enables console support in debug and test release builds
- **deps**
- **Cocoa-deps**: Dependencies for Mac OS X
- **Cross-platform-deps**: Dependencies for platforms other than Mac OS X
- **Linux-deps**: Dependencies for Linux on x86 and x86_64 processors
- **URLs**: URLs used for binary dependecies on Mac OS X
- **Windows-deps**: Dependencies for Windows on x86 and x86_64 processors
- **Doc**: Documentation (including user guides)
- **installers**: Files used to create various installers
- **Mac-specific**: Additional projects used only on Mac OS X
- **DataFormatters**: Debugger configurations for Xcode
- **DebugBundle**: Implements the [Debug menu and in-app console ](http://wiki.alioth.net/index.php/Debug_OXP#Mac_OS_X-specific_features )
- **OCUnitTest**: A small number of unit tests
- **Oolite-docktile:** An embedded plug-in which implements the Oolite dock menu when Oolite is not running
- **Oolite-importer**: A Spotlight importer to make saved games and OXPs searchable
2016-05-29 11:17:21 +02:00
- **Oolite.xcodeproj**: The OS X Xcode project to build Oolite
2016-05-29 12:42:57 +02:00
- **Resources**: Game assets and resource files for Mac and GNUstep application bundles
- **Schemata**: Plist schema files for the [OXP Verifier ](http://wiki.alioth.net/index.php/OXP_howto#OXP_Verifier )
- **src**: Objective-C and C sources, incuding header files
- **BSDCompat**: Support for BSDisms that gnu libc doesn't have (strl*)
- **Cocoa**: Files that are only compiled on Mac OS X
- **Core**: Files that are compiled on all platforms
- **SDL**: Files that are only compiled for platforms that use SDL
- **tests**: A mixed bag of test cases for manual testing and ad-hoc code tests.
- **tools**: Various tools for preparing files, builds, releases etc.
2016-05-29 11:17:21 +02:00
## Building
2016-05-29 12:42:57 +02:00
On Mac OS X, you will need the latest version of Xcode from the App Store.
Then double click on the Xcode project in the Finder, select one of the Oolite
targets from the Scheme pop-up, and hit Build and Run (the play button in the
toolbar).
2006-03-05 16:26:25 +00:00
2007-06-12 08:43:59 +00:00
For Windows, see the Oolite wiki:
http://wiki.alioth.net/index.php/Running_Oolite-Windows
On Linux, if you have the Debian package tools (installed by default with
Debian and Ubuntu), use dpkg-buildpackage.
On Linux, BSD and other Unix platforms without dpkg tools, you will need to
get GNUstep and SDL development libraries in addition to what is usually
installed by default if you choose to install the development
headers/libraries etc. when initially installing the OS. For most Linux
distros, GNUstep and SDL development libraries come prepackaged - just
apt-get/yum install the relevant files. You may also need to install Mozilla
Spidermonkey (libmozjs). On others you may need to build them from source. In
particular, you need the SDL_Mixer library, which doesn't always come with the
2016-05-29 11:17:21 +02:00
base SDL development kit. Then just type `make` , or, if you're using GNU make,
`make -f Makefile` . On some systems, such as Gentoo, you may need to run
`make -f Makefile OBJCFLAGS=-fobjc-exceptions` .
2006-03-05 16:26:25 +00:00
2016-05-29 11:17:21 +02:00
## Running
2006-03-05 16:26:25 +00:00
On OS X, you can run from Xcode by clicking on the appropriate icon
2016-05-29 12:42:57 +02:00
(or choosing 'Run' from the 'Product' menu).
2016-05-29 11:17:21 +02:00
On Linux/BSD/Unix, in a terminal, type `openapp oolite`
2013-11-10 12:09:57 +00:00
2016-05-29 11:17:21 +02:00
## Git
The Oolite source is available from github.
Use `git clone https://github.com/OoliteProject/oolite`
to retrieve. Then `git submodule update --init`
2013-11-10 12:09:57 +00:00
to fetch the various submodules.
If you've cloned the source from a forked repository instead, this may
not work - due to relative directory paths in .gitmodules, git tries
to download the submodules from the fork instead of the original oolite
repository. A workaround is to copy the file .absolute_gitmodules
onto .gitmodules, then perform the submodules init, then replace
2013-11-26 12:13:32 +00:00
.gitmodules with the relative path version. eg, on Unix:
2013-11-10 12:09:57 +00:00
2016-05-29 11:17:21 +02:00
```
2013-11-10 12:09:57 +00:00
$ cp .absolute_gitmodules .gitmodules
2013-11-13 19:00:57 +00:00
$ git submodule update --init
$ git checkout -- .gitmodules
2016-05-29 11:17:21 +02:00
```
2013-11-10 12:09:57 +00:00
2013-11-11 16:00:52 +00:00
You should now have access to the submodules, without git complaining
that .gitmodules has changed or including .gitmodules in pull requests.
