Running Oolite-Windows

2015-03-24T10:16:41Z

Day: /* Revised build from Source */

==Overview==
The Windows port of Oolite is built from the same source as the [[Running Oolite-Mac|Mac OS X]] and [[Running Oolite-Linux|Linux]] versions, and has all the features of those versions.

All OXPs should be compatible with the Windows port.

==Getting and installing the game==
{| width="100%" style="border: 2px solid #000033; background-color: #ffffff; padding: .1em; cellpadding: 0; cellspacing: 0; color: #000000;"
|'''The latest release can be downloaded from [http://developer.berlios.de/project/showfiles.php?group_id=3577 the BerliOS project].''' New releases are announced on [http://www.aegidian.org/bb/viewforum.php?f=8 the Oolite forum].
|}

The latest recommended release, 1.77, or the last official stable release, 1.76.1, can be downloaded from [http://www.oolite.org/download.shtml Oolite.org].

To install, run the installer that you have just downloaded.

The game has been tested on Windows 2000, XP, Vista and Windows 7. This game uses OpenGL, and you are advised to run the latest 3D graphics drivers from your 3D card manufacturer.
'''It will not run on the DOS-extender versions of Windows''' such as Windows 95, 98 or ME.

===Important note for Vista users!===
<h5>Summary:</h5>
DATA LOSS and OXP MALFUNCTION can appear if you install an early version of Oolite (1.65 - 1.72.x) on Vista. '''Oolite 1.73 and later releases have corrected this issue''' by using a different default installation directory, instead of one inside program files, as before.

<h5>Do This</h5>
When asked by the installer, change the Oolite install directory to a different location, one outside C:\Program Files\, like
* C:\Oolite\
* C:\Games\Oolite\
etc.

<h5>Don't Do This</h5>
It is STRONGLY recommended NOT to use the folder C:\Program Files\Oolite\ or any path including the following:
* %ProgramFiles%
* %ProgramData%
* %SystemRoot%

<h5>Why?</h5>
Vista rearranges some files outside the Oolite folder structure without visible alias/redirects, which completely hides all saved games and causes some OXP add-ons to malfunction. This is because Vista virtualizes files in those locations for legacy processes. You can read more about this problem on [http://aegidian.org/bb/viewtopic.php?t=5610 this Oolite forum thread]. The Microsoft explanation is here: [http://technet.microsoft.com/en-us/magazine/2007.06.uac.aspx].

<h5>Recovering Your Commanders Saved Under Vista</h5>
If you have already installed Oolite on a Vista machine and wish to move your saved games to a new and safer file location:
* Examine location C:\Users\[username]\AppData\Local\VirtualStore\Program Files\Oolite\oolite.app\oolite-saves\
or
* Use Windows Explorer to search for the string " *.oolite-save " with the Windows search option "''include system and hidden files''" checked (turned on).

For example, the default commander, if saved, might be found in this path:
C:\Users\[username]\AppData\Local\VirtualStore\Program Files\Oolite\oolite.app\oolite-saves\Jameson.oolite-save

==Running the game==
Find the Oolite icon in the Start -> Programs menu and click on it. Alternatively double click the Oolite program icon on the desktop. Note that the following key combination will get you out of 'graphics related trouble':

Shift-Escape: Quit Oolite immediately

If your game seems to have unreasonably low fps performance (check this in-game by hitting SHIFT-F) it is strongly recommended you visit your graphic cards' suppliers website and download and install the latest drivers.

===Installing OXPs===
You will need to find where the oolite.app folder is placed: versions 1.65 to 1.72.x should default to C:\Program Files\Oolite, later versions default install is C:\Oolite, to avoid clashes with Vista's virtual folders feature(see above). Create an AddOns folder beside the oolite.app folder. Put OXPs in here. '''NB:''' most OXPs zip files contain a folder with a README file and the actual OXP directory (somename.oxp) as a sub-folder - in this case, it's best to unzip the OXP somewhere else and then copy the unpacked .oxp folder into AddOns.

===Notes for amd64 users===
64-bit builds of Oolite for Windows are available and the development environment used defaults to 64-bit executables generation. They are the recommended ones for 64-bit OSes. However, the 32-bit version should run on 64-bit Windows without issues as well.

==Building from Source==
[[Developing_Oolite#On_Windows]]

==Old Building Oolite from source==
'''Updated on 09 January 2009 - (left here for reference, please use the instructions above).'''

'''Acknowledgments and thanks to Kaks for providing them:'''

'''Important note: It is recommended that all packages for Windows be installed in paths that do not contain spaces. The same recommendation applies for the Windows username of the account the build is performed from. There have been reports of MSYS/make problems in such cases.'''

# If you have an older version of GNUstep(GNUstep-base-1.11.1-gui-0.10.1-3 - from the wiki howto), uninstall it, then delete its root directory if it's still there(c:\GNUstep).
# Google & download the following 2 packages, and - this is important - install them in this sequence: http://ftpmain.gnustep.org/pub/gnustep/binaries/windows/gnustep-system-0.19.2-setup.exe, http://ftpmain.gnustep.org/pub/gnustep/binaries/windows/gnustep-core-0.19.2-setup.exe
# Google & download tortoiseSVN, install.
# You now need the dependencies files for Windows. Download Local_20090108.zip [ftp://ftp.alioth.net/oolite/Local_20090108.zip].
# Go to the Windows Start menu, navigate to and select ''Start>Programs>GNUstep>Shell''
# At the prompt :
## <code>mkdir /Local </code>
## <code>mkdir /Local/oolite </code>
## <code>mkdir /Local/oolite/trunk </code>. The first slash & the upper case L are very important!
# From windows, extract the directories inside Local_20090108.zip to <code>C:\GNUstep\Local </code>
# Still from windows go to <code>C:\GNUstep\Local\oolite\trunk </code>
# It's empty. Right click>SVN checkout. The repository is <code>svn://svn.berlios.de/oolite-linux/trunk </code>. Wait for it to finish.
# From inside the GNUstep shell
## <code>export PATH=$PATH:/Local/bin </code>
## <code>cd /Local/oolite/trunk </code>
## <code>make debug=no</code>
# We're now ready to launch the compiled oolite! From inside the GNUstep shell:
## <code>cd /Local/oolite/trunk </code>
## <code>openapp oolite.app </code>

''' The instructions below are valid only for versions prior to 1.70, only use them as an alternative if the updated ones fail for whatever reason.'''

# Download and install the necessary software
## Download and install svn for Windows: [http://subversion.tigris.org/project_packages.html#binary-packages]. Accept all defaults given by the installer.
## Download and install GNUstep for windows: [ftp://ftp.gnustep.org/pub/gnustep/binaries/windows/base-1.11.1-gui-0.10.1/GNUstep-base-1.11.1-gui-0.10.1-3.exe]. Accept all defaults given by the installer.
## Download the SDL files required to build Oolite: [http://prdownload.berlios.de/oolite-pc/Local.zip]
## Unzip this file to <code>c:\GNUstep\Local</code>
# Get the source and build it (note, the source comes from the oolite-linux project)
## Start the GNUstep command line (Start -> Programs -> GNUstep Development -> MSYS for GNUstep) and issue the following commands:
## <code>cd $GNUSTEP_LOCAL_ROOT</code>
## <code>export PATH=$PATH:$GNUSTEP_LOCAL_ROOT/bin</code>
## <code>mkdir oolite</code>
## <code>cd oolite</code>
## <code>svn checkout svn://svn.berlios.de/oolite-linux/trunk</code>
## <code>cd trunk</code>
## <code>make</code>
# To run the game in the build environment:
## Before running the first time: <code>cp $GNUSTEP_LOCAL_ROOT/bin/*.dll oolite.app</code>
## <code>openapp oolite.app</code>

Assuming you have installed one of Nic's releases as detailed above, you can easily keep updating the installation from the latest source. In the <code>$GNUSTEP_LOCAL_ROOT/oolite/trunk</code> directory, issue the commands:

# <code>export PATH=$PATH:$GNUSTEP_LOCAL_ROOT/bin</code>
# <code>svn up</code>
# <code>rm -rf oolite.app/Resources; make</code>

You only need to issue the export PATH command when you first start the command line. The rm -rf command before make is required because GNUstep for Windows cannot parse the XML plist file format, and the build fails when it tries to read one of these generated each time the build is performed. This failure is not important, and the process still works, but it is annoying.

Then use the following script to copy the new files over the existing installation:

<pre>
OA="/c/Program Files/Oolite/oolite.app"
cd $GNUSTEP_LOCAL_ROOT/oolite/trunk
if [ oolite.app/oolite.exe -nt "$OA/oolite.exe" ]; then
echo "Updating oolite.exe"
cp oolite.app/oolite.exe "$OA/oolite.exe"
fi

for a in AIs Config Images Models Music Sounds Textures; do
for b in Resources/$a/*; do
c=`basename $b`
if [ $b -nt "$OA/Contents/Resources/$a/$c" ]; then
echo "Updating with $b"
cp $b "$OA/Contents/Resources/$a/$c"
fi
done
done
</pre>

If you want to edit the source, Notepad++ has good Objective-C support and is free: [http://notepad-plus.sourceforge.net/]

Also see the Oolite-PC forum: [http://www.aegidian.org/bb/viewforum.php?f=8]

[[Category:Oolite]]

Developing Oolite

2015-03-24T10:06:51Z

Day: /* On Windows */

= Overview =

This page intends to allow you to setup an environment to develop Oolite.
It is possible either to setup your own branch on github, or to only clone locally the master branch.
In both cases, you can hack, try, do whatever takes your fancy :-)
But to have your changes integrated back into the main Oolite, it is easier to setup your own branch. Luckily, you can do this at the end when you are ready to propose your code too.

= Versioning (optional) =

When developing software, each little modification is tracked independently and assigned a version identifier.
That's called [http://en.wikipedia.com/Software_versioning versioning].
To do this, we use the [http://en.wikipedia.com/Git_(software) git] software.

The Oolite code is hosted on a git-friendly repository: github.

== Creating a GitHub account ==

Go to https://github.com/ and create an account.

== Creating a branch on GitHub ==

Fork the [https://github.com/OoliteProject/oolite oolite main branch].

== Fetching your branch ==

We now repatriate the code locally: we fetch it.

=== On Linux ===

==== Installing git ====

We need git for this. Installing it depends on your distribution. For ubuntu:
<code>sudo apt-get install git</code>

==== Fetching ====
<code>$git fetch --help</code>

= Cloning the master branch (alternative to setting up your own branch) =

The Oolite source is available from github. Use

<code> git clone https://github.com/OoliteProject/oolite </code>

to retrieve. Then

<code> git submodule update --init</code>

to fetch the various submodules.

Et voila! You've got the source ready to be compiled and/or tweaked.

= Documentation =

The documentation is automatically generated from the source code.
When generated, it's 700mb heavy !

== Pre-requisites ==

Installing Doxygen

=== On Linux ===

It depends on your distribution. For Ubuntu:
<code>sudo apt-get install doxygen</code>

== Generation ==

The documentation is generated into a html sub-directory.

=== On Linux ===

Go into your oolite directory and just do: <code>$doxygen Doxyfile</code>

= Setting up your development environment =

== On Linux ==

Do as you wish :-)

I use vim + youcompleteme.

There's no IDE on linux managing objective-c (at least not Eclipse and Intellij).
Auto-completion doesn't work in most of them because the xCode libraries aren't available (they're on OS X).

The only plugin for objective-c on eclipse is discontinued.

You can see the call hierarchy in the doxygen documentation.

= Building =
== On Windows ==
=== Current way to do it ===

''Let's hear the wise words of another_commander (Updated 08th November 2013)''

Seeing that, despite the quite comprehensive wiki instructions on how to make an Oolite executable, building from source on Windows is still a quite complicated matter, I have created a package that will hopefully simplify the process a lot and allow even the relatively inexperienced users to have a razor bleeding edge version of the game to play with and test. Please note that bleeding edge versions may cause spontaneous combustion of your computer, so you use them at own risk.

The download link to the Oolite Development Environment - Light Edition is this:
https://drive.google.com/file/d/0BwG6R5Qjd1f2aWRxZDY5NkxlcG8/edit?usp=sharing
The package contains the Objective-C compiler plus Posix environment (MinGW/MSYS), the Git package version 1.8.3 required for checking out and updating the source code and the required gnustep-base 1.20.1 files. No other downloads will be required.

Instructions on how to build an Oolite trunk executable from zero:

Download the environment and unzip it to a folder of your choice. IMPORTANT: The zip file you downloaded must be decompressed maintaining the folders' path structure, check your unzip program's documentation if you are not sure how to do this. Also note that in the unlikely case that your system is using drive letter O:, you will need to edit the files msys_x2/1.0/msys.bat and msys_x2/1.0/etc/fstab and change the references to o: to an unused drive letter. MORE IMPORTANT: Do not install this in a path containing spaces. We have had cases where the environment failed to work when installed in locations such as My Documents, Program Files etc.

Once unzipped, you must run the msys.bat file, found in <RootOfWhereTheEnvironmentWasInstalled>\msys_x2\1.0. You can create a shortcut to desktop for this file if you want. Once run, the environment will start up.

Important note: The latest development environment is by default configured for building the 64-bit version of the game, but it contains all files necessary for building the 32-bit flavor as well. To switch to the 32-bit version of the compiler, you need to navigate to the folder Msys_x2/1.0 and rename the following folders like this:
1) Devlibs -> Devlibs64
2) Mingw -> Mingw64
3) Devlibs32 -> Devlibs
4) Mingw32 -> Mingw.
Reverse-rename to return to the 64-bit configuration. Never, ever mix 32-bit Devlibs with 64-bit Mingw or vice-versa. Expect build failure if you do so.

The rest of the steps are:

''1. Create our working directory:''
* <code> mkdir /d/myoolite </code> - to create a folder called myoolite under D:\. This is where we will check out the code.
*<code> cd /d/myoolite </code> - to enter our working directory.

''2. Check out the oolite code:''
* <code> git clone https://github.com/OoliteProject/oolite.git </code> - this will start copying the source code from the repository to your working dir. When finished, there will be a folder named oolite under the folder you performed the checkout. Next do a
* <code> cd oolite </code> to enter in the trunk folder, where the actual build will take place. Finally, execute this command to pull in all the binary dependencies needed for the full build (maybe you can take a coffee break here, this takes a while):
* <code> git submodule update --init </code>

''3. Build the source:''
* <code> make debug=no </code> - That's it! Go get a coffee while it builds, then come back and you will find two new folders under trunk: obj and oolite.app. obj contains the object files produced by the compiler and you don't need to worry too much about it. And of course you all know what oolite.app is.

''4. Profit:''
Double click the oolite.exe file that resides in your <code>D:\myoolite\trunk\oolite.app </code> folder. You should see the splash screen followed by the familiar rotating Cobra. Now you can go and improve your Elite rating and give us some feedback from your testing while you're at it.

If at any later time you would like to update to the code that will be current by then, all you need to do is start up MSYS, then
* <code> cd /d/myoolite/oolite </code>
* <code>git pull </code>
* <code>make debug=no </code>

Good luck!

=== Old Building Oolite from source ===
'''Updated on 09 January 2009 - (left here for reference, please use the instructions above).'''

'''Acknowledgments and thanks to Kaks for providing them:'''

'''Important note: It is recommended that all packages for Windows be installed in paths that do not contain spaces. The same recommendation applies for the Windows username of the account the build is performed from. There have been reports of MSYS/make problems in such cases.'''

# If you have an older version of GNUstep(GNUstep-base-1.11.1-gui-0.10.1-3 - from the wiki howto), uninstall it, then delete its root directory if it's still there(c:\GNUstep).
# Google & download the following 2 packages, and - this is important - install them in this sequence: http://ftpmain.gnustep.org/pub/gnustep/binaries/windows/gnustep-system-0.19.2-setup.exe, http://ftpmain.gnustep.org/pub/gnustep/binaries/windows/gnustep-core-0.19.2-setup.exe
# Google & download tortoiseSVN, install.
# You now need the dependencies files for Windows. Download Local_20090108.zip [ftp://ftp.alioth.net/oolite/Local_20090108.zip].
# Go to the Windows Start menu, navigate to and select ''Start>Programs>GNUstep>Shell''
# At the prompt :
## <code>mkdir /Local </code>
## <code>mkdir /Local/oolite </code>
## <code>mkdir /Local/oolite/trunk </code>. The first slash & the upper case L are very important!
# From windows, extract the directories inside Local_20090108.zip to <code>C:\GNUstep\Local </code>
# Still from windows go to <code>C:\GNUstep\Local\oolite\trunk </code>
# It's empty. Right click>SVN checkout. The repository is <code>svn://svn.berlios.de/oolite-linux/trunk </code>. Wait for it to finish.
# From inside the GNUstep shell
## <code>export PATH=$PATH:/Local/bin </code>
## <code>cd /Local/oolite/trunk </code>
## <code>make debug=no</code>
# We're now ready to launch the compiled oolite! From inside the GNUstep shell:
## <code>cd /Local/oolite/trunk </code>
## <code>openapp oolite.app </code>

''' The instructions below are valid only for versions prior to 1.70, only use them as an alternative if the updated ones fail for whatever reason.'''

# Download and install the necessary software
## Download and install svn for Windows: [http://subversion.tigris.org/project_packages.html#binary-packages]. Accept all defaults given by the installer.
## Download and install GNUstep for windows: [ftp://ftp.gnustep.org/pub/gnustep/binaries/windows/base-1.11.1-gui-0.10.1/GNUstep-base-1.11.1-gui-0.10.1-3.exe]. Accept all defaults given by the installer.
## Download the SDL files required to build Oolite: [http://prdownload.berlios.de/oolite-pc/Local.zip]
## Unzip this file to <code>c:\GNUstep\Local</code>
# Get the source and build it (note, the source comes from the oolite-linux project)
## Start the GNUstep command line (Start -> Programs -> GNUstep Development -> MSYS for GNUstep) and issue the following commands:
## <code>cd $GNUSTEP_LOCAL_ROOT</code>
## <code>export PATH=$PATH:$GNUSTEP_LOCAL_ROOT/bin</code>
## <code>mkdir oolite</code>
## <code>cd oolite</code>
## <code>svn checkout svn://svn.berlios.de/oolite-linux/trunk</code>
## <code>cd trunk</code>
## <code>make</code>
# To run the game in the build environment:
## Before running the first time: <code>cp $GNUSTEP_LOCAL_ROOT/bin/*.dll oolite.app</code>
## <code>openapp oolite.app</code>

Assuming you have installed one of Nic's releases as detailed above, you can easily keep updating the installation from the latest source. In the <code>$GNUSTEP_LOCAL_ROOT/oolite/trunk</code> directory, issue the commands:

# <code>export PATH=$PATH:$GNUSTEP_LOCAL_ROOT/bin</code>
# <code>svn up</code>
# <code>rm -rf oolite.app/Resources; make</code>

You only need to issue the export PATH command when you first start the command line. The rm -rf command before make is required because GNUstep for Windows cannot parse the XML plist file format, and the build fails when it tries to read one of these generated each time the build is performed. This failure is not important, and the process still works, but it is annoying.

Then use the following script to copy the new files over the existing installation:

<pre>
OA="/c/Program Files/Oolite/oolite.app"
cd $GNUSTEP_LOCAL_ROOT/oolite/trunk
if [ oolite.app/oolite.exe -nt "$OA/oolite.exe" ]; then
echo "Updating oolite.exe"
cp oolite.app/oolite.exe "$OA/oolite.exe"
fi

for a in AIs Config Images Models Music Sounds Textures; do
for b in Resources/$a/*; do
c=`basename $b`
if [ $b -nt "$OA/Contents/Resources/$a/$c" ]; then
echo "Updating with $b"
cp $b "$OA/Contents/Resources/$a/$c"
fi
done
done
</pre>

If you want to edit the source, Notepad++ has good Objective-C support and is free: [http://notepad-plus.sourceforge.net/]

Also see the Oolite-PC forum: [http://www.aegidian.org/bb/viewforum.php?f=8]

[[Category:Oolite]]

Developing Oolite

2015-03-24T10:06:14Z

Developing Oolite

2015-03-19T11:28:56Z

Day: Created page with "= Overview = This page intends to allow you to setup an environment to develop Oolite. = Versioning = == Creating a GitHub account == == Creating a branch on GitHub == ==..."

= Overview =

This page intends to allow you to setup an environment to develop Oolite.

= Versioning =

== Creating a GitHub account ==

== Creating a branch on GitHub ==

== Fetching your branch ==

=== On Windows ===

=== On Mac OSX ===

=== On Linux ===

= Documentation =

== Pre-requisites ==

=== On Windows ===

=== On Mac OSX ===

=== On Linux ===

== Generation ==

=== On Windows ===

=== On Mac OSX ===

=== On Linux ===

= Setting up your development environment =

== On Windows ==

== On Mac OSX ==

== On Linux ==

Oolite

2015-03-19T11:06:51Z

Day: Adding link to "Developing Oolite page"

{{Infobox CVG| title = Oolite
|image = [[File:oolite-logo3.png]]
|developer = [[Giles Williams]]|
|publisher = [http://oolite.org oolite.org]
|version = 1.76.1|
|released = May 27, 2012 |
operating_system = Mac OS X, Linux |
|platforms = Mac OS X Linux Microsoft Windows
}}

'''Oolite''' is an [[Elite]]-like space sim game, originally written for Mac OS X. Stable ports for *NIX and Windows (XP, 2000 and Vista only) exist, and ports are also available for SGI IRIX and FreeBSD on Intel architectures..

It was written by [[Giles Williams]] as response to the withdrawal of [[Elite:_The_New_Kind|Elite - The New Kind]] from the internet. Although inspired by the work of [[Christian Pinder]], following [[David Braben]] and [[Ian Bell]], the work is an independent interpretation and expansion of the original game.

Oolite is designed as a small game that is easy for users to pick up and expand upon. Almost every aspect of the game can be modified using simple, free graphics packages and text-editors.

The game and source-code are offered for free under a Creative Commons License. One of Giles' priorities for development was to separate the game engine from the game materials (graphics, models, AI, text-strings etc.)

== Game style ==

Oolite follows the original Elite rather than [[Frontier Elite 2]] or [[First Encounters|Frontier First Encounters]]. It is set in the [[classic Elite]] universe, with the features found in the classic Elite universe (systems and the descriptions of systems generated by an algorithm, rather than text that the author has written). Like classic Elite, there is a single planet per system - although the game allows authors of add-ons to add multiple planets to a star system. Like classic Elite, the flight model is non-[[Newtonian modelling|Newtonian]] - meaning the spacecraft handles like an "aeroplane in space". However, this can be thought of as a complex flight computer helping the pilot as the game engine itself allows for real-world physics, for example, during collisions. This can lead to some interesting flight characteristics when the player survives a collision (especially with a [[Hognose|Hognose Tugship]]).

See the [[Oolite Instruction Manual]] for more information.

== Expandability ==

The game can be expanded in a number of ways with an [[OXP]] (Oolite eXpansion Pack). This takes the form of a directory with the extension 'oxp' that is placed in the AddOns folder. When Oolite is launched, it scans this folder for OXPs, and loads them. An OXP can contain new ships with custom AI and textures as well as new missions. Some notable OXPs have been to replace the space stations in Tech Level 13+ planets with a "2001-style" [[Torus station]], and the [[Tionisla Orbital Graveyard]] from the novella, [[The Dark Wheel]].
* [[OXP howto|How to make OXPs]]

== Portability to other operating systems ==

The game was originally written to use OpenGL and Cocoa (the Mac OS X toolkit) in Objective C. In April [http://en.wikipedia.org/wiki/2005 2005] a porting project was started by [[David Taylor]] and [[Dylan Smith]]. The port uses OpenGL and the GNUstep Objective-C library. The first stable version was 1.52, released on 24th September 2005. Substantial parts of the graphics output were changed to use SDL (Simple Directmedia Layer), a cross platform game library. This is portable to any Unix-like operating system that supports OpenGL and GNUstep, including back to Mac OS X as a Cocoa/SDL application. The game has been run on the PowerPC, Intel x86, AMD 64 and MIPS processor achitectures.

== Getting and installing Oolite ==

The following articles contain detailed information about where to get and how to run the game. There is also an additional section in these pages on how to build from source for those who are inclined to explore the technicalities of the game.

* [[Running Oolite-Mac]]
* [[Running Oolite-Linux]]
* [[Running Oolite-Windows]]
* [[Running Oolite-Unix|Running Oolite IRIX or BSD]]

== Developing Oolite ==

The following article contains information about what to do to get started on Oolite development:

[[Developing Oolite]]

== External links ==

*[http://oolite.org/ Oolite web site]
*[http://aegidian.org/bb Oolite Bulletin board]

[[Category:Oolite| Oolite]]
[[Category:Factual]]