===< FREESPACE PORT TO FREESPACE 2 >===
        Version 3.7.0  7/1/2022        
     http://fsport.hard-light.net/     
=======================================

=< 0. CONTENTS >=

0.  Contents
1.  Introduction
2.  File Contents
3.  Installation - FS2 Retail
4.  Installation - FS Open
5.  Multiplayer
6.  Converting FS1 Missions
7.  Common problems and their solutions
8.  Essential resources
9.  Version History
10. Legal disclaimer

=< 1. INTRODUCTION >=

The FreeSpace Port is a mod for FreeSpace 2 that allows you to play the original Great War and Silent Threat campaigns in the newer FS2 engine, as well as specific user-made campaigns such as Silent Threat: Reborn.  This version of the Port was specifically designed to be compatible with retail FreeSpace while still taking advantage of the additional features in FreeSpace Open.  To take full advantage of the experience, we recommend using the latest version of FreeSpace Open.

Please also note that, as a consequence of removing the FS2 ships and weapons, you will not be able to play the main FreeSpace 2 campaign with the Port installed.  Instead, use the Campaign Room to select a FSPort-compatible campaign.  If you've never played the Port before, start with "The Main FreeSpace Campaign" to learn the story of the Great War.

=< 2. FILE CONTENTS >=

README.TXT         - This file.
FSPORT.BMP         - Launcher graphic; FSOpen only.
MOD.INI            - Launcher configuration settings; FSOpen only.
FSPORT3_6.VP       - Essential files to play; REQUIRED.
FSPORT-MISSIONS.VP - The FreeSpace Port missions and campaigns; REQUIRED.
ODEON_FS1.VP       - OGG Vorbis cutscenes; FSOpen only.
SPARKY_HI_FS1.VP   - High-resolution interface art; REQUIRED to play in 1024x768 or higher.
STU_FS1.VP         - Voices for The Great War and Silent Threat campaigns.
TANGO_FS1.VP       - Command Briefing animations.
TANGO_HI#_FS1.VP   - High resolution Command Briefing animations (1-5); FSOpen only.
WARBLE_FS1.VP      - Music files; FSOpen only.

=< 3. INSTALLATION - FS2 RETAIL >=

You must have retail FreeSpace 2 installed.  Unpack the 'FSPort Retail' package to your FreeSpace2 directory.  It is STRONGLY RECOMMENDED you make a new pilot to play; use the Clone option to preserve your previous settings and keymappings.  Go to the Campaign Room to select a FreeSpace Port campaign and you're ready to play!
To return to the FS2 campaign, run DisableFSPort.bat.  To turn FSPort back on, run EnableFSPort.bat.  To remove the mod, run RemoveFSPort.bat.

=< 4. INSTALLATION - FS OPEN >=

You must have retail FreeSpace 2 installed.  Delete, move, or rename your current FSPort and FSPort MediaVP directories.  Unpack the 'FSPort Complete' package into your FS2 directory, and it should create new subfolders for FSPort and FSPort-mediavps.  Then select either of those folders from the MOD tab of the Launcher.
If you are using the FSPort Media VPs, be sure that you have the official FreeSpace Upgrade Project 3.6.12 MediaVPs installed in 'mediavps_3612' and you're using FreeSpace Open 3.6.12 Final or newer.

=< 5. MULTIPLAYER >=

FreeSpace Port has full support for multiplayer matchmaking through FS2netD.  Please see the Essential Resources at the end of this document for help.  Note that there is currently no built-in mod filter for joining games, so make sure all players are running FSPort before you launch the mission!

=< 6. CONVERTING FS1 MISSIONS >=

Many classic campaigns such as Awakenings, Destiny of Peace, and Cardinal Spear have been ported over and can be downloaded from the FreeSpace Port website or other FS2 modding destinations.  If you've FREDded or downloaded any other missions for FreeSpace 1, it's quite simple to convert them to run on FreeSpace 2 using the Port.  Follow these steps.

1) Download and run a recent version of FRED2 Open.  Any version including and after 3.6.9 should work.
2) Select File->Import->FS1 Misson.  Select the mission or missions you want to import and the folder where you want to save them.  The conversion will take a short time (usually only a few seconds, but longer if you're doing several missions at once) so if you get a "This program is not responding" message, ignore it.

That's usually it!  If you get any "ship class not found" messages, you may have converted a mission in which the class names are slightly different in the Port.  For example, missions which used the weakened Poseidon now use a regular Poseidon with reduced hull and subsystem integrity.  The easiest way to fix this is to replace the ship class name in the original mission and reconvert using the steps above.  For additional help, please contact the FreeSpace Campaign Restoration Project (FSCRP) and post your mission there.

=< 7. COMMON PROBLEMS AND THEIR SOLUTIONS >=

Q: When I start FreeSpace, it crashes with the error "Error: Could not load in main hall mask '2_MainHall_Galatea-m'!"
A: You're trying to play in 1024x768 mode (or higher) without having downloaded the 1024x768 interface art.  (See the introduction at the beginning of this readme.)  Download sparky_hi_fs1 and try again.

Q: I don't see "The Main FreeSpace Campaign" or "Silent Threat" in the campaign room.
A: You might not have downloaded the mission pack.  (See the introduction at the beginning of this readme.)  Download fsport-missions and try again.

Q: When I start a campaign, it crashes with an error about missing ships or weapons.
A: New pilots by default attempt to load the FreeSpace 2 campaign, or you may have selected an incompatible campaign; be sure to visit the Campaign Room first and select a FSPort-compatible campaign (See the introduction at the beginning of this readme.)  If you've selected a FSPort-compatible campaign and are still getting this error, MAKE SURE YOU DON'T HAVE ANY OTHER CONFLICTING MODS INSTALLED.  If you are definitely using a campaign made for FSPort, it might not be updated to use the latest version; contact the FSPort team to request an upgrade.

Q: The ship listing in the Tech Room displays the wrong ships.
A: The best solution is to create a new pilot from the Pilot Select screen when you first start FreeSpace 2 (cloning your current pilot won't work).  This will reset the tech room so that the proper ships appear.

Q: Whenever I click on the weapons database, the game crashes.
A: This is a bug in retail FS2.  You can either use FS Open or visit the Port website for data on all the new weapons.

Q: I don't get any FreeSpace 1 music, everything is the same old FS2 music.  What gives?
A: Retail FS2 will use FS2 music.  You will need FS Open and the Music Pack to hear FS1 music.

Q: I installed (the Media VPs / Silent Threat: Reborn / Cardinal Spear) and...
A: Please see the documentation for those mods.

=< 8. ESSENTIAL RESOURCES >=

FreeSpace Port website - Updated infrequently, but a useful hub for downloads and more information.
http://fsport.hard-light.net/website/ 

--FreeSpace Port forum - Very active and monitored daily by the creators.  If you're really stumped, post here and we'll help you out personally.
--http://www.hard-light.net/forums/index.php/board,39.0.html

Knossos - The easiest and fastest way to get started with FreeSpace mods.
http://www.fsnebula.org/

FreeSpace Open Installer - The legacy wizard-style installer for FreeSpace mods.
http://www.fsoinstaller.com/

FreeSpace Source Code Project - Development of the source code to bring it up to date.
http://scp.indiegames.us/

--Multiplayer Portal - All you need to get started with playing FSOpen online.
--http://www.hard-light.net/wiki/index.php/Portal:Multiplayer

--FreeSpace Upgrade Project - Dedicated to maximizing the graphical experience of FreeSpace 2.
--http://www.hard-light.net/forums/index.php/board,120.0.html 

--FreeSpace Port Upgrade Project - Dedicated to maximizing the graphical experience of the FreeSpace Port.
--http://www.hard-light.net/forums/index.php/board,170.0.html 

=< 9. VERSION HISTORY >=

Updates in 3.7.0:
--Fix MediaVP compatibility by syncing FSPort MediaVP versions
--Update the French translation, thanks to Achille
--Attempt to fix UTF-8 compatibility
--Update the traitor.tbl debriefing text for the Vasudan persona
--Update game_settings.tbl version-specific commenting
--Use distance-ship-subsystem for the "enter the docking bay" directive in Playing Judas
--Don't automatically target turrets when targeting a ship (use FSO flag to restore FS1 behavior)

Updates in 3.6.9:
--Improve version compatibility via version-specific commenting
--Match retail docked speed in Secret Recovery
--Make the jump node flicker and disappear in The End
--Fix some briefing icons

Updates in 3.6.8:
--Fix the subspace node model
--Remove an unused weapon point on the low-poly Vasudan probe
--Fix a parsing error in weapons.tbl

Updates in 3.6.1-7:
--Various attempts to make FSPort work correctly with UTF-8.  Finally changed Crème Brûlée to Creme Brulee to squash character encoding conflicts.

Updates in 3.6:
--New FSPort MediaVP organization.  Most assets are now in the standard MediaVPs, with the FSPort MediaVPs handling tables and configuration
--All Orions in the third-party Silent Threat missions have nameplates when run with the FSPort MediaVPs
--Added Galemp's Vasudan Probe model
--SCP enhancements to more closely reproduce FS1 scanning in "Playing Judas"
--Put the Vasudan multiplayer campaign back in the Vasudan main hall
--Fix engine sounds for some ships
--Miscellaneous bugfixes

Updates in 3.5:
--Campaigns now use mjn.mixael's enhanced main halls when the optional main hall pack is present
--Added mjn.mixael's rerendered FS1 medals to the FSPort MediaVPs
--Added updated versions of Dan Wentz's remixed FS1 music tracks to the FSPort MediaVPs
--Various other compatibility updates for MediaVPs 2014
--Translation support for French, German, Italian, Polish, and Spanish, using the original FS1 language packs
--Re-added the "big blast" Faustus and the GTS Centaur#Charon, with associated mission updates including support in sm2-07a
--The background in sm3-10a is now based on actual astronomical data from 2335-03-30 22:01:16 UTC
--Miscellaneous bugfixes

Updates in 3.4:
--Lots of table, and interface fixes
--Shivan craft now use Shivan variants of secondary weapons
--Add the SF Manticore to the tech database in the main campaign
--The Taranis and Ramses now attack each other properly in sm1-09
--Delta wing now sends an update message in sm2-07
--Miscellaneous other fixes of mission and compatibility bugs
--Conversion of TGA files to DDS
--Additional HTL models
--Dan Wentz's remixed FS1 soundtrack
--HUD fixes for FSO
--Etc.

Updates in 3.3:
--Compatibility and stability updates for FSOpen and the MediaVPs.
--All sorts of awesome extra enhancements from mjn.mixael:
----All cbanims recreated in hi-res.
----Typhon and Hades in high poly.
----Many POFs fixed/enhanced/replaced.
----All nameplates fixed.
----3.6.13 compatible HUD added.
----Many textures enhanced/replaced.
----Missions bugfixed.
----All primary and secondary weapons have weapon select POFs.
----Etc...
--A bunch of other stuff we forgot.

Updates in 3.2:
--Added additional dockpoints for the Faustus, Chronos, and Amazon Advanced for better compatibility with ST:R.
--PVSC Imhotep and Vasudan Asteroid Base models receive some cosmetic and performance updates.
--Created new models and interface art for all the remaining player weapons.
--Replaced briefing, ship, and weapon icons with classic style icons.
--Select cutscenes remastered courtesy of mjn.mixael and IceyJones.
--Select Command Briefing animations remastered courtesy of mjn.mixael and Galemp.
--Operation Templar ported to single player to be chronologically accurate.  FSPort weapons are now used.
--Re-added Prometheus R, Akheton SDG, and Flak guns for Templar.
--Asteroid field background enabled for missions where appropriate.
--Additional multiplayer dogfight missions included.
--Miscellaneous bugfixes, enhancements, and tweaks to the original missions.
--Many compatibility updates with FS Open 3.6.12 and MediaVPs 3.6.12.

Updates in 3.1.2:
--Disabled support in sm2-07a so that the Charon won't be distracted.
--Removed orders for the four transports in sm2-06a.
--Fixed the transparency and relative sizes of the bitmaps in sm3-10a.
--Added afterburner trails to the two SF Dragon variants.

Updates in 3.1.1:
--A ton of minor bugfixes.

Updates in 3.1:
--Added cbanis for the PVN and HOL, based on the FS2 tech cbanis.
--Added a GTI cbani and squad logo, based on the logo created for ST:R.
--Added a GTSC Faustus cbani, adapted from the GTSC Einstein cbani.
--Added the Prometheus A and Volz cannons and the Serkr warhead.
--Added TGA versions of the preload screens.
--Restored the FS1 speed behavior for docked objects (SCP).
--Restored the weapon tech room animations.
--Fixed reversed normals on the Athena, Amun, and Hunter models.
--Fixed dockpoints on several models.
--Fixed debriefing personas for campaigns that don't use +Debriefing Persona Index.
--Added a missing subsystem (fighterbay03) to the Karnak entry in ships.tbl.
--Added the FS1 cutscenes.tbl.
--Tweaked subsystem strengths on the Hades.
--Tweaked several ship scores.
--Tweaked the GTF Angel's shields and hitpoints.
--Added afterburner trails and turret angle fixes (SCP).
--Added destroyable versions of the navbuoys.
--Added a cargo version of the Karnak reactor.
--Added a TBM to revert the retextured models back to regular models with texture replacement (SCP).
--Ensured all fighters with allowed Interceptors and Hornets are allowed their #Weak equivalents.
--Fixed the "oops" persona messages to be applicable for any sender.
--Restored the Hades to its canonical hitpoint value of 800,000.
--Removed an incorrect frame in head-TP7b.ani.
--Fixed the Havoc missile by adding back the missing Shrapnel entry.
--Allowed the new Vasudan weapons on the existing Terran and Vasudan ships.
--Removed Cardinal Spear spoilers from the PVI Karnak table entry.
--Added approximate MOI values for several models.
--Added FS1 interface art for hi-res.
--Added all the FS1 interface sounds.
--Redid the hi-res ssani's in FS1 style.
--Added Vasudan personas for Command and the support ship.
--Added HOL textures for the PVB Sekhmet.
--Added the remaining canonical (between FS1 and ST:R) Orion variants.

Updates in 3.0.4:
--Updated the music table to work with the improved FS1 music code (SCP).
--Tweaked several ship class names to properly use the "ship copy" pattern.
--Removed stars.tbl so that Lightspeed's backgrounds will be used if present (SCP).

Updates in 3.0.3:
--Fixed the crash caused by incorrect filenames for some interface art.
--Added the Terran Command traitor debriefing (for sm2-06a).

Updates in 3.0.2:
--Fixed the crash caused by the main hall referencing an invalid sound index.

Updates in 3.0.1:
--Fixed the crash caused by certain Orion nameplates exceeding the texture filename limit.

Updates in 3.0:
--Overhauled the Port to use the FS1 tables, including ships, weapons, sounds, and main halls.
--Added the revised and enhanced FS1 music table (SCP).
--Added the FS1 personas.
--Added the FS1 ranks (SCP) and medals.
--Reconverted the FS1 missions using the import feature in FRED2 Open.
--Restored the FS1 shockwave behavior (SCP).
--Added the following ships:
----GTF Angel (Venom/Woomeister)
----GTT Hunter (Zarathud)
----GTI Polaris Extension (Dark)
----GTI Polaris Pylon (Dark)
----GTSC Faustus (medical) (Dark)
----GTFr Chronos (medical) (Dark)
----TAC 1 (medical) (Dark)
----GTT Elysium (medical) (Dark)
----PVF Ulysses
----PVB Sekhmet
----PVSC Imhotep (Ryx)
----PVI Shah Extension (Dark)
----PVI Shah Pylon (Dark)
----SF Gorgon (Dark)
----SB Nahema
----Vasudan NavBuoy (Dark)
----Terran Probe (Dark)
----Vasudan Probe
----Terran Asteroid Base
----Vasudan Asteroid Base (Dark)

Updates in 2.3:
--Fixed a few more crash bugs.
--Fixed a bunch of mission bugs in both the FS1 and FS2 campaigns.
--Miscellaneous other small fixes.

Updates in 2.2c:
--Fixed the out-of-bounds game sound indexes that were causing crashes.
--Rebalanced and fixed bugs in some missions.
--Fixed the conflicts between Cyclops and Cyclops#short.

Updates in 2.2b:
--Port reorganized by splitting into three VP files: the essential files, the hi-res interface art, and the hi-res texture maps.  These can all be downloaded from the FSPort downloads page.

Updates in 2.2:
--A cleaner, ultra-efficient ships.tbl now accepts all tech room descriptions.
--New animated FS2-style ship selection interface art!  Wow!
--Selected engine sound effects from FS1 integrated.
--A remodeled PVI Karnak with better LODs and cleaner geometry.
--The ever-present bug fixes and enhancements to the original campaign.

Updates in 2.1:
--Fixed a bunch of table errors.
--Added a new splash screen.
--Fixed glowmaps for the Athena and Fenris.
--Enhanced multiplayer support with Towani's dogfight weapons.
--The Amun, Anubis and Athena models are now more stable.
--Dozens of new briefing icons by Black Wolf!  Please note the following:
----The Large Ship icon is now the Faustus science cruiser
----The Shivan Support Ship icon is now the Demon
--A much nicer version of the pilot select screen.
--Slight changes to the FS2 missions Into the Lion's Den, Slaying Ravana, and Clash of the Titans II.
--Lots of mission fixes in the original ported campaign.
--FS1 subspace POFs included.  Subspace looks much nicer now; no more 'rings.'
--Ancients cutscenes now included in the ported campaign file.
--All instances of the Vasudan Light Laser have been renamed to the VLL-9 Laser, so it doesn't spill over the HUD.
--Tweaked the Huge laser turrets, the Megafunk turret, the VLL, the Havoc, the Unknown Bomb, and the Unknown Megabomb.
--Faustus model modified so that anything towing it goes forwards.
--GTC Leviathan skin hue slightly modified, to differentiate it from the Fenris.
--New Ancients cbanim, borrowed from one of Setekh's renders.  I'm sure he won't mind.
--Interface art for the SF Dragon (Terrans) is now complete, thanks to Sesquipedalian.
--Fused Karnak is now included.
--Squad logo added for the Vasudan Imperium.
--Asteroid-field-debris has been reskinned.
--Pilot images from FS1 now included. 

Updates in 2.0:
--Hi-res FS1 maps included - not all of them, just the ones at a higher res than the FS2 versions.
--All Terran and Vasudan fighters and bombers now have squadron insignias.
--Brand spanking new weapon interface art in the FS2 style.
--FS1 weapons now use the FS1 sound effects.
--Tables stabilized by squeezing under the 130 ship limit.
--Changed the Hades to have five engines instead of one.
--Subspace palette fix.
--New pilot selection screen.
--Fixed Clash of the Titans II bug caused by renaming the Bastion's table entry.
--Still more bug fixes in the original campaign. 
--Shielded Lucifer (by DTP) and corresponding HUD icon (by Sesquipedalian) added.
--Silent Threat converted (badly) to FS2.

Updates in 1.5:
--Fixed hitpoint values for most of the imported ships, including nearly doubling the Athena's shields and armor.
--Karnak now has dock points, fighterbays, and turret paths, thanks to DTP.
--Weapon animations added for those who don't have FreeSpace.  Only one weapon table is needed now.
--Fixed the turrets on the Amun.
--Added credits to Act III, mission 10.
--Fixed a few small bugs in some of the missions.
--Added transcripts of the Ancients cutscenes to the campaign.
--Added an icon for the Karnak installation, and edited the icons table to accommodate it.

Original release 1.0:
--All FreeSpace ships and weapons added to the FS2 tables.  FS1 to FS2 model conversions provided by Dark.
--Main FreeSpace campaign converted to FS2.
--PVI Karnak, Railgun, Fang, Barracuda and Havoc added for use in future campaigns.
--Earth background added for use in the final mission.

=< 10. LEGAL DISCLAIMER >=

All original FreeSpace material included herein is copyright 1998-1999 Volition, Inc., Interplay, and THQ.  Ported with permission to FreeSpace 2 by Peter Oliver (Galemp) and Ian Warfield (Goober5000).  You may use these files for your own missions, campaigns, and mods on a no-cost non-commercial basis with attribution.  Hosting provided by Hard Light Productions (http://www.hard-light.net/)  No Vasudans were harmed in the making of this Port.