Manually Installing FreeSpace 2 Open

From FreeSpace Wiki
Revision as of 21:50, 16 September 2010 by General Battuta (talk | contribs) (removed more obsolete crap; needs update)
Jump to: navigation, search

This guide assumes you already have a working copy of FreeSpace 2 installed. If not, see Installing FreeSpace 2. Also, this build assumes you do not use an installer. If you do, skip down Step One.

Quick Start: Using the Online Installer

You can use the excellent installer by Turey, that should give you a baseline of everything you need to play. The rest of this guide is full of information if you want to start tweaking things, or tackle things manually. However, for most players, you can stop with this step.

You can also get the Installer source code here.

This Installer is known to work on Windows, Linux(tested on Gentoo and Fedora, should work on others), and Mac (OSX Panther, with a hacked install of Java 1.5)

Requirements and Notes

You can update your installation by simply running the Installer again. It will download files that are out of date.

The Installer requires an internet connection to install. This is because:

  • It checks to see if it is out of date by pulling the number of the most recent version off of the web.
  • It automatically takes you to the download page of the most recent version if your version is out of date.
  • It checks that all the files are up-to-date.

Source: Original thread by Turey

Step One: Understanding what you need

There are three main components that you need to get the most out of fs2_open.

If Turey's installer is down, or if you want to assemble it all yourself, you need the following components, the rest of this guide tells you about those components and various inner workings of the SCP:

  • First, you need to install the retail data from FreeSpace 2
  • Second, the fs2_open build. This is the core game engine, a single executable file.
  • Next, the Launcher. This lets you configure the fs2_open executable for your particular system, in much the same way the original FreeSpace 2 launcher is used to configure it.
  • Finally, the MediaVPs. These contain all sorts of graphical improvements and are highly recommended. Version numbers of mediaVPs generally agree with the fs2_open build that they're supposed to be used with.

Step Two: Getting the Launcher

Unless you are using an extremely old build, you will want to get the appropriate launcher for your OS. It may be bundled with your release but the direct download link is below.

Windows: Launcher 5.5g download

OS X: Soulstorm's OS X Launcher 3.0

Linux: YAL or here or whatever you can figure out.

Step Three: Choosing a build

There are two main types of fs2_open builds, at the time of this writing. A "build" is any executable built from source code. Any build may also be a debug build. (Debug builds usually have names that end with "_d" or "_dbg" or somesuch) If you don't know why you'd want to use a debug build, you're almost certainly better off not using one.

All builds should be extracted to your main FreeSpace 2 folder.

Official Releases

The first type is the "stable" release build. Additionally, some official release builds are available with installers. It's a good idea to get the most recent official release, even if you end up deciding to get a recent build anyway. Current official release is FreeSpace Open 3.6.12.

FreeSpace Open 3.6.12 release thread

Recent Builds

Recent Builds are ones that individual coders release. Most of the time they're released to either test or showcase some particular new feature. If you're curious about how reliable a build is, your best bet is to check the original thread it was posted in and see what people's responses were.

Recent builds forum

Cross Platform Development forum (for Linux/OS X builds)

Nightly Builds

In addition to recent builds, nightly builds are built every evening after any changes have been applied to the main code base in SVN. These are put out so that the code base can be quickly verified for general stability. Testing nightly builds on a regular basis and reporting bugs helps ensure a stable code base is maintained.

Nightly builds forum

Step Four: MediaVPs

With the rerelease of the 3.6.12 MediaVPs, there is once again only one set of recommended MediaVPs available. The detailed instructions for installing and the current links can currently be found in the MediaVPs Release Thread linked below.

MediaVPs should be installed in a new 'mediavps_3612' directory under the main FreeSpace directory (\freespace2\mediavps_3612) This preserves the possibility to play with either with retail FreeSpace 2 vp files if this is desired (for example in multiplayer) and using the retail FreeSpace 2 executive files and requires minimal extra time to set up. (See step six for further details).

3.6.12 MediaVPs Release Thread

Step Five: Configuring Everything

Basic setup

At this point, you have one final stage remaining before fs2_open is ready to go. Open up the Launcher. (It should be in your main FreeSpace 2 folder). Select the EXE you'd like to use by clicking the "Browse..." button at the top of the Launcher. There are two types typically for any build release:

  • a debug build with the name containing 'd' or 'debug' right after the version number. For example, fs2_open_3_6_10d.exe.
  • a regular/release build with the name containing 'r' or nothing right after the version number. For example, fs2_open_3_6_10.exe or fs2_open_3_6_11r_sse2-20100131_r5862.exe.

For normal play you will want to use a regular build but for any testing, development, or bug reporting you definitely want to use a 'd' build. For example, fs2_open_3_6_10d.exe vs fs2_open_3_6_10.exe.

Next, ensure that the "Audio/Joystick" and "Network" tabs have the proper settings.

Speech setup

If you are using Windows XP, or have the Speech API installed, fs2_open will be able to read briefings, techroom descriptions, and even ingame messages to you using computer-generated voices. Although no match for real voice acting, it is convenient when valid plot points are mentioned in the middle of combat. Speech in the various locations can be turned on and off by checking and unchecking the check boxes; you can choose which of the installed voices to use in fs2_open by changing the drop-down menu. As of this writing, fs2_open will only use the voice you choose for everything. Text to Speech is typically only available in stable release builds. Recent Builds from a coder's test branch will usually not have it, nor will Nightly Builds.

Video setup

On the "Video" tab, you can choose choose various graphics options. Though the Launcher offers OpenGL and Direct3D for graphics APIs, it is good to note that 3.6.10 and newer builds do not include Direct3D and will use OpenGL regardless of what has been selected in the Luncher. With 3.6.9, Direct3D works, but OpenGL is recommended. You can also choose what resolution to run in, and whether to use anisotrophic filtering or not.

"Allow non standard modes" will let you choose resolutions other than 1024x768 and 640x480. 3.6.10 and newer builds support widescreen resolutions and other non-standard resolutions, though using a non-4:3 resolution will stretch the HUD and the interface elements.

Features setup

This tab is where most of fs2_open's options can be toggled on and off. At the top is a readout of your current command line; you should include this in any debugging reports you make.

The next box, with the buttons "Select mod" and "No mod" allow you to choose a mod directory to use; files in the mod directory will be given precedence over other files, so you can easily switch between mods by installing them to different directories.

"Custom flags" allows you to add any command line flags that don't show up in the Launcher. This may be because they require additional arguments, as is the case with the "-fov" command line argument. For more information, see the Command-Line Reference page.

Finally, the two boxes below this let you toggle the various new features in fs2_open, many of which are graphical improvements. Recommended options for midrange systems are "Enable specular", "Enable glowmaps", "Enable Environment Maps", and "Enable jpg,tga textures" (not in 3.6.10). (You may have to choose a different section in the drop-down box to get to some of these options). There are many, many more options, but these should get you started.

Command line Flags

Step Six: Cutscenes

Depending on how you installed the game, the cutscenes might not be in the proper location. If you bought your copy of FS2 from Good Old Games, the cutscenes (ten .mve files) are somewhere in \freespace2\data2\ or \freespace2\data3\ . You can get them working by moving them to \freespace2\data\movies\ . Create the directory if it does not exist. You can also download either the original MVE cutscenes or OGG-encoded versions from If you have the game CDs/DVD, you can copy the cutscenes from them to the FreeSpace2/data/movies/ folder. The OGG cutscenes are smaller but might not perform as well on older hardware that could run the MVEs without problem. Now you should have the full gamut of updated and retail content installed!

Note: If you've found the AVI versions of the cutscenes, do not use them. Support for AVI has been removed in FSO versions 3.6.10 and higher.