Installing fs2 open
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 to the part where it talks about configuring fs2_open.
Contents
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.
- Windows Installer (Zipped .exe, 19 MB) (Doesn't need Java, get this one if you are unsure and are using Windows)
- Win/Linux/Mac Installer (.jar, 26 KB) (Requires Java 1.5)
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)
At the time of the last update, the installer includes (but is not limited to):
- FreeSpace Open 3.6.9 Final (regular and debug)
- FreeSpace Open 3.6.10 Experimental (regular and debug)
- FRED2 Open 3.6.9 Final (regular and debug)
- Launcher 5.5c
- launcher6.ini
- Mac Executables
- Soulstorm's OSX Launcher
- fs2open_pxo.cfg
- The OpenAL Installer (optional)
- 3.6.8 Zeta MediaVPs (optional, includes the 710 patches)
- 3.6.8 Zeta adveffects (only for those with high-power systems, requires regular MediaVPs, includes 710 patch)
- .OGG Cutscenes
- Derelict SCP Version (With optional voice)
- Just Another Day 1, 2 & 3 (separate options for each)
- FreeSpace Port
- Awakenings
- Homesick
- Transcend
- Sync
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 Launcher 5.5 which is bundled with the FreeSpace Open 3.6.9 release but a direct download link is provided below.
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.9.
FreeSpace Open 3.6.9 release thread
Official 3.6.9 release download
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.
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.
Step Four: Choosing your MediaVPs
With the release of the 3.6.10 MediaVPs, there are now two types of installs. A MV_Complete, which includes everything, including the Advanced (high-end PC oriented) effects, and the separate MV_* files. 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' directory under the main FreeSpace directory (\freespace2\mediavps) This preserves both possibility to play with either with retail FreeSpace 2 vp files if this is desired (for example in multiplayer) or using the retail FreeSpace 2 executive files and requires minimal extra time to set up. (See step six for further details).
3.6.10 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 'd' or debug and a 'r' or regular/release. For normal play you will want to use an 'r' 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_10r.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 which API to use (OpenGL or Direct3D), what resolution to run in, and whether to use anti-aliasing (Multisampling) or not. With FreeSpace Open 3.6.9 OpenGL is strongly recommended over the Direct3D. Direct3D will no longer be available in 3.6.10 and on, unless a D3D coder joins the team to fix the many issues that have developed with it.
"Allow non standard modes" will let you choose resolutions other than 1024x768 and 640x480. There may be some small graphics alignment errors, but these are generally small and virtually unnoticeable.
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.
Step Six: (Optional) Preserving Freespace 2
At this point, if you try to start the original Freespace 2 executables, they'll likely crash at some point or other. To prevent this, do the following:
Move the mediaVPs to a mod dir
You can take advantage of the SCP's -mod feature and move the mediaVPs to a folder inside your main Freespace 2 folder; this folder can be named anything you like, such as "mediavps". However, whenever you run Freespace 2, you must remember to select that folder as the current mod. If you want to play another mod, you must make use of the SCP's multiple mod feature.
Save any existing pilot files
Fs2_open upgraded the pilot files to allow for better mod handling in version 3.6.5. To prevent double entries from showing up, a new, upgraded version of the pilot file is created, and then the old one is deleted. To save your progress, copy all *.plr, *.csg, and *.css files that start with your pilot name. Then, rename the copies so that they're in the form of <your name>_scp. For example, my player file would be called "WMCoolmon_scp.plr". Then, only use the "_scp" versions when running fs2_open.
It's recommended you back up the originals as well, in case you accidentally click on the non-SCP version while in the SCP. (It should warn you that it's going to destructively convert them, however.)
