FS2_open
========

If you don't have FreeSpace 2, get it from
    http://www.gog.com/gamecard/freespace_2


Installation
------------

* Manual instructions:
    http://www.hard-light.net/forums/index.php?topic=79545.0

* With game-data-packager:

    game-data-packager --no-download -i freespace2 <path/to/gog.com_installer>

  Or if you already installed the game on Windows or with Wine:
    game-data-packager --no-download -i freespace2 <path/to/fs2_directory>

  Or, if you own the original 3 CDs release, you can point game-data-packager
  to a directory where you have previously copied the content of all the CDs.


Screen resolution
-----------------

Odds are, you'll want to run fs2_open in a higher resolution than the
default 640x480. This requires use of launcher such as "wxlauncher"
provided by "freespace2-launcher-wxlauncher" package or 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.

Video resolution setting can be found in the following file:

    ~/.local/share/HardLightProductions/FreeSpaceOpen/fs2_open.ini

(formerly "~/.fs2_open/fs2_open.ini"), which contains something like the
following:

    [Default]
    VideocardFs2open=OGL -(640x480)x16 bit

To set fs2_open to use the highest setting possible on retail Freespace2,
change the VideocardFs2open to:

    VideocardFs2open=OGL -(1024x768)x32 bit

You can set this to pretty much anything you want as long as your monitor
supports it.


Starting game
-------------

    cd /usr/share/games/freespace2-open

    ./fs2_open -spec -glow -mipmap -jpgtga -orbradar

    ## Start 'Freespace 1: "The Great War"':
    ./fs2_open -mod fsport

# http://www.hard-light.net/wiki/index.php/Command-Line_Reference

Starting the game is the easiest using "freespace2-launcher-wxlauncher"
package.


Known issues
------------

    Unrecognised command line parameter -spec_exp
    Unrecognised command line parameter -ogl_spec

If experience the above warnings on start, it is probably due to legacy
config:

    ~/.fs2_open/data/cmdline_fso.cfg

New configuration location is here:

    ~/.local/share/HardLightProductions/FreeSpaceOpen


Joystick calibration
--------------------

Use "jscal" (/usr/bin/jscal) binary provided by "joystick" package to
calibrate joystick.


Game data
---------

Debian source packages are provided for some game data. As very minimum you
will need to build one -data package, either "freespace2-data-gog"
or "freespace2-data-volition". All -mod packages are optional.

Typical build instructions are

 1. Copy source packages to temporary directory where at least ~10 GiB
    of free space is available:

    cp -rv /usr/src/freespace2-open/packages/* .

 2. For -data package copy game data to the build directory (where "debian
    directory is"). "freespace2-data-volition" package will need files
    as listed in its "debian/files_sha1.txt" file; "freespace2-data-gog"
    needs only original "setup_freespace2_2.0.0.8.exe" file.

    For every -mod package fetch the data using the following command:

    debian/rules get-orig-source

 3. Build the package(s) using `dpkg-buildpackage -b -uc`,
    (install build-dependencies if prompted).
    Typical build-dependencies can be installed as follows:

    sudo apt install dpkg-dev wget p7zip-full unzip diffutils innoextract

