FreeSpace Wiki - User contributions [en]

Talk:Guide to FS Open on Linux

2007-02-03T01:50:42Z

Nodens:

The correct title of this article is fs2_open on Linux. The initial letter is capitalized and an _ is substituted or omitted due to the Wiki's technical restrictions.

== CVS Checkout ==

Should we really be pointing newbs (like me) to the unstable branch? --[[User:Moniter|Mars]] 21:13, 13 September 2006 (BST)

Right. I did not find the stable tarball when I searched for it, though. Maybe we could add a part about how to get the stable source. The compilation stuff stay the same, anyway. However, the "unstable" branch is not that unstable from what I've seen so far. --[[User:Nodens|nodens]] 23:13, 13 September 2006 (BST)

I tried to compile it several times today, but there were many uncompilable errors. Was fixed later today though --[[User:Moniter|Mars]] 02:05, 14 September 2006 (BST)

Check [[http://www.hard-light.net/forums/index.php/topic,45032.0.html this thread]] for some more discussion about this page. Also, please, don't be shy and correct any wording / spelling / grammar / anything mistake you might find. English is not necessarily the native language of the contributors :) --[[User:Nodens|nodens]] 19:47, 2 February 2007 (CST)

Talk:Guide to FS Open on Linux

2007-02-03T01:48:31Z

Nodens:

The correct title of this article is fs2_open on Linux. The initial letter is capitalized and an _ is substituted or omitted due to the Wiki's technical restrictions.

== CVS Checkout ==

Should we really be pointing newbs (like me) to the unstable branch? --[[User:Moniter|Mars]] 21:13, 13 September 2006 (BST)

Right. I did not find the stable tarball when I searched for it, though. Maybe we could add a part about how to get the stable source. The compilation stuff stay the same, anyway. However, the "unstable" branch is not that unstable from what I've seen so far. --[[User:Nodens|nodens]] 23:13, 13 September 2006 (BST)

I tried to compile it several times today, but there were many uncompilable errors. Was fixed later today though --[[User:Moniter|Mars]] 02:05, 14 September 2006 (BST)

Check this [[http://www.hard-light.net/forums/index.php/topic,45032.0.html|thread]] for some more discussion about this page. Also, please, don't be shy and correct any wording / spelling / grammar / anything mistake you might find. English is not necessarily the native language of the contributors :) --[[User:Nodens|nodens]] 19:47, 2 February 2007 (CST)

Talk:Guide to FS Open on Linux

2007-02-03T01:47:26Z

Nodens: /* CVS Checkout */

The correct title of this article is fs2_open on Linux. The initial letter is capitalized and an _ is substituted or omitted due to the Wiki's technical restrictions.

== CVS Checkout ==

Should we really be pointing newbs (like me) to the unstable branch? --[[User:Moniter|Mars]] 21:13, 13 September 2006 (BST)

Right. I did not find the stable tarball when I searched for it, though. Maybe we could add a part about how to get the stable source. The compilation stuff stay the same, anyway. However, the "unstable" branch is not that unstable from what I've seen so far. --[[User:Nodens|nodens]] 23:13, 13 September 2006 (BST)

I tried to compile it several times today, but there were many uncompilable errors. Was fixed later today though --[[User:Moniter|Mars]] 02:05, 14 September 2006 (BST)

See [[http://www.hard-light.net/forums/index.php/topic,45032.0.html|this thread]] for some more discussion on this page. Also, please, don't be shy and correct any wording / spelling / grammar / anything mistake you might find. English is not necessarily the native language of the contributors :) --[[User:Nodens|nodens]] 19:47, 2 February 2007 (CST)

Guide to FS Open on Linux

2007-02-03T01:43:04Z

Nodens: wording / typo

''This tutorial assumes some fundamental command line knowledge. ''
''As a rule of thumb, do not copy/paste commands without understanding them, especially as root. With great power comes great responsibility.''

'''Introduction :'''

This page will guide you through compilation and installation of FS2_open, using the CVS code, along with the data files.
Please note that if you don't manage to build the CVS (or don't want to), binaries will be found on this thread (no 3.6.9 linux binary yet as of this writing, but they should arrive soon). You'll need probably need to read on anyway (how to get data files, starting the games, dealing with i18n issues...), but ignore what's related to building your own binary.

If you don't want to use CVS, but can't find a suitable binary, you can download an almost current (3.6.9-RC8) source release here :
http://fs2source.warpcore.org/exes/linux/fs2_open-3.6.9-RC8.tar.bz2

Also, Turey wrote a cross-platform installer (in java), able to download all you need for running FS2_Open except the binary (retail files, MediaVP, movies...). It can be found here : [[http://www.hard-light.net/forums/index.php/topic,42854.0.html Freespace Open Installer]]. It's far more easier than extracting the data files from the retail CDs (see below).
// ''Linux binaries will be put into the Installer once taylor posts linux binaries 3.6.9 Final''

There is even work in progress on a linux launcher that you may want to try : [[http://www.hard-light.net/forums/index.php/topic,44204.0.html Linux launcher]] (this is different from the upcoming new launcher which will be used in 3.7 fs2_open release) // ''The links in the thread are currently dead, but let's hope that will be resolved soon.''

----

== Installing CVS ==
CVS stands for Concurrent Versions System and is a version control system used to record the changes in documents, such as source files. Developers use CVS so they can easily share their code changes among other developers.
Be aware that when you use CVS, you use the most up-to-date code : It may or may not be better than a release. It may be worse, less stable, or not even compile. This is work in progress.

You will need this tool to download ("checkout" in CVS terminology) fs2_open from the CVS server.

'''Debian/Ubuntu''' users want to:
$ apt-get install cvs
'''Gentoo''' users want to:
$ emerge cvs
'''Novell SuSE''' users install CVS via YaST.

'''Archlinux''' users want to:
$ pacman -Sy cvs

'''NOTE: Redhat, Mandrake/Mandriva, Slackware and all the other distros should go here too,'''
'''but we have no knowledge on how these work, so if you do, please enlighten us.'''

== Installing the necessary development libraries ==
You will also need SDL, OpenAL, libvorbis, libtheora and OpenGL(most likely provided with your video card driver) development packages. And of course the GCC compiler and required make tools.
 
'''Debian/Ubuntu''' users want to:
$ apt-get install libopenal-dev libvorbis-dev build-essential automake1.9 autoconf libsdl-dev libtheora-dev
'''NOTE:''' The ''build-essential'' meta package installs GCC4. This should work, but if you feel safer with GCC 3.4(gcc-3.4), add it to the apt-get line above. 

''Note : on other distributions, you'll need theora as well, so the information for Gentoo and SuSe below is outdated. if someone knows the exact package name, please edit !'' 

'''Gentoo''' users want to:
$ emerge openal libvorbis libsdl
'''Novell SuSE''' users just install the mentioned packages and the devel-packages via YaST. If this works don't read further.
SuSE maybe has some dependency problems with the game TORCS, i.e. its special version of OpenAL, so you have to make a choice. If you still want to run FS2 open, go on here http://www.hard-light.net/wiki/index.php/Fs2_open_on_Linux#Compile_Errors

'''Archlinux''' users want to:
$ pacman -S freealut libvorbis sdl

'''NOTE: Redhat, Mandrake,Slackware and all the other distros should go here too,'''
'''but we have no knowlage on how these work, so if you do, please enlighten us.'''

== Installing game data files ==

This tutorial deals primarily with providing you with an executable, but in order to play the game you also need the game data. Freespace 2 game data is available from a number of sources, see this thread: http://www.hard-light.net/forums/index.php/topic,38195.0.html (or use Turey's installer, see above for a link)

Note that if you use the retail CD, you'll need to extract the files and to copy them on your drive, reproducing the same layout as in a working win32 installation (just make sure every file is lowercase). This thread on the SCP forum has some more info on it : http://scp.indiegames.us/forum_viewtopic.php?3.282

There are two ways of doing this :
* use wine to install the game in the right directory, using the Setup.exe found on the first CD, or
* extract manually the files from the cd.

The second method is detailed below. The wine one is straightforward and you shouldn't need any specific instruction, but you'll have to fix permissions and lowercase the filename as well, so keep reading.

===Extracting data from CD===
====Installing unshield====

First, you need unshield from http://synce.sourceforge.net/synce/unshield.php

If you use debian, apt-get install unshield as root should do the trick. Else, try to find a package for your distribution, or if you don't, compile it yourself following the instructions provided on the website. Note you don't need to actually install it, just compile it and use it from the directory where you compiled it.

====Preparing directories====

* Create a directory for fs2_open, say, ''/usr/local/games/fs2_open'', with a ''data/movies'' and ''data/players'' subdirectories. Everything but user files and configuration will be in this directory. You'll probably need to be root or use sudo for most of the following commands if you use a global directory like the one in this example.

''Warning : Again, please double check the commands you run as root. A single typo could destroy your data. 'Remember what is said on the top of the page ? if not, go re-read it.''

<tt>~ $ mkdir -p /usr/local/games/fs2_open/data/movies /usr/local/games/fs2_open/data/players</tt>

====Extracting files====

* Use unshield to extract the groups from data1.cab (on the first cd) to a temporary directory; then move the files in your game directory :
<tt>~ $ mkdir /tmp/fs2
~ $ for group in "Basic Install Files" "Intel Anims" "Music Compressed" "High Res Files"; do unshield -d /tmp/fs2/ -g "$group" -L -j x /mnt/cdrom/data1.cab; done; mv -v /tmp/fs2/*/* /home/data/jeux/fs2_open
~ $ unshield -d /tmp/fs2/ -g "Hud Config Files" -L -j x /mnt/cdrom/data1.cab && mv -v /tmp/fs2/hud_config_files/* /usr/local/games/fs2_open/data/players</tt>
* From '''both''' the second and third CDs, get the vp files and the movies files (I don't think the the .mve file are really needed; you'll need the .avi ones if you want the movies).
<tt>~ $ cp -vf *.vp /usr/local/games/fs2_open
~ $ cp -vf *.MVE /usr/local/games/fs2_open/data/movies/</tt>

You may notice that some files are on all three CD; this is because the game was meant to be run with the CD in the drive. Don't worry, a copy of such a file from any of the 3 CDs will work.

=== Fixing Case and permissions ===
* You '''have''' to make sure everything is lowercase :
<tt>~ $ for file in `find /usr/local/games/fs2_open/`; do mv $file `echo $file | sed 's/$[A-Z]$/\l\1/g'`; done</tt>

* Then, fix permissions :
<tt>~ $ find /usr/local/games/fs2_open -type d -exec chmod a+rx '{}' \;
~ $ find /usr/local/games/fs2_open -type f -exec chmod a+r '{}' \;</tt>

== Using the source ==

=== CVS Checkout ===
Before you begin, make sure you have write permissions on your current working directory. Your /home/user/ directory is a pretty sure bet. I recommend that you create a permanent /home/user/src directory from which you run the CVS command, this way CVS will only update the files changed the next time you download the source and it's always nice to have things organized.

Now get the source. Run from a terminal:
$ cvs -d:pserver:anonymous:anonymous@warpcore.org:/home/fs2source/cvsroot login
and then
$ cvs -z3 -d:pserver:anonymous@warpcore.org:/home/fs2source/cvsroot co fs2_open
The first cvs command tells the CVS tool to first use a password file for authentication (pserver), that you are user "anonymous" with the password "anonymous" who wants to access warpcore.org's CVS repository "/home/fs2source/cvsroot" and login. The second command tells the CVS server on which we are now connected to that we want to checkout (co) the fs2_open module.
 
==== Simple Checkout Script ====
You can use this script to simplify your checkouts, don't forget to chmod +x it.
#!/bin/bash
CVS="cvs -d:pserver:anonymous:anonymous@warpcore.org:/home/fs2source/cvsroot"
MODULE="fs2_open"
BRANCH="fs2_open_3_6_9"

${CVS} co -r ${BRANCH} ${MODULE}

=== Pre-Compile Configuration ===

Before you compile you need to configure it for your system. In the directory you ran the CVS command from, a new directory has appear, namely fs2_open.
If your fs2_open is a completely new checkout, you will first need to run the autogen.sh script.
Run from inside your newly created fs2_open directory:
$ ./autogen.sh
autogen.sh is a script that will generate the required makefiles. You will see alot of "checking for this" and "checking for that", this is actually the "configure" script (which can be run with <tt>./configure</tt> if you need to change the options) examining and configuring fs2_open for your system. 
It is possible to give autogen.sh configure options as well, autogen.sh will pass them along to configure.

A full list of configure options can be found by running the configure script with the '--help' option.
$ ./configure --help

==== Optimizing fs2_open ====
Optimizing fs2_open might have little or no effect, or improve performance greatly, I honestly have no clue. 
A note of caution, if you are compiling a debug build, don't use the -fomit-frame-pointer CFLAG, it will make debugging impossible. 
You can specify your compiler flags with the configure script, se below.
$ ./configure CFLAGS="<your desired flags>"
If you got a Athlon-XP and want to play it safe, a good set of CFLAGS would be
$ ./configure CFLAGS="-march=athlon-xp -O3 -pipe -fomit-frame-pointer"
You should read up on CFLAGS and what they do before trying anything. I recommend you read through these links. 
http://gcc.gnu.org/onlinedocs/gcc-3.4.1/gcc/Optimize-Options.html 
http://linuxreviews.org/howtos/compiling/safe-cflags/ 
http://en.wikipedia.org/wiki/CFLAGS

=== Compiling ===

Run from within your fs2_open directory:
$ make
Sit back and enjoy gcc work its magic.

==== Simple Compile Script ====
It's a lot easier to use a scripts when dealing with constantly changing code. Copy and save this to a suitably named file like "compile-fs2_open", and make it executable with the command, chmod +x <name of file>
#!/bin/bash
# MY_CFLAGS="-march=athlon-xp -O2 -pipe -fomit-frame-pointer -falign-functions=64"
# MY_CXXFLAGS="${CFLAGS} -fvisibility-inlines-hidden"
# MY_LDFLAGS="-Wl,-O1 -Wl,--sort-common -Wl,--as-needed -s"
if [ -e ./${*} ]; then
cd ${*}
if [ -e ./Makefile.in ]; then
make clean
./configure CFLAGS="${MY_CFLAGS}" CXXFLAGS="${MY_CFLAGS}" LDFLAGS="${MY_LDFLAGS}"
make
else
./autogen.sh CFLAGS="${MY_CFLAGS}" CXXFLAGS="${MY_CFLAGS}" LDFLAGS="${MY_LDFLAGS}"
make
fi
fi
You can add your options to the ./configure line. You need to give the script the fs2_open source directory, like this:
$ ./compile-fs2_open fs2_open
This makes it easier to deal with multiple source directories.

== Using the Binaries ==

When the compile is done and if all went well, a binary executable will reside in the code directory ''fs2_open_r'' or ''fs2_open_d'' if you configured for a debug build. Copy the binary to directory where Freespace2 is installed, and you're all set to go.

=== Post-Compile Configuration ===
==== Changing Your Resolution ====
Odds are, you'll want to run fs2_open in a higher resolution than the default 640x480. Unfortunately, we Linux users don't have the swank launcher app that the Windows folks do. Instead, we'll be making a couple line changes to a config file. You will need to run fs2_open once before you can make the necessary changes, otherwise you won't have a configuration directory to work with.

Open up ~/.fs2_open/fs2_open.ini with the text editor of your choice (vi, EMACS, kwrite, gedit). You'll see something like the following:
[Default]
VideocardFs2open=OGL -(640x480)x16 bit
LastPlayer=MonkeyboyS
GammaD3D=1.0

To set fs2_open to use the highest setting possible on retail Freespace 2, change the VideocardFs2open to:
VideocardFs2open=OGL -(1024x768)x32 bit
You can set this to pretty much anything you want.

=== Creating a Start Up Script ===

In order to use all of the advanced engine features of fs2_open, you'll need to start the executable with a number of command line arguments. Instead of typing them in every time you want to start the game, why not create a script that does it for you?

Create a new file named start_freespace (or whatever you like) in your home directory. Open the file in your editor of choice, and paste the following:
#!/bin/bash
cd /path/to/your/freespace/
./fs2_open_r -spec -glow -mipmap -jpgtga -orbradar -mod Media_VP

''Note: You will need to edit this script before it will work properly. The second line must point to the directory where you installed fs2_open. You can also find a more elaborated script example below in the i18n section''

The last line starts fs2_open with a number of arguments that turn on extra features. In the example, the game will use specular highlights, glow-mapping, mipmapping, jpg and tga graphic files, the orb radar, and any MediaVPs installed to the /Media_VP directory. You should edit this line to use those features that your system supports.

More information about the available Command Line Arguments can be found at the [[Command-Line Reference]]

Once you've edited the file to your heart's content, make it executable:
$ chmod +x start_freespace

You can now type in start_freespace to start the game, or by clicking on start_freespace in your window manager. For convenience, you can copy it to your Desktop.

[http://www.hard-light.net/wiki/index.php/Command-Line_Reference See this] for more command line options.

==== Advanced Startup Script ====
This is nothing fancy, but it's all the command line options in a file.
#!/bin/bash
# Graphics
CMDLINE="-spec -env -glow -jpgtga -mipmap -2d_poof -missile_lighting"
CMDLINE="$CMDLINE -ambient_factor 75 -spec_exp 11 -spec_point 0.6"
CMDLINE="$CMDLINE -spec_static 0.8 -spec_tube 0.4"
#CMDLINE="$CMDLINE -pcx32 -cell -nomotiondebris -noscalevid -rlm -clipdist"
# Game Speed
CMDLINE="$CMDLINE -cache_bitmaps"
#CMDLINE=$CMDLINE -img2dds -no_vsync"
# HUD
CMDLINE="$CMDLINE -targetinfo -orbradar -ballistic_gauge -rearm_timer"
#CMDLINE="$CMDLINE -dualscanlines"
# Gameplay
CMDLINE="$CMDLINE -ship_choice_3d -3dwarp -warp_flash -fov 0.39"
#CMDLINE="$CMDLINE -UseNewAI -tbp -wcsaga"
# Audio
CMDLINE="$CMDLINE -snd_preload"
#CMDLINE="$CMDLINE -nosound -nomusic"
# Multiplayer
#CMDLINE="$CMDLINE -standalone -startgame -closed -restricted"
#CMDLINE="$CMDLINE -multilog -clientdamage -mpnoreturn"
# Troubleshooting
#CMDLINE="$CMDLINE -oldfire -nohtl -no_set_gamma -nomovies -noparseerrors"
#CMDLINE="$CMDLINE -safeloading -query_speech -d3d_bad_tsys -novbo -noibx -loadallweps"
# Experimental
CMDLINE="$CMDLINE -alpha_env"
#CMDLINE="$CMDLINE -decals -ingame_join"
# Development Tools
CMDLINE="$CMDLINE -fps"
#CMDLINE="$CMDLINE -pos -window -timerbar -coords -pofspew -tablecrcs -missioncrcs"
#CMDLINE="$CMDLINE -dis_collisions -dis_weapons -output_sexps"
#CMDLINE="$CMDLINE -output_scripting -nograb -show_mem_usage -stats"
# Mod
CMDLINE="$CMDLINE -mod mv368zeta"
./fs2_open_r $CMDLINE

== Troubleshooting ==
=== Compile Errors ===
==== Novell SuSE and the dependencies ====

If your SuSE gives you some errors like this, during the compile process, your OpenAL version is too old or corrupted.
sound/ds.cpp: In function 'int ds_init(int, int, unsigned int, short unsigned int)':
sound/ds.cpp:1790: error: invalid conversion from 'const char*' to 'const ALubyte*'
sound/ds.cpp:1790: error: initializing argument 1 of 'ALboolean alIsExtensionPresent(const ALubyte*)'
You have to remove all OpenAL-packages via YaST, you may also want to remove TORCS, too, it won't run anymore after this.
Unfortunately there is no repository with a newer version for this distro, yet, so you have to use a source-package for Fedora. You get it here http://download.fedora.redhat.com/pub/fedora/linux/extras/5/SRPMS/openal-0.0.9-0.6.20060204cvs.fc5.src.rpm
The version may change, so you better check this.
Now make sure, that TexInfo is installed. Then enter:
$ rpmbuild --rebuild --target=i686 <name-of-your-package>.fc5.src.rpm
If it builds without errors, you will find an OpenAL*.rpm and an OpenAL*-devel.rpm in <tt>/usr/src/packages/RPMS/i686/</tt>. Install both and go back to your fs_open directory again. Cause the environment has changed now, you better type:
$ make clean
$ ./configure [options]
$ make
Then you're done.

==== SDL: undefined reference to... ====

This is a SDL installing issue, since it's trying to link against the static lib and not the dynamic one.
First check where <tt>/usr/lib/libSDL.so</tt> is linked to, then search this very file.
$ ls -l /usr/lib/libSDL.so
lrwxrwxrwx 1 root root 28 2006-09-06 00:10 /usr/lib/libSDL.so -> /usr/lib/libSDL-1.2.so.0.7.1
$ ls /usr/lib/ | grep libSDL-1.2.so.0.7
libSDL-1.2.so.0.7.2
If they are not the same (like in this case), you just make a new link. Type as root:
# ln -s /usr/lib/libSDL-1.2.so.0.7.2 /usr/lib/libSDL.so
Of course you must change some figures, so it matches on your system.

==== Missing -lGLU compile error ====

On some Linux distributions (''Slackware'' for instance), compiling fails because a GL related library doesn't have a link in the <tt>/usr/lib</tt> directory. If the compile fails because it can't find <tt>-lGLU</tt>, here are two ways to fix it:

===== Solution as Root =====

If you have root access to the system, you can create a link to the library in question with just a little bit of command line magic. Go to a console and enter:

$ ln -s /usr/X11R6/lib/libGLU.so /usr/lib/libGLU.so

After that, you can run make again and it should finish compiling.

===== Solution as a Non-Root user =====

You don't have root access? Never fear, we can still fix the problem. It'll just be a tad more difficult.

Navigate to the <tt>fs2_open/code</tt> directory and locate a file named <tt>Makefile</tt> (not Makefile.rm or Makefile.in or Makefile.anything). Open it in your favorite text editor and make the following changes.

Find this line (line 457 in mine):
FS2_LDFLAGS = -L/usr/lib -Wl,-rpath,/usr/lib -lSDL -lpthread -lGL -lGLU -lopenal -logg -lvorbis -lvorbisfile

And replace it with this:
FS2_LDFLAGS = -L/usr/lib -Wl,-rpath,/usr/lib -lSDL -lpthread -lGL -lopenal -logg -lvorbis -lvorbisfile -L/usr/X11R6/lib -lGLU

Also find this one (line 565 in mine):
AM_LDFLAGS = -g -L/usr/lib -Wl,-rpath,/usr/lib -lSDL -lpthread -lGL -lGLU -lopenal -logg -lvorbis -lvorbisfile

And replace it with this:
AM_LDFLAGS = -g -L/usr/lib -Wl,-rpath,/usr/lib -lSDL -lpthread -lGL -lopenal -logg -lvorbis -lvorbisfile -L/usr/X11R6/lib -lGLU

Then run <tt>make</tt> from the <tt>fs2_open</tt> directory, and watch the magic happen.

==== glBindBufferARB feature missing ====
''If this is the actual solution to this problem remains to be seen.'' 
''So far, only people using Debian stable are affected by this.'' 
''So we need adventurus Debian users to confirm.'' 
''I can confirm that the APT-Pinning works, can not confirm compile thou. -- ni1s'' 
checking for glBindBufferARB in -lGL... no
configure: error: *** OpenGL version does not have the required features!! (ie.glBindBufferARB()) ***
This error appears if the installed Mesa development library is to old.

On Debian stable branch the xlibmesa-gl-dev package holds version 4.3.0. 
The xlibmesa-gl-dev package on ''testning'' is version 6.9.0.

'''Possible solution:''' 
First set /etc/apt/sources.list to include the testing branch. Add:
#Testing
deb http://ftp.us.debian.org/debian testing main non-free contrib
deb http://non-us.debian.org/debian-non-US testing/non-US main contrib non-free
Your sources.list might have these lines already, if so, you should be okej.

Your /etc/apt/preferences file should look like this
Package: *
Pin: release a=stable
Pin-Priority: 700

Package: *
Pin: release a=testing
Pin-Priority: 650

Package: *
Pin: release a=unstable
Pin-Priority: 600

Add to that file:
Package: xlibmesa-gl-dev
Pin: release a=testing
Pin-Priority: 800
Note that the Pin-Priority of xlibmesa-gl-dev here is higher than the Pin-Priority on 'stable'. As a result of this APT get will prioritize the xlibmesa-gl-dev from testing and leave the rest of the system on stable.
This is called apt-pinning.

Now that APT knows what xlibmesa-gl-dev to prioritze, install it again:
$ apt-get install xlibmesa-gl-dev

If you are using nVidia's nvidia-kernel and glx packages, a simple:
$ apt-get install nvidia-glx-dev
should suffice. No need to mess around with APT-pinning.

=== Runtime Errors and common problems ===
==== ERROR: "Web cursor bitmap not found." ====
ERROR: "Web cursor bitmap not found. This usually means that the executable is being run outside the directory
you installed Freespace2 to. Please move the executable to that directory and try again" at graphics/2d.cpp:1402
A common error. This happens when fs2_open can't find the .vp files or that your user doesn't have the permissions to access them. If you are using a start up script([http://www.hard-light.net/wiki/index.php/Fs2_open_on_Linux#Creating_a_Start_Up_Script like the one found here]) it's most likly the a permission problem.
Have your user take owenership of the .vp files, run as root:
$ chown <user> /path/to/vpfiles/ -R

=== I18n and Key mapping problems ===
''Me, being a Swede, need to use this aswell, especially for the grave key(`), but I also want to use a second X display. There is a way to tell xmodmap to use the new set of keys on the second X display, and thus eliminating the need for a temp. keymap table as it dies with the second display when exiting fs2_open, never touching the keymap table on display 0. We should dig that info up and write a super-start script. --ni1s'' 
Ok, imagine that like me you don't have an us keyboard but a french one (or anything). Well, you probably have problems mapping some keys or even using the default mapping.

Actually, the problem is fs2_open does not take modifiers into account, as it uses them internally as modifiers for keys, and it won't accept non-us charset either.

On a french keyboard layout, the numbers ''1 2 3 4 5 6 7 8 9 0'' are on the same keys than on a US layout, but you have to press shift to use them. The primary function for theses keys are ''& Ã© " ' ( - Ã¨ _ Ã§ Ã )''. These characters won't be accepted by freespace, and if you press shift to get a number, it won't work. This can be a problem, as theses keys are needed to use the communication system, and cannot be bound to anything. Also, as you won't get access some keys on your keyboard, it will be difficult to map every command on a key, or you'll have to use modifiers for nearly each key.

However, there is a solution. You can tell X to remap the keyboard before launching the game, and restore your normal keymap afterwards.

For exemple, I map 123456790 to &é"'(-è_çà keys so I can use the communication system, and I put , and ; on the Alt-Gr and Menu keys for convenience, as I binded thoses keys to next primary weapon and next secondary weapon.

To do this, I use a slightly enhanced startup script, which I put in ~/bin (this directory is in my path), together with a customized xmodmap.

* First, dump your current xmodmap :

<tt>~ $ xmodmap -pke > ~/xmodmap.current</tt>

* Then edit it with your favorite text editor. You'll see a bunch of lines looking like this :

<tt>
keycode 8 =
keycode 9 = Escape
keycode 10 = 1 ampersand onesuperior exclamdown onesuperior exclamdown
</tt>

The syntax is ''keycode <number> = <symbol list>''.

Use '''xev''' to scan the keycodes. The symbols are defined in ''/usr/include/X11/keysymdef.h''. Just make sure you write them without the ''XK_'' prefix. You'll find more information about xmodmap in the xmodmap manual page.

Just modify the keys you need, and be patient. This can be a long process. Test it with xmodmap :

<tt>~ $ xmodmap - < <filename></tt>

But don't forget to have your previous keymap at hand to recover your settings !
If you mess everything up, just restart X. Your default keymap will be applied from the X configuration.

Here is my own fs2 xmodmap, derived from fr-latin1 as described above. Feel free to use it if you're too lazy to modify your own. However, it may not fit with your needs. You may always use it as an exemple, thougt.
* http://clement.hermann.free.fr/fs2/xmodmap

Then, when the file is modified at your liking, just save it as '''~/.fs2_open/xmodmap'''

We'll start fs2_open with a slightly more elaborate startup script which will backup/apply/restore the keymap in addition of running the games with some options in the right directory.

<tt>
#!/bin/sh
# This script lauches fs2. If there is a file named $FS2_modmap (see below),
# backup the current modmap as $TMP_modmap and load it as the new modmap.
# The current modmap will be restored afterwards.

TMP_modmap="$HOME/xmodmap.tmp"
FS2_modmap="$HOME/.fs2_open/xmodmap"

FS2_OPEN_DIR=/usr/local/games/fs2_open

FS2_ARGS="-glow -spec -spec_exp 11 -spec_point 0.6 -spec_static 0.8 -spec_tube 0.4 -fps -jpgtga -ambient_factor 75 -targetinfo -nograb"

FS2_BIN="$FS2_OPEN_DIR/fs2_open_r"

die() {
echo "** Fatal error : $1" >&2
exit 1
}

cd $FS2_OPEN_DIR || die "Could not change directory to $FS2_OPEN_DIR"

# dump current xmodmap
[ -f "$FS2_modmap" ] && xmodmap -pke > $TMP_modmap

# load xmodmap
[ -f "$FS2_modmap" ] && xmodmap - < $FS2_modmap

# prepare to restore xmodmap on crash or exit
trap "xmodmap - < $TMP_modmap && rm $TMP_modmap" 0 2 3 4 9 11 15

# launch fs2
$FS2_BIN $FS2_ARGS $* || die "Error while running \"$FS2_BIN\" with arguments \"$FS2_ARGS\" ($?)"
</tt>

Adapt this script to your needs, and save it somewhere in your PATH - I for exemple use ''~/bin/freespace2''. Make it executable with chmod +x ''<file>''

That's it, now you can use fs2 with full control over your keyboard.

=== fs2_open dedicated X display ===
A good way of running games on Linux is having them run on a separate X display. The display you are most likely using now when reading this is 0:0. This display is normally used for whatever Window Manager/Desktop Environment(KDE,Gnome,*box,E) you've chosen. Sometimes fs2_open freezes and locks your X. This is of course very annoying as you have to CTRL+ALT+BACKSPACE to kill the X server, and in that, killing whatever program you had running besides fs2_open. The solution to this is to tell X to start fs2_open on another display. To to this we first need to tell X that you,the user on localhost, holds the permission to run on another display.
In a terminal, enter (NOT as root):
$ xauth list
A list that looks something like this should appear.
myuser@localhost ~ $ xauth list
localhost/unix:'''0''' MIT-MAGIC-COOKIE-1 14ec70e7c8cc835def61a04c92bbd50d
Let's look at that line, first up is your localhost, then unix, and last the display number,:0 (in bold). The rest is not really of interest.
Copy the whole line, but change the display value to 1 and paste it after the command ''xauth add'', like this:
$ xauth add localhost/unix:'''1''' MIT-MAGIC-COOKIE-1 14ec70e7c8cc835def61a04c92bbd50d
Run xauth list again. You should see a new entry.
myuser@localhost ~ $ xauth list
localhost/unix:'''0''' MIT-MAGIC-COOKIE-1 14ec70e7c8cc835def61a04c92bbd50d
localhost/unix:'''1''' MIT-MAGIC-COOKIE-1 14ec70e7c8cc835def61a04c92bbd50d
You now have permission to use display 1:0.
To start fs2_open in that display, use xinit.
$ xinit /path/to/fs2_open_r -foo -bar -- :1
The ''-- :1'' tells X that we want to start fs2_open on display 1. 
You can switch between display 0 and 1 with CTRL+ALT+F7 and CTRL+ALT+F8 respectively.

If you try this from an xterm (or a similar X terminal program) and obtain the error ''X: user not authorized to run the X server, aborting.'', the reason might be the file /etc/X11/Xwrapper.config. On my ubuntu machine, it contains the line

allowed_users=console

which means that only users logged in from a console terminal may start a new X server. However, on an xterm, you are on a '''virtual''' terminal and so the above does not work. A possibility is to change the allowed_users in the Xwrapper.config file to "anybody" (see man Xwrapper.config). However, this undermines X security. Another possibility is to start the xinit command from a console window (to which you can change with CTRL+ALT+F1-6).

''If someone knows of a good method to start fs2 on a second X display from an xterm without changing Xwrapper.config, please report it here.''

''A solution might be running xinit as root with sudo, and drop the root privileges in the startup script... Didn't tried, though.'' -- nodens

''xgame / xgame-gtk2 may be of use to achieve this as normal user, see http://xgame.tlhiv.org/ '' -- Lone_Wolf

[[Category:Source Code Project]]

Guide to FS Open on Linux

2007-02-02T22:41:18Z

Nodens: wording

''This tutorial assumes some fundamental command line knowledge. ''
''As a rule of thumb, do not copy/paste commands without understanding them, especially as root. With great power comes great responsability.''

'''Introduction :'''

This page will guide you through compilation and installation of FS2_open, using the CVS code, along with the data files.
Please note that if you don't manage to build the CVS (or don't want to), binaries my be found on this thread (no 3.6.9 linux binary as of this writing). You'll need probably need to read on anyway (how to get data files, starting the games, dealing with i18n issues...), but ignore what's related to building your own binary.

If you don't want to use CVS, but can't find a suitable binary, you can download an almost current (3.6.9-RC8) source release here :
http://fs2source.warpcore.org/exes/linux/fs2_open-3.6.9-RC8.tar.bz2

Also, Turey wrote a cross-platform installer (in java), able to download all you need for running FS2_Open except the binary (retail files, MediaVP, movies...). It can be found here : [[http://www.hard-light.net/forums/index.php/topic,42854.0.html|Freespace Open Installer]]. It's far more easier than extracting the data files from the retail CDs (see below).

There is even work in progress on a linux launcher that you may want to try : [[http://www.hard-light.net/forums/index.php/topic,44204.0.html|Linux launcher]] (this is different from the upcoming new launcher which will be used in 3.7 fs2_open release) // ''The links in the thread are currently dead, but let's hope that will be resolved soon.''

----

== Installing CVS ==
CVS stands for Concurrent Versions System and is a version control system used to record the changes in documents, such as source files. Developers use CVS so they can easily share their code changes among other developers.
Be aware that when you use CVS, you use the most up-to-date code : It may or may not be better than a release. It may be worse, less stable, or not even compile. This is work in progress.

You will need this tool to download ("checkout" in CVS terminology) fs2_open from the CVS server.

'''Debian/Ubuntu''' users want to:
$ apt-get install cvs
'''Gentoo''' users want to:
$ emerge cvs
'''Novell SuSE''' users install CVS via YaST.

'''Archlinux''' users want to:
$ pacman -Sy cvs

'''NOTE: Redhat, Mandrake/Mandriva, Slackware and all the other distros should go here too,'''
'''but we have no knowledge on how these work, so if you do, please enlighten us.'''

== Installing the necessary development libraries ==
You will also need SDL, OpenAL, libvorbis, libtheora and OpenGL(most likely provided with your video card driver) development packages. And of course the GCC compiler and required make tools.
 
'''Debian/Ubuntu''' users want to:
$ apt-get install libopenal-dev libvorbis-dev build-essential automake1.9 autoconf libsdl-dev libtheora-dev
'''NOTE:''' The ''build-essential'' meta package installs GCC4. This should work, but if you feel safer with GCC 3.4(gcc-3.4), add it to the apt-get line above. 

''Note : on other distributions, you'll need theora as well, so the information for Gentoo and SuSe below is outdated. if someone knows the exact package name, please edit !'' 

'''Gentoo''' users want to:
$ emerge openal libvorbis libsdl
'''Novell SuSE''' users just install the mentioned packages and the devel-packages via YaST. If this works don't read further.
SuSE maybe has some dependency problems with the game TORCS, i.e. its special version of OpenAL, so you have to make a choice. If you still want to run FS2 open, go on here http://www.hard-light.net/wiki/index.php/Fs2_open_on_Linux#Compile_Errors

'''Archlinux''' users want to:
$ pacman -S freealut libvorbis sdl

'''NOTE: Redhat, Mandrake,Slackware and all the other distros should go here too,'''
'''but we have no knowlage on how these work, so if you do, please enlighten us.'''

== Installing game data files ==

This tutorial deals primarily with providing you with an executable, but in order to play the game you also need the game data. Freespace 2 game data is available from a number of sources, see this thread: http://www.hard-light.net/forums/index.php/topic,38195.0.html (or use Turey's installer, see above for a link)

Note that if you use the retail CD, you'll need to extract the files and to copy them on your drive, reproducing the same layout as in a working win32 installation (just make sure every file is lowercase). This thread on the SCP forum has some more info on it : http://scp.indiegames.us/forum_viewtopic.php?3.282

There are two ways of doing this :
* use wine to install the game in the right directory, using the Setup.exe found on the first CD, or
* extract manually the files from the cd.

The second method is detailed below. The wine one is straightforward and you shouldn't need any specific instruction, but you'll have to fix permissions and lowercase the filename as well, so keep reading.

===Extracting data from CD===
====Installing unshield====

First, you need unshield from http://synce.sourceforge.net/synce/unshield.php

If you use debian, apt-get install unshield as root should do the trick. Else, try to find a package for your distribution, or if you don't, compile it yourself following the instructions provided on the website. Note you don't need to actually install it, just compile it and use it from the directory where you compiled it.

====Preparing directories====

* Create a directory for fs2_open, say, ''/usr/local/games/fs2_open'', with a ''data/movies'' and ''data/players'' subdirectories. Everything but user files and configuration will be in this directory. You'll probably need to be root or use sudo for most of the following commands if you use a global directory like the one in this example.

''Warning : Again, please double check the commands you run as root. A single typo could destroy your data. 'Remember what is said on the top of the page ? if not, go re-read it.''

<tt>~ $ mkdir -p /usr/local/games/fs2_open/data/movies /usr/local/games/fs2_open/data/players</tt>

====Extracting files====

* Use unshield to extract the groups from data1.cab (on the first cd) to a temporary directory; then move the files in your game directory :
<tt>~ $ mkdir /tmp/fs2
~ $ for group in "Basic Install Files" "Intel Anims" "Music Compressed" "High Res Files"; do unshield -d /tmp/fs2/ -g "$group" -L -j x /mnt/cdrom/data1.cab; done; mv -v /tmp/fs2/*/* /home/data/jeux/fs2_open
~ $ unshield -d /tmp/fs2/ -g "Hud Config Files" -L -j x /mnt/cdrom/data1.cab && mv -v /tmp/fs2/hud_config_files/* /usr/local/games/fs2_open/data/players</tt>
* From '''both''' the second and third CDs, get the vp files and the movies files (I don't think the the .mve file are really needed; you'll need the .avi ones if you want the movies).
<tt>~ $ cp -vf *.vp /usr/local/games/fs2_open
~ $ cp -vf *.MVE /usr/local/games/fs2_open/data/movies/</tt>

You may notice that some files are on all three CD; this is because the game was meant to be run with the CD in the drive. Don't worry, a copy of such a file from any of the 3 CDs will work.

=== Fixing Case and permissions ===
* You '''have''' to make sure everything is lowercase :
<tt>~ $ for file in `find /usr/local/games/fs2_open/`; do mv $file `echo $file | sed 's/$[A-Z]$/\l\1/g'`; done</tt>

* Then, fix permissions :
<tt>~ $ find /usr/local/games/fs2_open -type d -exec chmod a+rx '{}' \;
~ $ find /usr/local/games/fs2_open -type f -exec chmod a+r '{}' \;</tt>

== Using the source ==

=== CVS Checkout ===
Before you begin, make sure you have write permissions on your current working directory. Your /home/user/ directory is a pretty sure bet. I recommend that you create a permanent /home/user/src directory from which you run the CVS command, this way CVS will only update the files changed the next time you download the source and it's always nice to have things organized.

Now get the source. Run from a terminal:
$ cvs -d:pserver:anonymous:anonymous@warpcore.org:/home/fs2source/cvsroot login
and then
$ cvs -z3 -d:pserver:anonymous@warpcore.org:/home/fs2source/cvsroot co fs2_open
The first cvs command tells the CVS tool to first use a password file for authentication (pserver), that you are user "anonymous" with the password "anonymous" who wants to access warpcore.org's CVS repository "/home/fs2source/cvsroot" and login. The second command tells the CVS server on which we are now connected to that we want to checkout (co) the fs2_open module.
 
==== Simple Checkout Script ====
You can use this script to simplify your checkouts, don't forget to chmod +x it.
#!/bin/bash
CVS="cvs -d:pserver:anonymous:anonymous@warpcore.org:/home/fs2source/cvsroot"
MODULE="fs2_open"
BRANCH="fs2_open_3_6_9"

${CVS} co -r ${BRANCH} ${MODULE}

=== Pre-Compile Configuration ===

Before you compile you need to configure it for your system. In the directory you ran the CVS command from, a new directory has appear, namely fs2_open.
If your fs2_open is a completely new checkout, you will first need to run the autogen.sh script.
Run from inside your newly created fs2_open directory:
$ ./autogen.sh
autogen.sh is a script that will generate the required makefiles. You will see alot of "checking for this" and "checking for that", this is actually the "configure" script (which can be run with <tt>./configure</tt> if you need to change the options) examining and configuring fs2_open for your system. 
It is possible to give autogen.sh configure options as well, autogen.sh will pass them along to configure.

A full list of configure options can be found by running the configure script with the '--help' option.
$ ./configure --help

==== Optimizing fs2_open ====
Optimizing fs2_open might have little or no effect, or improve performance greatly, I honestly have no clue. 
A note of caution, if you are compiling a debug build, don't use the -fomit-frame-pointer CFLAG, it will make debugging impossible. 
You can specify your compiler flags with the configure script, se below.
$ ./configure CFLAGS="<your desired flags>"
If you got a Athlon-XP and want to play it safe, a good set of CFLAGS would be
$ ./configure CFLAGS="-march=athlon-xp -O3 -pipe -fomit-frame-pointer"
You should read up on CFLAGS and what they do before trying anything. I recommend you read through these links. 
http://gcc.gnu.org/onlinedocs/gcc-3.4.1/gcc/Optimize-Options.html 
http://linuxreviews.org/howtos/compiling/safe-cflags/ 
http://en.wikipedia.org/wiki/CFLAGS

=== Compiling ===

Run from within your fs2_open directory:
$ make
Sit back and enjoy gcc work its magic.

==== Simple Compile Script ====
It's a lot easier to use a scripts when dealing with constantly changing code. Copy and save this to a suitably named file like "compile-fs2_open", and make it executable with the command, chmod +x <name of file>
#!/bin/bash
# MY_CFLAGS="-march=athlon-xp -O2 -pipe -fomit-frame-pointer -falign-functions=64"
# MY_CXXFLAGS="${CFLAGS} -fvisibility-inlines-hidden"
# MY_LDFLAGS="-Wl,-O1 -Wl,--sort-common -Wl,--as-needed -s"
if [ -e ./${*} ]; then
cd ${*}
if [ -e ./Makefile.in ]; then
make clean
./configure CFLAGS="${MY_CFLAGS}" CXXFLAGS="${MY_CFLAGS}" LDFLAGS="${MY_LDFLAGS}"
make
else
./autogen.sh CFLAGS="${MY_CFLAGS}" CXXFLAGS="${MY_CFLAGS}" LDFLAGS="${MY_LDFLAGS}"
make
fi
fi
You can add your options to the ./configure line. You need to give the script the fs2_open source directory, like this:
$ ./compile-fs2_open fs2_open
This makes it easier to deal with multiple source directories.

== Using the Binaries ==

When the compile is done and if all went well, a binary executable will reside in the code directory ''fs2_open_r'' or ''fs2_open_d'' if you configured for a debug build. Copy the binary to directory where Freespace2 is installed, and you're all set to go.

=== Post-Compile Configuration ===
==== Changing Your Resolution ====
Odds are, you'll want to run fs2_open in a higher resolution than the default 640x480. Unfortunately, we Linux users don't have the swank launcher app that the Windows folks do. Instead, we'll be making a couple line changes to a config file. You will need to run fs2_open once before you can make the necessary changes, otherwise you won't have a configuration directory to work with.

Open up ~/.fs2_open/fs2_open.ini with the text editor of your choice (vi, EMACS, kwrite, gedit). You'll see something like the following:
[Default]
VideocardFs2open=OGL -(640x480)x16 bit
LastPlayer=MonkeyboyS
GammaD3D=1.0

To set fs2_open to use the highest setting possible on retail Freespace 2, change the VideocardFs2open to:
VideocardFs2open=OGL -(1024x768)x32 bit
You can set this to pretty much anything you want.

=== Creating a Start Up Script ===

In order to use all of the advanced engine features of fs2_open, you'll need to start the executable with a number of command line arguments. Instead of typing them in every time you want to start the game, why not create a script that does it for you?

Create a new file named start_freespace (or whatever you like) in your home directory. Open the file in your editor of choice, and paste the following:
#!/bin/bash
cd /path/to/your/freespace/
./fs2_open_r -spec -glow -mipmap -jpgtga -orbradar -mod Media_VP

''Note: You will need to edit this script before it will work properly. The second line must point to the directory where you installed fs2_open. You can also find a more elaborated script example below in the i18n section''

The last line starts fs2_open with a number of arguments that turn on extra features. In the example, the game will use specular highlights, glow-mapping, mipmapping, jpg and tga graphic files, the orb radar, and any MediaVPs installed to the /Media_VP directory. You should edit this line to use those features that your system supports.

More information about the available Command Line Arguments can be found at the [[Command-Line Reference]]

Once you've edited the file to your heart's content, make it executable:
$ chmod +x start_freespace

You can now type in start_freespace to start the game, or by clicking on start_freespace in your window manager. For convenience, you can copy it to your Desktop.

[http://www.hard-light.net/wiki/index.php/Command-Line_Reference See this] for more command line options.

==== Advanced Startup Script ====
This is nothing fancy, but it's all the command line options in a file.
#!/bin/bash
# Graphics
CMDLINE="-spec -env -glow -jpgtga -mipmap -2d_poof -missile_lighting"
CMDLINE="$CMDLINE -ambient_factor 75 -spec_exp 11 -spec_point 0.6"
CMDLINE="$CMDLINE -spec_static 0.8 -spec_tube 0.4"
#CMDLINE="$CMDLINE -pcx32 -cell -nomotiondebris -noscalevid -rlm -clipdist"
# Game Speed
CMDLINE="$CMDLINE -cache_bitmaps"
#CMDLINE=$CMDLINE -img2dds -no_vsync"
# HUD
CMDLINE="$CMDLINE -targetinfo -orbradar -ballistic_gauge -rearm_timer"
#CMDLINE="$CMDLINE -dualscanlines"
# Gameplay
CMDLINE="$CMDLINE -ship_choice_3d -3dwarp -warp_flash -fov 0.39"
#CMDLINE="$CMDLINE -UseNewAI -tbp -wcsaga"
# Audio
CMDLINE="$CMDLINE -snd_preload"
#CMDLINE="$CMDLINE -nosound -nomusic"
# Multiplayer
#CMDLINE="$CMDLINE -standalone -startgame -closed -restricted"
#CMDLINE="$CMDLINE -multilog -clientdamage -mpnoreturn"
# Troubleshooting
#CMDLINE="$CMDLINE -oldfire -nohtl -no_set_gamma -nomovies -noparseerrors"
#CMDLINE="$CMDLINE -safeloading -query_speech -d3d_bad_tsys -novbo -noibx -loadallweps"
# Experimental
CMDLINE="$CMDLINE -alpha_env"
#CMDLINE="$CMDLINE -decals -ingame_join"
# Development Tools
CMDLINE="$CMDLINE -fps"
#CMDLINE="$CMDLINE -pos -window -timerbar -coords -pofspew -tablecrcs -missioncrcs"
#CMDLINE="$CMDLINE -dis_collisions -dis_weapons -output_sexps"
#CMDLINE="$CMDLINE -output_scripting -nograb -show_mem_usage -stats"
# Mod
CMDLINE="$CMDLINE -mod mv368zeta"
./fs2_open_r $CMDLINE

== Troubleshooting ==
=== Compile Errors ===
==== Novell SuSE and the dependencies ====

If your SuSE gives you some errors like this, during the compile process, your OpenAL version is too old or corrupted.
sound/ds.cpp: In function 'int ds_init(int, int, unsigned int, short unsigned int)':
sound/ds.cpp:1790: error: invalid conversion from 'const char*' to 'const ALubyte*'
sound/ds.cpp:1790: error: initializing argument 1 of 'ALboolean alIsExtensionPresent(const ALubyte*)'
You have to remove all OpenAL-packages via YaST, you may also want to remove TORCS, too, it won't run anymore after this.
Unfortunately there is no repository with a newer version for this distro, yet, so you have to use a source-package for Fedora. You get it here http://download.fedora.redhat.com/pub/fedora/linux/extras/5/SRPMS/openal-0.0.9-0.6.20060204cvs.fc5.src.rpm
The version may change, so you better check this.
Now make sure, that TexInfo is installed. Then enter:
$ rpmbuild --rebuild --target=i686 <name-of-your-package>.fc5.src.rpm
If it builds without errors, you will find an OpenAL*.rpm and an OpenAL*-devel.rpm in <tt>/usr/src/packages/RPMS/i686/</tt>. Install both and go back to your fs_open directory again. Cause the environment has changed now, you better type:
$ make clean
$ ./configure [options]
$ make
Then you're done.

==== SDL: undefined reference to... ====

This is a SDL installing issue, since it's trying to link against the static lib and not the dynamic one.
First check where <tt>/usr/lib/libSDL.so</tt> is linked to, then search this very file.
$ ls -l /usr/lib/libSDL.so
lrwxrwxrwx 1 root root 28 2006-09-06 00:10 /usr/lib/libSDL.so -> /usr/lib/libSDL-1.2.so.0.7.1
$ ls /usr/lib/ | grep libSDL-1.2.so.0.7
libSDL-1.2.so.0.7.2
If they are not the same (like in this case), you just make a new link. Type as root:
# ln -s /usr/lib/libSDL-1.2.so.0.7.2 /usr/lib/libSDL.so
Of course you must change some figures, so it matches on your system.

==== Missing -lGLU compile error ====

On some Linux distributions (''Slackware'' for instance), compiling fails because a GL related library doesn't have a link in the <tt>/usr/lib</tt> directory. If the compile fails because it can't find <tt>-lGLU</tt>, here are two ways to fix it:

===== Solution as Root =====

If you have root access to the system, you can create a link to the library in question with just a little bit of command line magic. Go to a console and enter:

$ ln -s /usr/X11R6/lib/libGLU.so /usr/lib/libGLU.so

After that, you can run make again and it should finish compiling.

===== Solution as a Non-Root user =====

You don't have root access? Never fear, we can still fix the problem. It'll just be a tad more difficult.

Navigate to the <tt>fs2_open/code</tt> directory and locate a file named <tt>Makefile</tt> (not Makefile.rm or Makefile.in or Makefile.anything). Open it in your favorite text editor and make the following changes.

Find this line (line 457 in mine):
FS2_LDFLAGS = -L/usr/lib -Wl,-rpath,/usr/lib -lSDL -lpthread -lGL -lGLU -lopenal -logg -lvorbis -lvorbisfile

And replace it with this:
FS2_LDFLAGS = -L/usr/lib -Wl,-rpath,/usr/lib -lSDL -lpthread -lGL -lopenal -logg -lvorbis -lvorbisfile -L/usr/X11R6/lib -lGLU

Also find this one (line 565 in mine):
AM_LDFLAGS = -g -L/usr/lib -Wl,-rpath,/usr/lib -lSDL -lpthread -lGL -lGLU -lopenal -logg -lvorbis -lvorbisfile

And replace it with this:
AM_LDFLAGS = -g -L/usr/lib -Wl,-rpath,/usr/lib -lSDL -lpthread -lGL -lopenal -logg -lvorbis -lvorbisfile -L/usr/X11R6/lib -lGLU

Then run <tt>make</tt> from the <tt>fs2_open</tt> directory, and watch the magic happen.

==== glBindBufferARB feature missing ====
''If this is the actual solution to this problem remains to be seen.'' 
''So far, only people using Debian stable are affected by this.'' 
''So we need adventurus Debian users to confirm.'' 
''I can confirm that the APT-Pinning works, can not confirm compile thou. -- ni1s'' 
checking for glBindBufferARB in -lGL... no
configure: error: *** OpenGL version does not have the required features!! (ie.glBindBufferARB()) ***
This error appears if the installed Mesa development library is to old.

On Debian stable branch the xlibmesa-gl-dev package holds version 4.3.0. 
The xlibmesa-gl-dev package on ''testning'' is version 6.9.0.

'''Possible solution:''' 
First set /etc/apt/sources.list to include the testing branch. Add:
#Testing
deb http://ftp.us.debian.org/debian testing main non-free contrib
deb http://non-us.debian.org/debian-non-US testing/non-US main contrib non-free
Your sources.list might have these lines already, if so, you should be okej.

Your /etc/apt/preferences file should look like this
Package: *
Pin: release a=stable
Pin-Priority: 700

Package: *
Pin: release a=testing
Pin-Priority: 650

Package: *
Pin: release a=unstable
Pin-Priority: 600

Add to that file:
Package: xlibmesa-gl-dev
Pin: release a=testing
Pin-Priority: 800
Note that the Pin-Priority of xlibmesa-gl-dev here is higher than the Pin-Priority on 'stable'. As a result of this APT get will prioritize the xlibmesa-gl-dev from testing and leave the rest of the system on stable.
This is called apt-pinning.

Now that APT knows what xlibmesa-gl-dev to prioritze, install it again:
$ apt-get install xlibmesa-gl-dev

If you are using nVidia's nvidia-kernel and glx packages, a simple:
$ apt-get install nvidia-glx-dev
should suffice. No need to mess around with APT-pinning.

=== Runtime Errors and common problems ===
==== ERROR: "Web cursor bitmap not found." ====
ERROR: "Web cursor bitmap not found. This usually means that the executable is being run outside the directory
you installed Freespace2 to. Please move the executable to that directory and try again" at graphics/2d.cpp:1402
A common error. This happens when fs2_open can't find the .vp files or that your user doesn't have the permissions to access them. If you are using a start up script([http://www.hard-light.net/wiki/index.php/Fs2_open_on_Linux#Creating_a_Start_Up_Script like the one found here]) it's most likly the a permission problem.
Have your user take owenership of the .vp files, run as root:
$ chown <user> /path/to/vpfiles/ -R

=== I18n and Key mapping problems ===
''Me, being a Swede, need to use this aswell, especially for the grave key(`), but I also want to use a second X display. There is a way to tell xmodmap to use the new set of keys on the second X display, and thus eliminating the need for a temp. keymap table as it dies with the second display when exiting fs2_open, never touching the keymap table on display 0. We should dig that info up and write a super-start script. --ni1s'' 
Ok, imagine that like me you don't have an us keyboard but a french one (or anything). Well, you probably have problems mapping some keys or even using the default mapping.

Actually, the problem is fs2_open does not take modifiers into account, as it uses them internally as modifiers for keys, and it won't accept non-us charset either.

On a french keyboard layout, the numbers ''1 2 3 4 5 6 7 8 9 0'' are on the same keys than on a US layout, but you have to press shift to use them. The primary function for theses keys are ''& Ã© " ' ( - Ã¨ _ Ã§ Ã )''. These characters won't be accepted by freespace, and if you press shift to get a number, it won't work. This can be a problem, as theses keys are needed to use the communication system, and cannot be bound to anything. Also, as you won't get access some keys on your keyboard, it will be difficult to map every command on a key, or you'll have to use modifiers for nearly each key.

However, there is a solution. You can tell X to remap the keyboard before launching the game, and restore your normal keymap afterwards.

For exemple, I map 123456790 to &é"'(-è_çà keys so I can use the communication system, and I put , and ; on the Alt-Gr and Menu keys for convenience, as I binded thoses keys to next primary weapon and next secondary weapon.

To do this, I use a slightly enhanced startup script, which I put in ~/bin (this directory is in my path), together with a customized xmodmap.

* First, dump your current xmodmap :

<tt>~ $ xmodmap -pke > ~/xmodmap.current</tt>

* Then edit it with your favorite text editor. You'll see a bunch of lines looking like this :

<tt>
keycode 8 =
keycode 9 = Escape
keycode 10 = 1 ampersand onesuperior exclamdown onesuperior exclamdown
</tt>

The syntax is ''keycode <number> = <symbol list>''.

Use '''xev''' to scan the keycodes. The symbols are defined in ''/usr/include/X11/keysymdef.h''. Just make sure you write them without the ''XK_'' prefix. You'll find more information about xmodmap in the xmodmap manual page.

Just modify the keys you need, and be patient. This can be a long process. Test it with xmodmap :

<tt>~ $ xmodmap - < <filename></tt>

But don't forget to have your previous keymap at hand to recover your settings !
If you mess everything up, just restart X. Your default keymap will be applied from the X configuration.

Here is my own fs2 xmodmap, derived from fr-latin1 as described above. Feel free to use it if you're too lazy to modify your own. However, it may not fit with your needs. You may always use it as an exemple, thougt.
* http://clement.hermann.free.fr/fs2/xmodmap

Then, when the file is modified at your liking, just save it as '''~/.fs2_open/xmodmap'''

We'll start fs2_open with a slightly more elaborate startup script which will backup/apply/restore the keymap in addition of running the games with some options in the right directory.

<tt>
#!/bin/sh
# This script lauches fs2. If there is a file named $FS2_modmap (see below),
# backup the current modmap as $TMP_modmap and load it as the new modmap.
# The current modmap will be restored afterwards.

TMP_modmap="$HOME/xmodmap.tmp"
FS2_modmap="$HOME/.fs2_open/xmodmap"

FS2_OPEN_DIR=/usr/local/games/fs2_open

FS2_ARGS="-glow -spec -spec_exp 11 -spec_point 0.6 -spec_static 0.8 -spec_tube 0.4 -fps -jpgtga -ambient_factor 75 -targetinfo -nograb"

FS2_BIN="$FS2_OPEN_DIR/fs2_open_r"

die() {
echo "** Fatal error : $1" >&2
exit 1
}

cd $FS2_OPEN_DIR || die "Could not change directory to $FS2_OPEN_DIR"

# dump current xmodmap
[ -f "$FS2_modmap" ] && xmodmap -pke > $TMP_modmap

# load xmodmap
[ -f "$FS2_modmap" ] && xmodmap - < $FS2_modmap

# prepare to restore xmodmap on crash or exit
trap "xmodmap - < $TMP_modmap && rm $TMP_modmap" 0 2 3 4 9 11 15

# launch fs2
$FS2_BIN $FS2_ARGS $* || die "Error while running \"$FS2_BIN\" with arguments \"$FS2_ARGS\" ($?)"
</tt>

Adapt this script to your needs, and save it somewhere in your PATH - I for exemple use ''~/bin/freespace2''. Make it executable with chmod +x ''<file>''

That's it, now you can use fs2 with full control over your keyboard.

=== fs2_open dedicated X display ===
A good way of running games on Linux is having them run on a separate X display. The display you are most likely using now when reading this is 0:0. This display is normally used for whatever Window Manager/Desktop Environment(KDE,Gnome,*box,E) you've chosen. Sometimes fs2_open freezes and locks your X. This is of course very annoying as you have to CTRL+ALT+BACKSPACE to kill the X server, and in that, killing whatever program you had running besides fs2_open. The solution to this is to tell X to start fs2_open on another display. To to this we first need to tell X that you,the user on localhost, holds the permission to run on another display.
In a terminal, enter (NOT as root):
$ xauth list
A list that looks something like this should appear.
myuser@localhost ~ $ xauth list
localhost/unix:'''0''' MIT-MAGIC-COOKIE-1 14ec70e7c8cc835def61a04c92bbd50d
Let's look at that line, first up is your localhost, then unix, and last the display number,:0 (in bold). The rest is not really of interest.
Copy the whole line, but change the display value to 1 and paste it after the command ''xauth add'', like this:
$ xauth add localhost/unix:'''1''' MIT-MAGIC-COOKIE-1 14ec70e7c8cc835def61a04c92bbd50d
Run xauth list again. You should see a new entry.
myuser@localhost ~ $ xauth list
localhost/unix:'''0''' MIT-MAGIC-COOKIE-1 14ec70e7c8cc835def61a04c92bbd50d
localhost/unix:'''1''' MIT-MAGIC-COOKIE-1 14ec70e7c8cc835def61a04c92bbd50d
You now have permission to use display 1:0.
To start fs2_open in that display, use xinit.
$ xinit /path/to/fs2_open_r -foo -bar -- :1
The ''-- :1'' tells X that we want to start fs2_open on display 1. 
You can switch between display 0 and 1 with CTRL+ALT+F7 and CTRL+ALT+F8 respectively.

If you try this from an xterm (or a similar X terminal program) and obtain the error ''X: user not authorized to run the X server, aborting.'', the reason might be the file /etc/X11/Xwrapper.config. On my ubuntu machine, it contains the line

allowed_users=console

which means that only users logged in from a console terminal may start a new X server. However, on an xterm, you are on a '''virtual''' terminal and so the above does not work. A possibility is to change the allowed_users in the Xwrapper.config file to "anybody" (see man Xwrapper.config). However, this undermines X security. Another possibility is to start the xinit command from a console window (to which you can change with CTRL+ALT+F1-6).

''If someone knows of a good method to start fs2 on a second X display from an xterm without changing Xwrapper.config, please report it here.''

''A solution might be running xinit as root with sudo, and drop the root privileges in the startup script... Didn't tried, though.'' -- nodens

''xgame / xgame-gtk2 may be of use to achieve this as normal user, see http://xgame.tlhiv.org/ '' -- Lone_Wolf

[[Category:Source Code Project]]

Guide to FS Open on Linux

2007-02-02T22:09:36Z

Nodens: Added informations about the cross-platform installer and other things that can make your life easier ;)

''This tutorial assumes some fundamental command line knowledge. ''
''As a rule of thumb, do not copy/paste commands without understanding them, especially as root. With great power comes great responsability.''

'''Introduction :'''

This page will guide you through compilation and installation of FS2_open, using the CVS code, along with the data files.
Please note that if you don't manage to build the CVS (or don't want to), binaries my be found on this thread (no 3.6.9 linux binary as of this writing). You'll need probably need to read on anyway (how to get data files, starting the games, dealing with i18n issues...), but ignore what's related to building your own binary.

If you don't want to use CVS, but can't find a suitable binary, you can download an almost current (3.6.9-RC8) source release here :
http://fs2source.warpcore.org/exes/linux/fs2_open-3.6.9-RC8.tar.bz2

Also, Turey wrote a cross-platform installer (in java), able to download all you need for running FS2_Open except the binary (retail files, MediaVP, movies...). It can be found here : [[http://www.hard-light.net/forums/index.php/topic,42854.0.html|Freespace Open Installer]]. It's far more easier than extracting the data files from the retail windows installer (see below).

There is even work in progress on a linux launcher that you may want to try : [[http://www.hard-light.net/forums/index.php/topic,44204.0.html|Linux launcher]] (this is different from the upcoming new launcher which will be used in 3.7 fs2_open release) // ''The links in the thread are currently dead, but let's hope that will be resolved soon.''

----

== Installing CVS ==
CVS stands for Concurrent Versions System and is a version control system used to record the changes in documents, such as source files. Developers use CVS so they can easily share their code changes among other developers.
Be aware that when you use CVS, you use the most up-to-date code : It may or may not be better than a release. It may be worse, less stable, or not even compile. This is work in progress.

You will need this tool to download ("checkout" in CVS terminology) fs2_open from the CVS server.

'''Debian/Ubuntu''' users want to:
$ apt-get install cvs
'''Gentoo''' users want to:
$ emerge cvs
'''Novell SuSE''' users install CVS via YaST.

'''Archlinux''' users want to:
$ pacman -Sy cvs

'''NOTE: Redhat, Mandrake/Mandriva, Slackware and all the other distros should go here too,'''
'''but we have no knowledge on how these work, so if you do, please enlighten us.'''

== Installing the necessary development libraries ==
You will also need SDL, OpenAL, libvorbis, libtheora and OpenGL(most likely provided with your video card driver) development packages. And of course the GCC compiler and required make tools.
 
'''Debian/Ubuntu''' users want to:
$ apt-get install libopenal-dev libvorbis-dev build-essential automake1.9 autoconf libsdl-dev libtheora-dev
'''NOTE:''' The ''build-essential'' meta package installs GCC4. This should work, but if you feel safer with GCC 3.4(gcc-3.4), add it to the apt-get line above. 

''Note : on other distributions, you'll need theora as well, so the information for Gentoo and SuSe below is outdated. if someone knows the exact package name, please edit !'' 

'''Gentoo''' users want to:
$ emerge openal libvorbis libsdl
'''Novell SuSE''' users just install the mentioned packages and the devel-packages via YaST. If this works don't read further.
SuSE maybe has some dependency problems with the game TORCS, i.e. its special version of OpenAL, so you have to make a choice. If you still want to run FS2 open, go on here http://www.hard-light.net/wiki/index.php/Fs2_open_on_Linux#Compile_Errors

'''Archlinux''' users want to:
$ pacman -S freealut libvorbis sdl

'''NOTE: Redhat, Mandrake,Slackware and all the other distros should go here too,'''
'''but we have no knowlage on how these work, so if you do, please enlighten us.'''

== Installing game data files ==

This tutorial deals primarily with providing you with an executable, but in order to play the game you also need the game data. Freespace 2 game data is available from a number of sources, see this thread: http://www.hard-light.net/forums/index.php/topic,38195.0.html (or use Turey's installer, see above for a link)

Note that if you use the retail CD, you'll need to extract the files and to copy them on your drive, reproducing the same layout as in a working win32 installation (just make sure every file is lowercase). This thread on the SCP forum has some more info on it : http://scp.indiegames.us/forum_viewtopic.php?3.282

There are two ways of doing this :
* use wine to install the game in the right directory, using the Setup.exe found on the first CD, or
* extract manually the files from the cd.

The second method is detailed below. The wine one is straightforward and you shouldn't need any specific instruction, but you'll have to fix permissions and lowercase the filename as well, so keep reading.

===Extracting data from CD===
====Installing unshield====

First, you need unshield from http://synce.sourceforge.net/synce/unshield.php

If you use debian, apt-get install unshield as root should do the trick. Else, try to find a package for your distribution, or if you don't, compile it yourself following the instructions provided on the website. Note you don't need to actually install it, just compile it and use it from the directory where you compiled it.

====Preparing directories====

* Create a directory for fs2_open, say, ''/usr/local/games/fs2_open'', with a ''data/movies'' and ''data/players'' subdirectories. Everything but user files and configuration will be in this directory. You'll probably need to be root or use sudo for most of the following commands if you use a global directory like the one in this example.

''Warning : Again, please double check the commands you run as root. A single typo could destroy your data. 'Remember what is said on the top of the page ? if not, go re-read it.''

<tt>~ $ mkdir -p /usr/local/games/fs2_open/data/movies /usr/local/games/fs2_open/data/players</tt>

====Extracting files====

* Use unshield to extract the groups from data1.cab (on the first cd) to a temporary directory; then move the files in your game directory :
<tt>~ $ mkdir /tmp/fs2
~ $ for group in "Basic Install Files" "Intel Anims" "Music Compressed" "High Res Files"; do unshield -d /tmp/fs2/ -g "$group" -L -j x /mnt/cdrom/data1.cab; done; mv -v /tmp/fs2/*/* /home/data/jeux/fs2_open
~ $ unshield -d /tmp/fs2/ -g "Hud Config Files" -L -j x /mnt/cdrom/data1.cab && mv -v /tmp/fs2/hud_config_files/* /usr/local/games/fs2_open/data/players</tt>
* From '''both''' the second and third CDs, get the vp files and the movies files (I don't think the the .mve file are really needed; you'll need the .avi ones if you want the movies).
<tt>~ $ cp -vf *.vp /usr/local/games/fs2_open
~ $ cp -vf *.MVE /usr/local/games/fs2_open/data/movies/</tt>

You may notice that some files are on all three CD; this is because the game was meant to be run with the CD in the drive. Don't worry, a copy of such a file from any of the 3 CDs will work.

=== Fixing Case and permissions ===
* You '''have''' to make sure everything is lowercase :
<tt>~ $ for file in `find /usr/local/games/fs2_open/`; do mv $file `echo $file | sed 's/$[A-Z]$/\l\1/g'`; done</tt>

* Then, fix permissions :
<tt>~ $ find /usr/local/games/fs2_open -type d -exec chmod a+rx '{}' \;
~ $ find /usr/local/games/fs2_open -type f -exec chmod a+r '{}' \;</tt>

== Using the source ==

=== CVS Checkout ===
Before you begin, make sure you have write permissions on your current working directory. Your /home/user/ directory is a pretty sure bet. I recommend that you create a permanent /home/user/src directory from which you run the CVS command, this way CVS will only update the files changed the next time you download the source and it's always nice to have things organized.

Now get the source. Run from a terminal:
$ cvs -d:pserver:anonymous:anonymous@warpcore.org:/home/fs2source/cvsroot login
and then
$ cvs -z3 -d:pserver:anonymous@warpcore.org:/home/fs2source/cvsroot co fs2_open
The first cvs command tells the CVS tool to first use a password file for authentication (pserver), that you are user "anonymous" with the password "anonymous" who wants to access warpcore.org's CVS repository "/home/fs2source/cvsroot" and login. The second command tells the CVS server on which we are now connected to that we want to checkout (co) the fs2_open module.
 
==== Simple Checkout Script ====
You can use this script to simplify your checkouts, don't forget to chmod +x it.
#!/bin/bash
CVS="cvs -d:pserver:anonymous:anonymous@warpcore.org:/home/fs2source/cvsroot"
MODULE="fs2_open"
BRANCH="fs2_open_3_6_9"

${CVS} co -r ${BRANCH} ${MODULE}

=== Pre-Compile Configuration ===

Before you compile you need to configure it for your system. In the directory you ran the CVS command from, a new directory has appear, namely fs2_open.
If your fs2_open is a completely new checkout, you will first need to run the autogen.sh script.
Run from inside your newly created fs2_open directory:
$ ./autogen.sh
autogen.sh is a script that will generate the required makefiles. You will see alot of "checking for this" and "checking for that", this is actually the "configure" script (which can be run with <tt>./configure</tt> if you need to change the options) examining and configuring fs2_open for your system. 
It is possible to give autogen.sh configure options as well, autogen.sh will pass them along to configure.

A full list of configure options can be found by running the configure script with the '--help' option.
$ ./configure --help

==== Optimizing fs2_open ====
Optimizing fs2_open might have little or no effect, or improve performance greatly, I honestly have no clue. 
A note of caution, if you are compiling a debug build, don't use the -fomit-frame-pointer CFLAG, it will make debugging impossible. 
You can specify your compiler flags with the configure script, se below.
$ ./configure CFLAGS="<your desired flags>"
If you got a Athlon-XP and want to play it safe, a good set of CFLAGS would be
$ ./configure CFLAGS="-march=athlon-xp -O3 -pipe -fomit-frame-pointer"
You should read up on CFLAGS and what they do before trying anything. I recommend you read through these links. 
http://gcc.gnu.org/onlinedocs/gcc-3.4.1/gcc/Optimize-Options.html 
http://linuxreviews.org/howtos/compiling/safe-cflags/ 
http://en.wikipedia.org/wiki/CFLAGS

=== Compiling ===

Run from within your fs2_open directory:
$ make
Sit back and enjoy gcc work its magic.

==== Simple Compile Script ====
It's a lot easier to use a scripts when dealing with constantly changing code. Copy and save this to a suitably named file like "compile-fs2_open", and make it executable with the command, chmod +x <name of file>
#!/bin/bash
# MY_CFLAGS="-march=athlon-xp -O2 -pipe -fomit-frame-pointer -falign-functions=64"
# MY_CXXFLAGS="${CFLAGS} -fvisibility-inlines-hidden"
# MY_LDFLAGS="-Wl,-O1 -Wl,--sort-common -Wl,--as-needed -s"
if [ -e ./${*} ]; then
cd ${*}
if [ -e ./Makefile.in ]; then
make clean
./configure CFLAGS="${MY_CFLAGS}" CXXFLAGS="${MY_CFLAGS}" LDFLAGS="${MY_LDFLAGS}"
make
else
./autogen.sh CFLAGS="${MY_CFLAGS}" CXXFLAGS="${MY_CFLAGS}" LDFLAGS="${MY_LDFLAGS}"
make
fi
fi
You can add your options to the ./configure line. You need to give the script the fs2_open source directory, like this:
$ ./compile-fs2_open fs2_open
This makes it easier to deal with multiple source directories.

== Using the Binaries ==

When the compile is done and if all went well, a binary executable will reside in the code directory ''fs2_open_r'' or ''fs2_open_d'' if you configured for a debug build. Copy the binary to directory where Freespace2 is installed, and you're all set to go.

=== Post-Compile Configuration ===
==== Changing Your Resolution ====
Odds are, you'll want to run fs2_open in a higher resolution than the default 640x480. Unfortunately, we Linux users don't have the swank launcher app that the Windows folks do. Instead, we'll be making a couple line changes to a config file. You will need to run fs2_open once before you can make the necessary changes, otherwise you won't have a configuration directory to work with.

Open up ~/.fs2_open/fs2_open.ini with the text editor of your choice (vi, EMACS, kwrite, gedit). You'll see something like the following:
[Default]
VideocardFs2open=OGL -(640x480)x16 bit
LastPlayer=MonkeyboyS
GammaD3D=1.0

To set fs2_open to use the highest setting possible on retail Freespace 2, change the VideocardFs2open to:
VideocardFs2open=OGL -(1024x768)x32 bit
You can set this to pretty much anything you want.

=== Creating a Start Up Script ===

In order to use all of the advanced engine features of fs2_open, you'll need to start the executable with a number of command line arguments. Instead of typing them in every time you want to start the game, why not create a script that does it for you?

Create a new file named start_freespace (or whatever you like) in your home directory. Open the file in your editor of choice, and paste the following:
#!/bin/bash
cd /path/to/your/freespace/
./fs2_open_r -spec -glow -mipmap -jpgtga -orbradar -mod Media_VP

''Note: You will need to edit this script before it will work properly. The second line must point to the directory where you installed fs2_open. You can also find a more elaborated script example below in the i18n section''

The last line starts fs2_open with a number of arguments that turn on extra features. In the example, the game will use specular highlights, glow-mapping, mipmapping, jpg and tga graphic files, the orb radar, and any MediaVPs installed to the /Media_VP directory. You should edit this line to use those features that your system supports.

More information about the available Command Line Arguments can be found at the [[Command-Line Reference]]

Once you've edited the file to your heart's content, make it executable:
$ chmod +x start_freespace

You can now type in start_freespace to start the game, or by clicking on start_freespace in your window manager. For convenience, you can copy it to your Desktop.

[http://www.hard-light.net/wiki/index.php/Command-Line_Reference See this] for more command line options.

==== Advanced Startup Script ====
This is nothing fancy, but it's all the command line options in a file.
#!/bin/bash
# Graphics
CMDLINE="-spec -env -glow -jpgtga -mipmap -2d_poof -missile_lighting"
CMDLINE="$CMDLINE -ambient_factor 75 -spec_exp 11 -spec_point 0.6"
CMDLINE="$CMDLINE -spec_static 0.8 -spec_tube 0.4"
#CMDLINE="$CMDLINE -pcx32 -cell -nomotiondebris -noscalevid -rlm -clipdist"
# Game Speed
CMDLINE="$CMDLINE -cache_bitmaps"
#CMDLINE=$CMDLINE -img2dds -no_vsync"
# HUD
CMDLINE="$CMDLINE -targetinfo -orbradar -ballistic_gauge -rearm_timer"
#CMDLINE="$CMDLINE -dualscanlines"
# Gameplay
CMDLINE="$CMDLINE -ship_choice_3d -3dwarp -warp_flash -fov 0.39"
#CMDLINE="$CMDLINE -UseNewAI -tbp -wcsaga"
# Audio
CMDLINE="$CMDLINE -snd_preload"
#CMDLINE="$CMDLINE -nosound -nomusic"
# Multiplayer
#CMDLINE="$CMDLINE -standalone -startgame -closed -restricted"
#CMDLINE="$CMDLINE -multilog -clientdamage -mpnoreturn"
# Troubleshooting
#CMDLINE="$CMDLINE -oldfire -nohtl -no_set_gamma -nomovies -noparseerrors"
#CMDLINE="$CMDLINE -safeloading -query_speech -d3d_bad_tsys -novbo -noibx -loadallweps"
# Experimental
CMDLINE="$CMDLINE -alpha_env"
#CMDLINE="$CMDLINE -decals -ingame_join"
# Development Tools
CMDLINE="$CMDLINE -fps"
#CMDLINE="$CMDLINE -pos -window -timerbar -coords -pofspew -tablecrcs -missioncrcs"
#CMDLINE="$CMDLINE -dis_collisions -dis_weapons -output_sexps"
#CMDLINE="$CMDLINE -output_scripting -nograb -show_mem_usage -stats"
# Mod
CMDLINE="$CMDLINE -mod mv368zeta"
./fs2_open_r $CMDLINE

== Troubleshooting ==
=== Compile Errors ===
==== Novell SuSE and the dependencies ====

If your SuSE gives you some errors like this, during the compile process, your OpenAL version is too old or corrupted.
sound/ds.cpp: In function 'int ds_init(int, int, unsigned int, short unsigned int)':
sound/ds.cpp:1790: error: invalid conversion from 'const char*' to 'const ALubyte*'
sound/ds.cpp:1790: error: initializing argument 1 of 'ALboolean alIsExtensionPresent(const ALubyte*)'
You have to remove all OpenAL-packages via YaST, you may also want to remove TORCS, too, it won't run anymore after this.
Unfortunately there is no repository with a newer version for this distro, yet, so you have to use a source-package for Fedora. You get it here http://download.fedora.redhat.com/pub/fedora/linux/extras/5/SRPMS/openal-0.0.9-0.6.20060204cvs.fc5.src.rpm
The version may change, so you better check this.
Now make sure, that TexInfo is installed. Then enter:
$ rpmbuild --rebuild --target=i686 <name-of-your-package>.fc5.src.rpm
If it builds without errors, you will find an OpenAL*.rpm and an OpenAL*-devel.rpm in <tt>/usr/src/packages/RPMS/i686/</tt>. Install both and go back to your fs_open directory again. Cause the environment has changed now, you better type:
$ make clean
$ ./configure [options]
$ make
Then you're done.

==== SDL: undefined reference to... ====

This is a SDL installing issue, since it's trying to link against the static lib and not the dynamic one.
First check where <tt>/usr/lib/libSDL.so</tt> is linked to, then search this very file.
$ ls -l /usr/lib/libSDL.so
lrwxrwxrwx 1 root root 28 2006-09-06 00:10 /usr/lib/libSDL.so -> /usr/lib/libSDL-1.2.so.0.7.1
$ ls /usr/lib/ | grep libSDL-1.2.so.0.7
libSDL-1.2.so.0.7.2
If they are not the same (like in this case), you just make a new link. Type as root:
# ln -s /usr/lib/libSDL-1.2.so.0.7.2 /usr/lib/libSDL.so
Of course you must change some figures, so it matches on your system.

==== Missing -lGLU compile error ====

On some Linux distributions (''Slackware'' for instance), compiling fails because a GL related library doesn't have a link in the <tt>/usr/lib</tt> directory. If the compile fails because it can't find <tt>-lGLU</tt>, here are two ways to fix it:

===== Solution as Root =====

If you have root access to the system, you can create a link to the library in question with just a little bit of command line magic. Go to a console and enter:

$ ln -s /usr/X11R6/lib/libGLU.so /usr/lib/libGLU.so

After that, you can run make again and it should finish compiling.

===== Solution as a Non-Root user =====

You don't have root access? Never fear, we can still fix the problem. It'll just be a tad more difficult.

Navigate to the <tt>fs2_open/code</tt> directory and locate a file named <tt>Makefile</tt> (not Makefile.rm or Makefile.in or Makefile.anything). Open it in your favorite text editor and make the following changes.

Find this line (line 457 in mine):
FS2_LDFLAGS = -L/usr/lib -Wl,-rpath,/usr/lib -lSDL -lpthread -lGL -lGLU -lopenal -logg -lvorbis -lvorbisfile

And replace it with this:
FS2_LDFLAGS = -L/usr/lib -Wl,-rpath,/usr/lib -lSDL -lpthread -lGL -lopenal -logg -lvorbis -lvorbisfile -L/usr/X11R6/lib -lGLU

Also find this one (line 565 in mine):
AM_LDFLAGS = -g -L/usr/lib -Wl,-rpath,/usr/lib -lSDL -lpthread -lGL -lGLU -lopenal -logg -lvorbis -lvorbisfile

And replace it with this:
AM_LDFLAGS = -g -L/usr/lib -Wl,-rpath,/usr/lib -lSDL -lpthread -lGL -lopenal -logg -lvorbis -lvorbisfile -L/usr/X11R6/lib -lGLU

Then run <tt>make</tt> from the <tt>fs2_open</tt> directory, and watch the magic happen.

==== glBindBufferARB feature missing ====
''If this is the actual solution to this problem remains to be seen.'' 
''So far, only people using Debian stable are affected by this.'' 
''So we need adventurus Debian users to confirm.'' 
''I can confirm that the APT-Pinning works, can not confirm compile thou. -- ni1s'' 
checking for glBindBufferARB in -lGL... no
configure: error: *** OpenGL version does not have the required features!! (ie.glBindBufferARB()) ***
This error appears if the installed Mesa development library is to old.

On Debian stable branch the xlibmesa-gl-dev package holds version 4.3.0. 
The xlibmesa-gl-dev package on ''testning'' is version 6.9.0.

'''Possible solution:''' 
First set /etc/apt/sources.list to include the testing branch. Add:
#Testing
deb http://ftp.us.debian.org/debian testing main non-free contrib
deb http://non-us.debian.org/debian-non-US testing/non-US main contrib non-free
Your sources.list might have these lines already, if so, you should be okej.

Your /etc/apt/preferences file should look like this
Package: *
Pin: release a=stable
Pin-Priority: 700

Package: *
Pin: release a=testing
Pin-Priority: 650

Package: *
Pin: release a=unstable
Pin-Priority: 600

Add to that file:
Package: xlibmesa-gl-dev
Pin: release a=testing
Pin-Priority: 800
Note that the Pin-Priority of xlibmesa-gl-dev here is higher than the Pin-Priority on 'stable'. As a result of this APT get will prioritize the xlibmesa-gl-dev from testing and leave the rest of the system on stable.
This is called apt-pinning.

Now that APT knows what xlibmesa-gl-dev to prioritze, install it again:
$ apt-get install xlibmesa-gl-dev

If you are using nVidia's nvidia-kernel and glx packages, a simple:
$ apt-get install nvidia-glx-dev
should suffice. No need to mess around with APT-pinning.

=== Runtime Errors and common problems ===
==== ERROR: "Web cursor bitmap not found." ====
ERROR: "Web cursor bitmap not found. This usually means that the executable is being run outside the directory
you installed Freespace2 to. Please move the executable to that directory and try again" at graphics/2d.cpp:1402
A common error. This happens when fs2_open can't find the .vp files or that your user doesn't have the permissions to access them. If you are using a start up script([http://www.hard-light.net/wiki/index.php/Fs2_open_on_Linux#Creating_a_Start_Up_Script like the one found here]) it's most likly the a permission problem.
Have your user take owenership of the .vp files, run as root:
$ chown <user> /path/to/vpfiles/ -R

=== I18n and Key mapping problems ===
''Me, being a Swede, need to use this aswell, especially for the grave key(`), but I also want to use a second X display. There is a way to tell xmodmap to use the new set of keys on the second X display, and thus eliminating the need for a temp. keymap table as it dies with the second display when exiting fs2_open, never touching the keymap table on display 0. We should dig that info up and write a super-start script. --ni1s'' 
Ok, imagine that like me you don't have an us keyboard but a french one (or anything). Well, you probably have problems mapping some keys or even using the default mapping.

Actually, the problem is fs2_open does not take modifiers into account, as it uses them internally as modifiers for keys, and it won't accept non-us charset either.

On a french keyboard layout, the numbers ''1 2 3 4 5 6 7 8 9 0'' are on the same keys than on a US layout, but you have to press shift to use them. The primary function for theses keys are ''& Ã© " ' ( - Ã¨ _ Ã§ Ã )''. These characters won't be accepted by freespace, and if you press shift to get a number, it won't work. This can be a problem, as theses keys are needed to use the communication system, and cannot be bound to anything. Also, as you won't get access some keys on your keyboard, it will be difficult to map every command on a key, or you'll have to use modifiers for nearly each key.

However, there is a solution. You can tell X to remap the keyboard before launching the game, and restore your normal keymap afterwards.

For exemple, I map 123456790 to &é"'(-è_çà keys so I can use the communication system, and I put , and ; on the Alt-Gr and Menu keys for convenience, as I binded thoses keys to next primary weapon and next secondary weapon.

To do this, I use a slightly enhanced startup script, which I put in ~/bin (this directory is in my path), together with a customized xmodmap.

* First, dump your current xmodmap :

<tt>~ $ xmodmap -pke > ~/xmodmap.current</tt>

* Then edit it with your favorite text editor. You'll see a bunch of lines looking like this :

<tt>
keycode 8 =
keycode 9 = Escape
keycode 10 = 1 ampersand onesuperior exclamdown onesuperior exclamdown
</tt>

The syntax is ''keycode <number> = <symbol list>''.

Use '''xev''' to scan the keycodes. The symbols are defined in ''/usr/include/X11/keysymdef.h''. Just make sure you write them without the ''XK_'' prefix. You'll find more information about xmodmap in the xmodmap manual page.

Just modify the keys you need, and be patient. This can be a long process. Test it with xmodmap :

<tt>~ $ xmodmap - < <filename></tt>

But don't forget to have your previous keymap at hand to recover your settings !
If you mess everything up, just restart X. Your default keymap will be applied from the X configuration.

Here is my own fs2 xmodmap, derived from fr-latin1 as described above. Feel free to use it if you're too lazy to modify your own. However, it may not fit with your needs. You may always use it as an exemple, thougt.
* http://clement.hermann.free.fr/fs2/xmodmap

Then, when the file is modified at your liking, just save it as '''~/.fs2_open/xmodmap'''

We'll start fs2_open with a slightly more elaborate startup script which will backup/apply/restore the keymap in addition of running the games with some options in the right directory.

<tt>
#!/bin/sh
# This script lauches fs2. If there is a file named $FS2_modmap (see below),
# backup the current modmap as $TMP_modmap and load it as the new modmap.
# The current modmap will be restored afterwards.

TMP_modmap="$HOME/xmodmap.tmp"
FS2_modmap="$HOME/.fs2_open/xmodmap"

FS2_OPEN_DIR=/usr/local/games/fs2_open

FS2_ARGS="-glow -spec -spec_exp 11 -spec_point 0.6 -spec_static 0.8 -spec_tube 0.4 -fps -jpgtga -ambient_factor 75 -targetinfo -nograb"

FS2_BIN="$FS2_OPEN_DIR/fs2_open_r"

die() {
echo "** Fatal error : $1" >&2
exit 1
}

cd $FS2_OPEN_DIR || die "Could not change directory to $FS2_OPEN_DIR"

# dump current xmodmap
[ -f "$FS2_modmap" ] && xmodmap -pke > $TMP_modmap

# load xmodmap
[ -f "$FS2_modmap" ] && xmodmap - < $FS2_modmap

# prepare to restore xmodmap on crash or exit
trap "xmodmap - < $TMP_modmap && rm $TMP_modmap" 0 2 3 4 9 11 15

# launch fs2
$FS2_BIN $FS2_ARGS $* || die "Error while running \"$FS2_BIN\" with arguments \"$FS2_ARGS\" ($?)"
</tt>

Adapt this script to your needs, and save it somewhere in your PATH - I for exemple use ''~/bin/freespace2''. Make it executable with chmod +x ''<file>''

That's it, now you can use fs2 with full control over your keyboard.

=== fs2_open dedicated X display ===
A good way of running games on Linux is having them run on a separate X display. The display you are most likely using now when reading this is 0:0. This display is normally used for whatever Window Manager/Desktop Environment(KDE,Gnome,*box,E) you've chosen. Sometimes fs2_open freezes and locks your X. This is of course very annoying as you have to CTRL+ALT+BACKSPACE to kill the X server, and in that, killing whatever program you had running besides fs2_open. The solution to this is to tell X to start fs2_open on another display. To to this we first need to tell X that you,the user on localhost, holds the permission to run on another display.
In a terminal, enter (NOT as root):
$ xauth list
A list that looks something like this should appear.
myuser@localhost ~ $ xauth list
localhost/unix:'''0''' MIT-MAGIC-COOKIE-1 14ec70e7c8cc835def61a04c92bbd50d
Let's look at that line, first up is your localhost, then unix, and last the display number,:0 (in bold). The rest is not really of interest.
Copy the whole line, but change the display value to 1 and paste it after the command ''xauth add'', like this:
$ xauth add localhost/unix:'''1''' MIT-MAGIC-COOKIE-1 14ec70e7c8cc835def61a04c92bbd50d
Run xauth list again. You should see a new entry.
myuser@localhost ~ $ xauth list
localhost/unix:'''0''' MIT-MAGIC-COOKIE-1 14ec70e7c8cc835def61a04c92bbd50d
localhost/unix:'''1''' MIT-MAGIC-COOKIE-1 14ec70e7c8cc835def61a04c92bbd50d
You now have permission to use display 1:0.
To start fs2_open in that display, use xinit.
$ xinit /path/to/fs2_open_r -foo -bar -- :1
The ''-- :1'' tells X that we want to start fs2_open on display 1. 
You can switch between display 0 and 1 with CTRL+ALT+F7 and CTRL+ALT+F8 respectively.

If you try this from an xterm (or a similar X terminal program) and obtain the error ''X: user not authorized to run the X server, aborting.'', the reason might be the file /etc/X11/Xwrapper.config. On my ubuntu machine, it contains the line

allowed_users=console

which means that only users logged in from a console terminal may start a new X server. However, on an xterm, you are on a '''virtual''' terminal and so the above does not work. A possibility is to change the allowed_users in the Xwrapper.config file to "anybody" (see man Xwrapper.config). However, this undermines X security. Another possibility is to start the xinit command from a console window (to which you can change with CTRL+ALT+F1-6).

''If someone knows of a good method to start fs2 on a second X display from an xterm without changing Xwrapper.config, please report it here.''

''A solution might be running xinit as root with sudo, and drop the root privileges in the startup script... Didn't tried, though.'' -- nodens

''xgame / xgame-gtk2 may be of use to achieve this as normal user, see http://xgame.tlhiv.org/ '' -- Lone_Wolf

[[Category:Source Code Project]]

Guide to FS Open on Linux

2006-09-13T22:23:02Z

Nodens: /* I18n and Key mapping problems */ typos

''This tutorial assumes some fundamental command line knowledge. ''
''As a rule of thumb, do not copy/paste commands without understanding them, especially as root. With great power comes great responsability.''
== Installing CVS ==
CVS stands for Concurrent Versions System and is a version control system used to record the changes in documents, such as source files. Developers use CVS so they can easily share their code changes among other developers. You will need this tool to download ("checkout" in CVS terminology) fs2_open from the CVS server.

'''Debian/Ubuntu''' users want to:
$ apt-get install cvs
'''Gentoo''' users want to:
$ emerge cvs
'''Novell SuSE''' users install CVS via YaST.

'''NOTE: Redhat, Mandrake/Mandriva, Slackware and all the other distros should go here too,'''
'''but we have no knowledge on how these work, so if you do, please enlighten us.'''

== Installing the nessesary development libraries ==
You will also need SDL, OpenAL, libvorbis and OpenGL(most likely provided with your video card driver) development packages. And of course the GCC compiler and required make tools.
 
'''Debian/Ubuntu''' users want to:
$ apt-get install libopenal-dev libvorbis-dev build-essential automake1.9 autoconf libsdl-dev
'''NOTE:''' The ''build-essential'' meta package installs GCC4. This should work, but if you feel safer with GCC 3.4(gcc-3.4), add it to the apt-get line above. 
'''Gentoo''' users want to:
$ emerge openal libvorbis libsdl
'''Novell SuSE''' users just install the mentioned packages and the devel-packages via YaST. If this works don't read further.
SuSE maybe has some dependency problems with the game TORCS, i.e. its special version of OpenAL, so you have to make a choice. If you still want to run FS2 open, go on here http://www.hard-light.net/wiki/index.php/Fs2_open_on_Linux#Compile_Errors

'''NOTE: Redhat, Mandrake,Slackware and all the other distros should go here too,'''
'''but we have no knowlage on how these work, so if you do, please enlighten us.'''

== Installing game data files ==

This tutorial deals primarily with providing you with an executable, but in order to play the game you also need the game data. Freespace 2 game data is available from a number of sources, see this thread: http://www.hard-light.net/forums/index.php/topic,38195.0.html

Note that if you use the retail CD, you'll need to extract the files and to copy them on your drive, reproducing the same layout as in a working win32 installation (just make sure every file is lowercase). This thread on the SCP forum has some more info on it : http://scp.indiegames.us/forum_viewtopic.php?3.282

There are two ways of doing this :
* use wine to install the game in the right directory, using the Setup.exe found on the first CD, or
* extract manually the files from the cd.

The second method is detailed below. The wine one is straightforward and you shouldn't need any specific instruction, but you'll have to fix permissions and lowercase the filename as well, so keep reading.

===Extracting data from CD===
====Installing unshield====

First, you need unshield from http://synce.sourceforge.net/synce/unshield.php

If you use debian, apt-get install unshield as root should do the trick. Else, try to find a package for your distribution, or if you don't, compile it yourself following the instructions provided on the website. Note you don't need to actually install it, just compile it and use it from the directory where you compiled it.

====Preparing directories====

* Create a directory for fs2_open, say, ''/usr/local/games/fs2_open'', with a ''data/movies'' and ''data/players'' subdirectories. Everything but user files and configuration will be in this directory. You'll probably need to be root or use sudo for most of the following commands if you use a global directory like the one in this example.

''Warning : Again, please double check the commands you run as root. A single typo could destroy your data. 'Remember what is said on the top of the page ? if not, go re-read it.''

<tt>~ $ mkdir -p /usr/local/games/fs2_open/data/movies /usr/local/games/fs2_open/data/players</tt>

====Extracting files====

* Use unshield to extract the groups from data1.cab (on the first cd) to a temporary directory; then move the files in your game directory :
<tt>~ $ mkdir /tmp/fs2
~ $ for group in "Basic Install Files" "Intel Anims" "Music Compressed" "High Res Files"; do unshield -d tmp/fs2/ -g "$group" -L -j x disk1/data1.cab && mv -v /tmp/fs2/*/* /home/data/jeux/fs2_open
~ $ unshield -d /usr/local/games/fs2_open/data/players -g "Hud Config Files" -L -j x data1.cab && mv -v /tmp/fs2/hud_config_files/* /home/data/jeux/fs2_open/data/players</tt>

* From the second CD, get the vp files and the movies files (I dont think the the mve file are really needed, you'll need the avi ones if you want the movies).
<tt>~ $ cp -vf *.vp /usr/local/games/fs2_open</tt>
<tt>~ $ mkdir -p /usr/local/games/fs2_open/data/movies/ && cp -vf *.MVE /usr/local/games/fs2_open/data/movies/</tt>
* Do the same for the third CD :
<tt>~ $ cp -vf *.vp /usr/local/games/fs2_open</tt>
<tt>~ $ cp -vf *.MVE /usr/local/games/fs2_open/data/movies/</tt>

You may notice that some files are on all three CD. This is because the games was meant to be run from CD. Don't bother.

=== Fixing Case and permissions ===
* You '''have''' to make sure everything is lowercase :
<tt>~ $ find /usr/local/games/fs2_open/ | rename -v 'y/A-Z/a-z/'</tt>

* Then, fix permissions :
<tt>~ $ find /usr/local/games/fs2_open -type d -exec chmod a+rx '{}' \;</tt>
<tt>~ $ find /usr/local/games/fs2_open -type f -exec chmod a+r '{}' \;</tt>

===MediaVP and Cutscenes===
You'll also need the mediavp from the SCP if you want the enhanced graphics. Get them at http://scp.indiegames.us.
If you want the cutscenes, you'll have to find the avi version of the MVE files, or to convert them yourself. They are not hard to find. When you have them, just put them in the data/movies directory. Again, make sure everything is lowercase.

That's it for the game data files, now it's time get the source !

== Using the source ==

=== CVS Checkout ===
Before you begin, make sure you have write permissions on your current working directory. Your /home/user/ directory is a pretty sure bet. I recommend that you create a permanent /home/user/src directory from which you run the CVS command, this way CVS will only update the files changed the next time you download the source and it's always nice to have things organized.

Now get the source. Run from a terminal:
$ cvs -d:pserver:anonymous:anonymous@warpcore.org:/home/fs2source/cvsroot login
and then
$ cvs -z3 -d:pserver:anonymous@warpcore.org:/home/fs2source/cvsroot co fs2_open
The first cvs command tells the CVS tool to first use a password file for authentication (pserver), that you are user "anonymous" with the password "anonymous" who wants to access warpcore.org's CVS repository "/home/fs2source/cvsroot" and login. The second command tells the CVS server on which we are now connected to that we want to checkout (co) the fs2_open module.
 
==== CVS Checkout and Update Script ====
The code on CVS is in a constant state of change, and bugs that exist one day may be gone the next. Because of this, you'll want to occasionally update to a newer version and recompile.
Running those cvs commands will fast grow to be a pain, so this little script was created to make your life easier. This script will checkout fs2_open if it can't find a fs2_open directory and update fs2_open, if it finds it.
The script will run until a successfull checkout or update has been achieved.
Copy and save this to a suitably named file like "get_fs2_open", and make it executable with the command, chmod +x <name of file>
#!/bin/bash
# CVS Checkout and Update Script for fs2_open
CVS_LINE="cvs -d:pserver:anonymous:anonymous@warpcore.org:/home/fs2source/cvsroot" # The cvs command
if [ "$UID" = 0 ]; then # check if user is root, and if so, echo a warning.
echo "You are root. If this is a checkout, all files \
will be created with root as the owner."
sleep 3
fi
if [ -e ./fs2_open ]; then # check if directory fs2_open exists
echo "Found fs2_open, We are updating an old checkout."
CVS_ATTEMPT=0 # This updates the checkout.
until [ $CVS_ATTEMPT = 1 ]; do
$CVS_LINE login && \
$CVS_LINE update fs2_open && \
let CVS_ATTEMPT=1
done
else
echo "No fs2_open found, This is a new checkout."
CVS_ATTEMPT=0 # This creates a new checkout.
until [ $CVS_ATTEMPT = 1 ]; do
$CVS_LINE login && \
$CVS_LINE co fs2_open && \
let CVS_ATTEMPT=1
done
fi

=== Pre-Compile Configuration ===

Before you compile you need to configure it for your system. In the directory you ran the CVS command from, a new directory has appear, namely fs2_open.
If your fs2_open is a completely new checkout, you will first need to run the autogen.sh script.
Run from inside your newly created fs2_open directory:
$ ./autogen.sh
autogen.sh is a script that will generate the required makefiles. You will see alot of "checking for this" and "checking for that", this is actually the "configure" script (which can be run with <tt>./configure</tt> if you need to change the options) examining and configuring fs2_open for your system. 
It is possible to give autogen.sh configure options as well, autogen.sh will pass them along to configure.

A full list of configure options can be found by running the configure script with the '--help' option.
$ ./configure --help

==== Optimizing fs2_open ====
Optimizing fs2_open might have little or no effect, or improve performance greatly, I honestly have no clue. 
A note of caution, if you are compiling a debug build, don't use the -fomit-frame-pointer CFLAG, it will make debugging impossible. 
You can specify your compiler flags with the configure script, se below.
$ ./configure CFLAGS="<your desired flags>"
If you got a Athlon-XP and want to play it safe, a good set of CFLAGS would be
$ ./configure CFLAGS="-march=athlon-xp -O3 -pipe -fomit-frame-pointer"
You should read up on CFLAGS and what they do before trying anything. I recommend you read through these links. 
http://gcc.gnu.org/onlinedocs/gcc-3.4.1/gcc/Optimize-Options.html 
http://linuxreviews.org/howtos/compiling/safe-cflags/ 
http://en.wikipedia.org/wiki/CFLAGS

=== Compiling ===

Run from within your fs2_open directory:
$ make
Sit back and enjoy gcc work its magic.

==== Simple Compile Script ====
It's alot easier to use a scripts when dealing with constantly changing code. Copy and save this to a suitably named file like "compile_fs2_open", and make it executable with the command, chmod +x <name of file>
This script assumes the CVS checkout directory fs2_open is pressent in the same directory as the script itself.
#!/bin/bash
# fs2_open Compile Script
# These are only examples, uncomment to enable optimization.
#MY_CFLAGS="-march=athlon-xp -O3 -pipe -fomit-frame-pointer -ftracer"
if [ -e ./fs2_open/ ]; then
cd fs2_open
if [ -e ./Makefile.in ]; then
make clean
./configure CFLAGS="$MY_CFLAGS" CXXFLAGS="$MY_CFLAGS"
make
else
./autogen.sh CFLAGS="$MY_CFLAGS" CXXFLAGS="$MY_CFLAGS"
make
fi
else
echo "No fs2_open directory found."
fi

You can add your options to the ./configure line.

== Using the Binaries ==

When the compile is done and if all went well, a binary executable will reside in the code directory ''fs2_open_r'' or ''fs2_open_d'' if you configured for a debug build. Copy the binary to directory where Freespace2 is installed, and you're all set to go.

=== Post-Compile Configuration ===
==== Changing Your Resolution ====
Odds are, you'll want to run fs2_open in a higher resolution than the default 640x480. Unfortunately, we Linux users don't have the swank launcher app that the Windows folks do. Instead, we'll be making a couple line changes to a config file. You will need to run fs2_open once before you can make the necessary changes, otherwise you won't have a configuration directory to work with.

Open up ~/.fs2_open/fs2_open.ini with the text editor of your choice (vi, EMACS, kwrite, gedit). You'll see something like the following:
[Default]
VideocardFs2open=OGL -(640x480)x16 bit
LastPlayer=MonkeyboyS
GammaD3D=1.0

To set fs2_open to use the highest setting possible on retail Freespace 2, change the VideocardFs2open to:
VideocardFs2open=OGL -(1024x768)x32 bit
You can set this to pretty much anything you want.

=== Creating a Start Up Script ===

In order to use all of the advanced engine features of fs2_open, you'll need to start the executable with a number of command line arguments. Instead of typing them in every time you want to start the game, why not create a script that does it for you?

Create a new file named start_freespace (or whatever you like) in your home directory. Open the file in your editor of choice, and paste the following:
#!/bin/bash
cd /path/to/your/freespace/
./fs2_open_r -spec -glow -mipmap -jpgtga -orbradar -mod Media_VP

''Note: You will need to edit this script before it will work properly. The second line must point to the directory where you installed fs2_open. You can also find a more elaborated script example below in the i18n section''

The last line starts fs2_open with a number of arguments that turn on extra features. In the example, the game will use specular highlights, glow-mapping, mipmapping, jpg and tga graphic files, the orb radar, and any MediaVPs installed to the /Media_VP directory. You should edit this line to use those features that your system supports.

More information about the available Command Line Arguments can be found at the [[Command-Line Reference]]

Once you've edited the file to your heart's content, make it executable:
$ chmod +x start_freespace

You can now type in start_freespace to start the game, or by clicking on start_freespace in your window manager. For convenience, you can copy it to your Desktop.

[http://www.hard-light.net/wiki/index.php/Command-Line_Reference See this] for more command line options.

==== Advanced Startup Script ====
This is nothing fancy, but it's all the command line options in a file.
#!/bin/bash
# Graphics
CMDLINE="-spec -env -glow -jpgtga -mipmap -2d_poof -missile_lighting"
CMDLINE="$CMDLINE -ambient_factor 75 -spec_exp 11 -spec_point 0.6"
CMDLINE="$CMDLINE -spec_static 0.8 -spec_tube 0.4"
#CMDLINE="$CMDLINE -pcx32 -cell -nomotiondebris -noscalevid -rlm -clipdist"
# Game Speed
CMDLINE="$CMDLINE -cache_bitmaps"
#CMDLINE=$CMDLINE -img2dds -no_vsync"
# HUD
CMDLINE="$CMDLINE -targetinfo -orbradar -ballistic_gauge -rearm_timer"
#CMDLINE="$CMDLINE -dualscanlines"
# Gameplay
CMDLINE="$CMDLINE -ship_choice_3d -3dwarp -warp_flash -fov 0.39"
#CMDLINE="$CMDLINE -UseNewAI -tbp -wcsaga"
# Audio
CMDLINE="$CMDLINE -snd_preload"
#CMDLINE="$CMDLINE -nosound -nomusic"
# Multiplayer
#CMDLINE="$CMDLINE -standalone -startgame -closed -restricted"
#CMDLINE="$CMDLINE -multilog -clientdamage -mpnoreturn"
# Troubleshooting
#CMDLINE="$CMDLINE -oldfire -nohtl -no_set_gamma -nomovies -noparseerrors"
#CMDLINE="$CMDLINE -safeloading -query_speech -d3d_bad_tsys -novbo -noibx -loadallweps"
# Experimental
CMDLINE="$CMDLINE -alpha_env"
#CMDLINE="$CMDLINE -decals -ingame_join"
# Development Tools
CMDLINE="$CMDLINE -fps"
#CMDLINE="$CMDLINE -pos -window -timerbar -coords -pofspew -tablecrcs -missioncrcs"
#CMDLINE="$CMDLINE -dis_collisions -dis_weapons -output_sexps"
#CMDLINE="$CMDLINE -output_scripting -nograb -show_mem_usage -stats"
# Mod
CMDLINE="$CMDLINE -mod mv368zeta"
./fs2_open_r $CMDLINE

== Troubleshooting ==
=== Compile Errors ===
==== Novell SuSE and the dependencies ====

If your SuSE gives you some errors like this, during the compile process, your OpenAL version is too old or corrupted.
sound/ds.cpp: In function 'int ds_init(int, int, unsigned int, short unsigned int)':
sound/ds.cpp:1790: error: invalid conversion from 'const char*' to 'const ALubyte*'
sound/ds.cpp:1790: error: initializing argument 1 of 'ALboolean alIsExtensionPresent(const ALubyte*)'
You have to remove all OpenAL-packages via YaST, you may also want to remove TORCS, too, it won't run anymore after this.
Unfortunately there is no repository with a newer version for this distro, yet, so you have to use a source-package for Fedora. You get it here http://download.fedora.redhat.com/pub/fedora/linux/extras/5/SRPMS/openal-0.0.9-0.6.20060204cvs.fc5.src.rpm
The version may change, so you better check this.
Now make sure, that TexInfo is installed. Then enter:
$ rpmbuild --rebuild --target=i686 <name-of-your-package>.fc5.src.rpm
If it builds without errors, you will find an OpenAL*.rpm and an OpenAL*-devel.rpm in <tt>/usr/src/packages/RPMS/i686/</tt>. Install both and go back to your fs_open directory again. Cause the environment has changed now, you better type:
$ make clean
$ ./configure [options]
$ make
Then you're done.

==== SDL: undefined reference to... ====

This is a SDL installing issue, since it's trying to link against the static lib and not the dynamic one.
First check where <tt>/usr/lib/libSDL.so</tt> is linked to, then search this very file.
$ ls -l /usr/lib/libSDL.so
lrwxrwxrwx 1 root root 28 2006-09-06 00:10 /usr/lib/libSDL.so -> /usr/lib/libSDL-1.2.so.0.7.1
$ ls /usr/lib/ | grep libSDL-1.2.so.0.7
libSDL-1.2.so.0.7.2
If they are not the same (like in this case), you just make a new link. Type as root:
# ln -s /usr/lib/libSDL-1.2.so.0.7.2 /usr/lib/libSDL.so
Of course you must change some figures, so it matches on your system.

==== Missing -lGLU compile error ====

On some Linux distributions (''Slackware'' for instance), compiling fails because a GL related library doesn't have a link in the <tt>/usr/lib</tt> directory. If the compile fails because it can't find <tt>-lGLU</tt>, here are two ways to fix it:

===== Solution as Root =====

If you have root access to the system, you can create a link to the library in question with just a little bit of command line magic. Go to a console and enter:

$ ln -s /usr/X11R6/lib/libGLU.so /usr/lib/libGLU.so

After that, you can run make again and it should finish compiling.

===== Solution as a Non-Root user =====

You don't have root access? Never fear, we can still fix the problem. It'll just be a tad more difficult.

Navigate to the <tt>fs2_open/code</tt> directory and locate a file named <tt>Makefile</tt> (not Makefile.rm or Makefile.in or Makefile.anything). Open it in your favorite text editor and make the following changes.

Find this line (line 457 in mine):
FS2_LDFLAGS = -L/usr/lib -Wl,-rpath,/usr/lib -lSDL -lpthread -lGL -lGLU -lopenal -logg -lvorbis -lvorbisfile

And replace it with this:
FS2_LDFLAGS = -L/usr/lib -Wl,-rpath,/usr/lib -lSDL -lpthread -lGL -lopenal -logg -lvorbis -lvorbisfile -L/usr/X11R6/lib -lGLU

Also find this one (line 565 in mine):
AM_LDFLAGS = -g -L/usr/lib -Wl,-rpath,/usr/lib -lSDL -lpthread -lGL -lGLU -lopenal -logg -lvorbis -lvorbisfile

And replace it with this:
AM_LDFLAGS = -g -L/usr/lib -Wl,-rpath,/usr/lib -lSDL -lpthread -lGL -lopenal -logg -lvorbis -lvorbisfile -L/usr/X11R6/lib -lGLU

Then run <tt>make</tt> from the <tt>fs2_open</tt> directory, and watch the magic happen.

==== glBindBufferARB feature missing ====
''If this is the actual solution to this problem remains to be seen.'' 
''So far, only people using Debian stable are affected by this.'' 
''So we need adventurus Debian users to confirm.'' 
''I can confirm that the APT-Pinning works, can not confirm compile thou. -- ni1s'' 
checking for glBindBufferARB in -lGL... no
configure: error: *** OpenGL version does not have the required features!! (ie.glBindBufferARB()) ***
This error appears if the installed Mesa development library is to old.

On Debian stable branch the xlibmesa-gl-dev package holds version 4.3.0. 
The xlibmesa-gl-dev package on ''testning'' is version 6.9.0.

'''Possible solution:''' 
First set /etc/apt/sources.list to include the testing branch. Add:
#Testing
deb http://ftp.us.debian.org/debian testing main non-free contrib
deb http://non-us.debian.org/debian-non-US testing/non-US main contrib non-free
Your sources.list might have these lines already, if so, you should be okej.

Your /etc/apt/preferences file should look like this
Package: *
Pin: release a=stable
Pin-Priority: 700

Package: *
Pin: release a=testing
Pin-Priority: 650

Package: *
Pin: release a=unstable
Pin-Priority: 600

Add to that file:
Package: xlibmesa-gl-dev
Pin: release a=testing
Pin-Priority: 800
Note that the Pin-Priority of xlibmesa-gl-dev here is higher than the Pin-Priority on 'stable'. As a result of this APT get will prioritize the xlibmesa-gl-dev from testing and leave the rest of the system on stable.
This is called apt-pinning.

Now that APT knows what xlibmesa-gl-dev to prioritze, install it again:
$ apt-get install xlibmesa-gl-dev

If you are using nVidia's nvidia-kernel and glx packages, a simple:
$ apt-get install nvidia-glx-dev
should suffice. No need to mess around with APT-pinning.

=== Runtime Errors and common problems ===
==== ERROR: "Web cursor bitmap not found." ====
ERROR: "Web cursor bitmap not found. This usually means that the executable is being run outside the directory
you installed Freespace2 to. Please move the executable to that directory and try again" at graphics/2d.cpp:1402
A common error. This happens when fs2_open can't find the .vp files or that your user doesn't have the permissions to access them. If you are using a start up script([http://www.hard-light.net/wiki/index.php/Fs2_open_on_Linux#Creating_a_Start_Up_Script like the one found here]) it's most likly the a permission problem.
Have your user take owenership of the .vp files, run as root:
$ chown <user> /path/to/vpfiles/ -R

=== I18n and Key mapping problems ===
''Me, being a Swede, need to use this aswell, especially for the grave key(`), but I also want to use a second X display. There is a way to tell xmodmap to use the new set of keys on the second X display, and thus eliminating the need for a temp. keymap table as it dies with the second display when exiting fs2_open, never touching the keymap table on display 0. We should dig that info up and write a super-start script. --ni1s'' 
Ok, imagine that like me you don't have an us keyboard but a french one (or anything). Well, you probably have problems mapping some keys or even using the default mapping.

Actually, the problem is fs2_open does not take modifiers into account, as it uses them internally as modifiers for keys, and it won't accept non-us charset either.

On a french keyboard layout, the numbers ''1 2 3 4 5 6 7 8 9 0'' are on the same keys than on a US layout, but you have to press shift to use them. The primary function for theses keys are ''& Ã© " ' ( - Ã¨ _ Ã§ Ã )''. These characters won't be accepted by freespace, and if you press shift to get a number, it won't work. This can be a problem, as theses keys are needed to use the communication system, and cannot be bound to anything. Also, as you won't get access some keys on your keyboard, it will be difficult to map every command on a key, or you'll have to use modifiers for nearly each key.

However, there is a solution. You can tell X to remap the keyboard before launching the game, and restore your normal keymap afterwards.

For exemple, I map 123456790 to &é"'(-è_çà keys so I can use the communication system, and I put , and ; on the Alt-Gr and Menu keys for convenience, as I binded thoses keys to next primary weapon and next secondary weapon.

To do this, I use a slightly enhanced startup script, which I put in ~/bin (this directory is in my path), together with a customized xmodmap.

* First, dump your current xmodmap :

<tt>~ $ xmodmap -pke > ~/xmodmap.current</tt>

* Then edit it with your favorite text editor. You'll see a bunch of lines looking like this :

<tt>
keycode 8 =
keycode 9 = Escape
keycode 10 = 1 ampersand onesuperior exclamdown onesuperior exclamdown
</tt>

The syntax is ''keycode <number> = <symbol list>''.

Use '''xev''' to scan the keycodes. The symbols are defined in ''/usr/include/X11/keysymdef.h''. Just make sure you write them without the ''XK_'' prefix. You'll find more information about xmodmap in the xmodmap manual page.

Just modify the keys you need, and be patient. This can be a long process. Test it with xmodmap :

<tt>~ $ xmodmap - < <filename></tt>

But don't forget to have your previous keymap at hand to recover your settings !
If you mess everything up, just restart X. Your default keymap will be applied from the X configuration.

Here is my own fs2 xmodmap, derived from fr-latin1 as described above. Feel free to use it if you're too lazy to modify your own. However, it may not fit with your needs. You may always use it as an exemple, thougt.
* http://clement.hermann.free.fr/fs2/xmodmap

Then, when the file is modified at your liking, just save it as '''~/.fs2_open/xmodmap'''

We'll start fs2_open with a slightly more elaborate startup script which will backup/apply/restore the keymap in addition of running the games with some options in the right directory.

<tt>
#!/bin/sh
# This script lauches fs2. If there is a file named $FS2_modmap (see below),
# backup the current modmap as $TMP_modmap and load it as the new modmap.
# The current modmap will be restored afterwards.

TMP_modmap="$HOME/xmodmap.tmp"
FS2_modmap="$HOME/.fs2_open/xmodmap"

FS2_OPEN_DIR=/usr/local/games/fs2_open

FS2_ARGS="-glow -spec -spec_exp 11 -spec_point 0.6 -spec_static 0.8 -spec_tube 0.4 -fps -jpgtga -ambient_factor 75 -targetinfo -nograb"

FS2_BIN="$FS2_OPEN_DIR/fs2_open_r"

die() {
echo "** Fatal error : $1" >&2
exit 1
}

cd $FS2_OPEN_DIR || die "Could not change directory to $FS2_OPEN_DIR"

# dump current xmodmap
[ -f "$FS2_modmap" ] && xmodmap -pke > $TMP_modmap

# load xmodmap
[ -f "$FS2_modmap" ] && xmodmap - < $FS2_modmap

# prepare to restore xmodmap on crash or exit
trap "xmodmap - < $TMP_modmap && rm $TMP_modmap" 0 2 3 4 9 11 15

# launch fs2
$FS2_BIN $FS2_ARGS $* || die "Error while running \"$FS2_BIN\" with arguments \"$FS2_ARGS\" ($?)"
</tt>

Adapt this script to your needs, and save it somewhere in your PATH - I for exemple use ''~/bin/freespace2''. Make it executable with chmod +x ''<file>''

That's it, now you can use fs2 with full control over your keyboard.

=== fs2_open freezes X ===
A good way of running games on Linux is having them run on a separate X display. The display you are most likely using now when reading this is 0:0. This display is normally used for whatever Window Manager/Desktop Environment(KDE,Gnome,*box,E) you've chosen. Sometimes fs2_open freezes and locks your X. This is of course very annoying as you have to CTRL+ALT+BACKSPACE to kill the X server, and in that, killing whatever program you had running besides fs2_open. The solution to this is to tell X to start fs2_open on another display. To to this we first need to tell X that you,the user on localhost, holds the permission to run on another display.
In a terminal, enter (NOT as root):
$ xauth list
A list that looks something like this should appear.
myuser@localhost ~ $ xauth list
localhost/unix:'''0''' MIT-MAGIC-COOKIE-1 14ec70e7c8cc835def61a04c92bbd50d
Let's look at that line, first up is your localhost, then unix, and last the display number,:0 (in bold). The rest is not really of interest.
Copy the whole line, but change the display value to 1 and paste it after the command ''xauth add'', like this:
$ xauth add localhost/unix:'''1''' MIT-MAGIC-COOKIE-1 14ec70e7c8cc835def61a04c92bbd50d
Run xauth list again. You should see a new entry.
myuser@localhost ~ $ xauth list
localhost/unix:'''0''' MIT-MAGIC-COOKIE-1 14ec70e7c8cc835def61a04c92bbd50d
localhost/unix:'''1''' MIT-MAGIC-COOKIE-1 14ec70e7c8cc835def61a04c92bbd50d
You now have permission to use display 1:0.
To start fs2_open in that display, use xinit.
$ xinit /path/to/fs2_open_r -foo -bar -- :1
The ''-- :1'' tells X that we want to start fs2_open on display 1. 
You can switch between display 0 and 1 with CTRL+ALT+F7 and CTRL+ALT+F8 respectively.

If you try this from an xterm (or a similar X terminal program) and obtain the error ''X: user not authorized to run the X server, aborting.'', the reason might be the file /etc/X11/Xwrapper.config. On my ubuntu machine, it contains the line

allowed_users=console

which means that only users logged in from a console terminal may start a new X server. However, on an xterm, you are on a '''virtual''' terminal and so the above does not work. A possibility is to change the allowed_users in the Xwrapper.config file to "anybody" (see man Xwrapper.config). However, this undermines X security. Another possibility is to start the xinit command from a console window (to which you can change with CTRL+ALT+F1-6).

''If someone knows of a good method to start fs2 on a second X display from an xterm without changing Xwrapper.config, please report it here.''

''A solution might be running xinit as root with sudo, and drop the root privileges in the startup script... Didn't tried, though.'' -- nodens

[[Category:Source Code Project]]

Guide to FS Open on Linux

2006-09-13T22:21:28Z

Nodens: /* I18n and Key mapping problems */ typo and charset problems

''This tutorial assumes some fundamental command line knowledge. ''
''As a rule of thumb, do not copy/paste commands without understanding them, especially as root. With great power comes great responsability.''
== Installing CVS ==
CVS stands for Concurrent Versions System and is a version control system used to record the changes in documents, such as source files. Developers use CVS so they can easily share their code changes among other developers. You will need this tool to download ("checkout" in CVS terminology) fs2_open from the CVS server.

'''Debian/Ubuntu''' users want to:
$ apt-get install cvs
'''Gentoo''' users want to:
$ emerge cvs
'''Novell SuSE''' users install CVS via YaST.

'''NOTE: Redhat, Mandrake/Mandriva, Slackware and all the other distros should go here too,'''
'''but we have no knowledge on how these work, so if you do, please enlighten us.'''

== Installing the nessesary development libraries ==
You will also need SDL, OpenAL, libvorbis and OpenGL(most likely provided with your video card driver) development packages. And of course the GCC compiler and required make tools.
 
'''Debian/Ubuntu''' users want to:
$ apt-get install libopenal-dev libvorbis-dev build-essential automake1.9 autoconf libsdl-dev
'''NOTE:''' The ''build-essential'' meta package installs GCC4. This should work, but if you feel safer with GCC 3.4(gcc-3.4), add it to the apt-get line above. 
'''Gentoo''' users want to:
$ emerge openal libvorbis libsdl
'''Novell SuSE''' users just install the mentioned packages and the devel-packages via YaST. If this works don't read further.
SuSE maybe has some dependency problems with the game TORCS, i.e. its special version of OpenAL, so you have to make a choice. If you still want to run FS2 open, go on here http://www.hard-light.net/wiki/index.php/Fs2_open_on_Linux#Compile_Errors

'''NOTE: Redhat, Mandrake,Slackware and all the other distros should go here too,'''
'''but we have no knowlage on how these work, so if you do, please enlighten us.'''

== Installing game data files ==

This tutorial deals primarily with providing you with an executable, but in order to play the game you also need the game data. Freespace 2 game data is available from a number of sources, see this thread: http://www.hard-light.net/forums/index.php/topic,38195.0.html

Note that if you use the retail CD, you'll need to extract the files and to copy them on your drive, reproducing the same layout as in a working win32 installation (just make sure every file is lowercase). This thread on the SCP forum has some more info on it : http://scp.indiegames.us/forum_viewtopic.php?3.282

There are two ways of doing this :
* use wine to install the game in the right directory, using the Setup.exe found on the first CD, or
* extract manually the files from the cd.

The second method is detailed below. The wine one is straightforward and you shouldn't need any specific instruction, but you'll have to fix permissions and lowercase the filename as well, so keep reading.

===Extracting data from CD===
====Installing unshield====

First, you need unshield from http://synce.sourceforge.net/synce/unshield.php

If you use debian, apt-get install unshield as root should do the trick. Else, try to find a package for your distribution, or if you don't, compile it yourself following the instructions provided on the website. Note you don't need to actually install it, just compile it and use it from the directory where you compiled it.

====Preparing directories====

* Create a directory for fs2_open, say, ''/usr/local/games/fs2_open'', with a ''data/movies'' and ''data/players'' subdirectories. Everything but user files and configuration will be in this directory. You'll probably need to be root or use sudo for most of the following commands if you use a global directory like the one in this example.

''Warning : Again, please double check the commands you run as root. A single typo could destroy your data. 'Remember what is said on the top of the page ? if not, go re-read it.''

<tt>~ $ mkdir -p /usr/local/games/fs2_open/data/movies /usr/local/games/fs2_open/data/players</tt>

====Extracting files====

* Use unshield to extract the groups from data1.cab (on the first cd) to a temporary directory; then move the files in your game directory :
<tt>~ $ mkdir /tmp/fs2
~ $ for group in "Basic Install Files" "Intel Anims" "Music Compressed" "High Res Files"; do unshield -d tmp/fs2/ -g "$group" -L -j x disk1/data1.cab && mv -v /tmp/fs2/*/* /home/data/jeux/fs2_open
~ $ unshield -d /usr/local/games/fs2_open/data/players -g "Hud Config Files" -L -j x data1.cab && mv -v /tmp/fs2/hud_config_files/* /home/data/jeux/fs2_open/data/players</tt>

* From the second CD, get the vp files and the movies files (I dont think the the mve file are really needed, you'll need the avi ones if you want the movies).
<tt>~ $ cp -vf *.vp /usr/local/games/fs2_open</tt>
<tt>~ $ mkdir -p /usr/local/games/fs2_open/data/movies/ && cp -vf *.MVE /usr/local/games/fs2_open/data/movies/</tt>
* Do the same for the third CD :
<tt>~ $ cp -vf *.vp /usr/local/games/fs2_open</tt>
<tt>~ $ cp -vf *.MVE /usr/local/games/fs2_open/data/movies/</tt>

You may notice that some files are on all three CD. This is because the games was meant to be run from CD. Don't bother.

=== Fixing Case and permissions ===
* You '''have''' to make sure everything is lowercase :
<tt>~ $ find /usr/local/games/fs2_open/ | rename -v 'y/A-Z/a-z/'</tt>

* Then, fix permissions :
<tt>~ $ find /usr/local/games/fs2_open -type d -exec chmod a+rx '{}' \;</tt>
<tt>~ $ find /usr/local/games/fs2_open -type f -exec chmod a+r '{}' \;</tt>

===MediaVP and Cutscenes===
You'll also need the mediavp from the SCP if you want the enhanced graphics. Get them at http://scp.indiegames.us.
If you want the cutscenes, you'll have to find the avi version of the MVE files, or to convert them yourself. They are not hard to find. When you have them, just put them in the data/movies directory. Again, make sure everything is lowercase.

That's it for the game data files, now it's time get the source !

== Using the source ==

=== CVS Checkout ===
Before you begin, make sure you have write permissions on your current working directory. Your /home/user/ directory is a pretty sure bet. I recommend that you create a permanent /home/user/src directory from which you run the CVS command, this way CVS will only update the files changed the next time you download the source and it's always nice to have things organized.

Now get the source. Run from a terminal:
$ cvs -d:pserver:anonymous:anonymous@warpcore.org:/home/fs2source/cvsroot login
and then
$ cvs -z3 -d:pserver:anonymous@warpcore.org:/home/fs2source/cvsroot co fs2_open
The first cvs command tells the CVS tool to first use a password file for authentication (pserver), that you are user "anonymous" with the password "anonymous" who wants to access warpcore.org's CVS repository "/home/fs2source/cvsroot" and login. The second command tells the CVS server on which we are now connected to that we want to checkout (co) the fs2_open module.
 
==== CVS Checkout and Update Script ====
The code on CVS is in a constant state of change, and bugs that exist one day may be gone the next. Because of this, you'll want to occasionally update to a newer version and recompile.
Running those cvs commands will fast grow to be a pain, so this little script was created to make your life easier. This script will checkout fs2_open if it can't find a fs2_open directory and update fs2_open, if it finds it.
The script will run until a successfull checkout or update has been achieved.
Copy and save this to a suitably named file like "get_fs2_open", and make it executable with the command, chmod +x <name of file>
#!/bin/bash
# CVS Checkout and Update Script for fs2_open
CVS_LINE="cvs -d:pserver:anonymous:anonymous@warpcore.org:/home/fs2source/cvsroot" # The cvs command
if [ "$UID" = 0 ]; then # check if user is root, and if so, echo a warning.
echo "You are root. If this is a checkout, all files \
will be created with root as the owner."
sleep 3
fi
if [ -e ./fs2_open ]; then # check if directory fs2_open exists
echo "Found fs2_open, We are updating an old checkout."
CVS_ATTEMPT=0 # This updates the checkout.
until [ $CVS_ATTEMPT = 1 ]; do
$CVS_LINE login && \
$CVS_LINE update fs2_open && \
let CVS_ATTEMPT=1
done
else
echo "No fs2_open found, This is a new checkout."
CVS_ATTEMPT=0 # This creates a new checkout.
until [ $CVS_ATTEMPT = 1 ]; do
$CVS_LINE login && \
$CVS_LINE co fs2_open && \
let CVS_ATTEMPT=1
done
fi

=== Pre-Compile Configuration ===

Before you compile you need to configure it for your system. In the directory you ran the CVS command from, a new directory has appear, namely fs2_open.
If your fs2_open is a completely new checkout, you will first need to run the autogen.sh script.
Run from inside your newly created fs2_open directory:
$ ./autogen.sh
autogen.sh is a script that will generate the required makefiles. You will see alot of "checking for this" and "checking for that", this is actually the "configure" script (which can be run with <tt>./configure</tt> if you need to change the options) examining and configuring fs2_open for your system. 
It is possible to give autogen.sh configure options as well, autogen.sh will pass them along to configure.

A full list of configure options can be found by running the configure script with the '--help' option.
$ ./configure --help

==== Optimizing fs2_open ====
Optimizing fs2_open might have little or no effect, or improve performance greatly, I honestly have no clue. 
A note of caution, if you are compiling a debug build, don't use the -fomit-frame-pointer CFLAG, it will make debugging impossible. 
You can specify your compiler flags with the configure script, se below.
$ ./configure CFLAGS="<your desired flags>"
If you got a Athlon-XP and want to play it safe, a good set of CFLAGS would be
$ ./configure CFLAGS="-march=athlon-xp -O3 -pipe -fomit-frame-pointer"
You should read up on CFLAGS and what they do before trying anything. I recommend you read through these links. 
http://gcc.gnu.org/onlinedocs/gcc-3.4.1/gcc/Optimize-Options.html 
http://linuxreviews.org/howtos/compiling/safe-cflags/ 
http://en.wikipedia.org/wiki/CFLAGS

=== Compiling ===

Run from within your fs2_open directory:
$ make
Sit back and enjoy gcc work its magic.

==== Simple Compile Script ====
It's alot easier to use a scripts when dealing with constantly changing code. Copy and save this to a suitably named file like "compile_fs2_open", and make it executable with the command, chmod +x <name of file>
This script assumes the CVS checkout directory fs2_open is pressent in the same directory as the script itself.
#!/bin/bash
# fs2_open Compile Script
# These are only examples, uncomment to enable optimization.
#MY_CFLAGS="-march=athlon-xp -O3 -pipe -fomit-frame-pointer -ftracer"
if [ -e ./fs2_open/ ]; then
cd fs2_open
if [ -e ./Makefile.in ]; then
make clean
./configure CFLAGS="$MY_CFLAGS" CXXFLAGS="$MY_CFLAGS"
make
else
./autogen.sh CFLAGS="$MY_CFLAGS" CXXFLAGS="$MY_CFLAGS"
make
fi
else
echo "No fs2_open directory found."
fi

You can add your options to the ./configure line.

== Using the Binaries ==

When the compile is done and if all went well, a binary executable will reside in the code directory ''fs2_open_r'' or ''fs2_open_d'' if you configured for a debug build. Copy the binary to directory where Freespace2 is installed, and you're all set to go.

=== Post-Compile Configuration ===
==== Changing Your Resolution ====
Odds are, you'll want to run fs2_open in a higher resolution than the default 640x480. Unfortunately, we Linux users don't have the swank launcher app that the Windows folks do. Instead, we'll be making a couple line changes to a config file. You will need to run fs2_open once before you can make the necessary changes, otherwise you won't have a configuration directory to work with.

Open up ~/.fs2_open/fs2_open.ini with the text editor of your choice (vi, EMACS, kwrite, gedit). You'll see something like the following:
[Default]
VideocardFs2open=OGL -(640x480)x16 bit
LastPlayer=MonkeyboyS
GammaD3D=1.0

To set fs2_open to use the highest setting possible on retail Freespace 2, change the VideocardFs2open to:
VideocardFs2open=OGL -(1024x768)x32 bit
You can set this to pretty much anything you want.

=== Creating a Start Up Script ===

In order to use all of the advanced engine features of fs2_open, you'll need to start the executable with a number of command line arguments. Instead of typing them in every time you want to start the game, why not create a script that does it for you?

Create a new file named start_freespace (or whatever you like) in your home directory. Open the file in your editor of choice, and paste the following:
#!/bin/bash
cd /path/to/your/freespace/
./fs2_open_r -spec -glow -mipmap -jpgtga -orbradar -mod Media_VP

''Note: You will need to edit this script before it will work properly. The second line must point to the directory where you installed fs2_open. You can also find a more elaborated script example below in the i18n section''

The last line starts fs2_open with a number of arguments that turn on extra features. In the example, the game will use specular highlights, glow-mapping, mipmapping, jpg and tga graphic files, the orb radar, and any MediaVPs installed to the /Media_VP directory. You should edit this line to use those features that your system supports.

More information about the available Command Line Arguments can be found at the [[Command-Line Reference]]

Once you've edited the file to your heart's content, make it executable:
$ chmod +x start_freespace

You can now type in start_freespace to start the game, or by clicking on start_freespace in your window manager. For convenience, you can copy it to your Desktop.

[http://www.hard-light.net/wiki/index.php/Command-Line_Reference See this] for more command line options.

==== Advanced Startup Script ====
This is nothing fancy, but it's all the command line options in a file.
#!/bin/bash
# Graphics
CMDLINE="-spec -env -glow -jpgtga -mipmap -2d_poof -missile_lighting"
CMDLINE="$CMDLINE -ambient_factor 75 -spec_exp 11 -spec_point 0.6"
CMDLINE="$CMDLINE -spec_static 0.8 -spec_tube 0.4"
#CMDLINE="$CMDLINE -pcx32 -cell -nomotiondebris -noscalevid -rlm -clipdist"
# Game Speed
CMDLINE="$CMDLINE -cache_bitmaps"
#CMDLINE=$CMDLINE -img2dds -no_vsync"
# HUD
CMDLINE="$CMDLINE -targetinfo -orbradar -ballistic_gauge -rearm_timer"
#CMDLINE="$CMDLINE -dualscanlines"
# Gameplay
CMDLINE="$CMDLINE -ship_choice_3d -3dwarp -warp_flash -fov 0.39"
#CMDLINE="$CMDLINE -UseNewAI -tbp -wcsaga"
# Audio
CMDLINE="$CMDLINE -snd_preload"
#CMDLINE="$CMDLINE -nosound -nomusic"
# Multiplayer
#CMDLINE="$CMDLINE -standalone -startgame -closed -restricted"
#CMDLINE="$CMDLINE -multilog -clientdamage -mpnoreturn"
# Troubleshooting
#CMDLINE="$CMDLINE -oldfire -nohtl -no_set_gamma -nomovies -noparseerrors"
#CMDLINE="$CMDLINE -safeloading -query_speech -d3d_bad_tsys -novbo -noibx -loadallweps"
# Experimental
CMDLINE="$CMDLINE -alpha_env"
#CMDLINE="$CMDLINE -decals -ingame_join"
# Development Tools
CMDLINE="$CMDLINE -fps"
#CMDLINE="$CMDLINE -pos -window -timerbar -coords -pofspew -tablecrcs -missioncrcs"
#CMDLINE="$CMDLINE -dis_collisions -dis_weapons -output_sexps"
#CMDLINE="$CMDLINE -output_scripting -nograb -show_mem_usage -stats"
# Mod
CMDLINE="$CMDLINE -mod mv368zeta"
./fs2_open_r $CMDLINE

== Troubleshooting ==
=== Compile Errors ===
==== Novell SuSE and the dependencies ====

If your SuSE gives you some errors like this, during the compile process, your OpenAL version is too old or corrupted.
sound/ds.cpp: In function 'int ds_init(int, int, unsigned int, short unsigned int)':
sound/ds.cpp:1790: error: invalid conversion from 'const char*' to 'const ALubyte*'
sound/ds.cpp:1790: error: initializing argument 1 of 'ALboolean alIsExtensionPresent(const ALubyte*)'
You have to remove all OpenAL-packages via YaST, you may also want to remove TORCS, too, it won't run anymore after this.
Unfortunately there is no repository with a newer version for this distro, yet, so you have to use a source-package for Fedora. You get it here http://download.fedora.redhat.com/pub/fedora/linux/extras/5/SRPMS/openal-0.0.9-0.6.20060204cvs.fc5.src.rpm
The version may change, so you better check this.
Now make sure, that TexInfo is installed. Then enter:
$ rpmbuild --rebuild --target=i686 <name-of-your-package>.fc5.src.rpm
If it builds without errors, you will find an OpenAL*.rpm and an OpenAL*-devel.rpm in <tt>/usr/src/packages/RPMS/i686/</tt>. Install both and go back to your fs_open directory again. Cause the environment has changed now, you better type:
$ make clean
$ ./configure [options]
$ make
Then you're done.

==== SDL: undefined reference to... ====

This is a SDL installing issue, since it's trying to link against the static lib and not the dynamic one.
First check where <tt>/usr/lib/libSDL.so</tt> is linked to, then search this very file.
$ ls -l /usr/lib/libSDL.so
lrwxrwxrwx 1 root root 28 2006-09-06 00:10 /usr/lib/libSDL.so -> /usr/lib/libSDL-1.2.so.0.7.1
$ ls /usr/lib/ | grep libSDL-1.2.so.0.7
libSDL-1.2.so.0.7.2
If they are not the same (like in this case), you just make a new link. Type as root:
# ln -s /usr/lib/libSDL-1.2.so.0.7.2 /usr/lib/libSDL.so
Of course you must change some figures, so it matches on your system.

==== Missing -lGLU compile error ====

On some Linux distributions (''Slackware'' for instance), compiling fails because a GL related library doesn't have a link in the <tt>/usr/lib</tt> directory. If the compile fails because it can't find <tt>-lGLU</tt>, here are two ways to fix it:

===== Solution as Root =====

If you have root access to the system, you can create a link to the library in question with just a little bit of command line magic. Go to a console and enter:

$ ln -s /usr/X11R6/lib/libGLU.so /usr/lib/libGLU.so

After that, you can run make again and it should finish compiling.

===== Solution as a Non-Root user =====

You don't have root access? Never fear, we can still fix the problem. It'll just be a tad more difficult.

Navigate to the <tt>fs2_open/code</tt> directory and locate a file named <tt>Makefile</tt> (not Makefile.rm or Makefile.in or Makefile.anything). Open it in your favorite text editor and make the following changes.

Find this line (line 457 in mine):
FS2_LDFLAGS = -L/usr/lib -Wl,-rpath,/usr/lib -lSDL -lpthread -lGL -lGLU -lopenal -logg -lvorbis -lvorbisfile

And replace it with this:
FS2_LDFLAGS = -L/usr/lib -Wl,-rpath,/usr/lib -lSDL -lpthread -lGL -lopenal -logg -lvorbis -lvorbisfile -L/usr/X11R6/lib -lGLU

Also find this one (line 565 in mine):
AM_LDFLAGS = -g -L/usr/lib -Wl,-rpath,/usr/lib -lSDL -lpthread -lGL -lGLU -lopenal -logg -lvorbis -lvorbisfile

And replace it with this:
AM_LDFLAGS = -g -L/usr/lib -Wl,-rpath,/usr/lib -lSDL -lpthread -lGL -lopenal -logg -lvorbis -lvorbisfile -L/usr/X11R6/lib -lGLU

Then run <tt>make</tt> from the <tt>fs2_open</tt> directory, and watch the magic happen.

==== glBindBufferARB feature missing ====
''If this is the actual solution to this problem remains to be seen.'' 
''So far, only people using Debian stable are affected by this.'' 
''So we need adventurus Debian users to confirm.'' 
''I can confirm that the APT-Pinning works, can not confirm compile thou. -- ni1s'' 
checking for glBindBufferARB in -lGL... no
configure: error: *** OpenGL version does not have the required features!! (ie.glBindBufferARB()) ***
This error appears if the installed Mesa development library is to old.

On Debian stable branch the xlibmesa-gl-dev package holds version 4.3.0. 
The xlibmesa-gl-dev package on ''testning'' is version 6.9.0.

'''Possible solution:''' 
First set /etc/apt/sources.list to include the testing branch. Add:
#Testing
deb http://ftp.us.debian.org/debian testing main non-free contrib
deb http://non-us.debian.org/debian-non-US testing/non-US main contrib non-free
Your sources.list might have these lines already, if so, you should be okej.

Your /etc/apt/preferences file should look like this
Package: *
Pin: release a=stable
Pin-Priority: 700

Package: *
Pin: release a=testing
Pin-Priority: 650

Package: *
Pin: release a=unstable
Pin-Priority: 600

Add to that file:
Package: xlibmesa-gl-dev
Pin: release a=testing
Pin-Priority: 800
Note that the Pin-Priority of xlibmesa-gl-dev here is higher than the Pin-Priority on 'stable'. As a result of this APT get will prioritize the xlibmesa-gl-dev from testing and leave the rest of the system on stable.
This is called apt-pinning.

Now that APT knows what xlibmesa-gl-dev to prioritze, install it again:
$ apt-get install xlibmesa-gl-dev

If you are using nVidia's nvidia-kernel and glx packages, a simple:
$ apt-get install nvidia-glx-dev
should suffice. No need to mess around with APT-pinning.

=== Runtime Errors and common problems ===
==== ERROR: "Web cursor bitmap not found." ====
ERROR: "Web cursor bitmap not found. This usually means that the executable is being run outside the directory
you installed Freespace2 to. Please move the executable to that directory and try again" at graphics/2d.cpp:1402
A common error. This happens when fs2_open can't find the .vp files or that your user doesn't have the permissions to access them. If you are using a start up script([http://www.hard-light.net/wiki/index.php/Fs2_open_on_Linux#Creating_a_Start_Up_Script like the one found here]) it's most likly the a permission problem.
Have your user take owenership of the .vp files, run as root:
$ chown <user> /path/to/vpfiles/ -R

=== I18n and Key mapping problems ===
''Me, being a Swede, need to use this aswell, especially for the grave key(`), but I also want to use a second X display. There is a way to tell xmodmap to use the new set of keys on the second X display, and thus eliminating the need for a temp. keymap table as it dies with the second display when exiting fs2_open, never touching the keymap table on display 0. We should dig that info up and write a super-start script. --ni1s'' 
Ok, imagine that like me you don't have an us keyboard but a french one (or anything). Well, you probably have problems mapping some keys or even using the default mapping.

Actually, the problem is fs2_open does not take modifiers into account, as it uses them internally as modifiers for keys, and it won't accept non-us charset either.

On a french keyboard layout, the numbers ''1 2 3 4 5 6 7 8 9 0'' are on the same keys than on a US layout, but you have to press shift to use them. The primary function for theses keys are ''& Ã© " ' ( - Ã¨ _ Ã§ Ã )''. These characters won't be accepted by freespace, and if you press shift to get a number, it won't work. This can be a problem, as theses keys are needed to use the communication system, and cannot be bound to anything. Also, as you won't get access some keys on your keyboard, it will be difficult to map every command on a key, or you'll have to use modifiers for nearly each key.

However, there is a solution. You can tell X to remap the keyboard before launching the game, and restore your normal keymap afterwards.

For exemple, I map 123456790 to &é"'(-è_çà keys so I can use the communication system, and I put , and ; on the Alt-Gr and Menu keys for convenience, as I binded thoses keys to next primary weapon and next secondary weapon.

To do this, I use a slightly enhanced startup script, which I put in ~/bin (this directory is in my path), together with a customized xmodmap.

* First, dump your current xmodmap :

<tt>~ $ xmodmap -pke > ~/xmodmap.current</tt>

* Then edit it with your favorite text editor. You'll see a bunch of lines looking like this :

<tt>
keycode 8 =
keycode 9 = Escape
keycode 10 = 1 ampersand onesuperior exclamdown onesuperior exclamdown
</tt>

The syntax is ''keycode <number> = <symbol list>''.

Use '''xev''' to scan the keycodes. The symbols are defined in ''/usr/include/X11/keysymdef.h''. Just make sure you write them without the ''XK_'' prefix. You'll find more information about xmodmap in the xmodmap manual page.

Just modify the keys you need, and be patient. This can be a long process. Test it with xmodmap :

<tt>~ $ xmodmap - < <filename></tt>

But don't forget to have your previous keymap at hand to recover your settings !
If you mess everything up, just restart X. Your default keymap will be applied from the X configuration.

Here is my own fs2 xmodmap, derived from fr-latin1 as described above. Feel free to use it if you're too lazy to modify your own. However, it may not fit with your needs. You may always use it as an exemple, thougt.
* http://clement.hermann.free.fr/fs2/xmodmap

Then, when the file is modified at your liking, just save it as '''~/.fs2_open/xmodmap'''

We'll start fs2_open with a slightly more elaborate startup script which will backup/apply/restore the keymap in addition of running the games with some options in the right directory.

<tt>
#!/bin/sh
# This script lauches fs2. If there is a file named $FS2_modmap (see below),
# backup the current modmap as $TMP_modmap and load it as the new modmap.
# The current modmap will be restored afterwards.

TMP_modmap="$HOME/xmodmap.tmp"
FS2_modmap="$HOME/.fs2_open/xmodmap"

FS2_OPEN_DIR=/usr/local/games/fs2_open

FS2_ARGS="-glow -spec -spec_exp 11 -spec_point 0.6 -spec_static 0.8 -spec_tube 0.4 -fps -jpgtga -ambient_factor 75 -targetinfo -nograb"

FS2_BIN="$FS2_OPEN_DIR/fs2_open_r"

die() {
echo "** Fatal error : $1" >&2
exit 1
}

cd $FS2_OPEN_DIR || die "Could not change directory to $FS2_OPEN_DIR"

# dump current xmodmap
[ -f "$FS2_modmap" ] && xmodmap -pke > $TMP_modmap

# load xmodmap
[ -f "$FS2_modmap" ] && xmodmap - < $FS2_modmap

# prepare to restore xmodmap on crash or exit
trap "xmodmap - < $TMP_modmap && rm $TMP_modmap" 0 2 3 4 9 11 15

# launch fs2
$FS2_BIN $FS2_ARGS $* || die "Error while running \"$FS2_BIN\" with arguments \"$FS2_ARGS\" ($?)"
</tt>

Adapt this script to your needs, and save it somewhere in your PATH - I for exemple usr ~/bin/freespace2. Make it executable with a chmod +x ''<file>''

That's it, now you can use fs2 with full control over your keyboard.

=== fs2_open freezes X ===
A good way of running games on Linux is having them run on a separate X display. The display you are most likely using now when reading this is 0:0. This display is normally used for whatever Window Manager/Desktop Environment(KDE,Gnome,*box,E) you've chosen. Sometimes fs2_open freezes and locks your X. This is of course very annoying as you have to CTRL+ALT+BACKSPACE to kill the X server, and in that, killing whatever program you had running besides fs2_open. The solution to this is to tell X to start fs2_open on another display. To to this we first need to tell X that you,the user on localhost, holds the permission to run on another display.
In a terminal, enter (NOT as root):
$ xauth list
A list that looks something like this should appear.
myuser@localhost ~ $ xauth list
localhost/unix:'''0''' MIT-MAGIC-COOKIE-1 14ec70e7c8cc835def61a04c92bbd50d
Let's look at that line, first up is your localhost, then unix, and last the display number,:0 (in bold). The rest is not really of interest.
Copy the whole line, but change the display value to 1 and paste it after the command ''xauth add'', like this:
$ xauth add localhost/unix:'''1''' MIT-MAGIC-COOKIE-1 14ec70e7c8cc835def61a04c92bbd50d
Run xauth list again. You should see a new entry.
myuser@localhost ~ $ xauth list
localhost/unix:'''0''' MIT-MAGIC-COOKIE-1 14ec70e7c8cc835def61a04c92bbd50d
localhost/unix:'''1''' MIT-MAGIC-COOKIE-1 14ec70e7c8cc835def61a04c92bbd50d
You now have permission to use display 1:0.
To start fs2_open in that display, use xinit.
$ xinit /path/to/fs2_open_r -foo -bar -- :1
The ''-- :1'' tells X that we want to start fs2_open on display 1. 
You can switch between display 0 and 1 with CTRL+ALT+F7 and CTRL+ALT+F8 respectively.

If you try this from an xterm (or a similar X terminal program) and obtain the error ''X: user not authorized to run the X server, aborting.'', the reason might be the file /etc/X11/Xwrapper.config. On my ubuntu machine, it contains the line

allowed_users=console

which means that only users logged in from a console terminal may start a new X server. However, on an xterm, you are on a '''virtual''' terminal and so the above does not work. A possibility is to change the allowed_users in the Xwrapper.config file to "anybody" (see man Xwrapper.config). However, this undermines X security. Another possibility is to start the xinit command from a console window (to which you can change with CTRL+ALT+F1-6).

''If someone knows of a good method to start fs2 on a second X display from an xterm without changing Xwrapper.config, please report it here.''

''A solution might be running xinit as root with sudo, and drop the root privileges in the startup script... Didn't tried, though.'' -- nodens

[[Category:Source Code Project]]

Talk:Guide to FS Open on Linux

2006-09-13T22:15:42Z

Nodens: /* CVS Checkout */

Talk:Guide to FS Open on Linux

2006-09-13T22:13:04Z

Nodens: /* CVS Checkout */

Talk:Guide to FS Open on Linux

2006-09-13T22:12:31Z

Nodens: /* CVS Checkout */

Getting FreeSpace

2006-09-08T20:01:13Z

Nodens: /* Get it from another source */

There are several different ways of getting Freespace.

== Buy it ==
Of course, there are still a few copies of Freespace 2 floating around, up for sale on eBay, or maybe lying in the bargain bin at your local computer store - although the latter's pretty doubtful. Freespace 2 has not been mass-produced in the States for several years, so checking places that sell used software is your only recourse. Freespace, of course, has been out-of-print (so to speak) for even longer.

== Get it from a friend ==

Oddly enough, Freespace 2 actually has a clause in the license agreement that states that it's legal to give a copy of Freespace 2 to a friend - as long as it's for noncommercial use. So, be nice to anyone who has it, and maybe they'll burn it for you.

== Get it from HOTU ==

HOTU also has Freespace 2 [http://www.the-underdogs.info/game.php?id=4150 listed] in their downloads. Although this download went down for a brief time in the past, it is one of the most reliable ways of getting Freespace 2 over the internet. Unfortunately, the version included with HOTU is stripped-down. Fortunately, it is possible to correct this. By grabbing the missing VP files from a source such as [http://dynamic.gamespy.com/~freespace/forums/showthread.php?s=&threadid=16047 Fractux's FTP], and deleting or renaming the original "data" directory of the HOTU download, you can bring Freespace 2 back to its fully-featured potential.-

As of January 30th, 2006 "The game is already updated to v1.2 so there is no need to run the update." according to the readme.txt included with the HOTU version.

== Freespace Zone ==

The [http://www.freespacezone.com Freespace Zone] has .bin type images of all three CDs of Freespace 2 and the single CD of original Freespace, archived in the RAR format. Unfortunately the .cue files are not included. There's a freeware program called "CD Mage" that can automatically create the .cue files for you. (You'l have to search for it as its site is mirrored all over the web on free hosts, thus the site linked today may not be there tomorrow.) The Freespace Zone does not mention that the Freespace 2 image files they have are MODE 2 with a block size of 2352.

If you want to just use notepad or other text editor to make .cue files, here's the info. Just copy and paste each into an empty text file and save at disc1.cue, disc2.cue and disc3.cue, placing each in the same folder with its matching .bin file.

FILE "disc1.bin" BINARY
TRACK 01 MODE2/2352
INDEX 01 00:00:00

FILE "disc2.bin" BINARY
TRACK 01 MODE2/2352
INDEX 01 00:00:00

FILE "disc3.bin" BINARY
TRACK 01 MODE2/2352
INDEX 01 00:00:00

== BitTorrent ==

Freespace 2 is soon going to be made available via HLP's BitTorrent tracker. See the [[BitTorrent(Main)|main BitTorrent article]] for more information about this method of distribution.

== Get it from another source ==

There are other sources out there, that may have ISOs of the CDs, the VPs, etc.
You may find some info on this thread of the HLP forums : http://www.hard-light.net/forums/index.php/topic,38195.0.html

Guide to FS Open on Linux

2006-08-21T20:26:49Z

Nodens: /* I18n and Key mapping problems */

''This tutorial assumes some fundamental command line knowledge. ''
''As a rule of thumb, do not copy/paste commands without understanding them, especially as root. With great power comes great responsability.''
== Installing CVS ==
CVS stands for Concurrent Versions System and is a version control system used to record the changes in documents, such as source files. Developers use CVS so they can easily share their code changes among other developers. You will need this tool to download ("checkout" in CVS terminology) fs2_open from the CVS server.

'''Debian/Ubuntu''' users want to:
$ apt-get install cvs
'''Gentoo''' users want to:
$ emerge cvs

'''NOTE: Redhat, Mandrake/Mandriva, Slackware and all the other distros should go here too,'''
'''but we have no knowledge on how these work, so if you do, please enlighten us.'''

== Installing the nessesary development libraries ==
You will also need SDL, OpenAL, libvorbis and OpenGL(most likely provided with your video card driver) development packages. And of course the GCC compiler and required make tools.
 
'''Debian/Ubuntu''' users want to:
$ apt-get install libopenal-dev libvorbis-dev build-essential automake1.9 autoconf libsdl-dev
'''NOTE:''' The ''build-essential'' meta package installs GCC4. This should work, but if you feel safer with GCC 3.4(gcc-3.4), add it to the apt-get line above. 
'''Gentoo''' users want to:
$ emerge openal libvorbis libsdl
'''NOTE: Radhat, Mandrake,Slackware and all the other distros should go here too,'''
'''but we have no knowlage on how these work, so if you do, please enlighten us.'''

== Installing game data files ==

This tutorial deals primarily with providing you with an executable, but in order to play the game you also need the game data. Freespace 2 game data is available from a number of sources, see this thread: http://www.hard-light.net/forums/index.php/topic,38195.0.html

Note that if you use the retail CD, you'll need to extract the files and to copy them on your drive, reproducing the same layout as in a working win32 installation (just make sure every file is lowercase). This thread on the SCP forum has some more info on it : http://scp.indiegames.us/forum_viewtopic.php?3.282

There are two ways of doing this :
* use wine to install the game in the right directory, using the Setup.exe found on the first CD, or
* extract manually the files from the cd.

The second method is detailed below. The wine one is straightforward and you shouldn't need any specific instruction, but you'll have to fix permissions and lowercase the filename as well, so keep reading.

===Extracting data from CD===
====Installing unshield====

First, you need unshield from http://synce.sourceforge.net/synce/unshield.php

If you use debian, apt-get install unshield as root should do the trick. Else, try to find a package for your distribution, or if you don't, compile it yourself following the instructions provided on the website. Note you don't need to actually install it, just compile it and use it from the directory where you compiled it.

====Preparing directories====

* Create a directory for fs2_open, say, ''/usr/local/games/fs2_open'', with a ''data/movies'' and ''data/players'' subdirectories. Everything but user files and configuration will be in this directory. You'll probably need to be root or use sudo for most of the following commands if you use a global directory like the one in this example.

''Warning : Again, please double check the commands you run as root. A single typo could destroy your data. 'Remember what is said on the top of the page ? if not, go re-read it.''

<tt>~ $ mkdir -p /usr/local/games/fs2_open/data/movies /usr/local/games/fs2_open/data/players</tt>

====Extracting files====

* Use unshield to extract the groups from data1.cab (on the first cd) to a temporary directory; then move the files in your game directory :
<tt>~ $ mkdir /tmp/fs2
~ $ for group in "Basic Install Files" "Intel Anims" "Music Compressed" "High Res Files"; do unshield -d tmp/fs2/ -g "$group" -L -j x disk1/data1.cab && mv -v /tmp/fs2/*/* /home/data/jeux/fs2_open
~ $ unshield -d /usr/local/games/fs2_open/data/players -g "Hud Config Files" -L -j x data1.cab && mv -v /tmp/fs2/hud_config_files/* /home/data/jeux/fs2_open/data/players</tt>

* From the second CD, get the vp files and the movies files (I dont think the the mve file are really needed, you'll need the avi ones if you want the movies).
<tt>~ $ cp -vf *.vp /usr/local/games/fs2_open</tt>
<tt>~ $ mkdir -p /usr/local/games/fs2_open/data/movies/ && cp -vf *.MVE /usr/local/games/fs2_open/data/movies/</tt>
* Do the same for the third CD :
<tt>~ $ cp -vf *.vp /usr/local/games/fs2_open</tt>
<tt>~ $ cp -vf *.MVE /usr/local/games/fs2_open/data/movies/</tt>

You may notice that some files are on all three CD. This is because the games was meant to be run from CD. Don't bother.

=== Fixing Case and permissions ===
* You '''have''' to make sure everything is lowercase :
<tt>~ $ find /usr/local/games/fs2_open/ | rename -v 'y/A-Z/a-z/'</tt>

* Then, fix permissions :
<tt>~ $ find /usr/local/games/fs2_open -type d -exec chmod a+rx '{}' \;</tt>
<tt>~ $ find /usr/local/games/fs2_open -type f -exec chmod a+r '{}' \;</tt>

===MediaVP and Cutscenes===
You'll also need the mediavp from the SCP if you want the enhanced graphics. Get them at http://scp.indiegames.us.
If you want the cutscenes, you'll have to find the avi version of the MVE files, or to convert them yourself. They are not hard to find. When you have them, just put them in the data/movies directory. Again, make sure everything is lowercase.

That's it for the game data files, now it's time get the source !

== Using the source ==

=== CVS Checkout ===
Before you begin, make sure you have write permissions on your current working directory. Your /home/user/ directory is a pretty sure bet. I recommend that you create a permanent /home/user/src directory from which you run the CVS command, this way CVS will only update the files changed the next time you download the source and it's always nice to have things organized.

Now get the source. Run from a terminal:
$ cvs -d:pserver:anonymous:anonymous@warpcore.org:/home/fs2source/cvsroot login
and then
$ cvs -z3 -d:pserver:anonymous@warpcore.org:/home/fs2source/cvsroot co fs2_open
The first cvs command tells the CVS tool to first use a password file for authentication (pserver), that you are user "anonymous" with the password "anonymous" who wants to access warpcore.org's CVS repository "/home/fs2source/cvsroot" and login. The second command tells the CVS server on which we are now connected to that we want to checkout (co) the fs2_open module.
 
==== CVS Checkout and Update Script ====
The code on CVS is in a constant state of change, and bugs that exist one day may be gone the next. Because of this, you'll want to occasionally update to a newer version and recompile.
Running those cvs commands will fast grow to be a pain, so this little script was created to make your life easier. This script will checkout fs2_open if it can't find a fs2_open directory and update fs2_open, if it finds it.
The script will run until a successfull checkout or update has been achieved.
Copy and save this to a suitably named file like "get_fs2_open", and make it executable with the command, chmod +x <name of file>
#!/bin/bash
# CVS Checkout and Update Script for fs2_open
CVS_LINE="cvs -d:pserver:anonymous:anonymous@warpcore.org:/home/fs2source/cvsroot" # The cvs command
if [ "$UID" = 0 ]; then # check if user is root, and if so, echo a warning.
echo "You are root. If this is a checkout, all files \
will be created with root as the owner."
sleep 3
fi
if [ -e ./fs2_open ]; then # check if directory fs2_open exists
echo "Found fs2_open, We are updating an old checkout."
CVS_ATTEMPT=0 # This updates the checkout.
until [ $CVS_ATTEMPT = 1 ]; do
$CVS_LINE login && \
$CVS_LINE update fs2_open && \
let CVS_ATTEMPT=1
done
else
echo "No fs2_open found, This is a new checkout."
CVS_ATTEMPT=0 # This creates a new checkout.
until [ $CVS_ATTEMPT = 1 ]; do
$CVS_LINE login && \
$CVS_LINE co fs2_open && \
let CVS_ATTEMPT=1
done
fi

=== Pre-Compile Configuration ===

Before you compile you need to configure it for your system. In the directory you ran the CVS command from, a new directory has appear, namely fs2_open.
If your fs2_open is a completely new checkout, you will first need to run the autogen.sh script.
Run from inside your newly created fs2_open directory:
$ ./autogen.sh
autogen.sh is a script that will generate the required makefiles. You will see alot of "checking for this" and "checking for that", this is actually the "configure" script (which can be run with <tt>./configure</tt> if you need to change the options) examining and configuring fs2_open for your system. 
It is possible to give autogen.sh configure options as well, autogen.sh will pass them along to configure.

A full list of configure options can be found by running the configure script with the '--help' option.
$ ./configure --help

==== Optimizing fs2_open ====
Optimizing fs2_open might have little or no effect, or improve performance greatly, I honestly have no clue. 
A note of caution, if you are compiling a debug build, don't use the -fomit-frame-pointer CFLAG, it will make debugging impossible. 
You can specify your compiler flags with the configure script, se below.
$ ./configure CFLAGS="<your desired flags>"
If you got a Athlon-XP and want to play it safe, a good set of CFLAGS would be
$ ./configure CFLAGS="-march=athlon-xp -O3 -pipe -fomit-frame-pointer"
You should read up on CFLAGS and what they do before trying anything. I recommend you read through these links. 
http://gcc.gnu.org/onlinedocs/gcc-3.4.1/gcc/Optimize-Options.html 
http://linuxreviews.org/howtos/compiling/safe-cflags/ 
http://en.wikipedia.org/wiki/CFLAGS

=== Compiling ===

Run from within your fs2_open directory:
$ make
Sit back and enjoy gcc work its magic.

==== Simple Compile Script ====
It's alot easier to use a scripts when dealing with constantly changing code. Copy and save this to a suitably named file like "compile_fs2_open", and make it executable with the command, chmod +x <name of file>
This script assumes the CVS checkout directory fs2_open is pressent in the same directory as the script itself.
#!/bin/bash
# fs2_open Compile Script
# These are only examples, uncomment to enable optimization.
#MY_CFLAGS="-march=athlon-xp -O3 -pipe -fomit-frame-pointer -ftracer"
if [ -e ./fs2_open/ ]; then
cd fs2_open
if [ -e ./Makefile.in ]; then
make clean
./configure CFLAGS="$MY_CFLAGS" CXXFLAGS="$MY_CFLAGS"
make
else
./autogen.sh CFLAGS="$MY_CFLAGS" CXXFLAGS="$MY_CFLAGS"
make
fi
else
echo "No fs2_open directory found."
fi

You can add your options to the ./configure line.

== Using the Binaries ==

When the compile is done and if all went well, a binary executable will reside in the code directory ''fs2_open_r'' or ''fs2_open_d'' if you configured for a debug build. Copy the binary to directory where Freespace2 is installed, and you're all set to go.

=== Post-Compile Configuration ===
==== Changing Your Resolution ====
Odds are, you'll want to run fs2_open in a higher resolution than the default 640x480. Unfortunately, we Linux users don't have the swank launcher app that the Windows folks do. Instead, we'll be making a couple line changes to a config file. You will need to run fs2_open once before you can make the necessary changes, otherwise you won't have a configuration directory to work with.

Open up ~/.fs2_open/fs2_open.ini with the text editor of your choice (vi, EMACS, kwrite, gedit). You'll see something like the following:
[Default]
VideocardFs2open=OGL -(640x480)x16 bit
LastPlayer=MonkeyboyS
GammaD3D=1.0

To set fs2_open to use the highest setting possible on retail Freespace 2, change the VideocardFs2open to:
VideocardFs2open=OGL -(1024x768)x32 bit
You can set this to pretty much anything you want.

=== Creating a Start Up Script ===

In order to use all of the advanced engine features of fs2_open, you'll need to start the executable with a number of command line arguments. Instead of typing them in every time you want to start the game, why not create a script that does it for you?

Create a new file named start_freespace (or whatever you like) in your home directory. Open the file in your editor of choice, and paste the following:
#!/bin/bash
cd /path/to/your/freespace/
./fs2_open_r -spec -glow -mipmap -jpgtga -orbradar -mod Media_VP

''Note: You will need to edit this script before it will work properly. The second line must point to the directory where you installed fs2_open. You can also find a more elaborated script example below in the i18n section''

The last line starts fs2_open with a number of arguments that turn on extra features. In the example, the game will use specular highlights, glow-mapping, mipmapping, jpg and tga graphic files, the orb radar, and any MediaVPs installed to the /Media_VP directory. You should edit this line to use those features that your system supports.

More information about the available Command Line Arguments can be found at the [[Command-Line Reference]]

Once you've edited the file to your heart's content, make it executable:
$ chmod +x start_freespace

You can now type in start_freespace to start the game, or by clicking on start_freespace in your window manager. For convenience, you can copy it to your Desktop.

== Troubleshooting ==
=== Compile Errors ===
==== Missing -lGLU compile error ====

On some Linux distributions (''Slackware'' for instance), compiling fails because a GL related library doesn't have a link in the <tt>/usr/lib</tt> directory. If the compile fails because it can't find <tt>-lGLU</tt>, here are two ways to fix it:

===== Solution as Root =====

If you have root access to the system, you can create a link to the library in question with just a little bit of command line magic. Go to a console and enter:

$ ln -s /usr/X11R6/lib/libGLU.so /usr/lib/libGLU.so

After that, you can run make again and it should finish compiling.

===== Solution as a Non-Root user =====

You don't have root access? Never fear, we can still fix the problem. It'll just be a tad more difficult.

Navigate to the <tt>fs2_open/code</tt> directory and locate a file named <tt>Makefile</tt> (not Makefile.rm or Makefile.in or Makefile.anything). Open it in your favorite text editor and make the following changes.

Find this line (line 457 in mine):
FS2_LDFLAGS = -L/usr/lib -Wl,-rpath,/usr/lib -lSDL -lpthread -lGL -lGLU -lopenal -logg -lvorbis -lvorbisfile

And replace it with this:
FS2_LDFLAGS = -L/usr/lib -Wl,-rpath,/usr/lib -lSDL -lpthread -lGL -lopenal -logg -lvorbis -lvorbisfile -L/usr/X11R6/lib -lGLU

Also find this one (line 565 in mine):
AM_LDFLAGS = -g -L/usr/lib -Wl,-rpath,/usr/lib -lSDL -lpthread -lGL -lGLU -lopenal -logg -lvorbis -lvorbisfile

And replace it with this:
AM_LDFLAGS = -g -L/usr/lib -Wl,-rpath,/usr/lib -lSDL -lpthread -lGL -lopenal -logg -lvorbis -lvorbisfile -L/usr/X11R6/lib -lGLU

Then run <tt>make</tt> from the <tt>fs2_open</tt> directory, and watch the magic happen.

==== glBindBufferARB feature missing ====
''If this is the actual solution to this problem remains to be seen.'' 
''So far, only people using Debian stable are affected by this.'' 
''So we need adventurus Debian users to confirm.'' 
''I can confirm that the APT-Pinning works, can not confirm compile thou. -- ni1s'' 
checking for glBindBufferARB in -lGL... no
configure: error: *** OpenGL version does not have the required features!! (ie.glBindBufferARB()) ***
This error appears if the installed Mesa development library is to old.

On Debian stable branch the xlibmesa-gl-dev package holds version 4.3.0. 
The xlibmesa-gl-dev package on ''testning'' is version 6.9.0.

'''Possible solution:''' 
First set /etc/apt/sources.list to include the testing branch. Add:
#Testing
deb http://ftp.us.debian.org/debian testing main non-free contrib
deb http://non-us.debian.org/debian-non-US testing/non-US main contrib non-free
Your sources.list might have these lines already, if so, you should be okej.

Your /etc/apt/preferences file should look like this
Package: *
Pin: release a=stable
Pin-Priority: 700

Package: *
Pin: release a=testing
Pin-Priority: 650

Package: *
Pin: release a=unstable
Pin-Priority: 600

Add to that file:
Package: xlibmesa-gl-dev
Pin: release a=testing
Pin-Priority: 800
Note that the Pin-Priority of xlibmesa-gl-dev here is higher than the Pin-Priority on 'stable'. As a result of this APT get will prioritize the xlibmesa-gl-dev from testing and leave the rest of the system on stable.
This is called apt-pinning.

Now that APT knows what xlibmesa-gl-dev to prioritze, install it again:
$ apt-get install xlibmesa-gl-dev

If you are using nVidia's nvidia-kernel and glx packages, a simple:
$ apt-get install nvidia-glx-dev
should suffice. No need to mess around with APT-pinning.

=== Runtime Errors and common problems ===
==== ERROR: "Web cursor bitmap not found." ====
ERROR: "Web cursor bitmap not found. This usually means that the executable is being run outside the directory
you installed Freespace2 to. Please move the executable to that directory and try again" at graphics/2d.cpp:1402
A common error. This happens when fs2_open can't find the .vp files or that your user doesn't have the permissions to access them. If you are using a start up script([http://www.hard-light.net/wiki/index.php/Fs2_open_on_Linux#Creating_a_Start_Up_Script like the one found here]) it's most likly the a permission problem.
Have your user take owenership of the .vp files, run as root:
$ chown <user> /path/to/vpfiles/ -R

=== I18n and Key mapping problems ===
''Me, being a Swede, need to use this aswell, especially for the grave key(`), but I also want to use a second X display. There is a way to tell xmodmap to use the new set of keys on the second X display, and thus eliminating the need for a temp. keymap table as it dies with the second display when exiting fs2_open, never touching the keymap table on display 0. We should dig that info up and write a super-start script. --ni1s'' 
Ok, imagine that like me you don't have an us keyboard but a french one (or anything). Well, you probably have problems mapping some keys or even using the default mapping.

Actually, the problem is fs2_open does not take modifiers into account, as it uses them internally as modifiers for keys, and it won't accept non-us charset either.

On a french keyboard layout, the numbers ''1 2 3 4 5 6 7 8 9 0'' are on the same keys than on a US layout, but you have to press shift to use them. The primary function for theses keys are ''& Ã© " ' ( - Ã¨ _ Ã§ Ã )''. These characters won't be accepted by freespace, and if you press shift to get a number, it won't work. This can be a problem, as theses keys are needed to use the communication system, and cannot be bound to anything. Also, as you won't get access some keys on your keyboard, it will be difficult to map every command on a key, or you'll have to use modifiers for nearly each key.

However, there is a solution. You can tell X to remap the keyboard before launching the game, and restore your normal keymap afterwards.

For exemple, I map 123456790 to the &Ã©"'(-Ã¨_Ã§Ã keys so I can use the communication system, and I put , and ; on the Alt-Gr and Menu keys for convenience, as I binded thoses keys to next primary weapon and next secondary weapon.

To do this, I use a slightly enhanced startup script, which I put in ~/bin (this directory is in my path), together with a customized xmodmap.

* First, dump your current xmodmap :

<tt>~ $ xmodmap -pke > ~/xmodmap.current</tt>

* Then edit it with your favorite text editor. You'll see a bunch of lines looking like this :

<tt>
keycode 8 =
keycode 9 = Escape
keycode 10 = 1 ampersand onesuperior exclamdown onesuperior exclamdown
</tt>

The syntax is ''keycode <number> = <symbol list>''.

Use '''xev''' to scan the keycodes. The symbols are defined in ''/usr/include/X11/keysymdef.h''. Just make sure you write them without the ''XK_'' prefix. You'll find more information about xmodmap in the xmodmap manual page.

Just modify the keys you need, and be patient. This can be a long process. Test it with xmodmap :

<tt>~ $ xmodmap - < <filename></tt>

But don't forget to have your previous keymap at hand to recover your settings !
If you mess everything up, just restart X. Your default keymap will be applied from the X configuration.

Here is my own fs2 xmodmap, derived from fr-latin1 as described above. Feel free to use it if you're too lazy to modify your own. However, it may not fit with your needs. You may always use it as an exemple, thougt.
* http://clement.hermann.free.fr/fs2/xmodmap

Then, when the file is modified at your liking, just save it as '''~/.fs2_open/xmodmap'''

We'll start fs2_open with a slightly more elaborate startup script which will backup/apply/restore the keymap in addition of running the games with some options in the right directory.

<tt>
#!/bin/sh
# This script lauches fs2. If there is a file named $FS2_modmap (see below),
# backup the current modmap as $TMP_modmap and load it as the new modmap.
# The current modmap will be restored afterwards.

TMP_modmap="$HOME/xmodmap.tmp"
FS2_modmap="$HOME/.fs2_open/xmodmap"

FS2_OPEN_DIR=/usr/local/games/fs2_open

FS2_ARGS="-glow -spec -spec_exp 11 -spec_point 0.6 -spec_static 0.8 -spec_tube 0.4 -fps -jpgtga -ambient_factor 75 -targetinfo -nograb"

FS2_BIN="$FS2_OPEN_DIR/fs2_open_r"

die() {
echo "** Fatal error : $1" >&2
exit 1
}

cd $FS2_OPEN_DIR || die "Could not change directory to $FS2_OPEN_DIR"

# dump current xmodmap
[ -f "$FS2_modmap" ] && xmodmap -pke > $TMP_modmap

# load xmodmap
[ -f "$FS2_modmap" ] && xmodmap - < $FS2_modmap

# prepare to restore xmodmap on crash or exit
trap "xmodmap - < $TMP_modmap && rm $TMP_modmap" 0 2 3 4 9 11 15

# launch fs2
$FS2_BIN $FS2_ARGS $* || die "Error while running \"$FS2_BIN\" with arguments \"$FS2_ARGS\" ($?)"
</tt>

Adapt this script to your needs, and save it somewhere in your PATH - I for exemple usr ~/bin/freespace2. Make it executable with a chmod +x ''<file>''

That's it, now you can use fs2 with full control over your keyboard.

=== fs2_open freezes X ===
A good way of running games on Linux is having them run on a separate X display. The display you are most likely using now when reading this is 0:0. This display is normally used for whatever Window Manager/Desktop Environment(KDE,Gnome,*box,E) you've chosen. Sometimes fs2_open freezes and locks your X. This is of course very annoying as you have to CTRL+ALT+BACKSPACE to kill the X server, and in that, killing whatever program you had running besides fs2_open. The solution to this is to tell X to start fs2_open on another display. To to this we first need to tell X that you,the user on localhost, holds the permission to run on another display.
In a terminal, enter (NOT as root):
$ xauth list
A list that looks something like this should appear.
myuser@localhost ~ $ xauth list
localhost/unix:'''0''' MIT-MAGIC-COOKIE-1 14ec70e7c8cc835def61a04c92bbd50d
Let's look at that line, first up is your localhost, then unix, and last :0 (in bold). The rest is not really of interest.
Copy the whole line, but change the display value to 1 and paste it after the command ''xauth add'', like this:
$ xauth add localhost/unix:'''1''' MIT-MAGIC-COOKIE-1 14ec70e7c8cc835def61a04c92bbd50d
Run xauth list again. You should see a new entry.
myuser@localhost ~ $ xauth list
localhost/unix:'''0''' MIT-MAGIC-COOKIE-1 14ec70e7c8cc835def61a04c92bbd50d
localhost/unix:'''1''' MIT-MAGIC-COOKIE-1 14ec70e7c8cc835def61a04c92bbd50d
You now have permission to use display 1:0.
To start fs2_open in that display, use xinit.
$ xinit /path/to/fs2_open_r -foo -bar -- :1
The ''-- :1'' tells X that we want to start fs2_open on display 1. 
You can switch to display 0 and 1 with CTRL+ALT+F7 and CTRL+ALT+F8 respectively.

If you try this from an xterm (or a similar X terminal program) and obtain the error ''X: user not authorized to run the X server, aborting.'', the reason might be the file /etc/X11/Xwrapper.config. On my ubuntu machine, it contains the line

allowed_users=console

which means that only users logged in from a console terminal may start a new X server. However, on an xterm, you are on a '''virtual''' terminal and so the above does not work. A possibility is to change the allowed_users in the Xwrapper.config file to "anybody" (see man Xwrapper.config). However, this undermines X security. Another possibility is to start the xinit command from a console window (to which you can change with CTRL+ALT+F1-6).

''If someone knows of a good method to start fs2 on a second X display from an xterm without changing Xwrapper.config, please report it here.''

''A solution might be running xinit as root with sudo, and drop the root privileges in the startup script... Didn't tried, though.'' -- nodens

[[Category:Source Code Project]]

Guide to FS Open on Linux

2006-08-21T20:25:31Z

Nodens: /* I18n and Key mapping problems */

''This tutorial assumes some fundamental command line knowledge. ''
''As a rule of thumb, do not copy/paste commands without understanding them, especially as root. With great power comes great responsability.''
== Installing CVS ==
CVS stands for Concurrent Versions System and is a version control system used to record the changes in documents, such as source files. Developers use CVS so they can easily share their code changes among other developers. You will need this tool to download ("checkout" in CVS terminology) fs2_open from the CVS server.

'''Debian/Ubuntu''' users want to:
$ apt-get install cvs
'''Gentoo''' users want to:
$ emerge cvs

'''NOTE: Redhat, Mandrake/Mandriva, Slackware and all the other distros should go here too,'''
'''but we have no knowledge on how these work, so if you do, please enlighten us.'''

== Installing the nessesary development libraries ==
You will also need SDL, OpenAL, libvorbis and OpenGL(most likely provided with your video card driver) development packages. And of course the GCC compiler and required make tools.
 
'''Debian/Ubuntu''' users want to:
$ apt-get install libopenal-dev libvorbis-dev build-essential automake1.9 autoconf libsdl-dev
'''NOTE:''' The ''build-essential'' meta package installs GCC4. This should work, but if you feel safer with GCC 3.4(gcc-3.4), add it to the apt-get line above. 
'''Gentoo''' users want to:
$ emerge openal libvorbis libsdl
'''NOTE: Radhat, Mandrake,Slackware and all the other distros should go here too,'''
'''but we have no knowlage on how these work, so if you do, please enlighten us.'''

== Installing game data files ==

This tutorial deals primarily with providing you with an executable, but in order to play the game you also need the game data. Freespace 2 game data is available from a number of sources, see this thread: http://www.hard-light.net/forums/index.php/topic,38195.0.html

Note that if you use the retail CD, you'll need to extract the files and to copy them on your drive, reproducing the same layout as in a working win32 installation (just make sure every file is lowercase). This thread on the SCP forum has some more info on it : http://scp.indiegames.us/forum_viewtopic.php?3.282

There are two ways of doing this :
* use wine to install the game in the right directory, using the Setup.exe found on the first CD, or
* extract manually the files from the cd.

The second method is detailed below. The wine one is straightforward and you shouldn't need any specific instruction, but you'll have to fix permissions and lowercase the filename as well, so keep reading.

===Extracting data from CD===
====Installing unshield====

First, you need unshield from http://synce.sourceforge.net/synce/unshield.php

If you use debian, apt-get install unshield as root should do the trick. Else, try to find a package for your distribution, or if you don't, compile it yourself following the instructions provided on the website. Note you don't need to actually install it, just compile it and use it from the directory where you compiled it.

====Preparing directories====

* Create a directory for fs2_open, say, ''/usr/local/games/fs2_open'', with a ''data/movies'' and ''data/players'' subdirectories. Everything but user files and configuration will be in this directory. You'll probably need to be root or use sudo for most of the following commands if you use a global directory like the one in this example.

''Warning : Again, please double check the commands you run as root. A single typo could destroy your data. 'Remember what is said on the top of the page ? if not, go re-read it.''

<tt>~ $ mkdir -p /usr/local/games/fs2_open/data/movies /usr/local/games/fs2_open/data/players</tt>

====Extracting files====

* Use unshield to extract the groups from data1.cab (on the first cd) to a temporary directory; then move the files in your game directory :
<tt>~ $ mkdir /tmp/fs2
~ $ for group in "Basic Install Files" "Intel Anims" "Music Compressed" "High Res Files"; do unshield -d tmp/fs2/ -g "$group" -L -j x disk1/data1.cab && mv -v /tmp/fs2/*/* /home/data/jeux/fs2_open
~ $ unshield -d /usr/local/games/fs2_open/data/players -g "Hud Config Files" -L -j x data1.cab && mv -v /tmp/fs2/hud_config_files/* /home/data/jeux/fs2_open/data/players</tt>

* From the second CD, get the vp files and the movies files (I dont think the the mve file are really needed, you'll need the avi ones if you want the movies).
<tt>~ $ cp -vf *.vp /usr/local/games/fs2_open</tt>
<tt>~ $ mkdir -p /usr/local/games/fs2_open/data/movies/ && cp -vf *.MVE /usr/local/games/fs2_open/data/movies/</tt>
* Do the same for the third CD :
<tt>~ $ cp -vf *.vp /usr/local/games/fs2_open</tt>
<tt>~ $ cp -vf *.MVE /usr/local/games/fs2_open/data/movies/</tt>

You may notice that some files are on all three CD. This is because the games was meant to be run from CD. Don't bother.

=== Fixing Case and permissions ===
* You '''have''' to make sure everything is lowercase :
<tt>~ $ find /usr/local/games/fs2_open/ | rename -v 'y/A-Z/a-z/'</tt>

* Then, fix permissions :
<tt>~ $ find /usr/local/games/fs2_open -type d -exec chmod a+rx '{}' \;</tt>
<tt>~ $ find /usr/local/games/fs2_open -type f -exec chmod a+r '{}' \;</tt>

===MediaVP and Cutscenes===
You'll also need the mediavp from the SCP if you want the enhanced graphics. Get them at http://scp.indiegames.us.
If you want the cutscenes, you'll have to find the avi version of the MVE files, or to convert them yourself. They are not hard to find. When you have them, just put them in the data/movies directory. Again, make sure everything is lowercase.

That's it for the game data files, now it's time get the source !

== Using the source ==

=== CVS Checkout ===
Before you begin, make sure you have write permissions on your current working directory. Your /home/user/ directory is a pretty sure bet. I recommend that you create a permanent /home/user/src directory from which you run the CVS command, this way CVS will only update the files changed the next time you download the source and it's always nice to have things organized.

Now get the source. Run from a terminal:
$ cvs -d:pserver:anonymous:anonymous@warpcore.org:/home/fs2source/cvsroot login
and then
$ cvs -z3 -d:pserver:anonymous@warpcore.org:/home/fs2source/cvsroot co fs2_open
The first cvs command tells the CVS tool to first use a password file for authentication (pserver), that you are user "anonymous" with the password "anonymous" who wants to access warpcore.org's CVS repository "/home/fs2source/cvsroot" and login. The second command tells the CVS server on which we are now connected to that we want to checkout (co) the fs2_open module.
 
==== CVS Checkout and Update Script ====
The code on CVS is in a constant state of change, and bugs that exist one day may be gone the next. Because of this, you'll want to occasionally update to a newer version and recompile.
Running those cvs commands will fast grow to be a pain, so this little script was created to make your life easier. This script will checkout fs2_open if it can't find a fs2_open directory and update fs2_open, if it finds it.
The script will run until a successfull checkout or update has been achieved.
Copy and save this to a suitably named file like "get_fs2_open", and make it executable with the command, chmod +x <name of file>
#!/bin/bash
# CVS Checkout and Update Script for fs2_open
CVS_LINE="cvs -d:pserver:anonymous:anonymous@warpcore.org:/home/fs2source/cvsroot" # The cvs command
if [ "$UID" = 0 ]; then # check if user is root, and if so, echo a warning.
echo "You are root. If this is a checkout, all files \
will be created with root as the owner."
sleep 3
fi
if [ -e ./fs2_open ]; then # check if directory fs2_open exists
echo "Found fs2_open, We are updating an old checkout."
CVS_ATTEMPT=0 # This updates the checkout.
until [ $CVS_ATTEMPT = 1 ]; do
$CVS_LINE login && \
$CVS_LINE update fs2_open && \
let CVS_ATTEMPT=1
done
else
echo "No fs2_open found, This is a new checkout."
CVS_ATTEMPT=0 # This creates a new checkout.
until [ $CVS_ATTEMPT = 1 ]; do
$CVS_LINE login && \
$CVS_LINE co fs2_open && \
let CVS_ATTEMPT=1
done
fi

=== Pre-Compile Configuration ===

Before you compile you need to configure it for your system. In the directory you ran the CVS command from, a new directory has appear, namely fs2_open.
If your fs2_open is a completely new checkout, you will first need to run the autogen.sh script.
Run from inside your newly created fs2_open directory:
$ ./autogen.sh
autogen.sh is a script that will generate the required makefiles. You will see alot of "checking for this" and "checking for that", this is actually the "configure" script (which can be run with <tt>./configure</tt> if you need to change the options) examining and configuring fs2_open for your system. 
It is possible to give autogen.sh configure options as well, autogen.sh will pass them along to configure.

A full list of configure options can be found by running the configure script with the '--help' option.
$ ./configure --help

==== Optimizing fs2_open ====
Optimizing fs2_open might have little or no effect, or improve performance greatly, I honestly have no clue. 
A note of caution, if you are compiling a debug build, don't use the -fomit-frame-pointer CFLAG, it will make debugging impossible. 
You can specify your compiler flags with the configure script, se below.
$ ./configure CFLAGS="<your desired flags>"
If you got a Athlon-XP and want to play it safe, a good set of CFLAGS would be
$ ./configure CFLAGS="-march=athlon-xp -O3 -pipe -fomit-frame-pointer"
You should read up on CFLAGS and what they do before trying anything. I recommend you read through these links. 
http://gcc.gnu.org/onlinedocs/gcc-3.4.1/gcc/Optimize-Options.html 
http://linuxreviews.org/howtos/compiling/safe-cflags/ 
http://en.wikipedia.org/wiki/CFLAGS

=== Compiling ===

Run from within your fs2_open directory:
$ make
Sit back and enjoy gcc work its magic.

==== Simple Compile Script ====
It's alot easier to use a scripts when dealing with constantly changing code. Copy and save this to a suitably named file like "compile_fs2_open", and make it executable with the command, chmod +x <name of file>
This script assumes the CVS checkout directory fs2_open is pressent in the same directory as the script itself.
#!/bin/bash
# fs2_open Compile Script
# These are only examples, uncomment to enable optimization.
#MY_CFLAGS="-march=athlon-xp -O3 -pipe -fomit-frame-pointer -ftracer"
if [ -e ./fs2_open/ ]; then
cd fs2_open
if [ -e ./Makefile.in ]; then
make clean
./configure CFLAGS="$MY_CFLAGS" CXXFLAGS="$MY_CFLAGS"
make
else
./autogen.sh CFLAGS="$MY_CFLAGS" CXXFLAGS="$MY_CFLAGS"
make
fi
else
echo "No fs2_open directory found."
fi

You can add your options to the ./configure line.

== Using the Binaries ==

When the compile is done and if all went well, a binary executable will reside in the code directory ''fs2_open_r'' or ''fs2_open_d'' if you configured for a debug build. Copy the binary to directory where Freespace2 is installed, and you're all set to go.

=== Post-Compile Configuration ===
==== Changing Your Resolution ====
Odds are, you'll want to run fs2_open in a higher resolution than the default 640x480. Unfortunately, we Linux users don't have the swank launcher app that the Windows folks do. Instead, we'll be making a couple line changes to a config file. You will need to run fs2_open once before you can make the necessary changes, otherwise you won't have a configuration directory to work with.

Open up ~/.fs2_open/fs2_open.ini with the text editor of your choice (vi, EMACS, kwrite, gedit). You'll see something like the following:
[Default]
VideocardFs2open=OGL -(640x480)x16 bit
LastPlayer=MonkeyboyS
GammaD3D=1.0

To set fs2_open to use the highest setting possible on retail Freespace 2, change the VideocardFs2open to:
VideocardFs2open=OGL -(1024x768)x32 bit
You can set this to pretty much anything you want.

=== Creating a Start Up Script ===

In order to use all of the advanced engine features of fs2_open, you'll need to start the executable with a number of command line arguments. Instead of typing them in every time you want to start the game, why not create a script that does it for you?

Create a new file named start_freespace (or whatever you like) in your home directory. Open the file in your editor of choice, and paste the following:
#!/bin/bash
cd /path/to/your/freespace/
./fs2_open_r -spec -glow -mipmap -jpgtga -orbradar -mod Media_VP

''Note: You will need to edit this script before it will work properly. The second line must point to the directory where you installed fs2_open. You can also find a more elaborated script example below in the i18n section''

The last line starts fs2_open with a number of arguments that turn on extra features. In the example, the game will use specular highlights, glow-mapping, mipmapping, jpg and tga graphic files, the orb radar, and any MediaVPs installed to the /Media_VP directory. You should edit this line to use those features that your system supports.

More information about the available Command Line Arguments can be found at the [[Command-Line Reference]]

Once you've edited the file to your heart's content, make it executable:
$ chmod +x start_freespace

You can now type in start_freespace to start the game, or by clicking on start_freespace in your window manager. For convenience, you can copy it to your Desktop.

== Troubleshooting ==
=== Compile Errors ===
==== Missing -lGLU compile error ====

On some Linux distributions (''Slackware'' for instance), compiling fails because a GL related library doesn't have a link in the <tt>/usr/lib</tt> directory. If the compile fails because it can't find <tt>-lGLU</tt>, here are two ways to fix it:

===== Solution as Root =====

If you have root access to the system, you can create a link to the library in question with just a little bit of command line magic. Go to a console and enter:

$ ln -s /usr/X11R6/lib/libGLU.so /usr/lib/libGLU.so

After that, you can run make again and it should finish compiling.

===== Solution as a Non-Root user =====

You don't have root access? Never fear, we can still fix the problem. It'll just be a tad more difficult.

Navigate to the <tt>fs2_open/code</tt> directory and locate a file named <tt>Makefile</tt> (not Makefile.rm or Makefile.in or Makefile.anything). Open it in your favorite text editor and make the following changes.

Find this line (line 457 in mine):
FS2_LDFLAGS = -L/usr/lib -Wl,-rpath,/usr/lib -lSDL -lpthread -lGL -lGLU -lopenal -logg -lvorbis -lvorbisfile

And replace it with this:
FS2_LDFLAGS = -L/usr/lib -Wl,-rpath,/usr/lib -lSDL -lpthread -lGL -lopenal -logg -lvorbis -lvorbisfile -L/usr/X11R6/lib -lGLU

Also find this one (line 565 in mine):
AM_LDFLAGS = -g -L/usr/lib -Wl,-rpath,/usr/lib -lSDL -lpthread -lGL -lGLU -lopenal -logg -lvorbis -lvorbisfile

And replace it with this:
AM_LDFLAGS = -g -L/usr/lib -Wl,-rpath,/usr/lib -lSDL -lpthread -lGL -lopenal -logg -lvorbis -lvorbisfile -L/usr/X11R6/lib -lGLU

Then run <tt>make</tt> from the <tt>fs2_open</tt> directory, and watch the magic happen.

==== glBindBufferARB feature missing ====
''If this is the actual solution to this problem remains to be seen.'' 
''So far, only people using Debian stable are affected by this.'' 
''So we need adventurus Debian users to confirm.'' 
''I can confirm that the APT-Pinning works, can not confirm compile thou. -- ni1s'' 
checking for glBindBufferARB in -lGL... no
configure: error: *** OpenGL version does not have the required features!! (ie.glBindBufferARB()) ***
This error appears if the installed Mesa development library is to old.

On Debian stable branch the xlibmesa-gl-dev package holds version 4.3.0. 
The xlibmesa-gl-dev package on ''testning'' is version 6.9.0.

'''Possible solution:''' 
First set /etc/apt/sources.list to include the testing branch. Add:
#Testing
deb http://ftp.us.debian.org/debian testing main non-free contrib
deb http://non-us.debian.org/debian-non-US testing/non-US main contrib non-free
Your sources.list might have these lines already, if so, you should be okej.

Your /etc/apt/preferences file should look like this
Package: *
Pin: release a=stable
Pin-Priority: 700

Package: *
Pin: release a=testing
Pin-Priority: 650

Package: *
Pin: release a=unstable
Pin-Priority: 600

Add to that file:
Package: xlibmesa-gl-dev
Pin: release a=testing
Pin-Priority: 800
Note that the Pin-Priority of xlibmesa-gl-dev here is higher than the Pin-Priority on 'stable'. As a result of this APT get will prioritize the xlibmesa-gl-dev from testing and leave the rest of the system on stable.
This is called apt-pinning.

Now that APT knows what xlibmesa-gl-dev to prioritze, install it again:
$ apt-get install xlibmesa-gl-dev

If you are using nVidia's nvidia-kernel and glx packages, a simple:
$ apt-get install nvidia-glx-dev
should suffice. No need to mess around with APT-pinning.

=== Runtime Errors and common problems ===
==== ERROR: "Web cursor bitmap not found." ====
ERROR: "Web cursor bitmap not found. This usually means that the executable is being run outside the directory
you installed Freespace2 to. Please move the executable to that directory and try again" at graphics/2d.cpp:1402
A common error. This happens when fs2_open can't find the .vp files or that your user doesn't have the permissions to access them. If you are using a start up script([http://www.hard-light.net/wiki/index.php/Fs2_open_on_Linux#Creating_a_Start_Up_Script like the one found here]) it's most likly the a permission problem.
Have your user take owenership of the .vp files, run as root:
$ chown <user> /path/to/vpfiles/ -R

=== I18n and Key mapping problems ===
''Me, being a Swede, need to use this aswell, especially for the grave key(`), but I also want to use a second X display. There is a way to tell xmodmap to use the new set of keys on the second X display, and thus eliminating the need for a temp. keymap table as it dies with the second display when exiting fs2_open, never touching the keymap table on display 0. We should dig that info up and write a super-start script. --ni1s'' 
Ok, imagine that like me you don't have an us keyboard but a french one (or anything). Well, you probably have problems mapping some keys or even using the default mapping.

Actually, the problem is fs2_open does not take modifiers into account, as it uses them internally as modifiers for keys, and it won't accept non-us charset either.

On a french keyboard layout, the numbers ''1 2 3 4 5 6 7 8 9 0'' are on the same keys than on a US layout, but you have to press shift to use them. The primary function for theses keys are ''& Ã© " ' ( - Ã¨ _ Ã§ Ã )''. These characters won't be accepted by freespace, and if you press shift to get a number, it won't work. This can be a problem, as theses keys are needed to use the communication system, and cannot be bound to anything. Also, as you won't get access some keys on your keyboard, it will be difficult to map every command on a key, or you'll have to use modifiers for nearly each key.

However, there is a solution. You can tell X to remap the keyboard before launching the game, and restore your normal keymap afterwards.

For exemple, I map 123456790 to the &Ã©"'(-Ã¨_Ã§Ã keys so I can use the communication system, and I put , and ; on the Alt-Gr and Menu keys for convenience, as I binded thoses keys to next primary weapon and next secondary weapon.

To do this, I use a slightly enhanced startup script, which I put in ~/bin (this directory is in my path), together with a customized xmodmap.

* First, dump your current xmodmap :

<tt>~ $ xmodmap -pke > ~/xmodmap.current</tt>

* Then edit it with your favorite text editor. You'll see a bunch of lines looking like this :

<tt>
keycode 8 =
keycode 9 = Escape
keycode 10 = 1 ampersand onesuperior exclamdown onesuperior exclamdown
</tt>

The syntax is ''keycode <number> = <symbol list>''.

Use '''xev''' to scan the keycodes. The symbols are defined in ''/usr/include/X11/keysymdef.h''. Just make sure you write them without the ''XK_'' prefix. You'll find more information about xmodmap in the xmodmap manual page.

Just modify the keys you need, and be patient. This can be a long process. Test it with xmodmap :

<tt>~ $ xmodmap - < <filename></tt>

But don't forget to have your previous keymap at hand to recover your settings !
If you mess everything up, just restart X. Your default keymap will be applied from the X configuration.

Here is my own fs2 xmodmap, derived from fr-latin1 as described above. Feel free to use it if you're too lazy to modify your own. However, it may not fit with your needs. You may always use it as an exemple, thougt.
* http://clement.hermann.free.fr/fs2/xmodmap

Then, when the file is modified at your liking, just save it as '''~/.fs2_open/xmodmap'''

We'll start fs2_open with a slightly more elaborate startup script which will backup/apply/restore the keymap in addition of running the games with some options in the right directory.

<tt>
#!/bin/sh
# This script lauches fs2. If there is a file named $FS2_modmap (see below),
# backup the current modmap as $TMP_modmap and load it as the new modmap.
# The current modmap will be restored afterwards.

TMP_modmap="$HOME/xmodmap.tmp"
FS2_modmap="$HOME/.fs2_open/xmodmap"

FS2_OPEN_DIR=/usr/local/games/fs2_open

FS2_ARGS="-glow -spec -spec_exp 11 -spec_point 0.6 -spec_static 0.8 -spec_tube 0.4 -fps -jpgtga -ambient_factor 75 -targetinfo -nograb"

FS2_BIN="$FS2_OPEN_DIR/fs2_open_r"

die() {
echo "** Fatal error : $1" >&2
exit 1
}

cd $FS2_OPEN_DIR || die "Could not change directory to $FS2_OPEN_DIR"

# dump current xmodmap
[ -f "$FS2_modmap" ] && xmodmap -pke > $TMP_modmap

# load xmodmap
[ -f "$FS2_modmap" ] && xmodmap - < $FS2_modmap

# prepare to restore xmodmap on crash or exit
trap "xmodmap - < $TMP_modmap && rm $TMP_modmap" 0 2 3 4 9 11 15

# launch fs2
$FS2_BIN $FS2_ARGS $* || die "Error while running \"$FS2_BIN\" with arguments \"$FS2_ARGS\" ($?)"
</tt>

Adapt this script to your needs, and save it somewhere in your PATH - I for exemple usr ~/bin/freespace2. Make it executable with a chmod +x ''<file>''

That's it, now you can use fs2 with full control over your keyboard.

=== fs2_open freezes X ===
A good way of running games on Linux is having them run on a separate X display. The display you are most likely using now when reading this is 0:0. This display is normally used for whatever Window Manager/Desktop Environment(KDE,Gnome,*box,E) you've chosen. Sometimes fs2_open freezes and locks your X. This is of course very annoying as you have to CTRL+ALT+BACKSPACE to kill the X server, and in that, killing whatever program you had running besides fs2_open. The solution to this is to tell X to start fs2_open on another display. To to this we first need to tell X that you,the user on localhost, holds the permission to run on another display.
In a terminal, enter (NOT as root):
$ xauth list
A list that looks something like this should appear.
myuser@localhost ~ $ xauth list
localhost/unix:'''0''' MIT-MAGIC-COOKIE-1 14ec70e7c8cc835def61a04c92bbd50d
Let's look at that line, first up is your localhost, then unix, and last :0 (in bold). The rest is not really of interest.
Copy the whole line, but change the display value to 1 and paste it after the command ''xauth add'', like this:
$ xauth add localhost/unix:'''1''' MIT-MAGIC-COOKIE-1 14ec70e7c8cc835def61a04c92bbd50d
Run xauth list again. You should see a new entry.
myuser@localhost ~ $ xauth list
localhost/unix:'''0''' MIT-MAGIC-COOKIE-1 14ec70e7c8cc835def61a04c92bbd50d
localhost/unix:'''1''' MIT-MAGIC-COOKIE-1 14ec70e7c8cc835def61a04c92bbd50d
You now have permission to use display 1:0.
To start fs2_open in that display, use xinit.
$ xinit /path/to/fs2_open_r -foo -bar -- :1
The ''-- :1'' tells X that we want to start fs2_open on display 1. 
You can switch to display 0 and 1 with CTRL+ALT+F7 and CTRL+ALT+F8 respectively.

If you try this from an xterm (or a similar X terminal program) and obtain the error ''X: user not authorized to run the X server, aborting.'', the reason might be the file /etc/X11/Xwrapper.config. On my ubuntu machine, it contains the line

allowed_users=console

which means that only users logged in from a console terminal may start a new X server. However, on an xterm, you are on a '''virtual''' terminal and so the above does not work. A possibility is to change the allowed_users in the Xwrapper.config file to "anybody" (see man Xwrapper.config). However, this undermines X security. Another possibility is to start the xinit command from a console window (to which you can change with CTRL+ALT+F1-6).

''If someone knows of a good method to start fs2 on a second X display from an xterm without changing Xwrapper.config, please report it here.''

''A solution might be running xinit as root with sudo, and drop the root privileges in the startup script... Didn't tried, though.'' -- nodens

[[Category:Source Code Project]]

User:Nodens

2006-07-02T14:49:28Z

Nodens:

ok, let's make it short :

'''Interests''' : operating systems (unices prefered), networks, litterature (mostly sci-fi and fantasy, but classics, philosophy and others are nice too)

'''Freespace''' : I like a good dogfight, but I'm not really an hard-core gamer.

'''Contributions''' : you'll probably won't see me a lot in the forums... Most of my contributions to the fs2_open effort are on the [[fs2_open on Linux]] page.

--[[User:Nodens|nodens]] 15:48, 2 July 2006 (BST)

User:Nodens

2006-07-02T14:48:55Z

Nodens:

ok, let's make it short :

Interests : operating systems (unices prefered), networks, litterature (mostly sci-fi and fantasy, but classics, philosophy and others are nice too)

Freespace : I like a good dogfight, but I'm not really an hard-core gamer

Contributions : you'll probably won't see me a lot in the forums... Most of my contributions to the fs2_open effort are on the [[fs2_open on Linux]] page.

--[[User:Nodens|nodens]] 15:48, 2 July 2006 (BST)

User:Nodens

2006-07-02T14:48:15Z

Nodens:

ok, let's make it short :

Interests : operating systems (unices prefered), networks, litterature (mostly sci-fi and fantasy, but classics, philosophy and such are nice too)

Freespace : I like a good dogfight, but I'm not really an hard-core gamer

Contributions : you'll probably won't see me a lot in the forums... Most of my contributions to the fs2_open effort are on the [[fs2_open on Linux]] page.

--[[User:Nodens|nodens]] 15:48, 2 July 2006 (BST)

Guide to FS Open on Linux

2006-07-01T12:35:36Z

Nodens: well, this page belong to the SCP category, right ?

''This tutorial assumes some fundamental command line knowledge. ''
''As a rule of thumb, do not copy/paste commands without understanding them, especially as root. With great power comes great responsability.''
== Installing CVS ==
CVS stands for Concurrent Versions System and is a version control system used to record the changes in documents, such as source files. Developers use CVS so they can easily share their code changes among other developers. You will need this tool to download ("checkout" in CVS terminology) fs2_open from the CVS server.

'''Debian/Ubuntu''' users want to:
$ apt-get install cvs
'''Gentoo''' users want to:
$ emerge cvs

'''NOTE: Redhat, Mandrake/Mandriva, Slackware and all the other distros should go here too,'''
'''but we have no knowledge on how these work, so if you do, please enlighten us.'''

== Installing the nessesary development libraries ==
You will also need SDL, OpenAL, libvorbis and OpenGL(most likely provided with your video card driver) development packages. And of course the GCC compiler and required make tools.
 
'''Debian/Ubuntu''' users want to:
$ apt-get install libopenal-dev libvorbis-dev build-essential automake1.9 autoconf libsdl-dev
'''NOTE:''' The ''build-essential'' meta package installs GCC4. This should work, but if you feel safer with GCC 3.4(gcc-3.4), add it to the apt-get line above. 
'''Gentoo''' users want to:
$ emerge openal libvorbis libsdl
'''NOTE: Radhat, Mandrake,Slackware and all the other distros should go here too,'''
'''but we have no knowlage on how these work, so if you do, please enlighten us.'''

== Installing game data files ==

This tutorial deals primarily with providing you with an executable, but in order to play the game you also need the game data. Freespace 2 game data is available from a number of sources, see this thread: http://www.hard-light.net/forums/index.php/topic,38195.0.html

Note that if you use the retail CD, you'll need to extract the files and to copy them on your drive, reproducing the same layout as in a working win32 installation (just make sure every file is lowercase). This thread on the SCP forum has some more info on it : http://scp.indiegames.us/forum_viewtopic.php?3.282

There are two ways of doing this :
* use wine to install the game in the right directory, using the Setup.exe found on the first CD, or
* extract manually the files from the cd.

The second method is detailed below. The wine one is straightforward and you shouldn't need any specific instruction, but you'll have to fix permissions and lowercase the filename as well, so keep reading.

===Extracting data from CD===
====Installing unshield====

First, you need unshield from http://synce.sourceforge.net/synce/unshield.php

If you use debian, apt-get install unshield as root should do the trick. Else, try to find a package for your distribution, or if you don't, compile it yourself following the instructions provided on the website. Note you don't need to actually install it, just compile it and use it from the directory where you compiled it.

====Preparing directories====

* Create a directory for fs2_open, say, ''/usr/local/games/fs2_open'', with a ''data/movies'' and ''data/players'' subdirectories. Everything but user files and configuration will be in this directory. You'll probably need to be root or use sudo for most of the following commands if you use a global directory like the one in this example.

''Warning : Again, please double check the commands you run as root. A single typo could destroy your data. 'Remember what is said on the top of the page ? if not, go re-read it.''

<tt>~ $ mkdir -p /usr/local/games/fs2_open/data/movies /usr/local/games/fs2_open/data/players</tt>

====Extracting files====

* Use unshield to extract the groups from data1.cab (on the first cd) to a temporary directory; then move the files in your game directory :
<tt>~ $ mkdir /tmp/fs2
~ $ for group in "Basic Install Files" "Intel Anims" "Music Compressed" "High Res Files"; do unshield -d tmp/fs2/ -g "$group" -L -j x disk1/data1.cab && mv -v /tmp/fs2/*/* /home/data/jeux/fs2_open
~ $ unshield -d /usr/local/games/fs2_open/data/players -g "Hud Config Files" -L -j x data1.cab && mv -v /tmp/fs2/hud_config_files/* /home/data/jeux/fs2_open/data/players</tt>

* From the second CD, get the vp files and the movies files (I dont think the the mve file are really needed, you'll need the avi ones if you want the movies).
<tt>~ $ cp -vf *.vp /usr/local/games/fs2_open</tt>
<tt>~ $ mkdir -p /usr/local/games/fs2_open/data/movies/ && cp -vf *.MVE /usr/local/games/fs2_open/data/movies/</tt>
* Do the same for the third CD :
<tt>~ $ cp -vf *.vp /usr/local/games/fs2_open</tt>
<tt>~ $ cp -vf *.MVE /usr/local/games/fs2_open/data/movies/</tt>

You may notice that some files are on all three CD. This is because the games was meant to be run from CD. Don't bother.

=== Fixing Case and permissions ===
* You '''have''' to make sure everything is lowercase :
<tt>~ $ find /usr/local/games/fs2_open/ | rename -v 'y/A-Z/a-z/'</tt>

* Then, fix permissions :
<tt>~ $ find /usr/local/games/fs2_open -type d -exec chmod a+rx '{}' \;</tt>
<tt>~ $ find /usr/local/games/fs2_open -type f -exec chmod a+r '{}' \;</tt>

===MediaVP and Cutscenes===
You'll also need the mediavp from the SCP if you want the enhanced graphics. Get them at http://scp.indiegames.us.
If you want the cutscenes, you'll have to find the avi version of the MVE files, or to convert them yourself. They are not hard to find. When you have them, just put them in the data/movies directory. Again, make sure everything is lowercase.

That's it for the game data files, now it's time get the source !

== Using the source ==

=== CVS Checkout ===
Before you begin, make sure you have write permissions on your current working directory. Your /home/user/ directory is a pretty sure bet. I recommend that you create a permanent /home/user/src directory from which you run the CVS command, this way CVS will only update the files changed the next time you download the source and it's always nice to have things organized.

Now get the source. Run from a terminal:
$ cvs -d:pserver:anonymous:anonymous@warpcore.org:/home/fs2source/cvsroot login
and then
$ cvs -z3 -d:pserver:anonymous@warpcore.org:/home/fs2source/cvsroot co fs2_open
The first cvs command tells the CVS tool to first use a password file for authentication (pserver), that you are user "anonymous" with the password "anonymous" who wants to access warpcore.org's CVS repository "/home/fs2source/cvsroot" and login. The second command tells the CVS server on which we are now connected to that we want to checkout (co) the fs2_open module.
 
==== CVS Checkout and Update Script ====
The code on CVS is in a constant state of change, and bugs that exist one day may be gone the next. Because of this, you'll want to occasionally update to a newer version and recompile.
Running those cvs commands will fast grow to be a pain, so this little script was created to make your life easier. This script will checkout fs2_open if it can't find a fs2_open directory and update fs2_open, if it finds it.
The script will run until a successfull checkout or update has been achieved.
Copy and save this to a suitably named file like "get_fs2_open", and make it executable with the command, chmod +x <name of file>
#!/bin/bash
# CVS Checkout and Update Script for fs2_open
CVS_LINE="cvs -d:pserver:anonymous:anonymous@warpcore.org:/home/fs2source/cvsroot" # The cvs command
if [ "$UID" = 0 ]; then # check if user is root, and if so, echo a warning.
echo "You are root. If this is a checkout, all files \
will be created with root as the owner."
sleep 3
fi
if [ -e ./fs2_open ]; then # check if directory fs2_open exists
echo "Found fs2_open, We are updating an old checkout."
CVS_ATTEMPT=0 # This updates the checkout.
until [ $CVS_ATTEMPT = 1 ]; do
$CVS_LINE login && \
$CVS_LINE update fs2_open && \
let CVS_ATTEMPT=1
done
else
echo "No fs2_open found, This is a new checkout."
CVS_ATTEMPT=0 # This creates a new checkout.
until [ $CVS_ATTEMPT = 1 ]; do
$CVS_LINE login && \
$CVS_LINE co fs2_open && \
let CVS_ATTEMPT=1
done
fi

=== Pre-Compile Configuration ===

Before you compile you need to configure it for your system. In the directory you ran the CVS command from, a new directory has appear, namely fs2_open.
If your fs2_open is a completely new checkout, you will first need to run the autogen.sh script.
Run from inside your newly created fs2_open directory:
$ ./autogen.sh
autogen.sh is a script that will generate the required makefiles. You will see alot of "checking for this" and "checking for that", this is actually the "configure" script (which can be run with <tt>./configure</tt> if you need to change the options) examining and configuring fs2_open for your system. 
It is possible to give autogen.sh configure options as well, autogen.sh will pass them along to configure.

A full list of configure options can be found by running the configure script with the '--help' option.
$ ./configure --help

==== Optimizing fs2_open ====
Optimizing fs2_open might have little or no effect, or improve performance greatly, I honestly have no clue. 
A note of caution, if you are compiling a debug build, don't use the -fomit-frame-pointer CFLAG, it will make debugging impossible. 
You can specify your compiler flags with the configure script, se below.
$ ./configure CFLAGS="<your desired flags>"
If you got a Athlon-XP and want to play it safe, a good set of CFLAGS would be
$ ./configure CFLAGS="-march=athlon-xp -O3 -pipe -fomit-frame-pointer"
You should read up on CFLAGS and what they do before trying anything. I recommend you read through these links. 
http://gcc.gnu.org/onlinedocs/gcc-3.4.1/gcc/Optimize-Options.html 
http://linuxreviews.org/howtos/compiling/safe-cflags/ 
http://en.wikipedia.org/wiki/CFLAGS

=== Compiling ===

Run from within your fs2_open directory:
$ make
Sit back and enjoy gcc work its magic.

==== Simple Compile Script ====
It's alot easier to use a scripts when dealing with constantly changing code. Copy and save this to a suitably named file like "compile_fs2_open", and make it executable with the command, chmod +x <name of file>
This script assumes the CVS checkout directory fs2_open is pressent in the same directory as the script itself.
#!/bin/bash
# fs2_open Compile Script
# These are only examples, uncomment to enable optimization.
#MY_CFLAGS="-march=athlon-xp -O3 -pipe -fomit-frame-pointer -ftracer"
if [ -e ./fs2_open/ ]; then
cd fs2_open
if [ -e ./Makefile.in ]; then
make clean
./configure CFLAGS="$MY_CFLAGS" CXXFLAGS="$MY_CFLAGS"
make
else
./autogen.sh CFLAGS="$MY_CFLAGS" CXXFLAGS="$MY_CFLAGS"
make
fi
else
echo "No fs2_open directory found."
fi

You can add your options to the ./configure line.

== Using the Binaries ==

When the compile is done and if all went well, a binary executable will reside in the code directory ''fs2_open_r'' or ''fs2_open_d'' if you configured for a debug build. Copy the binary to directory where Freespace2 is installed, and you're all set to go.

=== Post-Compile Configuration ===
==== Changing Your Resolution ====
Odds are, you'll want to run fs2_open in a higher resolution than the default 640x480. Unfortunately, we Linux users don't have the swank launcher app that the Windows folks do. Instead, we'll be making a couple line changes to a config file. You will need to run fs2_open once before you can make the necessary changes, otherwise you won't have a configuration directory to work with.

Open up ~/.fs2_open/fs2_open.ini with the text editor of your choice (vi, EMACS, kwrite, gedit). You'll see something like the following:
[Default]
VideocardFs2open=OGL -(640x480)x16 bit
LastPlayer=MonkeyboyS
GammaD3D=1.0

To set fs2_open to use the highest setting possible on retail Freespace 2, change the VideocardFs2open to:
VideocardFs2open=OGL -(1024x768)x32 bit
You can set this to pretty much anything you want.

=== Creating a Start Up Script ===

In order to use all of the advanced engine features of fs2_open, you'll need to start the executable with a number of command line arguments. Instead of typing them in every time you want to start the game, why not create a script that does it for you?

Create a new file named start_freespace (or whatever you like) in your home directory. Open the file in your editor of choice, and paste the following:
#!/bin/bash
cd /path/to/your/freespace/
./fs2_open_r -spec -glow -mipmap -jpgtga -orbradar -mod Media_VP

''Note: You will need to edit this script before it will work properly. The second line must point to the directory where you installed fs2_open. You can also find a more elaborated script example below in the i18n section''

The last line starts fs2_open with a number of arguments that turn on extra features. In the example, the game will use specular highlights, glow-mapping, mipmapping, jpg and tga graphic files, the orb radar, and any MediaVPs installed to the /Media_VP directory. You should edit this line to use those features that your system supports.

More information about the available Command Line Arguments can be found at the [[Command-Line Reference]]

Once you've edited the file to your heart's content, make it executable:
$ chmod +x start_freespace

You can now type in start_freespace to start the game, or by clicking on start_freespace in your window manager. For convenience, you can copy it to your Desktop.

== Troubleshooting ==
=== Compile Errors ===
==== Missing -lGLU compile error ====

On some Linux distributions (''Slackware'' for instance), compiling fails because a GL related library doesn't have a link in the <tt>/usr/lib</tt> directory. If the compile fails because it can't find <tt>-lGLU</tt>, here are two ways to fix it:

===== Solution as Root =====

If you have root access to the system, you can create a link to the library in question with just a little bit of command line magic. Go to a console and enter:

$ ln -s /usr/X11R6/lib/libGLU.so /usr/lib/libGLU.so

After that, you can run make again and it should finish compiling.

===== Solution as a Non-Root user =====

You don't have root access? Never fear, we can still fix the problem. It'll just be a tad more difficult.

Navigate to the <tt>fs2_open/code</tt> directory and locate a file named <tt>Makefile</tt> (not Makefile.rm or Makefile.in or Makefile.anything). Open it in your favorite text editor and make the following changes.

Find this line (line 457 in mine):
FS2_LDFLAGS = -L/usr/lib -Wl,-rpath,/usr/lib -lSDL -lpthread -lGL -lGLU -lopenal -logg -lvorbis -lvorbisfile

And replace it with this:
FS2_LDFLAGS = -L/usr/lib -Wl,-rpath,/usr/lib -lSDL -lpthread -lGL -lopenal -logg -lvorbis -lvorbisfile -L/usr/X11R6/lib -lGLU

Also find this one (line 565 in mine):
AM_LDFLAGS = -g -L/usr/lib -Wl,-rpath,/usr/lib -lSDL -lpthread -lGL -lGLU -lopenal -logg -lvorbis -lvorbisfile

And replace it with this:
AM_LDFLAGS = -g -L/usr/lib -Wl,-rpath,/usr/lib -lSDL -lpthread -lGL -lopenal -logg -lvorbis -lvorbisfile -L/usr/X11R6/lib -lGLU

Then run <tt>make</tt> from the <tt>fs2_open</tt> directory, and watch the magic happen.

==== glBindBufferARB feature missing ====
''If this is the actual solution to this problem remains to be seen.'' 
''So far, only people using Debian stable are affected by this.'' 
''So we need adventurus Debian users to confirm.'' 
''I can confirm that the APT-Pinning works, can not confirm compile thou. -- ni1s'' 
checking for glBindBufferARB in -lGL... no
configure: error: *** OpenGL version does not have the required features!! (ie.glBindBufferARB()) ***
This error appears if the installed Mesa development library is to old.

On Debian stable branch the xlibmesa-gl-dev package holds version 4.3.0. 
The xlibmesa-gl-dev package on ''testning'' is version 6.9.0.

'''Possible solution:''' 
First set /etc/apt/sources.list to include the testing branch. Add:
#Testing
deb http://ftp.us.debian.org/debian testing main non-free contrib
deb http://non-us.debian.org/debian-non-US testing/non-US main contrib non-free
Your sources.list might have these lines already, if so, you should be okej.

Your /etc/apt/preferences file should look like this
Package: *
Pin: release a=stable
Pin-Priority: 700

Package: *
Pin: release a=testing
Pin-Priority: 650

Package: *
Pin: release a=unstable
Pin-Priority: 600

Add to that file:
Package: xlibmesa-gl-dev
Pin: release a=testing
Pin-Priority: 800
Note that the Pin-Priority of xlibmesa-gl-dev here is higher than the Pin-Priority on 'stable'. As a result of this APT get will prioritize the xlibmesa-gl-dev from testing and leave the rest of the system on stable.
This is called apt-pinning.

Now that APT knows what xlibmesa-gl-dev to prioritze, install it again:
$ apt-get install xlibmesa-gl-dev

If you are using nVidia's nvidia-kernel and glx packages, a simple:
$ apt-get install nvidia-glx-dev
should suffice. No need to mess around with APT-pinning.

=== Runtime Errors and common problems ===
==== ERROR: "Web cursor bitmap not found." ====
ERROR: "Web cursor bitmap not found. This usually means that the executable is being run outside the directory
you installed Freespace2 to. Please move the executable to that directory and try again" at graphics/2d.cpp:1402
A common error. This happens when fs2_open can't find the .vp files or that your user doesn't have the permissions to access them. If you are using a start up script([http://www.hard-light.net/wiki/index.php/Fs2_open_on_Linux#Creating_a_Start_Up_Script like the one found here]) it's most likly the a permission problem.
Have your user take owenership of the .vp files, run as root:
$ chown <user> /path/to/vpfiles/ -R

=== I18n and Key mapping problems ===
''Me, being a Swede, need to use this aswell, especially for the grave key(`), but I also want to use a second X display. There is a way to tell xmodmap to use the new set of keys on the second X display, and thus eliminating the need for a temp. keymap table as it dies with the second display when exiting fs2_open, never touching the keymap table on display 0. We should dig that info up and write a super-start script. --ni1s'' 
Ok, imagine that like me you don't have an us keyboard but a french one (or anything). Well, you probably have problems mapping some keys or even using the default mapping.

Actually, the problem is fs2_open does not take modifiers into account, as it uses them internally as modifiers for keys, and it won't accept non-us charset either.

On a french keyboard layout, the numbers ''1 2 3 4 5 6 7 8 9 0'' are on the same keys than on a US layout, but you have to press shift to use them. The primary function for theses keys are ''& Ã© " ' ( - Ã¨ _ Ã§ Ã )''. These characters won't be accepted by freespace, and if you press shift to get a number, it won't work. This can be a problem, as theses keys are needed to use the communication system, and cannot be bound to anything. Also, as you won't get access some keys on your keyboard, it will be difficult to map every command on a key, or you'll have to use modifiers for nearly each key.

However, there is a solution. You can tell X to remap the keyboard before launching the game, and restore your normal keymap afterwards.

For exemple, I map 123456790 to the &Ã©"'(-Ã¨_Ã§Ã keys so I can use the communication system, and I put , and ; on the Alt-Gr and Menu keys for convenience, as I binded thoses keys to next primary weapon and next secondary weapon.

To do this, I use a slightly enhanced startup script, which I put in ~/bin (this directory is in my path), together with a customized xmodmap.

* First, dump your current xmodmap :

<tt>~ $ xmodmap -pke > ~/xmodmap.current</tt>

* Then edit it with your favorite text editor. You'll see a bunch of lines looking like this :

<tt>
keycode 8 =
keycode 9 = Escape
keycode 10 = 1 ampersand onesuperior exclamdown onesuperior exclamdown
</tt>

The syntax is ''keycode <number> = <symbol list>''.

Use '''xev''' to scan the keycodes. The symbols are defined in ''/usr/include/X11/keysymdef.h''. Just make sure you write them without the ''XK_'' prefix. You'll find more information about xmodmap in the xmodmap manual page.

Just modify the keys you need, and be patient. This can be a long process. Test it with xmodmap :

<tt>~ $ xmodmap - < <filename></tt>

But don't forget to have your previous keymap at hand to recover your settings !
If you mess everything up, just restart X. Your default keymap will be applied from the X configuration.

Here is my own fs2 xmodmap, derived from fr-latin1 as described above. Feel free to use it if you're too lazy to modify your own. However, it may not fit with your needs. You may always use it as an exemple, thougt.
* http://clement.hermann.free.fr/fs2/xmodmap

Then, when the file is modified at your liking, just save it as '''~/.fs2_open/xmodmap'''

We'll start fs2_open with a slightly more elaborate startup script which will backup/apply/restore the keymap in addition of running the games with some options in the right directory.

<tt>
#!/bin/sh
# This script lauches fs2. If there is a file named $FS2_modmap (see below),
# backup the current modmap as $TMP_modmap and load it as the new modmap.
# The current modmap will be restored afterwards.

TMP_modmap="$HOME/xmodmap.tmp"
FS2_modmap="$HOME/.fs2_open/xmodmap"

FS2_OPEN_DIR=/usr/local/games/fs2_open

FS2_ARGS="-glow -spec -spec_exp 11 -spec_point 0.6 -spec_static 0.8 -spec_tube 0.4 -fps -jpgtga -ambient_factor 75 -targetinfo -nograb"

FS2_BIN="$FS2_OPEN_DIR/fs2_open_r"

die() {
echo "** Fatal error : $1" >&2
exit 1
}

cd $FS2_OPEN_DIR || die "Could not change directory to $FS2_OPEN_DIR"

# dump current xmodmap
[ -f "$FS2_modmap" ] && xmodmap -pke > $TMP_modmap

# load xmodmap
[ -f "$FS2_modmap" ] && xmodmap - < $FS2_modmap

# prepare to restore xmodmap on crash or exit
trap "xmodmap - < $TMP_modmap && rm $TMP_modmap" 0 2 3 4 9 11 15

# launch fs2
$FS2_BIN $FS2_ARGS $* || die "Error while running \"$FS2_BIN\" with arguments \"$FS2_ARGS\" ($?)"
</tt>

Adapt this script to your needs, and save it somewhere in your PATH - I for exemple usr ~/bin/freespace2. Make it executable with a chmod +x ''<file>''

That's it, now you can use fs2 with full control over your keyboard.

=== fs2_open freezes X ===
A good way of running games on Linux is having them run on a separate X display. The display you are most likely using now when reading this is 0:0. This display is normally used for whatever Window Manager/Desktop Environment(KDE,Gnome,*box,E) you've chosen. Sometimes fs2_open freezes and locks your X. This is of course very annoying as you have to CTRL+ALT+BACKSPACE to kill the X server, and in that, killing whatever program you had running besides fs2_open. The solution to this is to tell X to start fs2_open on another display. To to this we first need to tell X that you,the user on localhost, holds the permission to run on another display.
In a terminal, enter (NOT as root):
$ xauth list
A list that looks something like this should appear.
myuser@localhost ~ $ xauth list
localhost/unix:'''0''' MIT-MAGIC-COOKIE-1 14ec70e7c8cc835def61a04c92bbd50d
Let's look at that line, first up is your localhost, then unix, and last :0 (in bold). The rest is not really of interest.
Copy the whole line, but change the display value to 1 and paste it after the command ''xauth add'', like this:
$ xauth add localhost/unix:'''1''' MIT-MAGIC-COOKIE-1 14ec70e7c8cc835def61a04c92bbd50d
Run xauth list again. You should see a new entry.
myuser@localhost ~ $ xauth list
localhost/unix:'''0''' MIT-MAGIC-COOKIE-1 14ec70e7c8cc835def61a04c92bbd50d
localhost/unix:'''1''' MIT-MAGIC-COOKIE-1 14ec70e7c8cc835def61a04c92bbd50d
You now have permission to use display 1:0.
To start fs2_open in that display, use xinit.
$ xinit /path/to/fs2_open_r -foo -bar -- :1
The ''-- :1'' tells X that we want to start fs2_open on display 1. 
You can switch to display 0 and 1 with CTRL+ALT+F7 and CTRL+ALT+F8 respectively.

If you try this from an xterm (or a similar X terminal program) and obtain the error ''X: user not authorized to run the X server, aborting.'', the reason might be the file /etc/X11/Xwrapper.config. On my ubuntu machine, it contains the line

allowed_users=console

which means that only users logged in from a console terminal may start a new X server. However, on an xterm, you are on a '''virtual''' terminal and so the above does not work. A possibility is to change the allowed_users in the Xwrapper.config file to "anybody" (see man Xwrapper.config). However, this undermines X security. Another possibility is to start the xinit command from a console window (to which you can change with CTRL+ALT+F1-6).

''If someone knows of a good method to start fs2 on a second X display from an xterm without changing Xwrapper.config, please report it here.''

''A solution might be running xinit as root with sudo, and drop the root privileges in the startup script... Didn't tried, though.'' -- nodens

[[Category:Source Code Project]]

Guide to FS Open on Linux

2006-07-01T12:27:41Z

Nodens: Even better with proper punctuation

''This tutorial assumes some fundamental command line knowledge. ''
''As a rule of thumb, do not copy/paste commands without understanding them, especially as root. With great power comes great responsability.''
== Installing CVS ==
CVS stands for Concurrent Versions System and is a version control system used to record the changes in documents, such as source files. Developers use CVS so they can easily share their code changes among other developers. You will need this tool to download ("checkout" in CVS terminology) fs2_open from the CVS server.

'''Debian/Ubuntu''' users want to:
$ apt-get install cvs
'''Gentoo''' users want to:
$ emerge cvs

'''NOTE: Redhat, Mandrake/Mandriva, Slackware and all the other distros should go here too,'''
'''but we have no knowledge on how these work, so if you do, please enlighten us.'''

== Installing the nessesary development libraries ==
You will also need SDL, OpenAL, libvorbis and OpenGL(most likely provided with your video card driver) development packages. And of course the GCC compiler and required make tools.
 
'''Debian/Ubuntu''' users want to:
$ apt-get install libopenal-dev libvorbis-dev build-essential automake1.9 autoconf libsdl-dev
'''NOTE:''' The ''build-essential'' meta package installs GCC4. This should work, but if you feel safer with GCC 3.4(gcc-3.4), add it to the apt-get line above. 
'''Gentoo''' users want to:
$ emerge openal libvorbis libsdl
'''NOTE: Radhat, Mandrake,Slackware and all the other distros should go here too,'''
'''but we have no knowlage on how these work, so if you do, please enlighten us.'''

== Installing game data files ==

This tutorial deals primarily with providing you with an executable, but in order to play the game you also need the game data. Freespace 2 game data is available from a number of sources, see this thread: http://www.hard-light.net/forums/index.php/topic,38195.0.html

Note that if you use the retail CD, you'll need to extract the files and to copy them on your drive, reproducing the same layout as in a working win32 installation (just make sure every file is lowercase). This thread on the SCP forum has some more info on it : http://scp.indiegames.us/forum_viewtopic.php?3.282

There are two ways of doing this :
* use wine to install the game in the right directory, using the Setup.exe found on the first CD, or
* extract manually the files from the cd.

The second method is detailed below. The wine one is straightforward and you shouldn't need any specific instruction, but you'll have to fix permissions and lowercase the filename as well, so keep reading.

===Extracting data from CD===
====Installing unshield====

First, you need unshield from http://synce.sourceforge.net/synce/unshield.php

If you use debian, apt-get install unshield as root should do the trick. Else, try to find a package for your distribution, or if you don't, compile it yourself following the instructions provided on the website. Note you don't need to actually install it, just compile it and use it from the directory where you compiled it.

====Preparing directories====

* Create a directory for fs2_open, say, ''/usr/local/games/fs2_open'', with a ''data/movies'' and ''data/players'' subdirectories. Everything but user files and configuration will be in this directory. You'll probably need to be root or use sudo for most of the following commands if you use a global directory like the one in this example.

''Warning : Again, please double check the commands you run as root. A single typo could destroy your data. 'Remember what is said on the top of the page ? if not, go re-read it.''

<tt>~ $ mkdir -p /usr/local/games/fs2_open/data/movies /usr/local/games/fs2_open/data/players</tt>

====Extracting files====

* Use unshield to extract the groups from data1.cab (on the first cd) to a temporary directory; then move the files in your game directory :
<tt>~ $ mkdir /tmp/fs2
~ $ for group in "Basic Install Files" "Intel Anims" "Music Compressed" "High Res Files"; do unshield -d tmp/fs2/ -g "$group" -L -j x disk1/data1.cab && mv -v /tmp/fs2/*/* /home/data/jeux/fs2_open
~ $ unshield -d /usr/local/games/fs2_open/data/players -g "Hud Config Files" -L -j x data1.cab && mv -v /tmp/fs2/hud_config_files/* /home/data/jeux/fs2_open/data/players</tt>

* From the second CD, get the vp files and the movies files (I dont think the the mve file are really needed, you'll need the avi ones if you want the movies).
<tt>~ $ cp -vf *.vp /usr/local/games/fs2_open</tt>
<tt>~ $ mkdir -p /usr/local/games/fs2_open/data/movies/ && cp -vf *.MVE /usr/local/games/fs2_open/data/movies/</tt>
* Do the same for the third CD :
<tt>~ $ cp -vf *.vp /usr/local/games/fs2_open</tt>
<tt>~ $ cp -vf *.MVE /usr/local/games/fs2_open/data/movies/</tt>

You may notice that some files are on all three CD. This is because the games was meant to be run from CD. Don't bother.

=== Fixing Case and permissions ===
* You '''have''' to make sure everything is lowercase :
<tt>~ $ find /usr/local/games/fs2_open/ | rename -v 'y/A-Z/a-z/'</tt>

* Then, fix permissions :
<tt>~ $ find /usr/local/games/fs2_open -type d -exec chmod a+rx '{}' \;</tt>
<tt>~ $ find /usr/local/games/fs2_open -type f -exec chmod a+r '{}' \;</tt>

===MediaVP and Cutscenes===
You'll also need the mediavp from the SCP if you want the enhanced graphics. Get them at http://scp.indiegames.us.
If you want the cutscenes, you'll have to find the avi version of the MVE files, or to convert them yourself. They are not hard to find. When you have them, just put them in the data/movies directory. Again, make sure everything is lowercase.

That's it for the game data files, now it's time get the source !

== Using the source ==

=== CVS Checkout ===
Before you begin, make sure you have write permissions on your current working directory. Your /home/user/ directory is a pretty sure bet. I recommend that you create a permanent /home/user/src directory from which you run the CVS command, this way CVS will only update the files changed the next time you download the source and it's always nice to have things organized.

Now get the source. Run from a terminal:
$ cvs -d:pserver:anonymous:anonymous@warpcore.org:/home/fs2source/cvsroot login
and then
$ cvs -z3 -d:pserver:anonymous@warpcore.org:/home/fs2source/cvsroot co fs2_open
The first cvs command tells the CVS tool to first use a password file for authentication (pserver), that you are user "anonymous" with the password "anonymous" who wants to access warpcore.org's CVS repository "/home/fs2source/cvsroot" and login. The second command tells the CVS server on which we are now connected to that we want to checkout (co) the fs2_open module.
 
==== CVS Checkout and Update Script ====
The code on CVS is in a constant state of change, and bugs that exist one day may be gone the next. Because of this, you'll want to occasionally update to a newer version and recompile.
Running those cvs commands will fast grow to be a pain, so this little script was created to make your life easier. This script will checkout fs2_open if it can't find a fs2_open directory and update fs2_open, if it finds it.
The script will run until a successfull checkout or update has been achieved.
Copy and save this to a suitably named file like "get_fs2_open", and make it executable with the command, chmod +x <name of file>
#!/bin/bash
# CVS Checkout and Update Script for fs2_open
CVS_LINE="cvs -d:pserver:anonymous:anonymous@warpcore.org:/home/fs2source/cvsroot" # The cvs command
if [ "$UID" = 0 ]; then # check if user is root, and if so, echo a warning.
echo "You are root. If this is a checkout, all files \
will be created with root as the owner."
sleep 3
fi
if [ -e ./fs2_open ]; then # check if directory fs2_open exists
echo "Found fs2_open, We are updating an old checkout."
CVS_ATTEMPT=0 # This updates the checkout.
until [ $CVS_ATTEMPT = 1 ]; do
$CVS_LINE login && \
$CVS_LINE update fs2_open && \
let CVS_ATTEMPT=1
done
else
echo "No fs2_open found, This is a new checkout."
CVS_ATTEMPT=0 # This creates a new checkout.
until [ $CVS_ATTEMPT = 1 ]; do
$CVS_LINE login && \
$CVS_LINE co fs2_open && \
let CVS_ATTEMPT=1
done
fi

=== Pre-Compile Configuration ===

Before you compile you need to configure it for your system. In the directory you ran the CVS command from, a new directory has appear, namely fs2_open.
If your fs2_open is a completely new checkout, you will first need to run the autogen.sh script.
Run from inside your newly created fs2_open directory:
$ ./autogen.sh
autogen.sh is a script that will generate the required makefiles. You will see alot of "checking for this" and "checking for that", this is actually the "configure" script (which can be run with <tt>./configure</tt> if you need to change the options) examining and configuring fs2_open for your system. 
It is possible to give autogen.sh configure options as well, autogen.sh will pass them along to configure.

A full list of configure options can be found by running the configure script with the '--help' option.
$ ./configure --help

==== Optimizing fs2_open ====
Optimizing fs2_open might have little or no effect, or improve performance greatly, I honestly have no clue. 
A note of caution, if you are compiling a debug build, don't use the -fomit-frame-pointer CFLAG, it will make debugging impossible. 
You can specify your compiler flags with the configure script, se below.
$ ./configure CFLAGS="<your desired flags>"
If you got a Athlon-XP and want to play it safe, a good set of CFLAGS would be
$ ./configure CFLAGS="-march=athlon-xp -O3 -pipe -fomit-frame-pointer"
You should read up on CFLAGS and what they do before trying anything. I recommend you read through these links. 
http://gcc.gnu.org/onlinedocs/gcc-3.4.1/gcc/Optimize-Options.html 
http://linuxreviews.org/howtos/compiling/safe-cflags/ 
http://en.wikipedia.org/wiki/CFLAGS

=== Compiling ===

Run from within your fs2_open directory:
$ make
Sit back and enjoy gcc work its magic.

==== Simple Compile Script ====
It's alot easier to use a scripts when dealing with constantly changing code. Copy and save this to a suitably named file like "compile_fs2_open", and make it executable with the command, chmod +x <name of file>
This script assumes the CVS checkout directory fs2_open is pressent in the same directory as the script itself.
#!/bin/bash
# fs2_open Compile Script
# These are only examples, uncomment to enable optimization.
#MY_CFLAGS="-march=athlon-xp -O3 -pipe -fomit-frame-pointer -ftracer"
if [ -e ./fs2_open/ ]; then
cd fs2_open
if [ -e ./Makefile.in ]; then
make clean
./configure CFLAGS="$MY_CFLAGS" CXXFLAGS="$MY_CFLAGS"
make
else
./autogen.sh CFLAGS="$MY_CFLAGS" CXXFLAGS="$MY_CFLAGS"
make
fi
else
echo "No fs2_open directory found."
fi

You can add your options to the ./configure line.

== Using the Binaries ==

When the compile is done and if all went well, a binary executable will reside in the code directory ''fs2_open_r'' or ''fs2_open_d'' if you configured for a debug build. Copy the binary to directory where Freespace2 is installed, and you're all set to go.

=== Post-Compile Configuration ===
==== Changing Your Resolution ====
Odds are, you'll want to run fs2_open in a higher resolution than the default 640x480. Unfortunately, we Linux users don't have the swank launcher app that the Windows folks do. Instead, we'll be making a couple line changes to a config file. You will need to run fs2_open once before you can make the necessary changes, otherwise you won't have a configuration directory to work with.

Open up ~/.fs2_open/fs2_open.ini with the text editor of your choice (vi, EMACS, kwrite, gedit). You'll see something like the following:
[Default]
VideocardFs2open=OGL -(640x480)x16 bit
LastPlayer=MonkeyboyS
GammaD3D=1.0

To set fs2_open to use the highest setting possible on retail Freespace 2, change the VideocardFs2open to:
VideocardFs2open=OGL -(1024x768)x32 bit
You can set this to pretty much anything you want.

=== Creating a Start Up Script ===

In order to use all of the advanced engine features of fs2_open, you'll need to start the executable with a number of command line arguments. Instead of typing them in every time you want to start the game, why not create a script that does it for you?

Create a new file named start_freespace (or whatever you like) in your home directory. Open the file in your editor of choice, and paste the following:
#!/bin/bash
cd /path/to/your/freespace/
./fs2_open_r -spec -glow -mipmap -jpgtga -orbradar -mod Media_VP

''Note: You will need to edit this script before it will work properly. The second line must point to the directory where you installed fs2_open. You can also find a more elaborated script example below in the i18n section''

The last line starts fs2_open with a number of arguments that turn on extra features. In the example, the game will use specular highlights, glow-mapping, mipmapping, jpg and tga graphic files, the orb radar, and any MediaVPs installed to the /Media_VP directory. You should edit this line to use those features that your system supports.

More information about the available Command Line Arguments can be found at the [[Command-Line Reference]]

Once you've edited the file to your heart's content, make it executable:
$ chmod +x start_freespace

You can now type in start_freespace to start the game, or by clicking on start_freespace in your window manager. For convenience, you can copy it to your Desktop.

== Troubleshooting ==
=== Compile Errors ===
==== Missing -lGLU compile error ====

On some Linux distributions (''Slackware'' for instance), compiling fails because a GL related library doesn't have a link in the <tt>/usr/lib</tt> directory. If the compile fails because it can't find <tt>-lGLU</tt>, here are two ways to fix it:

===== Solution as Root =====

If you have root access to the system, you can create a link to the library in question with just a little bit of command line magic. Go to a console and enter:

$ ln -s /usr/X11R6/lib/libGLU.so /usr/lib/libGLU.so

After that, you can run make again and it should finish compiling.

===== Solution as a Non-Root user =====

You don't have root access? Never fear, we can still fix the problem. It'll just be a tad more difficult.

Navigate to the <tt>fs2_open/code</tt> directory and locate a file named <tt>Makefile</tt> (not Makefile.rm or Makefile.in or Makefile.anything). Open it in your favorite text editor and make the following changes.

Find this line (line 457 in mine):
FS2_LDFLAGS = -L/usr/lib -Wl,-rpath,/usr/lib -lSDL -lpthread -lGL -lGLU -lopenal -logg -lvorbis -lvorbisfile

And replace it with this:
FS2_LDFLAGS = -L/usr/lib -Wl,-rpath,/usr/lib -lSDL -lpthread -lGL -lopenal -logg -lvorbis -lvorbisfile -L/usr/X11R6/lib -lGLU

Also find this one (line 565 in mine):
AM_LDFLAGS = -g -L/usr/lib -Wl,-rpath,/usr/lib -lSDL -lpthread -lGL -lGLU -lopenal -logg -lvorbis -lvorbisfile

And replace it with this:
AM_LDFLAGS = -g -L/usr/lib -Wl,-rpath,/usr/lib -lSDL -lpthread -lGL -lopenal -logg -lvorbis -lvorbisfile -L/usr/X11R6/lib -lGLU

Then run <tt>make</tt> from the <tt>fs2_open</tt> directory, and watch the magic happen.

==== glBindBufferARB feature missing ====
''If this is the actual solution to this problem remains to be seen.'' 
''So far, only people using Debian stable are affected by this.'' 
''So we need adventurus Debian users to confirm.'' 
''I can confirm that the APT-Pinning works, can not confirm compile thou. -- ni1s'' 
checking for glBindBufferARB in -lGL... no
configure: error: *** OpenGL version does not have the required features!! (ie.glBindBufferARB()) ***
This error appears if the installed Mesa development library is to old.

On Debian stable branch the xlibmesa-gl-dev package holds version 4.3.0. 
The xlibmesa-gl-dev package on ''testning'' is version 6.9.0.

'''Possible solution:''' 
First set /etc/apt/sources.list to include the testing branch. Add:
#Testing
deb http://ftp.us.debian.org/debian testing main non-free contrib
deb http://non-us.debian.org/debian-non-US testing/non-US main contrib non-free
Your sources.list might have these lines already, if so, you should be okej.

Your /etc/apt/preferences file should look like this
Package: *
Pin: release a=stable
Pin-Priority: 700

Package: *
Pin: release a=testing
Pin-Priority: 650

Package: *
Pin: release a=unstable
Pin-Priority: 600

Add to that file:
Package: xlibmesa-gl-dev
Pin: release a=testing
Pin-Priority: 800
Note that the Pin-Priority of xlibmesa-gl-dev here is higher than the Pin-Priority on 'stable'. As a result of this APT get will prioritize the xlibmesa-gl-dev from testing and leave the rest of the system on stable.
This is called apt-pinning.

Now that APT knows what xlibmesa-gl-dev to prioritze, install it again:
$ apt-get install xlibmesa-gl-dev

If you are using nVidia's nvidia-kernel and glx packages, a simple:
$ apt-get install nvidia-glx-dev
should suffice. No need to mess around with APT-pinning.

=== Runtime Errors and common problems ===
==== ERROR: "Web cursor bitmap not found." ====
ERROR: "Web cursor bitmap not found. This usually means that the executable is being run outside the directory
you installed Freespace2 to. Please move the executable to that directory and try again" at graphics/2d.cpp:1402
A common error. This happens when fs2_open can't find the .vp files or that your user doesn't have the permissions to access them. If you are using a start up script([http://www.hard-light.net/wiki/index.php/Fs2_open_on_Linux#Creating_a_Start_Up_Script like the one found here]) it's most likly the a permission problem.
Have your user take owenership of the .vp files, run as root:
$ chown <user> /path/to/vpfiles/ -R

=== I18n and Key mapping problems ===
''Me, being a Swede, need to use this aswell, especially for the grave key(`), but I also want to use a second X display. There is a way to tell xmodmap to use the new set of keys on the second X display, and thus eliminating the need for a temp. keymap table as it dies with the second display when exiting fs2_open, never touching the keymap table on display 0. We should dig that info up and write a super-start script. --ni1s'' 
Ok, imagine that like me you don't have an us keyboard but a french one (or anything). Well, you probably have problems mapping some keys or even using the default mapping.

Actually, the problem is fs2_open does not take modifiers into account, as it uses them internally as modifiers for keys, and it won't accept non-us charset either.

On a french keyboard layout, the numbers ''1 2 3 4 5 6 7 8 9 0'' are on the same keys than on a US layout, but you have to press shift to use them. The primary function for theses keys are ''& Ã© " ' ( - Ã¨ _ Ã§ Ã )''. These characters won't be accepted by freespace, and if you press shift to get a number, it won't work. This can be a problem, as theses keys are needed to use the communication system, and cannot be bound to anything. Also, as you won't get access some keys on your keyboard, it will be difficult to map every command on a key, or you'll have to use modifiers for nearly each key.

However, there is a solution. You can tell X to remap the keyboard before launching the game, and restore your normal keymap afterwards.

For exemple, I map 123456790 to the &Ã©"'(-Ã¨_Ã§Ã keys so I can use the communication system, and I put , and ; on the Alt-Gr and Menu keys for convenience, as I binded thoses keys to next primary weapon and next secondary weapon.

To do this, I use a slightly enhanced startup script, which I put in ~/bin (this directory is in my path), together with a customized xmodmap.

* First, dump your current xmodmap :

<tt>~ $ xmodmap -pke > ~/xmodmap.current</tt>

* Then edit it with your favorite text editor. You'll see a bunch of lines looking like this :

<tt>
keycode 8 =
keycode 9 = Escape
keycode 10 = 1 ampersand onesuperior exclamdown onesuperior exclamdown
</tt>

The syntax is ''keycode <number> = <symbol list>''.

Use '''xev''' to scan the keycodes. The symbols are defined in ''/usr/include/X11/keysymdef.h''. Just make sure you write them without the ''XK_'' prefix. You'll find more information about xmodmap in the xmodmap manual page.

Just modify the keys you need, and be patient. This can be a long process. Test it with xmodmap :

<tt>~ $ xmodmap - < <filename></tt>

But don't forget to have your previous keymap at hand to recover your settings !
If you mess everything up, just restart X. Your default keymap will be applied from the X configuration.

Here is my own fs2 xmodmap, derived from fr-latin1 as described above. Feel free to use it if you're too lazy to modify your own. However, it may not fit with your needs. You may always use it as an exemple, thougt.
* http://clement.hermann.free.fr/fs2/xmodmap

Then, when the file is modified at your liking, just save it as '''~/.fs2_open/xmodmap'''

We'll start fs2_open with a slightly more elaborate startup script which will backup/apply/restore the keymap in addition of running the games with some options in the right directory.

<tt>
#!/bin/sh
# This script lauches fs2. If there is a file named $FS2_modmap (see below),
# backup the current modmap as $TMP_modmap and load it as the new modmap.
# The current modmap will be restored afterwards.

TMP_modmap="$HOME/xmodmap.tmp"
FS2_modmap="$HOME/.fs2_open/xmodmap"

FS2_OPEN_DIR=/usr/local/games/fs2_open

FS2_ARGS="-glow -spec -spec_exp 11 -spec_point 0.6 -spec_static 0.8 -spec_tube 0.4 -fps -jpgtga -ambient_factor 75 -targetinfo -nograb"

FS2_BIN="$FS2_OPEN_DIR/fs2_open_r"

die() {
echo "** Fatal error : $1" >&2
exit 1
}

cd $FS2_OPEN_DIR || die "Could not change directory to $FS2_OPEN_DIR"

# dump current xmodmap
[ -f "$FS2_modmap" ] && xmodmap -pke > $TMP_modmap

# load xmodmap
[ -f "$FS2_modmap" ] && xmodmap - < $FS2_modmap

# prepare to restore xmodmap on crash or exit
trap "xmodmap - < $TMP_modmap && rm $TMP_modmap" 0 2 3 4 9 11 15

# launch fs2
$FS2_BIN $FS2_ARGS $* || die "Error while running \"$FS2_BIN\" with arguments \"$FS2_ARGS\" ($?)"
</tt>

Adapt this script to your needs, and save it somewhere in your PATH - I for exemple usr ~/bin/freespace2. Make it executable with a chmod +x ''<file>''

That's it, now you can use fs2 with full control over your keyboard.

=== fs2_open freezes X ===
A good way of running games on Linux is having them run on a separate X display. The display you are most likely using now when reading this is 0:0. This display is normally used for whatever Window Manager/Desktop Environment(KDE,Gnome,*box,E) you've chosen. Sometimes fs2_open freezes and locks your X. This is of course very annoying as you have to CTRL+ALT+BACKSPACE to kill the X server, and in that, killing whatever program you had running besides fs2_open. The solution to this is to tell X to start fs2_open on another display. To to this we first need to tell X that you,the user on localhost, holds the permission to run on another display.
In a terminal, enter (NOT as root):
$ xauth list
A list that looks something like this should appear.
myuser@localhost ~ $ xauth list
localhost/unix:'''0''' MIT-MAGIC-COOKIE-1 14ec70e7c8cc835def61a04c92bbd50d
Let's look at that line, first up is your localhost, then unix, and last :0 (in bold). The rest is not really of interest.
Copy the whole line, but change the display value to 1 and paste it after the command ''xauth add'', like this:
$ xauth add localhost/unix:'''1''' MIT-MAGIC-COOKIE-1 14ec70e7c8cc835def61a04c92bbd50d
Run xauth list again. You should see a new entry.
myuser@localhost ~ $ xauth list
localhost/unix:'''0''' MIT-MAGIC-COOKIE-1 14ec70e7c8cc835def61a04c92bbd50d
localhost/unix:'''1''' MIT-MAGIC-COOKIE-1 14ec70e7c8cc835def61a04c92bbd50d
You now have permission to use display 1:0.
To start fs2_open in that display, use xinit.
$ xinit /path/to/fs2_open_r -foo -bar -- :1
The ''-- :1'' tells X that we want to start fs2_open on display 1. 
You can switch to display 0 and 1 with CTRL+ALT+F7 and CTRL+ALT+F8 respectively.

If you try this from an xterm (or a similar X terminal program) and obtain the error ''X: user not authorized to run the X server, aborting.'', the reason might be the file /etc/X11/Xwrapper.config. On my ubuntu machine, it contains the line

allowed_users=console

which means that only users logged in from a console terminal may start a new X server. However, on an xterm, you are on a '''virtual''' terminal and so the above does not work. A possibility is to change the allowed_users in the Xwrapper.config file to "anybody" (see man Xwrapper.config). However, this undermines X security. Another possibility is to start the xinit command from a console window (to which you can change with CTRL+ALT+F1-6).

''If someone knows of a good method to start fs2 on a second X display from an xterm without changing Xwrapper.config, please report it here.''

''A solution might be running xinit as root with sudo, and drop the root privileges in the startup script... Didn't tried, though.'' -- nodens

Guide to FS Open on Linux

2006-07-01T12:26:51Z

Nodens: Well, no need to say the same thing twice.

''This tutorial assumes some fundamental command line knowledge. ''
''As a rule of thumb, do not copy/paste commands without understanding them, especially as root. With great power comes great responsability.''
== Installing CVS ==
CVS stands for Concurrent Versions System and is a version control system used to record the changes in documents, such as source files. Developers use CVS so they can easily share their code changes among other developers. You will need this tool to download ("checkout" in CVS terminology) fs2_open from the CVS server.

'''Debian/Ubuntu''' users want to:
$ apt-get install cvs
'''Gentoo''' users want to:
$ emerge cvs

'''NOTE: Redhat, Mandrake/Mandriva, Slackware and all the other distros should go here too,'''
'''but we have no knowledge on how these work, so if you do, please enlighten us.'''

== Installing the nessesary development libraries ==
You will also need SDL, OpenAL, libvorbis and OpenGL(most likely provided with your video card driver) development packages. And of course the GCC compiler and required make tools.
 
'''Debian/Ubuntu''' users want to:
$ apt-get install libopenal-dev libvorbis-dev build-essential automake1.9 autoconf libsdl-dev
'''NOTE:''' The ''build-essential'' meta package installs GCC4. This should work, but if you feel safer with GCC 3.4(gcc-3.4), add it to the apt-get line above. 
'''Gentoo''' users want to:
$ emerge openal libvorbis libsdl
'''NOTE: Radhat, Mandrake,Slackware and all the other distros should go here too,'''
'''but we have no knowlage on how these work, so if you do, please enlighten us.'''

== Installing game data files ==

This tutorial deals primarily with providing you with an executable, but in order to play the game you also need the game data. Freespace 2 game data is available from a number of sources, see this thread: http://www.hard-light.net/forums/index.php/topic,38195.0.html

Note that if you use the retail CD, you'll need to extract the files and to copy them on your drive, reproducing the same layout as in a working win32 installation (just make sure every file is lowercase). This thread on the SCP forum has some more info on it : http://scp.indiegames.us/forum_viewtopic.php?3.282

There are two ways of doing this :
* use wine to install the game in the right directory, using the Setup.exe found on the first CD, or
* extract manually the files from the cd.

The second method is detailed below. The wine one is straightforward and you shouldn't need any specific instruction, but you'll have to fix permissions and lowercase the filename as well, so keep reading.

===Extracting data from CD===
====Installing unshield====

First, you need unshield from http://synce.sourceforge.net/synce/unshield.php

If you use debian, apt-get install unshield as root should do the trick. Else, try to find a package for your distribution, or if you don't, compile it yourself following the instructions provided on the website. Note you don't need to actually install it, just compile it and use it from the directory where you compiled it.

====Preparing directories====

* Create a directory for fs2_open, say, ''/usr/local/games/fs2_open'', with a ''data/movies'' and ''data/players'' subdirectories. Everything but user files and configuration will be in this directory. You'll probably need to be root or use sudo for most of the following commands if you use a global directory like the one in this example.

''Warning : please double check the commands you run as root. A single typo could destroy your data. 'Remember what is said on the top of the page ? if not, go re-read it''

<tt>~ $ mkdir -p /usr/local/games/fs2_open/data/movies /usr/local/games/fs2_open/data/players</tt>

====Extracting files====

* Use unshield to extract the groups from data1.cab (on the first cd) to a temporary directory; then move the files in your game directory :
<tt>~ $ mkdir /tmp/fs2
~ $ for group in "Basic Install Files" "Intel Anims" "Music Compressed" "High Res Files"; do unshield -d tmp/fs2/ -g "$group" -L -j x disk1/data1.cab && mv -v /tmp/fs2/*/* /home/data/jeux/fs2_open
~ $ unshield -d /usr/local/games/fs2_open/data/players -g "Hud Config Files" -L -j x data1.cab && mv -v /tmp/fs2/hud_config_files/* /home/data/jeux/fs2_open/data/players</tt>

* From the second CD, get the vp files and the movies files (I dont think the the mve file are really needed, you'll need the avi ones if you want the movies).
<tt>~ $ cp -vf *.vp /usr/local/games/fs2_open</tt>
<tt>~ $ mkdir -p /usr/local/games/fs2_open/data/movies/ && cp -vf *.MVE /usr/local/games/fs2_open/data/movies/</tt>
* Do the same for the third CD :
<tt>~ $ cp -vf *.vp /usr/local/games/fs2_open</tt>
<tt>~ $ cp -vf *.MVE /usr/local/games/fs2_open/data/movies/</tt>

You may notice that some files are on all three CD. This is because the games was meant to be run from CD. Don't bother.

=== Fixing Case and permissions ===
* You '''have''' to make sure everything is lowercase :
<tt>~ $ find /usr/local/games/fs2_open/ | rename -v 'y/A-Z/a-z/'</tt>

* Then, fix permissions :
<tt>~ $ find /usr/local/games/fs2_open -type d -exec chmod a+rx '{}' \;</tt>
<tt>~ $ find /usr/local/games/fs2_open -type f -exec chmod a+r '{}' \;</tt>

===MediaVP and Cutscenes===
You'll also need the mediavp from the SCP if you want the enhanced graphics. Get them at http://scp.indiegames.us.
If you want the cutscenes, you'll have to find the avi version of the MVE files, or to convert them yourself. They are not hard to find. When you have them, just put them in the data/movies directory. Again, make sure everything is lowercase.

That's it for the game data files, now it's time get the source !

== Using the source ==

=== CVS Checkout ===
Before you begin, make sure you have write permissions on your current working directory. Your /home/user/ directory is a pretty sure bet. I recommend that you create a permanent /home/user/src directory from which you run the CVS command, this way CVS will only update the files changed the next time you download the source and it's always nice to have things organized.

Now get the source. Run from a terminal:
$ cvs -d:pserver:anonymous:anonymous@warpcore.org:/home/fs2source/cvsroot login
and then
$ cvs -z3 -d:pserver:anonymous@warpcore.org:/home/fs2source/cvsroot co fs2_open
The first cvs command tells the CVS tool to first use a password file for authentication (pserver), that you are user "anonymous" with the password "anonymous" who wants to access warpcore.org's CVS repository "/home/fs2source/cvsroot" and login. The second command tells the CVS server on which we are now connected to that we want to checkout (co) the fs2_open module.
 
==== CVS Checkout and Update Script ====
The code on CVS is in a constant state of change, and bugs that exist one day may be gone the next. Because of this, you'll want to occasionally update to a newer version and recompile.
Running those cvs commands will fast grow to be a pain, so this little script was created to make your life easier. This script will checkout fs2_open if it can't find a fs2_open directory and update fs2_open, if it finds it.
The script will run until a successfull checkout or update has been achieved.
Copy and save this to a suitably named file like "get_fs2_open", and make it executable with the command, chmod +x <name of file>
#!/bin/bash
# CVS Checkout and Update Script for fs2_open
CVS_LINE="cvs -d:pserver:anonymous:anonymous@warpcore.org:/home/fs2source/cvsroot" # The cvs command
if [ "$UID" = 0 ]; then # check if user is root, and if so, echo a warning.
echo "You are root. If this is a checkout, all files \
will be created with root as the owner."
sleep 3
fi
if [ -e ./fs2_open ]; then # check if directory fs2_open exists
echo "Found fs2_open, We are updating an old checkout."
CVS_ATTEMPT=0 # This updates the checkout.
until [ $CVS_ATTEMPT = 1 ]; do
$CVS_LINE login && \
$CVS_LINE update fs2_open && \
let CVS_ATTEMPT=1
done
else
echo "No fs2_open found, This is a new checkout."
CVS_ATTEMPT=0 # This creates a new checkout.
until [ $CVS_ATTEMPT = 1 ]; do
$CVS_LINE login && \
$CVS_LINE co fs2_open && \
let CVS_ATTEMPT=1
done
fi

=== Pre-Compile Configuration ===

Before you compile you need to configure it for your system. In the directory you ran the CVS command from, a new directory has appear, namely fs2_open.
If your fs2_open is a completely new checkout, you will first need to run the autogen.sh script.
Run from inside your newly created fs2_open directory:
$ ./autogen.sh
autogen.sh is a script that will generate the required makefiles. You will see alot of "checking for this" and "checking for that", this is actually the "configure" script (which can be run with <tt>./configure</tt> if you need to change the options) examining and configuring fs2_open for your system. 
It is possible to give autogen.sh configure options as well, autogen.sh will pass them along to configure.

A full list of configure options can be found by running the configure script with the '--help' option.
$ ./configure --help

==== Optimizing fs2_open ====
Optimizing fs2_open might have little or no effect, or improve performance greatly, I honestly have no clue. 
A note of caution, if you are compiling a debug build, don't use the -fomit-frame-pointer CFLAG, it will make debugging impossible. 
You can specify your compiler flags with the configure script, se below.
$ ./configure CFLAGS="<your desired flags>"
If you got a Athlon-XP and want to play it safe, a good set of CFLAGS would be
$ ./configure CFLAGS="-march=athlon-xp -O3 -pipe -fomit-frame-pointer"
You should read up on CFLAGS and what they do before trying anything. I recommend you read through these links. 
http://gcc.gnu.org/onlinedocs/gcc-3.4.1/gcc/Optimize-Options.html 
http://linuxreviews.org/howtos/compiling/safe-cflags/ 
http://en.wikipedia.org/wiki/CFLAGS

=== Compiling ===

Run from within your fs2_open directory:
$ make
Sit back and enjoy gcc work its magic.

==== Simple Compile Script ====
It's alot easier to use a scripts when dealing with constantly changing code. Copy and save this to a suitably named file like "compile_fs2_open", and make it executable with the command, chmod +x <name of file>
This script assumes the CVS checkout directory fs2_open is pressent in the same directory as the script itself.
#!/bin/bash
# fs2_open Compile Script
# These are only examples, uncomment to enable optimization.
#MY_CFLAGS="-march=athlon-xp -O3 -pipe -fomit-frame-pointer -ftracer"
if [ -e ./fs2_open/ ]; then
cd fs2_open
if [ -e ./Makefile.in ]; then
make clean
./configure CFLAGS="$MY_CFLAGS" CXXFLAGS="$MY_CFLAGS"
make
else
./autogen.sh CFLAGS="$MY_CFLAGS" CXXFLAGS="$MY_CFLAGS"
make
fi
else
echo "No fs2_open directory found."
fi

You can add your options to the ./configure line.

== Using the Binaries ==

When the compile is done and if all went well, a binary executable will reside in the code directory ''fs2_open_r'' or ''fs2_open_d'' if you configured for a debug build. Copy the binary to directory where Freespace2 is installed, and you're all set to go.

=== Post-Compile Configuration ===
==== Changing Your Resolution ====
Odds are, you'll want to run fs2_open in a higher resolution than the default 640x480. Unfortunately, we Linux users don't have the swank launcher app that the Windows folks do. Instead, we'll be making a couple line changes to a config file. You will need to run fs2_open once before you can make the necessary changes, otherwise you won't have a configuration directory to work with.

Open up ~/.fs2_open/fs2_open.ini with the text editor of your choice (vi, EMACS, kwrite, gedit). You'll see something like the following:
[Default]
VideocardFs2open=OGL -(640x480)x16 bit
LastPlayer=MonkeyboyS
GammaD3D=1.0

To set fs2_open to use the highest setting possible on retail Freespace 2, change the VideocardFs2open to:
VideocardFs2open=OGL -(1024x768)x32 bit
You can set this to pretty much anything you want.

=== Creating a Start Up Script ===

In order to use all of the advanced engine features of fs2_open, you'll need to start the executable with a number of command line arguments. Instead of typing them in every time you want to start the game, why not create a script that does it for you?

Create a new file named start_freespace (or whatever you like) in your home directory. Open the file in your editor of choice, and paste the following:
#!/bin/bash
cd /path/to/your/freespace/
./fs2_open_r -spec -glow -mipmap -jpgtga -orbradar -mod Media_VP

''Note: You will need to edit this script before it will work properly. The second line must point to the directory where you installed fs2_open. You can also find a more elaborated script example below in the i18n section''

The last line starts fs2_open with a number of arguments that turn on extra features. In the example, the game will use specular highlights, glow-mapping, mipmapping, jpg and tga graphic files, the orb radar, and any MediaVPs installed to the /Media_VP directory. You should edit this line to use those features that your system supports.

More information about the available Command Line Arguments can be found at the [[Command-Line Reference]]

Once you've edited the file to your heart's content, make it executable:
$ chmod +x start_freespace

You can now type in start_freespace to start the game, or by clicking on start_freespace in your window manager. For convenience, you can copy it to your Desktop.

== Troubleshooting ==
=== Compile Errors ===
==== Missing -lGLU compile error ====

On some Linux distributions (''Slackware'' for instance), compiling fails because a GL related library doesn't have a link in the <tt>/usr/lib</tt> directory. If the compile fails because it can't find <tt>-lGLU</tt>, here are two ways to fix it:

===== Solution as Root =====

If you have root access to the system, you can create a link to the library in question with just a little bit of command line magic. Go to a console and enter:

$ ln -s /usr/X11R6/lib/libGLU.so /usr/lib/libGLU.so

After that, you can run make again and it should finish compiling.

===== Solution as a Non-Root user =====

You don't have root access? Never fear, we can still fix the problem. It'll just be a tad more difficult.

Navigate to the <tt>fs2_open/code</tt> directory and locate a file named <tt>Makefile</tt> (not Makefile.rm or Makefile.in or Makefile.anything). Open it in your favorite text editor and make the following changes.

Find this line (line 457 in mine):
FS2_LDFLAGS = -L/usr/lib -Wl,-rpath,/usr/lib -lSDL -lpthread -lGL -lGLU -lopenal -logg -lvorbis -lvorbisfile

And replace it with this:
FS2_LDFLAGS = -L/usr/lib -Wl,-rpath,/usr/lib -lSDL -lpthread -lGL -lopenal -logg -lvorbis -lvorbisfile -L/usr/X11R6/lib -lGLU

Also find this one (line 565 in mine):
AM_LDFLAGS = -g -L/usr/lib -Wl,-rpath,/usr/lib -lSDL -lpthread -lGL -lGLU -lopenal -logg -lvorbis -lvorbisfile

And replace it with this:
AM_LDFLAGS = -g -L/usr/lib -Wl,-rpath,/usr/lib -lSDL -lpthread -lGL -lopenal -logg -lvorbis -lvorbisfile -L/usr/X11R6/lib -lGLU

Then run <tt>make</tt> from the <tt>fs2_open</tt> directory, and watch the magic happen.

==== glBindBufferARB feature missing ====
''If this is the actual solution to this problem remains to be seen.'' 
''So far, only people using Debian stable are affected by this.'' 
''So we need adventurus Debian users to confirm.'' 
''I can confirm that the APT-Pinning works, can not confirm compile thou. -- ni1s'' 
checking for glBindBufferARB in -lGL... no
configure: error: *** OpenGL version does not have the required features!! (ie.glBindBufferARB()) ***
This error appears if the installed Mesa development library is to old.

On Debian stable branch the xlibmesa-gl-dev package holds version 4.3.0. 
The xlibmesa-gl-dev package on ''testning'' is version 6.9.0.

'''Possible solution:''' 
First set /etc/apt/sources.list to include the testing branch. Add:
#Testing
deb http://ftp.us.debian.org/debian testing main non-free contrib
deb http://non-us.debian.org/debian-non-US testing/non-US main contrib non-free
Your sources.list might have these lines already, if so, you should be okej.

Your /etc/apt/preferences file should look like this
Package: *
Pin: release a=stable
Pin-Priority: 700

Package: *
Pin: release a=testing
Pin-Priority: 650

Package: *
Pin: release a=unstable
Pin-Priority: 600

Add to that file:
Package: xlibmesa-gl-dev
Pin: release a=testing
Pin-Priority: 800
Note that the Pin-Priority of xlibmesa-gl-dev here is higher than the Pin-Priority on 'stable'. As a result of this APT get will prioritize the xlibmesa-gl-dev from testing and leave the rest of the system on stable.
This is called apt-pinning.

Now that APT knows what xlibmesa-gl-dev to prioritze, install it again:
$ apt-get install xlibmesa-gl-dev

If you are using nVidia's nvidia-kernel and glx packages, a simple:
$ apt-get install nvidia-glx-dev
should suffice. No need to mess around with APT-pinning.

=== Runtime Errors and common problems ===
==== ERROR: "Web cursor bitmap not found." ====
ERROR: "Web cursor bitmap not found. This usually means that the executable is being run outside the directory
you installed Freespace2 to. Please move the executable to that directory and try again" at graphics/2d.cpp:1402
A common error. This happens when fs2_open can't find the .vp files or that your user doesn't have the permissions to access them. If you are using a start up script([http://www.hard-light.net/wiki/index.php/Fs2_open_on_Linux#Creating_a_Start_Up_Script like the one found here]) it's most likly the a permission problem.
Have your user take owenership of the .vp files, run as root:
$ chown <user> /path/to/vpfiles/ -R

=== I18n and Key mapping problems ===
''Me, being a Swede, need to use this aswell, especially for the grave key(`), but I also want to use a second X display. There is a way to tell xmodmap to use the new set of keys on the second X display, and thus eliminating the need for a temp. keymap table as it dies with the second display when exiting fs2_open, never touching the keymap table on display 0. We should dig that info up and write a super-start script. --ni1s'' 
Ok, imagine that like me you don't have an us keyboard but a french one (or anything). Well, you probably have problems mapping some keys or even using the default mapping.

Actually, the problem is fs2_open does not take modifiers into account, as it uses them internally as modifiers for keys, and it won't accept non-us charset either.

On a french keyboard layout, the numbers ''1 2 3 4 5 6 7 8 9 0'' are on the same keys than on a US layout, but you have to press shift to use them. The primary function for theses keys are ''& Ã© " ' ( - Ã¨ _ Ã§ Ã )''. These characters won't be accepted by freespace, and if you press shift to get a number, it won't work. This can be a problem, as theses keys are needed to use the communication system, and cannot be bound to anything. Also, as you won't get access some keys on your keyboard, it will be difficult to map every command on a key, or you'll have to use modifiers for nearly each key.

However, there is a solution. You can tell X to remap the keyboard before launching the game, and restore your normal keymap afterwards.

For exemple, I map 123456790 to the &Ã©"'(-Ã¨_Ã§Ã keys so I can use the communication system, and I put , and ; on the Alt-Gr and Menu keys for convenience, as I binded thoses keys to next primary weapon and next secondary weapon.

To do this, I use a slightly enhanced startup script, which I put in ~/bin (this directory is in my path), together with a customized xmodmap.

* First, dump your current xmodmap :

<tt>~ $ xmodmap -pke > ~/xmodmap.current</tt>

* Then edit it with your favorite text editor. You'll see a bunch of lines looking like this :

<tt>
keycode 8 =
keycode 9 = Escape
keycode 10 = 1 ampersand onesuperior exclamdown onesuperior exclamdown
</tt>

The syntax is ''keycode <number> = <symbol list>''.

Use '''xev''' to scan the keycodes. The symbols are defined in ''/usr/include/X11/keysymdef.h''. Just make sure you write them without the ''XK_'' prefix. You'll find more information about xmodmap in the xmodmap manual page.

Just modify the keys you need, and be patient. This can be a long process. Test it with xmodmap :

<tt>~ $ xmodmap - < <filename></tt>

But don't forget to have your previous keymap at hand to recover your settings !
If you mess everything up, just restart X. Your default keymap will be applied from the X configuration.

Here is my own fs2 xmodmap, derived from fr-latin1 as described above. Feel free to use it if you're too lazy to modify your own. However, it may not fit with your needs. You may always use it as an exemple, thougt.
* http://clement.hermann.free.fr/fs2/xmodmap

Then, when the file is modified at your liking, just save it as '''~/.fs2_open/xmodmap'''

We'll start fs2_open with a slightly more elaborate startup script which will backup/apply/restore the keymap in addition of running the games with some options in the right directory.

<tt>
#!/bin/sh
# This script lauches fs2. If there is a file named $FS2_modmap (see below),
# backup the current modmap as $TMP_modmap and load it as the new modmap.
# The current modmap will be restored afterwards.

TMP_modmap="$HOME/xmodmap.tmp"
FS2_modmap="$HOME/.fs2_open/xmodmap"

FS2_OPEN_DIR=/usr/local/games/fs2_open

FS2_ARGS="-glow -spec -spec_exp 11 -spec_point 0.6 -spec_static 0.8 -spec_tube 0.4 -fps -jpgtga -ambient_factor 75 -targetinfo -nograb"

FS2_BIN="$FS2_OPEN_DIR/fs2_open_r"

die() {
echo "** Fatal error : $1" >&2
exit 1
}

cd $FS2_OPEN_DIR || die "Could not change directory to $FS2_OPEN_DIR"

# dump current xmodmap
[ -f "$FS2_modmap" ] && xmodmap -pke > $TMP_modmap

# load xmodmap
[ -f "$FS2_modmap" ] && xmodmap - < $FS2_modmap

# prepare to restore xmodmap on crash or exit
trap "xmodmap - < $TMP_modmap && rm $TMP_modmap" 0 2 3 4 9 11 15

# launch fs2
$FS2_BIN $FS2_ARGS $* || die "Error while running \"$FS2_BIN\" with arguments \"$FS2_ARGS\" ($?)"
</tt>

Adapt this script to your needs, and save it somewhere in your PATH - I for exemple usr ~/bin/freespace2. Make it executable with a chmod +x ''<file>''

That's it, now you can use fs2 with full control over your keyboard.

=== fs2_open freezes X ===
A good way of running games on Linux is having them run on a separate X display. The display you are most likely using now when reading this is 0:0. This display is normally used for whatever Window Manager/Desktop Environment(KDE,Gnome,*box,E) you've chosen. Sometimes fs2_open freezes and locks your X. This is of course very annoying as you have to CTRL+ALT+BACKSPACE to kill the X server, and in that, killing whatever program you had running besides fs2_open. The solution to this is to tell X to start fs2_open on another display. To to this we first need to tell X that you,the user on localhost, holds the permission to run on another display.
In a terminal, enter (NOT as root):
$ xauth list
A list that looks something like this should appear.
myuser@localhost ~ $ xauth list
localhost/unix:'''0''' MIT-MAGIC-COOKIE-1 14ec70e7c8cc835def61a04c92bbd50d
Let's look at that line, first up is your localhost, then unix, and last :0 (in bold). The rest is not really of interest.
Copy the whole line, but change the display value to 1 and paste it after the command ''xauth add'', like this:
$ xauth add localhost/unix:'''1''' MIT-MAGIC-COOKIE-1 14ec70e7c8cc835def61a04c92bbd50d
Run xauth list again. You should see a new entry.
myuser@localhost ~ $ xauth list
localhost/unix:'''0''' MIT-MAGIC-COOKIE-1 14ec70e7c8cc835def61a04c92bbd50d
localhost/unix:'''1''' MIT-MAGIC-COOKIE-1 14ec70e7c8cc835def61a04c92bbd50d
You now have permission to use display 1:0.
To start fs2_open in that display, use xinit.
$ xinit /path/to/fs2_open_r -foo -bar -- :1
The ''-- :1'' tells X that we want to start fs2_open on display 1. 
You can switch to display 0 and 1 with CTRL+ALT+F7 and CTRL+ALT+F8 respectively.

If you try this from an xterm (or a similar X terminal program) and obtain the error ''X: user not authorized to run the X server, aborting.'', the reason might be the file /etc/X11/Xwrapper.config. On my ubuntu machine, it contains the line

allowed_users=console

which means that only users logged in from a console terminal may start a new X server. However, on an xterm, you are on a '''virtual''' terminal and so the above does not work. A possibility is to change the allowed_users in the Xwrapper.config file to "anybody" (see man Xwrapper.config). However, this undermines X security. Another possibility is to start the xinit command from a console window (to which you can change with CTRL+ALT+F1-6).

''If someone knows of a good method to start fs2 on a second X display from an xterm without changing Xwrapper.config, please report it here.''

''A solution might be running xinit as root with sudo, and drop the root privileges in the startup script... Didn't tried, though.'' -- nodens

Guide to FS Open on Linux

2006-06-28T21:49:35Z

Nodens: /* Preparing directories */ - wording.

''Note: This tutorial assumes some fundamental command line knowledge.''

== Installing CVS ==
CVS stands for Concurrent Versions System and is a version control system used to record the changes in documents, such as source files. Developers use CVS so they can easily share their code changes among other developers. You will need this tool to download ("checkout" in CVS terminology) fs2_open from the CVS server.

'''Debian/Ubuntu''' users want to:
$ apt-get install cvs
'''Gentoo''' users want to:
$ emerge cvs

'''NOTE: Redhat, Mandrake/Mandriva, Slackware and all the other distros should go here too,'''
'''but we have no knowledge on how these work, so if you do, please enlighten us.'''

== Installing the nessesary development libraries ==
You will also need SDL, OpenAL, libvorbis and OpenGL(most likely provided with your video card driver) development packages. And of course the GCC compiler and required make tools.
 
'''Debian/Ubuntu''' users want to:
$ apt-get install libopenal-dev libvorbis-dev build-essential automake1.9 autoconf libsdl-dev
'''NOTE:''' The ''build-essential'' meta package installs GCC4. This should work, but if you feel safer with GCC 3.4(gcc-3.4), add it to the apt-get line above. 
'''Gentoo''' users want to:
$ emerge openal libvorbis libsdl
'''NOTE: Radhat, Mandrake,Slackware and all the other distros should go here too,'''
'''but we have no knowlage on how these work, so if you do, please enlighten us.'''

== Installing game data files ==

This tutorial deals primarily with providing you with an executable, but in order to play the game you also need the game data. Freespace 2 game data is available from a number of sources, see this thread: http://www.hard-light.net/forums/index.php/topic,38195.0.html

Note that if you use the retail CD, you'll need to extract the files and to copy them on your drive, reproducing the same layout as in a working win32 installation (just make sure every file is lowercase). This thread on the SCP forum has some more info on it : http://scp.indiegames.us/forum_viewtopic.php?3.282

There are two ways of doing this :
* use wine to install the game in the right directory, using the Setup.exe found on the first CD, or
* extract manually the files from the cd.

The second method is detailed below. The wine one is straightforward and you shouldn't need any specific instruction, but you'll have to fix permissions and lowercase the filename as well, so keep reading.

===Extracting data from CD===
====Installing unshield====

First, you need unshield from http://synce.sourceforge.net/synce/unshield.php

If you use debian, apt-get install unshield as root should do the trick. Else, try to find a package for your distribution, or if you don't, compile it yourself following the instructions provided on the website. Note you don't need to actually install it, just compile it and use it from the directory where you compiled it.

====Preparing directories====

* Create a directory for fs2_open, say, ''/usr/local/games/fs2_open'', with a ''data/movies'' and ''data/players'' subdirectories. Everything but user files and configuration will be in this directory. You'll probably need to be root or use sudo for most of the following commands if you use a global directory like the one in this example.

''Warning : please double check the commands you run as root. A single typo could destroy your data. As a rule of thumb, do not copy/paste commands without understanding them, especially as root. With great power comes great responsability.''

<tt>~ $ mkdir -p /usr/local/games/fs2_open/data/movies /usr/local/games/fs2_open/data/players</tt>

====Extracting files====

* Use unshield to extract the groups from data1.cab (on the first cd) to a temporary directory; then move the files in your game directory :
<tt>~ $ mkdir /tmp/fs2
~ $ for group in "Basic Install Files" "Intel Anims" "Music Compressed" "High Res Files"; do unshield -d tmp/fs2/ -g "$group" -L -j x disk1/data1.cab && mv -v /tmp/fs2/*/* /home/data/jeux/fs2_open
~ $ unshield -d /usr/local/games/fs2_open/data/players -g "Hud Config Files" -L -j x data1.cab && mv -v /tmp/fs2/hud_config_files/* /home/data/jeux/fs2_open/data/players</tt>

* From the second CD, get the vp files and the movies files (I dont think the the mve file are really needed, you'll need the avi ones if you want the movies).
<tt>~ $ cp -vf *.vp /usr/local/games/fs2_open</tt>
<tt>~ $ mkdir -p /usr/local/games/fs2_open/data/movies/ && cp -vf *.MVE /usr/local/games/fs2_open/data/movies/</tt>
* Do the same for the third CD :
<tt>~ $ cp -vf *.vp /usr/local/games/fs2_open</tt>
<tt>~ $ cp -vf *.MVE /usr/local/games/fs2_open/data/movies/</tt>

You may notice that some files are on all three CD. This is because the games was meant to be run from CD. Don't bother.

=== Fixing Case and permissions ===
* You '''have''' to make sure everything is lowercase :
<tt>~ $ find /usr/local/games/fs2_open/ | rename -v 'y/A-Z/a-z/'</tt>

* Then, fix permissions :
<tt>~ $ find /usr/local/games/fs2_open -type d -exec chmod a+rx '{}' \;</tt>
<tt>~ $ find /usr/local/games/fs2_open -type f -exec chmod a+r '{}' \;</tt>

===MediaVP and Cutscenes===
You'll also need the mediavp from the SCP if you want the enhanced graphics. Get them at http://scp.indiegames.us.
If you want the cutscenes, you'll have to find the avi version of the MVE files, or to convert them yourself. They are not hard to find. When you have them, just put them in the data/movies directory. Again, make sure everything is lowercase.

That's it for the game data files, now it's time get the source !

== Using the source ==

=== CVS Checkout ===
Before you begin, make sure you have write permissions on your current working directory. Your /home/user/ directory is a pretty sure bet. I recommend that you create a permanent /home/user/src directory from which you run the CVS command, this way CVS will only update the files changed the next time you download the source and it's always nice to have things organized.

Now get the source. Run from a terminal:
$ cvs -d:pserver:anonymous:anonymous@warpcore.org:/home/fs2source/cvsroot login
and then
$ cvs -z3 -d:pserver:anonymous@warpcore.org:/home/fs2source/cvsroot co fs2_open
The first cvs command tells the CVS tool to first use a password file for authentication (pserver), that you are user "anonymous" with the password "anonymous" who wants to access warpcore.org's CVS repository "/home/fs2source/cvsroot" and login. The second command tells the CVS server on which we are now connected to that we want to checkout (co) the fs2_open module.
 
==== CVS Checkout and Update Script ====
The code on CVS is in a constant state of change, and bugs that exist one day may be gone the next. Because of this, you'll want to occasionally update to a newer version and recompile.
Running those cvs commands will fast grow to be a pain, so this little script was created to make your life easier. This script will checkout fs2_open if it can't find a fs2_open directory and update fs2_open, if it finds it.
The script will run until a successfull checkout or update has been achieved.
Copy and save this to a suitably named file like "get_fs2_open", and make it executable with the command, chmod +x <name of file>
#!/bin/bash
# CVS Checkout and Update Script for fs2_open
CVS_LINE="cvs -d:pserver:anonymous:anonymous@warpcore.org:/home/fs2source/cvsroot" # The cvs command
if [ "$UID" = 0 ]; then # check if user is root, and if so, echo a warning.
echo "You are root. If this is a checkout, all files \
will be created with root as the owner."
sleep 3
fi
if [ -e ./fs2_open ]; then # check if directory fs2_open exists
echo "Found fs2_open, We are updating an old checkout."
CVS_ATTEMPT=0 # This updates the checkout.
until [ $CVS_ATTEMPT = 1 ]; do
$CVS_LINE login && \
$CVS_LINE update fs2_open && \
let CVS_ATTEMPT=1
done
else
echo "No fs2_open found, This is a new checkout."
CVS_ATTEMPT=0 # This creates a new checkout.
until [ $CVS_ATTEMPT = 1 ]; do
$CVS_LINE login && \
$CVS_LINE co fs2_open && \
let CVS_ATTEMPT=1
done
fi

=== Pre-Compile Configuration ===

Before you compile you need to configure it for your system. In the directory you ran the CVS command from, a new directory has appear, namely fs2_open.
If your fs2_open is a completely new checkout, you will first need to run the autogen.sh script.
Run from inside your newly created fs2_open directory:
$ ./autogen.sh
autogen.sh is a script that will generate the required makefiles. You will see alot of "checking for this" and "checking for that", this is actually the "configure" script (which can be run with <tt>./configure</tt> if you need to change the options) examining and configuring fs2_open for your system. 
It is possible to give autogen.sh configure options as well, autogen.sh will pass them along to configure.

A full list of configure options can be found by running the configure script with the '--help' option.
$ ./configure --help

==== Optimizing fs2_open ====
Optimizing fs2_open might have little or no effect, or improve performance greatly, I honestly have no clue. 
A note of caution, if you are compiling a debug build, don't use the -fomit-frame-pointer CFLAG, it will make debugging impossible. 
You can specify your compiler flags with the configure script, se below.
$ ./configure CFLAGS="<your desired flags>"
If you got a Athlon-XP and want to play it safe, a good set of CFLAGS would be
$ ./configure CFLAGS="-march=athlon-xp -O3 -pipe -fomit-frame-pointer"
You should read up on CFLAGS and what they do before trying anything. I recommend you read through these links. 
http://gcc.gnu.org/onlinedocs/gcc-3.4.1/gcc/Optimize-Options.html 
http://linuxreviews.org/howtos/compiling/safe-cflags/ 
http://en.wikipedia.org/wiki/CFLAGS

=== Compiling ===

Run from within your fs2_open directory:
$ make
Sit back and enjoy gcc work its magic.

==== Simple Compile Script ====
It's alot easier to use a scripts when dealing with constantly changing code. Copy and save this to a suitably named file like "compile_fs2_open", and make it executable with the command, chmod +x <name of file>
This script assumes the CVS checkout directory fs2_open is pressent in the same directory as the script itself.
#!/bin/bash
# fs2_open Compile Script
# These are only examples, uncomment to enable optimization.
#MY_CFLAGS="-march=athlon-xp -O3 -pipe -fomit-frame-pointer -ftracer"
if [ -e ./fs2_open/ ]; then
cd fs2_open
if [ -e ./Makefile.in ]; then
make clean
./configure CFLAGS="$MY_CFLAGS" CXXFLAGS="$MY_CFLAGS"
make
else
./autogen.sh CFLAGS="$MY_CFLAGS" CXXFLAGS="$MY_CFLAGS"
make
fi
else
echo "No fs2_open directory found."
fi

You can add your options to the ./configure line.

== Using the Binaries ==

When the compile is done and if all went well, a binary executable will reside in the code directory ''fs2_open_r'' or ''fs2_open_d'' if you configured for a debug build. Copy the binary to directory where Freespace2 is installed, and you're all set to go.

=== Post-Compile Configuration ===
==== Changing Your Resolution ====
Odds are, you'll want to run fs2_open in a higher resolution than the default 640x480. Unfortunately, we Linux users don't have the swank launcher app that the Windows folks do. Instead, we'll be making a couple line changes to a config file. You will need to run fs2_open once before you can make the necessary changes, otherwise you won't have a configuration directory to work with.

Open up ~/.fs2_open/fs2_open.ini with the text editor of your choice (vi, EMACS, kwrite, gedit). You'll see something like the following:
[Default]
VideocardFs2open=OGL -(640x480)x16 bit
LastPlayer=MonkeyboyS
GammaD3D=1.0

To set fs2_open to use the highest setting possible on retail Freespace 2, change the VideocardFs2open to:
VideocardFs2open=OGL -(1024x768)x32 bit
You can set this to pretty much anything you want.

=== Creating a Start Up Script ===

In order to use all of the advanced engine features of fs2_open, you'll need to start the executable with a number of command line arguments. Instead of typing them in every time you want to start the game, why not create a script that does it for you?

Create a new file named start_freespace (or whatever you like) in your home directory. Open the file in your editor of choice, and paste the following:
#!/bin/bash
cd /path/to/your/freespace/
./fs2_open_r -spec -glow -mipmap -jpgtga -orbradar -mod Media_VP

''Note: You will need to edit this script before it will work properly. The second line must point to the directory where you installed fs2_open. You can also find a more elaborated script example below in the i18n section''

The last line starts fs2_open with a number of arguments that turn on extra features. In the example, the game will use specular highlights, glow-mapping, mipmapping, jpg and tga graphic files, the orb radar, and any MediaVPs installed to the /Media_VP directory. You should edit this line to use those features that your system supports.

More information about the available Command Line Arguments can be found at the [[Command-Line Reference]]

Once you've edited the file to your heart's content, make it executable:
$ chmod +x start_freespace

You can now type in start_freespace to start the game, or by clicking on start_freespace in your window manager. For convenience, you can copy it to your Desktop.

== Troubleshooting ==
=== Compile Errors ===
==== Missing -lGLU compile error ====

On some Linux distributions (''Slackware'' for instance), compiling fails because a GL related library doesn't have a link in the <tt>/usr/lib</tt> directory. If the compile fails because it can't find <tt>-lGLU</tt>, here are two ways to fix it:

===== Solution as Root =====

If you have root access to the system, you can create a link to the library in question with just a little bit of command line magic. Go to a console and enter:

$ ln -s /usr/X11R6/lib/libGLU.so /usr/lib/libGLU.so

After that, you can run make again and it should finish compiling.

===== Solution as a Non-Root user =====

You don't have root access? Never fear, we can still fix the problem. It'll just be a tad more difficult.

Navigate to the <tt>fs2_open/code</tt> directory and locate a file named <tt>Makefile</tt> (not Makefile.rm or Makefile.in or Makefile.anything). Open it in your favorite text editor and make the following changes.

Find this line (line 457 in mine):
FS2_LDFLAGS = -L/usr/lib -Wl,-rpath,/usr/lib -lSDL -lpthread -lGL -lGLU -lopenal -logg -lvorbis -lvorbisfile

And replace it with this:
FS2_LDFLAGS = -L/usr/lib -Wl,-rpath,/usr/lib -lSDL -lpthread -lGL -lopenal -logg -lvorbis -lvorbisfile -L/usr/X11R6/lib -lGLU

Also find this one (line 565 in mine):
AM_LDFLAGS = -g -L/usr/lib -Wl,-rpath,/usr/lib -lSDL -lpthread -lGL -lGLU -lopenal -logg -lvorbis -lvorbisfile

And replace it with this:
AM_LDFLAGS = -g -L/usr/lib -Wl,-rpath,/usr/lib -lSDL -lpthread -lGL -lopenal -logg -lvorbis -lvorbisfile -L/usr/X11R6/lib -lGLU

Then run <tt>make</tt> from the <tt>fs2_open</tt> directory, and watch the magic happen.

==== glBindBufferARB feature missing ====
''If this is the actual solution to this problem remains to be seen.'' 
''So far, only people using Debian stable are affected by this.'' 
''So we need adventurus Debian users to confirm.'' 
''I can confirm that the APT-Pinning works, can not confirm compile thou. -- ni1s'' 
checking for glBindBufferARB in -lGL... no
configure: error: *** OpenGL version does not have the required features!! (ie.glBindBufferARB()) ***
This error appears if the installed Mesa development library is to old.

On Debian stable branch the xlibmesa-gl-dev package holds version 4.3.0. 
The xlibmesa-gl-dev package on ''testning'' is version 6.9.0.

'''Possible solution:''' 
First set /etc/apt/sources.list to include the testing branch. Add:
#Testing
deb http://ftp.us.debian.org/debian testing main non-free contrib
deb http://non-us.debian.org/debian-non-US testing/non-US main contrib non-free
Your sources.list might have these lines already, if so, you should be okej.

Your /etc/apt/preferences file should look like this
Package: *
Pin: release a=stable
Pin-Priority: 700

Package: *
Pin: release a=testing
Pin-Priority: 650

Package: *
Pin: release a=unstable
Pin-Priority: 600

Add to that file:
Package: xlibmesa-gl-dev
Pin: release a=testing
Pin-Priority: 800
Note that the Pin-Priority of xlibmesa-gl-dev here is higher than the Pin-Priority on 'stable'. As a result of this APT get will prioritize the xlibmesa-gl-dev from testing and leave the rest of the system on stable.
This is called apt-pinning.

Now that APT knows what xlibmesa-gl-dev to prioritze, install it again:
$ apt-get install xlibmesa-gl-dev

If you are using nVidia's nvidia-kernel and glx packages, a simple:
$ apt-get install nvidia-glx-dev
should suffice. No need to mess around with APT-pinning.

=== Runtime Errors and common problems ===
==== ERROR: "Web cursor bitmap not found." ====
ERROR: "Web cursor bitmap not found. This usually means that the executable is being run outside the directory
you installed Freespace2 to. Please move the executable to that directory and try again" at graphics/2d.cpp:1402
A common error. This happens when fs2_open can't find the .vp files or that your user doesn't have the permissions to access them. If you are using a start up script([http://www.hard-light.net/wiki/index.php/Fs2_open_on_Linux#Creating_a_Start_Up_Script like the one found here]) it's most likly the a permission problem.
Have your user take owenership of the .vp files, run as root:
$ chown <user> /path/to/vpfiles/ -R

=== I18n and Key mapping problems ===
''Me, being a Swede, need to use this aswell, especially for the grave key(`), but I also want to use a second X display. There is a way to tell xmodmap to use the new set of keys on the second X display, and thus eliminating the need for a temp. keymap table as it dies with the second display when exiting fs2_open, never touching the keymap table on display 0. We should dig that info up and write a super-start script. --ni1s'' 
Ok, imagine that like me you don't have an us keyboard but a french one (or anything). Well, you probably have problems mapping some keys or even using the default mapping.

Actually, the problem is fs2_open does not take modifiers into account, as it uses them internally as modifiers for keys, and it won't accept non-us charset either.

On a french keyboard layout, the numbers ''1 2 3 4 5 6 7 8 9 0'' are on the same keys than on a US layout, but you have to press shift to use them. The primary function for theses keys are ''& Ã© " ' ( - Ã¨ _ Ã§ Ã )''. These characters won't be accepted by freespace, and if you press shift to get a number, it won't work. This can be a problem, as theses keys are needed to use the communication system, and cannot be bound to anything. Also, as you won't get access some keys on your keyboard, it will be difficult to map every command on a key, or you'll have to use modifiers for nearly each key.

However, there is a solution. You can tell X to remap the keyboard before launching the game, and restore your normal keymap afterwards.

For exemple, I map 123456790 to the &Ã©"'(-Ã¨_Ã§Ã keys so I can use the communication system, and I put , and ; on the Alt-Gr and Menu keys for convenience, as I binded thoses keys to next primary weapon and next secondary weapon.

To do this, I use a slightly enhanced startup script, which I put in ~/bin (this directory is in my path), together with a customized xmodmap.

* First, dump your current xmodmap :

<tt>~ $ xmodmap -pke > ~/xmodmap.current</tt>

* Then edit it with your favorite text editor. You'll see a bunch of lines looking like this :

<tt>
keycode 8 =
keycode 9 = Escape
keycode 10 = 1 ampersand onesuperior exclamdown onesuperior exclamdown
</tt>

The syntax is ''keycode <number> = <symbol list>''.

Use '''xev''' to scan the keycodes. The symbols are defined in ''/usr/include/X11/keysymdef.h''. Just make sure you write them without the ''XK_'' prefix. You'll find more information about xmodmap in the xmodmap manual page.

Just modify the keys you need, and be patient. This can be a long process. Test it with xmodmap :

<tt>~ $ xmodmap - < <filename></tt>

But don't forget to have your previous keymap at hand to recover your settings !
If you mess everything up, just restart X. Your default keymap will be applied from the X configuration.

Here is my own fs2 xmodmap, derived from fr-latin1 as described above. Feel free to use it if you're too lazy to modify your own. However, it may not fit with your needs. You may always use it as an exemple, thougt.
* http://clement.hermann.free.fr/fs2/xmodmap

Then, when the file is modified at your liking, just save it as '''~/.fs2_open/xmodmap'''

We'll start fs2_open with a slightly more elaborate startup script which will backup/apply/restore the keymap in addition of running the games with some options in the right directory.

<tt>
#!/bin/sh
# This script lauches fs2. If there is a file named $FS2_modmap (see below),
# backup the current modmap as $TMP_modmap and load it as the new modmap.
# The current modmap will be restored afterwards.

TMP_modmap="$HOME/xmodmap.tmp"
FS2_modmap="$HOME/.fs2_open/xmodmap"

FS2_OPEN_DIR=/usr/local/games/fs2_open

FS2_ARGS="-glow -spec -spec_exp 11 -spec_point 0.6 -spec_static 0.8 -spec_tube 0.4 -fps -jpgtga -ambient_factor 75 -targetinfo -nograb"

FS2_BIN="$FS2_OPEN_DIR/fs2_open_r"

die() {
echo "** Fatal error : $1" >&2
exit 1
}

cd $FS2_OPEN_DIR || die "Could not change directory to $FS2_OPEN_DIR"

# dump current xmodmap
[ -f "$FS2_modmap" ] && xmodmap -pke > $TMP_modmap

# load xmodmap
[ -f "$FS2_modmap" ] && xmodmap - < $FS2_modmap

# prepare to restore xmodmap on crash or exit
trap "xmodmap - < $TMP_modmap && rm $TMP_modmap" 0 2 3 4 9 11 15

# launch fs2
$FS2_BIN $FS2_ARGS $* || die "Error while running \"$FS2_BIN\" with arguments \"$FS2_ARGS\" ($?)"
</tt>

Adapt this script to your needs, and save it somewhere in your PATH - I for exemple usr ~/bin/freespace2. Make it executable with a chmod +x ''<file>''

That's it, now you can use fs2 with full control over your keyboard.

=== fs2_open freezes X ===
A good way of running games on Linux is having them run on a separate X display. The display you are most likely using now when reading this is 0:0. This display is normally used for whatever Window Manager/Desktop Environment(KDE,Gnome,*box,E) you've chosen. Sometimes fs2_open freezes and locks your X. This is of course very annoying as you have to CTRL+ALT+BACKSPACE to kill the X server, and in that, killing whatever program you had running besides fs2_open. The solution to this is to tell X to start fs2_open on another display. To to this we first need to tell X that you,the user on localhost, holds the permission to run on another display.
In a terminal, enter (NOT as root):
$ xauth list
A list that looks something like this should appear.
myuser@localhost ~ $ xauth list
localhost/unix:'''0''' MIT-MAGIC-COOKIE-1 14ec70e7c8cc835def61a04c92bbd50d
Let's look at that line, first up is your localhost, then unix, and last :0 (in bold). The rest is not really of interest.
Copy the whole line, but change the display value to 1 and paste it after the command ''xauth add'', like this:
$ xauth add localhost/unix:'''1''' MIT-MAGIC-COOKIE-1 14ec70e7c8cc835def61a04c92bbd50d
Run xauth list again. You should see a new entry.
myuser@localhost ~ $ xauth list
localhost/unix:'''0''' MIT-MAGIC-COOKIE-1 14ec70e7c8cc835def61a04c92bbd50d
localhost/unix:'''1''' MIT-MAGIC-COOKIE-1 14ec70e7c8cc835def61a04c92bbd50d
You now have permission to use display 1:0.
To start fs2_open in that display, use xinit.
$ xinit /path/to/fs2_open_r -foo -bar -- :1
The ''-- :1'' tells X that we want to start fs2_open on display 1. 
You can switch to display 0 and 1 with CTRL+ALT+F7 and CTRL+ALT+F8 respectively.

If you try this from an xterm (or a similar X terminal program) and obtain the error ''X: user not authorized to run the X server, aborting.'', the reason might be the file /etc/X11/Xwrapper.config. On my ubuntu machine, it contains the line

allowed_users=console

which means that only users logged in from a console terminal may start a new X server. However, on an xterm, you are on a '''virtual''' terminal and so the above does not work. A possibility is to change the allowed_users in the Xwrapper.config file to "anybody" (see man Xwrapper.config). However, this undermines X security. Another possibility is to start the xinit command from a console window (to which you can change with CTRL+ALT+F1-6).

''If someone knows of a good method to start fs2 on a second X display from an xterm without changing Xwrapper.config, please report it here.''

''A solution might be running xinit as root with sudo, and drop the root privileges in the startup script... Didn't tried, though.'' -- nodens

Guide to FS Open on Linux

2006-06-28T21:48:54Z

Nodens: forgot to add the actual warning. It's late here.

''Note: This tutorial assumes some fundamental command line knowledge.''

== Installing CVS ==
CVS stands for Concurrent Versions System and is a version control system used to record the changes in documents, such as source files. Developers use CVS so they can easily share their code changes among other developers. You will need this tool to download ("checkout" in CVS terminology) fs2_open from the CVS server.

'''Debian/Ubuntu''' users want to:
$ apt-get install cvs
'''Gentoo''' users want to:
$ emerge cvs

'''NOTE: Redhat, Mandrake/Mandriva, Slackware and all the other distros should go here too,'''
'''but we have no knowledge on how these work, so if you do, please enlighten us.'''

== Installing the nessesary development libraries ==
You will also need SDL, OpenAL, libvorbis and OpenGL(most likely provided with your video card driver) development packages. And of course the GCC compiler and required make tools.
 
'''Debian/Ubuntu''' users want to:
$ apt-get install libopenal-dev libvorbis-dev build-essential automake1.9 autoconf libsdl-dev
'''NOTE:''' The ''build-essential'' meta package installs GCC4. This should work, but if you feel safer with GCC 3.4(gcc-3.4), add it to the apt-get line above. 
'''Gentoo''' users want to:
$ emerge openal libvorbis libsdl
'''NOTE: Radhat, Mandrake,Slackware and all the other distros should go here too,'''
'''but we have no knowlage on how these work, so if you do, please enlighten us.'''

== Installing game data files ==

This tutorial deals primarily with providing you with an executable, but in order to play the game you also need the game data. Freespace 2 game data is available from a number of sources, see this thread: http://www.hard-light.net/forums/index.php/topic,38195.0.html

Note that if you use the retail CD, you'll need to extract the files and to copy them on your drive, reproducing the same layout as in a working win32 installation (just make sure every file is lowercase). This thread on the SCP forum has some more info on it : http://scp.indiegames.us/forum_viewtopic.php?3.282

There are two ways of doing this :
* use wine to install the game in the right directory, using the Setup.exe found on the first CD, or
* extract manually the files from the cd.

The second method is detailed below. The wine one is straightforward and you shouldn't need any specific instruction, but you'll have to fix permissions and lowercase the filename as well, so keep reading.

===Extracting data from CD===
====Installing unshield====

First, you need unshield from http://synce.sourceforge.net/synce/unshield.php

If you use debian, apt-get install unshield as root should do the trick. Else, try to find a package for your distribution, or if you don't, compile it yourself following the instructions provided on the website. Note you don't need to actually install it, just compile it and use it from the directory where you compiled it.

====Preparing directories====

* Create a directory for fs2_open, say, ''/usr/local/games/fs2_open'', with a ''data/movies'' and ''data/players'' subdirectories. Everything but user files and configuration will be in this directory. You'll probably need to be root or use sudo for most of the following commands if you use a global directory like the one in this example.

''Beware : please double check the commands you run as root. A single typo could destroy your data. As a rule of thumb, do not copy/paste commands without understanding them, especially as root. With great power comes great responsability.''

<tt>~ $ mkdir -p /usr/local/games/fs2_open/data/movies /usr/local/games/fs2_open/data/players</tt>

====Extracting files====

* Use unshield to extract the groups from data1.cab (on the first cd) to a temporary directory; then move the files in your game directory :
<tt>~ $ mkdir /tmp/fs2
~ $ for group in "Basic Install Files" "Intel Anims" "Music Compressed" "High Res Files"; do unshield -d tmp/fs2/ -g "$group" -L -j x disk1/data1.cab && mv -v /tmp/fs2/*/* /home/data/jeux/fs2_open
~ $ unshield -d /usr/local/games/fs2_open/data/players -g "Hud Config Files" -L -j x data1.cab && mv -v /tmp/fs2/hud_config_files/* /home/data/jeux/fs2_open/data/players</tt>

* From the second CD, get the vp files and the movies files (I dont think the the mve file are really needed, you'll need the avi ones if you want the movies).
<tt>~ $ cp -vf *.vp /usr/local/games/fs2_open</tt>
<tt>~ $ mkdir -p /usr/local/games/fs2_open/data/movies/ && cp -vf *.MVE /usr/local/games/fs2_open/data/movies/</tt>
* Do the same for the third CD :
<tt>~ $ cp -vf *.vp /usr/local/games/fs2_open</tt>
<tt>~ $ cp -vf *.MVE /usr/local/games/fs2_open/data/movies/</tt>

You may notice that some files are on all three CD. This is because the games was meant to be run from CD. Don't bother.

=== Fixing Case and permissions ===
* You '''have''' to make sure everything is lowercase :
<tt>~ $ find /usr/local/games/fs2_open/ | rename -v 'y/A-Z/a-z/'</tt>

* Then, fix permissions :
<tt>~ $ find /usr/local/games/fs2_open -type d -exec chmod a+rx '{}' \;</tt>
<tt>~ $ find /usr/local/games/fs2_open -type f -exec chmod a+r '{}' \;</tt>

===MediaVP and Cutscenes===
You'll also need the mediavp from the SCP if you want the enhanced graphics. Get them at http://scp.indiegames.us.
If you want the cutscenes, you'll have to find the avi version of the MVE files, or to convert them yourself. They are not hard to find. When you have them, just put them in the data/movies directory. Again, make sure everything is lowercase.

That's it for the game data files, now it's time get the source !

== Using the source ==

=== CVS Checkout ===
Before you begin, make sure you have write permissions on your current working directory. Your /home/user/ directory is a pretty sure bet. I recommend that you create a permanent /home/user/src directory from which you run the CVS command, this way CVS will only update the files changed the next time you download the source and it's always nice to have things organized.

Now get the source. Run from a terminal:
$ cvs -d:pserver:anonymous:anonymous@warpcore.org:/home/fs2source/cvsroot login
and then
$ cvs -z3 -d:pserver:anonymous@warpcore.org:/home/fs2source/cvsroot co fs2_open
The first cvs command tells the CVS tool to first use a password file for authentication (pserver), that you are user "anonymous" with the password "anonymous" who wants to access warpcore.org's CVS repository "/home/fs2source/cvsroot" and login. The second command tells the CVS server on which we are now connected to that we want to checkout (co) the fs2_open module.
 
==== CVS Checkout and Update Script ====
The code on CVS is in a constant state of change, and bugs that exist one day may be gone the next. Because of this, you'll want to occasionally update to a newer version and recompile.
Running those cvs commands will fast grow to be a pain, so this little script was created to make your life easier. This script will checkout fs2_open if it can't find a fs2_open directory and update fs2_open, if it finds it.
The script will run until a successfull checkout or update has been achieved.
Copy and save this to a suitably named file like "get_fs2_open", and make it executable with the command, chmod +x <name of file>
#!/bin/bash
# CVS Checkout and Update Script for fs2_open
CVS_LINE="cvs -d:pserver:anonymous:anonymous@warpcore.org:/home/fs2source/cvsroot" # The cvs command
if [ "$UID" = 0 ]; then # check if user is root, and if so, echo a warning.
echo "You are root. If this is a checkout, all files \
will be created with root as the owner."
sleep 3
fi
if [ -e ./fs2_open ]; then # check if directory fs2_open exists
echo "Found fs2_open, We are updating an old checkout."
CVS_ATTEMPT=0 # This updates the checkout.
until [ $CVS_ATTEMPT = 1 ]; do
$CVS_LINE login && \
$CVS_LINE update fs2_open && \
let CVS_ATTEMPT=1
done
else
echo "No fs2_open found, This is a new checkout."
CVS_ATTEMPT=0 # This creates a new checkout.
until [ $CVS_ATTEMPT = 1 ]; do
$CVS_LINE login && \
$CVS_LINE co fs2_open && \
let CVS_ATTEMPT=1
done
fi

=== Pre-Compile Configuration ===

Before you compile you need to configure it for your system. In the directory you ran the CVS command from, a new directory has appear, namely fs2_open.
If your fs2_open is a completely new checkout, you will first need to run the autogen.sh script.
Run from inside your newly created fs2_open directory:
$ ./autogen.sh
autogen.sh is a script that will generate the required makefiles. You will see alot of "checking for this" and "checking for that", this is actually the "configure" script (which can be run with <tt>./configure</tt> if you need to change the options) examining and configuring fs2_open for your system. 
It is possible to give autogen.sh configure options as well, autogen.sh will pass them along to configure.

A full list of configure options can be found by running the configure script with the '--help' option.
$ ./configure --help

==== Optimizing fs2_open ====
Optimizing fs2_open might have little or no effect, or improve performance greatly, I honestly have no clue. 
A note of caution, if you are compiling a debug build, don't use the -fomit-frame-pointer CFLAG, it will make debugging impossible. 
You can specify your compiler flags with the configure script, se below.
$ ./configure CFLAGS="<your desired flags>"
If you got a Athlon-XP and want to play it safe, a good set of CFLAGS would be
$ ./configure CFLAGS="-march=athlon-xp -O3 -pipe -fomit-frame-pointer"
You should read up on CFLAGS and what they do before trying anything. I recommend you read through these links. 
http://gcc.gnu.org/onlinedocs/gcc-3.4.1/gcc/Optimize-Options.html 
http://linuxreviews.org/howtos/compiling/safe-cflags/ 
http://en.wikipedia.org/wiki/CFLAGS

=== Compiling ===

Run from within your fs2_open directory:
$ make
Sit back and enjoy gcc work its magic.

==== Simple Compile Script ====
It's alot easier to use a scripts when dealing with constantly changing code. Copy and save this to a suitably named file like "compile_fs2_open", and make it executable with the command, chmod +x <name of file>
This script assumes the CVS checkout directory fs2_open is pressent in the same directory as the script itself.
#!/bin/bash
# fs2_open Compile Script
# These are only examples, uncomment to enable optimization.
#MY_CFLAGS="-march=athlon-xp -O3 -pipe -fomit-frame-pointer -ftracer"
if [ -e ./fs2_open/ ]; then
cd fs2_open
if [ -e ./Makefile.in ]; then
make clean
./configure CFLAGS="$MY_CFLAGS" CXXFLAGS="$MY_CFLAGS"
make
else
./autogen.sh CFLAGS="$MY_CFLAGS" CXXFLAGS="$MY_CFLAGS"
make
fi
else
echo "No fs2_open directory found."
fi

You can add your options to the ./configure line.

== Using the Binaries ==

When the compile is done and if all went well, a binary executable will reside in the code directory ''fs2_open_r'' or ''fs2_open_d'' if you configured for a debug build. Copy the binary to directory where Freespace2 is installed, and you're all set to go.

=== Post-Compile Configuration ===
==== Changing Your Resolution ====
Odds are, you'll want to run fs2_open in a higher resolution than the default 640x480. Unfortunately, we Linux users don't have the swank launcher app that the Windows folks do. Instead, we'll be making a couple line changes to a config file. You will need to run fs2_open once before you can make the necessary changes, otherwise you won't have a configuration directory to work with.

Open up ~/.fs2_open/fs2_open.ini with the text editor of your choice (vi, EMACS, kwrite, gedit). You'll see something like the following:
[Default]
VideocardFs2open=OGL -(640x480)x16 bit
LastPlayer=MonkeyboyS
GammaD3D=1.0

To set fs2_open to use the highest setting possible on retail Freespace 2, change the VideocardFs2open to:
VideocardFs2open=OGL -(1024x768)x32 bit
You can set this to pretty much anything you want.

=== Creating a Start Up Script ===

In order to use all of the advanced engine features of fs2_open, you'll need to start the executable with a number of command line arguments. Instead of typing them in every time you want to start the game, why not create a script that does it for you?

Create a new file named start_freespace (or whatever you like) in your home directory. Open the file in your editor of choice, and paste the following:
#!/bin/bash
cd /path/to/your/freespace/
./fs2_open_r -spec -glow -mipmap -jpgtga -orbradar -mod Media_VP

''Note: You will need to edit this script before it will work properly. The second line must point to the directory where you installed fs2_open. You can also find a more elaborated script example below in the i18n section''

The last line starts fs2_open with a number of arguments that turn on extra features. In the example, the game will use specular highlights, glow-mapping, mipmapping, jpg and tga graphic files, the orb radar, and any MediaVPs installed to the /Media_VP directory. You should edit this line to use those features that your system supports.

More information about the available Command Line Arguments can be found at the [[Command-Line Reference]]

Once you've edited the file to your heart's content, make it executable:
$ chmod +x start_freespace

You can now type in start_freespace to start the game, or by clicking on start_freespace in your window manager. For convenience, you can copy it to your Desktop.

== Troubleshooting ==
=== Compile Errors ===
==== Missing -lGLU compile error ====

On some Linux distributions (''Slackware'' for instance), compiling fails because a GL related library doesn't have a link in the <tt>/usr/lib</tt> directory. If the compile fails because it can't find <tt>-lGLU</tt>, here are two ways to fix it:

===== Solution as Root =====

If you have root access to the system, you can create a link to the library in question with just a little bit of command line magic. Go to a console and enter:

$ ln -s /usr/X11R6/lib/libGLU.so /usr/lib/libGLU.so

After that, you can run make again and it should finish compiling.

===== Solution as a Non-Root user =====

You don't have root access? Never fear, we can still fix the problem. It'll just be a tad more difficult.

Navigate to the <tt>fs2_open/code</tt> directory and locate a file named <tt>Makefile</tt> (not Makefile.rm or Makefile.in or Makefile.anything). Open it in your favorite text editor and make the following changes.

Find this line (line 457 in mine):
FS2_LDFLAGS = -L/usr/lib -Wl,-rpath,/usr/lib -lSDL -lpthread -lGL -lGLU -lopenal -logg -lvorbis -lvorbisfile

And replace it with this:
FS2_LDFLAGS = -L/usr/lib -Wl,-rpath,/usr/lib -lSDL -lpthread -lGL -lopenal -logg -lvorbis -lvorbisfile -L/usr/X11R6/lib -lGLU

Also find this one (line 565 in mine):
AM_LDFLAGS = -g -L/usr/lib -Wl,-rpath,/usr/lib -lSDL -lpthread -lGL -lGLU -lopenal -logg -lvorbis -lvorbisfile

And replace it with this:
AM_LDFLAGS = -g -L/usr/lib -Wl,-rpath,/usr/lib -lSDL -lpthread -lGL -lopenal -logg -lvorbis -lvorbisfile -L/usr/X11R6/lib -lGLU

Then run <tt>make</tt> from the <tt>fs2_open</tt> directory, and watch the magic happen.

==== glBindBufferARB feature missing ====
''If this is the actual solution to this problem remains to be seen.'' 
''So far, only people using Debian stable are affected by this.'' 
''So we need adventurus Debian users to confirm.'' 
''I can confirm that the APT-Pinning works, can not confirm compile thou. -- ni1s'' 
checking for glBindBufferARB in -lGL... no
configure: error: *** OpenGL version does not have the required features!! (ie.glBindBufferARB()) ***
This error appears if the installed Mesa development library is to old.

On Debian stable branch the xlibmesa-gl-dev package holds version 4.3.0. 
The xlibmesa-gl-dev package on ''testning'' is version 6.9.0.

'''Possible solution:''' 
First set /etc/apt/sources.list to include the testing branch. Add:
#Testing
deb http://ftp.us.debian.org/debian testing main non-free contrib
deb http://non-us.debian.org/debian-non-US testing/non-US main contrib non-free
Your sources.list might have these lines already, if so, you should be okej.

Your /etc/apt/preferences file should look like this
Package: *
Pin: release a=stable
Pin-Priority: 700

Package: *
Pin: release a=testing
Pin-Priority: 650

Package: *
Pin: release a=unstable
Pin-Priority: 600

Add to that file:
Package: xlibmesa-gl-dev
Pin: release a=testing
Pin-Priority: 800
Note that the Pin-Priority of xlibmesa-gl-dev here is higher than the Pin-Priority on 'stable'. As a result of this APT get will prioritize the xlibmesa-gl-dev from testing and leave the rest of the system on stable.
This is called apt-pinning.

Now that APT knows what xlibmesa-gl-dev to prioritze, install it again:
$ apt-get install xlibmesa-gl-dev

If you are using nVidia's nvidia-kernel and glx packages, a simple:
$ apt-get install nvidia-glx-dev
should suffice. No need to mess around with APT-pinning.

=== Runtime Errors and common problems ===
==== ERROR: "Web cursor bitmap not found." ====
ERROR: "Web cursor bitmap not found. This usually means that the executable is being run outside the directory
you installed Freespace2 to. Please move the executable to that directory and try again" at graphics/2d.cpp:1402
A common error. This happens when fs2_open can't find the .vp files or that your user doesn't have the permissions to access them. If you are using a start up script([http://www.hard-light.net/wiki/index.php/Fs2_open_on_Linux#Creating_a_Start_Up_Script like the one found here]) it's most likly the a permission problem.
Have your user take owenership of the .vp files, run as root:
$ chown <user> /path/to/vpfiles/ -R

=== I18n and Key mapping problems ===
''Me, being a Swede, need to use this aswell, especially for the grave key(`), but I also want to use a second X display. There is a way to tell xmodmap to use the new set of keys on the second X display, and thus eliminating the need for a temp. keymap table as it dies with the second display when exiting fs2_open, never touching the keymap table on display 0. We should dig that info up and write a super-start script. --ni1s'' 
Ok, imagine that like me you don't have an us keyboard but a french one (or anything). Well, you probably have problems mapping some keys or even using the default mapping.

Actually, the problem is fs2_open does not take modifiers into account, as it uses them internally as modifiers for keys, and it won't accept non-us charset either.

On a french keyboard layout, the numbers ''1 2 3 4 5 6 7 8 9 0'' are on the same keys than on a US layout, but you have to press shift to use them. The primary function for theses keys are ''& Ã© " ' ( - Ã¨ _ Ã§ Ã )''. These characters won't be accepted by freespace, and if you press shift to get a number, it won't work. This can be a problem, as theses keys are needed to use the communication system, and cannot be bound to anything. Also, as you won't get access some keys on your keyboard, it will be difficult to map every command on a key, or you'll have to use modifiers for nearly each key.

However, there is a solution. You can tell X to remap the keyboard before launching the game, and restore your normal keymap afterwards.

For exemple, I map 123456790 to the &Ã©"'(-Ã¨_Ã§Ã keys so I can use the communication system, and I put , and ; on the Alt-Gr and Menu keys for convenience, as I binded thoses keys to next primary weapon and next secondary weapon.

To do this, I use a slightly enhanced startup script, which I put in ~/bin (this directory is in my path), together with a customized xmodmap.

* First, dump your current xmodmap :

<tt>~ $ xmodmap -pke > ~/xmodmap.current</tt>

* Then edit it with your favorite text editor. You'll see a bunch of lines looking like this :

<tt>
keycode 8 =
keycode 9 = Escape
keycode 10 = 1 ampersand onesuperior exclamdown onesuperior exclamdown
</tt>

The syntax is ''keycode <number> = <symbol list>''.

Use '''xev''' to scan the keycodes. The symbols are defined in ''/usr/include/X11/keysymdef.h''. Just make sure you write them without the ''XK_'' prefix. You'll find more information about xmodmap in the xmodmap manual page.

Just modify the keys you need, and be patient. This can be a long process. Test it with xmodmap :

<tt>~ $ xmodmap - < <filename></tt>

But don't forget to have your previous keymap at hand to recover your settings !
If you mess everything up, just restart X. Your default keymap will be applied from the X configuration.

Here is my own fs2 xmodmap, derived from fr-latin1 as described above. Feel free to use it if you're too lazy to modify your own. However, it may not fit with your needs. You may always use it as an exemple, thougt.
* http://clement.hermann.free.fr/fs2/xmodmap

Then, when the file is modified at your liking, just save it as '''~/.fs2_open/xmodmap'''

We'll start fs2_open with a slightly more elaborate startup script which will backup/apply/restore the keymap in addition of running the games with some options in the right directory.

<tt>
#!/bin/sh
# This script lauches fs2. If there is a file named $FS2_modmap (see below),
# backup the current modmap as $TMP_modmap and load it as the new modmap.
# The current modmap will be restored afterwards.

TMP_modmap="$HOME/xmodmap.tmp"
FS2_modmap="$HOME/.fs2_open/xmodmap"

FS2_OPEN_DIR=/usr/local/games/fs2_open

FS2_ARGS="-glow -spec -spec_exp 11 -spec_point 0.6 -spec_static 0.8 -spec_tube 0.4 -fps -jpgtga -ambient_factor 75 -targetinfo -nograb"

FS2_BIN="$FS2_OPEN_DIR/fs2_open_r"

die() {
echo "** Fatal error : $1" >&2
exit 1
}

cd $FS2_OPEN_DIR || die "Could not change directory to $FS2_OPEN_DIR"

# dump current xmodmap
[ -f "$FS2_modmap" ] && xmodmap -pke > $TMP_modmap

# load xmodmap
[ -f "$FS2_modmap" ] && xmodmap - < $FS2_modmap

# prepare to restore xmodmap on crash or exit
trap "xmodmap - < $TMP_modmap && rm $TMP_modmap" 0 2 3 4 9 11 15

# launch fs2
$FS2_BIN $FS2_ARGS $* || die "Error while running \"$FS2_BIN\" with arguments \"$FS2_ARGS\" ($?)"
</tt>

Adapt this script to your needs, and save it somewhere in your PATH - I for exemple usr ~/bin/freespace2. Make it executable with a chmod +x ''<file>''

That's it, now you can use fs2 with full control over your keyboard.

=== fs2_open freezes X ===
A good way of running games on Linux is having them run on a separate X display. The display you are most likely using now when reading this is 0:0. This display is normally used for whatever Window Manager/Desktop Environment(KDE,Gnome,*box,E) you've chosen. Sometimes fs2_open freezes and locks your X. This is of course very annoying as you have to CTRL+ALT+BACKSPACE to kill the X server, and in that, killing whatever program you had running besides fs2_open. The solution to this is to tell X to start fs2_open on another display. To to this we first need to tell X that you,the user on localhost, holds the permission to run on another display.
In a terminal, enter (NOT as root):
$ xauth list
A list that looks something like this should appear.
myuser@localhost ~ $ xauth list
localhost/unix:'''0''' MIT-MAGIC-COOKIE-1 14ec70e7c8cc835def61a04c92bbd50d
Let's look at that line, first up is your localhost, then unix, and last :0 (in bold). The rest is not really of interest.
Copy the whole line, but change the display value to 1 and paste it after the command ''xauth add'', like this:
$ xauth add localhost/unix:'''1''' MIT-MAGIC-COOKIE-1 14ec70e7c8cc835def61a04c92bbd50d
Run xauth list again. You should see a new entry.
myuser@localhost ~ $ xauth list
localhost/unix:'''0''' MIT-MAGIC-COOKIE-1 14ec70e7c8cc835def61a04c92bbd50d
localhost/unix:'''1''' MIT-MAGIC-COOKIE-1 14ec70e7c8cc835def61a04c92bbd50d
You now have permission to use display 1:0.
To start fs2_open in that display, use xinit.
$ xinit /path/to/fs2_open_r -foo -bar -- :1
The ''-- :1'' tells X that we want to start fs2_open on display 1. 
You can switch to display 0 and 1 with CTRL+ALT+F7 and CTRL+ALT+F8 respectively.

If you try this from an xterm (or a similar X terminal program) and obtain the error ''X: user not authorized to run the X server, aborting.'', the reason might be the file /etc/X11/Xwrapper.config. On my ubuntu machine, it contains the line

allowed_users=console

which means that only users logged in from a console terminal may start a new X server. However, on an xterm, you are on a '''virtual''' terminal and so the above does not work. A possibility is to change the allowed_users in the Xwrapper.config file to "anybody" (see man Xwrapper.config). However, this undermines X security. Another possibility is to start the xinit command from a console window (to which you can change with CTRL+ALT+F1-6).

''If someone knows of a good method to start fs2 on a second X display from an xterm without changing Xwrapper.config, please report it here.''

''A solution might be running xinit as root with sudo, and drop the root privileges in the startup script... Didn't tried, though.'' -- nodens

Guide to FS Open on Linux

2006-06-28T21:44:44Z

Nodens: /* Preparing directories */ - warn about the root / sudo thing. better safe than sorry ;)

''Note: This tutorial assumes some fundamental command line knowledge.''

== Installing CVS ==
CVS stands for Concurrent Versions System and is a version control system used to record the changes in documents, such as source files. Developers use CVS so they can easily share their code changes among other developers. You will need this tool to download ("checkout" in CVS terminology) fs2_open from the CVS server.

'''Debian/Ubuntu''' users want to:
$ apt-get install cvs
'''Gentoo''' users want to:
$ emerge cvs

'''NOTE: Redhat, Mandrake/Mandriva, Slackware and all the other distros should go here too,'''
'''but we have no knowledge on how these work, so if you do, please enlighten us.'''

== Installing the nessesary development libraries ==
You will also need SDL, OpenAL, libvorbis and OpenGL(most likely provided with your video card driver) development packages. And of course the GCC compiler and required make tools.
 
'''Debian/Ubuntu''' users want to:
$ apt-get install libopenal-dev libvorbis-dev build-essential automake1.9 autoconf libsdl-dev
'''NOTE:''' The ''build-essential'' meta package installs GCC4. This should work, but if you feel safer with GCC 3.4(gcc-3.4), add it to the apt-get line above. 
'''Gentoo''' users want to:
$ emerge openal libvorbis libsdl
'''NOTE: Radhat, Mandrake,Slackware and all the other distros should go here too,'''
'''but we have no knowlage on how these work, so if you do, please enlighten us.'''

== Installing game data files ==

This tutorial deals primarily with providing you with an executable, but in order to play the game you also need the game data. Freespace 2 game data is available from a number of sources, see this thread: http://www.hard-light.net/forums/index.php/topic,38195.0.html

Note that if you use the retail CD, you'll need to extract the files and to copy them on your drive, reproducing the same layout as in a working win32 installation (just make sure every file is lowercase). This thread on the SCP forum has some more info on it : http://scp.indiegames.us/forum_viewtopic.php?3.282

There are two ways of doing this :
* use wine to install the game in the right directory, using the Setup.exe found on the first CD, or
* extract manually the files from the cd.

The second method is detailed below. The wine one is straightforward and you shouldn't need any specific instruction, but you'll have to fix permissions and lowercase the filename as well, so keep reading.

===Extracting data from CD===
====Installing unshield====

First, you need unshield from http://synce.sourceforge.net/synce/unshield.php

If you use debian, apt-get install unshield as root should do the trick. Else, try to find a package for your distribution, or if you don't, compile it yourself following the instructions provided on the website. Note you don't need to actually install it, just compile it and use it from the directory where you compiled it.

====Preparing directories====

* Create a directory for fs2_open, say, ''/usr/local/games/fs2_open'', with a ''data/movies'' and ''data/players'' subdirectories. Everything but user files and configuration will be in this directory. You'll probably need to be root or use sudo for most of the following commands.

<tt>~ $ mkdir -p /usr/local/games/fs2_open/data/movies /usr/local/games/fs2_open/data/players</tt>

====Extracting files====

* Use unshield to extract the groups from data1.cab (on the first cd) to a temporary directory; then move the files in your game directory :
<tt>~ $ mkdir /tmp/fs2
~ $ for group in "Basic Install Files" "Intel Anims" "Music Compressed" "High Res Files"; do unshield -d tmp/fs2/ -g "$group" -L -j x disk1/data1.cab && mv -v /tmp/fs2/*/* /home/data/jeux/fs2_open
~ $ unshield -d /usr/local/games/fs2_open/data/players -g "Hud Config Files" -L -j x data1.cab && mv -v /tmp/fs2/hud_config_files/* /home/data/jeux/fs2_open/data/players</tt>

* From the second CD, get the vp files and the movies files (I dont think the the mve file are really needed, you'll need the avi ones if you want the movies).
<tt>~ $ cp -vf *.vp /usr/local/games/fs2_open</tt>
<tt>~ $ mkdir -p /usr/local/games/fs2_open/data/movies/ && cp -vf *.MVE /usr/local/games/fs2_open/data/movies/</tt>
* Do the same for the third CD :
<tt>~ $ cp -vf *.vp /usr/local/games/fs2_open</tt>
<tt>~ $ cp -vf *.MVE /usr/local/games/fs2_open/data/movies/</tt>

You may notice that some files are on all three CD. This is because the games was meant to be run from CD. Don't bother.

=== Fixing Case and permissions ===
* You '''have''' to make sure everything is lowercase :
<tt>~ $ find /usr/local/games/fs2_open/ | rename -v 'y/A-Z/a-z/'</tt>

* Then, fix permissions :
<tt>~ $ find /usr/local/games/fs2_open -type d -exec chmod a+rx '{}' \;</tt>
<tt>~ $ find /usr/local/games/fs2_open -type f -exec chmod a+r '{}' \;</tt>

===MediaVP and Cutscenes===
You'll also need the mediavp from the SCP if you want the enhanced graphics. Get them at http://scp.indiegames.us.
If you want the cutscenes, you'll have to find the avi version of the MVE files, or to convert them yourself. They are not hard to find. When you have them, just put them in the data/movies directory. Again, make sure everything is lowercase.

That's it for the game data files, now it's time get the source !

== Using the source ==

=== CVS Checkout ===
Before you begin, make sure you have write permissions on your current working directory. Your /home/user/ directory is a pretty sure bet. I recommend that you create a permanent /home/user/src directory from which you run the CVS command, this way CVS will only update the files changed the next time you download the source and it's always nice to have things organized.

Now get the source. Run from a terminal:
$ cvs -d:pserver:anonymous:anonymous@warpcore.org:/home/fs2source/cvsroot login
and then
$ cvs -z3 -d:pserver:anonymous@warpcore.org:/home/fs2source/cvsroot co fs2_open
The first cvs command tells the CVS tool to first use a password file for authentication (pserver), that you are user "anonymous" with the password "anonymous" who wants to access warpcore.org's CVS repository "/home/fs2source/cvsroot" and login. The second command tells the CVS server on which we are now connected to that we want to checkout (co) the fs2_open module.
 
==== CVS Checkout and Update Script ====
The code on CVS is in a constant state of change, and bugs that exist one day may be gone the next. Because of this, you'll want to occasionally update to a newer version and recompile.
Running those cvs commands will fast grow to be a pain, so this little script was created to make your life easier. This script will checkout fs2_open if it can't find a fs2_open directory and update fs2_open, if it finds it.
The script will run until a successfull checkout or update has been achieved.
Copy and save this to a suitably named file like "get_fs2_open", and make it executable with the command, chmod +x <name of file>
#!/bin/bash
# CVS Checkout and Update Script for fs2_open
CVS_LINE="cvs -d:pserver:anonymous:anonymous@warpcore.org:/home/fs2source/cvsroot" # The cvs command
if [ "$UID" = 0 ]; then # check if user is root, and if so, echo a warning.
echo "You are root. If this is a checkout, all files \
will be created with root as the owner."
sleep 3
fi
if [ -e ./fs2_open ]; then # check if directory fs2_open exists
echo "Found fs2_open, We are updating an old checkout."
CVS_ATTEMPT=0 # This updates the checkout.
until [ $CVS_ATTEMPT = 1 ]; do
$CVS_LINE login && \
$CVS_LINE update fs2_open && \
let CVS_ATTEMPT=1
done
else
echo "No fs2_open found, This is a new checkout."
CVS_ATTEMPT=0 # This creates a new checkout.
until [ $CVS_ATTEMPT = 1 ]; do
$CVS_LINE login && \
$CVS_LINE co fs2_open && \
let CVS_ATTEMPT=1
done
fi

=== Pre-Compile Configuration ===

Before you compile you need to configure it for your system. In the directory you ran the CVS command from, a new directory has appear, namely fs2_open.
If your fs2_open is a completely new checkout, you will first need to run the autogen.sh script.
Run from inside your newly created fs2_open directory:
$ ./autogen.sh
autogen.sh is a script that will generate the required makefiles. You will see alot of "checking for this" and "checking for that", this is actually the "configure" script (which can be run with <tt>./configure</tt> if you need to change the options) examining and configuring fs2_open for your system. 
It is possible to give autogen.sh configure options as well, autogen.sh will pass them along to configure.

A full list of configure options can be found by running the configure script with the '--help' option.
$ ./configure --help

==== Optimizing fs2_open ====
Optimizing fs2_open might have little or no effect, or improve performance greatly, I honestly have no clue. 
A note of caution, if you are compiling a debug build, don't use the -fomit-frame-pointer CFLAG, it will make debugging impossible. 
You can specify your compiler flags with the configure script, se below.
$ ./configure CFLAGS="<your desired flags>"
If you got a Athlon-XP and want to play it safe, a good set of CFLAGS would be
$ ./configure CFLAGS="-march=athlon-xp -O3 -pipe -fomit-frame-pointer"
You should read up on CFLAGS and what they do before trying anything. I recommend you read through these links. 
http://gcc.gnu.org/onlinedocs/gcc-3.4.1/gcc/Optimize-Options.html 
http://linuxreviews.org/howtos/compiling/safe-cflags/ 
http://en.wikipedia.org/wiki/CFLAGS

=== Compiling ===

Run from within your fs2_open directory:
$ make
Sit back and enjoy gcc work its magic.

==== Simple Compile Script ====
It's alot easier to use a scripts when dealing with constantly changing code. Copy and save this to a suitably named file like "compile_fs2_open", and make it executable with the command, chmod +x <name of file>
This script assumes the CVS checkout directory fs2_open is pressent in the same directory as the script itself.
#!/bin/bash
# fs2_open Compile Script
# These are only examples, uncomment to enable optimization.
#MY_CFLAGS="-march=athlon-xp -O3 -pipe -fomit-frame-pointer -ftracer"
if [ -e ./fs2_open/ ]; then
cd fs2_open
if [ -e ./Makefile.in ]; then
make clean
./configure CFLAGS="$MY_CFLAGS" CXXFLAGS="$MY_CFLAGS"
make
else
./autogen.sh CFLAGS="$MY_CFLAGS" CXXFLAGS="$MY_CFLAGS"
make
fi
else
echo "No fs2_open directory found."
fi

You can add your options to the ./configure line.

== Using the Binaries ==

When the compile is done and if all went well, a binary executable will reside in the code directory ''fs2_open_r'' or ''fs2_open_d'' if you configured for a debug build. Copy the binary to directory where Freespace2 is installed, and you're all set to go.

=== Post-Compile Configuration ===
==== Changing Your Resolution ====
Odds are, you'll want to run fs2_open in a higher resolution than the default 640x480. Unfortunately, we Linux users don't have the swank launcher app that the Windows folks do. Instead, we'll be making a couple line changes to a config file. You will need to run fs2_open once before you can make the necessary changes, otherwise you won't have a configuration directory to work with.

Open up ~/.fs2_open/fs2_open.ini with the text editor of your choice (vi, EMACS, kwrite, gedit). You'll see something like the following:
[Default]
VideocardFs2open=OGL -(640x480)x16 bit
LastPlayer=MonkeyboyS
GammaD3D=1.0

To set fs2_open to use the highest setting possible on retail Freespace 2, change the VideocardFs2open to:
VideocardFs2open=OGL -(1024x768)x32 bit
You can set this to pretty much anything you want.

=== Creating a Start Up Script ===

In order to use all of the advanced engine features of fs2_open, you'll need to start the executable with a number of command line arguments. Instead of typing them in every time you want to start the game, why not create a script that does it for you?

Create a new file named start_freespace (or whatever you like) in your home directory. Open the file in your editor of choice, and paste the following:
#!/bin/bash
cd /path/to/your/freespace/
./fs2_open_r -spec -glow -mipmap -jpgtga -orbradar -mod Media_VP

''Note: You will need to edit this script before it will work properly. The second line must point to the directory where you installed fs2_open. You can also find a more elaborated script example below in the i18n section''

The last line starts fs2_open with a number of arguments that turn on extra features. In the example, the game will use specular highlights, glow-mapping, mipmapping, jpg and tga graphic files, the orb radar, and any MediaVPs installed to the /Media_VP directory. You should edit this line to use those features that your system supports.

More information about the available Command Line Arguments can be found at the [[Command-Line Reference]]

Once you've edited the file to your heart's content, make it executable:
$ chmod +x start_freespace

You can now type in start_freespace to start the game, or by clicking on start_freespace in your window manager. For convenience, you can copy it to your Desktop.

== Troubleshooting ==
=== Compile Errors ===
==== Missing -lGLU compile error ====

On some Linux distributions (''Slackware'' for instance), compiling fails because a GL related library doesn't have a link in the <tt>/usr/lib</tt> directory. If the compile fails because it can't find <tt>-lGLU</tt>, here are two ways to fix it:

===== Solution as Root =====

If you have root access to the system, you can create a link to the library in question with just a little bit of command line magic. Go to a console and enter:

$ ln -s /usr/X11R6/lib/libGLU.so /usr/lib/libGLU.so

After that, you can run make again and it should finish compiling.

===== Solution as a Non-Root user =====

You don't have root access? Never fear, we can still fix the problem. It'll just be a tad more difficult.

Navigate to the <tt>fs2_open/code</tt> directory and locate a file named <tt>Makefile</tt> (not Makefile.rm or Makefile.in or Makefile.anything). Open it in your favorite text editor and make the following changes.

Find this line (line 457 in mine):
FS2_LDFLAGS = -L/usr/lib -Wl,-rpath,/usr/lib -lSDL -lpthread -lGL -lGLU -lopenal -logg -lvorbis -lvorbisfile

And replace it with this:
FS2_LDFLAGS = -L/usr/lib -Wl,-rpath,/usr/lib -lSDL -lpthread -lGL -lopenal -logg -lvorbis -lvorbisfile -L/usr/X11R6/lib -lGLU

Also find this one (line 565 in mine):
AM_LDFLAGS = -g -L/usr/lib -Wl,-rpath,/usr/lib -lSDL -lpthread -lGL -lGLU -lopenal -logg -lvorbis -lvorbisfile

And replace it with this:
AM_LDFLAGS = -g -L/usr/lib -Wl,-rpath,/usr/lib -lSDL -lpthread -lGL -lopenal -logg -lvorbis -lvorbisfile -L/usr/X11R6/lib -lGLU

Then run <tt>make</tt> from the <tt>fs2_open</tt> directory, and watch the magic happen.

==== glBindBufferARB feature missing ====
''If this is the actual solution to this problem remains to be seen.'' 
''So far, only people using Debian stable are affected by this.'' 
''So we need adventurus Debian users to confirm.'' 
''I can confirm that the APT-Pinning works, can not confirm compile thou. -- ni1s'' 
checking for glBindBufferARB in -lGL... no
configure: error: *** OpenGL version does not have the required features!! (ie.glBindBufferARB()) ***
This error appears if the installed Mesa development library is to old.

On Debian stable branch the xlibmesa-gl-dev package holds version 4.3.0. 
The xlibmesa-gl-dev package on ''testning'' is version 6.9.0.

'''Possible solution:''' 
First set /etc/apt/sources.list to include the testing branch. Add:
#Testing
deb http://ftp.us.debian.org/debian testing main non-free contrib
deb http://non-us.debian.org/debian-non-US testing/non-US main contrib non-free
Your sources.list might have these lines already, if so, you should be okej.

Your /etc/apt/preferences file should look like this
Package: *
Pin: release a=stable
Pin-Priority: 700

Package: *
Pin: release a=testing
Pin-Priority: 650

Package: *
Pin: release a=unstable
Pin-Priority: 600

Add to that file:
Package: xlibmesa-gl-dev
Pin: release a=testing
Pin-Priority: 800
Note that the Pin-Priority of xlibmesa-gl-dev here is higher than the Pin-Priority on 'stable'. As a result of this APT get will prioritize the xlibmesa-gl-dev from testing and leave the rest of the system on stable.
This is called apt-pinning.

Now that APT knows what xlibmesa-gl-dev to prioritze, install it again:
$ apt-get install xlibmesa-gl-dev

If you are using nVidia's nvidia-kernel and glx packages, a simple:
$ apt-get install nvidia-glx-dev
should suffice. No need to mess around with APT-pinning.

=== Runtime Errors and common problems ===
==== ERROR: "Web cursor bitmap not found." ====
ERROR: "Web cursor bitmap not found. This usually means that the executable is being run outside the directory
you installed Freespace2 to. Please move the executable to that directory and try again" at graphics/2d.cpp:1402
A common error. This happens when fs2_open can't find the .vp files or that your user doesn't have the permissions to access them. If you are using a start up script([http://www.hard-light.net/wiki/index.php/Fs2_open_on_Linux#Creating_a_Start_Up_Script like the one found here]) it's most likly the a permission problem.
Have your user take owenership of the .vp files, run as root:
$ chown <user> /path/to/vpfiles/ -R

=== I18n and Key mapping problems ===
''Me, being a Swede, need to use this aswell, especially for the grave key(`), but I also want to use a second X display. There is a way to tell xmodmap to use the new set of keys on the second X display, and thus eliminating the need for a temp. keymap table as it dies with the second display when exiting fs2_open, never touching the keymap table on display 0. We should dig that info up and write a super-start script. --ni1s'' 
Ok, imagine that like me you don't have an us keyboard but a french one (or anything). Well, you probably have problems mapping some keys or even using the default mapping.

Actually, the problem is fs2_open does not take modifiers into account, as it uses them internally as modifiers for keys, and it won't accept non-us charset either.

On a french keyboard layout, the numbers ''1 2 3 4 5 6 7 8 9 0'' are on the same keys than on a US layout, but you have to press shift to use them. The primary function for theses keys are ''& Ã© " ' ( - Ã¨ _ Ã§ Ã )''. These characters won't be accepted by freespace, and if you press shift to get a number, it won't work. This can be a problem, as theses keys are needed to use the communication system, and cannot be bound to anything. Also, as you won't get access some keys on your keyboard, it will be difficult to map every command on a key, or you'll have to use modifiers for nearly each key.

However, there is a solution. You can tell X to remap the keyboard before launching the game, and restore your normal keymap afterwards.

For exemple, I map 123456790 to the &Ã©"'(-Ã¨_Ã§Ã keys so I can use the communication system, and I put , and ; on the Alt-Gr and Menu keys for convenience, as I binded thoses keys to next primary weapon and next secondary weapon.

To do this, I use a slightly enhanced startup script, which I put in ~/bin (this directory is in my path), together with a customized xmodmap.

* First, dump your current xmodmap :

<tt>~ $ xmodmap -pke > ~/xmodmap.current</tt>

* Then edit it with your favorite text editor. You'll see a bunch of lines looking like this :

<tt>
keycode 8 =
keycode 9 = Escape
keycode 10 = 1 ampersand onesuperior exclamdown onesuperior exclamdown
</tt>

The syntax is ''keycode <number> = <symbol list>''.

Use '''xev''' to scan the keycodes. The symbols are defined in ''/usr/include/X11/keysymdef.h''. Just make sure you write them without the ''XK_'' prefix. You'll find more information about xmodmap in the xmodmap manual page.

Just modify the keys you need, and be patient. This can be a long process. Test it with xmodmap :

<tt>~ $ xmodmap - < <filename></tt>

But don't forget to have your previous keymap at hand to recover your settings !
If you mess everything up, just restart X. Your default keymap will be applied from the X configuration.

Here is my own fs2 xmodmap, derived from fr-latin1 as described above. Feel free to use it if you're too lazy to modify your own. However, it may not fit with your needs. You may always use it as an exemple, thougt.
* http://clement.hermann.free.fr/fs2/xmodmap

Then, when the file is modified at your liking, just save it as '''~/.fs2_open/xmodmap'''

We'll start fs2_open with a slightly more elaborate startup script which will backup/apply/restore the keymap in addition of running the games with some options in the right directory.

<tt>
#!/bin/sh
# This script lauches fs2. If there is a file named $FS2_modmap (see below),
# backup the current modmap as $TMP_modmap and load it as the new modmap.
# The current modmap will be restored afterwards.

TMP_modmap="$HOME/xmodmap.tmp"
FS2_modmap="$HOME/.fs2_open/xmodmap"

FS2_OPEN_DIR=/usr/local/games/fs2_open

FS2_ARGS="-glow -spec -spec_exp 11 -spec_point 0.6 -spec_static 0.8 -spec_tube 0.4 -fps -jpgtga -ambient_factor 75 -targetinfo -nograb"

FS2_BIN="$FS2_OPEN_DIR/fs2_open_r"

die() {
echo "** Fatal error : $1" >&2
exit 1
}

cd $FS2_OPEN_DIR || die "Could not change directory to $FS2_OPEN_DIR"

# dump current xmodmap
[ -f "$FS2_modmap" ] && xmodmap -pke > $TMP_modmap

# load xmodmap
[ -f "$FS2_modmap" ] && xmodmap - < $FS2_modmap

# prepare to restore xmodmap on crash or exit
trap "xmodmap - < $TMP_modmap && rm $TMP_modmap" 0 2 3 4 9 11 15

# launch fs2
$FS2_BIN $FS2_ARGS $* || die "Error while running \"$FS2_BIN\" with arguments \"$FS2_ARGS\" ($?)"
</tt>

Adapt this script to your needs, and save it somewhere in your PATH - I for exemple usr ~/bin/freespace2. Make it executable with a chmod +x ''<file>''

That's it, now you can use fs2 with full control over your keyboard.

=== fs2_open freezes X ===
A good way of running games on Linux is having them run on a separate X display. The display you are most likely using now when reading this is 0:0. This display is normally used for whatever Window Manager/Desktop Environment(KDE,Gnome,*box,E) you've chosen. Sometimes fs2_open freezes and locks your X. This is of course very annoying as you have to CTRL+ALT+BACKSPACE to kill the X server, and in that, killing whatever program you had running besides fs2_open. The solution to this is to tell X to start fs2_open on another display. To to this we first need to tell X that you,the user on localhost, holds the permission to run on another display.
In a terminal, enter (NOT as root):
$ xauth list
A list that looks something like this should appear.
myuser@localhost ~ $ xauth list
localhost/unix:'''0''' MIT-MAGIC-COOKIE-1 14ec70e7c8cc835def61a04c92bbd50d
Let's look at that line, first up is your localhost, then unix, and last :0 (in bold). The rest is not really of interest.
Copy the whole line, but change the display value to 1 and paste it after the command ''xauth add'', like this:
$ xauth add localhost/unix:'''1''' MIT-MAGIC-COOKIE-1 14ec70e7c8cc835def61a04c92bbd50d
Run xauth list again. You should see a new entry.
myuser@localhost ~ $ xauth list
localhost/unix:'''0''' MIT-MAGIC-COOKIE-1 14ec70e7c8cc835def61a04c92bbd50d
localhost/unix:'''1''' MIT-MAGIC-COOKIE-1 14ec70e7c8cc835def61a04c92bbd50d
You now have permission to use display 1:0.
To start fs2_open in that display, use xinit.
$ xinit /path/to/fs2_open_r -foo -bar -- :1
The ''-- :1'' tells X that we want to start fs2_open on display 1. 
You can switch to display 0 and 1 with CTRL+ALT+F7 and CTRL+ALT+F8 respectively.

If you try this from an xterm (or a similar X terminal program) and obtain the error ''X: user not authorized to run the X server, aborting.'', the reason might be the file /etc/X11/Xwrapper.config. On my ubuntu machine, it contains the line

allowed_users=console

which means that only users logged in from a console terminal may start a new X server. However, on an xterm, you are on a '''virtual''' terminal and so the above does not work. A possibility is to change the allowed_users in the Xwrapper.config file to "anybody" (see man Xwrapper.config). However, this undermines X security. Another possibility is to start the xinit command from a console window (to which you can change with CTRL+ALT+F1-6).

''If someone knows of a good method to start fs2 on a second X display from an xterm without changing Xwrapper.config, please report it here.''

''A solution might be running xinit as root with sudo, and drop the root privileges in the startup script... Didn't tried, though.'' -- nodens

Guide to FS Open on Linux

2006-06-28T21:43:09Z

Nodens: /* CVS Checkout */ - wording again

''Note: This tutorial assumes some fundamental command line knowledge.''

== Installing CVS ==
CVS stands for Concurrent Versions System and is a version control system used to record the changes in documents, such as source files. Developers use CVS so they can easily share their code changes among other developers. You will need this tool to download ("checkout" in CVS terminology) fs2_open from the CVS server.

'''Debian/Ubuntu''' users want to:
$ apt-get install cvs
'''Gentoo''' users want to:
$ emerge cvs

'''NOTE: Redhat, Mandrake/Mandriva, Slackware and all the other distros should go here too,'''
'''but we have no knowledge on how these work, so if you do, please enlighten us.'''

== Installing the nessesary development libraries ==
You will also need SDL, OpenAL, libvorbis and OpenGL(most likely provided with your video card driver) development packages. And of course the GCC compiler and required make tools.
 
'''Debian/Ubuntu''' users want to:
$ apt-get install libopenal-dev libvorbis-dev build-essential automake1.9 autoconf libsdl-dev
'''NOTE:''' The ''build-essential'' meta package installs GCC4. This should work, but if you feel safer with GCC 3.4(gcc-3.4), add it to the apt-get line above. 
'''Gentoo''' users want to:
$ emerge openal libvorbis libsdl
'''NOTE: Radhat, Mandrake,Slackware and all the other distros should go here too,'''
'''but we have no knowlage on how these work, so if you do, please enlighten us.'''

== Installing game data files ==

This tutorial deals primarily with providing you with an executable, but in order to play the game you also need the game data. Freespace 2 game data is available from a number of sources, see this thread: http://www.hard-light.net/forums/index.php/topic,38195.0.html

Note that if you use the retail CD, you'll need to extract the files and to copy them on your drive, reproducing the same layout as in a working win32 installation (just make sure every file is lowercase). This thread on the SCP forum has some more info on it : http://scp.indiegames.us/forum_viewtopic.php?3.282

There are two ways of doing this :
* use wine to install the game in the right directory, using the Setup.exe found on the first CD, or
* extract manually the files from the cd.

The second method is detailed below. The wine one is straightforward and you shouldn't need any specific instruction, but you'll have to fix permissions and lowercase the filename as well, so keep reading.

===Extracting data from CD===
====Installing unshield====

First, you need unshield from http://synce.sourceforge.net/synce/unshield.php

If you use debian, apt-get install unshield as root should do the trick. Else, try to find a package for your distribution, or if you don't, compile it yourself following the instructions provided on the website. Note you don't need to actually install it, just compile it and use it from the directory where you compiled it.

====Preparing directories====

* Create a directory for fs2_open, say, ''/usr/local/games/fs2_open'', with a ''data/movies'' and ''data/players'' subdirectories. Everything but user files and configuration will be in this directory.

<tt>~ $ mkdir -p /usr/local/games/fs2_open/data/movies /usr/local/games/fs2_open/data/players</tt>

====Extracting files====

* Use unshield to extract the groups from data1.cab (on the first cd) to a temporary directory; then move the files in your game directory :
<tt>~ $ mkdir /tmp/fs2
~ $ for group in "Basic Install Files" "Intel Anims" "Music Compressed" "High Res Files"; do unshield -d tmp/fs2/ -g "$group" -L -j x disk1/data1.cab && mv -v /tmp/fs2/*/* /home/data/jeux/fs2_open
~ $ unshield -d /usr/local/games/fs2_open/data/players -g "Hud Config Files" -L -j x data1.cab && mv -v /tmp/fs2/hud_config_files/* /home/data/jeux/fs2_open/data/players</tt>

* From the second CD, get the vp files and the movies files (I dont think the the mve file are really needed, you'll need the avi ones if you want the movies).
<tt>~ $ cp -vf *.vp /usr/local/games/fs2_open</tt>
<tt>~ $ mkdir -p /usr/local/games/fs2_open/data/movies/ && cp -vf *.MVE /usr/local/games/fs2_open/data/movies/</tt>
* Do the same for the third CD :
<tt>~ $ cp -vf *.vp /usr/local/games/fs2_open</tt>
<tt>~ $ cp -vf *.MVE /usr/local/games/fs2_open/data/movies/</tt>

You may notice that some files are on all three CD. This is because the games was meant to be run from CD. Don't bother.

=== Fixing Case and permissions ===
* You '''have''' to make sure everything is lowercase :
<tt>~ $ find /usr/local/games/fs2_open/ | rename -v 'y/A-Z/a-z/'</tt>

* Then, fix permissions :
<tt>~ $ find /usr/local/games/fs2_open -type d -exec chmod a+rx '{}' \;</tt>
<tt>~ $ find /usr/local/games/fs2_open -type f -exec chmod a+r '{}' \;</tt>

===MediaVP and Cutscenes===
You'll also need the mediavp from the SCP if you want the enhanced graphics. Get them at http://scp.indiegames.us.
If you want the cutscenes, you'll have to find the avi version of the MVE files, or to convert them yourself. They are not hard to find. When you have them, just put them in the data/movies directory. Again, make sure everything is lowercase.

That's it for the game data files, now it's time get the source !

== Using the source ==

=== CVS Checkout ===
Before you begin, make sure you have write permissions on your current working directory. Your /home/user/ directory is a pretty sure bet. I recommend that you create a permanent /home/user/src directory from which you run the CVS command, this way CVS will only update the files changed the next time you download the source and it's always nice to have things organized.

Now get the source. Run from a terminal:
$ cvs -d:pserver:anonymous:anonymous@warpcore.org:/home/fs2source/cvsroot login
and then
$ cvs -z3 -d:pserver:anonymous@warpcore.org:/home/fs2source/cvsroot co fs2_open
The first cvs command tells the CVS tool to first use a password file for authentication (pserver), that you are user "anonymous" with the password "anonymous" who wants to access warpcore.org's CVS repository "/home/fs2source/cvsroot" and login. The second command tells the CVS server on which we are now connected to that we want to checkout (co) the fs2_open module.
 
==== CVS Checkout and Update Script ====
The code on CVS is in a constant state of change, and bugs that exist one day may be gone the next. Because of this, you'll want to occasionally update to a newer version and recompile.
Running those cvs commands will fast grow to be a pain, so this little script was created to make your life easier. This script will checkout fs2_open if it can't find a fs2_open directory and update fs2_open, if it finds it.
The script will run until a successfull checkout or update has been achieved.
Copy and save this to a suitably named file like "get_fs2_open", and make it executable with the command, chmod +x <name of file>
#!/bin/bash
# CVS Checkout and Update Script for fs2_open
CVS_LINE="cvs -d:pserver:anonymous:anonymous@warpcore.org:/home/fs2source/cvsroot" # The cvs command
if [ "$UID" = 0 ]; then # check if user is root, and if so, echo a warning.
echo "You are root. If this is a checkout, all files \
will be created with root as the owner."
sleep 3
fi
if [ -e ./fs2_open ]; then # check if directory fs2_open exists
echo "Found fs2_open, We are updating an old checkout."
CVS_ATTEMPT=0 # This updates the checkout.
until [ $CVS_ATTEMPT = 1 ]; do
$CVS_LINE login && \
$CVS_LINE update fs2_open && \
let CVS_ATTEMPT=1
done
else
echo "No fs2_open found, This is a new checkout."
CVS_ATTEMPT=0 # This creates a new checkout.
until [ $CVS_ATTEMPT = 1 ]; do
$CVS_LINE login && \
$CVS_LINE co fs2_open && \
let CVS_ATTEMPT=1
done
fi

=== Pre-Compile Configuration ===

Before you compile you need to configure it for your system. In the directory you ran the CVS command from, a new directory has appear, namely fs2_open.
If your fs2_open is a completely new checkout, you will first need to run the autogen.sh script.
Run from inside your newly created fs2_open directory:
$ ./autogen.sh
autogen.sh is a script that will generate the required makefiles. You will see alot of "checking for this" and "checking for that", this is actually the "configure" script (which can be run with <tt>./configure</tt> if you need to change the options) examining and configuring fs2_open for your system. 
It is possible to give autogen.sh configure options as well, autogen.sh will pass them along to configure.

A full list of configure options can be found by running the configure script with the '--help' option.
$ ./configure --help

==== Optimizing fs2_open ====
Optimizing fs2_open might have little or no effect, or improve performance greatly, I honestly have no clue. 
A note of caution, if you are compiling a debug build, don't use the -fomit-frame-pointer CFLAG, it will make debugging impossible. 
You can specify your compiler flags with the configure script, se below.
$ ./configure CFLAGS="<your desired flags>"
If you got a Athlon-XP and want to play it safe, a good set of CFLAGS would be
$ ./configure CFLAGS="-march=athlon-xp -O3 -pipe -fomit-frame-pointer"
You should read up on CFLAGS and what they do before trying anything. I recommend you read through these links. 
http://gcc.gnu.org/onlinedocs/gcc-3.4.1/gcc/Optimize-Options.html 
http://linuxreviews.org/howtos/compiling/safe-cflags/ 
http://en.wikipedia.org/wiki/CFLAGS

=== Compiling ===

Run from within your fs2_open directory:
$ make
Sit back and enjoy gcc work its magic.

==== Simple Compile Script ====
It's alot easier to use a scripts when dealing with constantly changing code. Copy and save this to a suitably named file like "compile_fs2_open", and make it executable with the command, chmod +x <name of file>
This script assumes the CVS checkout directory fs2_open is pressent in the same directory as the script itself.
#!/bin/bash
# fs2_open Compile Script
# These are only examples, uncomment to enable optimization.
#MY_CFLAGS="-march=athlon-xp -O3 -pipe -fomit-frame-pointer -ftracer"
if [ -e ./fs2_open/ ]; then
cd fs2_open
if [ -e ./Makefile.in ]; then
make clean
./configure CFLAGS="$MY_CFLAGS" CXXFLAGS="$MY_CFLAGS"
make
else
./autogen.sh CFLAGS="$MY_CFLAGS" CXXFLAGS="$MY_CFLAGS"
make
fi
else
echo "No fs2_open directory found."
fi

You can add your options to the ./configure line.

== Using the Binaries ==

When the compile is done and if all went well, a binary executable will reside in the code directory ''fs2_open_r'' or ''fs2_open_d'' if you configured for a debug build. Copy the binary to directory where Freespace2 is installed, and you're all set to go.

=== Post-Compile Configuration ===
==== Changing Your Resolution ====
Odds are, you'll want to run fs2_open in a higher resolution than the default 640x480. Unfortunately, we Linux users don't have the swank launcher app that the Windows folks do. Instead, we'll be making a couple line changes to a config file. You will need to run fs2_open once before you can make the necessary changes, otherwise you won't have a configuration directory to work with.

Open up ~/.fs2_open/fs2_open.ini with the text editor of your choice (vi, EMACS, kwrite, gedit). You'll see something like the following:
[Default]
VideocardFs2open=OGL -(640x480)x16 bit
LastPlayer=MonkeyboyS
GammaD3D=1.0

To set fs2_open to use the highest setting possible on retail Freespace 2, change the VideocardFs2open to:
VideocardFs2open=OGL -(1024x768)x32 bit
You can set this to pretty much anything you want.

=== Creating a Start Up Script ===

In order to use all of the advanced engine features of fs2_open, you'll need to start the executable with a number of command line arguments. Instead of typing them in every time you want to start the game, why not create a script that does it for you?

Create a new file named start_freespace (or whatever you like) in your home directory. Open the file in your editor of choice, and paste the following:
#!/bin/bash
cd /path/to/your/freespace/
./fs2_open_r -spec -glow -mipmap -jpgtga -orbradar -mod Media_VP

''Note: You will need to edit this script before it will work properly. The second line must point to the directory where you installed fs2_open. You can also find a more elaborated script example below in the i18n section''

The last line starts fs2_open with a number of arguments that turn on extra features. In the example, the game will use specular highlights, glow-mapping, mipmapping, jpg and tga graphic files, the orb radar, and any MediaVPs installed to the /Media_VP directory. You should edit this line to use those features that your system supports.

More information about the available Command Line Arguments can be found at the [[Command-Line Reference]]

Once you've edited the file to your heart's content, make it executable:
$ chmod +x start_freespace

You can now type in start_freespace to start the game, or by clicking on start_freespace in your window manager. For convenience, you can copy it to your Desktop.

== Troubleshooting ==
=== Compile Errors ===
==== Missing -lGLU compile error ====

On some Linux distributions (''Slackware'' for instance), compiling fails because a GL related library doesn't have a link in the <tt>/usr/lib</tt> directory. If the compile fails because it can't find <tt>-lGLU</tt>, here are two ways to fix it:

===== Solution as Root =====

If you have root access to the system, you can create a link to the library in question with just a little bit of command line magic. Go to a console and enter:

$ ln -s /usr/X11R6/lib/libGLU.so /usr/lib/libGLU.so

After that, you can run make again and it should finish compiling.

===== Solution as a Non-Root user =====

You don't have root access? Never fear, we can still fix the problem. It'll just be a tad more difficult.

Navigate to the <tt>fs2_open/code</tt> directory and locate a file named <tt>Makefile</tt> (not Makefile.rm or Makefile.in or Makefile.anything). Open it in your favorite text editor and make the following changes.

Find this line (line 457 in mine):
FS2_LDFLAGS = -L/usr/lib -Wl,-rpath,/usr/lib -lSDL -lpthread -lGL -lGLU -lopenal -logg -lvorbis -lvorbisfile

And replace it with this:
FS2_LDFLAGS = -L/usr/lib -Wl,-rpath,/usr/lib -lSDL -lpthread -lGL -lopenal -logg -lvorbis -lvorbisfile -L/usr/X11R6/lib -lGLU

Also find this one (line 565 in mine):
AM_LDFLAGS = -g -L/usr/lib -Wl,-rpath,/usr/lib -lSDL -lpthread -lGL -lGLU -lopenal -logg -lvorbis -lvorbisfile

And replace it with this:
AM_LDFLAGS = -g -L/usr/lib -Wl,-rpath,/usr/lib -lSDL -lpthread -lGL -lopenal -logg -lvorbis -lvorbisfile -L/usr/X11R6/lib -lGLU

Then run <tt>make</tt> from the <tt>fs2_open</tt> directory, and watch the magic happen.

==== glBindBufferARB feature missing ====
''If this is the actual solution to this problem remains to be seen.'' 
''So far, only people using Debian stable are affected by this.'' 
''So we need adventurus Debian users to confirm.'' 
''I can confirm that the APT-Pinning works, can not confirm compile thou. -- ni1s'' 
checking for glBindBufferARB in -lGL... no
configure: error: *** OpenGL version does not have the required features!! (ie.glBindBufferARB()) ***
This error appears if the installed Mesa development library is to old.

On Debian stable branch the xlibmesa-gl-dev package holds version 4.3.0. 
The xlibmesa-gl-dev package on ''testning'' is version 6.9.0.

'''Possible solution:''' 
First set /etc/apt/sources.list to include the testing branch. Add:
#Testing
deb http://ftp.us.debian.org/debian testing main non-free contrib
deb http://non-us.debian.org/debian-non-US testing/non-US main contrib non-free
Your sources.list might have these lines already, if so, you should be okej.

Your /etc/apt/preferences file should look like this
Package: *
Pin: release a=stable
Pin-Priority: 700

Package: *
Pin: release a=testing
Pin-Priority: 650

Package: *
Pin: release a=unstable
Pin-Priority: 600

Add to that file:
Package: xlibmesa-gl-dev
Pin: release a=testing
Pin-Priority: 800
Note that the Pin-Priority of xlibmesa-gl-dev here is higher than the Pin-Priority on 'stable'. As a result of this APT get will prioritize the xlibmesa-gl-dev from testing and leave the rest of the system on stable.
This is called apt-pinning.

Now that APT knows what xlibmesa-gl-dev to prioritze, install it again:
$ apt-get install xlibmesa-gl-dev

If you are using nVidia's nvidia-kernel and glx packages, a simple:
$ apt-get install nvidia-glx-dev
should suffice. No need to mess around with APT-pinning.

=== Runtime Errors and common problems ===
==== ERROR: "Web cursor bitmap not found." ====
ERROR: "Web cursor bitmap not found. This usually means that the executable is being run outside the directory
you installed Freespace2 to. Please move the executable to that directory and try again" at graphics/2d.cpp:1402
A common error. This happens when fs2_open can't find the .vp files or that your user doesn't have the permissions to access them. If you are using a start up script([http://www.hard-light.net/wiki/index.php/Fs2_open_on_Linux#Creating_a_Start_Up_Script like the one found here]) it's most likly the a permission problem.
Have your user take owenership of the .vp files, run as root:
$ chown <user> /path/to/vpfiles/ -R

=== I18n and Key mapping problems ===
''Me, being a Swede, need to use this aswell, especially for the grave key(`), but I also want to use a second X display. There is a way to tell xmodmap to use the new set of keys on the second X display, and thus eliminating the need for a temp. keymap table as it dies with the second display when exiting fs2_open, never touching the keymap table on display 0. We should dig that info up and write a super-start script. --ni1s'' 
Ok, imagine that like me you don't have an us keyboard but a french one (or anything). Well, you probably have problems mapping some keys or even using the default mapping.

Actually, the problem is fs2_open does not take modifiers into account, as it uses them internally as modifiers for keys, and it won't accept non-us charset either.

On a french keyboard layout, the numbers ''1 2 3 4 5 6 7 8 9 0'' are on the same keys than on a US layout, but you have to press shift to use them. The primary function for theses keys are ''& Ã© " ' ( - Ã¨ _ Ã§ Ã )''. These characters won't be accepted by freespace, and if you press shift to get a number, it won't work. This can be a problem, as theses keys are needed to use the communication system, and cannot be bound to anything. Also, as you won't get access some keys on your keyboard, it will be difficult to map every command on a key, or you'll have to use modifiers for nearly each key.

However, there is a solution. You can tell X to remap the keyboard before launching the game, and restore your normal keymap afterwards.

For exemple, I map 123456790 to the &Ã©"'(-Ã¨_Ã§Ã keys so I can use the communication system, and I put , and ; on the Alt-Gr and Menu keys for convenience, as I binded thoses keys to next primary weapon and next secondary weapon.

To do this, I use a slightly enhanced startup script, which I put in ~/bin (this directory is in my path), together with a customized xmodmap.

* First, dump your current xmodmap :

<tt>~ $ xmodmap -pke > ~/xmodmap.current</tt>

* Then edit it with your favorite text editor. You'll see a bunch of lines looking like this :

<tt>
keycode 8 =
keycode 9 = Escape
keycode 10 = 1 ampersand onesuperior exclamdown onesuperior exclamdown
</tt>

The syntax is ''keycode <number> = <symbol list>''.

Use '''xev''' to scan the keycodes. The symbols are defined in ''/usr/include/X11/keysymdef.h''. Just make sure you write them without the ''XK_'' prefix. You'll find more information about xmodmap in the xmodmap manual page.

Just modify the keys you need, and be patient. This can be a long process. Test it with xmodmap :

<tt>~ $ xmodmap - < <filename></tt>

But don't forget to have your previous keymap at hand to recover your settings !
If you mess everything up, just restart X. Your default keymap will be applied from the X configuration.

Here is my own fs2 xmodmap, derived from fr-latin1 as described above. Feel free to use it if you're too lazy to modify your own. However, it may not fit with your needs. You may always use it as an exemple, thougt.
* http://clement.hermann.free.fr/fs2/xmodmap

Then, when the file is modified at your liking, just save it as '''~/.fs2_open/xmodmap'''

We'll start fs2_open with a slightly more elaborate startup script which will backup/apply/restore the keymap in addition of running the games with some options in the right directory.

<tt>
#!/bin/sh
# This script lauches fs2. If there is a file named $FS2_modmap (see below),
# backup the current modmap as $TMP_modmap and load it as the new modmap.
# The current modmap will be restored afterwards.

TMP_modmap="$HOME/xmodmap.tmp"
FS2_modmap="$HOME/.fs2_open/xmodmap"

FS2_OPEN_DIR=/usr/local/games/fs2_open

FS2_ARGS="-glow -spec -spec_exp 11 -spec_point 0.6 -spec_static 0.8 -spec_tube 0.4 -fps -jpgtga -ambient_factor 75 -targetinfo -nograb"

FS2_BIN="$FS2_OPEN_DIR/fs2_open_r"

die() {
echo "** Fatal error : $1" >&2
exit 1
}

cd $FS2_OPEN_DIR || die "Could not change directory to $FS2_OPEN_DIR"

# dump current xmodmap
[ -f "$FS2_modmap" ] && xmodmap -pke > $TMP_modmap

# load xmodmap
[ -f "$FS2_modmap" ] && xmodmap - < $FS2_modmap

# prepare to restore xmodmap on crash or exit
trap "xmodmap - < $TMP_modmap && rm $TMP_modmap" 0 2 3 4 9 11 15

# launch fs2
$FS2_BIN $FS2_ARGS $* || die "Error while running \"$FS2_BIN\" with arguments \"$FS2_ARGS\" ($?)"
</tt>

Adapt this script to your needs, and save it somewhere in your PATH - I for exemple usr ~/bin/freespace2. Make it executable with a chmod +x ''<file>''

That's it, now you can use fs2 with full control over your keyboard.

=== fs2_open freezes X ===
A good way of running games on Linux is having them run on a separate X display. The display you are most likely using now when reading this is 0:0. This display is normally used for whatever Window Manager/Desktop Environment(KDE,Gnome,*box,E) you've chosen. Sometimes fs2_open freezes and locks your X. This is of course very annoying as you have to CTRL+ALT+BACKSPACE to kill the X server, and in that, killing whatever program you had running besides fs2_open. The solution to this is to tell X to start fs2_open on another display. To to this we first need to tell X that you,the user on localhost, holds the permission to run on another display.
In a terminal, enter (NOT as root):
$ xauth list
A list that looks something like this should appear.
myuser@localhost ~ $ xauth list
localhost/unix:'''0''' MIT-MAGIC-COOKIE-1 14ec70e7c8cc835def61a04c92bbd50d
Let's look at that line, first up is your localhost, then unix, and last :0 (in bold). The rest is not really of interest.
Copy the whole line, but change the display value to 1 and paste it after the command ''xauth add'', like this:
$ xauth add localhost/unix:'''1''' MIT-MAGIC-COOKIE-1 14ec70e7c8cc835def61a04c92bbd50d
Run xauth list again. You should see a new entry.
myuser@localhost ~ $ xauth list
localhost/unix:'''0''' MIT-MAGIC-COOKIE-1 14ec70e7c8cc835def61a04c92bbd50d
localhost/unix:'''1''' MIT-MAGIC-COOKIE-1 14ec70e7c8cc835def61a04c92bbd50d
You now have permission to use display 1:0.
To start fs2_open in that display, use xinit.
$ xinit /path/to/fs2_open_r -foo -bar -- :1
The ''-- :1'' tells X that we want to start fs2_open on display 1. 
You can switch to display 0 and 1 with CTRL+ALT+F7 and CTRL+ALT+F8 respectively.

If you try this from an xterm (or a similar X terminal program) and obtain the error ''X: user not authorized to run the X server, aborting.'', the reason might be the file /etc/X11/Xwrapper.config. On my ubuntu machine, it contains the line

allowed_users=console

which means that only users logged in from a console terminal may start a new X server. However, on an xterm, you are on a '''virtual''' terminal and so the above does not work. A possibility is to change the allowed_users in the Xwrapper.config file to "anybody" (see man Xwrapper.config). However, this undermines X security. Another possibility is to start the xinit command from a console window (to which you can change with CTRL+ALT+F1-6).

''If someone knows of a good method to start fs2 on a second X display from an xterm without changing Xwrapper.config, please report it here.''

''A solution might be running xinit as root with sudo, and drop the root privileges in the startup script... Didn't tried, though.'' -- nodens

Guide to FS Open on Linux

2006-06-28T21:42:20Z

Nodens: /* CVS Checkout */ - better wording

''Note: This tutorial assumes some fundamental command line knowledge.''

== Installing CVS ==
CVS stands for Concurrent Versions System and is a version control system used to record the changes in documents, such as source files. Developers use CVS so they can easily share their code changes among other developers. You will need this tool to download ("checkout" in CVS terminology) fs2_open from the CVS server.

'''Debian/Ubuntu''' users want to:
$ apt-get install cvs
'''Gentoo''' users want to:
$ emerge cvs

'''NOTE: Redhat, Mandrake/Mandriva, Slackware and all the other distros should go here too,'''
'''but we have no knowledge on how these work, so if you do, please enlighten us.'''

== Installing the nessesary development libraries ==
You will also need SDL, OpenAL, libvorbis and OpenGL(most likely provided with your video card driver) development packages. And of course the GCC compiler and required make tools.
 
'''Debian/Ubuntu''' users want to:
$ apt-get install libopenal-dev libvorbis-dev build-essential automake1.9 autoconf libsdl-dev
'''NOTE:''' The ''build-essential'' meta package installs GCC4. This should work, but if you feel safer with GCC 3.4(gcc-3.4), add it to the apt-get line above. 
'''Gentoo''' users want to:
$ emerge openal libvorbis libsdl
'''NOTE: Radhat, Mandrake,Slackware and all the other distros should go here too,'''
'''but we have no knowlage on how these work, so if you do, please enlighten us.'''

== Installing game data files ==

This tutorial deals primarily with providing you with an executable, but in order to play the game you also need the game data. Freespace 2 game data is available from a number of sources, see this thread: http://www.hard-light.net/forums/index.php/topic,38195.0.html

Note that if you use the retail CD, you'll need to extract the files and to copy them on your drive, reproducing the same layout as in a working win32 installation (just make sure every file is lowercase). This thread on the SCP forum has some more info on it : http://scp.indiegames.us/forum_viewtopic.php?3.282

There are two ways of doing this :
* use wine to install the game in the right directory, using the Setup.exe found on the first CD, or
* extract manually the files from the cd.

The second method is detailed below. The wine one is straightforward and you shouldn't need any specific instruction, but you'll have to fix permissions and lowercase the filename as well, so keep reading.

===Extracting data from CD===
====Installing unshield====

First, you need unshield from http://synce.sourceforge.net/synce/unshield.php

If you use debian, apt-get install unshield as root should do the trick. Else, try to find a package for your distribution, or if you don't, compile it yourself following the instructions provided on the website. Note you don't need to actually install it, just compile it and use it from the directory where you compiled it.

====Preparing directories====

* Create a directory for fs2_open, say, ''/usr/local/games/fs2_open'', with a ''data/movies'' and ''data/players'' subdirectories. Everything but user files and configuration will be in this directory.

<tt>~ $ mkdir -p /usr/local/games/fs2_open/data/movies /usr/local/games/fs2_open/data/players</tt>

====Extracting files====

* Use unshield to extract the groups from data1.cab (on the first cd) to a temporary directory; then move the files in your game directory :
<tt>~ $ mkdir /tmp/fs2
~ $ for group in "Basic Install Files" "Intel Anims" "Music Compressed" "High Res Files"; do unshield -d tmp/fs2/ -g "$group" -L -j x disk1/data1.cab && mv -v /tmp/fs2/*/* /home/data/jeux/fs2_open
~ $ unshield -d /usr/local/games/fs2_open/data/players -g "Hud Config Files" -L -j x data1.cab && mv -v /tmp/fs2/hud_config_files/* /home/data/jeux/fs2_open/data/players</tt>

* From the second CD, get the vp files and the movies files (I dont think the the mve file are really needed, you'll need the avi ones if you want the movies).
<tt>~ $ cp -vf *.vp /usr/local/games/fs2_open</tt>
<tt>~ $ mkdir -p /usr/local/games/fs2_open/data/movies/ && cp -vf *.MVE /usr/local/games/fs2_open/data/movies/</tt>
* Do the same for the third CD :
<tt>~ $ cp -vf *.vp /usr/local/games/fs2_open</tt>
<tt>~ $ cp -vf *.MVE /usr/local/games/fs2_open/data/movies/</tt>

You may notice that some files are on all three CD. This is because the games was meant to be run from CD. Don't bother.

=== Fixing Case and permissions ===
* You '''have''' to make sure everything is lowercase :
<tt>~ $ find /usr/local/games/fs2_open/ | rename -v 'y/A-Z/a-z/'</tt>

* Then, fix permissions :
<tt>~ $ find /usr/local/games/fs2_open -type d -exec chmod a+rx '{}' \;</tt>
<tt>~ $ find /usr/local/games/fs2_open -type f -exec chmod a+r '{}' \;</tt>

===MediaVP and Cutscenes===
You'll also need the mediavp from the SCP if you want the enhanced graphics. Get them at http://scp.indiegames.us.
If you want the cutscenes, you'll have to find the avi version of the MVE files, or to convert them yourself. They are not hard to find. When you have them, just put them in the data/movies directory. Again, make sure everything is lowercase.

That's it for the game data files, now it's time get the source !

== Using the source ==

=== CVS Checkout ===
Before you begin, make sure you have write permissions on your current working directory. Your /home/user/ directory is pretty much a sure bet. I recommend that you create a permanent /home/user/src directory from which you run the CVS command, this way CVS will only update the files changed the next time you download the source and it's always nice to have things organized.

Now get the source. Run from a terminal:
$ cvs -d:pserver:anonymous:anonymous@warpcore.org:/home/fs2source/cvsroot login
and then
$ cvs -z3 -d:pserver:anonymous@warpcore.org:/home/fs2source/cvsroot co fs2_open
The first cvs command tells the CVS tool to first use a password file for authentication (pserver), that you are user "anonymous" with the password "anonymous" who wants to access warpcore.org's CVS repository "/home/fs2source/cvsroot" and login. The second command tells the CVS server on which we are now connected to that we want to checkout (co) the fs2_open module.
 
==== CVS Checkout and Update Script ====
The code on CVS is in a constant state of change, and bugs that exist one day may be gone the next. Because of this, you'll want to occasionally update to a newer version and recompile.
Running those cvs commands will fast grow to be a pain, so this little script was created to make your life easier. This script will checkout fs2_open if it can't find a fs2_open directory and update fs2_open, if it finds it.
The script will run until a successfull checkout or update has been achieved.
Copy and save this to a suitably named file like "get_fs2_open", and make it executable with the command, chmod +x <name of file>
#!/bin/bash
# CVS Checkout and Update Script for fs2_open
CVS_LINE="cvs -d:pserver:anonymous:anonymous@warpcore.org:/home/fs2source/cvsroot" # The cvs command
if [ "$UID" = 0 ]; then # check if user is root, and if so, echo a warning.
echo "You are root. If this is a checkout, all files \
will be created with root as the owner."
sleep 3
fi
if [ -e ./fs2_open ]; then # check if directory fs2_open exists
echo "Found fs2_open, We are updating an old checkout."
CVS_ATTEMPT=0 # This updates the checkout.
until [ $CVS_ATTEMPT = 1 ]; do
$CVS_LINE login && \
$CVS_LINE update fs2_open && \
let CVS_ATTEMPT=1
done
else
echo "No fs2_open found, This is a new checkout."
CVS_ATTEMPT=0 # This creates a new checkout.
until [ $CVS_ATTEMPT = 1 ]; do
$CVS_LINE login && \
$CVS_LINE co fs2_open && \
let CVS_ATTEMPT=1
done
fi

=== Pre-Compile Configuration ===

Before you compile you need to configure it for your system. In the directory you ran the CVS command from, a new directory has appear, namely fs2_open.
If your fs2_open is a completely new checkout, you will first need to run the autogen.sh script.
Run from inside your newly created fs2_open directory:
$ ./autogen.sh
autogen.sh is a script that will generate the required makefiles. You will see alot of "checking for this" and "checking for that", this is actually the "configure" script (which can be run with <tt>./configure</tt> if you need to change the options) examining and configuring fs2_open for your system. 
It is possible to give autogen.sh configure options as well, autogen.sh will pass them along to configure.

A full list of configure options can be found by running the configure script with the '--help' option.
$ ./configure --help

==== Optimizing fs2_open ====
Optimizing fs2_open might have little or no effect, or improve performance greatly, I honestly have no clue. 
A note of caution, if you are compiling a debug build, don't use the -fomit-frame-pointer CFLAG, it will make debugging impossible. 
You can specify your compiler flags with the configure script, se below.
$ ./configure CFLAGS="<your desired flags>"
If you got a Athlon-XP and want to play it safe, a good set of CFLAGS would be
$ ./configure CFLAGS="-march=athlon-xp -O3 -pipe -fomit-frame-pointer"
You should read up on CFLAGS and what they do before trying anything. I recommend you read through these links. 
http://gcc.gnu.org/onlinedocs/gcc-3.4.1/gcc/Optimize-Options.html 
http://linuxreviews.org/howtos/compiling/safe-cflags/ 
http://en.wikipedia.org/wiki/CFLAGS

=== Compiling ===

Run from within your fs2_open directory:
$ make
Sit back and enjoy gcc work its magic.

==== Simple Compile Script ====
It's alot easier to use a scripts when dealing with constantly changing code. Copy and save this to a suitably named file like "compile_fs2_open", and make it executable with the command, chmod +x <name of file>
This script assumes the CVS checkout directory fs2_open is pressent in the same directory as the script itself.
#!/bin/bash
# fs2_open Compile Script
# These are only examples, uncomment to enable optimization.
#MY_CFLAGS="-march=athlon-xp -O3 -pipe -fomit-frame-pointer -ftracer"
if [ -e ./fs2_open/ ]; then
cd fs2_open
if [ -e ./Makefile.in ]; then
make clean
./configure CFLAGS="$MY_CFLAGS" CXXFLAGS="$MY_CFLAGS"
make
else
./autogen.sh CFLAGS="$MY_CFLAGS" CXXFLAGS="$MY_CFLAGS"
make
fi
else
echo "No fs2_open directory found."
fi

You can add your options to the ./configure line.

== Using the Binaries ==

When the compile is done and if all went well, a binary executable will reside in the code directory ''fs2_open_r'' or ''fs2_open_d'' if you configured for a debug build. Copy the binary to directory where Freespace2 is installed, and you're all set to go.

=== Post-Compile Configuration ===
==== Changing Your Resolution ====
Odds are, you'll want to run fs2_open in a higher resolution than the default 640x480. Unfortunately, we Linux users don't have the swank launcher app that the Windows folks do. Instead, we'll be making a couple line changes to a config file. You will need to run fs2_open once before you can make the necessary changes, otherwise you won't have a configuration directory to work with.

Open up ~/.fs2_open/fs2_open.ini with the text editor of your choice (vi, EMACS, kwrite, gedit). You'll see something like the following:
[Default]
VideocardFs2open=OGL -(640x480)x16 bit
LastPlayer=MonkeyboyS
GammaD3D=1.0

To set fs2_open to use the highest setting possible on retail Freespace 2, change the VideocardFs2open to:
VideocardFs2open=OGL -(1024x768)x32 bit
You can set this to pretty much anything you want.

=== Creating a Start Up Script ===

In order to use all of the advanced engine features of fs2_open, you'll need to start the executable with a number of command line arguments. Instead of typing them in every time you want to start the game, why not create a script that does it for you?

Create a new file named start_freespace (or whatever you like) in your home directory. Open the file in your editor of choice, and paste the following:
#!/bin/bash
cd /path/to/your/freespace/
./fs2_open_r -spec -glow -mipmap -jpgtga -orbradar -mod Media_VP

''Note: You will need to edit this script before it will work properly. The second line must point to the directory where you installed fs2_open. You can also find a more elaborated script example below in the i18n section''

The last line starts fs2_open with a number of arguments that turn on extra features. In the example, the game will use specular highlights, glow-mapping, mipmapping, jpg and tga graphic files, the orb radar, and any MediaVPs installed to the /Media_VP directory. You should edit this line to use those features that your system supports.

More information about the available Command Line Arguments can be found at the [[Command-Line Reference]]

Once you've edited the file to your heart's content, make it executable:
$ chmod +x start_freespace

You can now type in start_freespace to start the game, or by clicking on start_freespace in your window manager. For convenience, you can copy it to your Desktop.

== Troubleshooting ==
=== Compile Errors ===
==== Missing -lGLU compile error ====

On some Linux distributions (''Slackware'' for instance), compiling fails because a GL related library doesn't have a link in the <tt>/usr/lib</tt> directory. If the compile fails because it can't find <tt>-lGLU</tt>, here are two ways to fix it:

===== Solution as Root =====

If you have root access to the system, you can create a link to the library in question with just a little bit of command line magic. Go to a console and enter:

$ ln -s /usr/X11R6/lib/libGLU.so /usr/lib/libGLU.so

After that, you can run make again and it should finish compiling.

===== Solution as a Non-Root user =====

You don't have root access? Never fear, we can still fix the problem. It'll just be a tad more difficult.

Navigate to the <tt>fs2_open/code</tt> directory and locate a file named <tt>Makefile</tt> (not Makefile.rm or Makefile.in or Makefile.anything). Open it in your favorite text editor and make the following changes.

Find this line (line 457 in mine):
FS2_LDFLAGS = -L/usr/lib -Wl,-rpath,/usr/lib -lSDL -lpthread -lGL -lGLU -lopenal -logg -lvorbis -lvorbisfile

And replace it with this:
FS2_LDFLAGS = -L/usr/lib -Wl,-rpath,/usr/lib -lSDL -lpthread -lGL -lopenal -logg -lvorbis -lvorbisfile -L/usr/X11R6/lib -lGLU

Also find this one (line 565 in mine):
AM_LDFLAGS = -g -L/usr/lib -Wl,-rpath,/usr/lib -lSDL -lpthread -lGL -lGLU -lopenal -logg -lvorbis -lvorbisfile

And replace it with this:
AM_LDFLAGS = -g -L/usr/lib -Wl,-rpath,/usr/lib -lSDL -lpthread -lGL -lopenal -logg -lvorbis -lvorbisfile -L/usr/X11R6/lib -lGLU

Then run <tt>make</tt> from the <tt>fs2_open</tt> directory, and watch the magic happen.

==== glBindBufferARB feature missing ====
''If this is the actual solution to this problem remains to be seen.'' 
''So far, only people using Debian stable are affected by this.'' 
''So we need adventurus Debian users to confirm.'' 
''I can confirm that the APT-Pinning works, can not confirm compile thou. -- ni1s'' 
checking for glBindBufferARB in -lGL... no
configure: error: *** OpenGL version does not have the required features!! (ie.glBindBufferARB()) ***
This error appears if the installed Mesa development library is to old.

On Debian stable branch the xlibmesa-gl-dev package holds version 4.3.0. 
The xlibmesa-gl-dev package on ''testning'' is version 6.9.0.

'''Possible solution:''' 
First set /etc/apt/sources.list to include the testing branch. Add:
#Testing
deb http://ftp.us.debian.org/debian testing main non-free contrib
deb http://non-us.debian.org/debian-non-US testing/non-US main contrib non-free
Your sources.list might have these lines already, if so, you should be okej.

Your /etc/apt/preferences file should look like this
Package: *
Pin: release a=stable
Pin-Priority: 700

Package: *
Pin: release a=testing
Pin-Priority: 650

Package: *
Pin: release a=unstable
Pin-Priority: 600

Add to that file:
Package: xlibmesa-gl-dev
Pin: release a=testing
Pin-Priority: 800
Note that the Pin-Priority of xlibmesa-gl-dev here is higher than the Pin-Priority on 'stable'. As a result of this APT get will prioritize the xlibmesa-gl-dev from testing and leave the rest of the system on stable.
This is called apt-pinning.

Now that APT knows what xlibmesa-gl-dev to prioritze, install it again:
$ apt-get install xlibmesa-gl-dev

If you are using nVidia's nvidia-kernel and glx packages, a simple:
$ apt-get install nvidia-glx-dev
should suffice. No need to mess around with APT-pinning.

=== Runtime Errors and common problems ===
==== ERROR: "Web cursor bitmap not found." ====
ERROR: "Web cursor bitmap not found. This usually means that the executable is being run outside the directory
you installed Freespace2 to. Please move the executable to that directory and try again" at graphics/2d.cpp:1402
A common error. This happens when fs2_open can't find the .vp files or that your user doesn't have the permissions to access them. If you are using a start up script([http://www.hard-light.net/wiki/index.php/Fs2_open_on_Linux#Creating_a_Start_Up_Script like the one found here]) it's most likly the a permission problem.
Have your user take owenership of the .vp files, run as root:
$ chown <user> /path/to/vpfiles/ -R

=== I18n and Key mapping problems ===
''Me, being a Swede, need to use this aswell, especially for the grave key(`), but I also want to use a second X display. There is a way to tell xmodmap to use the new set of keys on the second X display, and thus eliminating the need for a temp. keymap table as it dies with the second display when exiting fs2_open, never touching the keymap table on display 0. We should dig that info up and write a super-start script. --ni1s'' 
Ok, imagine that like me you don't have an us keyboard but a french one (or anything). Well, you probably have problems mapping some keys or even using the default mapping.

Actually, the problem is fs2_open does not take modifiers into account, as it uses them internally as modifiers for keys, and it won't accept non-us charset either.

On a french keyboard layout, the numbers ''1 2 3 4 5 6 7 8 9 0'' are on the same keys than on a US layout, but you have to press shift to use them. The primary function for theses keys are ''& Ã© " ' ( - Ã¨ _ Ã§ Ã )''. These characters won't be accepted by freespace, and if you press shift to get a number, it won't work. This can be a problem, as theses keys are needed to use the communication system, and cannot be bound to anything. Also, as you won't get access some keys on your keyboard, it will be difficult to map every command on a key, or you'll have to use modifiers for nearly each key.

However, there is a solution. You can tell X to remap the keyboard before launching the game, and restore your normal keymap afterwards.

For exemple, I map 123456790 to the &Ã©"'(-Ã¨_Ã§Ã keys so I can use the communication system, and I put , and ; on the Alt-Gr and Menu keys for convenience, as I binded thoses keys to next primary weapon and next secondary weapon.

To do this, I use a slightly enhanced startup script, which I put in ~/bin (this directory is in my path), together with a customized xmodmap.

* First, dump your current xmodmap :

<tt>~ $ xmodmap -pke > ~/xmodmap.current</tt>

* Then edit it with your favorite text editor. You'll see a bunch of lines looking like this :

<tt>
keycode 8 =
keycode 9 = Escape
keycode 10 = 1 ampersand onesuperior exclamdown onesuperior exclamdown
</tt>

The syntax is ''keycode <number> = <symbol list>''.

Use '''xev''' to scan the keycodes. The symbols are defined in ''/usr/include/X11/keysymdef.h''. Just make sure you write them without the ''XK_'' prefix. You'll find more information about xmodmap in the xmodmap manual page.

Just modify the keys you need, and be patient. This can be a long process. Test it with xmodmap :

<tt>~ $ xmodmap - < <filename></tt>

But don't forget to have your previous keymap at hand to recover your settings !
If you mess everything up, just restart X. Your default keymap will be applied from the X configuration.

Here is my own fs2 xmodmap, derived from fr-latin1 as described above. Feel free to use it if you're too lazy to modify your own. However, it may not fit with your needs. You may always use it as an exemple, thougt.
* http://clement.hermann.free.fr/fs2/xmodmap

Then, when the file is modified at your liking, just save it as '''~/.fs2_open/xmodmap'''

We'll start fs2_open with a slightly more elaborate startup script which will backup/apply/restore the keymap in addition of running the games with some options in the right directory.

<tt>
#!/bin/sh
# This script lauches fs2. If there is a file named $FS2_modmap (see below),
# backup the current modmap as $TMP_modmap and load it as the new modmap.
# The current modmap will be restored afterwards.

TMP_modmap="$HOME/xmodmap.tmp"
FS2_modmap="$HOME/.fs2_open/xmodmap"

FS2_OPEN_DIR=/usr/local/games/fs2_open

FS2_ARGS="-glow -spec -spec_exp 11 -spec_point 0.6 -spec_static 0.8 -spec_tube 0.4 -fps -jpgtga -ambient_factor 75 -targetinfo -nograb"

FS2_BIN="$FS2_OPEN_DIR/fs2_open_r"

die() {
echo "** Fatal error : $1" >&2
exit 1
}

cd $FS2_OPEN_DIR || die "Could not change directory to $FS2_OPEN_DIR"

# dump current xmodmap
[ -f "$FS2_modmap" ] && xmodmap -pke > $TMP_modmap

# load xmodmap
[ -f "$FS2_modmap" ] && xmodmap - < $FS2_modmap

# prepare to restore xmodmap on crash or exit
trap "xmodmap - < $TMP_modmap && rm $TMP_modmap" 0 2 3 4 9 11 15

# launch fs2
$FS2_BIN $FS2_ARGS $* || die "Error while running \"$FS2_BIN\" with arguments \"$FS2_ARGS\" ($?)"
</tt>

Adapt this script to your needs, and save it somewhere in your PATH - I for exemple usr ~/bin/freespace2. Make it executable with a chmod +x ''<file>''

That's it, now you can use fs2 with full control over your keyboard.

=== fs2_open freezes X ===
A good way of running games on Linux is having them run on a separate X display. The display you are most likely using now when reading this is 0:0. This display is normally used for whatever Window Manager/Desktop Environment(KDE,Gnome,*box,E) you've chosen. Sometimes fs2_open freezes and locks your X. This is of course very annoying as you have to CTRL+ALT+BACKSPACE to kill the X server, and in that, killing whatever program you had running besides fs2_open. The solution to this is to tell X to start fs2_open on another display. To to this we first need to tell X that you,the user on localhost, holds the permission to run on another display.
In a terminal, enter (NOT as root):
$ xauth list
A list that looks something like this should appear.
myuser@localhost ~ $ xauth list
localhost/unix:'''0''' MIT-MAGIC-COOKIE-1 14ec70e7c8cc835def61a04c92bbd50d
Let's look at that line, first up is your localhost, then unix, and last :0 (in bold). The rest is not really of interest.
Copy the whole line, but change the display value to 1 and paste it after the command ''xauth add'', like this:
$ xauth add localhost/unix:'''1''' MIT-MAGIC-COOKIE-1 14ec70e7c8cc835def61a04c92bbd50d
Run xauth list again. You should see a new entry.
myuser@localhost ~ $ xauth list
localhost/unix:'''0''' MIT-MAGIC-COOKIE-1 14ec70e7c8cc835def61a04c92bbd50d
localhost/unix:'''1''' MIT-MAGIC-COOKIE-1 14ec70e7c8cc835def61a04c92bbd50d
You now have permission to use display 1:0.
To start fs2_open in that display, use xinit.
$ xinit /path/to/fs2_open_r -foo -bar -- :1
The ''-- :1'' tells X that we want to start fs2_open on display 1. 
You can switch to display 0 and 1 with CTRL+ALT+F7 and CTRL+ALT+F8 respectively.

If you try this from an xterm (or a similar X terminal program) and obtain the error ''X: user not authorized to run the X server, aborting.'', the reason might be the file /etc/X11/Xwrapper.config. On my ubuntu machine, it contains the line

allowed_users=console

which means that only users logged in from a console terminal may start a new X server. However, on an xterm, you are on a '''virtual''' terminal and so the above does not work. A possibility is to change the allowed_users in the Xwrapper.config file to "anybody" (see man Xwrapper.config). However, this undermines X security. Another possibility is to start the xinit command from a console window (to which you can change with CTRL+ALT+F1-6).

''If someone knows of a good method to start fs2 on a second X display from an xterm without changing Xwrapper.config, please report it here.''

''A solution might be running xinit as root with sudo, and drop the root privileges in the startup script... Didn't tried, though.'' -- nodens

Guide to FS Open on Linux

2006-06-28T21:39:20Z

Nodens: /* Extracting files */ - wiki syntax

''Note: This tutorial assumes some fundamental command line knowledge.''

== Installing CVS ==
CVS stands for Concurrent Versions System and is a version control system used to record the changes in documents, such as source files. Developers use CVS so they can easily share their code changes among other developers. You will need this tool to download ("checkout" in CVS terminology) fs2_open from the CVS server.

'''Debian/Ubuntu''' users want to:
$ apt-get install cvs
'''Gentoo''' users want to:
$ emerge cvs

'''NOTE: Redhat, Mandrake/Mandriva, Slackware and all the other distros should go here too,'''
'''but we have no knowledge on how these work, so if you do, please enlighten us.'''

== Installing the nessesary development libraries ==
You will also need SDL, OpenAL, libvorbis and OpenGL(most likely provided with your video card driver) development packages. And of course the GCC compiler and required make tools.
 
'''Debian/Ubuntu''' users want to:
$ apt-get install libopenal-dev libvorbis-dev build-essential automake1.9 autoconf libsdl-dev
'''NOTE:''' The ''build-essential'' meta package installs GCC4. This should work, but if you feel safer with GCC 3.4(gcc-3.4), add it to the apt-get line above. 
'''Gentoo''' users want to:
$ emerge openal libvorbis libsdl
'''NOTE: Radhat, Mandrake,Slackware and all the other distros should go here too,'''
'''but we have no knowlage on how these work, so if you do, please enlighten us.'''

== Installing game data files ==

This tutorial deals primarily with providing you with an executable, but in order to play the game you also need the game data. Freespace 2 game data is available from a number of sources, see this thread: http://www.hard-light.net/forums/index.php/topic,38195.0.html

Note that if you use the retail CD, you'll need to extract the files and to copy them on your drive, reproducing the same layout as in a working win32 installation (just make sure every file is lowercase). This thread on the SCP forum has some more info on it : http://scp.indiegames.us/forum_viewtopic.php?3.282

There are two ways of doing this :
* use wine to install the game in the right directory, using the Setup.exe found on the first CD, or
* extract manually the files from the cd.

The second method is detailed below. The wine one is straightforward and you shouldn't need any specific instruction, but you'll have to fix permissions and lowercase the filename as well, so keep reading.

===Extracting data from CD===
====Installing unshield====

First, you need unshield from http://synce.sourceforge.net/synce/unshield.php

If you use debian, apt-get install unshield as root should do the trick. Else, try to find a package for your distribution, or if you don't, compile it yourself following the instructions provided on the website. Note you don't need to actually install it, just compile it and use it from the directory where you compiled it.

====Preparing directories====

* Create a directory for fs2_open, say, ''/usr/local/games/fs2_open'', with a ''data/movies'' and ''data/players'' subdirectories. Everything but user files and configuration will be in this directory.

<tt>~ $ mkdir -p /usr/local/games/fs2_open/data/movies /usr/local/games/fs2_open/data/players</tt>

====Extracting files====

* Use unshield to extract the groups from data1.cab (on the first cd) to a temporary directory; then move the files in your game directory :
<tt>~ $ mkdir /tmp/fs2
~ $ for group in "Basic Install Files" "Intel Anims" "Music Compressed" "High Res Files"; do unshield -d tmp/fs2/ -g "$group" -L -j x disk1/data1.cab && mv -v /tmp/fs2/*/* /home/data/jeux/fs2_open
~ $ unshield -d /usr/local/games/fs2_open/data/players -g "Hud Config Files" -L -j x data1.cab && mv -v /tmp/fs2/hud_config_files/* /home/data/jeux/fs2_open/data/players</tt>

* From the second CD, get the vp files and the movies files (I dont think the the mve file are really needed, you'll need the avi ones if you want the movies).
<tt>~ $ cp -vf *.vp /usr/local/games/fs2_open</tt>
<tt>~ $ mkdir -p /usr/local/games/fs2_open/data/movies/ && cp -vf *.MVE /usr/local/games/fs2_open/data/movies/</tt>
* Do the same for the third CD :
<tt>~ $ cp -vf *.vp /usr/local/games/fs2_open</tt>
<tt>~ $ cp -vf *.MVE /usr/local/games/fs2_open/data/movies/</tt>

You may notice that some files are on all three CD. This is because the games was meant to be run from CD. Don't bother.

=== Fixing Case and permissions ===
* You '''have''' to make sure everything is lowercase :
<tt>~ $ find /usr/local/games/fs2_open/ | rename -v 'y/A-Z/a-z/'</tt>

* Then, fix permissions :
<tt>~ $ find /usr/local/games/fs2_open -type d -exec chmod a+rx '{}' \;</tt>
<tt>~ $ find /usr/local/games/fs2_open -type f -exec chmod a+r '{}' \;</tt>

===MediaVP and Cutscenes===
You'll also need the mediavp from the SCP if you want the enhanced graphics. Get them at http://scp.indiegames.us.
If you want the cutscenes, you'll have to find the avi version of the MVE files, or to convert them yourself. They are not hard to find. When you have them, just put them in the data/movies directory. Again, make sure everything is lowercase.

That's it for the game data files, now it's time get the source !

== Using the source ==

=== CVS Checkout ===
Before you begin, make sure you are situated in a a directory where you have write permissions. Your /home/user/ directory is pretty much a sure bet. I recommend that you create a permanent /home/user/src directory from which you run the CVS command, this way CVS will only update the files changed the next time you download the source and it's always nice to have things organized.

Now get the source. Run from a terminal:
$ cvs -d:pserver:anonymous:anonymous@warpcore.org:/home/fs2source/cvsroot login
and then
$ cvs -z3 -d:pserver:anonymous@warpcore.org:/home/fs2source/cvsroot co fs2_open
The first cvs command tells the CVS tool to first use a password file for authentication (pserver), that you are user "anonymous" with the password "anonymous" who wants to access warpcore.org's CVS repository "/home/fs2source/cvsroot" and login. The second command tells the CVS server on which we are now connected to that we want to checkout (co) the fs2_open module.
 
==== CVS Checkout and Update Script ====
The code on CVS is in a constant state of change, and bugs that exist one day may be gone the next. Because of this, you'll want to occasionally update to a newer version and recompile.
Running those cvs commands will fast grow to be a pain, so this little script was created to make your life easier. This script will checkout fs2_open if it can't find a fs2_open directory and update fs2_open, if it finds it.
The script will run until a successfull checkout or update has been achieved.
Copy and save this to a suitably named file like "get_fs2_open", and make it executable with the command, chmod +x <name of file>
#!/bin/bash
# CVS Checkout and Update Script for fs2_open
CVS_LINE="cvs -d:pserver:anonymous:anonymous@warpcore.org:/home/fs2source/cvsroot" # The cvs command
if [ "$UID" = 0 ]; then # check if user is root, and if so, echo a warning.
echo "You are root. If this is a checkout, all files \
will be created with root as the owner."
sleep 3
fi
if [ -e ./fs2_open ]; then # check if directory fs2_open exists
echo "Found fs2_open, We are updating an old checkout."
CVS_ATTEMPT=0 # This updates the checkout.
until [ $CVS_ATTEMPT = 1 ]; do
$CVS_LINE login && \
$CVS_LINE update fs2_open && \
let CVS_ATTEMPT=1
done
else
echo "No fs2_open found, This is a new checkout."
CVS_ATTEMPT=0 # This creates a new checkout.
until [ $CVS_ATTEMPT = 1 ]; do
$CVS_LINE login && \
$CVS_LINE co fs2_open && \
let CVS_ATTEMPT=1
done
fi

=== Pre-Compile Configuration ===

Before you compile you need to configure it for your system. In the directory you ran the CVS command from, a new directory has appear, namely fs2_open.
If your fs2_open is a completely new checkout, you will first need to run the autogen.sh script.
Run from inside your newly created fs2_open directory:
$ ./autogen.sh
autogen.sh is a script that will generate the required makefiles. You will see alot of "checking for this" and "checking for that", this is actually the "configure" script (which can be run with <tt>./configure</tt> if you need to change the options) examining and configuring fs2_open for your system. 
It is possible to give autogen.sh configure options as well, autogen.sh will pass them along to configure.

A full list of configure options can be found by running the configure script with the '--help' option.
$ ./configure --help

==== Optimizing fs2_open ====
Optimizing fs2_open might have little or no effect, or improve performance greatly, I honestly have no clue. 
A note of caution, if you are compiling a debug build, don't use the -fomit-frame-pointer CFLAG, it will make debugging impossible. 
You can specify your compiler flags with the configure script, se below.
$ ./configure CFLAGS="<your desired flags>"
If you got a Athlon-XP and want to play it safe, a good set of CFLAGS would be
$ ./configure CFLAGS="-march=athlon-xp -O3 -pipe -fomit-frame-pointer"
You should read up on CFLAGS and what they do before trying anything. I recommend you read through these links. 
http://gcc.gnu.org/onlinedocs/gcc-3.4.1/gcc/Optimize-Options.html 
http://linuxreviews.org/howtos/compiling/safe-cflags/ 
http://en.wikipedia.org/wiki/CFLAGS

=== Compiling ===

Run from within your fs2_open directory:
$ make
Sit back and enjoy gcc work its magic.

==== Simple Compile Script ====
It's alot easier to use a scripts when dealing with constantly changing code. Copy and save this to a suitably named file like "compile_fs2_open", and make it executable with the command, chmod +x <name of file>
This script assumes the CVS checkout directory fs2_open is pressent in the same directory as the script itself.
#!/bin/bash
# fs2_open Compile Script
# These are only examples, uncomment to enable optimization.
#MY_CFLAGS="-march=athlon-xp -O3 -pipe -fomit-frame-pointer -ftracer"
if [ -e ./fs2_open/ ]; then
cd fs2_open
if [ -e ./Makefile.in ]; then
make clean
./configure CFLAGS="$MY_CFLAGS" CXXFLAGS="$MY_CFLAGS"
make
else
./autogen.sh CFLAGS="$MY_CFLAGS" CXXFLAGS="$MY_CFLAGS"
make
fi
else
echo "No fs2_open directory found."
fi

You can add your options to the ./configure line.

== Using the Binaries ==

When the compile is done and if all went well, a binary executable will reside in the code directory ''fs2_open_r'' or ''fs2_open_d'' if you configured for a debug build. Copy the binary to directory where Freespace2 is installed, and you're all set to go.

=== Post-Compile Configuration ===
==== Changing Your Resolution ====
Odds are, you'll want to run fs2_open in a higher resolution than the default 640x480. Unfortunately, we Linux users don't have the swank launcher app that the Windows folks do. Instead, we'll be making a couple line changes to a config file. You will need to run fs2_open once before you can make the necessary changes, otherwise you won't have a configuration directory to work with.

Open up ~/.fs2_open/fs2_open.ini with the text editor of your choice (vi, EMACS, kwrite, gedit). You'll see something like the following:
[Default]
VideocardFs2open=OGL -(640x480)x16 bit
LastPlayer=MonkeyboyS
GammaD3D=1.0

To set fs2_open to use the highest setting possible on retail Freespace 2, change the VideocardFs2open to:
VideocardFs2open=OGL -(1024x768)x32 bit
You can set this to pretty much anything you want.

=== Creating a Start Up Script ===

In order to use all of the advanced engine features of fs2_open, you'll need to start the executable with a number of command line arguments. Instead of typing them in every time you want to start the game, why not create a script that does it for you?

Create a new file named start_freespace (or whatever you like) in your home directory. Open the file in your editor of choice, and paste the following:
#!/bin/bash
cd /path/to/your/freespace/
./fs2_open_r -spec -glow -mipmap -jpgtga -orbradar -mod Media_VP

''Note: You will need to edit this script before it will work properly. The second line must point to the directory where you installed fs2_open. You can also find a more elaborated script example below in the i18n section''

The last line starts fs2_open with a number of arguments that turn on extra features. In the example, the game will use specular highlights, glow-mapping, mipmapping, jpg and tga graphic files, the orb radar, and any MediaVPs installed to the /Media_VP directory. You should edit this line to use those features that your system supports.

More information about the available Command Line Arguments can be found at the [[Command-Line Reference]]

Once you've edited the file to your heart's content, make it executable:
$ chmod +x start_freespace

You can now type in start_freespace to start the game, or by clicking on start_freespace in your window manager. For convenience, you can copy it to your Desktop.

== Troubleshooting ==
=== Compile Errors ===
==== Missing -lGLU compile error ====

On some Linux distributions (''Slackware'' for instance), compiling fails because a GL related library doesn't have a link in the <tt>/usr/lib</tt> directory. If the compile fails because it can't find <tt>-lGLU</tt>, here are two ways to fix it:

===== Solution as Root =====

If you have root access to the system, you can create a link to the library in question with just a little bit of command line magic. Go to a console and enter:

$ ln -s /usr/X11R6/lib/libGLU.so /usr/lib/libGLU.so

After that, you can run make again and it should finish compiling.

===== Solution as a Non-Root user =====

You don't have root access? Never fear, we can still fix the problem. It'll just be a tad more difficult.

Navigate to the <tt>fs2_open/code</tt> directory and locate a file named <tt>Makefile</tt> (not Makefile.rm or Makefile.in or Makefile.anything). Open it in your favorite text editor and make the following changes.

Find this line (line 457 in mine):
FS2_LDFLAGS = -L/usr/lib -Wl,-rpath,/usr/lib -lSDL -lpthread -lGL -lGLU -lopenal -logg -lvorbis -lvorbisfile

And replace it with this:
FS2_LDFLAGS = -L/usr/lib -Wl,-rpath,/usr/lib -lSDL -lpthread -lGL -lopenal -logg -lvorbis -lvorbisfile -L/usr/X11R6/lib -lGLU

Also find this one (line 565 in mine):
AM_LDFLAGS = -g -L/usr/lib -Wl,-rpath,/usr/lib -lSDL -lpthread -lGL -lGLU -lopenal -logg -lvorbis -lvorbisfile

And replace it with this:
AM_LDFLAGS = -g -L/usr/lib -Wl,-rpath,/usr/lib -lSDL -lpthread -lGL -lopenal -logg -lvorbis -lvorbisfile -L/usr/X11R6/lib -lGLU

Then run <tt>make</tt> from the <tt>fs2_open</tt> directory, and watch the magic happen.

==== glBindBufferARB feature missing ====
''If this is the actual solution to this problem remains to be seen.'' 
''So far, only people using Debian stable are affected by this.'' 
''So we need adventurus Debian users to confirm.'' 
''I can confirm that the APT-Pinning works, can not confirm compile thou. -- ni1s'' 
checking for glBindBufferARB in -lGL... no
configure: error: *** OpenGL version does not have the required features!! (ie.glBindBufferARB()) ***
This error appears if the installed Mesa development library is to old.

On Debian stable branch the xlibmesa-gl-dev package holds version 4.3.0. 
The xlibmesa-gl-dev package on ''testning'' is version 6.9.0.

'''Possible solution:''' 
First set /etc/apt/sources.list to include the testing branch. Add:
#Testing
deb http://ftp.us.debian.org/debian testing main non-free contrib
deb http://non-us.debian.org/debian-non-US testing/non-US main contrib non-free
Your sources.list might have these lines already, if so, you should be okej.

Your /etc/apt/preferences file should look like this
Package: *
Pin: release a=stable
Pin-Priority: 700

Package: *
Pin: release a=testing
Pin-Priority: 650

Package: *
Pin: release a=unstable
Pin-Priority: 600

Add to that file:
Package: xlibmesa-gl-dev
Pin: release a=testing
Pin-Priority: 800
Note that the Pin-Priority of xlibmesa-gl-dev here is higher than the Pin-Priority on 'stable'. As a result of this APT get will prioritize the xlibmesa-gl-dev from testing and leave the rest of the system on stable.
This is called apt-pinning.

Now that APT knows what xlibmesa-gl-dev to prioritze, install it again:
$ apt-get install xlibmesa-gl-dev

If you are using nVidia's nvidia-kernel and glx packages, a simple:
$ apt-get install nvidia-glx-dev
should suffice. No need to mess around with APT-pinning.

=== Runtime Errors and common problems ===
==== ERROR: "Web cursor bitmap not found." ====
ERROR: "Web cursor bitmap not found. This usually means that the executable is being run outside the directory
you installed Freespace2 to. Please move the executable to that directory and try again" at graphics/2d.cpp:1402
A common error. This happens when fs2_open can't find the .vp files or that your user doesn't have the permissions to access them. If you are using a start up script([http://www.hard-light.net/wiki/index.php/Fs2_open_on_Linux#Creating_a_Start_Up_Script like the one found here]) it's most likly the a permission problem.
Have your user take owenership of the .vp files, run as root:
$ chown <user> /path/to/vpfiles/ -R

=== I18n and Key mapping problems ===
''Me, being a Swede, need to use this aswell, especially for the grave key(`), but I also want to use a second X display. There is a way to tell xmodmap to use the new set of keys on the second X display, and thus eliminating the need for a temp. keymap table as it dies with the second display when exiting fs2_open, never touching the keymap table on display 0. We should dig that info up and write a super-start script. --ni1s'' 
Ok, imagine that like me you don't have an us keyboard but a french one (or anything). Well, you probably have problems mapping some keys or even using the default mapping.

Actually, the problem is fs2_open does not take modifiers into account, as it uses them internally as modifiers for keys, and it won't accept non-us charset either.

On a french keyboard layout, the numbers ''1 2 3 4 5 6 7 8 9 0'' are on the same keys than on a US layout, but you have to press shift to use them. The primary function for theses keys are ''& Ã© " ' ( - Ã¨ _ Ã§ Ã )''. These characters won't be accepted by freespace, and if you press shift to get a number, it won't work. This can be a problem, as theses keys are needed to use the communication system, and cannot be bound to anything. Also, as you won't get access some keys on your keyboard, it will be difficult to map every command on a key, or you'll have to use modifiers for nearly each key.

However, there is a solution. You can tell X to remap the keyboard before launching the game, and restore your normal keymap afterwards.

For exemple, I map 123456790 to the &Ã©"'(-Ã¨_Ã§Ã keys so I can use the communication system, and I put , and ; on the Alt-Gr and Menu keys for convenience, as I binded thoses keys to next primary weapon and next secondary weapon.

To do this, I use a slightly enhanced startup script, which I put in ~/bin (this directory is in my path), together with a customized xmodmap.

* First, dump your current xmodmap :

<tt>~ $ xmodmap -pke > ~/xmodmap.current</tt>

* Then edit it with your favorite text editor. You'll see a bunch of lines looking like this :

<tt>
keycode 8 =
keycode 9 = Escape
keycode 10 = 1 ampersand onesuperior exclamdown onesuperior exclamdown
</tt>

The syntax is ''keycode <number> = <symbol list>''.

Use '''xev''' to scan the keycodes. The symbols are defined in ''/usr/include/X11/keysymdef.h''. Just make sure you write them without the ''XK_'' prefix. You'll find more information about xmodmap in the xmodmap manual page.

Just modify the keys you need, and be patient. This can be a long process. Test it with xmodmap :

<tt>~ $ xmodmap - < <filename></tt>

But don't forget to have your previous keymap at hand to recover your settings !
If you mess everything up, just restart X. Your default keymap will be applied from the X configuration.

Here is my own fs2 xmodmap, derived from fr-latin1 as described above. Feel free to use it if you're too lazy to modify your own. However, it may not fit with your needs. You may always use it as an exemple, thougt.
* http://clement.hermann.free.fr/fs2/xmodmap

Then, when the file is modified at your liking, just save it as '''~/.fs2_open/xmodmap'''

We'll start fs2_open with a slightly more elaborate startup script which will backup/apply/restore the keymap in addition of running the games with some options in the right directory.

<tt>
#!/bin/sh
# This script lauches fs2. If there is a file named $FS2_modmap (see below),
# backup the current modmap as $TMP_modmap and load it as the new modmap.
# The current modmap will be restored afterwards.

TMP_modmap="$HOME/xmodmap.tmp"
FS2_modmap="$HOME/.fs2_open/xmodmap"

FS2_OPEN_DIR=/usr/local/games/fs2_open

FS2_ARGS="-glow -spec -spec_exp 11 -spec_point 0.6 -spec_static 0.8 -spec_tube 0.4 -fps -jpgtga -ambient_factor 75 -targetinfo -nograb"

FS2_BIN="$FS2_OPEN_DIR/fs2_open_r"

die() {
echo "** Fatal error : $1" >&2
exit 1
}

cd $FS2_OPEN_DIR || die "Could not change directory to $FS2_OPEN_DIR"

# dump current xmodmap
[ -f "$FS2_modmap" ] && xmodmap -pke > $TMP_modmap

# load xmodmap
[ -f "$FS2_modmap" ] && xmodmap - < $FS2_modmap

# prepare to restore xmodmap on crash or exit
trap "xmodmap - < $TMP_modmap && rm $TMP_modmap" 0 2 3 4 9 11 15

# launch fs2
$FS2_BIN $FS2_ARGS $* || die "Error while running \"$FS2_BIN\" with arguments \"$FS2_ARGS\" ($?)"
</tt>

Adapt this script to your needs, and save it somewhere in your PATH - I for exemple usr ~/bin/freespace2. Make it executable with a chmod +x ''<file>''

That's it, now you can use fs2 with full control over your keyboard.

=== fs2_open freezes X ===
A good way of running games on Linux is having them run on a separate X display. The display you are most likely using now when reading this is 0:0. This display is normally used for whatever Window Manager/Desktop Environment(KDE,Gnome,*box,E) you've chosen. Sometimes fs2_open freezes and locks your X. This is of course very annoying as you have to CTRL+ALT+BACKSPACE to kill the X server, and in that, killing whatever program you had running besides fs2_open. The solution to this is to tell X to start fs2_open on another display. To to this we first need to tell X that you,the user on localhost, holds the permission to run on another display.
In a terminal, enter (NOT as root):
$ xauth list
A list that looks something like this should appear.
myuser@localhost ~ $ xauth list
localhost/unix:'''0''' MIT-MAGIC-COOKIE-1 14ec70e7c8cc835def61a04c92bbd50d
Let's look at that line, first up is your localhost, then unix, and last :0 (in bold). The rest is not really of interest.
Copy the whole line, but change the display value to 1 and paste it after the command ''xauth add'', like this:
$ xauth add localhost/unix:'''1''' MIT-MAGIC-COOKIE-1 14ec70e7c8cc835def61a04c92bbd50d
Run xauth list again. You should see a new entry.
myuser@localhost ~ $ xauth list
localhost/unix:'''0''' MIT-MAGIC-COOKIE-1 14ec70e7c8cc835def61a04c92bbd50d
localhost/unix:'''1''' MIT-MAGIC-COOKIE-1 14ec70e7c8cc835def61a04c92bbd50d
You now have permission to use display 1:0.
To start fs2_open in that display, use xinit.
$ xinit /path/to/fs2_open_r -foo -bar -- :1
The ''-- :1'' tells X that we want to start fs2_open on display 1. 
You can switch to display 0 and 1 with CTRL+ALT+F7 and CTRL+ALT+F8 respectively.

If you try this from an xterm (or a similar X terminal program) and obtain the error ''X: user not authorized to run the X server, aborting.'', the reason might be the file /etc/X11/Xwrapper.config. On my ubuntu machine, it contains the line

allowed_users=console

which means that only users logged in from a console terminal may start a new X server. However, on an xterm, you are on a '''virtual''' terminal and so the above does not work. A possibility is to change the allowed_users in the Xwrapper.config file to "anybody" (see man Xwrapper.config). However, this undermines X security. Another possibility is to start the xinit command from a console window (to which you can change with CTRL+ALT+F1-6).

''If someone knows of a good method to start fs2 on a second X display from an xterm without changing Xwrapper.config, please report it here.''

''A solution might be running xinit as root with sudo, and drop the root privileges in the startup script... Didn't tried, though.'' -- nodens

Guide to FS Open on Linux

2006-06-28T21:37:56Z

Nodens: /* Extracting files */

''Note: This tutorial assumes some fundamental command line knowledge.''

== Installing CVS ==
CVS stands for Concurrent Versions System and is a version control system used to record the changes in documents, such as source files. Developers use CVS so they can easily share their code changes among other developers. You will need this tool to download ("checkout" in CVS terminology) fs2_open from the CVS server.

'''Debian/Ubuntu''' users want to:
$ apt-get install cvs
'''Gentoo''' users want to:
$ emerge cvs

'''NOTE: Redhat, Mandrake/Mandriva, Slackware and all the other distros should go here too,'''
'''but we have no knowledge on how these work, so if you do, please enlighten us.'''

== Installing the nessesary development libraries ==
You will also need SDL, OpenAL, libvorbis and OpenGL(most likely provided with your video card driver) development packages. And of course the GCC compiler and required make tools.
 
'''Debian/Ubuntu''' users want to:
$ apt-get install libopenal-dev libvorbis-dev build-essential automake1.9 autoconf libsdl-dev
'''NOTE:''' The ''build-essential'' meta package installs GCC4. This should work, but if you feel safer with GCC 3.4(gcc-3.4), add it to the apt-get line above. 
'''Gentoo''' users want to:
$ emerge openal libvorbis libsdl
'''NOTE: Radhat, Mandrake,Slackware and all the other distros should go here too,'''
'''but we have no knowlage on how these work, so if you do, please enlighten us.'''

== Installing game data files ==

This tutorial deals primarily with providing you with an executable, but in order to play the game you also need the game data. Freespace 2 game data is available from a number of sources, see this thread: http://www.hard-light.net/forums/index.php/topic,38195.0.html

Note that if you use the retail CD, you'll need to extract the files and to copy them on your drive, reproducing the same layout as in a working win32 installation (just make sure every file is lowercase). This thread on the SCP forum has some more info on it : http://scp.indiegames.us/forum_viewtopic.php?3.282

There are two ways of doing this :
* use wine to install the game in the right directory, using the Setup.exe found on the first CD, or
* extract manually the files from the cd.

The second method is detailed below. The wine one is straightforward and you shouldn't need any specific instruction, but you'll have to fix permissions and lowercase the filename as well, so keep reading.

===Extracting data from CD===
====Installing unshield====

First, you need unshield from http://synce.sourceforge.net/synce/unshield.php

If you use debian, apt-get install unshield as root should do the trick. Else, try to find a package for your distribution, or if you don't, compile it yourself following the instructions provided on the website. Note you don't need to actually install it, just compile it and use it from the directory where you compiled it.

====Preparing directories====

* Create a directory for fs2_open, say, ''/usr/local/games/fs2_open'', with a ''data/movies'' and ''data/players'' subdirectories. Everything but user files and configuration will be in this directory.

<tt>~ $ mkdir -p /usr/local/games/fs2_open/data/movies /usr/local/games/fs2_open/data/players</tt>

====Extracting files====

* Use unshield to extract the groups from data1.cab (on the first cd) to a temporary directory; then move the files in your game directory :
<tt>~ $ mkdir /tmp/fs2
~ $ for group in "Basic Install Files" "Intel Anims" "Music Compressed" "High Res Files"; do unshield -d tmp/fs2/ -g "$group" -L -j x disk1/data1.cab && mv -v /tmp/fs2/*/* /home/data/jeux/fs2_open
~ $ unshield -d /usr/local/games/fs2_open/data/players -g "Hud Config Files" -L -j x data1.cab && mv -v /tmp/fs2/hud_config_files/"* /home/data/jeux/fs2_open/data/players</tt>

* From the second CD, get the vp files and the movies files (I dont think the the mve file are really needed, you'll need the avi ones if you want the movies).
<tt>~ $ cp -vf *.vp /usr/local/games/fs2_open</tt>
<tt>~ $ mkdir -p /usr/local/games/fs2_open/data/movies/ && cp -vf *.MVE /usr/local/games/fs2_open/data/movies/</tt>
* Do the same for the third CD :
<tt>~ $ cp -vf *.vp /usr/local/games/fs2_open</tt>
<tt>~ $ cp -vf *.MVE /usr/local/games/fs2_open/data/movies/</tt>

You may notice that some files are on all three CD. This is because the games was meant to be run from CD. Don't bother.

=== Fixing Case and permissions ===
* You '''have''' to make sure everything is lowercase :
<tt>~ $ find /usr/local/games/fs2_open/ | rename -v 'y/A-Z/a-z/'</tt>

* Then, fix permissions :
<tt>~ $ find /usr/local/games/fs2_open -type d -exec chmod a+rx '{}' \;</tt>
<tt>~ $ find /usr/local/games/fs2_open -type f -exec chmod a+r '{}' \;</tt>

===MediaVP and Cutscenes===
You'll also need the mediavp from the SCP if you want the enhanced graphics. Get them at http://scp.indiegames.us.
If you want the cutscenes, you'll have to find the avi version of the MVE files, or to convert them yourself. They are not hard to find. When you have them, just put them in the data/movies directory. Again, make sure everything is lowercase.

That's it for the game data files, now it's time get the source !

== Using the source ==

=== CVS Checkout ===
Before you begin, make sure you are situated in a a directory where you have write permissions. Your /home/user/ directory is pretty much a sure bet. I recommend that you create a permanent /home/user/src directory from which you run the CVS command, this way CVS will only update the files changed the next time you download the source and it's always nice to have things organized.

Now get the source. Run from a terminal:
$ cvs -d:pserver:anonymous:anonymous@warpcore.org:/home/fs2source/cvsroot login
and then
$ cvs -z3 -d:pserver:anonymous@warpcore.org:/home/fs2source/cvsroot co fs2_open
The first cvs command tells the CVS tool to first use a password file for authentication (pserver), that you are user "anonymous" with the password "anonymous" who wants to access warpcore.org's CVS repository "/home/fs2source/cvsroot" and login. The second command tells the CVS server on which we are now connected to that we want to checkout (co) the fs2_open module.
 
==== CVS Checkout and Update Script ====
The code on CVS is in a constant state of change, and bugs that exist one day may be gone the next. Because of this, you'll want to occasionally update to a newer version and recompile.
Running those cvs commands will fast grow to be a pain, so this little script was created to make your life easier. This script will checkout fs2_open if it can't find a fs2_open directory and update fs2_open, if it finds it.
The script will run until a successfull checkout or update has been achieved.
Copy and save this to a suitably named file like "get_fs2_open", and make it executable with the command, chmod +x <name of file>
#!/bin/bash
# CVS Checkout and Update Script for fs2_open
CVS_LINE="cvs -d:pserver:anonymous:anonymous@warpcore.org:/home/fs2source/cvsroot" # The cvs command
if [ "$UID" = 0 ]; then # check if user is root, and if so, echo a warning.
echo "You are root. If this is a checkout, all files \
will be created with root as the owner."
sleep 3
fi
if [ -e ./fs2_open ]; then # check if directory fs2_open exists
echo "Found fs2_open, We are updating an old checkout."
CVS_ATTEMPT=0 # This updates the checkout.
until [ $CVS_ATTEMPT = 1 ]; do
$CVS_LINE login && \
$CVS_LINE update fs2_open && \
let CVS_ATTEMPT=1
done
else
echo "No fs2_open found, This is a new checkout."
CVS_ATTEMPT=0 # This creates a new checkout.
until [ $CVS_ATTEMPT = 1 ]; do
$CVS_LINE login && \
$CVS_LINE co fs2_open && \
let CVS_ATTEMPT=1
done
fi

=== Pre-Compile Configuration ===

Before you compile you need to configure it for your system. In the directory you ran the CVS command from, a new directory has appear, namely fs2_open.
If your fs2_open is a completely new checkout, you will first need to run the autogen.sh script.
Run from inside your newly created fs2_open directory:
$ ./autogen.sh
autogen.sh is a script that will generate the required makefiles. You will see alot of "checking for this" and "checking for that", this is actually the "configure" script (which can be run with <tt>./configure</tt> if you need to change the options) examining and configuring fs2_open for your system. 
It is possible to give autogen.sh configure options as well, autogen.sh will pass them along to configure.

A full list of configure options can be found by running the configure script with the '--help' option.
$ ./configure --help

==== Optimizing fs2_open ====
Optimizing fs2_open might have little or no effect, or improve performance greatly, I honestly have no clue. 
A note of caution, if you are compiling a debug build, don't use the -fomit-frame-pointer CFLAG, it will make debugging impossible. 
You can specify your compiler flags with the configure script, se below.
$ ./configure CFLAGS="<your desired flags>"
If you got a Athlon-XP and want to play it safe, a good set of CFLAGS would be
$ ./configure CFLAGS="-march=athlon-xp -O3 -pipe -fomit-frame-pointer"
You should read up on CFLAGS and what they do before trying anything. I recommend you read through these links. 
http://gcc.gnu.org/onlinedocs/gcc-3.4.1/gcc/Optimize-Options.html 
http://linuxreviews.org/howtos/compiling/safe-cflags/ 
http://en.wikipedia.org/wiki/CFLAGS

=== Compiling ===

Run from within your fs2_open directory:
$ make
Sit back and enjoy gcc work its magic.

==== Simple Compile Script ====
It's alot easier to use a scripts when dealing with constantly changing code. Copy and save this to a suitably named file like "compile_fs2_open", and make it executable with the command, chmod +x <name of file>
This script assumes the CVS checkout directory fs2_open is pressent in the same directory as the script itself.
#!/bin/bash
# fs2_open Compile Script
# These are only examples, uncomment to enable optimization.
#MY_CFLAGS="-march=athlon-xp -O3 -pipe -fomit-frame-pointer -ftracer"
if [ -e ./fs2_open/ ]; then
cd fs2_open
if [ -e ./Makefile.in ]; then
make clean
./configure CFLAGS="$MY_CFLAGS" CXXFLAGS="$MY_CFLAGS"
make
else
./autogen.sh CFLAGS="$MY_CFLAGS" CXXFLAGS="$MY_CFLAGS"
make
fi
else
echo "No fs2_open directory found."
fi

You can add your options to the ./configure line.

== Using the Binaries ==

When the compile is done and if all went well, a binary executable will reside in the code directory ''fs2_open_r'' or ''fs2_open_d'' if you configured for a debug build. Copy the binary to directory where Freespace2 is installed, and you're all set to go.

=== Post-Compile Configuration ===
==== Changing Your Resolution ====
Odds are, you'll want to run fs2_open in a higher resolution than the default 640x480. Unfortunately, we Linux users don't have the swank launcher app that the Windows folks do. Instead, we'll be making a couple line changes to a config file. You will need to run fs2_open once before you can make the necessary changes, otherwise you won't have a configuration directory to work with.

Open up ~/.fs2_open/fs2_open.ini with the text editor of your choice (vi, EMACS, kwrite, gedit). You'll see something like the following:
[Default]
VideocardFs2open=OGL -(640x480)x16 bit
LastPlayer=MonkeyboyS
GammaD3D=1.0

To set fs2_open to use the highest setting possible on retail Freespace 2, change the VideocardFs2open to:
VideocardFs2open=OGL -(1024x768)x32 bit
You can set this to pretty much anything you want.

=== Creating a Start Up Script ===

In order to use all of the advanced engine features of fs2_open, you'll need to start the executable with a number of command line arguments. Instead of typing them in every time you want to start the game, why not create a script that does it for you?

Create a new file named start_freespace (or whatever you like) in your home directory. Open the file in your editor of choice, and paste the following:
#!/bin/bash
cd /path/to/your/freespace/
./fs2_open_r -spec -glow -mipmap -jpgtga -orbradar -mod Media_VP

''Note: You will need to edit this script before it will work properly. The second line must point to the directory where you installed fs2_open. You can also find a more elaborated script example below in the i18n section''

The last line starts fs2_open with a number of arguments that turn on extra features. In the example, the game will use specular highlights, glow-mapping, mipmapping, jpg and tga graphic files, the orb radar, and any MediaVPs installed to the /Media_VP directory. You should edit this line to use those features that your system supports.

More information about the available Command Line Arguments can be found at the [[Command-Line Reference]]

Once you've edited the file to your heart's content, make it executable:
$ chmod +x start_freespace

You can now type in start_freespace to start the game, or by clicking on start_freespace in your window manager. For convenience, you can copy it to your Desktop.

== Troubleshooting ==
=== Compile Errors ===
==== Missing -lGLU compile error ====

On some Linux distributions (''Slackware'' for instance), compiling fails because a GL related library doesn't have a link in the <tt>/usr/lib</tt> directory. If the compile fails because it can't find <tt>-lGLU</tt>, here are two ways to fix it:

===== Solution as Root =====

If you have root access to the system, you can create a link to the library in question with just a little bit of command line magic. Go to a console and enter:

$ ln -s /usr/X11R6/lib/libGLU.so /usr/lib/libGLU.so

After that, you can run make again and it should finish compiling.

===== Solution as a Non-Root user =====

You don't have root access? Never fear, we can still fix the problem. It'll just be a tad more difficult.

Navigate to the <tt>fs2_open/code</tt> directory and locate a file named <tt>Makefile</tt> (not Makefile.rm or Makefile.in or Makefile.anything). Open it in your favorite text editor and make the following changes.

Find this line (line 457 in mine):
FS2_LDFLAGS = -L/usr/lib -Wl,-rpath,/usr/lib -lSDL -lpthread -lGL -lGLU -lopenal -logg -lvorbis -lvorbisfile

And replace it with this:
FS2_LDFLAGS = -L/usr/lib -Wl,-rpath,/usr/lib -lSDL -lpthread -lGL -lopenal -logg -lvorbis -lvorbisfile -L/usr/X11R6/lib -lGLU

Also find this one (line 565 in mine):
AM_LDFLAGS = -g -L/usr/lib -Wl,-rpath,/usr/lib -lSDL -lpthread -lGL -lGLU -lopenal -logg -lvorbis -lvorbisfile

And replace it with this:
AM_LDFLAGS = -g -L/usr/lib -Wl,-rpath,/usr/lib -lSDL -lpthread -lGL -lopenal -logg -lvorbis -lvorbisfile -L/usr/X11R6/lib -lGLU

Then run <tt>make</tt> from the <tt>fs2_open</tt> directory, and watch the magic happen.

==== glBindBufferARB feature missing ====
''If this is the actual solution to this problem remains to be seen.'' 
''So far, only people using Debian stable are affected by this.'' 
''So we need adventurus Debian users to confirm.'' 
''I can confirm that the APT-Pinning works, can not confirm compile thou. -- ni1s'' 
checking for glBindBufferARB in -lGL... no
configure: error: *** OpenGL version does not have the required features!! (ie.glBindBufferARB()) ***
This error appears if the installed Mesa development library is to old.

On Debian stable branch the xlibmesa-gl-dev package holds version 4.3.0. 
The xlibmesa-gl-dev package on ''testning'' is version 6.9.0.

'''Possible solution:''' 
First set /etc/apt/sources.list to include the testing branch. Add:
#Testing
deb http://ftp.us.debian.org/debian testing main non-free contrib
deb http://non-us.debian.org/debian-non-US testing/non-US main contrib non-free
Your sources.list might have these lines already, if so, you should be okej.

Your /etc/apt/preferences file should look like this
Package: *
Pin: release a=stable
Pin-Priority: 700

Package: *
Pin: release a=testing
Pin-Priority: 650

Package: *
Pin: release a=unstable
Pin-Priority: 600

Add to that file:
Package: xlibmesa-gl-dev
Pin: release a=testing
Pin-Priority: 800
Note that the Pin-Priority of xlibmesa-gl-dev here is higher than the Pin-Priority on 'stable'. As a result of this APT get will prioritize the xlibmesa-gl-dev from testing and leave the rest of the system on stable.
This is called apt-pinning.

Now that APT knows what xlibmesa-gl-dev to prioritze, install it again:
$ apt-get install xlibmesa-gl-dev

If you are using nVidia's nvidia-kernel and glx packages, a simple:
$ apt-get install nvidia-glx-dev
should suffice. No need to mess around with APT-pinning.

=== Runtime Errors and common problems ===
==== ERROR: "Web cursor bitmap not found." ====
ERROR: "Web cursor bitmap not found. This usually means that the executable is being run outside the directory
you installed Freespace2 to. Please move the executable to that directory and try again" at graphics/2d.cpp:1402
A common error. This happens when fs2_open can't find the .vp files or that your user doesn't have the permissions to access them. If you are using a start up script([http://www.hard-light.net/wiki/index.php/Fs2_open_on_Linux#Creating_a_Start_Up_Script like the one found here]) it's most likly the a permission problem.
Have your user take owenership of the .vp files, run as root:
$ chown <user> /path/to/vpfiles/ -R

=== I18n and Key mapping problems ===
''Me, being a Swede, need to use this aswell, especially for the grave key(`), but I also want to use a second X display. There is a way to tell xmodmap to use the new set of keys on the second X display, and thus eliminating the need for a temp. keymap table as it dies with the second display when exiting fs2_open, never touching the keymap table on display 0. We should dig that info up and write a super-start script. --ni1s'' 
Ok, imagine that like me you don't have an us keyboard but a french one (or anything). Well, you probably have problems mapping some keys or even using the default mapping.

Actually, the problem is fs2_open does not take modifiers into account, as it uses them internally as modifiers for keys, and it won't accept non-us charset either.

On a french keyboard layout, the numbers ''1 2 3 4 5 6 7 8 9 0'' are on the same keys than on a US layout, but you have to press shift to use them. The primary function for theses keys are ''& Ã© " ' ( - Ã¨ _ Ã§ Ã )''. These characters won't be accepted by freespace, and if you press shift to get a number, it won't work. This can be a problem, as theses keys are needed to use the communication system, and cannot be bound to anything. Also, as you won't get access some keys on your keyboard, it will be difficult to map every command on a key, or you'll have to use modifiers for nearly each key.

However, there is a solution. You can tell X to remap the keyboard before launching the game, and restore your normal keymap afterwards.

For exemple, I map 123456790 to the &Ã©"'(-Ã¨_Ã§Ã keys so I can use the communication system, and I put , and ; on the Alt-Gr and Menu keys for convenience, as I binded thoses keys to next primary weapon and next secondary weapon.

To do this, I use a slightly enhanced startup script, which I put in ~/bin (this directory is in my path), together with a customized xmodmap.

* First, dump your current xmodmap :

<tt>~ $ xmodmap -pke > ~/xmodmap.current</tt>

* Then edit it with your favorite text editor. You'll see a bunch of lines looking like this :

<tt>
keycode 8 =
keycode 9 = Escape
keycode 10 = 1 ampersand onesuperior exclamdown onesuperior exclamdown
</tt>

The syntax is ''keycode <number> = <symbol list>''.

Use '''xev''' to scan the keycodes. The symbols are defined in ''/usr/include/X11/keysymdef.h''. Just make sure you write them without the ''XK_'' prefix. You'll find more information about xmodmap in the xmodmap manual page.

Just modify the keys you need, and be patient. This can be a long process. Test it with xmodmap :

<tt>~ $ xmodmap - < <filename></tt>

But don't forget to have your previous keymap at hand to recover your settings !
If you mess everything up, just restart X. Your default keymap will be applied from the X configuration.

Here is my own fs2 xmodmap, derived from fr-latin1 as described above. Feel free to use it if you're too lazy to modify your own. However, it may not fit with your needs. You may always use it as an exemple, thougt.
* http://clement.hermann.free.fr/fs2/xmodmap

Then, when the file is modified at your liking, just save it as '''~/.fs2_open/xmodmap'''

We'll start fs2_open with a slightly more elaborate startup script which will backup/apply/restore the keymap in addition of running the games with some options in the right directory.

<tt>
#!/bin/sh
# This script lauches fs2. If there is a file named $FS2_modmap (see below),
# backup the current modmap as $TMP_modmap and load it as the new modmap.
# The current modmap will be restored afterwards.

TMP_modmap="$HOME/xmodmap.tmp"
FS2_modmap="$HOME/.fs2_open/xmodmap"

FS2_OPEN_DIR=/usr/local/games/fs2_open

FS2_ARGS="-glow -spec -spec_exp 11 -spec_point 0.6 -spec_static 0.8 -spec_tube 0.4 -fps -jpgtga -ambient_factor 75 -targetinfo -nograb"

FS2_BIN="$FS2_OPEN_DIR/fs2_open_r"

die() {
echo "** Fatal error : $1" >&2
exit 1
}

cd $FS2_OPEN_DIR || die "Could not change directory to $FS2_OPEN_DIR"

# dump current xmodmap
[ -f "$FS2_modmap" ] && xmodmap -pke > $TMP_modmap

# load xmodmap
[ -f "$FS2_modmap" ] && xmodmap - < $FS2_modmap

# prepare to restore xmodmap on crash or exit
trap "xmodmap - < $TMP_modmap && rm $TMP_modmap" 0 2 3 4 9 11 15

# launch fs2
$FS2_BIN $FS2_ARGS $* || die "Error while running \"$FS2_BIN\" with arguments \"$FS2_ARGS\" ($?)"
</tt>

Adapt this script to your needs, and save it somewhere in your PATH - I for exemple usr ~/bin/freespace2. Make it executable with a chmod +x ''<file>''

That's it, now you can use fs2 with full control over your keyboard.

=== fs2_open freezes X ===
A good way of running games on Linux is having them run on a separate X display. The display you are most likely using now when reading this is 0:0. This display is normally used for whatever Window Manager/Desktop Environment(KDE,Gnome,*box,E) you've chosen. Sometimes fs2_open freezes and locks your X. This is of course very annoying as you have to CTRL+ALT+BACKSPACE to kill the X server, and in that, killing whatever program you had running besides fs2_open. The solution to this is to tell X to start fs2_open on another display. To to this we first need to tell X that you,the user on localhost, holds the permission to run on another display.
In a terminal, enter (NOT as root):
$ xauth list
A list that looks something like this should appear.
myuser@localhost ~ $ xauth list
localhost/unix:'''0''' MIT-MAGIC-COOKIE-1 14ec70e7c8cc835def61a04c92bbd50d
Let's look at that line, first up is your localhost, then unix, and last :0 (in bold). The rest is not really of interest.
Copy the whole line, but change the display value to 1 and paste it after the command ''xauth add'', like this:
$ xauth add localhost/unix:'''1''' MIT-MAGIC-COOKIE-1 14ec70e7c8cc835def61a04c92bbd50d
Run xauth list again. You should see a new entry.
myuser@localhost ~ $ xauth list
localhost/unix:'''0''' MIT-MAGIC-COOKIE-1 14ec70e7c8cc835def61a04c92bbd50d
localhost/unix:'''1''' MIT-MAGIC-COOKIE-1 14ec70e7c8cc835def61a04c92bbd50d
You now have permission to use display 1:0.
To start fs2_open in that display, use xinit.
$ xinit /path/to/fs2_open_r -foo -bar -- :1
The ''-- :1'' tells X that we want to start fs2_open on display 1. 
You can switch to display 0 and 1 with CTRL+ALT+F7 and CTRL+ALT+F8 respectively.

If you try this from an xterm (or a similar X terminal program) and obtain the error ''X: user not authorized to run the X server, aborting.'', the reason might be the file /etc/X11/Xwrapper.config. On my ubuntu machine, it contains the line

allowed_users=console

which means that only users logged in from a console terminal may start a new X server. However, on an xterm, you are on a '''virtual''' terminal and so the above does not work. A possibility is to change the allowed_users in the Xwrapper.config file to "anybody" (see man Xwrapper.config). However, this undermines X security. Another possibility is to start the xinit command from a console window (to which you can change with CTRL+ALT+F1-6).

''If someone knows of a good method to start fs2 on a second X display from an xterm without changing Xwrapper.config, please report it here.''

''A solution might be running xinit as root with sudo, and drop the root privileges in the startup script... Didn't tried, though.'' -- nodens

Guide to FS Open on Linux

2006-06-28T21:36:34Z

Nodens: /* Installing game data files */ - grammar

''Note: This tutorial assumes some fundamental command line knowledge.''

== Installing CVS ==
CVS stands for Concurrent Versions System and is a version control system used to record the changes in documents, such as source files. Developers use CVS so they can easily share their code changes among other developers. You will need this tool to download ("checkout" in CVS terminology) fs2_open from the CVS server.

'''Debian/Ubuntu''' users want to:
$ apt-get install cvs
'''Gentoo''' users want to:
$ emerge cvs

'''NOTE: Redhat, Mandrake/Mandriva, Slackware and all the other distros should go here too,'''
'''but we have no knowledge on how these work, so if you do, please enlighten us.'''

== Installing the nessesary development libraries ==
You will also need SDL, OpenAL, libvorbis and OpenGL(most likely provided with your video card driver) development packages. And of course the GCC compiler and required make tools.
 
'''Debian/Ubuntu''' users want to:
$ apt-get install libopenal-dev libvorbis-dev build-essential automake1.9 autoconf libsdl-dev
'''NOTE:''' The ''build-essential'' meta package installs GCC4. This should work, but if you feel safer with GCC 3.4(gcc-3.4), add it to the apt-get line above. 
'''Gentoo''' users want to:
$ emerge openal libvorbis libsdl
'''NOTE: Radhat, Mandrake,Slackware and all the other distros should go here too,'''
'''but we have no knowlage on how these work, so if you do, please enlighten us.'''

== Installing game data files ==

This tutorial deals primarily with providing you with an executable, but in order to play the game you also need the game data. Freespace 2 game data is available from a number of sources, see this thread: http://www.hard-light.net/forums/index.php/topic,38195.0.html

Note that if you use the retail CD, you'll need to extract the files and to copy them on your drive, reproducing the same layout as in a working win32 installation (just make sure every file is lowercase). This thread on the SCP forum has some more info on it : http://scp.indiegames.us/forum_viewtopic.php?3.282

There are two ways of doing this :
* use wine to install the game in the right directory, using the Setup.exe found on the first CD, or
* extract manually the files from the cd.

The second method is detailed below. The wine one is straightforward and you shouldn't need any specific instruction, but you'll have to fix permissions and lowercase the filename as well, so keep reading.

===Extracting data from CD===
====Installing unshield====

First, you need unshield from http://synce.sourceforge.net/synce/unshield.php

If you use debian, apt-get install unshield as root should do the trick. Else, try to find a package for your distribution, or if you don't, compile it yourself following the instructions provided on the website. Note you don't need to actually install it, just compile it and use it from the directory where you compiled it.

====Preparing directories====

* Create a directory for fs2_open, say, ''/usr/local/games/fs2_open'', with a ''data/movies'' and ''data/players'' subdirectories. Everything but user files and configuration will be in this directory.

<tt>~ $ mkdir -p /usr/local/games/fs2_open/data/movies /usr/local/games/fs2_open/data/players</tt>

====Extracting files====

* Use unshield to extract the groups from data1.cab (on the first cd) to a temporary directory; then move the files in your game directory :
<tt>~ $ mkdir /tmp/fs2</>
~ $ for group in "Basic Install Files" "Intel Anims" "Music Compressed" "High Res Files"; do unshield -d tmp/fs2/ -g "$group" -L -j x disk1/data1.cab && mv -v /tmp/fs2/*/* /home/data/jeux/fs2_open
~ $ unshield -d /usr/local/games/fs2_open/data/players -g "Hud Config Files" -L -j x data1.cab && mv -v /tmp/fs2/hud_config_files/"* /home/data/jeux/fs2_open/data/players</tt>

* From the second CD, get the vp files and the movies files (I dont think the the mve file are really needed, you'll need the avi ones if you want the movies).
<tt>~ $ cp -vf *.vp /usr/local/games/fs2_open</tt>
<tt>~ $ mkdir -p /usr/local/games/fs2_open/data/movies/ && cp -vf *.MVE /usr/local/games/fs2_open/data/movies/</tt>
* Do the same for the third CD :
<tt>~ $ cp -vf *.vp /usr/local/games/fs2_open</tt>
<tt>~ $ cp -vf *.MVE /usr/local/games/fs2_open/data/movies/</tt>

You may notice that some files are on all three CD. This is because the games was meant to be run from CD. Don't bother.

=== Fixing Case and permissions ===
* You '''have''' to make sure everything is lowercase :
<tt>~ $ find /usr/local/games/fs2_open/ | rename -v 'y/A-Z/a-z/'</tt>

* Then, fix permissions :
<tt>~ $ find /usr/local/games/fs2_open -type d -exec chmod a+rx '{}' \;</tt>
<tt>~ $ find /usr/local/games/fs2_open -type f -exec chmod a+r '{}' \;</tt>

===MediaVP and Cutscenes===
You'll also need the mediavp from the SCP if you want the enhanced graphics. Get them at http://scp.indiegames.us.
If you want the cutscenes, you'll have to find the avi version of the MVE files, or to convert them yourself. They are not hard to find. When you have them, just put them in the data/movies directory. Again, make sure everything is lowercase.

That's it for the game data files, now it's time get the source !

== Using the source ==

=== CVS Checkout ===
Before you begin, make sure you are situated in a a directory where you have write permissions. Your /home/user/ directory is pretty much a sure bet. I recommend that you create a permanent /home/user/src directory from which you run the CVS command, this way CVS will only update the files changed the next time you download the source and it's always nice to have things organized.

Now get the source. Run from a terminal:
$ cvs -d:pserver:anonymous:anonymous@warpcore.org:/home/fs2source/cvsroot login
and then
$ cvs -z3 -d:pserver:anonymous@warpcore.org:/home/fs2source/cvsroot co fs2_open
The first cvs command tells the CVS tool to first use a password file for authentication (pserver), that you are user "anonymous" with the password "anonymous" who wants to access warpcore.org's CVS repository "/home/fs2source/cvsroot" and login. The second command tells the CVS server on which we are now connected to that we want to checkout (co) the fs2_open module.
 
==== CVS Checkout and Update Script ====
The code on CVS is in a constant state of change, and bugs that exist one day may be gone the next. Because of this, you'll want to occasionally update to a newer version and recompile.
Running those cvs commands will fast grow to be a pain, so this little script was created to make your life easier. This script will checkout fs2_open if it can't find a fs2_open directory and update fs2_open, if it finds it.
The script will run until a successfull checkout or update has been achieved.
Copy and save this to a suitably named file like "get_fs2_open", and make it executable with the command, chmod +x <name of file>
#!/bin/bash
# CVS Checkout and Update Script for fs2_open
CVS_LINE="cvs -d:pserver:anonymous:anonymous@warpcore.org:/home/fs2source/cvsroot" # The cvs command
if [ "$UID" = 0 ]; then # check if user is root, and if so, echo a warning.
echo "You are root. If this is a checkout, all files \
will be created with root as the owner."
sleep 3
fi
if [ -e ./fs2_open ]; then # check if directory fs2_open exists
echo "Found fs2_open, We are updating an old checkout."
CVS_ATTEMPT=0 # This updates the checkout.
until [ $CVS_ATTEMPT = 1 ]; do
$CVS_LINE login && \
$CVS_LINE update fs2_open && \
let CVS_ATTEMPT=1
done
else
echo "No fs2_open found, This is a new checkout."
CVS_ATTEMPT=0 # This creates a new checkout.
until [ $CVS_ATTEMPT = 1 ]; do
$CVS_LINE login && \
$CVS_LINE co fs2_open && \
let CVS_ATTEMPT=1
done
fi

=== Pre-Compile Configuration ===

Before you compile you need to configure it for your system. In the directory you ran the CVS command from, a new directory has appear, namely fs2_open.
If your fs2_open is a completely new checkout, you will first need to run the autogen.sh script.
Run from inside your newly created fs2_open directory:
$ ./autogen.sh
autogen.sh is a script that will generate the required makefiles. You will see alot of "checking for this" and "checking for that", this is actually the "configure" script (which can be run with <tt>./configure</tt> if you need to change the options) examining and configuring fs2_open for your system. 
It is possible to give autogen.sh configure options as well, autogen.sh will pass them along to configure.

A full list of configure options can be found by running the configure script with the '--help' option.
$ ./configure --help

==== Optimizing fs2_open ====
Optimizing fs2_open might have little or no effect, or improve performance greatly, I honestly have no clue. 
A note of caution, if you are compiling a debug build, don't use the -fomit-frame-pointer CFLAG, it will make debugging impossible. 
You can specify your compiler flags with the configure script, se below.
$ ./configure CFLAGS="<your desired flags>"
If you got a Athlon-XP and want to play it safe, a good set of CFLAGS would be
$ ./configure CFLAGS="-march=athlon-xp -O3 -pipe -fomit-frame-pointer"
You should read up on CFLAGS and what they do before trying anything. I recommend you read through these links. 
http://gcc.gnu.org/onlinedocs/gcc-3.4.1/gcc/Optimize-Options.html 
http://linuxreviews.org/howtos/compiling/safe-cflags/ 
http://en.wikipedia.org/wiki/CFLAGS

=== Compiling ===

Run from within your fs2_open directory:
$ make
Sit back and enjoy gcc work its magic.

==== Simple Compile Script ====
It's alot easier to use a scripts when dealing with constantly changing code. Copy and save this to a suitably named file like "compile_fs2_open", and make it executable with the command, chmod +x <name of file>
This script assumes the CVS checkout directory fs2_open is pressent in the same directory as the script itself.
#!/bin/bash
# fs2_open Compile Script
# These are only examples, uncomment to enable optimization.
#MY_CFLAGS="-march=athlon-xp -O3 -pipe -fomit-frame-pointer -ftracer"
if [ -e ./fs2_open/ ]; then
cd fs2_open
if [ -e ./Makefile.in ]; then
make clean
./configure CFLAGS="$MY_CFLAGS" CXXFLAGS="$MY_CFLAGS"
make
else
./autogen.sh CFLAGS="$MY_CFLAGS" CXXFLAGS="$MY_CFLAGS"
make
fi
else
echo "No fs2_open directory found."
fi

You can add your options to the ./configure line.

== Using the Binaries ==

When the compile is done and if all went well, a binary executable will reside in the code directory ''fs2_open_r'' or ''fs2_open_d'' if you configured for a debug build. Copy the binary to directory where Freespace2 is installed, and you're all set to go.

=== Post-Compile Configuration ===
==== Changing Your Resolution ====
Odds are, you'll want to run fs2_open in a higher resolution than the default 640x480. Unfortunately, we Linux users don't have the swank launcher app that the Windows folks do. Instead, we'll be making a couple line changes to a config file. You will need to run fs2_open once before you can make the necessary changes, otherwise you won't have a configuration directory to work with.

Open up ~/.fs2_open/fs2_open.ini with the text editor of your choice (vi, EMACS, kwrite, gedit). You'll see something like the following:
[Default]
VideocardFs2open=OGL -(640x480)x16 bit
LastPlayer=MonkeyboyS
GammaD3D=1.0

To set fs2_open to use the highest setting possible on retail Freespace 2, change the VideocardFs2open to:
VideocardFs2open=OGL -(1024x768)x32 bit
You can set this to pretty much anything you want.

=== Creating a Start Up Script ===

In order to use all of the advanced engine features of fs2_open, you'll need to start the executable with a number of command line arguments. Instead of typing them in every time you want to start the game, why not create a script that does it for you?

Create a new file named start_freespace (or whatever you like) in your home directory. Open the file in your editor of choice, and paste the following:
#!/bin/bash
cd /path/to/your/freespace/
./fs2_open_r -spec -glow -mipmap -jpgtga -orbradar -mod Media_VP

''Note: You will need to edit this script before it will work properly. The second line must point to the directory where you installed fs2_open. You can also find a more elaborated script example below in the i18n section''

The last line starts fs2_open with a number of arguments that turn on extra features. In the example, the game will use specular highlights, glow-mapping, mipmapping, jpg and tga graphic files, the orb radar, and any MediaVPs installed to the /Media_VP directory. You should edit this line to use those features that your system supports.

More information about the available Command Line Arguments can be found at the [[Command-Line Reference]]

Once you've edited the file to your heart's content, make it executable:
$ chmod +x start_freespace

You can now type in start_freespace to start the game, or by clicking on start_freespace in your window manager. For convenience, you can copy it to your Desktop.

== Troubleshooting ==
=== Compile Errors ===
==== Missing -lGLU compile error ====

On some Linux distributions (''Slackware'' for instance), compiling fails because a GL related library doesn't have a link in the <tt>/usr/lib</tt> directory. If the compile fails because it can't find <tt>-lGLU</tt>, here are two ways to fix it:

===== Solution as Root =====

If you have root access to the system, you can create a link to the library in question with just a little bit of command line magic. Go to a console and enter:

$ ln -s /usr/X11R6/lib/libGLU.so /usr/lib/libGLU.so

After that, you can run make again and it should finish compiling.

===== Solution as a Non-Root user =====

You don't have root access? Never fear, we can still fix the problem. It'll just be a tad more difficult.

Navigate to the <tt>fs2_open/code</tt> directory and locate a file named <tt>Makefile</tt> (not Makefile.rm or Makefile.in or Makefile.anything). Open it in your favorite text editor and make the following changes.

Find this line (line 457 in mine):
FS2_LDFLAGS = -L/usr/lib -Wl,-rpath,/usr/lib -lSDL -lpthread -lGL -lGLU -lopenal -logg -lvorbis -lvorbisfile

And replace it with this:
FS2_LDFLAGS = -L/usr/lib -Wl,-rpath,/usr/lib -lSDL -lpthread -lGL -lopenal -logg -lvorbis -lvorbisfile -L/usr/X11R6/lib -lGLU

Also find this one (line 565 in mine):
AM_LDFLAGS = -g -L/usr/lib -Wl,-rpath,/usr/lib -lSDL -lpthread -lGL -lGLU -lopenal -logg -lvorbis -lvorbisfile

And replace it with this:
AM_LDFLAGS = -g -L/usr/lib -Wl,-rpath,/usr/lib -lSDL -lpthread -lGL -lopenal -logg -lvorbis -lvorbisfile -L/usr/X11R6/lib -lGLU

Then run <tt>make</tt> from the <tt>fs2_open</tt> directory, and watch the magic happen.

==== glBindBufferARB feature missing ====
''If this is the actual solution to this problem remains to be seen.'' 
''So far, only people using Debian stable are affected by this.'' 
''So we need adventurus Debian users to confirm.'' 
''I can confirm that the APT-Pinning works, can not confirm compile thou. -- ni1s'' 
checking for glBindBufferARB in -lGL... no
configure: error: *** OpenGL version does not have the required features!! (ie.glBindBufferARB()) ***
This error appears if the installed Mesa development library is to old.

On Debian stable branch the xlibmesa-gl-dev package holds version 4.3.0. 
The xlibmesa-gl-dev package on ''testning'' is version 6.9.0.

'''Possible solution:''' 
First set /etc/apt/sources.list to include the testing branch. Add:
#Testing
deb http://ftp.us.debian.org/debian testing main non-free contrib
deb http://non-us.debian.org/debian-non-US testing/non-US main contrib non-free
Your sources.list might have these lines already, if so, you should be okej.

Your /etc/apt/preferences file should look like this
Package: *
Pin: release a=stable
Pin-Priority: 700

Package: *
Pin: release a=testing
Pin-Priority: 650

Package: *
Pin: release a=unstable
Pin-Priority: 600

Add to that file:
Package: xlibmesa-gl-dev
Pin: release a=testing
Pin-Priority: 800
Note that the Pin-Priority of xlibmesa-gl-dev here is higher than the Pin-Priority on 'stable'. As a result of this APT get will prioritize the xlibmesa-gl-dev from testing and leave the rest of the system on stable.
This is called apt-pinning.

Now that APT knows what xlibmesa-gl-dev to prioritze, install it again:
$ apt-get install xlibmesa-gl-dev

If you are using nVidia's nvidia-kernel and glx packages, a simple:
$ apt-get install nvidia-glx-dev
should suffice. No need to mess around with APT-pinning.

=== Runtime Errors and common problems ===
==== ERROR: "Web cursor bitmap not found." ====
ERROR: "Web cursor bitmap not found. This usually means that the executable is being run outside the directory
you installed Freespace2 to. Please move the executable to that directory and try again" at graphics/2d.cpp:1402
A common error. This happens when fs2_open can't find the .vp files or that your user doesn't have the permissions to access them. If you are using a start up script([http://www.hard-light.net/wiki/index.php/Fs2_open_on_Linux#Creating_a_Start_Up_Script like the one found here]) it's most likly the a permission problem.
Have your user take owenership of the .vp files, run as root:
$ chown <user> /path/to/vpfiles/ -R

=== I18n and Key mapping problems ===
''Me, being a Swede, need to use this aswell, especially for the grave key(`), but I also want to use a second X display. There is a way to tell xmodmap to use the new set of keys on the second X display, and thus eliminating the need for a temp. keymap table as it dies with the second display when exiting fs2_open, never touching the keymap table on display 0. We should dig that info up and write a super-start script. --ni1s'' 
Ok, imagine that like me you don't have an us keyboard but a french one (or anything). Well, you probably have problems mapping some keys or even using the default mapping.

Actually, the problem is fs2_open does not take modifiers into account, as it uses them internally as modifiers for keys, and it won't accept non-us charset either.

On a french keyboard layout, the numbers ''1 2 3 4 5 6 7 8 9 0'' are on the same keys than on a US layout, but you have to press shift to use them. The primary function for theses keys are ''& Ã© " ' ( - Ã¨ _ Ã§ Ã )''. These characters won't be accepted by freespace, and if you press shift to get a number, it won't work. This can be a problem, as theses keys are needed to use the communication system, and cannot be bound to anything. Also, as you won't get access some keys on your keyboard, it will be difficult to map every command on a key, or you'll have to use modifiers for nearly each key.

However, there is a solution. You can tell X to remap the keyboard before launching the game, and restore your normal keymap afterwards.

For exemple, I map 123456790 to the &Ã©"'(-Ã¨_Ã§Ã keys so I can use the communication system, and I put , and ; on the Alt-Gr and Menu keys for convenience, as I binded thoses keys to next primary weapon and next secondary weapon.

To do this, I use a slightly enhanced startup script, which I put in ~/bin (this directory is in my path), together with a customized xmodmap.

* First, dump your current xmodmap :

<tt>~ $ xmodmap -pke > ~/xmodmap.current</tt>

* Then edit it with your favorite text editor. You'll see a bunch of lines looking like this :

<tt>
keycode 8 =
keycode 9 = Escape
keycode 10 = 1 ampersand onesuperior exclamdown onesuperior exclamdown
</tt>

The syntax is ''keycode <number> = <symbol list>''.

Use '''xev''' to scan the keycodes. The symbols are defined in ''/usr/include/X11/keysymdef.h''. Just make sure you write them without the ''XK_'' prefix. You'll find more information about xmodmap in the xmodmap manual page.

Just modify the keys you need, and be patient. This can be a long process. Test it with xmodmap :

<tt>~ $ xmodmap - < <filename></tt>

But don't forget to have your previous keymap at hand to recover your settings !
If you mess everything up, just restart X. Your default keymap will be applied from the X configuration.

Here is my own fs2 xmodmap, derived from fr-latin1 as described above. Feel free to use it if you're too lazy to modify your own. However, it may not fit with your needs. You may always use it as an exemple, thougt.
* http://clement.hermann.free.fr/fs2/xmodmap

Then, when the file is modified at your liking, just save it as '''~/.fs2_open/xmodmap'''

We'll start fs2_open with a slightly more elaborate startup script which will backup/apply/restore the keymap in addition of running the games with some options in the right directory.

<tt>
#!/bin/sh
# This script lauches fs2. If there is a file named $FS2_modmap (see below),
# backup the current modmap as $TMP_modmap and load it as the new modmap.
# The current modmap will be restored afterwards.

TMP_modmap="$HOME/xmodmap.tmp"
FS2_modmap="$HOME/.fs2_open/xmodmap"

FS2_OPEN_DIR=/usr/local/games/fs2_open

FS2_ARGS="-glow -spec -spec_exp 11 -spec_point 0.6 -spec_static 0.8 -spec_tube 0.4 -fps -jpgtga -ambient_factor 75 -targetinfo -nograb"

FS2_BIN="$FS2_OPEN_DIR/fs2_open_r"

die() {
echo "** Fatal error : $1" >&2
exit 1
}

cd $FS2_OPEN_DIR || die "Could not change directory to $FS2_OPEN_DIR"

# dump current xmodmap
[ -f "$FS2_modmap" ] && xmodmap -pke > $TMP_modmap

# load xmodmap
[ -f "$FS2_modmap" ] && xmodmap - < $FS2_modmap

# prepare to restore xmodmap on crash or exit
trap "xmodmap - < $TMP_modmap && rm $TMP_modmap" 0 2 3 4 9 11 15

# launch fs2
$FS2_BIN $FS2_ARGS $* || die "Error while running \"$FS2_BIN\" with arguments \"$FS2_ARGS\" ($?)"
</tt>

Adapt this script to your needs, and save it somewhere in your PATH - I for exemple usr ~/bin/freespace2. Make it executable with a chmod +x ''<file>''

That's it, now you can use fs2 with full control over your keyboard.

=== fs2_open freezes X ===
A good way of running games on Linux is having them run on a separate X display. The display you are most likely using now when reading this is 0:0. This display is normally used for whatever Window Manager/Desktop Environment(KDE,Gnome,*box,E) you've chosen. Sometimes fs2_open freezes and locks your X. This is of course very annoying as you have to CTRL+ALT+BACKSPACE to kill the X server, and in that, killing whatever program you had running besides fs2_open. The solution to this is to tell X to start fs2_open on another display. To to this we first need to tell X that you,the user on localhost, holds the permission to run on another display.
In a terminal, enter (NOT as root):
$ xauth list
A list that looks something like this should appear.
myuser@localhost ~ $ xauth list
localhost/unix:'''0''' MIT-MAGIC-COOKIE-1 14ec70e7c8cc835def61a04c92bbd50d
Let's look at that line, first up is your localhost, then unix, and last :0 (in bold). The rest is not really of interest.
Copy the whole line, but change the display value to 1 and paste it after the command ''xauth add'', like this:
$ xauth add localhost/unix:'''1''' MIT-MAGIC-COOKIE-1 14ec70e7c8cc835def61a04c92bbd50d
Run xauth list again. You should see a new entry.
myuser@localhost ~ $ xauth list
localhost/unix:'''0''' MIT-MAGIC-COOKIE-1 14ec70e7c8cc835def61a04c92bbd50d
localhost/unix:'''1''' MIT-MAGIC-COOKIE-1 14ec70e7c8cc835def61a04c92bbd50d
You now have permission to use display 1:0.
To start fs2_open in that display, use xinit.
$ xinit /path/to/fs2_open_r -foo -bar -- :1
The ''-- :1'' tells X that we want to start fs2_open on display 1. 
You can switch to display 0 and 1 with CTRL+ALT+F7 and CTRL+ALT+F8 respectively.

If you try this from an xterm (or a similar X terminal program) and obtain the error ''X: user not authorized to run the X server, aborting.'', the reason might be the file /etc/X11/Xwrapper.config. On my ubuntu machine, it contains the line

allowed_users=console

which means that only users logged in from a console terminal may start a new X server. However, on an xterm, you are on a '''virtual''' terminal and so the above does not work. A possibility is to change the allowed_users in the Xwrapper.config file to "anybody" (see man Xwrapper.config). However, this undermines X security. Another possibility is to start the xinit command from a console window (to which you can change with CTRL+ALT+F1-6).

''If someone knows of a good method to start fs2 on a second X display from an xterm without changing Xwrapper.config, please report it here.''

''A solution might be running xinit as root with sudo, and drop the root privileges in the startup script... Didn't tried, though.'' -- nodens

Guide to FS Open on Linux

2006-06-28T21:33:29Z

Nodens: my english is soooo bad.

''Note: This tutorial assumes some fundamental command line knowledge.''

== Installing CVS ==
CVS stands for Concurrent Versions System and is a version control system used to record the changes in documents, such as source files. Developers use CVS so they can easily share their code changes among other developers. You will need this tool to download ("checkout" in CVS terminology) fs2_open from the CVS server.

'''Debian/Ubuntu''' users want to:
$ apt-get install cvs
'''Gentoo''' users want to:
$ emerge cvs

'''NOTE: Redhat, Mandrake/Mandriva, Slackware and all the other distros should go here too,'''
'''but we have no knowledge on how these work, so if you do, please enlighten us.'''

== Installing the nessesary development libraries ==
You will also need SDL, OpenAL, libvorbis and OpenGL(most likely provided with your video card driver) development packages. And of course the GCC compiler and required make tools.
 
'''Debian/Ubuntu''' users want to:
$ apt-get install libopenal-dev libvorbis-dev build-essential automake1.9 autoconf libsdl-dev
'''NOTE:''' The ''build-essential'' meta package installs GCC4. This should work, but if you feel safer with GCC 3.4(gcc-3.4), add it to the apt-get line above. 
'''Gentoo''' users want to:
$ emerge openal libvorbis libsdl
'''NOTE: Radhat, Mandrake,Slackware and all the other distros should go here too,'''
'''but we have no knowlage on how these work, so if you do, please enlighten us.'''

== Installing game data files ==

This tutorial deals primarily with providing you with an executable, but in order to play the game you also need the game data. Freespace 2 game data is available from a number of sources, see this thread: http://www.hard-light.net/forums/index.php/topic,38195.0.html

Note that if you use the retail CD, you'll need to extract the files and copying them on your drive, reproducing the same layout as in a working win32 installation (just make sure every file is lowercase). This thread on the SCP forum has some more info on it : http://scp.indiegames.us/forum_viewtopic.php?3.282

There are two ways of doing this :
* use wine to install the game in the right directory, using the Setup.exe found on the first CD, or
* extract manually the files from the cd.

The second method is detailed below. The wine one is straightforward and you shouldn't need any specific instruction, but you'll have to fix permissions and lowercase the filename as well, so keep reading.

===Extracting data from CD===
====Installing unshield====

First, you need unshield from http://synce.sourceforge.net/synce/unshield.php

If you use debian, apt-get install unshield as root should do the trick. Else, try to find a package for your distribution, or if you don't, compile it yourself following the instructions provided on the website. Note you don't need to actually install it, just compile it and use it from the directory where you compiled it.

====Preparing directories====

* Create a directory for fs2_open, say, ''/usr/local/games/fs2_open'', with a ''data/movies'' and ''data/players'' subdirectories. Everything but user files and configuration will be in this directory.

<tt>~ $ mkdir -p /usr/local/games/fs2_open/data/movies /usr/local/games/fs2_open/data/players</tt>

====Extracting files====

* Use unshield to extract the groups from data1.cab (on the first cd) to a temporary directory; then move the files in your game directory :
<tt>~ $ mkdir /tmp/fs2</>
~ $ for group in "Basic Install Files" "Intel Anims" "Music Compressed" "High Res Files"; do unshield -d tmp/fs2/ -g "$group" -L -j x disk1/data1.cab && mv -v /tmp/fs2/*/* /home/data/jeux/fs2_open
~ $ unshield -d /usr/local/games/fs2_open/data/players -g "Hud Config Files" -L -j x data1.cab && mv -v /tmp/fs2/hud_config_files/"* /home/data/jeux/fs2_open/data/players</tt>

* From the second CD, get the vp files and the movies files (I dont think the the mve file are really needed, you'll need the avi ones if you want the movies).
<tt>~ $ cp -vf *.vp /usr/local/games/fs2_open</tt>
<tt>~ $ mkdir -p /usr/local/games/fs2_open/data/movies/ && cp -vf *.MVE /usr/local/games/fs2_open/data/movies/</tt>
* Do the same for the third CD :
<tt>~ $ cp -vf *.vp /usr/local/games/fs2_open</tt>
<tt>~ $ cp -vf *.MVE /usr/local/games/fs2_open/data/movies/</tt>

You may notice that some files are on all three CD. This is because the games was meant to be run from CD. Don't bother.

=== Fixing Case and permissions ===
* You '''have''' to make sure everything is lowercase :
<tt>~ $ find /usr/local/games/fs2_open/ | rename -v 'y/A-Z/a-z/'</tt>

* Then, fix permissions :
<tt>~ $ find /usr/local/games/fs2_open -type d -exec chmod a+rx '{}' \;</tt>
<tt>~ $ find /usr/local/games/fs2_open -type f -exec chmod a+r '{}' \;</tt>

===MediaVP and Cutscenes===
You'll also need the mediavp from the SCP if you want the enhanced graphics. Get them at http://scp.indiegames.us.
If you want the cutscenes, you'll have to find the avi version of the MVE files, or to convert them yourself. They are not hard to find. When you have them, just put them in the data/movies directory. Again, make sure everything is lowercase.

That's it for the game data files, now it's time get the source !

== Using the source ==

=== CVS Checkout ===
Before you begin, make sure you are situated in a a directory where you have write permissions. Your /home/user/ directory is pretty much a sure bet. I recommend that you create a permanent /home/user/src directory from which you run the CVS command, this way CVS will only update the files changed the next time you download the source and it's always nice to have things organized.

Now get the source. Run from a terminal:
$ cvs -d:pserver:anonymous:anonymous@warpcore.org:/home/fs2source/cvsroot login
and then
$ cvs -z3 -d:pserver:anonymous@warpcore.org:/home/fs2source/cvsroot co fs2_open
The first cvs command tells the CVS tool to first use a password file for authentication (pserver), that you are user "anonymous" with the password "anonymous" who wants to access warpcore.org's CVS repository "/home/fs2source/cvsroot" and login. The second command tells the CVS server on which we are now connected to that we want to checkout (co) the fs2_open module.
 
==== CVS Checkout and Update Script ====
The code on CVS is in a constant state of change, and bugs that exist one day may be gone the next. Because of this, you'll want to occasionally update to a newer version and recompile.
Running those cvs commands will fast grow to be a pain, so this little script was created to make your life easier. This script will checkout fs2_open if it can't find a fs2_open directory and update fs2_open, if it finds it.
The script will run until a successfull checkout or update has been achieved.
Copy and save this to a suitably named file like "get_fs2_open", and make it executable with the command, chmod +x <name of file>
#!/bin/bash
# CVS Checkout and Update Script for fs2_open
CVS_LINE="cvs -d:pserver:anonymous:anonymous@warpcore.org:/home/fs2source/cvsroot" # The cvs command
if [ "$UID" = 0 ]; then # check if user is root, and if so, echo a warning.
echo "You are root. If this is a checkout, all files \
will be created with root as the owner."
sleep 3
fi
if [ -e ./fs2_open ]; then # check if directory fs2_open exists
echo "Found fs2_open, We are updating an old checkout."
CVS_ATTEMPT=0 # This updates the checkout.
until [ $CVS_ATTEMPT = 1 ]; do
$CVS_LINE login && \
$CVS_LINE update fs2_open && \
let CVS_ATTEMPT=1
done
else
echo "No fs2_open found, This is a new checkout."
CVS_ATTEMPT=0 # This creates a new checkout.
until [ $CVS_ATTEMPT = 1 ]; do
$CVS_LINE login && \
$CVS_LINE co fs2_open && \
let CVS_ATTEMPT=1
done
fi

=== Pre-Compile Configuration ===

Before you compile you need to configure it for your system. In the directory you ran the CVS command from, a new directory has appear, namely fs2_open.
If your fs2_open is a completely new checkout, you will first need to run the autogen.sh script.
Run from inside your newly created fs2_open directory:
$ ./autogen.sh
autogen.sh is a script that will generate the required makefiles. You will see alot of "checking for this" and "checking for that", this is actually the "configure" script (which can be run with <tt>./configure</tt> if you need to change the options) examining and configuring fs2_open for your system. 
It is possible to give autogen.sh configure options as well, autogen.sh will pass them along to configure.

A full list of configure options can be found by running the configure script with the '--help' option.
$ ./configure --help

==== Optimizing fs2_open ====
Optimizing fs2_open might have little or no effect, or improve performance greatly, I honestly have no clue. 
A note of caution, if you are compiling a debug build, don't use the -fomit-frame-pointer CFLAG, it will make debugging impossible. 
You can specify your compiler flags with the configure script, se below.
$ ./configure CFLAGS="<your desired flags>"
If you got a Athlon-XP and want to play it safe, a good set of CFLAGS would be
$ ./configure CFLAGS="-march=athlon-xp -O3 -pipe -fomit-frame-pointer"
You should read up on CFLAGS and what they do before trying anything. I recommend you read through these links. 
http://gcc.gnu.org/onlinedocs/gcc-3.4.1/gcc/Optimize-Options.html 
http://linuxreviews.org/howtos/compiling/safe-cflags/ 
http://en.wikipedia.org/wiki/CFLAGS

=== Compiling ===

Run from within your fs2_open directory:
$ make
Sit back and enjoy gcc work its magic.

==== Simple Compile Script ====
It's alot easier to use a scripts when dealing with constantly changing code. Copy and save this to a suitably named file like "compile_fs2_open", and make it executable with the command, chmod +x <name of file>
This script assumes the CVS checkout directory fs2_open is pressent in the same directory as the script itself.
#!/bin/bash
# fs2_open Compile Script
# These are only examples, uncomment to enable optimization.
#MY_CFLAGS="-march=athlon-xp -O3 -pipe -fomit-frame-pointer -ftracer"
if [ -e ./fs2_open/ ]; then
cd fs2_open
if [ -e ./Makefile.in ]; then
make clean
./configure CFLAGS="$MY_CFLAGS" CXXFLAGS="$MY_CFLAGS"
make
else
./autogen.sh CFLAGS="$MY_CFLAGS" CXXFLAGS="$MY_CFLAGS"
make
fi
else
echo "No fs2_open directory found."
fi

You can add your options to the ./configure line.

== Using the Binaries ==

When the compile is done and if all went well, a binary executable will reside in the code directory ''fs2_open_r'' or ''fs2_open_d'' if you configured for a debug build. Copy the binary to directory where Freespace2 is installed, and you're all set to go.

=== Post-Compile Configuration ===
==== Changing Your Resolution ====
Odds are, you'll want to run fs2_open in a higher resolution than the default 640x480. Unfortunately, we Linux users don't have the swank launcher app that the Windows folks do. Instead, we'll be making a couple line changes to a config file. You will need to run fs2_open once before you can make the necessary changes, otherwise you won't have a configuration directory to work with.

Open up ~/.fs2_open/fs2_open.ini with the text editor of your choice (vi, EMACS, kwrite, gedit). You'll see something like the following:
[Default]
VideocardFs2open=OGL -(640x480)x16 bit
LastPlayer=MonkeyboyS
GammaD3D=1.0

To set fs2_open to use the highest setting possible on retail Freespace 2, change the VideocardFs2open to:
VideocardFs2open=OGL -(1024x768)x32 bit
You can set this to pretty much anything you want.

=== Creating a Start Up Script ===

In order to use all of the advanced engine features of fs2_open, you'll need to start the executable with a number of command line arguments. Instead of typing them in every time you want to start the game, why not create a script that does it for you?

Create a new file named start_freespace (or whatever you like) in your home directory. Open the file in your editor of choice, and paste the following:
#!/bin/bash
cd /path/to/your/freespace/
./fs2_open_r -spec -glow -mipmap -jpgtga -orbradar -mod Media_VP

''Note: You will need to edit this script before it will work properly. The second line must point to the directory where you installed fs2_open. You can also find a more elaborated script example below in the i18n section''

The last line starts fs2_open with a number of arguments that turn on extra features. In the example, the game will use specular highlights, glow-mapping, mipmapping, jpg and tga graphic files, the orb radar, and any MediaVPs installed to the /Media_VP directory. You should edit this line to use those features that your system supports.

More information about the available Command Line Arguments can be found at the [[Command-Line Reference]]

Once you've edited the file to your heart's content, make it executable:
$ chmod +x start_freespace

You can now type in start_freespace to start the game, or by clicking on start_freespace in your window manager. For convenience, you can copy it to your Desktop.

== Troubleshooting ==
=== Compile Errors ===
==== Missing -lGLU compile error ====

On some Linux distributions (''Slackware'' for instance), compiling fails because a GL related library doesn't have a link in the <tt>/usr/lib</tt> directory. If the compile fails because it can't find <tt>-lGLU</tt>, here are two ways to fix it:

===== Solution as Root =====

If you have root access to the system, you can create a link to the library in question with just a little bit of command line magic. Go to a console and enter:

$ ln -s /usr/X11R6/lib/libGLU.so /usr/lib/libGLU.so

After that, you can run make again and it should finish compiling.

===== Solution as a Non-Root user =====

You don't have root access? Never fear, we can still fix the problem. It'll just be a tad more difficult.

Navigate to the <tt>fs2_open/code</tt> directory and locate a file named <tt>Makefile</tt> (not Makefile.rm or Makefile.in or Makefile.anything). Open it in your favorite text editor and make the following changes.

Find this line (line 457 in mine):
FS2_LDFLAGS = -L/usr/lib -Wl,-rpath,/usr/lib -lSDL -lpthread -lGL -lGLU -lopenal -logg -lvorbis -lvorbisfile

And replace it with this:
FS2_LDFLAGS = -L/usr/lib -Wl,-rpath,/usr/lib -lSDL -lpthread -lGL -lopenal -logg -lvorbis -lvorbisfile -L/usr/X11R6/lib -lGLU

Also find this one (line 565 in mine):
AM_LDFLAGS = -g -L/usr/lib -Wl,-rpath,/usr/lib -lSDL -lpthread -lGL -lGLU -lopenal -logg -lvorbis -lvorbisfile

And replace it with this:
AM_LDFLAGS = -g -L/usr/lib -Wl,-rpath,/usr/lib -lSDL -lpthread -lGL -lopenal -logg -lvorbis -lvorbisfile -L/usr/X11R6/lib -lGLU

Then run <tt>make</tt> from the <tt>fs2_open</tt> directory, and watch the magic happen.

==== glBindBufferARB feature missing ====
''If this is the actual solution to this problem remains to be seen.'' 
''So far, only people using Debian stable are affected by this.'' 
''So we need adventurus Debian users to confirm.'' 
''I can confirm that the APT-Pinning works, can not confirm compile thou. -- ni1s'' 
checking for glBindBufferARB in -lGL... no
configure: error: *** OpenGL version does not have the required features!! (ie.glBindBufferARB()) ***
This error appears if the installed Mesa development library is to old.

On Debian stable branch the xlibmesa-gl-dev package holds version 4.3.0. 
The xlibmesa-gl-dev package on ''testning'' is version 6.9.0.

'''Possible solution:''' 
First set /etc/apt/sources.list to include the testing branch. Add:
#Testing
deb http://ftp.us.debian.org/debian testing main non-free contrib
deb http://non-us.debian.org/debian-non-US testing/non-US main contrib non-free
Your sources.list might have these lines already, if so, you should be okej.

Your /etc/apt/preferences file should look like this
Package: *
Pin: release a=stable
Pin-Priority: 700

Package: *
Pin: release a=testing
Pin-Priority: 650

Package: *
Pin: release a=unstable
Pin-Priority: 600

Add to that file:
Package: xlibmesa-gl-dev
Pin: release a=testing
Pin-Priority: 800
Note that the Pin-Priority of xlibmesa-gl-dev here is higher than the Pin-Priority on 'stable'. As a result of this APT get will prioritize the xlibmesa-gl-dev from testing and leave the rest of the system on stable.
This is called apt-pinning.

Now that APT knows what xlibmesa-gl-dev to prioritze, install it again:
$ apt-get install xlibmesa-gl-dev

If you are using nVidia's nvidia-kernel and glx packages, a simple:
$ apt-get install nvidia-glx-dev
should suffice. No need to mess around with APT-pinning.

=== Runtime Errors and common problems ===
==== ERROR: "Web cursor bitmap not found." ====
ERROR: "Web cursor bitmap not found. This usually means that the executable is being run outside the directory
you installed Freespace2 to. Please move the executable to that directory and try again" at graphics/2d.cpp:1402
A common error. This happens when fs2_open can't find the .vp files or that your user doesn't have the permissions to access them. If you are using a start up script([http://www.hard-light.net/wiki/index.php/Fs2_open_on_Linux#Creating_a_Start_Up_Script like the one found here]) it's most likly the a permission problem.
Have your user take owenership of the .vp files, run as root:
$ chown <user> /path/to/vpfiles/ -R

=== I18n and Key mapping problems ===
''Me, being a Swede, need to use this aswell, especially for the grave key(`), but I also want to use a second X display. There is a way to tell xmodmap to use the new set of keys on the second X display, and thus eliminating the need for a temp. keymap table as it dies with the second display when exiting fs2_open, never touching the keymap table on display 0. We should dig that info up and write a super-start script. --ni1s'' 
Ok, imagine that like me you don't have an us keyboard but a french one (or anything). Well, you probably have problems mapping some keys or even using the default mapping.

Actually, the problem is fs2_open does not take modifiers into account, as it uses them internally as modifiers for keys, and it won't accept non-us charset either.

On a french keyboard layout, the numbers ''1 2 3 4 5 6 7 8 9 0'' are on the same keys than on a US layout, but you have to press shift to use them. The primary function for theses keys are ''& Ã© " ' ( - Ã¨ _ Ã§ Ã )''. These characters won't be accepted by freespace, and if you press shift to get a number, it won't work. This can be a problem, as theses keys are needed to use the communication system, and cannot be bound to anything. Also, as you won't get access some keys on your keyboard, it will be difficult to map every command on a key, or you'll have to use modifiers for nearly each key.

However, there is a solution. You can tell X to remap the keyboard before launching the game, and restore your normal keymap afterwards.

For exemple, I map 123456790 to the &Ã©"'(-Ã¨_Ã§Ã keys so I can use the communication system, and I put , and ; on the Alt-Gr and Menu keys for convenience, as I binded thoses keys to next primary weapon and next secondary weapon.

To do this, I use a slightly enhanced startup script, which I put in ~/bin (this directory is in my path), together with a customized xmodmap.

* First, dump your current xmodmap :

<tt>~ $ xmodmap -pke > ~/xmodmap.current</tt>

* Then edit it with your favorite text editor. You'll see a bunch of lines looking like this :

<tt>
keycode 8 =
keycode 9 = Escape
keycode 10 = 1 ampersand onesuperior exclamdown onesuperior exclamdown
</tt>

The syntax is ''keycode <number> = <symbol list>''.

Use '''xev''' to scan the keycodes. The symbols are defined in ''/usr/include/X11/keysymdef.h''. Just make sure you write them without the ''XK_'' prefix. You'll find more information about xmodmap in the xmodmap manual page.

Just modify the keys you need, and be patient. This can be a long process. Test it with xmodmap :

<tt>~ $ xmodmap - < <filename></tt>

But don't forget to have your previous keymap at hand to recover your settings !
If you mess everything up, just restart X. Your default keymap will be applied from the X configuration.

Here is my own fs2 xmodmap, derived from fr-latin1 as described above. Feel free to use it if you're too lazy to modify your own. However, it may not fit with your needs. You may always use it as an exemple, thougt.
* http://clement.hermann.free.fr/fs2/xmodmap

Then, when the file is modified at your liking, just save it as '''~/.fs2_open/xmodmap'''

We'll start fs2_open with a slightly more elaborate startup script which will backup/apply/restore the keymap in addition of running the games with some options in the right directory.

<tt>
#!/bin/sh
# This script lauches fs2. If there is a file named $FS2_modmap (see below),
# backup the current modmap as $TMP_modmap and load it as the new modmap.
# The current modmap will be restored afterwards.

TMP_modmap="$HOME/xmodmap.tmp"
FS2_modmap="$HOME/.fs2_open/xmodmap"

FS2_OPEN_DIR=/usr/local/games/fs2_open

FS2_ARGS="-glow -spec -spec_exp 11 -spec_point 0.6 -spec_static 0.8 -spec_tube 0.4 -fps -jpgtga -ambient_factor 75 -targetinfo -nograb"

FS2_BIN="$FS2_OPEN_DIR/fs2_open_r"

die() {
echo "** Fatal error : $1" >&2
exit 1
}

cd $FS2_OPEN_DIR || die "Could not change directory to $FS2_OPEN_DIR"

# dump current xmodmap
[ -f "$FS2_modmap" ] && xmodmap -pke > $TMP_modmap

# load xmodmap
[ -f "$FS2_modmap" ] && xmodmap - < $FS2_modmap

# prepare to restore xmodmap on crash or exit
trap "xmodmap - < $TMP_modmap && rm $TMP_modmap" 0 2 3 4 9 11 15

# launch fs2
$FS2_BIN $FS2_ARGS $* || die "Error while running \"$FS2_BIN\" with arguments \"$FS2_ARGS\" ($?)"
</tt>

Adapt this script to your needs, and save it somewhere in your PATH - I for exemple usr ~/bin/freespace2. Make it executable with a chmod +x ''<file>''

That's it, now you can use fs2 with full control over your keyboard.

=== fs2_open freezes X ===
A good way of running games on Linux is having them run on a separate X display. The display you are most likely using now when reading this is 0:0. This display is normally used for whatever Window Manager/Desktop Environment(KDE,Gnome,*box,E) you've chosen. Sometimes fs2_open freezes and locks your X. This is of course very annoying as you have to CTRL+ALT+BACKSPACE to kill the X server, and in that, killing whatever program you had running besides fs2_open. The solution to this is to tell X to start fs2_open on another display. To to this we first need to tell X that you,the user on localhost, holds the permission to run on another display.
In a terminal, enter (NOT as root):
$ xauth list
A list that looks something like this should appear.
myuser@localhost ~ $ xauth list
localhost/unix:'''0''' MIT-MAGIC-COOKIE-1 14ec70e7c8cc835def61a04c92bbd50d
Let's look at that line, first up is your localhost, then unix, and last :0 (in bold). The rest is not really of interest.
Copy the whole line, but change the display value to 1 and paste it after the command ''xauth add'', like this:
$ xauth add localhost/unix:'''1''' MIT-MAGIC-COOKIE-1 14ec70e7c8cc835def61a04c92bbd50d
Run xauth list again. You should see a new entry.
myuser@localhost ~ $ xauth list
localhost/unix:'''0''' MIT-MAGIC-COOKIE-1 14ec70e7c8cc835def61a04c92bbd50d
localhost/unix:'''1''' MIT-MAGIC-COOKIE-1 14ec70e7c8cc835def61a04c92bbd50d
You now have permission to use display 1:0.
To start fs2_open in that display, use xinit.
$ xinit /path/to/fs2_open_r -foo -bar -- :1
The ''-- :1'' tells X that we want to start fs2_open on display 1. 
You can switch to display 0 and 1 with CTRL+ALT+F7 and CTRL+ALT+F8 respectively.

If you try this from an xterm (or a similar X terminal program) and obtain the error ''X: user not authorized to run the X server, aborting.'', the reason might be the file /etc/X11/Xwrapper.config. On my ubuntu machine, it contains the line

allowed_users=console

which means that only users logged in from a console terminal may start a new X server. However, on an xterm, you are on a '''virtual''' terminal and so the above does not work. A possibility is to change the allowed_users in the Xwrapper.config file to "anybody" (see man Xwrapper.config). However, this undermines X security. Another possibility is to start the xinit command from a console window (to which you can change with CTRL+ALT+F1-6).

''If someone knows of a good method to start fs2 on a second X display from an xterm without changing Xwrapper.config, please report it here.''

''A solution might be running xinit as root with sudo, and drop the root privileges in the startup script... Didn't tried, though.'' -- nodens

Guide to FS Open on Linux

2006-06-28T21:31:00Z

Nodens: note about the other startup script (people may want a better script but not having i18n concern)

''Note: This tutorial assumes some fundamental command line knowledge.''

== Installing CVS ==
CVS stands for Concurrent Versions System and is a version control system used to record the changes in documents, such as source files. Developers use CVS so they can easily share their code changes among other developers. You will need this tool to download ("checkout" in CVS terminology) fs2_open from the CVS server.

'''Debian/Ubuntu''' users want to:
$ apt-get install cvs
'''Gentoo''' users want to:
$ emerge cvs

'''NOTE: Redhat, Mandrake/Mandriva, Slackware and all the other distros should go here too,'''
'''but we have no knowledge on how these work, so if you do, please enlighten us.'''

== Installing the nessesary development libraries ==
You will also need SDL, OpenAL, libvorbis and OpenGL(most likely provided with your video card driver) development packages. And of course the GCC compiler and required make tools.
 
'''Debian/Ubuntu''' users want to:
$ apt-get install libopenal-dev libvorbis-dev build-essential automake1.9 autoconf libsdl-dev
'''NOTE:''' The ''build-essential'' meta package installs GCC4. This should work, but if you feel safer with GCC 3.4(gcc-3.4), add it to the apt-get line above. 
'''Gentoo''' users want to:
$ emerge openal libvorbis libsdl
'''NOTE: Radhat, Mandrake,Slackware and all the other distros should go here too,'''
'''but we have no knowlage on how these work, so if you do, please enlighten us.'''

== Installing game data files ==

This tutorial deals primarily with providing you with an executable, but in order to play the game you also need the game data. Freespace 2 game data is available from a number of sources, see this thread: http://www.hard-light.net/forums/index.php/topic,38195.0.html

Note that if you use the retail CD, you'll need to extract the files and copying them on your drive, reproducing the same layout as in a working win32 installation (just make sure every file is lowercase). This thread on the SCP forum has some more info on it : http://scp.indiegames.us/forum_viewtopic.php?3.282

There are two ways of doing this :
* use wine to install the game in the right directory, using the Setup.exe found on the first CD, or
* extract manually the files from the cd.

The second method is detailed below. The wine one is straightforward and you shouldn't need any specific instruction, but you'll have to fix permissions and lowercase the filename as well, so keep reading.

===Extracting data from CD===
====Installing unshield====

First, you need unshield from http://synce.sourceforge.net/synce/unshield.php

If you use debian, apt-get install unshield as root should do the trick. Else, try to find a package for your distribution, or if you don't, compile it yourself following the instructions provided on the website. Note you don't need to actually install it, just compile it and use it from the directory where you compiled it.

====Preparing directories====

* Create a directory for fs2_open, say, ''/usr/local/games/fs2_open'', with a ''data/movies'' and ''data/players'' subdirectories. Everything but user files and configuration will be in this directory.

<tt>~ $ mkdir -p /usr/local/games/fs2_open/data/movies /usr/local/games/fs2_open/data/players</tt>

====Extracting files====

* Use unshield to extract the groups from data1.cab (on the first cd) to a temporary directory; then move the files in your game directory :
<tt>~ $ mkdir /tmp/fs2</>
~ $ for group in "Basic Install Files" "Intel Anims" "Music Compressed" "High Res Files"; do unshield -d tmp/fs2/ -g "$group" -L -j x disk1/data1.cab && mv -v /tmp/fs2/*/* /home/data/jeux/fs2_open
~ $ unshield -d /usr/local/games/fs2_open/data/players -g "Hud Config Files" -L -j x data1.cab && mv -v /tmp/fs2/hud_config_files/"* /home/data/jeux/fs2_open/data/players</tt>

* From the second CD, get the vp files and the movies files (I dont think the the mve file are really needed, you'll need the avi ones if you want the movies).
<tt>~ $ cp -vf *.vp /usr/local/games/fs2_open</tt>
<tt>~ $ mkdir -p /usr/local/games/fs2_open/data/movies/ && cp -vf *.MVE /usr/local/games/fs2_open/data/movies/</tt>
* Do the same for the third CD :
<tt>~ $ cp -vf *.vp /usr/local/games/fs2_open</tt>
<tt>~ $ cp -vf *.MVE /usr/local/games/fs2_open/data/movies/</tt>

You may notice that some files are on all three CD. This is because the games was meant to be run from CD. Don't bother.

=== Fixing Case and permissions ===
* You '''have''' to make sure everything is lowercase :
<tt>~ $ find /usr/local/games/fs2_open/ | rename -v 'y/A-Z/a-z/'</tt>

* Then, fix permissions :
<tt>~ $ find /usr/local/games/fs2_open -type d -exec chmod a+rx '{}' \;</tt>
<tt>~ $ find /usr/local/games/fs2_open -type f -exec chmod a+r '{}' \;</tt>

===MediaVP and Cutscenes===
You'll also need the mediavp from the SCP if you want the enhanced graphics. Get them at http://scp.indiegames.us.
If you want the cutscenes, you'll have to find the avi version of the MVE files, or to convert them yourself. They are not hard to find. When you have them, just put them in the data/movies directory. Again, make sure everything is lowercase.

That's it for the game data files, now it's time get the source !

== Using the source ==

=== CVS Checkout ===
Before you begin, make sure you are situated in a a directory where you have write permissions. Your /home/user/ directory is pretty much a sure bet. I recommend that you create a permanent /home/user/src directory from which you run the CVS command, this way CVS will only update the files changed the next time you download the source and it's always nice to have things organized.

Now get the source. Run from a terminal:
$ cvs -d:pserver:anonymous:anonymous@warpcore.org:/home/fs2source/cvsroot login
and then
$ cvs -z3 -d:pserver:anonymous@warpcore.org:/home/fs2source/cvsroot co fs2_open
The first cvs command tells the CVS tool to first use a password file for authentication (pserver), that you are user "anonymous" with the password "anonymous" who wants to access warpcore.org's CVS repository "/home/fs2source/cvsroot" and login. The second command tells the CVS server on which we are now connected to that we want to checkout (co) the fs2_open module.
 
==== CVS Checkout and Update Script ====
The code on CVS is in a constant state of change, and bugs that exist one day may be gone the next. Because of this, you'll want to occasionally update to a newer version and recompile.
Running those cvs commands will fast grow to be a pain, so this little script was created to make your life easier. This script will checkout fs2_open if it can't find a fs2_open directory and update fs2_open, if it finds it.
The script will run until a successfull checkout or update has been achieved.
Copy and save this to a suitably named file like "get_fs2_open", and make it executable with the command, chmod +x <name of file>
#!/bin/bash
# CVS Checkout and Update Script for fs2_open
CVS_LINE="cvs -d:pserver:anonymous:anonymous@warpcore.org:/home/fs2source/cvsroot" # The cvs command
if [ "$UID" = 0 ]; then # check if user is root, and if so, echo a warning.
echo "You are root. If this is a checkout, all files \
will be created with root as the owner."
sleep 3
fi
if [ -e ./fs2_open ]; then # check if directory fs2_open exists
echo "Found fs2_open, We are updating an old checkout."
CVS_ATTEMPT=0 # This updates the checkout.
until [ $CVS_ATTEMPT = 1 ]; do
$CVS_LINE login && \
$CVS_LINE update fs2_open && \
let CVS_ATTEMPT=1
done
else
echo "No fs2_open found, This is a new checkout."
CVS_ATTEMPT=0 # This creates a new checkout.
until [ $CVS_ATTEMPT = 1 ]; do
$CVS_LINE login && \
$CVS_LINE co fs2_open && \
let CVS_ATTEMPT=1
done
fi

=== Pre-Compile Configuration ===

Before you compile you need to configure it for your system. In the directory you ran the CVS command from, a new directory has appear, namely fs2_open.
If your fs2_open is a completely new checkout, you will first need to run the autogen.sh script.
Run from inside your newly created fs2_open directory:
$ ./autogen.sh
autogen.sh is a script that will generate the required makefiles. You will see alot of "checking for this" and "checking for that", this is actually the "configure" script (which can be run with <tt>./configure</tt> if you need to change the options) examining and configuring fs2_open for your system. 
It is possible to give autogen.sh configure options as well, autogen.sh will pass them along to configure.

A full list of configure options can be found by running the configure script with the '--help' option.
$ ./configure --help

==== Optimizing fs2_open ====
Optimizing fs2_open might have little or no effect, or improve performance greatly, I honestly have no clue. 
A note of caution, if you are compiling a debug build, don't use the -fomit-frame-pointer CFLAG, it will make debugging impossible. 
You can specify your compiler flags with the configure script, se below.
$ ./configure CFLAGS="<your desired flags>"
If you got a Athlon-XP and want to play it safe, a good set of CFLAGS would be
$ ./configure CFLAGS="-march=athlon-xp -O3 -pipe -fomit-frame-pointer"
You should read up on CFLAGS and what they do before trying anything. I recommend you read through these links. 
http://gcc.gnu.org/onlinedocs/gcc-3.4.1/gcc/Optimize-Options.html 
http://linuxreviews.org/howtos/compiling/safe-cflags/ 
http://en.wikipedia.org/wiki/CFLAGS

=== Compiling ===

Run from within your fs2_open directory:
$ make
Sit back and enjoy gcc work its magic.

==== Simple Compile Script ====
It's alot easier to use a scripts when dealing with constantly changing code. Copy and save this to a suitably named file like "compile_fs2_open", and make it executable with the command, chmod +x <name of file>
This script assumes the CVS checkout directory fs2_open is pressent in the same directory as the script itself.
#!/bin/bash
# fs2_open Compile Script
# These are only examples, uncomment to enable optimization.
#MY_CFLAGS="-march=athlon-xp -O3 -pipe -fomit-frame-pointer -ftracer"
if [ -e ./fs2_open/ ]; then
cd fs2_open
if [ -e ./Makefile.in ]; then
make clean
./configure CFLAGS="$MY_CFLAGS" CXXFLAGS="$MY_CFLAGS"
make
else
./autogen.sh CFLAGS="$MY_CFLAGS" CXXFLAGS="$MY_CFLAGS"
make
fi
else
echo "No fs2_open directory found."
fi

You can add your options to the ./configure line.

== Using the Binaries ==

When the compile is done and if all went well, a binary executable will reside in the code directory ''fs2_open_r'' or ''fs2_open_d'' if you configured for a debug build. Copy the binary to directory where Freespace2 is installed, and you're all set to go.

=== Post-Compile Configuration ===
==== Changing Your Resolution ====
Odds are, you'll want to run fs2_open in a higher resolution than the default 640x480. Unfortunately, we Linux users don't have the swank launcher app that the Windows folks do. Instead, we'll be making a couple line changes to a config file. You will need to run fs2_open once before you can make the necessary changes, otherwise you won't have a configuration directory to work with.

Open up ~/.fs2_open/fs2_open.ini with the text editor of your choice (vi, EMACS, kwrite, gedit). You'll see something like the following:
[Default]
VideocardFs2open=OGL -(640x480)x16 bit
LastPlayer=MonkeyboyS
GammaD3D=1.0

To set fs2_open to use the highest setting possible on retail Freespace 2, change the VideocardFs2open to:
VideocardFs2open=OGL -(1024x768)x32 bit
You can set this to pretty much anything you want.

=== Creating a Start Up Script ===

In order to use all of the advanced engine features of fs2_open, you'll need to start the executable with a number of command line arguments. Instead of typing them in every time you want to start the game, why not create a script that does it for you?

Create a new file named start_freespace (or whatever you like) in your home directory. Open the file in your editor of choice, and paste the following:
#!/bin/bash
cd /path/to/your/freespace/
./fs2_open_r -spec -glow -mipmap -jpgtga -orbradar -mod Media_VP

''Note: You will need to edit this script before it will work properly. The second line must point to the directory where you installed fs2_open.''

''Note : You can find a more elaborated startup script example below in the i18n section''

The last line starts fs2_open with a number of arguments that turn on extra features. In the example, the game will use specular highlights, glow-mapping, mipmapping, jpg and tga graphic files, the orb radar, and any MediaVPs installed to the /Media_VP directory. You should edit this line to use those features that your system supports.

More information about the available Command Line Arguments can be found at the [[Command-Line Reference]]

Once you've edited the file to your heart's content, make it executable:
$ chmod +x start_freespace

You can now type in start_freespace to start the game, or by clicking on start_freespace in your window manager. For convenience, you can copy it to your Desktop.

== Troubleshooting ==
=== Compile Errors ===
==== Missing -lGLU compile error ====

On some Linux distributions (''Slackware'' for instance), compiling fails because a GL related library doesn't have a link in the <tt>/usr/lib</tt> directory. If the compile fails because it can't find <tt>-lGLU</tt>, here are two ways to fix it:

===== Solution as Root =====

If you have root access to the system, you can create a link to the library in question with just a little bit of command line magic. Go to a console and enter:

$ ln -s /usr/X11R6/lib/libGLU.so /usr/lib/libGLU.so

After that, you can run make again and it should finish compiling.

===== Solution as a Non-Root user =====

You don't have root access? Never fear, we can still fix the problem. It'll just be a tad more difficult.

Navigate to the <tt>fs2_open/code</tt> directory and locate a file named <tt>Makefile</tt> (not Makefile.rm or Makefile.in or Makefile.anything). Open it in your favorite text editor and make the following changes.

Find this line (line 457 in mine):
FS2_LDFLAGS = -L/usr/lib -Wl,-rpath,/usr/lib -lSDL -lpthread -lGL -lGLU -lopenal -logg -lvorbis -lvorbisfile

And replace it with this:
FS2_LDFLAGS = -L/usr/lib -Wl,-rpath,/usr/lib -lSDL -lpthread -lGL -lopenal -logg -lvorbis -lvorbisfile -L/usr/X11R6/lib -lGLU

Also find this one (line 565 in mine):
AM_LDFLAGS = -g -L/usr/lib -Wl,-rpath,/usr/lib -lSDL -lpthread -lGL -lGLU -lopenal -logg -lvorbis -lvorbisfile

And replace it with this:
AM_LDFLAGS = -g -L/usr/lib -Wl,-rpath,/usr/lib -lSDL -lpthread -lGL -lopenal -logg -lvorbis -lvorbisfile -L/usr/X11R6/lib -lGLU

Then run <tt>make</tt> from the <tt>fs2_open</tt> directory, and watch the magic happen.

==== glBindBufferARB feature missing ====
''If this is the actual solution to this problem remains to be seen.'' 
''So far, only people using Debian stable are affected by this.'' 
''So we need adventurus Debian users to confirm.'' 
''I can confirm that the APT-Pinning works, can not confirm compile thou. -- ni1s'' 
checking for glBindBufferARB in -lGL... no
configure: error: *** OpenGL version does not have the required features!! (ie.glBindBufferARB()) ***
This error appears if the installed Mesa development library is to old.

On Debian stable branch the xlibmesa-gl-dev package holds version 4.3.0. 
The xlibmesa-gl-dev package on ''testning'' is version 6.9.0.

'''Possible solution:''' 
First set /etc/apt/sources.list to include the testing branch. Add:
#Testing
deb http://ftp.us.debian.org/debian testing main non-free contrib
deb http://non-us.debian.org/debian-non-US testing/non-US main contrib non-free
Your sources.list might have these lines already, if so, you should be okej.

Your /etc/apt/preferences file should look like this
Package: *
Pin: release a=stable
Pin-Priority: 700

Package: *
Pin: release a=testing
Pin-Priority: 650

Package: *
Pin: release a=unstable
Pin-Priority: 600

Add to that file:
Package: xlibmesa-gl-dev
Pin: release a=testing
Pin-Priority: 800
Note that the Pin-Priority of xlibmesa-gl-dev here is higher than the Pin-Priority on 'stable'. As a result of this APT get will prioritize the xlibmesa-gl-dev from testing and leave the rest of the system on stable.
This is called apt-pinning.

Now that APT knows what xlibmesa-gl-dev to prioritze, install it again:
$ apt-get install xlibmesa-gl-dev

If you are using nVidia's nvidia-kernel and glx packages, a simple:
$ apt-get install nvidia-glx-dev
should suffice. No need to mess around with APT-pinning.

=== Runtime Errors ===
==== ERROR: "Web cursor bitmap not found." ====
ERROR: "Web cursor bitmap not found. This usually means that the executable is being run outside the directory
you installed Freespace2 to. Please move the executable to that directory and try again" at graphics/2d.cpp:1402
A common error. This happens when fs2_open can't find the .vp files or that your user doesn't have the permissions to access them. If you are using a start up script([http://www.hard-light.net/wiki/index.php/Fs2_open_on_Linux#Creating_a_Start_Up_Script like the one found here]) it's most likly the a permission problem.
Have your user take owenership of the .vp files, run as root:
$ chown <user> /path/to/vpfiles/ -R

=== I18n and Key mapping problems ===
''Me, being a Swede, need to use this aswell, especially for the grave key(`), but I also want to use a second X display. There is a way to tell xmodmap to use the new set of keys on the second X display, and thus eliminating the need for a temp. keymap table as it dies with the second display when exiting fs2_open, never touching the keymap table on display 0. We should dig that info up and write a super-start script. --ni1s'' 
Ok, imagine that like me you don't have an us keyboard but a french one (or anything). Well, you probably have problems mapping some keys or even using the default mapping.

Actually, the problem is fs2_open does not take modifiers into account, as it uses them internally as modifiers for keys, and it won't accept non-us charset either.

On a french keyboard layout, the numbers ''1 2 3 4 5 6 7 8 9 0'' are on the same keys than on a US layout, but you have to press shift to use them. The primary function for theses keys are ''& Ã© " ' ( - Ã¨ _ Ã§ Ã )''. These characters won't be accepted by freespace, and if you press shift to get a number, it won't work. This can be a problem, as theses keys are needed to use the communication system, and cannot be bound to anything. Also, as you won't get access some keys on your keyboard, it will be difficult to map every command on a key, or you'll have to use modifiers for nearly each key.

However, there is a solution. You can tell X to remap the keyboard before launching the game, and restore your normal keymap afterwards.

For exemple, I map 123456790 to the &Ã©"'(-Ã¨_Ã§Ã keys so I can use the communication system, and I put , and ; on the Alt-Gr and Menu keys for convenience, as I binded thoses keys to next primary weapon and next secondary weapon.

To do this, I use a slightly enhanced startup script, which I put in ~/bin (this directory is in my path), together with a customized xmodmap.

* First, dump your current xmodmap :

<tt>~ $ xmodmap -pke > ~/xmodmap.current</tt>

* Then edit it with your favorite text editor. You'll see a bunch of lines looking like this :

<tt>
keycode 8 =
keycode 9 = Escape
keycode 10 = 1 ampersand onesuperior exclamdown onesuperior exclamdown
</tt>

The syntax is ''keycode <number> = <symbol list>''.

Use '''xev''' to scan the keycodes. The symbols are defined in ''/usr/include/X11/keysymdef.h''. Just make sure you write them without the ''XK_'' prefix. You'll find more information about xmodmap in the xmodmap manual page.

Just modify the keys you need, and be patient. This can be a long process. Test it with xmodmap :

<tt>~ $ xmodmap - < <filename></tt>

But don't forget to have your previous keymap at hand to recover your settings !
If you mess everything up, just restart X. Your default keymap will be applied from the X configuration.

Here is my own fs2 xmodmap, derived from fr-latin1 as described above. Feel free to use it if you're too lazy to modify your own. However, it may not fit with your needs. You may always use it as an exemple, thougt.
* http://clement.hermann.free.fr/fs2/xmodmap

Then, when the file is modified at your liking, just save it as '''~/.fs2_open/xmodmap'''

We'll start fs2_open with a slightly more elaborate startup script which will backup/apply/restore the keymap in addition of running the games with some options in the right directory.

<tt>
#!/bin/sh
# This script lauches fs2. If there is a file named $FS2_modmap (see below),
# backup the current modmap as $TMP_modmap and load it as the new modmap.
# The current modmap will be restored afterwards.

TMP_modmap="$HOME/xmodmap.tmp"
FS2_modmap="$HOME/.fs2_open/xmodmap"

FS2_OPEN_DIR=/usr/local/games/fs2_open

FS2_ARGS="-glow -spec -spec_exp 11 -spec_point 0.6 -spec_static 0.8 -spec_tube 0.4 -fps -jpgtga -ambient_factor 75 -targetinfo -nograb"

FS2_BIN="$FS2_OPEN_DIR/fs2_open_r"

die() {
echo "** Fatal error : $1" >&2
exit 1
}

cd $FS2_OPEN_DIR || die "Could not change directory to $FS2_OPEN_DIR"

# dump current xmodmap
[ -f "$FS2_modmap" ] && xmodmap -pke > $TMP_modmap

# load xmodmap
[ -f "$FS2_modmap" ] && xmodmap - < $FS2_modmap

# prepare to restore xmodmap on crash or exit
trap "xmodmap - < $TMP_modmap && rm $TMP_modmap" 0 2 3 4 9 11 15

# launch fs2
$FS2_BIN $FS2_ARGS $* || die "Error while running \"$FS2_BIN\" with arguments \"$FS2_ARGS\" ($?)"
</tt>

Adapt this script to your needs, and save it somewhere in your PATH - I for exemple usr ~/bin/freespace2. Make it executable with a chmod +x ''<file>''

That's it, now you can use fs2 with full control over your keyboard.

=== fs2_open freezes X ===
A good way of running games on Linux is having them run on a separate X display. The display you are most likely using now when reading this is 0:0. This display is normally used for whatever Window Manager/Desktop Environment(KDE,Gnome,*box,E) you've chosen. Sometimes fs2_open freezes and locks your X. This is of course very annoying as you have to CTRL+ALT+BACKSPACE to kill the X server, and in that, killing whatever program you had running besides fs2_open. The solution to this is to tell X to start fs2_open on another display. To to this we first need to tell X that you,the user on localhost, holds the permission to run on another display.
In a terminal, enter (NOT as root):
$ xauth list
A list that looks something like this should appear.
myuser@localhost ~ $ xauth list
localhost/unix:'''0''' MIT-MAGIC-COOKIE-1 14ec70e7c8cc835def61a04c92bbd50d
Let's look at that line, first up is your localhost, then unix, and last :0 (in bold). The rest is not really of interest.
Copy the whole line, but change the display value to 1 and paste it after the command ''xauth add'', like this:
$ xauth add localhost/unix:'''1''' MIT-MAGIC-COOKIE-1 14ec70e7c8cc835def61a04c92bbd50d
Run xauth list again. You should see a new entry.
myuser@localhost ~ $ xauth list
localhost/unix:'''0''' MIT-MAGIC-COOKIE-1 14ec70e7c8cc835def61a04c92bbd50d
localhost/unix:'''1''' MIT-MAGIC-COOKIE-1 14ec70e7c8cc835def61a04c92bbd50d
You now have permission to use display 1:0.
To start fs2_open in that display, use xinit.
$ xinit /path/to/fs2_open_r -foo -bar -- :1
The ''-- :1'' tells X that we want to start fs2_open on display 1. 
You can switch to display 0 and 1 with CTRL+ALT+F7 and CTRL+ALT+F8 respectively.

If you try this from an xterm (or a similar X terminal program) and obtain the error ''X: user not authorized to run the X server, aborting.'', the reason might be the file /etc/X11/Xwrapper.config. On my ubuntu machine, it contains the line

allowed_users=console

which means that only users logged in from a console terminal may start a new X server. However, on an xterm, you are on a '''virtual''' terminal and so the above does not work. A possibility is to change the allowed_users in the Xwrapper.config file to "anybody" (see man Xwrapper.config). However, this undermines X security. Another possibility is to start the xinit command from a console window (to which you can change with CTRL+ALT+F1-6).

''If someone knows of a good method to start fs2 on a second X display from an xterm without changing Xwrapper.config, please report it here.''

''A solution might be running xinit as root with sudo, and drop the root privileges in the startup script... Didn't tried, though.'' -- nodens

Guide to FS Open on Linux

2006-06-28T21:27:28Z

Nodens: sentences are more easily understood with *all* the words ;)

''Note: This tutorial assumes some fundamental command line knowledge.''

== Installing CVS ==
CVS stands for Concurrent Versions System and is a version control system used to record the changes in documents, such as source files. Developers use CVS so they can easily share their code changes among other developers. You will need this tool to download ("checkout" in CVS terminology) fs2_open from the CVS server.

'''Debian/Ubuntu''' users want to:
$ apt-get install cvs
'''Gentoo''' users want to:
$ emerge cvs

'''NOTE: Redhat, Mandrake/Mandriva, Slackware and all the other distros should go here too,'''
'''but we have no knowledge on how these work, so if you do, please enlighten us.'''

== Installing the nessesary development libraries ==
You will also need SDL, OpenAL, libvorbis and OpenGL(most likely provided with your video card driver) development packages. And of course the GCC compiler and required make tools.
 
'''Debian/Ubuntu''' users want to:
$ apt-get install libopenal-dev libvorbis-dev build-essential automake1.9 autoconf libsdl-dev
'''NOTE:''' The ''build-essential'' meta package installs GCC4. This should work, but if you feel safer with GCC 3.4(gcc-3.4), add it to the apt-get line above. 
'''Gentoo''' users want to:
$ emerge openal libvorbis libsdl
'''NOTE: Radhat, Mandrake,Slackware and all the other distros should go here too,'''
'''but we have no knowlage on how these work, so if you do, please enlighten us.'''

== Installing game data files ==

This tutorial deals primarily with providing you with an executable, but in order to play the game you also need the game data. Freespace 2 game data is available from a number of sources, see this thread: http://www.hard-light.net/forums/index.php/topic,38195.0.html

Note that if you use the retail CD, you'll need to extract the files and copying them on your drive, reproducing the same layout as in a working win32 installation (just make sure every file is lowercase). This thread on the SCP forum has some more info on it : http://scp.indiegames.us/forum_viewtopic.php?3.282

There are two ways of doing this :
* use wine to install the game in the right directory, using the Setup.exe found on the first CD, or
* extract manually the files from the cd.

The second method is detailed below. The wine one is straightforward and you shouldn't need any specific instruction, but you'll have to fix permissions and lowercase the filename as well, so keep reading.

===Extracting data from CD===
====Installing unshield====

First, you need unshield from http://synce.sourceforge.net/synce/unshield.php

If you use debian, apt-get install unshield as root should do the trick. Else, try to find a package for your distribution, or if you don't, compile it yourself following the instructions provided on the website. Note you don't need to actually install it, just compile it and use it from the directory where you compiled it.

====Preparing directories====

* Create a directory for fs2_open, say, ''/usr/local/games/fs2_open'', with a ''data/movies'' and ''data/players'' subdirectories. Everything but user files and configuration will be in this directory.

<tt>~ $ mkdir -p /usr/local/games/fs2_open/data/movies /usr/local/games/fs2_open/data/players</tt>

====Extracting files====

* Use unshield to extract the groups from data1.cab (on the first cd) to a temporary directory; then move the files in your game directory :
<tt>~ $ mkdir /tmp/fs2</>
~ $ for group in "Basic Install Files" "Intel Anims" "Music Compressed" "High Res Files"; do unshield -d tmp/fs2/ -g "$group" -L -j x disk1/data1.cab && mv -v /tmp/fs2/*/* /home/data/jeux/fs2_open
~ $ unshield -d /usr/local/games/fs2_open/data/players -g "Hud Config Files" -L -j x data1.cab && mv -v /tmp/fs2/hud_config_files/"* /home/data/jeux/fs2_open/data/players</tt>

* From the second CD, get the vp files and the movies files (I dont think the the mve file are really needed, you'll need the avi ones if you want the movies).
<tt>~ $ cp -vf *.vp /usr/local/games/fs2_open</tt>
<tt>~ $ mkdir -p /usr/local/games/fs2_open/data/movies/ && cp -vf *.MVE /usr/local/games/fs2_open/data/movies/</tt>
* Do the same for the third CD :
<tt>~ $ cp -vf *.vp /usr/local/games/fs2_open</tt>
<tt>~ $ cp -vf *.MVE /usr/local/games/fs2_open/data/movies/</tt>

You may notice that some files are on all three CD. This is because the games was meant to be run from CD. Don't bother.

=== Fixing Case and permissions ===
* You '''have''' to make sure everything is lowercase :
<tt>~ $ find /usr/local/games/fs2_open/ | rename -v 'y/A-Z/a-z/'</tt>

* Then, fix permissions :
<tt>~ $ find /usr/local/games/fs2_open -type d -exec chmod a+rx '{}' \;</tt>
<tt>~ $ find /usr/local/games/fs2_open -type f -exec chmod a+r '{}' \;</tt>

===MediaVP and Cutscenes===
You'll also need the mediavp from the SCP if you want the enhanced graphics. Get them at http://scp.indiegames.us.
If you want the cutscenes, you'll have to find the avi version of the MVE files, or to convert them yourself. They are not hard to find. When you have them, just put them in the data/movies directory. Again, make sure everything is lowercase.

That's it for the game data files, now it's time get the source !

== Using the source ==

=== CVS Checkout ===
Before you begin, make sure you are situated in a a directory where you have write permissions. Your /home/user/ directory is pretty much a sure bet. I recommend that you create a permanent /home/user/src directory from which you run the CVS command, this way CVS will only update the files changed the next time you download the source and it's always nice to have things organized.

Now get the source. Run from a terminal:
$ cvs -d:pserver:anonymous:anonymous@warpcore.org:/home/fs2source/cvsroot login
and then
$ cvs -z3 -d:pserver:anonymous@warpcore.org:/home/fs2source/cvsroot co fs2_open
The first cvs command tells the CVS tool to first use a password file for authentication (pserver), that you are user "anonymous" with the password "anonymous" who wants to access warpcore.org's CVS repository "/home/fs2source/cvsroot" and login. The second command tells the CVS server on which we are now connected to that we want to checkout (co) the fs2_open module.
 
==== CVS Checkout and Update Script ====
The code on CVS is in a constant state of change, and bugs that exist one day may be gone the next. Because of this, you'll want to occasionally update to a newer version and recompile.
Running those cvs commands will fast grow to be a pain, so this little script was created to make your life easier. This script will checkout fs2_open if it can't find a fs2_open directory and update fs2_open, if it finds it.
The script will run until a successfull checkout or update has been achieved.
Copy and save this to a suitably named file like "get_fs2_open", and make it executable with the command, chmod +x <name of file>
#!/bin/bash
# CVS Checkout and Update Script for fs2_open
CVS_LINE="cvs -d:pserver:anonymous:anonymous@warpcore.org:/home/fs2source/cvsroot" # The cvs command
if [ "$UID" = 0 ]; then # check if user is root, and if so, echo a warning.
echo "You are root. If this is a checkout, all files \
will be created with root as the owner."
sleep 3
fi
if [ -e ./fs2_open ]; then # check if directory fs2_open exists
echo "Found fs2_open, We are updating an old checkout."
CVS_ATTEMPT=0 # This updates the checkout.
until [ $CVS_ATTEMPT = 1 ]; do
$CVS_LINE login && \
$CVS_LINE update fs2_open && \
let CVS_ATTEMPT=1
done
else
echo "No fs2_open found, This is a new checkout."
CVS_ATTEMPT=0 # This creates a new checkout.
until [ $CVS_ATTEMPT = 1 ]; do
$CVS_LINE login && \
$CVS_LINE co fs2_open && \
let CVS_ATTEMPT=1
done
fi

=== Pre-Compile Configuration ===

Before you compile you need to configure it for your system. In the directory you ran the CVS command from, a new directory has appear, namely fs2_open.
If your fs2_open is a completely new checkout, you will first need to run the autogen.sh script.
Run from inside your newly created fs2_open directory:
$ ./autogen.sh
autogen.sh is a script that will generate the required makefiles. You will see alot of "checking for this" and "checking for that", this is actually the "configure" script (which can be run with <tt>./configure</tt> if you need to change the options) examining and configuring fs2_open for your system. 
It is possible to give autogen.sh configure options as well, autogen.sh will pass them along to configure.

A full list of configure options can be found by running the configure script with the '--help' option.
$ ./configure --help

==== Optimizing fs2_open ====
Optimizing fs2_open might have little or no effect, or improve performance greatly, I honestly have no clue. 
A note of caution, if you are compiling a debug build, don't use the -fomit-frame-pointer CFLAG, it will make debugging impossible. 
You can specify your compiler flags with the configure script, se below.
$ ./configure CFLAGS="<your desired flags>"
If you got a Athlon-XP and want to play it safe, a good set of CFLAGS would be
$ ./configure CFLAGS="-march=athlon-xp -O3 -pipe -fomit-frame-pointer"
You should read up on CFLAGS and what they do before trying anything. I recommend you read through these links. 
http://gcc.gnu.org/onlinedocs/gcc-3.4.1/gcc/Optimize-Options.html 
http://linuxreviews.org/howtos/compiling/safe-cflags/ 
http://en.wikipedia.org/wiki/CFLAGS

=== Compiling ===

Run from within your fs2_open directory:
$ make
Sit back and enjoy gcc work its magic.

==== Simple Compile Script ====
It's alot easier to use a scripts when dealing with constantly changing code. Copy and save this to a suitably named file like "compile_fs2_open", and make it executable with the command, chmod +x <name of file>
This script assumes the CVS checkout directory fs2_open is pressent in the same directory as the script itself.
#!/bin/bash
# fs2_open Compile Script
# These are only examples, uncomment to enable optimization.
#MY_CFLAGS="-march=athlon-xp -O3 -pipe -fomit-frame-pointer -ftracer"
if [ -e ./fs2_open/ ]; then
cd fs2_open
if [ -e ./Makefile.in ]; then
make clean
./configure CFLAGS="$MY_CFLAGS" CXXFLAGS="$MY_CFLAGS"
make
else
./autogen.sh CFLAGS="$MY_CFLAGS" CXXFLAGS="$MY_CFLAGS"
make
fi
else
echo "No fs2_open directory found."
fi

You can add your options to the ./configure line.

== Using the Binaries ==

When the compile is done and if all went well, a binary executable will reside in the code directory ''fs2_open_r'' or ''fs2_open_d'' if you configured for a debug build. Copy the binary to directory where Freespace2 is installed, and you're all set to go.

=== Post-Compile Configuration ===
==== Changing Your Resolution ====
Odds are, you'll want to run fs2_open in a higher resolution than the default 640x480. Unfortunately, we Linux users don't have the swank launcher app that the Windows folks do. Instead, we'll be making a couple line changes to a config file. You will need to run fs2_open once before you can make the necessary changes, otherwise you won't have a configuration directory to work with.

Open up ~/.fs2_open/fs2_open.ini with the text editor of your choice (vi, EMACS, kwrite, gedit). You'll see something like the following:
[Default]
VideocardFs2open=OGL -(640x480)x16 bit
LastPlayer=MonkeyboyS
GammaD3D=1.0

To set fs2_open to use the highest setting possible on retail Freespace 2, change the VideocardFs2open to:
VideocardFs2open=OGL -(1024x768)x32 bit
You can set this to pretty much anything you want.

=== Creating a Start Up Script ===

In order to use all of the advanced engine features of fs2_open, you'll need to start the executable with a number of command line arguments. Instead of typing them in every time you want to start the game, why not create a script that does it for you?

Create a new file named start_freespace (or whatever you like) in your home directory. Open the file in your editor of choice, and paste the following:
#!/bin/bash
cd /path/to/your/freespace/
./fs2_open_r -spec -glow -mipmap -jpgtga -orbradar -mod Media_VP

''Note: You will need to edit this script before it will work properly. The second line must point to the directory where you installed fs2_open.''

The last line starts fs2_open with a number of arguments that turn on extra features. In the example, the game will use specular highlights, glow-mapping, mipmapping, jpg and tga graphic files, the orb radar, and any MediaVPs installed to the /Media_VP directory. You should edit this line to use those features that your system supports.

More information about the available Command Line Arguments can be found at the [[Command-Line Reference]]

Once you've edited the file to your heart's content, make it executable:
$ chmod +x start_freespace

You can now type in start_freespace to start the game, or by clicking on start_freespace in your window manager. For convenience, you can copy it to your Desktop.

== Troubleshooting ==
=== Compile Errors ===
==== Missing -lGLU compile error ====

On some Linux distributions (''Slackware'' for instance), compiling fails because a GL related library doesn't have a link in the <tt>/usr/lib</tt> directory. If the compile fails because it can't find <tt>-lGLU</tt>, here are two ways to fix it:

===== Solution as Root =====

If you have root access to the system, you can create a link to the library in question with just a little bit of command line magic. Go to a console and enter:

$ ln -s /usr/X11R6/lib/libGLU.so /usr/lib/libGLU.so

After that, you can run make again and it should finish compiling.

===== Solution as a Non-Root user =====

You don't have root access? Never fear, we can still fix the problem. It'll just be a tad more difficult.

Navigate to the <tt>fs2_open/code</tt> directory and locate a file named <tt>Makefile</tt> (not Makefile.rm or Makefile.in or Makefile.anything). Open it in your favorite text editor and make the following changes.

Find this line (line 457 in mine):
FS2_LDFLAGS = -L/usr/lib -Wl,-rpath,/usr/lib -lSDL -lpthread -lGL -lGLU -lopenal -logg -lvorbis -lvorbisfile

And replace it with this:
FS2_LDFLAGS = -L/usr/lib -Wl,-rpath,/usr/lib -lSDL -lpthread -lGL -lopenal -logg -lvorbis -lvorbisfile -L/usr/X11R6/lib -lGLU

Also find this one (line 565 in mine):
AM_LDFLAGS = -g -L/usr/lib -Wl,-rpath,/usr/lib -lSDL -lpthread -lGL -lGLU -lopenal -logg -lvorbis -lvorbisfile

And replace it with this:
AM_LDFLAGS = -g -L/usr/lib -Wl,-rpath,/usr/lib -lSDL -lpthread -lGL -lopenal -logg -lvorbis -lvorbisfile -L/usr/X11R6/lib -lGLU

Then run <tt>make</tt> from the <tt>fs2_open</tt> directory, and watch the magic happen.

==== glBindBufferARB feature missing ====
''If this is the actual solution to this problem remains to be seen.'' 
''So far, only people using Debian stable are affected by this.'' 
''So we need adventurus Debian users to confirm.'' 
''I can confirm that the APT-Pinning works, can not confirm compile thou. -- ni1s'' 
checking for glBindBufferARB in -lGL... no
configure: error: *** OpenGL version does not have the required features!! (ie.glBindBufferARB()) ***
This error appears if the installed Mesa development library is to old.

On Debian stable branch the xlibmesa-gl-dev package holds version 4.3.0. 
The xlibmesa-gl-dev package on ''testning'' is version 6.9.0.

'''Possible solution:''' 
First set /etc/apt/sources.list to include the testing branch. Add:
#Testing
deb http://ftp.us.debian.org/debian testing main non-free contrib
deb http://non-us.debian.org/debian-non-US testing/non-US main contrib non-free
Your sources.list might have these lines already, if so, you should be okej.

Your /etc/apt/preferences file should look like this
Package: *
Pin: release a=stable
Pin-Priority: 700

Package: *
Pin: release a=testing
Pin-Priority: 650

Package: *
Pin: release a=unstable
Pin-Priority: 600

Add to that file:
Package: xlibmesa-gl-dev
Pin: release a=testing
Pin-Priority: 800
Note that the Pin-Priority of xlibmesa-gl-dev here is higher than the Pin-Priority on 'stable'. As a result of this APT get will prioritize the xlibmesa-gl-dev from testing and leave the rest of the system on stable.
This is called apt-pinning.

Now that APT knows what xlibmesa-gl-dev to prioritze, install it again:
$ apt-get install xlibmesa-gl-dev

If you are using nVidia's nvidia-kernel and glx packages, a simple:
$ apt-get install nvidia-glx-dev
should suffice. No need to mess around with APT-pinning.

=== Runtime Errors ===
==== ERROR: "Web cursor bitmap not found." ====
ERROR: "Web cursor bitmap not found. This usually means that the executable is being run outside the directory
you installed Freespace2 to. Please move the executable to that directory and try again" at graphics/2d.cpp:1402
A common error. This happens when fs2_open can't find the .vp files or that your user doesn't have the permissions to access them. If you are using a start up script([http://www.hard-light.net/wiki/index.php/Fs2_open_on_Linux#Creating_a_Start_Up_Script like the one found here]) it's most likly the a permission problem.
Have your user take owenership of the .vp files, run as root:
$ chown <user> /path/to/vpfiles/ -R

=== I18n and Key mapping problems ===
''Me, being a Swede, need to use this aswell, especially for the grave key(`), but I also want to use a second X display. There is a way to tell xmodmap to use the new set of keys on the second X display, and thus eliminating the need for a temp. keymap table as it dies with the second display when exiting fs2_open, never touching the keymap table on display 0. We should dig that info up and write a super-start script. --ni1s'' 
Ok, imagine that like me you don't have an us keyboard but a french one (or anything). Well, you probably have problems mapping some keys or even using the default mapping.

Actually, the problem is fs2_open does not take modifiers into account, as it uses them internally as modifiers for keys, and it won't accept non-us charset either.

On a french keyboard layout, the numbers ''1 2 3 4 5 6 7 8 9 0'' are on the same keys than on a US layout, but you have to press shift to use them. The primary function for theses keys are ''& Ã© " ' ( - Ã¨ _ Ã§ Ã )''. These characters won't be accepted by freespace, and if you press shift to get a number, it won't work. This can be a problem, as theses keys are needed to use the communication system, and cannot be bound to anything. Also, as you won't get access some keys on your keyboard, it will be difficult to map every command on a key, or you'll have to use modifiers for nearly each key.

However, there is a solution. You can tell X to remap the keyboard before launching the game, and restore your normal keymap afterwards.

For exemple, I map 123456790 to the &Ã©"'(-Ã¨_Ã§Ã keys so I can use the communication system, and I put , and ; on the Alt-Gr and Menu keys for convenience, as I binded thoses keys to next primary weapon and next secondary weapon.

To do this, I use a slightly enhanced startup script, which I put in ~/bin (this directory is in my path), together with a customized xmodmap.

* First, dump your current xmodmap :

<tt>~ $ xmodmap -pke > ~/xmodmap.current</tt>

* Then edit it with your favorite text editor. You'll see a bunch of lines looking like this :

<tt>
keycode 8 =
keycode 9 = Escape
keycode 10 = 1 ampersand onesuperior exclamdown onesuperior exclamdown
</tt>

The syntax is ''keycode <number> = <symbol list>''.

Use '''xev''' to scan the keycodes. The symbols are defined in ''/usr/include/X11/keysymdef.h''. Just make sure you write them without the ''XK_'' prefix. You'll find more information about xmodmap in the xmodmap manual page.

Just modify the keys you need, and be patient. This can be a long process. Test it with xmodmap :

<tt>~ $ xmodmap - < <filename></tt>

But don't forget to have your previous keymap at hand to recover your settings !
If you mess everything up, just restart X. Your default keymap will be applied from the X configuration.

Here is my own fs2 xmodmap, derived from fr-latin1 as described above. Feel free to use it if you're too lazy to modify your own. However, it may not fit with your needs. You may always use it as an exemple, thougt.
* http://clement.hermann.free.fr/fs2/xmodmap

Then, when the file is modified at your liking, just save it as '''~/.fs2_open/xmodmap'''

We'll start fs2_open with a slightly more elaborate startup script which will backup/apply/restore the keymap in addition of running the games with some options in the right directory.

<tt>
#!/bin/sh
# This script lauches fs2. If there is a file named $FS2_modmap (see below),
# backup the current modmap as $TMP_modmap and load it as the new modmap.
# The current modmap will be restored afterwards.

TMP_modmap="$HOME/xmodmap.tmp"
FS2_modmap="$HOME/.fs2_open/xmodmap"

FS2_OPEN_DIR=/usr/local/games/fs2_open

FS2_ARGS="-glow -spec -spec_exp 11 -spec_point 0.6 -spec_static 0.8 -spec_tube 0.4 -fps -jpgtga -ambient_factor 75 -targetinfo -nograb"

FS2_BIN="$FS2_OPEN_DIR/fs2_open_r"

die() {
echo "** Fatal error : $1" >&2
exit 1
}

cd $FS2_OPEN_DIR || die "Could not change directory to $FS2_OPEN_DIR"

# dump current xmodmap
[ -f "$FS2_modmap" ] && xmodmap -pke > $TMP_modmap

# load xmodmap
[ -f "$FS2_modmap" ] && xmodmap - < $FS2_modmap

# prepare to restore xmodmap on crash or exit
trap "xmodmap - < $TMP_modmap && rm $TMP_modmap" 0 2 3 4 9 11 15

# launch fs2
$FS2_BIN $FS2_ARGS $* || die "Error while running \"$FS2_BIN\" with arguments \"$FS2_ARGS\" ($?)"
</tt>

Adapt this script to your needs, and save it somewhere in your PATH - I for exemple usr ~/bin/freespace2. Make it executable with a chmod +x ''<file>''

That's it, now you can use fs2 with full control over your keyboard.

=== fs2_open freezes X ===
A good way of running games on Linux is having them run on a separate X display. The display you are most likely using now when reading this is 0:0. This display is normally used for whatever Window Manager/Desktop Environment(KDE,Gnome,*box,E) you've chosen. Sometimes fs2_open freezes and locks your X. This is of course very annoying as you have to CTRL+ALT+BACKSPACE to kill the X server, and in that, killing whatever program you had running besides fs2_open. The solution to this is to tell X to start fs2_open on another display. To to this we first need to tell X that you,the user on localhost, holds the permission to run on another display.
In a terminal, enter (NOT as root):
$ xauth list
A list that looks something like this should appear.
myuser@localhost ~ $ xauth list
localhost/unix:'''0''' MIT-MAGIC-COOKIE-1 14ec70e7c8cc835def61a04c92bbd50d
Let's look at that line, first up is your localhost, then unix, and last :0 (in bold). The rest is not really of interest.
Copy the whole line, but change the display value to 1 and paste it after the command ''xauth add'', like this:
$ xauth add localhost/unix:'''1''' MIT-MAGIC-COOKIE-1 14ec70e7c8cc835def61a04c92bbd50d
Run xauth list again. You should see a new entry.
myuser@localhost ~ $ xauth list
localhost/unix:'''0''' MIT-MAGIC-COOKIE-1 14ec70e7c8cc835def61a04c92bbd50d
localhost/unix:'''1''' MIT-MAGIC-COOKIE-1 14ec70e7c8cc835def61a04c92bbd50d
You now have permission to use display 1:0.
To start fs2_open in that display, use xinit.
$ xinit /path/to/fs2_open_r -foo -bar -- :1
The ''-- :1'' tells X that we want to start fs2_open on display 1. 
You can switch to display 0 and 1 with CTRL+ALT+F7 and CTRL+ALT+F8 respectively.

If you try this from an xterm (or a similar X terminal program) and obtain the error ''X: user not authorized to run the X server, aborting.'', the reason might be the file /etc/X11/Xwrapper.config. On my ubuntu machine, it contains the line

allowed_users=console

which means that only users logged in from a console terminal may start a new X server. However, on an xterm, you are on a '''virtual''' terminal and so the above does not work. A possibility is to change the allowed_users in the Xwrapper.config file to "anybody" (see man Xwrapper.config). However, this undermines X security. Another possibility is to start the xinit command from a console window (to which you can change with CTRL+ALT+F1-6).

''If someone knows of a good method to start fs2 on a second X display from an xterm without changing Xwrapper.config, please report it here.''

''A solution might be running xinit as root with sudo, and drop the root privileges in the startup script... Didn't tried, though.'' -- nodens

Guide to FS Open on Linux

2006-06-28T21:26:26Z

Nodens: use sudo and drop priviliges ?

''Note: This tutorial assumes some fundamental command line knowledge.''

== Installing CVS ==
CVS stands for Concurrent Versions System and is a version control system used to record the changes in documents, such as source files. Developers use CVS so they can easily share their code changes among other developers. You will need this tool to download ("checkout" in CVS terminology) fs2_open from the CVS server.

'''Debian/Ubuntu''' users want to:
$ apt-get install cvs
'''Gentoo''' users want to:
$ emerge cvs

'''NOTE: Redhat, Mandrake/Mandriva, Slackware and all the other distros should go here too,'''
'''but we have no knowledge on how these work, so if you do, please enlighten us.'''

== Installing the nessesary development libraries ==
You will also need SDL, OpenAL, libvorbis and OpenGL(most likely provided with your video card driver) development packages. And of course the GCC compiler and required make tools.
 
'''Debian/Ubuntu''' users want to:
$ apt-get install libopenal-dev libvorbis-dev build-essential automake1.9 autoconf libsdl-dev
'''NOTE:''' The ''build-essential'' meta package installs GCC4. This should work, but if you feel safer with GCC 3.4(gcc-3.4), add it to the apt-get line above. 
'''Gentoo''' users want to:
$ emerge openal libvorbis libsdl
'''NOTE: Radhat, Mandrake,Slackware and all the other distros should go here too,'''
'''but we have no knowlage on how these work, so if you do, please enlighten us.'''

== Installing game data files ==

This tutorial deals primarily with providing you with an executable, but in order to play the game you also need the game data. Freespace 2 game data is available from a number of sources, see this thread: http://www.hard-light.net/forums/index.php/topic,38195.0.html

Note that if you use the retail CD, you'll need to extract the files and copying them on your drive, reproducing the same layout as in a working win32 installation (just make sure every file is lowercase). This thread on the SCP forum has some more info on it : http://scp.indiegames.us/forum_viewtopic.php?3.282

There are two ways of doing this :
* use wine to install the game in the right directory, using the Setup.exe found on the first CD, or
* extract manually the files from the cd.

The second method is detailed below. The wine one is straightforward and you shouldn't need any specific instruction, but you'll have to fix permissions and lowercase the filename as well, so keep reading.

===Extracting data from CD===
====Installing unshield====

First, you need unshield from http://synce.sourceforge.net/synce/unshield.php

If you use debian, apt-get install unshield as root should do the trick. Else, try to find a package for your distribution, or if you don't, compile it yourself following the instructions provided on the website. Note you don't need to actually install it, just compile it and use it from the directory where you compiled it.

====Preparing directories====

* Create a directory for fs2_open, say, ''/usr/local/games/fs2_open'', with a ''data/movies'' and ''data/players'' subdirectories. Everything but user files and configuration will be in this directory.

<tt>~ $ mkdir -p /usr/local/games/fs2_open/data/movies /usr/local/games/fs2_open/data/players</tt>

====Extracting files====

* Use unshield to extract the groups from data1.cab (on the first cd) to a temporary directory; then move the files in your game directory :
<tt>~ $ mkdir /tmp/fs2</>
~ $ for group in "Basic Install Files" "Intel Anims" "Music Compressed" "High Res Files"; do unshield -d tmp/fs2/ -g "$group" -L -j x disk1/data1.cab && mv -v /tmp/fs2/*/* /home/data/jeux/fs2_open
~ $ unshield -d /usr/local/games/fs2_open/data/players -g "Hud Config Files" -L -j x data1.cab && mv -v /tmp/fs2/hud_config_files/"* /home/data/jeux/fs2_open/data/players</tt>

* From the second CD, get the vp files and the movies files (I dont think the the mve file are really needed, you'll need the avi ones if you want the movies).
<tt>~ $ cp -vf *.vp /usr/local/games/fs2_open</tt>
<tt>~ $ mkdir -p /usr/local/games/fs2_open/data/movies/ && cp -vf *.MVE /usr/local/games/fs2_open/data/movies/</tt>
* Do the same for the third CD :
<tt>~ $ cp -vf *.vp /usr/local/games/fs2_open</tt>
<tt>~ $ cp -vf *.MVE /usr/local/games/fs2_open/data/movies/</tt>

You may notice that some files are on all three CD. This is because the games was meant to be run from CD. Don't bother.

=== Fixing Case and permissions ===
* You '''have''' to make sure everything is lowercase :
<tt>~ $ find /usr/local/games/fs2_open/ | rename -v 'y/A-Z/a-z/'</tt>

* Then, fix permissions :
<tt>~ $ find /usr/local/games/fs2_open -type d -exec chmod a+rx '{}' \;</tt>
<tt>~ $ find /usr/local/games/fs2_open -type f -exec chmod a+r '{}' \;</tt>

===MediaVP and Cutscenes===
You'll also need the mediavp from the SCP if you want the enhanced graphics. Get them at http://scp.indiegames.us.
If you want the cutscenes, you'll have to find the avi version of the MVE files, or to convert them yourself. They are not hard to find. When you have them, just put them in the data/movies directory. Again, make sure everything is lowercase.

That's it for the game data files, now it's time get the source !

== Using the source ==

=== CVS Checkout ===
Before you begin, make sure you are situated in a a directory where you have write permissions. Your /home/user/ directory is pretty much a sure bet. I recommend that you create a permanent /home/user/src directory from which you run the CVS command, this way CVS will only update the files changed the next time you download the source and it's always nice to have things organized.

Now get the source. Run from a terminal:
$ cvs -d:pserver:anonymous:anonymous@warpcore.org:/home/fs2source/cvsroot login
and then
$ cvs -z3 -d:pserver:anonymous@warpcore.org:/home/fs2source/cvsroot co fs2_open
The first cvs command tells the CVS tool to first use a password file for authentication (pserver), that you are user "anonymous" with the password "anonymous" who wants to access warpcore.org's CVS repository "/home/fs2source/cvsroot" and login. The second command tells the CVS server on which we are now connected to that we want to checkout (co) the fs2_open module.
 
==== CVS Checkout and Update Script ====
The code on CVS is in a constant state of change, and bugs that exist one day may be gone the next. Because of this, you'll want to occasionally update to a newer version and recompile.
Running those cvs commands will fast grow to be a pain, so this little script was created to make your life easier. This script will checkout fs2_open if it can't find a fs2_open directory and update fs2_open, if it finds it.
The script will run until a successfull checkout or update has been achieved.
Copy and save this to a suitably named file like "get_fs2_open", and make it executable with the command, chmod +x <name of file>
#!/bin/bash
# CVS Checkout and Update Script for fs2_open
CVS_LINE="cvs -d:pserver:anonymous:anonymous@warpcore.org:/home/fs2source/cvsroot" # The cvs command
if [ "$UID" = 0 ]; then # check if user is root, and if so, echo a warning.
echo "You are root. If this is a checkout, all files \
will be created with root as the owner."
sleep 3
fi
if [ -e ./fs2_open ]; then # check if directory fs2_open exists
echo "Found fs2_open, We are updating an old checkout."
CVS_ATTEMPT=0 # This updates the checkout.
until [ $CVS_ATTEMPT = 1 ]; do
$CVS_LINE login && \
$CVS_LINE update fs2_open && \
let CVS_ATTEMPT=1
done
else
echo "No fs2_open found, This is a new checkout."
CVS_ATTEMPT=0 # This creates a new checkout.
until [ $CVS_ATTEMPT = 1 ]; do
$CVS_LINE login && \
$CVS_LINE co fs2_open && \
let CVS_ATTEMPT=1
done
fi

=== Pre-Compile Configuration ===

Before you compile you need to configure it for your system. In the directory you ran the CVS command from, a new directory has appear, namely fs2_open.
If your fs2_open is a completely new checkout, you will first need to run the autogen.sh script.
Run from inside your newly created fs2_open directory:
$ ./autogen.sh
autogen.sh is a script that will generate the required makefiles. You will see alot of "checking for this" and "checking for that", this is actually the "configure" script (which can be run with <tt>./configure</tt> if you need to change the options) examining and configuring fs2_open for your system. 
It is possible to give autogen.sh configure options as well, autogen.sh will pass them along to configure.

A full list of configure options can be found by running the configure script with the '--help' option.
$ ./configure --help

==== Optimizing fs2_open ====
Optimizing fs2_open might have little or no effect, or improve performance greatly, I honestly have no clue. 
A note of caution, if you are compiling a debug build, don't use the -fomit-frame-pointer CFLAG, it will make debugging impossible. 
You can specify your compiler flags with the configure script, se below.
$ ./configure CFLAGS="<your desired flags>"
If you got a Athlon-XP and want to play it safe, a good set of CFLAGS would be
$ ./configure CFLAGS="-march=athlon-xp -O3 -pipe -fomit-frame-pointer"
You should read up on CFLAGS and what they do before trying anything. I recommend you read through these links. 
http://gcc.gnu.org/onlinedocs/gcc-3.4.1/gcc/Optimize-Options.html 
http://linuxreviews.org/howtos/compiling/safe-cflags/ 
http://en.wikipedia.org/wiki/CFLAGS

=== Compiling ===

Run from within your fs2_open directory:
$ make
Sit back and enjoy gcc work its magic.

==== Simple Compile Script ====
It's alot easier to use a scripts when dealing with constantly changing code. Copy and save this to a suitably named file like "compile_fs2_open", and make it executable with the command, chmod +x <name of file>
This script assumes the CVS checkout directory fs2_open is pressent in the same directory as the script itself.
#!/bin/bash
# fs2_open Compile Script
# These are only examples, uncomment to enable optimization.
#MY_CFLAGS="-march=athlon-xp -O3 -pipe -fomit-frame-pointer -ftracer"
if [ -e ./fs2_open/ ]; then
cd fs2_open
if [ -e ./Makefile.in ]; then
make clean
./configure CFLAGS="$MY_CFLAGS" CXXFLAGS="$MY_CFLAGS"
make
else
./autogen.sh CFLAGS="$MY_CFLAGS" CXXFLAGS="$MY_CFLAGS"
make
fi
else
echo "No fs2_open directory found."
fi

You can add your options to the ./configure line.

== Using the Binaries ==

When the compile is done and if all went well, a binary executable will reside in the code directory ''fs2_open_r'' or ''fs2_open_d'' if you configured for a debug build. Copy the binary to directory where Freespace2 is installed, and you're all set to go.

=== Post-Compile Configuration ===
==== Changing Your Resolution ====
Odds are, you'll want to run fs2_open in a higher resolution than the default 640x480. Unfortunately, we Linux users don't have the swank launcher app that the Windows folks do. Instead, we'll be making a couple line changes to a config file. You will need to run fs2_open once before you can make the necessary changes, otherwise you won't have a configuration directory to work with.

Open up ~/.fs2_open/fs2_open.ini with the text editor of your choice (vi, EMACS, kwrite, gedit). You'll see something like the following:
[Default]
VideocardFs2open=OGL -(640x480)x16 bit
LastPlayer=MonkeyboyS
GammaD3D=1.0

To set fs2_open to use the highest setting possible on retail Freespace 2, change the VideocardFs2open to:
VideocardFs2open=OGL -(1024x768)x32 bit
You can set this to pretty much anything you want.

=== Creating a Start Up Script ===

In order to use all of the advanced engine features of fs2_open, you'll need to start the executable with a number of command line arguments. Instead of typing them in every time you want to start the game, why not create a script that does it for you?

Create a new file named start_freespace (or whatever you like) in your home directory. Open the file in your editor of choice, and paste the following:
#!/bin/bash
cd /path/to/your/freespace/
./fs2_open_r -spec -glow -mipmap -jpgtga -orbradar -mod Media_VP

''Note: You will need to edit this script before it will work properly. The second line must point to the directory where you installed fs2_open.''

The last line starts fs2_open with a number of arguments that turn on extra features. In the example, the game will use specular highlights, glow-mapping, mipmapping, jpg and tga graphic files, the orb radar, and any MediaVPs installed to the /Media_VP directory. You should edit this line to use those features that your system supports.

More information about the available Command Line Arguments can be found at the [[Command-Line Reference]]

Once you've edited the file to your heart's content, make it executable:
$ chmod +x start_freespace

You can now type in start_freespace to start the game, or by clicking on start_freespace in your window manager. For convenience, you can copy it to your Desktop.

== Troubleshooting ==
=== Compile Errors ===
==== Missing -lGLU compile error ====

On some Linux distributions (''Slackware'' for instance), compiling fails because a GL related library doesn't have a link in the <tt>/usr/lib</tt> directory. If the compile fails because it can't find <tt>-lGLU</tt>, here are two ways to fix it:

===== Solution as Root =====

If you have root access to the system, you can create a link to the library in question with just a little bit of command line magic. Go to a console and enter:

$ ln -s /usr/X11R6/lib/libGLU.so /usr/lib/libGLU.so

After that, you can run make again and it should finish compiling.

===== Solution as a Non-Root user =====

You don't have root access? Never fear, we can still fix the problem. It'll just be a tad more difficult.

Navigate to the <tt>fs2_open/code</tt> directory and locate a file named <tt>Makefile</tt> (not Makefile.rm or Makefile.in or Makefile.anything). Open it in your favorite text editor and make the following changes.

Find this line (line 457 in mine):
FS2_LDFLAGS = -L/usr/lib -Wl,-rpath,/usr/lib -lSDL -lpthread -lGL -lGLU -lopenal -logg -lvorbis -lvorbisfile

And replace it with this:
FS2_LDFLAGS = -L/usr/lib -Wl,-rpath,/usr/lib -lSDL -lpthread -lGL -lopenal -logg -lvorbis -lvorbisfile -L/usr/X11R6/lib -lGLU

Also find this one (line 565 in mine):
AM_LDFLAGS = -g -L/usr/lib -Wl,-rpath,/usr/lib -lSDL -lpthread -lGL -lGLU -lopenal -logg -lvorbis -lvorbisfile

And replace it with this:
AM_LDFLAGS = -g -L/usr/lib -Wl,-rpath,/usr/lib -lSDL -lpthread -lGL -lopenal -logg -lvorbis -lvorbisfile -L/usr/X11R6/lib -lGLU

Then run <tt>make</tt> from the <tt>fs2_open</tt> directory, and watch the magic happen.

==== glBindBufferARB feature missing ====
''If this is the actual solution to this problem remains to be seen.'' 
''So far, only people using Debian stable are affected by this.'' 
''So we need adventurus Debian users to confirm.'' 
''I can confirm that the APT-Pinning works, can not confirm compile thou. -- ni1s'' 
checking for glBindBufferARB in -lGL... no
configure: error: *** OpenGL version does not have the required features!! (ie.glBindBufferARB()) ***
This error appears if the installed Mesa development library is to old.

On Debian stable branch the xlibmesa-gl-dev package holds version 4.3.0. 
The xlibmesa-gl-dev package on ''testning'' is version 6.9.0.

'''Possible solution:''' 
First set /etc/apt/sources.list to include the testing branch. Add:
#Testing
deb http://ftp.us.debian.org/debian testing main non-free contrib
deb http://non-us.debian.org/debian-non-US testing/non-US main contrib non-free
Your sources.list might have these lines already, if so, you should be okej.

Your /etc/apt/preferences file should look like this
Package: *
Pin: release a=stable
Pin-Priority: 700

Package: *
Pin: release a=testing
Pin-Priority: 650

Package: *
Pin: release a=unstable
Pin-Priority: 600

Add to that file:
Package: xlibmesa-gl-dev
Pin: release a=testing
Pin-Priority: 800
Note that the Pin-Priority of xlibmesa-gl-dev here is higher than the Pin-Priority on 'stable'. As a result of this APT get will prioritize the xlibmesa-gl-dev from testing and leave the rest of the system on stable.
This is called apt-pinning.

Now that APT knows what xlibmesa-gl-dev to prioritze, install it again:
$ apt-get install xlibmesa-gl-dev

If you are using nVidia's nvidia-kernel and glx packages, a simple:
$ apt-get install nvidia-glx-dev
should suffice. No need to mess around with APT-pinning.

=== Runtime Errors ===
==== ERROR: "Web cursor bitmap not found." ====
ERROR: "Web cursor bitmap not found. This usually means that the executable is being run outside the directory
you installed Freespace2 to. Please move the executable to that directory and try again" at graphics/2d.cpp:1402
A common error. This happens when fs2_open can't find the .vp files or that your user doesn't have the permissions to access them. If you are using a start up script([http://www.hard-light.net/wiki/index.php/Fs2_open_on_Linux#Creating_a_Start_Up_Script like the one found here]) it's most likly the a permission problem.
Have your user take owenership of the .vp files, run as root:
$ chown <user> /path/to/vpfiles/ -R

=== I18n and Key mapping problems ===
''Me, being a Swede, need to use this aswell, especially for the grave key(`), but I also want to use a second X display. There is a way to tell xmodmap to use the new set of keys on the second X display, and thus eliminating the need for a temp. keymap table as it dies with the second display when exiting fs2_open, never touching the keymap table on display 0. We should dig that info up and write a super-start script. --ni1s'' 
Ok, imagine that like me you don't have an us keyboard but a french one (or anything). Well, you probably have problems mapping some keys or even using the default mapping.

Actually, the problem is fs2_open does not take modifiers into account, as it uses them internally as modifiers for keys, and it won't accept non-us charset either.

On a french keyboard layout, the numbers ''1 2 3 4 5 6 7 8 9 0'' are on the same keys than on a US layout, but you have to press shift to use them. The primary function for theses keys are ''& Ã© " ' ( - Ã¨ _ Ã§ Ã )''. These characters won't be accepted by freespace, and if you press shift to get a number, it won't work. This can be a problem, as theses keys are needed to use the communication system, and cannot be bound to anything. Also, as you won't get access some keys on your keyboard, it will be difficult to map every command on a key, or you'll have to use modifiers for nearly each key.

However, there is a solution. You can tell X to remap the keyboard before launching the game, and restore your normal keymap afterwards.

For exemple, I map 123456790 to the &Ã©"'(-Ã¨_Ã§Ã keys so I can use the communication system, and I put , and ; on the Alt-Gr and Menu keys for convenience, as I binded thoses keys to next primary weapon and next secondary weapon.

To do this, I use a slightly enhanced startup script, which I put in ~/bin (this directory is in my path), together with a customized xmodmap.

* First, dump your current xmodmap :

<tt>~ $ xmodmap -pke > ~/xmodmap.current</tt>

* Then edit it with your favorite text editor. You'll see a bunch of lines looking like this :

<tt>
keycode 8 =
keycode 9 = Escape
keycode 10 = 1 ampersand onesuperior exclamdown onesuperior exclamdown
</tt>

The syntax is ''keycode <number> = <symbol list>''.

Use '''xev''' to scan the keycodes. The symbols are defined in ''/usr/include/X11/keysymdef.h''. Just make sure you write them without the ''XK_'' prefix. You'll find more information about xmodmap in the xmodmap manual page.

Just modify the keys you need, and be patient. This can be a long process. Test it with xmodmap :

<tt>~ $ xmodmap - < <filename></tt>

But don't forget to have your previous keymap at hand to recover your settings !
If you mess everything up, just restart X. Your default keymap will be applied from the X configuration.

Here is my own fs2 xmodmap, derived from fr-latin1 as described above. Feel free to use it if you're too lazy to modify your own. However, it may not fit with your needs. You may always use it as an exemple, thougt.
* http://clement.hermann.free.fr/fs2/xmodmap

Then, when the file is modified at your liking, just save it as '''~/.fs2_open/xmodmap'''

We'll start fs2_open with a slightly more elaborate startup script which will backup/apply/restore the keymap in addition of running the games with some options in the right directory.

<tt>
#!/bin/sh
# This script lauches fs2. If there is a file named $FS2_modmap (see below),
# backup the current modmap as $TMP_modmap and load it as the new modmap.
# The current modmap will be restored afterwards.

TMP_modmap="$HOME/xmodmap.tmp"
FS2_modmap="$HOME/.fs2_open/xmodmap"

FS2_OPEN_DIR=/usr/local/games/fs2_open

FS2_ARGS="-glow -spec -spec_exp 11 -spec_point 0.6 -spec_static 0.8 -spec_tube 0.4 -fps -jpgtga -ambient_factor 75 -targetinfo -nograb"

FS2_BIN="$FS2_OPEN_DIR/fs2_open_r"

die() {
echo "** Fatal error : $1" >&2
exit 1
}

cd $FS2_OPEN_DIR || die "Could not change directory to $FS2_OPEN_DIR"

# dump current xmodmap
[ -f "$FS2_modmap" ] && xmodmap -pke > $TMP_modmap

# load xmodmap
[ -f "$FS2_modmap" ] && xmodmap - < $FS2_modmap

# prepare to restore xmodmap on crash or exit
trap "xmodmap - < $TMP_modmap && rm $TMP_modmap" 0 2 3 4 9 11 15

# launch fs2
$FS2_BIN $FS2_ARGS $* || die "Error while running \"$FS2_BIN\" with arguments \"$FS2_ARGS\" ($?)"
</tt>

Adapt this script to your needs, and save it somewhere in your PATH - I for exemple usr ~/bin/freespace2. Make it executable with a chmod +x ''<file>''

That's it, now you can use fs2 with full control over your keyboard.

=== fs2_open freezes X ===
A good way of running games on Linux is having them run on a separate X display. The display you are most likely using now when reading this is 0:0. This display is normally used for whatever Window Manager/Desktop Environment(KDE,Gnome,*box,E) you've chosen. Sometimes fs2_open freezes and locks your X. This is of course very annoying as you have to CTRL+ALT+BACKSPACE to kill the X server, and in that, killing whatever program you had running besides fs2_open. The solution to this is to tell X to start fs2_open on another display. To to this we first need to tell X that you,the user on localhost, holds the permission to run on another display.
In a terminal, enter (NOT as root):
$ xauth list
A list that looks something like this should appear.
myuser@localhost ~ $ xauth list
localhost/unix:'''0''' MIT-MAGIC-COOKIE-1 14ec70e7c8cc835def61a04c92bbd50d
Let's look at that line, first up is your localhost, then unix, and last :0 (in bold). The rest is not really of interest.
Copy the whole line, but change the display value to 1 and paste it after the command ''xauth add'', like this:
$ xauth add localhost/unix:'''1''' MIT-MAGIC-COOKIE-1 14ec70e7c8cc835def61a04c92bbd50d
Run xauth list again. You should see a new entry.
myuser@localhost ~ $ xauth list
localhost/unix:'''0''' MIT-MAGIC-COOKIE-1 14ec70e7c8cc835def61a04c92bbd50d
localhost/unix:'''1''' MIT-MAGIC-COOKIE-1 14ec70e7c8cc835def61a04c92bbd50d
You now have permission to use display 1:0.
To start fs2_open in that display, use xinit.
$ xinit /path/to/fs2_open_r -foo -bar -- :1
The ''-- :1'' tells X that we want to start fs2_open on display 1. 
You can switch to display 0 and 1 with CTRL+ALT+F7 and CTRL+ALT+F8 respectively.

If you try this from an xterm (or a similar X terminal program) and obtain the error ''X: user not authorized to run the X server, aborting.'', the reason might be the file /etc/X11/Xwrapper.config. On my ubuntu machine, it contains the line

allowed_users=console

which means that only users logged in from a console terminal may start a new X server. However, on an xterm, you are on a '''virtual''' terminal and so the above does not work. A possibility is to change the allowed_users in the Xwrapper.config file to "anybody" (see man Xwrapper.config). However, this undermines X security. Another possibility is to start the xinit command from a console window (to which you can change with CTRL+ALT+F1-6).

''If someone knows of a good method to start fs2 on a second X display from an xterm without changing Xwrapper.config, please report it here.''

''A solution might be running xinit as with sudo, and drop the root privileges in the startup script... Didn't tried, though.'' -- nodens

Guide to FS Open on Linux

2006-06-28T21:22:34Z

Nodens: slightly improved startup script so that the xmodmap is restored on crash, error or interrupt

''Note: This tutorial assumes some fundamental command line knowledge.''

== Installing CVS ==
CVS stands for Concurrent Versions System and is a version control system used to record the changes in documents, such as source files. Developers use CVS so they can easily share their code changes among other developers. You will need this tool to download ("checkout" in CVS terminology) fs2_open from the CVS server.

'''Debian/Ubuntu''' users want to:
$ apt-get install cvs
'''Gentoo''' users want to:
$ emerge cvs

'''NOTE: Redhat, Mandrake/Mandriva, Slackware and all the other distros should go here too,'''
'''but we have no knowledge on how these work, so if you do, please enlighten us.'''

== Installing the nessesary development libraries ==
You will also need SDL, OpenAL, libvorbis and OpenGL(most likely provided with your video card driver) development packages. And of course the GCC compiler and required make tools.
 
'''Debian/Ubuntu''' users want to:
$ apt-get install libopenal-dev libvorbis-dev build-essential automake1.9 autoconf libsdl-dev
'''NOTE:''' The ''build-essential'' meta package installs GCC4. This should work, but if you feel safer with GCC 3.4(gcc-3.4), add it to the apt-get line above. 
'''Gentoo''' users want to:
$ emerge openal libvorbis libsdl
'''NOTE: Radhat, Mandrake,Slackware and all the other distros should go here too,'''
'''but we have no knowlage on how these work, so if you do, please enlighten us.'''

== Installing game data files ==

This tutorial deals primarily with providing you with an executable, but in order to play the game you also need the game data. Freespace 2 game data is available from a number of sources, see this thread: http://www.hard-light.net/forums/index.php/topic,38195.0.html

Note that if you use the retail CD, you'll need to extract the files and copying them on your drive, reproducing the same layout as in a working win32 installation (just make sure every file is lowercase). This thread on the SCP forum has some more info on it : http://scp.indiegames.us/forum_viewtopic.php?3.282

There are two ways of doing this :
* use wine to install the game in the right directory, using the Setup.exe found on the first CD, or
* extract manually the files from the cd.

The second method is detailed below. The wine one is straightforward and you shouldn't need any specific instruction, but you'll have to fix permissions and lowercase the filename as well, so keep reading.

===Extracting data from CD===
====Installing unshield====

First, you need unshield from http://synce.sourceforge.net/synce/unshield.php

If you use debian, apt-get install unshield as root should do the trick. Else, try to find a package for your distribution, or if you don't, compile it yourself following the instructions provided on the website. Note you don't need to actually install it, just compile it and use it from the directory where you compiled it.

====Preparing directories====

* Create a directory for fs2_open, say, ''/usr/local/games/fs2_open'', with a ''data/movies'' and ''data/players'' subdirectories. Everything but user files and configuration will be in this directory.

<tt>~ $ mkdir -p /usr/local/games/fs2_open/data/movies /usr/local/games/fs2_open/data/players</tt>

====Extracting files====

* Use unshield to extract the groups from data1.cab (on the first cd) to a temporary directory; then move the files in your game directory :
<tt>~ $ mkdir /tmp/fs2</>
~ $ for group in "Basic Install Files" "Intel Anims" "Music Compressed" "High Res Files"; do unshield -d tmp/fs2/ -g "$group" -L -j x disk1/data1.cab && mv -v /tmp/fs2/*/* /home/data/jeux/fs2_open
~ $ unshield -d /usr/local/games/fs2_open/data/players -g "Hud Config Files" -L -j x data1.cab && mv -v /tmp/fs2/hud_config_files/"* /home/data/jeux/fs2_open/data/players</tt>

* From the second CD, get the vp files and the movies files (I dont think the the mve file are really needed, you'll need the avi ones if you want the movies).
<tt>~ $ cp -vf *.vp /usr/local/games/fs2_open</tt>
<tt>~ $ mkdir -p /usr/local/games/fs2_open/data/movies/ && cp -vf *.MVE /usr/local/games/fs2_open/data/movies/</tt>
* Do the same for the third CD :
<tt>~ $ cp -vf *.vp /usr/local/games/fs2_open</tt>
<tt>~ $ cp -vf *.MVE /usr/local/games/fs2_open/data/movies/</tt>

You may notice that some files are on all three CD. This is because the games was meant to be run from CD. Don't bother.

=== Fixing Case and permissions ===
* You '''have''' to make sure everything is lowercase :
<tt>~ $ find /usr/local/games/fs2_open/ | rename -v 'y/A-Z/a-z/'</tt>

* Then, fix permissions :
<tt>~ $ find /usr/local/games/fs2_open -type d -exec chmod a+rx '{}' \;</tt>
<tt>~ $ find /usr/local/games/fs2_open -type f -exec chmod a+r '{}' \;</tt>

===MediaVP and Cutscenes===
You'll also need the mediavp from the SCP if you want the enhanced graphics. Get them at http://scp.indiegames.us.
If you want the cutscenes, you'll have to find the avi version of the MVE files, or to convert them yourself. They are not hard to find. When you have them, just put them in the data/movies directory. Again, make sure everything is lowercase.

That's it for the game data files, now it's time get the source !

== Using the source ==

=== CVS Checkout ===
Before you begin, make sure you are situated in a a directory where you have write permissions. Your /home/user/ directory is pretty much a sure bet. I recommend that you create a permanent /home/user/src directory from which you run the CVS command, this way CVS will only update the files changed the next time you download the source and it's always nice to have things organized.

Now get the source. Run from a terminal:
$ cvs -d:pserver:anonymous:anonymous@warpcore.org:/home/fs2source/cvsroot login
and then
$ cvs -z3 -d:pserver:anonymous@warpcore.org:/home/fs2source/cvsroot co fs2_open
The first cvs command tells the CVS tool to first use a password file for authentication (pserver), that you are user "anonymous" with the password "anonymous" who wants to access warpcore.org's CVS repository "/home/fs2source/cvsroot" and login. The second command tells the CVS server on which we are now connected to that we want to checkout (co) the fs2_open module.
 
==== CVS Checkout and Update Script ====
The code on CVS is in a constant state of change, and bugs that exist one day may be gone the next. Because of this, you'll want to occasionally update to a newer version and recompile.
Running those cvs commands will fast grow to be a pain, so this little script was created to make your life easier. This script will checkout fs2_open if it can't find a fs2_open directory and update fs2_open, if it finds it.
The script will run until a successfull checkout or update has been achieved.
Copy and save this to a suitably named file like "get_fs2_open", and make it executable with the command, chmod +x <name of file>
#!/bin/bash
# CVS Checkout and Update Script for fs2_open
CVS_LINE="cvs -d:pserver:anonymous:anonymous@warpcore.org:/home/fs2source/cvsroot" # The cvs command
if [ "$UID" = 0 ]; then # check if user is root, and if so, echo a warning.
echo "You are root. If this is a checkout, all files \
will be created with root as the owner."
sleep 3
fi
if [ -e ./fs2_open ]; then # check if directory fs2_open exists
echo "Found fs2_open, We are updating an old checkout."
CVS_ATTEMPT=0 # This updates the checkout.
until [ $CVS_ATTEMPT = 1 ]; do
$CVS_LINE login && \
$CVS_LINE update fs2_open && \
let CVS_ATTEMPT=1
done
else
echo "No fs2_open found, This is a new checkout."
CVS_ATTEMPT=0 # This creates a new checkout.
until [ $CVS_ATTEMPT = 1 ]; do
$CVS_LINE login && \
$CVS_LINE co fs2_open && \
let CVS_ATTEMPT=1
done
fi

=== Pre-Compile Configuration ===

Before you compile you need to configure it for your system. In the directory you ran the CVS command from, a new directory has appear, namely fs2_open.
If your fs2_open is a completely new checkout, you will first need to run the autogen.sh script.
Run from inside your newly created fs2_open directory:
$ ./autogen.sh
autogen.sh is a script that will generate the required makefiles. You will see alot of "checking for this" and "checking for that", this is actually the "configure" script (which can be run with <tt>./configure</tt> if you need to change the options) examining and configuring fs2_open for your system. 
It is possible to give autogen.sh configure options as well, autogen.sh will pass them along to configure.

A full list of configure options can be found by running the configure script with the '--help' option.
$ ./configure --help

==== Optimizing fs2_open ====
Optimizing fs2_open might have little or no effect, or improve performance greatly, I honestly have no clue. 
A note of caution, if you are compiling a debug build, don't use the -fomit-frame-pointer CFLAG, it will make debugging impossible. 
You can specify your compiler flags with the configure script, se below.
$ ./configure CFLAGS="<your desired flags>"
If you got a Athlon-XP and want to play it safe, a good set of CFLAGS would be
$ ./configure CFLAGS="-march=athlon-xp -O3 -pipe -fomit-frame-pointer"
You should read up on CFLAGS and what they do before trying anything. I recommend you read through these links. 
http://gcc.gnu.org/onlinedocs/gcc-3.4.1/gcc/Optimize-Options.html 
http://linuxreviews.org/howtos/compiling/safe-cflags/ 
http://en.wikipedia.org/wiki/CFLAGS

=== Compiling ===

Run from within your fs2_open directory:
$ make
Sit back and enjoy gcc work its magic.

==== Simple Compile Script ====
It's alot easier to use a scripts when dealing with constantly changing code. Copy and save this to a suitably named file like "compile_fs2_open", and make it executable with the command, chmod +x <name of file>
This script assumes the CVS checkout directory fs2_open is pressent in the same directory as the script itself.
#!/bin/bash
# fs2_open Compile Script
# These are only examples, uncomment to enable optimization.
#MY_CFLAGS="-march=athlon-xp -O3 -pipe -fomit-frame-pointer -ftracer"
if [ -e ./fs2_open/ ]; then
cd fs2_open
if [ -e ./Makefile.in ]; then
make clean
./configure CFLAGS="$MY_CFLAGS" CXXFLAGS="$MY_CFLAGS"
make
else
./autogen.sh CFLAGS="$MY_CFLAGS" CXXFLAGS="$MY_CFLAGS"
make
fi
else
echo "No fs2_open directory found."
fi

You can add your options to the ./configure line.

== Using the Binaries ==

When the compile is done and if all went well, a binary executable will reside in the code directory ''fs2_open_r'' or ''fs2_open_d'' if you configured for a debug build. Copy the binary to directory where Freespace2 is installed, and you're all set to go.

=== Post-Compile Configuration ===
==== Changing Your Resolution ====
Odds are, you'll want to run fs2_open in a higher resolution than the default 640x480. Unfortunately, we Linux users don't have the swank launcher app that the Windows folks do. Instead, we'll be making a couple line changes to a config file. You will need to run fs2_open once before you can make the necessary changes, otherwise you won't have a configuration directory to work with.

Open up ~/.fs2_open/fs2_open.ini with the text editor of your choice (vi, EMACS, kwrite, gedit). You'll see something like the following:
[Default]
VideocardFs2open=OGL -(640x480)x16 bit
LastPlayer=MonkeyboyS
GammaD3D=1.0

To set fs2_open to use the highest setting possible on retail Freespace 2, change the VideocardFs2open to:
VideocardFs2open=OGL -(1024x768)x32 bit
You can set this to pretty much anything you want.

=== Creating a Start Up Script ===

In order to use all of the advanced engine features of fs2_open, you'll need to start the executable with a number of command line arguments. Instead of typing them in every time you want to start the game, why not create a script that does it for you?

Create a new file named start_freespace (or whatever you like) in your home directory. Open the file in your editor of choice, and paste the following:
#!/bin/bash
cd /path/to/your/freespace/
./fs2_open_r -spec -glow -mipmap -jpgtga -orbradar -mod Media_VP

''Note: You will need to edit this script before it will work properly. The second line must point to the directory where you installed fs2_open.''

The last line starts fs2_open with a number of arguments that turn on extra features. In the example, the game will use specular highlights, glow-mapping, mipmapping, jpg and tga graphic files, the orb radar, and any MediaVPs installed to the /Media_VP directory. You should edit this line to use those features that your system supports.

More information about the available Command Line Arguments can be found at the [[Command-Line Reference]]

Once you've edited the file to your heart's content, make it executable:
$ chmod +x start_freespace

You can now type in start_freespace to start the game, or by clicking on start_freespace in your window manager. For convenience, you can copy it to your Desktop.

== Troubleshooting ==
=== Compile Errors ===
==== Missing -lGLU compile error ====

On some Linux distributions (''Slackware'' for instance), compiling fails because a GL related library doesn't have a link in the <tt>/usr/lib</tt> directory. If the compile fails because it can't find <tt>-lGLU</tt>, here are two ways to fix it:

===== Solution as Root =====

If you have root access to the system, you can create a link to the library in question with just a little bit of command line magic. Go to a console and enter:

$ ln -s /usr/X11R6/lib/libGLU.so /usr/lib/libGLU.so

After that, you can run make again and it should finish compiling.

===== Solution as a Non-Root user =====

You don't have root access? Never fear, we can still fix the problem. It'll just be a tad more difficult.

Navigate to the <tt>fs2_open/code</tt> directory and locate a file named <tt>Makefile</tt> (not Makefile.rm or Makefile.in or Makefile.anything). Open it in your favorite text editor and make the following changes.

Find this line (line 457 in mine):
FS2_LDFLAGS = -L/usr/lib -Wl,-rpath,/usr/lib -lSDL -lpthread -lGL -lGLU -lopenal -logg -lvorbis -lvorbisfile

And replace it with this:
FS2_LDFLAGS = -L/usr/lib -Wl,-rpath,/usr/lib -lSDL -lpthread -lGL -lopenal -logg -lvorbis -lvorbisfile -L/usr/X11R6/lib -lGLU

Also find this one (line 565 in mine):
AM_LDFLAGS = -g -L/usr/lib -Wl,-rpath,/usr/lib -lSDL -lpthread -lGL -lGLU -lopenal -logg -lvorbis -lvorbisfile

And replace it with this:
AM_LDFLAGS = -g -L/usr/lib -Wl,-rpath,/usr/lib -lSDL -lpthread -lGL -lopenal -logg -lvorbis -lvorbisfile -L/usr/X11R6/lib -lGLU

Then run <tt>make</tt> from the <tt>fs2_open</tt> directory, and watch the magic happen.

==== glBindBufferARB feature missing ====
''If this is the actual solution to this problem remains to be seen.'' 
''So far, only people using Debian stable are affected by this.'' 
''So we need adventurus Debian users to confirm.'' 
''I can confirm that the APT-Pinning works, can not confirm compile thou. -- ni1s'' 
checking for glBindBufferARB in -lGL... no
configure: error: *** OpenGL version does not have the required features!! (ie.glBindBufferARB()) ***
This error appears if the installed Mesa development library is to old.

On Debian stable branch the xlibmesa-gl-dev package holds version 4.3.0. 
The xlibmesa-gl-dev package on ''testning'' is version 6.9.0.

'''Possible solution:''' 
First set /etc/apt/sources.list to include the testing branch. Add:
#Testing
deb http://ftp.us.debian.org/debian testing main non-free contrib
deb http://non-us.debian.org/debian-non-US testing/non-US main contrib non-free
Your sources.list might have these lines already, if so, you should be okej.

Your /etc/apt/preferences file should look like this
Package: *
Pin: release a=stable
Pin-Priority: 700

Package: *
Pin: release a=testing
Pin-Priority: 650

Package: *
Pin: release a=unstable
Pin-Priority: 600

Add to that file:
Package: xlibmesa-gl-dev
Pin: release a=testing
Pin-Priority: 800
Note that the Pin-Priority of xlibmesa-gl-dev here is higher than the Pin-Priority on 'stable'. As a result of this APT get will prioritize the xlibmesa-gl-dev from testing and leave the rest of the system on stable.
This is called apt-pinning.

Now that APT knows what xlibmesa-gl-dev to prioritze, install it again:
$ apt-get install xlibmesa-gl-dev

If you are using nVidia's nvidia-kernel and glx packages, a simple:
$ apt-get install nvidia-glx-dev
should suffice. No need to mess around with APT-pinning.

=== Runtime Errors ===
==== ERROR: "Web cursor bitmap not found." ====
ERROR: "Web cursor bitmap not found. This usually means that the executable is being run outside the directory
you installed Freespace2 to. Please move the executable to that directory and try again" at graphics/2d.cpp:1402
A common error. This happens when fs2_open can't find the .vp files or that your user doesn't have the permissions to access them. If you are using a start up script([http://www.hard-light.net/wiki/index.php/Fs2_open_on_Linux#Creating_a_Start_Up_Script like the one found here]) it's most likly the a permission problem.
Have your user take owenership of the .vp files, run as root:
$ chown <user> /path/to/vpfiles/ -R

=== I18n and Key mapping problems ===
''Me, being a Swede, need to use this aswell, especially for the grave key(`), but I also want to use a second X display. There is a way to tell xmodmap to use the new set of keys on the second X display, and thus eliminating the need for a temp. keymap table as it dies with the second display when exiting fs2_open, never touching the keymap table on display 0. We should dig that info up and write a super-start script. --ni1s'' 
Ok, imagine that like me you don't have an us keyboard but a french one (or anything). Well, you probably have problems mapping some keys or even using the default mapping.

Actually, the problem is fs2_open does not take modifiers into account, as it uses them internally as modifiers for keys, and it won't accept non-us charset either.

On a french keyboard layout, the numbers ''1 2 3 4 5 6 7 8 9 0'' are on the same keys than on a US layout, but you have to press shift to use them. The primary function for theses keys are ''& Ã© " ' ( - Ã¨ _ Ã§ Ã )''. These characters won't be accepted by freespace, and if you press shift to get a number, it won't work. This can be a problem, as theses keys are needed to use the communication system, and cannot be bound to anything. Also, as you won't get access some keys on your keyboard, it will be difficult to map every command on a key, or you'll have to use modifiers for nearly each key.

However, there is a solution. You can tell X to remap the keyboard before launching the game, and restore your normal keymap afterwards.

For exemple, I map 123456790 to the &Ã©"'(-Ã¨_Ã§Ã keys so I can use the communication system, and I put , and ; on the Alt-Gr and Menu keys for convenience, as I binded thoses keys to next primary weapon and next secondary weapon.

To do this, I use a slightly enhanced startup script, which I put in ~/bin (this directory is in my path), together with a customized xmodmap.

* First, dump your current xmodmap :

<tt>~ $ xmodmap -pke > ~/xmodmap.current</tt>

* Then edit it with your favorite text editor. You'll see a bunch of lines looking like this :

<tt>
keycode 8 =
keycode 9 = Escape
keycode 10 = 1 ampersand onesuperior exclamdown onesuperior exclamdown
</tt>

The syntax is ''keycode <number> = <symbol list>''.

Use '''xev''' to scan the keycodes. The symbols are defined in ''/usr/include/X11/keysymdef.h''. Just make sure you write them without the ''XK_'' prefix. You'll find more information about xmodmap in the xmodmap manual page.

Just modify the keys you need, and be patient. This can be a long process. Test it with xmodmap :

<tt>~ $ xmodmap - < <filename></tt>

But don't forget to have your previous keymap at hand to recover your settings !
If you mess everything up, just restart X. Your default keymap will be applied from the X configuration.

Here is my own fs2 xmodmap, derived from fr-latin1 as described above. Feel free to use it if you're too lazy to modify your own. However, it may not fit with your needs. You may always use it as an exemple, thougt.
* http://clement.hermann.free.fr/fs2/xmodmap

Then, when the file is modified at your liking, just save it as '''~/.fs2_open/xmodmap'''

We'll start fs2_open with a slightly more elaborate startup script which will backup/apply/restore the keymap in addition of running the games with some options in the right directory.

<tt>
#!/bin/sh
# This script lauches fs2. If there is a file named $FS2_modmap (see below),
# backup the current modmap as $TMP_modmap and load it as the new modmap.
# The current modmap will be restored afterwards.

TMP_modmap="$HOME/xmodmap.tmp"
FS2_modmap="$HOME/.fs2_open/xmodmap"

FS2_OPEN_DIR=/usr/local/games/fs2_open

FS2_ARGS="-glow -spec -spec_exp 11 -spec_point 0.6 -spec_static 0.8 -spec_tube 0.4 -fps -jpgtga -ambient_factor 75 -targetinfo -nograb"

FS2_BIN="$FS2_OPEN_DIR/fs2_open_r"

die() {
echo "** Fatal error : $1" >&2
exit 1
}

cd $FS2_OPEN_DIR || die "Could not change directory to $FS2_OPEN_DIR"

# dump current xmodmap
[ -f "$FS2_modmap" ] && xmodmap -pke > $TMP_modmap

# load xmodmap
[ -f "$FS2_modmap" ] && xmodmap - < $FS2_modmap

# prepare to restore xmodmap on crash or exit
trap "xmodmap - < $TMP_modmap && rm $TMP_modmap" 0 2 3 4 9 11 15

# launch fs2
$FS2_BIN $FS2_ARGS $* || die "Error while running \"$FS2_BIN\" with arguments \"$FS2_ARGS\" ($?)"
</tt>

Adapt this script to your needs, and save it somewhere in your PATH - I for exemple usr ~/bin/freespace2. Make it executable with a chmod +x ''<file>''

That's it, now you can use fs2 with full control over your keyboard.

=== fs2_open freezes X ===
A good way of running games on Linux is having them run on a separate X display. The display you are most likely using now when reading this is 0:0. This display is normally used for whatever Window Manager/Desktop Environment(KDE,Gnome,*box,E) you've chosen. Sometimes fs2_open freezes and locks your X. This is of course very annoying as you have to CTRL+ALT+BACKSPACE to kill the X server, and in that, killing whatever program you had running besides fs2_open. The solution to this is to tell X to start fs2_open on another display. To to this we first need to tell X that you,the user on localhost, holds the permission to run on another display.
In a terminal, enter (NOT as root):
$ xauth list
A list that looks something like this should appear.
myuser@localhost ~ $ xauth list
localhost/unix:'''0''' MIT-MAGIC-COOKIE-1 14ec70e7c8cc835def61a04c92bbd50d
Let's look at that line, first up is your localhost, then unix, and last :0 (in bold). The rest is not really of interest.
Copy the whole line, but change the display value to 1 and paste it after the command ''xauth add'', like this:
$ xauth add localhost/unix:'''1''' MIT-MAGIC-COOKIE-1 14ec70e7c8cc835def61a04c92bbd50d
Run xauth list again. You should see a new entry.
myuser@localhost ~ $ xauth list
localhost/unix:'''0''' MIT-MAGIC-COOKIE-1 14ec70e7c8cc835def61a04c92bbd50d
localhost/unix:'''1''' MIT-MAGIC-COOKIE-1 14ec70e7c8cc835def61a04c92bbd50d
You now have permission to use display 1:0.
To start fs2_open in that display, use xinit.
$ xinit /path/to/fs2_open_r -foo -bar -- :1
The ''-- :1'' tells X that we want to start fs2_open on display 1. 
You can switch to display 0 and 1 with CTRL+ALT+F7 and CTRL+ALT+F8 respectively.

If you try this from an xterm (or a similar X terminal program) and obtain the error ''X: user not authorized to run the X server, aborting.'', the reason might be the file /etc/X11/Xwrapper.config. On my ubuntu machine, it contains the line

allowed_users=console

which means that only users logged in from a console terminal may start a new X server. However, on an xterm, you are on a '''virtual''' terminal and so the above does not work. A possibility is to change the allowed_users in the Xwrapper.config file to "anybody" (see man Xwrapper.config). However, this undermines X security. Another possibility is to start the xinit command from a console window (to which you can change with CTRL+ALT+F1-6).

''If someone knows of a good method to start fs2 on a second X display from an xterm without changing Xwrapper.config, please report it here.''

Guide to FS Open on Linux

2006-04-17T12:15:00Z

Nodens: added a link to my own xmodmap

''Note: This tutorial assumes some fundamental command line knowledge.''

== Installing CVS ==
CVS stands for Concurrent Versions System and is a version control system used to record the changes in documents, such as source files. Developers use CVS so they can easily share their code changes among other developers. You will need this tool to download ("checkout" in CVS terminology) fs2_open from the CVS server.

'''Debian/Ubuntu''' users want to:
apt-get install cvs
'''Gentoo''' users want to:
emerge cvs

'''NOTE: Redhat, Mandrake/Mandriva, Slackware and all the other distros should go here too,'''
'''but we have no knowledge on how these work, so if you do, please enlighten us.'''

== Installing the nessesary development libraries ==
You will also need SDL, OpenAL, libvorbis and OpenGL(most likely provided with your video card driver) development packages. And of course the GCC compiler and required make tools.
 
'''Debian/Ubuntu''' users want to:
apt-get install libopenal-dev libvorbis-dev build-essential automake1.9 autoconf libsdl-dev
'''NOTE:''' The ''build-essential'' meta package installs GCC4. This should work, but if you feel safer with GCC 3.4(gcc-3.4), add it to the apt-get line above. 
'''Gentoo''' users want to:
emerge openal libvorbis libsdl
'''NOTE: Radhat, Mandrake,Slackware and all the other distros should go here too,'''
'''but we have no knowlage on how these work, so if you do, please enlighten us.'''

== Installing game data files ==

This tutorial deals primarily with providing you with an executable, but in order to play the game you also need the game data. Freespace 2 game data is available from a number of sources, see this thread: http://www.hard-light.net/forums/index.php/topic,38195.0.html

Note that if you use the retail CD, you'll need to extract the files and copying them on your drive, reproducing the same layout as in a working win32 installation (just make sure every file is lowercase). This thread on the SCP forum has some more info on it : http://scp.indiegames.us/forum_viewtopic.php?3.282

There are two ways of doing this :
* use wine to install the game in the right directory, using the Setup.exe found on the first CD, or
* extract manually the files from the cd.

The second method is detailed below. The wine one is straightforward and you shouldn't need any specific instruction, but you'll have to fix permissions and lowercase the filename as well, so keep reading.

===Extracting data from CD===
====Installing unshield====

First, you need unshield from http://synce.sourceforge.net/synce/unshield.php

If you use debian, apt-get install unshield as root should do the trick. Else, try to find a package for your distribution, or if you don't, compile it yourself following the instructions provided on the website. Note you don't need to actually install it, just compile it and use it from the directory where you compiled it.

====Preparing directories====

* Create a directory for fs2_open, say, ''/usr/local/games/fs2_open'', with a ''data/movies'' and ''data/players'' subdirectories. Everything but user files and configuration will be in this directory.

<tt>~# mkdir -p /usr/local/games/fs2_open/data/movies /usr/local/games/fs2_open/data/players</tt>

====Extracting files====

* Use unshield to extract the groups from data1.cab (on the first cd) to a temporary directory; then move the files in your game directory :
<tt>~# mkdir /tmp/fs2</>
<tt>~# for group in "Basic Install Files" "Intel Anims" "Music Compressed" "High Res Files"; do unshield -d /tmp/fs2/ -g "$group" -L -j x disk1/data1.cab && mv -v /tmp/fs2/*/* /home/data/jeux/fs2_open</tt>
<tt>~# unshield -d /usr/local/games/fs2_open/data/players -g "Hud Config Files" -L -j x data1.cab && mv -v /tmp/fs2/hud_config_files/"* /home/data/jeux/fs2_open/data/players</tt>

* From the second CD, get the vp files and the movies files (I dont think the the mve file are really needed, you'll need the avi ones if you want the movies).
<tt>~# cp -vf *.vp /usr/local/games/fs2_open</tt>
<tt>~# mkdir -p /usr/local/games/fs2_open/data/movies/ && cp -vf *.MVE /usr/local/games/fs2_open/data/movies/</tt>
* Do the same for the third CD :
<tt>~# cp -vf *.vp /usr/local/games/fs2_open</tt>
<tt>~# cp -vf *.MVE /usr/local/games/fs2_open/data/movies/</tt>

You may notice that some files are on all three CD. This is because the games was meant to be run from CD. Don't bother.

=== Fixing Case and permissions ===
* You '''have''' to make sure everything is lowercase :
<tt>~# find /usr/local/games/fs2_open/ | rename -v 'y/A-Z/a-z/'</tt>

* Then, fix permissions :
<tt>~# find /usr/local/games/fs2_open -type d -exec chmod a+rx '{}' \;</tt>
<tt>~# find /usr/local/games/fs2_open -type f -exec chmod a+r '{}' \;</tt>

===MediaVP and Cutscenes===
You'll also need the mediavp from the SCP if you want the enhanced graphics. Get them at http://scp.indiegames.us.
If you want the cutscenes, you'll have to find the avi version of the MVE files, or to convert them yourself. They are not hard to find. When you have them, just put them in the data/movies directory. Again, make sure everything is lowercase.

That's it for the game data files, now it's time get the source !

== Using the source ==

=== CVS Checkout ===
Before you begin, make sure you are situated in a a directory where you have write permissions. Your /home/user/ directory is pretty much a sure bet. I recommend that you create a permanent /home/user/src directory from which you run the CVS command, this way CVS will only update the files changed the next time you download the source and it's always nice to have things organized.

Now get the source. Run from a terminal:
cvs -d:pserver:anonymous:anonymous@warpcore.org:/home/fs2source/cvsroot login
and then
cvs -z3 -d:pserver:anonymous@warpcore.org:/home/fs2source/cvsroot co fs2_open
The first cvs command tells the CVS tool to first use a password file for authentication (pserver), that you are user "anonymous" with the password "anonymous" who wants to access warpcore.org's CVS repository "/home/fs2source/cvsroot" and login. The second command tells the CVS server on which we are now connected to that we want to checkout (co) the fs2_open module.
 
==== CVS Checkout and Update Script ====
The code on CVS is in a constant state of change, and bugs that exist one day may be gone the next. Because of this, you'll want to occasionally update to a newer version and recompile.
Running those cvs commands will fast grow to be a pain, so this little script was created to make your life easier. This script will checkout fs2_open if it can't find a fs2_open directory and update fs2_open, if it finds it.
The script will run until a successfull checkout or update has been achieved.
Copy and save this to a suitably named file like "get_fs2_open", and make it executable with the command, chmod +x <name of file>
#!/bin/bash
# CVS Checkout and Update Script for fs2_open
CVS_LINE="cvs -d:pserver:anonymous:anonymous@warpcore.org:/home/fs2source/cvsroot" # The cvs command
if [ "$UID" = 0 ]; then # check if user is root, and if so, echo a warning.
echo "You are root. If this is a checkout, all files \
will be created with root as the owner."
sleep 3
fi
if [ -e ./fs2_open ]; then # check if directory fs2_open exists
echo "Found fs2_open, We are updating an old checkout."
CVS_ATTEMPT=0 # This updates the checkout.
until [ $CVS_ATTEMPT = 1 ]; do
$CVS_LINE login && \
$CVS_LINE update fs2_open && \
let CVS_ATTEMPT=1
done
else
echo "No fs2_open found, This is a new checkout."
CVS_ATTEMPT=0 # This creates a new checkout.
until [ $CVS_ATTEMPT = 1 ]; do
$CVS_LINE login && \
$CVS_LINE co fs2_open && \
let CVS_ATTEMPT=1
done
fi

=== Pre-Compile Configuration ===

Before you compile you need to configure it for your system. Run from
In the directory you ran the CVS command from, a new directory will appear, namely fs2_open.
If your fs2_open is a completely new checkout, you will first need to run the autogen.sh script.
Run from inside your newly created fs2_open directory:
./autogen.sh
autogen.sh is a script that will generate the required makefiles. You will see alot of "checking for this" and "checking for that", this is actually the "configure" script (which can be run with <tt>./configure</tt> if you need to change the options) examining and configuring fs2_open for your system. 
It is possible to give autogen.sh configure options as well, autogen.sh will pass them along to configure.

A full list of configure options can be found by running the configure script with the '--help' option.
./configure --help

==== Optimizing fs2_open ====
Optimizing fs2_open might have little or no effect, or improve performance greatly, I honestly have no clue. 
A note of caution, if you are compiling a debug build, don't use the -fomit-frame-pointer CFLAG, it will make debugging impossible. 
You can specify your compiler flags with the configure script, se below.
./configure CFLAGS="<your desired flags>"
If you got a Athlon-XP and want to play it safe, a good set of CFLAGS would be
./configure CFLAGS="-march=athlon-xp -O3 -pipe -fomit-frame-pointer"
You should read up on CFLAGS and what they do before trying anything. I recommend you read through these links. 
http://gcc.gnu.org/onlinedocs/gcc-3.4.1/gcc/Optimize-Options.html 
http://linuxreviews.org/howtos/compiling/safe-cflags/ 
http://en.wikipedia.org/wiki/CFLAGS

=== Compiling ===

Run from within your fs2_open directory:
make
Sit back and enjoy gcc work its magic.

==== Simple Compile Script ====
It's alot easier to use a scripts when dealing with constantly changing code. Copy and save this to a suitably named file like "compile_fs2_open", and make it executable with the command, chmod +x <name of file>
This script assumes the CVS checkout directory fs2_open is pressent in the same directory as the script itself.
#!/bin/bash
# fs2_open Compile Script
# These are only examples, uncomment to enable optimization.
#MY_CFLAGS="-march=athlon-xp -O3 -pipe -fomit-frame-pointer -ftracer"
if [ -e ./fs2_open/ ]; then
cd fs2_open
if [ -e ./Makefile.in ]; then
make clean
./configure CFLAGS="$MY_CFLAGS" CXXFLAGS="$MY_CFLAGS"
make
else
./autogen.sh CFLAGS="$MY_CFLAGS" CXXFLAGS="$MY_CFLAGS"
make
fi
else
echo "No fs2_open directory found."
fi

You can add your options to the ./configure line.

== Using the Binaries ==

When the compile is done and if all went well, a binary executable will reside in the code directory ''fs2_open_r'' or ''fs2_open_d'' if you configured for a debug build. Copy the binary to directory where Freespace2 is installed, and you're all set to go.

=== Post-Compile Configuration ===
==== Changing Your Resolution ====

Odds are, you'll want to run fs2_open in a higher resolution than the default 640x480. Unfortunately, we Linux users don't have the swank launcher app that the Windows folks do. Instead, we'll be making a couple line changes to a config file. You will need to run fs2_open once before you can make the necessary changes, otherwise you won't have a configuration directory to work with.

The first thing we need to do is get into the fs2_open config directory, which is a hidden folder in your home directory. The fastest way to get there is to type the following in a console:
cd ~/.fs2_open

From here, open up fs2_open.ini in your text editor of choice (vi, EMACS, joe, pico, etc). You'll see something like the following:
[Default]
VideocardFs2open=OGL -(640x480)x16 bit
LastPlayer=MonkeyboyS
GammaD3D=1.0

Then change the Videocard line to the following:
VideocardFs2open=OGL -(1024x768)x32 bit

Save the file, and run fs2_open as you normally would. Voila! You're now in 1024x768 at 32bit color. Congratulations!

=== Creating a Start Up Script ===

In order to use all of the advanced engine features of fs2_open, you'll need to start the executable with a number of command line arguments. Instead of typing them in every time you want to start the game, why not create a script that does it for you?

Create a new file named start_freespace (or whatever you like) in your home directory. Open the file in your editor of choice, and paste the following:
#!/bin/bash
cd /path/to/your/freespace/
./fs2_open_r -spec -glow -mipmap -jpgtga -orbradar -mod Media_VP

''Note: You will need to edit this script before it will work properly. The second line must point to the directory where you installed fs2_open.''

The last line starts fs2_open with a number of arguments that turn on extra features. In the example, the game will use specular highlights, glow-mapping, mipmapping, jpg and tga graphic files, the orb radar, and any MediaVPs installed to the /Media_VP directory. You should edit this line to use those features that your system supports.

More information about the available Command Line Arguments can be found at the [[Command-Line Reference]]

Once you've edited the file to your heart's content, make it executable:
chmod +x start_freespace

You can now type in start_freespace to start the game, or by clicking on start_freespace in your window manager. For convenience, you can copy it to your Desktop.

== Troubleshooting ==
=== Compile Errors ===
==== Missing -lGLU compile error ====

On some Linux distributions (''Slackware'' for instance), compiling fails because a GL related library doesn't have a link in the <tt>/usr/lib</tt> directory. If the compile fails because it can't find <tt>-lGLU</tt>, here are two ways to fix it:

===== Solution as Root =====

If you have root access to the system, you can create a link to the library in question with just a little bit of command line magic. Go to a console and enter:

ln -s /usr/X11R6/lib/libGLU.so /usr/lib/libGLU.so

After that, you can run make again and it should finish compiling.

===== Solution as a Non-Root user =====

You don't have root access? Never fear, we can still fix the problem. It'll just be a tad more difficult.

Navigate to the <tt>fs2_open/code</tt> directory and locate a file named <tt>Makefile</tt> (not Makefile.rm or Makefile.in or Makefile.anything). Open it in your favorite text editor and make the following changes.

Find this line (line 457 in mine):
FS2_LDFLAGS = -L/usr/lib -Wl,-rpath,/usr/lib -lSDL -lpthread -lGL -lGLU -lopenal -logg -lvorbis -lvorbisfile

And replace it with this:
FS2_LDFLAGS = -L/usr/lib -Wl,-rpath,/usr/lib -lSDL -lpthread -lGL -lopenal -logg -lvorbis -lvorbisfile -L/usr/X11R6/lib -lGLU

Also find this one (line 565 in mine):
AM_LDFLAGS = -g -L/usr/lib -Wl,-rpath,/usr/lib -lSDL -lpthread -lGL -lGLU -lopenal -logg -lvorbis -lvorbisfile

And replace it with this:
AM_LDFLAGS = -g -L/usr/lib -Wl,-rpath,/usr/lib -lSDL -lpthread -lGL -lopenal -logg -lvorbis -lvorbisfile -L/usr/X11R6/lib -lGLU

Then run <tt>make</tt> from the <tt>fs2_open</tt> directory, and watch the magic happen.

==== glBindBufferARB feature missing ====
'''This is a draft, and has not been tested.''' 
'''If this is the actual solution to this problem remains to be proven.''' 
'''So far, only people using Debian stable are affected by this.''' 
'''So we need adventurus Debian users to confirm. / ni1s''' 
checking for glBindBufferARB in -lGL... no
configure: error: *** OpenGL version does not have the required features!! (ie.glBindBufferARB()) ***
This error appears if the installed Mesa development library is to old.

On Debian stable branch the xlibmesa-gl-dev package holds version 4.3.0. 
The xlibmesa-gl-dev package on ''testning'' is version 6.9.0.

'''Possible solution:''' 
First set /etc/apt/sources.list to include the testing branch. Add:
#Testing
deb http://ftp.us.debian.org/debian testing main non-free contrib
deb http://non-us.debian.org/debian-non-US testing/non-US main contrib non-free
Your sources.list might have these lines already, if so, you should be okej.

Your /etc/apt/preferences file should look like this
Package: *
Pin: release a=stable
Pin-Priority: 700

Package: *
Pin: release a=testing
Pin-Priority: 650

Package: *
Pin: release a=unstable
Pin-Priority: 600

Add to that file:
Package: xlibmesa-gl-dev
Pin: release a=testing
Pin-Priority: 800
Note that the Pin-Priority of xlibmesa-gl-dev here is higher than the Pin-Priority on 'stable'. As a result of this APT get will prioritize the xlibmesa-gl-dev from testing and leave the rest of the system on stable.
This is called apt-pinning.

Now that APT knows what xlibmesa-gl-dev to prioritze, install it again:
apt-get install xlibmesa-gl-dev

If you are using nVidia's nvidia-kernel and glx packages, a simple:
apt-get install nvidia-glx-dev
should suffice. No need to mess around with APT-pinning.

=== Runtime Errors ===
==== ERROR: "Web cursor bitmap not found." ====
ERROR: "Web cursor bitmap not found. This usually means that the executable is being run outside the directory
you installed Freespace2 to. Please move the executable to that directory and try again" at graphics/2d.cpp:1402
A common error. This happens when fs2_open can't find the .vp files or that your user doesn't have the permissions to access them. If you are using a start up script([http://www.hard-light.net/wiki/index.php/Fs2_open_on_Linux#Creating_a_Start_Up_Script like the one found here]) it's most likly the a permission problem.
Have your user take owenership of the .vp files, run as root:
chown <user> /path/to/vpfiles/ -R

=== I18n and Key mapping problems ===

Ok, imagine that like me you don't have an us keyboard but a french one (or anything). Well, you probably have problems mapping some keys or even using the default mapping.

Actually, the problem is fs2_open does not take modifiers into account, as it uses them internally as modifiers for keys, and it won't accept non-us charset either.

On a french keyboard layout, the numbers ''1 2 3 4 5 6 7 8 9 0'' are on the same keys than on a US layout, but you have to press shift to use them. The primary function for theses keys are ''& Ã© " ' ( - Ã¨ _ Ã§ Ã )''. These characters won't be accepted by freespace, and if you press shift to get a number, it won't work. This can be a problem, as theses keys are needed to use the communication system, and cannot be bound to anything. Also, as you won't get access some keys on your keyboard, it will be difficult to map every command on a key, or you'll have to use modifiers for nearly each key.

However, there is a solution. You can tell X to remap the keyboard before launching the game, and restore your normal keymap afterwards.

For exemple, I map 123456790 to the &Ã©"'(-Ã¨_Ã§Ã keys so I can use the communication system, and I put , and ; on the Alt-Gr and Menu keys for convenience, as I binded thoses keys to next primary weapon and next secondary weapon.

To do this, I use a slightly enhanced startup script, which I put in ~/bin (this directory is in my path), together with a customized xmodmap.

* First, dump your current xmodmap :

<tt>~$ xmodmap -pke > ~/xmodmap.current</tt>

* Then edit it with your favorite text editor. You'll see a bunch of lines looking like this :

<tt>
keycode 8 =
keycode 9 = Escape
keycode 10 = 1 ampersand onesuperior exclamdown onesuperior exclamdown
</tt>

The syntax is ''keycode <number> = <symbol list>''.

Use '''xev''' to scan the keycodes. The symbols are defined in ''/usr/include/X11/keysymdef.h''. Just make sure you write them without the ''XK_'' prefix. You'll find more information about xmodmap in the xmodmap manual page.

Just modify the keys you need, and be patient. This can be a long process. Test it with xmodmap :

<tt>xmodmap - < <filename></tt>

But don't forget to have your previous keymap at hand to recover your settings !
If you mess everything up, just restart X. Your default keymap will be applied from the X configuration.

Here is my own fs2 xmodmap, derived from fr-latin1 as described above. Feel free to use it if you're too lazy to modify your own. However, it may not fit with your needs. You may always use it as an exemple, thougt.
* http://clement.hermann.free.fr/fs2/xmodmap

Then, when the file is modified at your liking, just save it as '''~/.fs2_open/xmodmap'''

We'll start fs2_open with a slightly more elaborate startup script which will backup/apply/restore the keymap in addition of running the games with some options in the right directory.

<tt>
#!/bin/sh
# This script lauches fs2. If there is a file named $FS2_modmap (see below),
# backup the current modmap as $TMP_modmap and load it as the new modmap.
# The current modmap will be restored afterwards.

TMP_modmap="$HOME/xmodmap.tmp"
FS2_modmap="$HOME/.fs2_open/xmodmap"

FS2_OPEN_DIR=/usr/local/games/fs2_open

FS2_ARGS="-glow -spec -spec_exp 11 -spec_point 0.6 -spec_static 0.8 -spec_tube 0.4 -fps -jpgtga -ambient_factor 75 -targetinfo -nograb"

FS2_BIN="$FS2_OPEN_DIR/fs2_open_r"

die() {
echo "** Fatal error : $1" >&2
exit 1
}

cd $FS2_OPEN_DIR || die "Could not change directory to $FS2_OPEN_DIR"

# dump current xmodmap
[ -f "$FS2_modmap" ] && xmodmap -pke > $TMP_modmap

# load xmodmap
[ -f "$FS2_modmap" ] && xmodmap - < $FS2_modmap

# launch fs2
$FS2_BIN $FS2_ARGS $* || die "Error while running \"$FS2_BIN\" with arguments \"$FS2_ARGS\"."

# restore xmodmap
xmodmap - < $TMP_modmap && rm $TMP_modmap
</tt>

Adapt this script to your needs, and save it somewhere in your PATH - I for exemple usr ~/bin/freespace2. Make it executable with a chmod +x ''<file>''

That's it, now you can use fs2 with full control over your keyboard.

Guide to FS Open on Linux

2006-04-17T12:08:08Z

Nodens: added a section about i18n and key mapping problem (and solution)

''Note: This tutorial assumes some fundamental command line knowledge.''

== Installing CVS ==
CVS stands for Concurrent Versions System and is a version control system used to record the changes in documents, such as source files. Developers use CVS so they can easily share their code changes among other developers. You will need this tool to download ("checkout" in CVS terminology) fs2_open from the CVS server.

'''Debian/Ubuntu''' users want to:
apt-get install cvs
'''Gentoo''' users want to:
emerge cvs

'''NOTE: Redhat, Mandrake/Mandriva, Slackware and all the other distros should go here too,'''
'''but we have no knowledge on how these work, so if you do, please enlighten us.'''

== Installing the nessesary development libraries ==
You will also need SDL, OpenAL, libvorbis and OpenGL(most likely provided with your video card driver) development packages. And of course the GCC compiler and required make tools.
 
'''Debian/Ubuntu''' users want to:
apt-get install libopenal-dev libvorbis-dev build-essential automake1.9 autoconf libsdl-dev
'''NOTE:''' The ''build-essential'' meta package installs GCC4. This should work, but if you feel safer with GCC 3.4(gcc-3.4), add it to the apt-get line above. 
'''Gentoo''' users want to:
emerge openal libvorbis libsdl
'''NOTE: Radhat, Mandrake,Slackware and all the other distros should go here too,'''
'''but we have no knowlage on how these work, so if you do, please enlighten us.'''

== Installing game data files ==

This tutorial deals primarily with providing you with an executable, but in order to play the game you also need the game data. Freespace 2 game data is available from a number of sources, see this thread: http://www.hard-light.net/forums/index.php/topic,38195.0.html

Note that if you use the retail CD, you'll need to extract the files and copying them on your drive, reproducing the same layout as in a working win32 installation (just make sure every file is lowercase). This thread on the SCP forum has some more info on it : http://scp.indiegames.us/forum_viewtopic.php?3.282

There are two ways of doing this :
* use wine to install the game in the right directory, using the Setup.exe found on the first CD, or
* extract manually the files from the cd.

The second method is detailed below. The wine one is straightforward and you shouldn't need any specific instruction, but you'll have to fix permissions and lowercase the filename as well, so keep reading.

===Extracting data from CD===
====Installing unshield====

First, you need unshield from http://synce.sourceforge.net/synce/unshield.php

If you use debian, apt-get install unshield as root should do the trick. Else, try to find a package for your distribution, or if you don't, compile it yourself following the instructions provided on the website. Note you don't need to actually install it, just compile it and use it from the directory where you compiled it.

====Preparing directories====

* Create a directory for fs2_open, say, ''/usr/local/games/fs2_open'', with a ''data/movies'' and ''data/players'' subdirectories. Everything but user files and configuration will be in this directory.

<tt>~# mkdir -p /usr/local/games/fs2_open/data/movies /usr/local/games/fs2_open/data/players</tt>

====Extracting files====

* Use unshield to extract the groups from data1.cab (on the first cd) to a temporary directory; then move the files in your game directory :
<tt>~# mkdir /tmp/fs2</>
<tt>~# for group in "Basic Install Files" "Intel Anims" "Music Compressed" "High Res Files"; do unshield -d /tmp/fs2/ -g "$group" -L -j x disk1/data1.cab && mv -v /tmp/fs2/*/* /home/data/jeux/fs2_open</tt>
<tt>~# unshield -d /usr/local/games/fs2_open/data/players -g "Hud Config Files" -L -j x data1.cab && mv -v /tmp/fs2/hud_config_files/"* /home/data/jeux/fs2_open/data/players</tt>

* From the second CD, get the vp files and the movies files (I dont think the the mve file are really needed, you'll need the avi ones if you want the movies).
<tt>~# cp -vf *.vp /usr/local/games/fs2_open</tt>
<tt>~# mkdir -p /usr/local/games/fs2_open/data/movies/ && cp -vf *.MVE /usr/local/games/fs2_open/data/movies/</tt>
* Do the same for the third CD :
<tt>~# cp -vf *.vp /usr/local/games/fs2_open</tt>
<tt>~# cp -vf *.MVE /usr/local/games/fs2_open/data/movies/</tt>

You may notice that some files are on all three CD. This is because the games was meant to be run from CD. Don't bother.

=== Fixing Case and permissions ===
* You '''have''' to make sure everything is lowercase :
<tt>~# find /usr/local/games/fs2_open/ | rename -v 'y/A-Z/a-z/'</tt>

* Then, fix permissions :
<tt>~# find /usr/local/games/fs2_open -type d -exec chmod a+rx '{}' \;</tt>
<tt>~# find /usr/local/games/fs2_open -type f -exec chmod a+r '{}' \;</tt>

===MediaVP and Cutscenes===
You'll also need the mediavp from the SCP if you want the enhanced graphics. Get them at http://scp.indiegames.us.
If you want the cutscenes, you'll have to find the avi version of the MVE files, or to convert them yourself. They are not hard to find. When you have them, just put them in the data/movies directory. Again, make sure everything is lowercase.

That's it for the game data files, now it's time get the source !

== Using the source ==

=== CVS Checkout ===
Before you begin, make sure you are situated in a a directory where you have write permissions. Your /home/user/ directory is pretty much a sure bet. I recommend that you create a permanent /home/user/src directory from which you run the CVS command, this way CVS will only update the files changed the next time you download the source and it's always nice to have things organized.

Now get the source. Run from a terminal:
cvs -d:pserver:anonymous:anonymous@warpcore.org:/home/fs2source/cvsroot login
and then
cvs -z3 -d:pserver:anonymous@warpcore.org:/home/fs2source/cvsroot co fs2_open
The first cvs command tells the CVS tool to first use a password file for authentication (pserver), that you are user "anonymous" with the password "anonymous" who wants to access warpcore.org's CVS repository "/home/fs2source/cvsroot" and login. The second command tells the CVS server on which we are now connected to that we want to checkout (co) the fs2_open module.
 
==== CVS Checkout and Update Script ====
The code on CVS is in a constant state of change, and bugs that exist one day may be gone the next. Because of this, you'll want to occasionally update to a newer version and recompile.
Running those cvs commands will fast grow to be a pain, so this little script was created to make your life easier. This script will checkout fs2_open if it can't find a fs2_open directory and update fs2_open, if it finds it.
The script will run until a successfull checkout or update has been achieved.
Copy and save this to a suitably named file like "get_fs2_open", and make it executable with the command, chmod +x <name of file>
#!/bin/bash
# CVS Checkout and Update Script for fs2_open
CVS_LINE="cvs -d:pserver:anonymous:anonymous@warpcore.org:/home/fs2source/cvsroot" # The cvs command
if [ "$UID" = 0 ]; then # check if user is root, and if so, echo a warning.
echo "You are root. If this is a checkout, all files \
will be created with root as the owner."
sleep 3
fi
if [ -e ./fs2_open ]; then # check if directory fs2_open exists
echo "Found fs2_open, We are updating an old checkout."
CVS_ATTEMPT=0 # This updates the checkout.
until [ $CVS_ATTEMPT = 1 ]; do
$CVS_LINE login && \
$CVS_LINE update fs2_open && \
let CVS_ATTEMPT=1
done
else
echo "No fs2_open found, This is a new checkout."
CVS_ATTEMPT=0 # This creates a new checkout.
until [ $CVS_ATTEMPT = 1 ]; do
$CVS_LINE login && \
$CVS_LINE co fs2_open && \
let CVS_ATTEMPT=1
done
fi

=== Pre-Compile Configuration ===

Before you compile you need to configure it for your system. Run from
In the directory you ran the CVS command from, a new directory will appear, namely fs2_open.
If your fs2_open is a completely new checkout, you will first need to run the autogen.sh script.
Run from inside your newly created fs2_open directory:
./autogen.sh
autogen.sh is a script that will generate the required makefiles. You will see alot of "checking for this" and "checking for that", this is actually the "configure" script (which can be run with <tt>./configure</tt> if you need to change the options) examining and configuring fs2_open for your system. 
It is possible to give autogen.sh configure options as well, autogen.sh will pass them along to configure.

A full list of configure options can be found by running the configure script with the '--help' option.
./configure --help

==== Optimizing fs2_open ====
Optimizing fs2_open might have little or no effect, or improve performance greatly, I honestly have no clue. 
A note of caution, if you are compiling a debug build, don't use the -fomit-frame-pointer CFLAG, it will make debugging impossible. 
You can specify your compiler flags with the configure script, se below.
./configure CFLAGS="<your desired flags>"
If you got a Athlon-XP and want to play it safe, a good set of CFLAGS would be
./configure CFLAGS="-march=athlon-xp -O3 -pipe -fomit-frame-pointer"
You should read up on CFLAGS and what they do before trying anything. I recommend you read through these links. 
http://gcc.gnu.org/onlinedocs/gcc-3.4.1/gcc/Optimize-Options.html 
http://linuxreviews.org/howtos/compiling/safe-cflags/ 
http://en.wikipedia.org/wiki/CFLAGS

=== Compiling ===

Run from within your fs2_open directory:
make
Sit back and enjoy gcc work its magic.

==== Simple Compile Script ====
It's alot easier to use a scripts when dealing with constantly changing code. Copy and save this to a suitably named file like "compile_fs2_open", and make it executable with the command, chmod +x <name of file>
This script assumes the CVS checkout directory fs2_open is pressent in the same directory as the script itself.
#!/bin/bash
# fs2_open Compile Script
# These are only examples, uncomment to enable optimization.
#MY_CFLAGS="-march=athlon-xp -O3 -pipe -fomit-frame-pointer -ftracer"
if [ -e ./fs2_open/ ]; then
cd fs2_open
if [ -e ./Makefile.in ]; then
make clean
./configure CFLAGS="$MY_CFLAGS" CXXFLAGS="$MY_CFLAGS"
make
else
./autogen.sh CFLAGS="$MY_CFLAGS" CXXFLAGS="$MY_CFLAGS"
make
fi
else
echo "No fs2_open directory found."
fi

You can add your options to the ./configure line.

== Using the Binaries ==

When the compile is done and if all went well, a binary executable will reside in the code directory ''fs2_open_r'' or ''fs2_open_d'' if you configured for a debug build. Copy the binary to directory where Freespace2 is installed, and you're all set to go.

=== Post-Compile Configuration ===
==== Changing Your Resolution ====

Odds are, you'll want to run fs2_open in a higher resolution than the default 640x480. Unfortunately, we Linux users don't have the swank launcher app that the Windows folks do. Instead, we'll be making a couple line changes to a config file. You will need to run fs2_open once before you can make the necessary changes, otherwise you won't have a configuration directory to work with.

The first thing we need to do is get into the fs2_open config directory, which is a hidden folder in your home directory. The fastest way to get there is to type the following in a console:
cd ~/.fs2_open

From here, open up fs2_open.ini in your text editor of choice (vi, EMACS, joe, pico, etc). You'll see something like the following:
[Default]
VideocardFs2open=OGL -(640x480)x16 bit
LastPlayer=MonkeyboyS
GammaD3D=1.0

Then change the Videocard line to the following:
VideocardFs2open=OGL -(1024x768)x32 bit

Save the file, and run fs2_open as you normally would. Voila! You're now in 1024x768 at 32bit color. Congratulations!

=== Creating a Start Up Script ===

In order to use all of the advanced engine features of fs2_open, you'll need to start the executable with a number of command line arguments. Instead of typing them in every time you want to start the game, why not create a script that does it for you?

Create a new file named start_freespace (or whatever you like) in your home directory. Open the file in your editor of choice, and paste the following:
#!/bin/bash
cd /path/to/your/freespace/
./fs2_open_r -spec -glow -mipmap -jpgtga -orbradar -mod Media_VP

''Note: You will need to edit this script before it will work properly. The second line must point to the directory where you installed fs2_open.''

The last line starts fs2_open with a number of arguments that turn on extra features. In the example, the game will use specular highlights, glow-mapping, mipmapping, jpg and tga graphic files, the orb radar, and any MediaVPs installed to the /Media_VP directory. You should edit this line to use those features that your system supports.

More information about the available Command Line Arguments can be found at the [[Command-Line Reference]]

Once you've edited the file to your heart's content, make it executable:
chmod +x start_freespace

You can now type in start_freespace to start the game, or by clicking on start_freespace in your window manager. For convenience, you can copy it to your Desktop.

== Troubleshooting ==
=== Compile Errors ===
==== Missing -lGLU compile error ====

On some Linux distributions (''Slackware'' for instance), compiling fails because a GL related library doesn't have a link in the <tt>/usr/lib</tt> directory. If the compile fails because it can't find <tt>-lGLU</tt>, here are two ways to fix it:

===== Solution as Root =====

If you have root access to the system, you can create a link to the library in question with just a little bit of command line magic. Go to a console and enter:

ln -s /usr/X11R6/lib/libGLU.so /usr/lib/libGLU.so

After that, you can run make again and it should finish compiling.

===== Solution as a Non-Root user =====

You don't have root access? Never fear, we can still fix the problem. It'll just be a tad more difficult.

Navigate to the <tt>fs2_open/code</tt> directory and locate a file named <tt>Makefile</tt> (not Makefile.rm or Makefile.in or Makefile.anything). Open it in your favorite text editor and make the following changes.

Find this line (line 457 in mine):
FS2_LDFLAGS = -L/usr/lib -Wl,-rpath,/usr/lib -lSDL -lpthread -lGL -lGLU -lopenal -logg -lvorbis -lvorbisfile

And replace it with this:
FS2_LDFLAGS = -L/usr/lib -Wl,-rpath,/usr/lib -lSDL -lpthread -lGL -lopenal -logg -lvorbis -lvorbisfile -L/usr/X11R6/lib -lGLU

Also find this one (line 565 in mine):
AM_LDFLAGS = -g -L/usr/lib -Wl,-rpath,/usr/lib -lSDL -lpthread -lGL -lGLU -lopenal -logg -lvorbis -lvorbisfile

And replace it with this:
AM_LDFLAGS = -g -L/usr/lib -Wl,-rpath,/usr/lib -lSDL -lpthread -lGL -lopenal -logg -lvorbis -lvorbisfile -L/usr/X11R6/lib -lGLU

Then run <tt>make</tt> from the <tt>fs2_open</tt> directory, and watch the magic happen.

==== glBindBufferARB feature missing ====
'''This is a draft, and has not been tested.''' 
'''If this is the actual solution to this problem remains to be proven.''' 
'''So far, only people using Debian stable are affected by this.''' 
'''So we need adventurus Debian users to confirm. / ni1s''' 
checking for glBindBufferARB in -lGL... no
configure: error: *** OpenGL version does not have the required features!! (ie.glBindBufferARB()) ***
This error appears if the installed Mesa development library is to old.

On Debian stable branch the xlibmesa-gl-dev package holds version 4.3.0. 
The xlibmesa-gl-dev package on ''testning'' is version 6.9.0.

'''Possible solution:''' 
First set /etc/apt/sources.list to include the testing branch. Add:
#Testing
deb http://ftp.us.debian.org/debian testing main non-free contrib
deb http://non-us.debian.org/debian-non-US testing/non-US main contrib non-free
Your sources.list might have these lines already, if so, you should be okej.

Your /etc/apt/preferences file should look like this
Package: *
Pin: release a=stable
Pin-Priority: 700

Package: *
Pin: release a=testing
Pin-Priority: 650

Package: *
Pin: release a=unstable
Pin-Priority: 600

Add to that file:
Package: xlibmesa-gl-dev
Pin: release a=testing
Pin-Priority: 800
Note that the Pin-Priority of xlibmesa-gl-dev here is higher than the Pin-Priority on 'stable'. As a result of this APT get will prioritize the xlibmesa-gl-dev from testing and leave the rest of the system on stable.
This is called apt-pinning.

Now that APT knows what xlibmesa-gl-dev to prioritze, install it again:
apt-get install xlibmesa-gl-dev

If you are using nVidia's nvidia-kernel and glx packages, a simple:
apt-get install nvidia-glx-dev
should suffice. No need to mess around with APT-pinning.

=== Runtime Errors ===
==== ERROR: "Web cursor bitmap not found." ====
ERROR: "Web cursor bitmap not found. This usually means that the executable is being run outside the directory
you installed Freespace2 to. Please move the executable to that directory and try again" at graphics/2d.cpp:1402
A common error. This happens when fs2_open can't find the .vp files or that your user doesn't have the permissions to access them. If you are using a start up script([http://www.hard-light.net/wiki/index.php/Fs2_open_on_Linux#Creating_a_Start_Up_Script like the one found here]) it's most likly the a permission problem.
Have your user take owenership of the .vp files, run as root:
chown <user> /path/to/vpfiles/ -R

=== I18n and Key mapping problems ===

Ok, imagine that like me you don't have an us keyboard but a french one (or anything). Well, you probably have problems mapping some keys or even using the default mapping.

Actually, the problem is fs2_open does not take modifiers into account, as it uses them internally as modifiers for keys, and it won't accept non-us charset either.

On a french keyboard layout, the numbers ''1 2 3 4 5 6 7 8 9 0'' are on the same keys than on a US layout, but you have to press shift to use them. The primary function for theses keys are ''& Ã© " ' ( - Ã¨ _ Ã§ Ã )''. These characters won't be accepted by freespace, and if you press shift to get a number, it won't work. This can be a problem, as theses keys are needed to use the communication system, and cannot be bound to anything. Also, as you won't get access some keys on your keyboard, it will be difficult to map every command on a key, or you'll have to use modifiers for nearly each key.

However, there is a solution. You can tell X to remap the keyboard before launching the game, and restore your normal keymap afterwards.

For exemple, I map 123456790 to the &Ã©"'(-Ã¨_Ã§Ã keys so I can use the communication system, and I put , and ; on the Alt-Gr and Menu keys for convenience, as I binded thoses keys to next primary weapon and next secondary weapon.

To do this, I use a slightly enhanced startup script, which I put in ~/bin (this directory is in my path), together with a customized xmodmap.

* First, dump your current xmodmap :

<tt>~$ xmodmap -pke > ~/xmodmap.current</tt>

* Then edit it with your favorite text editor. You'll see a bunch of lines looking like this :

<tt>
keycode 8 =
keycode 9 = Escape
keycode 10 = 1 ampersand onesuperior exclamdown onesuperior exclamdown
</tt>

The syntax is ''keycode <number> = <symbol list>''.

Use '''xev''' to scan the keycodes. The symbols are defined in ''/usr/include/X11/keysymdef.h''. Just make sure you write them without the ''XK_'' prefix. You'll find more information about xmodmap in the xmodmap manual page.

Just modify the keys you need, and be patient. This can be a long process. Test it with xmodmap :

<tt>xmodmap - < <filename></tt>

But don't forget to have your previous keymap at hand to recover your settings !
If you mess everything up, just restart X. Your default keymap will be applied from the X configuration.

Then, when the file is modified at your convenience, just save it as '''~/.fs2_open/xmodmap'''

We'll start fs2_open with a slightly more elaborate startup script which will backup/apply/restore the keymap in addition of running the games with some options in the right directory.

<tt>
#!/bin/sh
# This script lauches fs2. If there is a file named $FS2_modmap (see below),
# backup the current modmap as $TMP_modmap and load it as the new modmap.
# The current modmap will be restored afterwards.

TMP_modmap="$HOME/xmodmap.tmp"
FS2_modmap="$HOME/.fs2_open/xmodmap"

FS2_OPEN_DIR=/usr/local/games/fs2_open

FS2_ARGS="-glow -spec -spec_exp 11 -spec_point 0.6 -spec_static 0.8 -spec_tube 0.4 -fps -jpgtga -ambient_factor 75 -targetinfo -nograb"

FS2_BIN="$FS2_OPEN_DIR/fs2_open_r"

die() {
echo "** Fatal error : $1" >&2
exit 1
}

cd $FS2_OPEN_DIR || die "Could not change directory to $FS2_OPEN_DIR"

# dump current xmodmap
[ -f "$FS2_modmap" ] && xmodmap -pke > $TMP_modmap

# load xmodmap
[ -f "$FS2_modmap" ] && xmodmap - < $FS2_modmap

# launch fs2
$FS2_BIN $FS2_ARGS $* || die "Error while running \"$FS2_BIN\" with arguments \"$FS2_ARGS\"."

# restore xmodmap
xmodmap - < $TMP_modmap && rm $TMP_modmap
</tt>

Adapt this script to your needs, and save it somewhere in your PATH - I for exemple usr ~/bin/freespace2. Make it executable with a chmod +x ''<file>''

That's it, now you can use fs2 with full control over your keyboard.

Guide to FS Open on Linux

2006-04-17T11:13:01Z

Nodens: /* Installing game data files */

Guide to FS Open on Linux

2006-04-17T11:11:55Z

Nodens: /* Installing game data files */ - minor fix

Guide to FS Open on Linux

2006-04-17T11:10:59Z

Nodens: /* MediaVP and Cutscenes */ - typo

Guide to FS Open on Linux

2006-04-17T11:10:09Z

Nodens: improved the presentation so everything looks consistent

Guide to FS Open on Linux

2006-04-17T10:58:10Z

Nodens: actually finished the unshield thing.

Guide to FS Open on Linux

2006-04-13T01:21:12Z

Nodens: /* Installing game data files */ - added the wine trick.

Guide to FS Open on Linux

2006-04-12T15:43:14Z

Nodens: /* Installing game data files */ - typo

Guide to FS Open on Linux

2006-04-12T15:42:25Z

Nodens: /* Installing game data files */ missing </tt>

Guide to FS Open on Linux

2006-04-12T15:40:42Z

Nodens: /* Installing game data files */ - fix permissions

Guide to FS Open on Linux

2006-04-12T14:22:10Z

Nodens: /* Installing game data files */ - warning about the WIP status.

Guide to FS Open on Linux

2006-04-12T13:53:36Z

Nodens: /* Installing game data files */

Guide to FS Open on Linux

2006-04-12T13:46:47Z

Nodens: /* Installing game data files */ - more infos

Guide to FS Open on Linux

2006-04-12T11:47:44Z

Nodens:

Guide to FS Open on Linux

2006-04-12T11:24:45Z

Nodens:

Guide to FS Open on Linux

2006-04-12T11:23:02Z

Nodens: Added a little more info for data files