FreeSpace Wiki - User contributions [en]

Command-Line Reference

2006-10-09T18:41:56Z

Martellato: Added standalone server notes

==Launcher Flags==
The following command-line options can be chosen from the launcher.
===Graphics===
====-spec====
Enables specular mapping. Only polygons mapped with textures for which a shinemap exists will recieve specular mapping; no attempt is made to generate spec maps where they do not exist. Specular maps are specified with the base map name plus "-shine" (i.e. TCov3A-shine.pcx).
====-env====
Enables environment mapping. Environment mapping intensity will be determined from the intensity of specular maps. At the time of this writing (build 3.6.9 RC7), environment mapping only works when the video mode is OpenGL. [[Installing_fs2_open#Video setup|See Video setup.]]

====-glow====
Enables glowmapping. Only polygons mapped with textures for which a glowmap exists will be glowmapped. Glow maps are specified with the base map name plus "-glow" (i.e. TCov4A-glow.pcx)

====-jpgtga====
Enables the use of TGA and JPG file formats for image files. If a ship is showing up partially invisible, select this option.
====-pcx32====
'''WARNING - HIGH MEMORY USAGE'''

Enables PCX files to be loaded into 32-bit memory. This will not imporove the rendering of any ships in-game, and is usually more of a burden on performance than is worthwhile. Use at your own risk. Removed from launcher options after 3.6.7.

====-cell====
Enables cell shading. This will make graphics appear more "cartoonish". For use with media in mv_cell.vp. Not considered a standard enhancement.
====-mipmap====
Enables mipmapping.

====-nomotiondebris====
Disables motion debris.
====-2d_poof====
Applies nebula poofs in 2d, effectively preventing them from forming intersections with ships.
====-noscalevid====
Disables scaling of video clips.
====-missile_lighting====
Applys lighting to missiles.
====-rlm====
'''Obsolete Argument'''


Enables more accurate lighting model for OpenGL mode. Always on in current builds, so this command-line option has been removed.

----

===Game Speed===
====-img2dds====
Converts all images to DDS (compressed) format. Decreases memory usage but potentially reduces image quality.
====-no_vsync====
Disables vertical sync.
====-cache_bitmaps====
Caches bitmaps between missions, which will ideally reduce the load-time from one mission to another.

----

===HUD===
====-dualscanlines====
Adds a second pair of scanning lines to the target window when scanning an object.
====-targetinfo====
Displays target info, such as name and class, beside the targeted object.
====-orbradar====
Enables 3D radar (the Orb). 3D radar will replace the standard 2D version.
====-ballistic_gauge====
Adds an ammo gauge to the HUD when armed with a ballistic weapon.
====-rearm_timer====
Displays time remaining until rearm and repair from a support ship is complete.

----

===Gameplay===
====-smart_shields====
Enables "smart" shield recharging. Shield recharge is distributed to the most damaged shield quadrant instead of being distributed equally across the entire shield and be wasted when a quadrant is full.
====-ship_choice_3d====
Use ship and weapon models in ship selection and weapon loadout. Completely disables the standard ANI interface on those screens.
====-3dwarp====
Use full geometry for the subspace warp effect.
====-warp_flash====
Enable a flash at warp in and warp out.
====-UseNewAI====
Tells the game to use new AI routines. This argument alters mission balance and is not considered a standard feature.
====-tbp====
Enable feature set for The Babylon Project
====-wcsaga====
Enable feature set for The Wing Commander Saga

----

===Audio===
====-snd_preload====
Preload mission sounds. Useful in preventing game stuttering when sounds are played for the first time.
====-nosound====
Disables all sounds.
====-nomusic====
Disables music only.

----

===Multiplayer===
====-standalone====
Creates a standalone server.
====-startgame====
Once you launch and choose a pilot within the game, you will immediately have begun to host a game. This can be used in conjunction with several options to customize the game you create: -closed, -restricted, -password, -gamename, -allowabove, and -allowbelow. -startgame has no effect when -standalone is used.

See related: [[Command-Line_Reference#-closed|-closed]] [[Command-Line_Reference#-restricted|-restricted]] [[Command-Line_Reference#-password|-password]] [[Command-Line_Reference#-gamename|-gamename]] [[Command-Line_Reference#-allowabove|-allowabove]] [[Command-Line_Reference#-allowbelow|-allowbelow]]

====-closed====
Hosts a new game in a closed state, where no one can join until the in-game "Close" button is cleared. This only works when used in conjunction with -startgame. Cannot be used in conjunction with -restricted or -password.

See related: [[Command-Line_Reference#-startgame|-startgame]] [[Command-Line_Reference#-restricted|-restricted]] [[Command-Line_Reference#-password|-password]]

====-restricted====
Hosts a new game in a restricted state. The host is presented with option to accept or deny each client's request to join the game. This only works when used in conjunction with -startgame. Cannot be used in conjunction with -closed or -password.

See related: [[Command-Line_Reference#-startgame|-startgame]] [[Command-Line_Reference#-closed|-closed]] [[Command-Line_Reference#-password|-password]]

====-multilog====
Creates a log file with a summary of packets sent and received in multiplayer games. The file is saved as \data\multi.log within the active mod folder - or with main data folder if no mod is active.

====-clientdamage====
This feature is not available in current builds.

====-mpnoreturn====
Disables return to the flight deck screen after a mission completes.

----

===Troubleshooting===
====-fixbugs====
'''Obsolete Argument - Removed in builds after 3.6.7'''


Originally used to disable certain crashing behavior as a stop-gap measure. This feature is not available in current builds.
====-nocrash====
'''Obsolete Argument - Removed in builds after 3.6.7'''


Originally used to disable certain crashing behavior as a stop-gap measure. This feature is not available in current builds.
====-oldfire====
This feature is not available in current builds.

====-nohtl====
'''WARNING - VERY SLOW'''

Reverts to software rendering mode. Does this work any more?
====-no_set_gamma====
Disables the gamma settings in the options screen.
====-nomovies====
Disables all video playback.
====-noparseerrors====
Disables some parsing warnings and makes other parse errors non-fatal. Do not rely on this when creating new tables, the errors are there for a reason.
====-safeloading====
Loads missions the old way. Typically safer, but slower.
====-query_speech====
Determines if the current build includes text-to-speech.
====-d3d_bad_tsys====
Enable inefficient texture system.
====-novbo====
Disables OpenGL VBO.
====-noibx====
Disables IBX caching of model geometry data. This will dramatically increase load times, but will help troubleshoot a model if one is working incorrectly.
====-loadallweps====
Load all weapons, even those not used.

----

===Experimental===
====-alpha_env====
Enables alpha environment mapping. OpenGL only. Environment mapping intensity will be determined from the alpha channel of specular maps.
====-decals====
Enables damage decals.
====-ingame_join====
Enables ingame joining in multiplayer. FIXME: Host option?
====-tga16====
'''Obsolete Argument - Removed in builds after 3.6.7'''


Originally used to converts TGA images to 16-bits in order to reduce memory footprint (at the expense of image quality), superseded by ''-img2dds''.
----

===Development Tools===
====-fps====
Displays current frames per second.
====-pos====
Displays current position coordinates of camera.
====-window====
Runs the game in a window. No check to make sure that resolution is no higher than your desktop resolution, so be careful.
====-timerbar====
Displays a timing bar across the top of the screen. Timebar format varies by build.
====-stats====
Shows total and free physical memory, virtual memory and system pagefile.

====-coords====
Shows coordinates of the mouse cursor.
====-show_mem_usage====
Shows detailed RAM usage in HUD.

The meaning of the info displayed in the upper right corner is:

'''DYN''' = dynamic memory, basically anything that's been allocated by the vm_* memory functions. This does NOT indicate total memory usage but does account for most of it.

'''POF''' = model memory, how much memory is being used by models (does not include textures)

'''C-BMP, BMP''' = bmpman memory, how much is used by the textures/images that are loaded. C-BMP means that you are using -cache_bitmaps and it will try to keep textures in memory between level loads and as the new level is loading it will keep what it needs and unload what it doesn't. Can greatly increase level loading speed, but does so at the cost of memory between level loads. This does not increase overall memory usage though, only during the loading screen. BMP means that it is not cached and all textures are unloaded from memory at the start of level load and all needed textures are then loaded from the disk again.

'''S-RAM''' = sound memory, how much is used by the sounds loaded in memory at the time. This counts static sounds only (from sounds.tbl, etc.) and not streaming sounds (music, voices, briefing stuff, etc).

'''V-RAM''' = approximate memory usage of video textures. This is not mean that your card has this much memory and can report higher numbers that your card actually has memory. For OpenGL it also includes some of the geometry data, but this number does not reflect the total memory that your video card is using. It only reports how much data the game has purposefully loaded into API memory (meaning it could be in system memory, video card memory, or AGP memory).

''(It only works with debug builds, not with release builds).''

====-pofspew====
'''''What does this do?'''''
====-tablecrcs====
'''''What does this do?'''''
====-missioncrcs====
'''''What does this do?'''''
====-dis_collisions====
Disables all collisions.
====-dis_weapons====
Disables weapons rendering.
====-output_sexps====
Outputs SEXPs to sexps.html.
====-output_scripting====
Outputs scripting to scripting.html.
====-nograb====
Unix only. Disables focus grabbing in a window.
==Other==
The following options are not available as checkboxes in the launcher. Many require parameters, which follow the flag seperated by a space. The prototype for use in this case is "-option argument"
===Graphics===
====-ambient_factor====

This must be entered into the "Custom flags" field. This is a multiplier applied to the intensity of ambient lighting. Ambient light is lighting applied to all parts of a ship. FS2's standard value is 120. Try 75 for a good and realistic looking value. However, that is relative.

====-spec_exp====

This must be used with the -spec command line parameter and must be entered into the "Custom flags" field. Adjusts the size of the shiny spot on ships. Higher number mean smaller spots. Default is 16, however 11 is recommended. However, that is relative.

====-spec_point====

This must be used with the -spec command line parameter and must be entered into the
"Custom flags" field. Adjusts how much laser weapons contribute to specular highlights. Higher number mean greater contributions. Default is 1.0, however 0.6 is recommended. However, that is relative.

====-spec_static====

This must be used with the -spec command line parameter and must be entered into the "Custom flags" field. Adjusts how much suns contribute to specular highlights. Higher numbers mean a greater contribution. Default is 1.0, however is 0.8 recommended. However, that is relative.

====-spec_tube====

This must be used with the -spec command line parameter and must be entered into the "Custom flags" field. Adjusts how much Beam Weapons contribute to specular highlights. Higher numbers mean a greater contribution. Default is 1.0, however 0.4 is recommended. However, that is relative.

====-clipdist====
Changes the distance from the viewpoint for the near-clipping plane.

Takes one argument decimal specifying the distance to the near-clipping plane.

----

===Gameplay===
====-mod====

Specifies in which folders inside Freespace2 directory, the game looks for all the game data (models, missions, textures, tables, ...). Retail version only looks inside ''Freespace2/data/'' structure and ''Freespace2/vp archives''.

This flag allows installing several different mods that modify retail behaviour, and switching between them without needing to erase files or having undesired cross effects. Each mod should be installed in its own folder.

It takes one argument string: the chain of names of the used directories. Comma (''',''') must be used as separator. In this way, '''-mod dir1,dir2,dir3,...,dirx''' causes the game to use the following directory precedence:

#Freespace2/dir1/
#Freespace2/dir2/
#Freespace2/dir3/
# ... (the rest of the typed directories) ...
#Freespace2/dirx/
#Freespace2/

:::Please note. Freespace Open doesn't like spaces in directories (in the full path) so do not install the game within ''Program Files/Freespace2'' or ''Games/Freespace 2'' and, of course, do not use spaces within mod directories (''dir1'' is OK but ''dir 1'' isn't).

This flag can be indirectly set, (and it is normally set), through Launcher MOD tab and mod.ini file. Within this Launcher tab you can select one directory, (let's call it ''moddir''), so the flag is at least set to '''-mod moddir'''. If ''Freespace2/moddir/mod.ini'' exists, (its format must be plain text), it will be read and, inside it, the following section and lines can be used to modify the -mod flag too:

: [multimod] PrimaryList = Pri1,Pri2,...(the rest of desired directories)...,Prix; SecondaryList = Sec1,Sec2,...(the rest of desired directories)...,Secx;

(Please note the ending semicolon (;) in each list line). With these lines the following flag would be built:
: '''-mod Pri1,Pri2,...,Prix,moddir,Sec1,Sec2,...,Secx'''

If primary or secondary folders aren't used, their respective line can be erased or it can be typed as ''xxxxxxList = ;''.

::: '''''PLEASE NOTE''': '''Launcher v 5.4''', or later, '''must be used'''. Earlier versions had some bugs that would cause the previous explanation about mod.ini fail.''

::: The most common use of mod.ini and SecondaryList is sharing resources between mods. And the best example is the enhaced media vps from SCP crew. Most of the people install them in a folder called ''mediavps'' inside ''Freespace2''. In this way when running retail FS2 they do not interfere with this original game version that doesn't use this -mod flag feature. When using FS2_Open but without mods, you just need to select ''mediavps'' in Launcher MOD tab to use them. And if you want to enjoy that enhacements while playing any 'real' mod, you just need to put a mod.ini file inside its ''moddir'' with at least a ''SecondaryList = mediavps;'' line.

Inside each directory, data precedence is the following:

#Individual files located in ''Current_dir/data/'' subdir structure.
#Files located inside vp archives. (These vp archives are 'similar' to zip archives, they just contain other files and folders. Moreover, files have to be stored using the same ''data/'' structure used outside it). Vp archives are read in alphabetical order so aaa.vp files have higher priority than aab.vp files and so on.

The highest priority file overrides the rest of them. In this way, if you have a ''Mission.fs2'' inside ''Freespace2/Pri1/data/missions/'' it doesn't matter how this ''Mission.fs2'' is inside ''Freespace2/Pri1/aaa.vp'', ''Freespace2/Pri1/aab.vp'', ... or ''Freespace2/data/missions/''. This data precedence allows the user to quickly replace old files by corrected or enhaced ones adding them in a higher priority place.

As derived from explanation, the exact names for directories or vp archives are actually irrelevant. It only matters the directory order inside -mod flag argument and the alphabetical order for vp archives inside each used directory.

:'''Additional notes'''

# This flag is also used by FRED. So if there is special mod info, (like backgrounds maps, ship models or whatever), it must be typed, (''Fred2_Open_r.exe -MOD whatever''), or FRED won't be able to use it. No Launcher MOD tab available for this use. 
# Be careful while typing the directory names in the flag argument or inside mod.ini files. The program doesn't check if the typed directories exist. If they do not exist, they are just ignored. No warnings, no errors, no messages at all.

====-fov====
Specifies the Field of View for the player eyepoint.

Takes one argument decimal specifying the angle of the viewing cone in radians, from 0 to 2*pi

You can set the cone of view making things look bigger/smaller. The problem with this is that if you choose a small FOV, you will have a squashed look on the edges of your screen - stretched edges with a too high FOV. It is recommended to change the FOV as FS2 normally has some perspective distortion at the screen edges (FOV too high). Set the FOV to something like 0.39 - it will fix the distortion problem, and (as a nice side effect) will make everything look bigger and more realistic scale-wise. The default is 0.75, if you go higher, you'll get the fish-eye effect. Feel free to experiment. This must be entered into the "Custom flags" field

''Because of an active bug, FOV can misalign target boxes, effects, etc. Please check [http://lore.maxgaming.net/~scp/mantis/bug_view_advanced_page.php?bug_id=0000083 Mantis bug 083 status]if you are going to change the default value.''

----

===Multiplayer===
====-gamename====
Specifies the name of the game to be created by the host. This only works when used in conjunction with -startgame.

Takes one argument string, the name to be assigned to the game being created.

This argument does nothing when used with -standalone. To set the name for a standalone server, see [[Multiplayer(Main)#Standalone Servers|Standalone Servers]].

See related:   [[Command-Line_Reference#-startgame|-startgame]]   [[Multiplayer(Main)#Standalone Servers|Standalone Servers]]

====-password====
Specifies the password for a stand-alone server. This only works when used in conjunction with -startgame. Cannot be used in conjunction with -closed or -restricted.

Takes one argument string, the required password for the game being created.

See related: [[Command-Line_Reference#-startgame|-startgame]] [[Command-Line_Reference#-closed|-closed]] [[Command-Line_Reference#-restricted|-restricted]]

====-allowabove====
Specifies a player's minimum rank for joining a game. This only works when used in conjunction with -startgame.

Takes one argument integer, the points ranking above which a player must be to enter the game.

See related: [[Command-Line_Reference#-startgame|-startgame]]

====-allowbelow====
Specifies a player's maximum rank for joining a game on a stand-alone server. This only works when used in conjunction with -startgame.

Takes one argument integer, the points ranking below which a player must be to enter the game.

See related: [[Command-Line_Reference#-startgame|-startgame]]

====-port====
Specifies the port on which to host a game or serve a stand-alone game.

Takes one argument integer, the port on which the host will listen for clients.

====-connect====
'''''What does this do?'''''

====-timeout====
'''''What does this do?'''''

[[Category:Lists]]
[[Category:Source Code Project]]

Multiplayer(Main)

2006-10-09T18:37:39Z

Martellato: Revised "Related" links

==FS2NetD - SCP Multiplayer==
FS2NetD is an online FS2 game tracker. It acts as a lobby for multiplayer games, and it tracks registered pilots and mission statistics. When PXO is slated to be back online in 2007, FS2NetD will go away.

Related: [[Getting Started with FS2netD]]   [[Logging On]] [[Category:Source Code Project]]

==Multiplay over TCP/IP==
FreeSpace 2 can also be played by connecting directly to a hosting game via their i.p. address.

==Standalone Servers==
A dedicated/standalone FreeSpace2 server can be run on the Windows platform. This is enabled with the [[Command-Line_Reference#-standalone|-standalone]] option.

Some options for the standalone server can be specified in the multi.cfg file located in your FreeSpace2\data\ directory. For example, this simple multi.cfg file gives a default game name for a standalone server of "Nova Cafe":
+name Nova Cafe

Related: [http://www.pxo.net/faq_fs2demo.cfm Information on multi.cfg] [[Sample multi.cfg file]]

Multiplayer(Main)

2006-10-09T18:36:11Z

Martellato: Revised "Related" links

==FS2NetD - SCP Multiplayer==
FS2NetD is an online FS2 game tracker. It acts as a lobby for multiplayer games, and it tracks registered pilots and mission statistics. When PXO is slated to be back online in 2007, FS2NetD will go away.
[[Getting Started with FS2netD]]
 [[Logging On]]

[[Category:Source Code Project]]

==Multiplay over TCP/IP==
FreeSpace 2 can also be played by connecting directly to a hosting game via their i.p. address.

==Standalone Servers==
A dedicated/standalone FreeSpace2 server can be run on the Windows platform. This is enabled with the [[Command-Line_Reference#-standalone|-standalone]] option.

Some options for the standalone server can be specified in the multi.cfg file located in your FreeSpace2\data\ directory. For example, this simple multi.cfg file gives a default game name for a standalone server of "Nova Cafe":
+name Nova Cafe

Related: [http://www.pxo.net/faq_fs2demo.cfm Information on multi.cfg] [[Sample multi.cfg file]]

Multiplayer(Main)

2006-10-09T18:33:40Z

Martellato: Revised "Related" links

==FS2NetD - SCP Multiplayer==
FS2NetD is an online FS2 game tracker. It acts as a lobby for multiplayer games, and it tracks registered pilots and mission statistics. When PXO is slated to be back online in 2007, FS2NetD will go away.
[[Getting Started with FS2netD]]
 [[Logging On]]

[[Category:Source Code Project]]

==Multiplay over TCP/IP==
FreeSpace 2 can also be played by connecting directly to a hosting game via their i.p. address.

==Standalone Servers==
A dedicated/standalone FreeSpace2 server can be run on the Windows platform. This is enabled with the [[Command-Line_Reference#-standalone|-standalone]] option.

Some options for the standalone server can be specified in the multi.cfg file located in your FreeSpace2\data\ directory. For example, this simple multi.cfg file gives a default game name for a standalone server of "Nova Cafe":
+name Nova Cafe

Related: [[http://www.pxo.net/faq_fs2demo.cfm Information on multi.cfg]] [[Sample multi.cfg file]]

Multiplayer(Main)

2006-10-09T18:28:58Z

Martellato: /* FS2NetD - SCP Multiplayer */

==FS2NetD - SCP Multiplayer==
FS2NetD is an online FS2 game tracker. It acts as a lobby for multiplayer games, and it tracks registered pilots and mission statistics. When PXO is slated to be back online in 2007, FS2NetD will go away.
[[Getting Started with FS2netD]]
 [[Logging On]]

[[Category:Source Code Project]]

==Multiplay over TCP/IP==
FreeSpace 2 can also be played by connecting directly to a hosting game via their i.p. address.

==Standalone Servers==
A dedicated/standalone FreeSpace2 server can be run on the Windows platform. This is enabled with the [[Command-Line_Reference#-standalone|-standalone]] option.

Some options for the standalone server can be specified in the multi.cfg file located in your FreeSpace2\data\ directory. For example, this simple multi.cfg file gives a default game name for a standalone server of "Nova Cafe":
+name Nova Cafe

Related: [[http://www.pxo.net/faq_fs2demo.cfm Information on multi.cfg]] [[media:multi.cfg|Sample multi.cfg file]]

Command-Line Reference

2006-09-25T06:40:10Z

Martellato: updated -startgame

==Launcher Flags==
The following command-line options can be chosen from the launcher.
===Graphics===
====-spec====
Enables specular mapping. Only polygons mapped with textures for which a shinemap exists will recieve specular mapping; no attempt is made to generate spec maps where they do not exist. Specular maps are specified with the base map name plus "-shine" (i.e. TCov3A-shine.pcx).
====-env====
Enables environment mapping. Environment mapping intensity will be determined from the intensity of specular maps. At the time of this writing (build 3.6.9 RC7), environment mapping only works when the video mode is OpenGL. [[Installing_fs2_open#Video setup|See Video setup.]]

====-glow====
Enables glowmapping. Only polygons mapped with textures for which a glowmap exists will be glowmapped. Glow maps are specified with the base map name plus "-glow" (i.e. TCov4A-glow.pcx)

====-jpgtga====
Enables the use of TGA and JPG file formats for image files. If a ship is showing up partially invisible, select this option.
====-pcx32====
'''WARNING - HIGH MEMORY USAGE'''

Enables PCX files to be loaded into 32-bit memory. This will not imporove the rendering of any ships in-game, and is usually more of a burden on performance than is worthwhile. Use at your own risk. Removed from launcher options after 3.6.7.

====-cell====
Enables cell shading. This will make graphics appear more "cartoonish". For use with media in mv_cell.vp. Not considered a standard enhancement.
====-mipmap====
Enables mipmapping.

====-nomotiondebris====
Disables motion debris.
====-2d_poof====
Applies nebula poofs in 2d, effectively preventing them from forming intersections with ships.
====-noscalevid====
Disables scaling of video clips.
====-missile_lighting====
Applys lighting to missiles.
====-rlm====
'''Obsolete Argument'''


Enables more accurate lighting model for OpenGL mode. Always on in current builds, so this command-line option has been removed.

----

===Game Speed===
====-img2dds====
Converts all images to DDS (compressed) format. Decreases memory usage but potentially reduces image quality.
====-no_vsync====
Disables vertical sync.
====-cache_bitmaps====
Caches bitmaps between missions, which will ideally reduce the load-time from one mission to another.

----

===HUD===
====-dualscanlines====
Adds a second pair of scanning lines to the target window when scanning an object.
====-targetinfo====
Displays target info, such as name and class, beside the targeted object.
====-orbradar====
Enables 3D radar (the Orb). 3D radar will replace the standard 2D version.
====-ballistic_gauge====
Adds an ammo gauge to the HUD when armed with a ballistic weapon.
====-rearm_timer====
Displays time remaining until rearm and repair from a support ship is complete.

----

===Gameplay===
====-smart_shields====
Enables "smart" shield recharging. Shield recharge is distributed to the most damaged shield quadrant instead of being distributed equally across the entire shield and be wasted when a quadrant is full.
====-ship_choice_3d====
Use ship and weapon models in ship selection and weapon loadout. Completely disables the standard ANI interface on those screens.
====-3dwarp====
Use full geometry for the subspace warp effect.
====-warp_flash====
Enable a flash at warp in and warp out.
====-UseNewAI====
Tells the game to use new AI routines. This argument alters mission balance and is not considered a standard feature.
====-tbp====
Enable feature set for The Babylon Project
====-wcsaga====
Enable feature set for The Wing Commander Saga

----

===Audio===
====-snd_preload====
Preload mission sounds. Useful in preventing game stuttering when sounds are played for the first time.
====-nosound====
Disables all sounds.
====-nomusic====
Disables music only.

----

===Multiplayer===
====-standalone====
Creates a standalone server.
====-startgame====
Once you launch and choose a pilot within the game, you will immediately have begun to host a game. This can be used in conjunction with several options to customize the game you create: -closed, -restricted, -password, -gamename, -allowabove, and -allowbelow. -startgame has no effect when -standalone is used.

See related: [[Command-Line_Reference#-closed|-closed]] [[Command-Line_Reference#-restricted|-restricted]] [[Command-Line_Reference#-password|-password]] [[Command-Line_Reference#-gamename|-gamename]] [[Command-Line_Reference#-allowabove|-allowabove]] [[Command-Line_Reference#-allowbelow|-allowbelow]]

====-closed====
Hosts a new game in a closed state, where no one can join until the in-game "Close" button is cleared. This only works when used in conjunction with -startgame. Cannot be used in conjunction with -restricted or -password.

See related: [[Command-Line_Reference#-startgame|-startgame]] [[Command-Line_Reference#-restricted|-restricted]] [[Command-Line_Reference#-password|-password]]

====-restricted====
Hosts a new game in a restricted state. The host is presented with option to accept or deny each client's request to join the game. This only works when used in conjunction with -startgame. Cannot be used in conjunction with -closed or -password.

See related: [[Command-Line_Reference#-startgame|-startgame]] [[Command-Line_Reference#-closed|-closed]] [[Command-Line_Reference#-password|-password]]

====-multilog====
Creates a log file with a summary of packets sent and received in multiplayer games. The file is saved as \data\multi.log within the active mod folder - or with main data folder if no mod is active.

====-clientdamage====
This feature is not available in current builds.

====-mpnoreturn====
Disables return to the flight deck screen after a mission completes.

----

===Troubleshooting===
====-fixbugs====
'''Obsolete Argument - Removed in builds after 3.6.7'''


Originally used to disable certain crashing behavior as a stop-gap measure. This feature is not available in current builds.
====-nocrash====
'''Obsolete Argument - Removed in builds after 3.6.7'''


Originally used to disable certain crashing behavior as a stop-gap measure. This feature is not available in current builds.
====-oldfire====
This feature is not available in current builds.

====-nohtl====
'''WARNING - VERY SLOW'''

Reverts to software rendering mode. Does this work any more?
====-no_set_gamma====
Disables the gamma settings in the options screen.
====-nomovies====
Disables all video playback.
====-noparseerrors====
Disables some parsing warnings and makes other parse errors non-fatal. Do not rely on this when creating new tables, the errors are there for a reason.
====-safeloading====
Loads missions the old way. Typically safer, but slower.
====-query_speech====
Determines if the current build includes text-to-speech.
====-d3d_bad_tsys====
Enable inefficient texture system.
====-novbo====
Disables OpenGL VBO.
====-noibx====
Disables IBX caching of model geometry data. This will dramatically increase load times, but will help troubleshoot a model if one is working incorrectly.
====-loadallweps====
Load all weapons, even those not used.

----

===Experimental===
====-alpha_env====
Enables alpha environment mapping. OpenGL only. Environment mapping intensity will be determined from the alpha channel of specular maps.
====-decals====
Enables damage decals.
====-ingame_join====
Enables ingame joining in multiplayer. FIXME: Host option?
====-tga16====
'''Obsolete Argument - Removed in builds after 3.6.7'''


Originally used to converts TGA images to 16-bits in order to reduce memory footprint (at the expense of image quality), superseded by ''-img2dds''.
----

===Development Tools===
====-fps====
Displays current frames per second.
====-pos====
Displays current position coordinates of camera.
====-window====
Runs the game in a window. No check to make sure that resolution is no higher than your desktop resolution, so be careful.
====-timerbar====
Displays a timing bar across the top of the screen. Timebar format varies by build.
====-stats====
Shows total and free physical memory, virtual memory and system pagefile.

====-coords====
Shows coordinates of the mouse cursor.
====-show_mem_usage====
Shows detailed RAM usage in HUD.

The meaning of the info displayed in the upper right corner is:

'''DYN''' = dynamic memory, basically anything that's been allocated by the vm_* memory functions. This does NOT indicate total memory usage but does account for most of it.

'''POF''' = model memory, how much memory is being used by models (does not include textures)

'''C-BMP, BMP''' = bmpman memory, how much is used by the textures/images that are loaded. C-BMP means that you are using -cache_bitmaps and it will try to keep textures in memory between level loads and as the new level is loading it will keep what it needs and unload what it doesn't. Can greatly increase level loading speed, but does so at the cost of memory between level loads. This does not increase overall memory usage though, only during the loading screen. BMP means that it is not cached and all textures are unloaded from memory at the start of level load and all needed textures are then loaded from the disk again.

'''S-RAM''' = sound memory, how much is used by the sounds loaded in memory at the time. This counts static sounds only (from sounds.tbl, etc.) and not streaming sounds (music, voices, briefing stuff, etc).

'''V-RAM''' = approximate memory usage of video textures. This is not mean that your card has this much memory and can report higher numbers that your card actually has memory. For OpenGL it also includes some of the geometry data, but this number does not reflect the total memory that your video card is using. It only reports how much data the game has purposefully loaded into API memory (meaning it could be in system memory, video card memory, or AGP memory).

''(It only works with debug builds, not with release builds).''

====-pofspew====
'''''What does this do?'''''
====-tablecrcs====
'''''What does this do?'''''
====-missioncrcs====
'''''What does this do?'''''
====-dis_collisions====
Disables all collisions.
====-dis_weapons====
Disables weapons rendering.
====-output_sexps====
Outputs SEXPs to sexps.html.
====-output_scripting====
Outputs scripting to scripting.html.
====-nograb====
Unix only. Disables focus grabbing in a window.
==Other==
The following options are not available as checkboxes in the launcher. Many require parameters, which follow the flag seperated by a space. The prototype for use in this case is "-option argument"
===Graphics===
====-ambient_factor====

This must be entered into the "Custom flags" field. This is a multiplier applied to the intensity of ambient lighting. Ambient light is lighting applied to all parts of a ship. FS2's standard value is 120. Try 75 for a good and realistic looking value. However, that is relative.

====-spec_exp====

This must be used with the -spec command line parameter and must be entered into the "Custom flags" field. Adjusts the size of the shiny spot on ships. Higher number mean smaller spots. Default is 16, however 11 is recommended. However, that is relative.

====-spec_point====

This must be used with the -spec command line parameter and must be entered into the
"Custom flags" field. Adjusts how much laser weapons contribute to specular highlights. Higher number mean greater contributions. Default is 1.0, however 0.6 is recommended. However, that is relative.

====-spec_static====

This must be used with the -spec command line parameter and must be entered into the "Custom flags" field. Adjusts how much suns contribute to specular highlights. Higher numbers mean a greater contribution. Default is 1.0, however is 0.8 recommended. However, that is relative.

====-spec_tube====

This must be used with the -spec command line parameter and must be entered into the "Custom flags" field. Adjusts how much Beam Weapons contribute to specular highlights. Higher numbers mean a greater contribution. Default is 1.0, however 0.4 is recommended. However, that is relative.

====-clipdist====
Changes the distance from the viewpoint for the near-clipping plane.

Takes one argument decimal specifying the distance to the near-clipping plane.

----

===Gameplay===
====-mod====

Specifies in which folders inside Freespace2 directory, the game looks for all the game data (models, missions, textures, tables, ...). Retail version only looks inside ''Freespace2/data/'' structure and ''Freespace2/vp archives''.

This flag allows installing several different mods that modify retail behaviour, and switching between them without needing to erase files or having undesired cross effects. Each mod should be installed in its own folder.

It takes one argument string: the chain of names of the used directories. Comma (''',''') must be used as separator. In this way, '''-mod dir1,dir2,dir3,...,dirx''' causes the game to use the following directory precedence:

#Freespace2/dir1/
#Freespace2/dir2/
#Freespace2/dir3/
# ... (the rest of the typed directories) ...
#Freespace2/dirx/
#Freespace2/

:::Please note. Freespace Open doesn't like spaces in directories (in the full path) so do not install the game within ''Program Files/Freespace2'' or ''Games/Freespace 2'' and, of course, do not use spaces within mod directories (''dir1'' is OK but ''dir 1'' isn't).

This flag can be indirectly set, (and it is normally set), through Launcher MOD tab and mod.ini file. Within this Launcher tab you can select one directory, (let's call it ''moddir''), so the flag is at least set to '''-mod moddir'''. If ''Freespace2/moddir/mod.ini'' exists, (its format must be plain text), it will be read and, inside it, the following section and lines can be used to modify the -mod flag too:

: [multimod] PrimaryList = Pri1,Pri2,...(the rest of desired directories)...,Prix; SecondaryList = Sec1,Sec2,...(the rest of desired directories)...,Secx;

(Please note the ending semicolon (;) in each list line). With these lines the following flag would be built:
: '''-mod Pri1,Pri2,...,Prix,moddir,Sec1,Sec2,...,Secx'''

If primary or secondary folders aren't used, their respective line can be erased or it can be typed as ''xxxxxxList = ;''.

::: '''''PLEASE NOTE''': '''Launcher v 5.4''', or later, '''must be used'''. Earlier versions had some bugs that would cause the previous explanation about mod.ini fail.''

::: The most common use of mod.ini and SecondaryList is sharing resources between mods. And the best example is the enhaced media vps from SCP crew. Most of the people install them in a folder called ''mediavps'' inside ''Freespace2''. In this way when running retail FS2 they do not interfere with this original game version that doesn't use this -mod flag feature. When using FS2_Open but without mods, you just need to select ''mediavps'' in Launcher MOD tab to use them. And if you want to enjoy that enhacements while playing any 'real' mod, you just need to put a mod.ini file inside its ''moddir'' with at least a ''SecondaryList = mediavps;'' line.

Inside each directory, data precedence is the following:

#Individual files located in ''Current_dir/data/'' subdir structure.
#Files located inside vp archives. (These vp archives are 'similar' to zip archives, they just contain other files and folders. Moreover, files have to be stored using the same ''data/'' structure used outside it). Vp archives are read in alphabetical order so aaa.vp files have higher priority than aab.vp files and so on.

The highest priority file overrides the rest of them. In this way, if you have a ''Mission.fs2'' inside ''Freespace2/Pri1/data/missions/'' it doesn't matter how this ''Mission.fs2'' is inside ''Freespace2/Pri1/aaa.vp'', ''Freespace2/Pri1/aab.vp'', ... or ''Freespace2/data/missions/''. This data precedence allows the user to quickly replace old files by corrected or enhaced ones adding them in a higher priority place.

As derived from explanation, the exact names for directories or vp archives are actually irrelevant. It only matters the directory order inside -mod flag argument and the alphabetical order for vp archives inside each used directory.

:'''Additional notes'''

# This flag is also used by FRED. So if there is special mod info, (like backgrounds maps, ship models or whatever), it must be typed, (''Fred2_Open_r.exe -MOD whatever''), or FRED won't be able to use it. No Launcher MOD tab available for this use. 
# Be careful while typing the directory names in the flag argument or inside mod.ini files. The program doesn't check if the typed directories exist. If they do not exist, they are just ignored. No warnings, no errors, no messages at all.

====-fov====
Specifies the Field of View for the player eyepoint.

Takes one argument decimal specifying the angle of the viewing cone in radians, from 0 to 2*pi

You can set the cone of view making things look bigger/smaller. The problem with this is that if you choose a small FOV, you will have a squashed look on the edges of your screen - stretched edges with a too high FOV. It is recommended to change the FOV as FS2 normally has some perspective distortion at the screen edges (FOV too high). Set the FOV to something like 0.39 - it will fix the distortion problem, and (as a nice side effect) will make everything look bigger and more realistic scale-wise. The default is 0.75, if you go higher, you'll get the fish-eye effect. Feel free to experiment. This must be entered into the "Custom flags" field

''Because of an active bug, FOV can misalign target boxes, effects, etc. Please check [http://lore.maxgaming.net/~scp/mantis/bug_view_advanced_page.php?bug_id=0000083 Mantis bug 083 status]if you are going to change the default value.''

----

===Multiplayer===
====-gamename====
Specifies the name of the game to be created by the host. This only works when used in conjunction with -startgame. This does nothing when used with -standalone.

Takes one argument string, the name to be assigned to the game being created.

See related: [[Command-Line_Reference#-startgame|-startgame]]

====-password====
Specifies the password for a stand-alone server. This only works when used in conjunction with -startgame. Cannot be used in conjunction with -closed or -restricted.

Takes one argument string, the required password for the game being created.

See related: [[Command-Line_Reference#-startgame|-startgame]] [[Command-Line_Reference#-closed|-closed]] [[Command-Line_Reference#-restricted|-restricted]]

====-allowabove====
Specifies a player's minimum rank for joining a game. This only works when used in conjunction with -startgame.

Takes one argument integer, the points ranking above which a player must be to enter the game.

See related: [[Command-Line_Reference#-startgame|-startgame]]

====-allowbelow====
Specifies a player's maximum rank for joining a game on a stand-alone server. This only works when used in conjunction with -startgame.

Takes one argument integer, the points ranking below which a player must be to enter the game.

See related: [[Command-Line_Reference#-startgame|-startgame]]

====-port====
Specifies the port on which to host a game or serve a stand-alone game.

Takes one argument integer, the port on which the host will listen for clients.

====-connect====
'''''What does this do?'''''

====-timeout====
'''''What does this do?'''''

[[Category:Lists]]
[[Category:Source Code Project]]

Command-Line Reference

2006-09-25T06:27:01Z

Martellato: updated -port

==Launcher Flags==
The following command-line options can be chosen from the launcher.
===Graphics===
====-spec====
Enables specular mapping. Only polygons mapped with textures for which a shinemap exists will recieve specular mapping; no attempt is made to generate spec maps where they do not exist. Specular maps are specified with the base map name plus "-shine" (i.e. TCov3A-shine.pcx).
====-env====
Enables environment mapping. Environment mapping intensity will be determined from the intensity of specular maps. At the time of this writing (build 3.6.9 RC7), environment mapping only works when the video mode is OpenGL. [[Installing_fs2_open#Video setup|See Video setup.]]

====-glow====
Enables glowmapping. Only polygons mapped with textures for which a glowmap exists will be glowmapped. Glow maps are specified with the base map name plus "-glow" (i.e. TCov4A-glow.pcx)

====-jpgtga====
Enables the use of TGA and JPG file formats for image files. If a ship is showing up partially invisible, select this option.
====-pcx32====
'''WARNING - HIGH MEMORY USAGE'''

Enables PCX files to be loaded into 32-bit memory. This will not imporove the rendering of any ships in-game, and is usually more of a burden on performance than is worthwhile. Use at your own risk. Removed from launcher options after 3.6.7.

====-cell====
Enables cell shading. This will make graphics appear more "cartoonish". For use with media in mv_cell.vp. Not considered a standard enhancement.
====-mipmap====
Enables mipmapping.

====-nomotiondebris====
Disables motion debris.
====-2d_poof====
Applies nebula poofs in 2d, effectively preventing them from forming intersections with ships.
====-noscalevid====
Disables scaling of video clips.
====-missile_lighting====
Applys lighting to missiles.
====-rlm====
'''Obsolete Argument'''


Enables more accurate lighting model for OpenGL mode. Always on in current builds, so this command-line option has been removed.

----

===Game Speed===
====-img2dds====
Converts all images to DDS (compressed) format. Decreases memory usage but potentially reduces image quality.
====-no_vsync====
Disables vertical sync.
====-cache_bitmaps====
Caches bitmaps between missions, which will ideally reduce the load-time from one mission to another.

----

===HUD===
====-dualscanlines====
Adds a second pair of scanning lines to the target window when scanning an object.
====-targetinfo====
Displays target info, such as name and class, beside the targeted object.
====-orbradar====
Enables 3D radar (the Orb). 3D radar will replace the standard 2D version.
====-ballistic_gauge====
Adds an ammo gauge to the HUD when armed with a ballistic weapon.
====-rearm_timer====
Displays time remaining until rearm and repair from a support ship is complete.

----

===Gameplay===
====-smart_shields====
Enables "smart" shield recharging. Shield recharge is distributed to the most damaged shield quadrant instead of being distributed equally across the entire shield and be wasted when a quadrant is full.
====-ship_choice_3d====
Use ship and weapon models in ship selection and weapon loadout. Completely disables the standard ANI interface on those screens.
====-3dwarp====
Use full geometry for the subspace warp effect.
====-warp_flash====
Enable a flash at warp in and warp out.
====-UseNewAI====
Tells the game to use new AI routines. This argument alters mission balance and is not considered a standard feature.
====-tbp====
Enable feature set for The Babylon Project
====-wcsaga====
Enable feature set for The Wing Commander Saga

----

===Audio===
====-snd_preload====
Preload mission sounds. Useful in preventing game stuttering when sounds are played for the first time.
====-nosound====
Disables all sounds.
====-nomusic====
Disables music only.

----

===Multiplayer===
====-standalone====
Creates a standalone server.
====-startgame====
'''''What does this do?'''''
====-closed====
Hosts a new game in a closed state, where no one can join until the in-game "Close" button is cleared. This only works when used in conjunction with -startgame. Cannot be used in conjunction with -restricted or -password.

See related: [[Command-Line_Reference#-startgame|-startgame]] [[Command-Line_Reference#-restricted|-restricted]] [[Command-Line_Reference#-password|-password]]

====-restricted====
Hosts a new game in a restricted state. The host is presented with option to accept or deny each client's request to join the game. This only works when used in conjunction with -startgame. Cannot be used in conjunction with -closed or -password.

See related: [[Command-Line_Reference#-startgame|-startgame]] [[Command-Line_Reference#-closed|-closed]] [[Command-Line_Reference#-password|-password]]

====-multilog====
Creates a log file with a summary of packets sent and received in multiplayer games. The file is saved as \data\multi.log within the active mod folder - or with main data folder if no mod is active.

====-clientdamage====
This feature is not available in current builds.

====-mpnoreturn====
Disables return to the flight deck screen after a mission completes.

----

===Troubleshooting===
====-fixbugs====
'''Obsolete Argument - Removed in builds after 3.6.7'''


Originally used to disable certain crashing behavior as a stop-gap measure. This feature is not available in current builds.
====-nocrash====
'''Obsolete Argument - Removed in builds after 3.6.7'''


Originally used to disable certain crashing behavior as a stop-gap measure. This feature is not available in current builds.
====-oldfire====
This feature is not available in current builds.

====-nohtl====
'''WARNING - VERY SLOW'''

Reverts to software rendering mode. Does this work any more?
====-no_set_gamma====
Disables the gamma settings in the options screen.
====-nomovies====
Disables all video playback.
====-noparseerrors====
Disables some parsing warnings and makes other parse errors non-fatal. Do not rely on this when creating new tables, the errors are there for a reason.
====-safeloading====
Loads missions the old way. Typically safer, but slower.
====-query_speech====
Determines if the current build includes text-to-speech.
====-d3d_bad_tsys====
Enable inefficient texture system.
====-novbo====
Disables OpenGL VBO.
====-noibx====
Disables IBX caching of model geometry data. This will dramatically increase load times, but will help troubleshoot a model if one is working incorrectly.
====-loadallweps====
Load all weapons, even those not used.

----

===Experimental===
====-alpha_env====
Enables alpha environment mapping. OpenGL only. Environment mapping intensity will be determined from the alpha channel of specular maps.
====-decals====
Enables damage decals.
====-ingame_join====
Enables ingame joining in multiplayer. FIXME: Host option?
====-tga16====
'''Obsolete Argument - Removed in builds after 3.6.7'''


Originally used to converts TGA images to 16-bits in order to reduce memory footprint (at the expense of image quality), superseded by ''-img2dds''.
----

===Development Tools===
====-fps====
Displays current frames per second.
====-pos====
Displays current position coordinates of camera.
====-window====
Runs the game in a window. No check to make sure that resolution is no higher than your desktop resolution, so be careful.
====-timerbar====
Displays a timing bar across the top of the screen. Timebar format varies by build.
====-stats====
Shows total and free physical memory, virtual memory and system pagefile.

====-coords====
Shows coordinates of the mouse cursor.
====-show_mem_usage====
Shows detailed RAM usage in HUD.

The meaning of the info displayed in the upper right corner is:

'''DYN''' = dynamic memory, basically anything that's been allocated by the vm_* memory functions. This does NOT indicate total memory usage but does account for most of it.

'''POF''' = model memory, how much memory is being used by models (does not include textures)

'''C-BMP, BMP''' = bmpman memory, how much is used by the textures/images that are loaded. C-BMP means that you are using -cache_bitmaps and it will try to keep textures in memory between level loads and as the new level is loading it will keep what it needs and unload what it doesn't. Can greatly increase level loading speed, but does so at the cost of memory between level loads. This does not increase overall memory usage though, only during the loading screen. BMP means that it is not cached and all textures are unloaded from memory at the start of level load and all needed textures are then loaded from the disk again.

'''S-RAM''' = sound memory, how much is used by the sounds loaded in memory at the time. This counts static sounds only (from sounds.tbl, etc.) and not streaming sounds (music, voices, briefing stuff, etc).

'''V-RAM''' = approximate memory usage of video textures. This is not mean that your card has this much memory and can report higher numbers that your card actually has memory. For OpenGL it also includes some of the geometry data, but this number does not reflect the total memory that your video card is using. It only reports how much data the game has purposefully loaded into API memory (meaning it could be in system memory, video card memory, or AGP memory).

''(It only works with debug builds, not with release builds).''

====-pofspew====
'''''What does this do?'''''
====-tablecrcs====
'''''What does this do?'''''
====-missioncrcs====
'''''What does this do?'''''
====-dis_collisions====
Disables all collisions.
====-dis_weapons====
Disables weapons rendering.
====-output_sexps====
Outputs SEXPs to sexps.html.
====-output_scripting====
Outputs scripting to scripting.html.
====-nograb====
Unix only. Disables focus grabbing in a window.
==Other==
The following options are not available as checkboxes in the launcher. Many require parameters, which follow the flag seperated by a space. The prototype for use in this case is "-option argument"
===Graphics===
====-ambient_factor====

This must be entered into the "Custom flags" field. This is a multiplier applied to the intensity of ambient lighting. Ambient light is lighting applied to all parts of a ship. FS2's standard value is 120. Try 75 for a good and realistic looking value. However, that is relative.

====-spec_exp====

This must be used with the -spec command line parameter and must be entered into the "Custom flags" field. Adjusts the size of the shiny spot on ships. Higher number mean smaller spots. Default is 16, however 11 is recommended. However, that is relative.

====-spec_point====

This must be used with the -spec command line parameter and must be entered into the
"Custom flags" field. Adjusts how much laser weapons contribute to specular highlights. Higher number mean greater contributions. Default is 1.0, however 0.6 is recommended. However, that is relative.

====-spec_static====

This must be used with the -spec command line parameter and must be entered into the "Custom flags" field. Adjusts how much suns contribute to specular highlights. Higher numbers mean a greater contribution. Default is 1.0, however is 0.8 recommended. However, that is relative.

====-spec_tube====

This must be used with the -spec command line parameter and must be entered into the "Custom flags" field. Adjusts how much Beam Weapons contribute to specular highlights. Higher numbers mean a greater contribution. Default is 1.0, however 0.4 is recommended. However, that is relative.

====-clipdist====
Changes the distance from the viewpoint for the near-clipping plane.

Takes one argument decimal specifying the distance to the near-clipping plane.

----

===Gameplay===
====-mod====

Specifies in which folders inside Freespace2 directory, the game looks for all the game data (models, missions, textures, tables, ...). Retail version only looks inside ''Freespace2/data/'' structure and ''Freespace2/vp archives''.

This flag allows installing several different mods that modify retail behaviour, and switching between them without needing to erase files or having undesired cross effects. Each mod should be installed in its own folder.

It takes one argument string: the chain of names of the used directories. Comma (''',''') must be used as separator. In this way, '''-mod dir1,dir2,dir3,...,dirx''' causes the game to use the following directory precedence:

#Freespace2/dir1/
#Freespace2/dir2/
#Freespace2/dir3/
# ... (the rest of the typed directories) ...
#Freespace2/dirx/
#Freespace2/

:::Please note. Freespace Open doesn't like spaces in directories (in the full path) so do not install the game within ''Program Files/Freespace2'' or ''Games/Freespace 2'' and, of course, do not use spaces within mod directories (''dir1'' is OK but ''dir 1'' isn't).

This flag can be indirectly set, (and it is normally set), through Launcher MOD tab and mod.ini file. Within this Launcher tab you can select one directory, (let's call it ''moddir''), so the flag is at least set to '''-mod moddir'''. If ''Freespace2/moddir/mod.ini'' exists, (its format must be plain text), it will be read and, inside it, the following section and lines can be used to modify the -mod flag too:

: [multimod] PrimaryList = Pri1,Pri2,...(the rest of desired directories)...,Prix; SecondaryList = Sec1,Sec2,...(the rest of desired directories)...,Secx;

(Please note the ending semicolon (;) in each list line). With these lines the following flag would be built:
: '''-mod Pri1,Pri2,...,Prix,moddir,Sec1,Sec2,...,Secx'''

If primary or secondary folders aren't used, their respective line can be erased or it can be typed as ''xxxxxxList = ;''.

::: '''''PLEASE NOTE''': '''Launcher v 5.4''', or later, '''must be used'''. Earlier versions had some bugs that would cause the previous explanation about mod.ini fail.''

::: The most common use of mod.ini and SecondaryList is sharing resources between mods. And the best example is the enhaced media vps from SCP crew. Most of the people install them in a folder called ''mediavps'' inside ''Freespace2''. In this way when running retail FS2 they do not interfere with this original game version that doesn't use this -mod flag feature. When using FS2_Open but without mods, you just need to select ''mediavps'' in Launcher MOD tab to use them. And if you want to enjoy that enhacements while playing any 'real' mod, you just need to put a mod.ini file inside its ''moddir'' with at least a ''SecondaryList = mediavps;'' line.

Inside each directory, data precedence is the following:

#Individual files located in ''Current_dir/data/'' subdir structure.
#Files located inside vp archives. (These vp archives are 'similar' to zip archives, they just contain other files and folders. Moreover, files have to be stored using the same ''data/'' structure used outside it). Vp archives are read in alphabetical order so aaa.vp files have higher priority than aab.vp files and so on.

The highest priority file overrides the rest of them. In this way, if you have a ''Mission.fs2'' inside ''Freespace2/Pri1/data/missions/'' it doesn't matter how this ''Mission.fs2'' is inside ''Freespace2/Pri1/aaa.vp'', ''Freespace2/Pri1/aab.vp'', ... or ''Freespace2/data/missions/''. This data precedence allows the user to quickly replace old files by corrected or enhaced ones adding them in a higher priority place.

As derived from explanation, the exact names for directories or vp archives are actually irrelevant. It only matters the directory order inside -mod flag argument and the alphabetical order for vp archives inside each used directory.

:'''Additional notes'''

# This flag is also used by FRED. So if there is special mod info, (like backgrounds maps, ship models or whatever), it must be typed, (''Fred2_Open_r.exe -MOD whatever''), or FRED won't be able to use it. No Launcher MOD tab available for this use. 
# Be careful while typing the directory names in the flag argument or inside mod.ini files. The program doesn't check if the typed directories exist. If they do not exist, they are just ignored. No warnings, no errors, no messages at all.

====-fov====
Specifies the Field of View for the player eyepoint.

Takes one argument decimal specifying the angle of the viewing cone in radians, from 0 to 2*pi

You can set the cone of view making things look bigger/smaller. The problem with this is that if you choose a small FOV, you will have a squashed look on the edges of your screen - stretched edges with a too high FOV. It is recommended to change the FOV as FS2 normally has some perspective distortion at the screen edges (FOV too high). Set the FOV to something like 0.39 - it will fix the distortion problem, and (as a nice side effect) will make everything look bigger and more realistic scale-wise. The default is 0.75, if you go higher, you'll get the fish-eye effect. Feel free to experiment. This must be entered into the "Custom flags" field

''Because of an active bug, FOV can misalign target boxes, effects, etc. Please check [http://lore.maxgaming.net/~scp/mantis/bug_view_advanced_page.php?bug_id=0000083 Mantis bug 083 status]if you are going to change the default value.''

----

===Multiplayer===
====-gamename====
Specifies the name of the game to be created by the host. This only works when used in conjunction with -startgame. This does nothing when used with -standalone.

Takes one argument string, the name to be assigned to the game being created.

See related: [[Command-Line_Reference#-startgame|-startgame]]

====-password====
Specifies the password for a stand-alone server. This only works when used in conjunction with -startgame. Cannot be used in conjunction with -closed or -restricted.

Takes one argument string, the required password for the game being created.

See related: [[Command-Line_Reference#-startgame|-startgame]] [[Command-Line_Reference#-closed|-closed]] [[Command-Line_Reference#-restricted|-restricted]]

====-allowabove====
Specifies a player's minimum rank for joining a game. This only works when used in conjunction with -startgame.

Takes one argument integer, the points ranking above which a player must be to enter the game.

See related: [[Command-Line_Reference#-startgame|-startgame]]

====-allowbelow====
Specifies a player's maximum rank for joining a game on a stand-alone server. This only works when used in conjunction with -startgame.

Takes one argument integer, the points ranking below which a player must be to enter the game.

See related: [[Command-Line_Reference#-startgame|-startgame]]

====-port====
Specifies the port on which to host a game or serve a stand-alone game.

Takes one argument integer, the port on which the host will listen for clients.

====-connect====
'''''What does this do?'''''

====-timeout====
'''''What does this do?'''''

[[Category:Lists]]
[[Category:Source Code Project]]

Command-Line Reference

2006-09-25T06:26:04Z

Martellato: removed empty hard-return

==Launcher Flags==
The following command-line options can be chosen from the launcher.
===Graphics===
====-spec====
Enables specular mapping. Only polygons mapped with textures for which a shinemap exists will recieve specular mapping; no attempt is made to generate spec maps where they do not exist. Specular maps are specified with the base map name plus "-shine" (i.e. TCov3A-shine.pcx).
====-env====
Enables environment mapping. Environment mapping intensity will be determined from the intensity of specular maps. At the time of this writing (build 3.6.9 RC7), environment mapping only works when the video mode is OpenGL. [[Installing_fs2_open#Video setup|See Video setup.]]

====-glow====
Enables glowmapping. Only polygons mapped with textures for which a glowmap exists will be glowmapped. Glow maps are specified with the base map name plus "-glow" (i.e. TCov4A-glow.pcx)

====-jpgtga====
Enables the use of TGA and JPG file formats for image files. If a ship is showing up partially invisible, select this option.
====-pcx32====
'''WARNING - HIGH MEMORY USAGE'''

Enables PCX files to be loaded into 32-bit memory. This will not imporove the rendering of any ships in-game, and is usually more of a burden on performance than is worthwhile. Use at your own risk. Removed from launcher options after 3.6.7.

====-cell====
Enables cell shading. This will make graphics appear more "cartoonish". For use with media in mv_cell.vp. Not considered a standard enhancement.
====-mipmap====
Enables mipmapping.

====-nomotiondebris====
Disables motion debris.
====-2d_poof====
Applies nebula poofs in 2d, effectively preventing them from forming intersections with ships.
====-noscalevid====
Disables scaling of video clips.
====-missile_lighting====
Applys lighting to missiles.
====-rlm====
'''Obsolete Argument'''


Enables more accurate lighting model for OpenGL mode. Always on in current builds, so this command-line option has been removed.

----

===Game Speed===
====-img2dds====
Converts all images to DDS (compressed) format. Decreases memory usage but potentially reduces image quality.
====-no_vsync====
Disables vertical sync.
====-cache_bitmaps====
Caches bitmaps between missions, which will ideally reduce the load-time from one mission to another.

----

===HUD===
====-dualscanlines====
Adds a second pair of scanning lines to the target window when scanning an object.
====-targetinfo====
Displays target info, such as name and class, beside the targeted object.
====-orbradar====
Enables 3D radar (the Orb). 3D radar will replace the standard 2D version.
====-ballistic_gauge====
Adds an ammo gauge to the HUD when armed with a ballistic weapon.
====-rearm_timer====
Displays time remaining until rearm and repair from a support ship is complete.

----

===Gameplay===
====-smart_shields====
Enables "smart" shield recharging. Shield recharge is distributed to the most damaged shield quadrant instead of being distributed equally across the entire shield and be wasted when a quadrant is full.
====-ship_choice_3d====
Use ship and weapon models in ship selection and weapon loadout. Completely disables the standard ANI interface on those screens.
====-3dwarp====
Use full geometry for the subspace warp effect.
====-warp_flash====
Enable a flash at warp in and warp out.
====-UseNewAI====
Tells the game to use new AI routines. This argument alters mission balance and is not considered a standard feature.
====-tbp====
Enable feature set for The Babylon Project
====-wcsaga====
Enable feature set for The Wing Commander Saga

----

===Audio===
====-snd_preload====
Preload mission sounds. Useful in preventing game stuttering when sounds are played for the first time.
====-nosound====
Disables all sounds.
====-nomusic====
Disables music only.

----

===Multiplayer===
====-standalone====
Creates a standalone server.
====-startgame====
'''''What does this do?'''''
====-closed====
Hosts a new game in a closed state, where no one can join until the in-game "Close" button is cleared. This only works when used in conjunction with -startgame. Cannot be used in conjunction with -restricted or -password.

See related: [[Command-Line_Reference#-startgame|-startgame]] [[Command-Line_Reference#-restricted|-restricted]] [[Command-Line_Reference#-password|-password]]

====-restricted====
Hosts a new game in a restricted state. The host is presented with option to accept or deny each client's request to join the game. This only works when used in conjunction with -startgame. Cannot be used in conjunction with -closed or -password.

See related: [[Command-Line_Reference#-startgame|-startgame]] [[Command-Line_Reference#-closed|-closed]] [[Command-Line_Reference#-password|-password]]

====-multilog====
Creates a log file with a summary of packets sent and received in multiplayer games. The file is saved as \data\multi.log within the active mod folder - or with main data folder if no mod is active.

====-clientdamage====
This feature is not available in current builds.

====-mpnoreturn====
Disables return to the flight deck screen after a mission completes.

----

===Troubleshooting===
====-fixbugs====
'''Obsolete Argument - Removed in builds after 3.6.7'''


Originally used to disable certain crashing behavior as a stop-gap measure. This feature is not available in current builds.
====-nocrash====
'''Obsolete Argument - Removed in builds after 3.6.7'''


Originally used to disable certain crashing behavior as a stop-gap measure. This feature is not available in current builds.
====-oldfire====
This feature is not available in current builds.

====-nohtl====
'''WARNING - VERY SLOW'''

Reverts to software rendering mode. Does this work any more?
====-no_set_gamma====
Disables the gamma settings in the options screen.
====-nomovies====
Disables all video playback.
====-noparseerrors====
Disables some parsing warnings and makes other parse errors non-fatal. Do not rely on this when creating new tables, the errors are there for a reason.
====-safeloading====
Loads missions the old way. Typically safer, but slower.
====-query_speech====
Determines if the current build includes text-to-speech.
====-d3d_bad_tsys====
Enable inefficient texture system.
====-novbo====
Disables OpenGL VBO.
====-noibx====
Disables IBX caching of model geometry data. This will dramatically increase load times, but will help troubleshoot a model if one is working incorrectly.
====-loadallweps====
Load all weapons, even those not used.

----

===Experimental===
====-alpha_env====
Enables alpha environment mapping. OpenGL only. Environment mapping intensity will be determined from the alpha channel of specular maps.
====-decals====
Enables damage decals.
====-ingame_join====
Enables ingame joining in multiplayer. FIXME: Host option?
====-tga16====
'''Obsolete Argument - Removed in builds after 3.6.7'''


Originally used to converts TGA images to 16-bits in order to reduce memory footprint (at the expense of image quality), superseded by ''-img2dds''.
----

===Development Tools===
====-fps====
Displays current frames per second.
====-pos====
Displays current position coordinates of camera.
====-window====
Runs the game in a window. No check to make sure that resolution is no higher than your desktop resolution, so be careful.
====-timerbar====
Displays a timing bar across the top of the screen. Timebar format varies by build.
====-stats====
Shows total and free physical memory, virtual memory and system pagefile.

====-coords====
Shows coordinates of the mouse cursor.
====-show_mem_usage====
Shows detailed RAM usage in HUD.

The meaning of the info displayed in the upper right corner is:

'''DYN''' = dynamic memory, basically anything that's been allocated by the vm_* memory functions. This does NOT indicate total memory usage but does account for most of it.

'''POF''' = model memory, how much memory is being used by models (does not include textures)

'''C-BMP, BMP''' = bmpman memory, how much is used by the textures/images that are loaded. C-BMP means that you are using -cache_bitmaps and it will try to keep textures in memory between level loads and as the new level is loading it will keep what it needs and unload what it doesn't. Can greatly increase level loading speed, but does so at the cost of memory between level loads. This does not increase overall memory usage though, only during the loading screen. BMP means that it is not cached and all textures are unloaded from memory at the start of level load and all needed textures are then loaded from the disk again.

'''S-RAM''' = sound memory, how much is used by the sounds loaded in memory at the time. This counts static sounds only (from sounds.tbl, etc.) and not streaming sounds (music, voices, briefing stuff, etc).

'''V-RAM''' = approximate memory usage of video textures. This is not mean that your card has this much memory and can report higher numbers that your card actually has memory. For OpenGL it also includes some of the geometry data, but this number does not reflect the total memory that your video card is using. It only reports how much data the game has purposefully loaded into API memory (meaning it could be in system memory, video card memory, or AGP memory).

''(It only works with debug builds, not with release builds).''

====-pofspew====
'''''What does this do?'''''
====-tablecrcs====
'''''What does this do?'''''
====-missioncrcs====
'''''What does this do?'''''
====-dis_collisions====
Disables all collisions.
====-dis_weapons====
Disables weapons rendering.
====-output_sexps====
Outputs SEXPs to sexps.html.
====-output_scripting====
Outputs scripting to scripting.html.
====-nograb====
Unix only. Disables focus grabbing in a window.
==Other==
The following options are not available as checkboxes in the launcher. Many require parameters, which follow the flag seperated by a space. The prototype for use in this case is "-option argument"
===Graphics===
====-ambient_factor====

This must be entered into the "Custom flags" field. This is a multiplier applied to the intensity of ambient lighting. Ambient light is lighting applied to all parts of a ship. FS2's standard value is 120. Try 75 for a good and realistic looking value. However, that is relative.

====-spec_exp====

This must be used with the -spec command line parameter and must be entered into the "Custom flags" field. Adjusts the size of the shiny spot on ships. Higher number mean smaller spots. Default is 16, however 11 is recommended. However, that is relative.

====-spec_point====

This must be used with the -spec command line parameter and must be entered into the
"Custom flags" field. Adjusts how much laser weapons contribute to specular highlights. Higher number mean greater contributions. Default is 1.0, however 0.6 is recommended. However, that is relative.

====-spec_static====

This must be used with the -spec command line parameter and must be entered into the "Custom flags" field. Adjusts how much suns contribute to specular highlights. Higher numbers mean a greater contribution. Default is 1.0, however is 0.8 recommended. However, that is relative.

====-spec_tube====

This must be used with the -spec command line parameter and must be entered into the "Custom flags" field. Adjusts how much Beam Weapons contribute to specular highlights. Higher numbers mean a greater contribution. Default is 1.0, however 0.4 is recommended. However, that is relative.

====-clipdist====
Changes the distance from the viewpoint for the near-clipping plane.

Takes one argument decimal specifying the distance to the near-clipping plane.

----

===Gameplay===
====-mod====

Specifies in which folders inside Freespace2 directory, the game looks for all the game data (models, missions, textures, tables, ...). Retail version only looks inside ''Freespace2/data/'' structure and ''Freespace2/vp archives''.

This flag allows installing several different mods that modify retail behaviour, and switching between them without needing to erase files or having undesired cross effects. Each mod should be installed in its own folder.

It takes one argument string: the chain of names of the used directories. Comma (''',''') must be used as separator. In this way, '''-mod dir1,dir2,dir3,...,dirx''' causes the game to use the following directory precedence:

#Freespace2/dir1/
#Freespace2/dir2/
#Freespace2/dir3/
# ... (the rest of the typed directories) ...
#Freespace2/dirx/
#Freespace2/

:::Please note. Freespace Open doesn't like spaces in directories (in the full path) so do not install the game within ''Program Files/Freespace2'' or ''Games/Freespace 2'' and, of course, do not use spaces within mod directories (''dir1'' is OK but ''dir 1'' isn't).

This flag can be indirectly set, (and it is normally set), through Launcher MOD tab and mod.ini file. Within this Launcher tab you can select one directory, (let's call it ''moddir''), so the flag is at least set to '''-mod moddir'''. If ''Freespace2/moddir/mod.ini'' exists, (its format must be plain text), it will be read and, inside it, the following section and lines can be used to modify the -mod flag too:

: [multimod] PrimaryList = Pri1,Pri2,...(the rest of desired directories)...,Prix; SecondaryList = Sec1,Sec2,...(the rest of desired directories)...,Secx;

(Please note the ending semicolon (;) in each list line). With these lines the following flag would be built:
: '''-mod Pri1,Pri2,...,Prix,moddir,Sec1,Sec2,...,Secx'''

If primary or secondary folders aren't used, their respective line can be erased or it can be typed as ''xxxxxxList = ;''.

::: '''''PLEASE NOTE''': '''Launcher v 5.4''', or later, '''must be used'''. Earlier versions had some bugs that would cause the previous explanation about mod.ini fail.''

::: The most common use of mod.ini and SecondaryList is sharing resources between mods. And the best example is the enhaced media vps from SCP crew. Most of the people install them in a folder called ''mediavps'' inside ''Freespace2''. In this way when running retail FS2 they do not interfere with this original game version that doesn't use this -mod flag feature. When using FS2_Open but without mods, you just need to select ''mediavps'' in Launcher MOD tab to use them. And if you want to enjoy that enhacements while playing any 'real' mod, you just need to put a mod.ini file inside its ''moddir'' with at least a ''SecondaryList = mediavps;'' line.

Inside each directory, data precedence is the following:

#Individual files located in ''Current_dir/data/'' subdir structure.
#Files located inside vp archives. (These vp archives are 'similar' to zip archives, they just contain other files and folders. Moreover, files have to be stored using the same ''data/'' structure used outside it). Vp archives are read in alphabetical order so aaa.vp files have higher priority than aab.vp files and so on.

The highest priority file overrides the rest of them. In this way, if you have a ''Mission.fs2'' inside ''Freespace2/Pri1/data/missions/'' it doesn't matter how this ''Mission.fs2'' is inside ''Freespace2/Pri1/aaa.vp'', ''Freespace2/Pri1/aab.vp'', ... or ''Freespace2/data/missions/''. This data precedence allows the user to quickly replace old files by corrected or enhaced ones adding them in a higher priority place.

As derived from explanation, the exact names for directories or vp archives are actually irrelevant. It only matters the directory order inside -mod flag argument and the alphabetical order for vp archives inside each used directory.

:'''Additional notes'''

# This flag is also used by FRED. So if there is special mod info, (like backgrounds maps, ship models or whatever), it must be typed, (''Fred2_Open_r.exe -MOD whatever''), or FRED won't be able to use it. No Launcher MOD tab available for this use. 
# Be careful while typing the directory names in the flag argument or inside mod.ini files. The program doesn't check if the typed directories exist. If they do not exist, they are just ignored. No warnings, no errors, no messages at all.

====-fov====
Specifies the Field of View for the player eyepoint.

Takes one argument decimal specifying the angle of the viewing cone in radians, from 0 to 2*pi

You can set the cone of view making things look bigger/smaller. The problem with this is that if you choose a small FOV, you will have a squashed look on the edges of your screen - stretched edges with a too high FOV. It is recommended to change the FOV as FS2 normally has some perspective distortion at the screen edges (FOV too high). Set the FOV to something like 0.39 - it will fix the distortion problem, and (as a nice side effect) will make everything look bigger and more realistic scale-wise. The default is 0.75, if you go higher, you'll get the fish-eye effect. Feel free to experiment. This must be entered into the "Custom flags" field

''Because of an active bug, FOV can misalign target boxes, effects, etc. Please check [http://lore.maxgaming.net/~scp/mantis/bug_view_advanced_page.php?bug_id=0000083 Mantis bug 083 status]if you are going to change the default value.''

----

===Multiplayer===
====-gamename====
Specifies the name of the game to be created by the host. This only works when used in conjunction with -startgame. This does nothing when used with -standalone.

Takes one argument string, the name to be assigned to the game being created.

See related: [[Command-Line_Reference#-startgame|-startgame]]

====-password====
Specifies the password for a stand-alone server. This only works when used in conjunction with -startgame. Cannot be used in conjunction with -closed or -restricted.

Takes one argument string, the required password for the game being created.

See related: [[Command-Line_Reference#-startgame|-startgame]] [[Command-Line_Reference#-closed|-closed]] [[Command-Line_Reference#-restricted|-restricted]]

====-allowabove====
Specifies a player's minimum rank for joining a game. This only works when used in conjunction with -startgame.

Takes one argument integer, the points ranking above which a player must be to enter the game.

See related: [[Command-Line_Reference#-startgame|-startgame]]

====-allowbelow====
Specifies a player's maximum rank for joining a game on a stand-alone server. This only works when used in conjunction with -startgame.

Takes one argument integer, the points ranking below which a player must be to enter the game.

See related: [[Command-Line_Reference#-startgame|-startgame]]

====-port====
Specifies the port on which to host a game or serve a stand-alone game.

Takes one argument integer, the port which the game should use to connect.

====-connect====
'''''What does this do?'''''

====-timeout====
'''''What does this do?'''''

[[Category:Lists]]
[[Category:Source Code Project]]

Command-Line Reference

2006-09-25T06:24:58Z

Martellato: deleted duplicate -clientdamage

==Launcher Flags==
The following command-line options can be chosen from the launcher.
===Graphics===
====-spec====
Enables specular mapping. Only polygons mapped with textures for which a shinemap exists will recieve specular mapping; no attempt is made to generate spec maps where they do not exist. Specular maps are specified with the base map name plus "-shine" (i.e. TCov3A-shine.pcx).
====-env====
Enables environment mapping. Environment mapping intensity will be determined from the intensity of specular maps. At the time of this writing (build 3.6.9 RC7), environment mapping only works when the video mode is OpenGL. [[Installing_fs2_open#Video setup|See Video setup.]]

====-glow====
Enables glowmapping. Only polygons mapped with textures for which a glowmap exists will be glowmapped. Glow maps are specified with the base map name plus "-glow" (i.e. TCov4A-glow.pcx)

====-jpgtga====
Enables the use of TGA and JPG file formats for image files. If a ship is showing up partially invisible, select this option.
====-pcx32====
'''WARNING - HIGH MEMORY USAGE'''

Enables PCX files to be loaded into 32-bit memory. This will not imporove the rendering of any ships in-game, and is usually more of a burden on performance than is worthwhile. Use at your own risk. Removed from launcher options after 3.6.7.

====-cell====
Enables cell shading. This will make graphics appear more "cartoonish". For use with media in mv_cell.vp. Not considered a standard enhancement.
====-mipmap====
Enables mipmapping.

====-nomotiondebris====
Disables motion debris.
====-2d_poof====
Applies nebula poofs in 2d, effectively preventing them from forming intersections with ships.
====-noscalevid====
Disables scaling of video clips.
====-missile_lighting====
Applys lighting to missiles.
====-rlm====
'''Obsolete Argument'''


Enables more accurate lighting model for OpenGL mode. Always on in current builds, so this command-line option has been removed.

----

===Game Speed===
====-img2dds====
Converts all images to DDS (compressed) format. Decreases memory usage but potentially reduces image quality.
====-no_vsync====
Disables vertical sync.
====-cache_bitmaps====
Caches bitmaps between missions, which will ideally reduce the load-time from one mission to another.

----

===HUD===
====-dualscanlines====
Adds a second pair of scanning lines to the target window when scanning an object.
====-targetinfo====
Displays target info, such as name and class, beside the targeted object.
====-orbradar====
Enables 3D radar (the Orb). 3D radar will replace the standard 2D version.
====-ballistic_gauge====
Adds an ammo gauge to the HUD when armed with a ballistic weapon.
====-rearm_timer====
Displays time remaining until rearm and repair from a support ship is complete.

----

===Gameplay===
====-smart_shields====
Enables "smart" shield recharging. Shield recharge is distributed to the most damaged shield quadrant instead of being distributed equally across the entire shield and be wasted when a quadrant is full.
====-ship_choice_3d====
Use ship and weapon models in ship selection and weapon loadout. Completely disables the standard ANI interface on those screens.
====-3dwarp====
Use full geometry for the subspace warp effect.
====-warp_flash====
Enable a flash at warp in and warp out.
====-UseNewAI====
Tells the game to use new AI routines. This argument alters mission balance and is not considered a standard feature.
====-tbp====
Enable feature set for The Babylon Project
====-wcsaga====
Enable feature set for The Wing Commander Saga

----

===Audio===
====-snd_preload====
Preload mission sounds. Useful in preventing game stuttering when sounds are played for the first time.
====-nosound====
Disables all sounds.
====-nomusic====
Disables music only.

----

===Multiplayer===
====-standalone====
Creates a standalone server.
====-startgame====
'''''What does this do?'''''
====-closed====
Hosts a new game in a closed state, where no one can join until the in-game "Close" button is cleared. This only works when used in conjunction with -startgame. Cannot be used in conjunction with -restricted or -password.

See related: [[Command-Line_Reference#-startgame|-startgame]] [[Command-Line_Reference#-restricted|-restricted]] [[Command-Line_Reference#-password|-password]]

====-restricted====
Hosts a new game in a restricted state. The host is presented with option to accept or deny each client's request to join the game. This only works when used in conjunction with -startgame. Cannot be used in conjunction with -closed or -password.

See related: [[Command-Line_Reference#-startgame|-startgame]] [[Command-Line_Reference#-closed|-closed]] [[Command-Line_Reference#-password|-password]]

====-multilog====
Creates a log file with a summary of packets sent and received in multiplayer games. The file is saved as \data\multi.log within the active mod folder - or with main data folder if no mod is active.

====-clientdamage====
This feature is not available in current builds.

====-mpnoreturn====
Disables return to the flight deck screen after a mission completes.

----

===Troubleshooting===
====-fixbugs====
'''Obsolete Argument - Removed in builds after 3.6.7'''


Originally used to disable certain crashing behavior as a stop-gap measure. This feature is not available in current builds.
====-nocrash====
'''Obsolete Argument - Removed in builds after 3.6.7'''


Originally used to disable certain crashing behavior as a stop-gap measure. This feature is not available in current builds.
====-oldfire====
This feature is not available in current builds.

====-nohtl====
'''WARNING - VERY SLOW'''

Reverts to software rendering mode. Does this work any more?
====-no_set_gamma====
Disables the gamma settings in the options screen.
====-nomovies====
Disables all video playback.
====-noparseerrors====
Disables some parsing warnings and makes other parse errors non-fatal. Do not rely on this when creating new tables, the errors are there for a reason.
====-safeloading====
Loads missions the old way. Typically safer, but slower.
====-query_speech====
Determines if the current build includes text-to-speech.
====-d3d_bad_tsys====
Enable inefficient texture system.
====-novbo====
Disables OpenGL VBO.
====-noibx====
Disables IBX caching of model geometry data. This will dramatically increase load times, but will help troubleshoot a model if one is working incorrectly.
====-loadallweps====
Load all weapons, even those not used.

----

===Experimental===
====-alpha_env====
Enables alpha environment mapping. OpenGL only. Environment mapping intensity will be determined from the alpha channel of specular maps.
====-decals====
Enables damage decals.
====-ingame_join====
Enables ingame joining in multiplayer. FIXME: Host option?
====-tga16====
'''Obsolete Argument - Removed in builds after 3.6.7'''


Originally used to converts TGA images to 16-bits in order to reduce memory footprint (at the expense of image quality), superseded by ''-img2dds''.
----

===Development Tools===
====-fps====
Displays current frames per second.
====-pos====
Displays current position coordinates of camera.
====-window====
Runs the game in a window. No check to make sure that resolution is no higher than your desktop resolution, so be careful.
====-timerbar====
Displays a timing bar across the top of the screen. Timebar format varies by build.
====-stats====
Shows total and free physical memory, virtual memory and system pagefile.

====-coords====
Shows coordinates of the mouse cursor.
====-show_mem_usage====
Shows detailed RAM usage in HUD.

The meaning of the info displayed in the upper right corner is:

'''DYN''' = dynamic memory, basically anything that's been allocated by the vm_* memory functions. This does NOT indicate total memory usage but does account for most of it.

'''POF''' = model memory, how much memory is being used by models (does not include textures)

'''C-BMP, BMP''' = bmpman memory, how much is used by the textures/images that are loaded. C-BMP means that you are using -cache_bitmaps and it will try to keep textures in memory between level loads and as the new level is loading it will keep what it needs and unload what it doesn't. Can greatly increase level loading speed, but does so at the cost of memory between level loads. This does not increase overall memory usage though, only during the loading screen. BMP means that it is not cached and all textures are unloaded from memory at the start of level load and all needed textures are then loaded from the disk again.

'''S-RAM''' = sound memory, how much is used by the sounds loaded in memory at the time. This counts static sounds only (from sounds.tbl, etc.) and not streaming sounds (music, voices, briefing stuff, etc).

'''V-RAM''' = approximate memory usage of video textures. This is not mean that your card has this much memory and can report higher numbers that your card actually has memory. For OpenGL it also includes some of the geometry data, but this number does not reflect the total memory that your video card is using. It only reports how much data the game has purposefully loaded into API memory (meaning it could be in system memory, video card memory, or AGP memory).

''(It only works with debug builds, not with release builds).''

====-pofspew====
'''''What does this do?'''''
====-tablecrcs====
'''''What does this do?'''''
====-missioncrcs====
'''''What does this do?'''''
====-dis_collisions====
Disables all collisions.
====-dis_weapons====
Disables weapons rendering.
====-output_sexps====
Outputs SEXPs to sexps.html.
====-output_scripting====
Outputs scripting to scripting.html.
====-nograb====
Unix only. Disables focus grabbing in a window.
==Other==
The following options are not available as checkboxes in the launcher. Many require parameters, which follow the flag seperated by a space. The prototype for use in this case is "-option argument"
===Graphics===
====-ambient_factor====

This must be entered into the "Custom flags" field. This is a multiplier applied to the intensity of ambient lighting. Ambient light is lighting applied to all parts of a ship. FS2's standard value is 120. Try 75 for a good and realistic looking value. However, that is relative.

====-spec_exp====

This must be used with the -spec command line parameter and must be entered into the "Custom flags" field. Adjusts the size of the shiny spot on ships. Higher number mean smaller spots. Default is 16, however 11 is recommended. However, that is relative.

====-spec_point====

This must be used with the -spec command line parameter and must be entered into the
"Custom flags" field. Adjusts how much laser weapons contribute to specular highlights. Higher number mean greater contributions. Default is 1.0, however 0.6 is recommended. However, that is relative.

====-spec_static====

This must be used with the -spec command line parameter and must be entered into the "Custom flags" field. Adjusts how much suns contribute to specular highlights. Higher numbers mean a greater contribution. Default is 1.0, however is 0.8 recommended. However, that is relative.

====-spec_tube====

This must be used with the -spec command line parameter and must be entered into the "Custom flags" field. Adjusts how much Beam Weapons contribute to specular highlights. Higher numbers mean a greater contribution. Default is 1.0, however 0.4 is recommended. However, that is relative.

====-clipdist====
Changes the distance from the viewpoint for the near-clipping plane.

Takes one argument decimal specifying the distance to the near-clipping plane.

----

===Gameplay===
====-mod====

Specifies in which folders inside Freespace2 directory, the game looks for all the game data (models, missions, textures, tables, ...). Retail version only looks inside ''Freespace2/data/'' structure and ''Freespace2/vp archives''.

This flag allows installing several different mods that modify retail behaviour, and switching between them without needing to erase files or having undesired cross effects. Each mod should be installed in its own folder.

It takes one argument string: the chain of names of the used directories. Comma (''',''') must be used as separator. In this way, '''-mod dir1,dir2,dir3,...,dirx''' causes the game to use the following directory precedence:

#Freespace2/dir1/
#Freespace2/dir2/
#Freespace2/dir3/
# ... (the rest of the typed directories) ...
#Freespace2/dirx/
#Freespace2/

:::Please note. Freespace Open doesn't like spaces in directories (in the full path) so do not install the game within ''Program Files/Freespace2'' or ''Games/Freespace 2'' and, of course, do not use spaces within mod directories (''dir1'' is OK but ''dir 1'' isn't).

This flag can be indirectly set, (and it is normally set), through Launcher MOD tab and mod.ini file. Within this Launcher tab you can select one directory, (let's call it ''moddir''), so the flag is at least set to '''-mod moddir'''. If ''Freespace2/moddir/mod.ini'' exists, (its format must be plain text), it will be read and, inside it, the following section and lines can be used to modify the -mod flag too:

: [multimod] PrimaryList = Pri1,Pri2,...(the rest of desired directories)...,Prix; SecondaryList = Sec1,Sec2,...(the rest of desired directories)...,Secx;

(Please note the ending semicolon (;) in each list line). With these lines the following flag would be built:
: '''-mod Pri1,Pri2,...,Prix,moddir,Sec1,Sec2,...,Secx'''

If primary or secondary folders aren't used, their respective line can be erased or it can be typed as ''xxxxxxList = ;''.

::: '''''PLEASE NOTE''': '''Launcher v 5.4''', or later, '''must be used'''. Earlier versions had some bugs that would cause the previous explanation about mod.ini fail.''

::: The most common use of mod.ini and SecondaryList is sharing resources between mods. And the best example is the enhaced media vps from SCP crew. Most of the people install them in a folder called ''mediavps'' inside ''Freespace2''. In this way when running retail FS2 they do not interfere with this original game version that doesn't use this -mod flag feature. When using FS2_Open but without mods, you just need to select ''mediavps'' in Launcher MOD tab to use them. And if you want to enjoy that enhacements while playing any 'real' mod, you just need to put a mod.ini file inside its ''moddir'' with at least a ''SecondaryList = mediavps;'' line.

Inside each directory, data precedence is the following:

#Individual files located in ''Current_dir/data/'' subdir structure.
#Files located inside vp archives. (These vp archives are 'similar' to zip archives, they just contain other files and folders. Moreover, files have to be stored using the same ''data/'' structure used outside it). Vp archives are read in alphabetical order so aaa.vp files have higher priority than aab.vp files and so on.

The highest priority file overrides the rest of them. In this way, if you have a ''Mission.fs2'' inside ''Freespace2/Pri1/data/missions/'' it doesn't matter how this ''Mission.fs2'' is inside ''Freespace2/Pri1/aaa.vp'', ''Freespace2/Pri1/aab.vp'', ... or ''Freespace2/data/missions/''. This data precedence allows the user to quickly replace old files by corrected or enhaced ones adding them in a higher priority place.

As derived from explanation, the exact names for directories or vp archives are actually irrelevant. It only matters the directory order inside -mod flag argument and the alphabetical order for vp archives inside each used directory.

:'''Additional notes'''

# This flag is also used by FRED. So if there is special mod info, (like backgrounds maps, ship models or whatever), it must be typed, (''Fred2_Open_r.exe -MOD whatever''), or FRED won't be able to use it. No Launcher MOD tab available for this use. 
# Be careful while typing the directory names in the flag argument or inside mod.ini files. The program doesn't check if the typed directories exist. If they do not exist, they are just ignored. No warnings, no errors, no messages at all.

====-fov====
Specifies the Field of View for the player eyepoint.

Takes one argument decimal specifying the angle of the viewing cone in radians, from 0 to 2*pi

You can set the cone of view making things look bigger/smaller. The problem with this is that if you choose a small FOV, you will have a squashed look on the edges of your screen - stretched edges with a too high FOV. It is recommended to change the FOV as FS2 normally has some perspective distortion at the screen edges (FOV too high). Set the FOV to something like 0.39 - it will fix the distortion problem, and (as a nice side effect) will make everything look bigger and more realistic scale-wise. The default is 0.75, if you go higher, you'll get the fish-eye effect. Feel free to experiment. This must be entered into the "Custom flags" field

''Because of an active bug, FOV can misalign target boxes, effects, etc. Please check [http://lore.maxgaming.net/~scp/mantis/bug_view_advanced_page.php?bug_id=0000083 Mantis bug 083 status]if you are going to change the default value.''

----

===Multiplayer===
====-gamename====
Specifies the name of the game to be created by the host. This only works when used in conjunction with -startgame. This does nothing when used with -standalone.

Takes one argument string, the name to be assigned to the game being created.

See related: [[Command-Line_Reference#-startgame|-startgame]]

====-password====
Specifies the password for a stand-alone server. This only works when used in conjunction with -startgame. Cannot be used in conjunction with -closed or -restricted.

Takes one argument string, the required password for the game being created.

See related: [[Command-Line_Reference#-startgame|-startgame]] [[Command-Line_Reference#-closed|-closed]] [[Command-Line_Reference#-restricted|-restricted]]

====-allowabove====
Specifies a player's minimum rank for joining a game. This only works when used in conjunction with -startgame.

Takes one argument integer, the points ranking above which a player must be to enter the game.

See related: [[Command-Line_Reference#-startgame|-startgame]]

====-allowbelow====
Specifies a player's maximum rank for joining a game on a stand-alone server. This only works when used in conjunction with -startgame.

Takes one argument integer, the points ranking below which a player must be to enter the game.

See related: [[Command-Line_Reference#-startgame|-startgame]]

====-port====
Specifies the port on which to host a game or serve a stand-alone game.

Takes one argument integer, the port which the game should use to connect.

====-connect====
'''''What does this do?'''''

====-timeout====
'''''What does this do?'''''

[[Category:Lists]]
[[Category:Source Code Project]]

Command-Line Reference

2006-09-25T06:23:09Z

Martellato: updated -port

==Launcher Flags==
The following command-line options can be chosen from the launcher.
===Graphics===
====-spec====
Enables specular mapping. Only polygons mapped with textures for which a shinemap exists will recieve specular mapping; no attempt is made to generate spec maps where they do not exist. Specular maps are specified with the base map name plus "-shine" (i.e. TCov3A-shine.pcx).
====-env====
Enables environment mapping. Environment mapping intensity will be determined from the intensity of specular maps. At the time of this writing (build 3.6.9 RC7), environment mapping only works when the video mode is OpenGL. [[Installing_fs2_open#Video setup|See Video setup.]]

====-glow====
Enables glowmapping. Only polygons mapped with textures for which a glowmap exists will be glowmapped. Glow maps are specified with the base map name plus "-glow" (i.e. TCov4A-glow.pcx)

====-jpgtga====
Enables the use of TGA and JPG file formats for image files. If a ship is showing up partially invisible, select this option.
====-pcx32====
'''WARNING - HIGH MEMORY USAGE'''

Enables PCX files to be loaded into 32-bit memory. This will not imporove the rendering of any ships in-game, and is usually more of a burden on performance than is worthwhile. Use at your own risk. Removed from launcher options after 3.6.7.

====-cell====
Enables cell shading. This will make graphics appear more "cartoonish". For use with media in mv_cell.vp. Not considered a standard enhancement.
====-mipmap====
Enables mipmapping.

====-nomotiondebris====
Disables motion debris.
====-2d_poof====
Applies nebula poofs in 2d, effectively preventing them from forming intersections with ships.
====-noscalevid====
Disables scaling of video clips.
====-missile_lighting====
Applys lighting to missiles.
====-rlm====
'''Obsolete Argument'''


Enables more accurate lighting model for OpenGL mode. Always on in current builds, so this command-line option has been removed.

----

===Game Speed===
====-img2dds====
Converts all images to DDS (compressed) format. Decreases memory usage but potentially reduces image quality.
====-no_vsync====
Disables vertical sync.
====-cache_bitmaps====
Caches bitmaps between missions, which will ideally reduce the load-time from one mission to another.

----

===HUD===
====-dualscanlines====
Adds a second pair of scanning lines to the target window when scanning an object.
====-targetinfo====
Displays target info, such as name and class, beside the targeted object.
====-orbradar====
Enables 3D radar (the Orb). 3D radar will replace the standard 2D version.
====-ballistic_gauge====
Adds an ammo gauge to the HUD when armed with a ballistic weapon.
====-rearm_timer====
Displays time remaining until rearm and repair from a support ship is complete.

----

===Gameplay===
====-smart_shields====
Enables "smart" shield recharging. Shield recharge is distributed to the most damaged shield quadrant instead of being distributed equally across the entire shield and be wasted when a quadrant is full.
====-ship_choice_3d====
Use ship and weapon models in ship selection and weapon loadout. Completely disables the standard ANI interface on those screens.
====-3dwarp====
Use full geometry for the subspace warp effect.
====-warp_flash====
Enable a flash at warp in and warp out.
====-UseNewAI====
Tells the game to use new AI routines. This argument alters mission balance and is not considered a standard feature.
====-tbp====
Enable feature set for The Babylon Project
====-wcsaga====
Enable feature set for The Wing Commander Saga

----

===Audio===
====-snd_preload====
Preload mission sounds. Useful in preventing game stuttering when sounds are played for the first time.
====-nosound====
Disables all sounds.
====-nomusic====
Disables music only.

----

===Multiplayer===
====-standalone====
Creates a standalone server.
====-startgame====
'''''What does this do?'''''
====-closed====
Hosts a new game in a closed state, where no one can join until the in-game "Close" button is cleared. This only works when used in conjunction with -startgame. Cannot be used in conjunction with -restricted or -password.

See related: [[Command-Line_Reference#-startgame|-startgame]] [[Command-Line_Reference#-restricted|-restricted]] [[Command-Line_Reference#-password|-password]]

====-restricted====
Hosts a new game in a restricted state. The host is presented with option to accept or deny each client's request to join the game. This only works when used in conjunction with -startgame. Cannot be used in conjunction with -closed or -password.

See related: [[Command-Line_Reference#-startgame|-startgame]] [[Command-Line_Reference#-closed|-closed]] [[Command-Line_Reference#-password|-password]]

====-multilog====
Creates a log file with a summary of packets sent and received in multiplayer games. The file is saved as \data\multi.log within the active mod folder - or with main data folder if no mod is active.

====-clientdamage====
This feature is not available in current builds.

====-mpnoreturn====
Disables return to the flight deck screen after a mission completes.

----

===Troubleshooting===
====-fixbugs====
'''Obsolete Argument - Removed in builds after 3.6.7'''


Originally used to disable certain crashing behavior as a stop-gap measure. This feature is not available in current builds.
====-nocrash====
'''Obsolete Argument - Removed in builds after 3.6.7'''


Originally used to disable certain crashing behavior as a stop-gap measure. This feature is not available in current builds.
====-oldfire====
This feature is not available in current builds.

====-nohtl====
'''WARNING - VERY SLOW'''

Reverts to software rendering mode. Does this work any more?
====-no_set_gamma====
Disables the gamma settings in the options screen.
====-nomovies====
Disables all video playback.
====-noparseerrors====
Disables some parsing warnings and makes other parse errors non-fatal. Do not rely on this when creating new tables, the errors are there for a reason.
====-safeloading====
Loads missions the old way. Typically safer, but slower.
====-query_speech====
Determines if the current build includes text-to-speech.
====-d3d_bad_tsys====
Enable inefficient texture system.
====-novbo====
Disables OpenGL VBO.
====-noibx====
Disables IBX caching of model geometry data. This will dramatically increase load times, but will help troubleshoot a model if one is working incorrectly.
====-loadallweps====
Load all weapons, even those not used.

----

===Experimental===
====-alpha_env====
Enables alpha environment mapping. OpenGL only. Environment mapping intensity will be determined from the alpha channel of specular maps.
====-decals====
Enables damage decals.
====-ingame_join====
Enables ingame joining in multiplayer. FIXME: Host option?
====-tga16====
'''Obsolete Argument - Removed in builds after 3.6.7'''


Originally used to converts TGA images to 16-bits in order to reduce memory footprint (at the expense of image quality), superseded by ''-img2dds''.
----

===Development Tools===
====-fps====
Displays current frames per second.
====-pos====
Displays current position coordinates of camera.
====-window====
Runs the game in a window. No check to make sure that resolution is no higher than your desktop resolution, so be careful.
====-timerbar====
Displays a timing bar across the top of the screen. Timebar format varies by build.
====-stats====
Shows total and free physical memory, virtual memory and system pagefile.

====-coords====
Shows coordinates of the mouse cursor.
====-show_mem_usage====
Shows detailed RAM usage in HUD.

The meaning of the info displayed in the upper right corner is:

'''DYN''' = dynamic memory, basically anything that's been allocated by the vm_* memory functions. This does NOT indicate total memory usage but does account for most of it.

'''POF''' = model memory, how much memory is being used by models (does not include textures)

'''C-BMP, BMP''' = bmpman memory, how much is used by the textures/images that are loaded. C-BMP means that you are using -cache_bitmaps and it will try to keep textures in memory between level loads and as the new level is loading it will keep what it needs and unload what it doesn't. Can greatly increase level loading speed, but does so at the cost of memory between level loads. This does not increase overall memory usage though, only during the loading screen. BMP means that it is not cached and all textures are unloaded from memory at the start of level load and all needed textures are then loaded from the disk again.

'''S-RAM''' = sound memory, how much is used by the sounds loaded in memory at the time. This counts static sounds only (from sounds.tbl, etc.) and not streaming sounds (music, voices, briefing stuff, etc).

'''V-RAM''' = approximate memory usage of video textures. This is not mean that your card has this much memory and can report higher numbers that your card actually has memory. For OpenGL it also includes some of the geometry data, but this number does not reflect the total memory that your video card is using. It only reports how much data the game has purposefully loaded into API memory (meaning it could be in system memory, video card memory, or AGP memory).

''(It only works with debug builds, not with release builds).''

====-pofspew====
'''''What does this do?'''''
====-tablecrcs====
'''''What does this do?'''''
====-missioncrcs====
'''''What does this do?'''''
====-dis_collisions====
Disables all collisions.
====-dis_weapons====
Disables weapons rendering.
====-output_sexps====
Outputs SEXPs to sexps.html.
====-output_scripting====
Outputs scripting to scripting.html.
====-nograb====
Unix only. Disables focus grabbing in a window.
==Other==
The following options are not available as checkboxes in the launcher. Many require parameters, which follow the flag seperated by a space. The prototype for use in this case is "-option argument"
===Graphics===
====-ambient_factor====

This must be entered into the "Custom flags" field. This is a multiplier applied to the intensity of ambient lighting. Ambient light is lighting applied to all parts of a ship. FS2's standard value is 120. Try 75 for a good and realistic looking value. However, that is relative.

====-spec_exp====

This must be used with the -spec command line parameter and must be entered into the "Custom flags" field. Adjusts the size of the shiny spot on ships. Higher number mean smaller spots. Default is 16, however 11 is recommended. However, that is relative.

====-spec_point====

This must be used with the -spec command line parameter and must be entered into the
"Custom flags" field. Adjusts how much laser weapons contribute to specular highlights. Higher number mean greater contributions. Default is 1.0, however 0.6 is recommended. However, that is relative.

====-spec_static====

This must be used with the -spec command line parameter and must be entered into the "Custom flags" field. Adjusts how much suns contribute to specular highlights. Higher numbers mean a greater contribution. Default is 1.0, however is 0.8 recommended. However, that is relative.

====-spec_tube====

This must be used with the -spec command line parameter and must be entered into the "Custom flags" field. Adjusts how much Beam Weapons contribute to specular highlights. Higher numbers mean a greater contribution. Default is 1.0, however 0.4 is recommended. However, that is relative.

====-clipdist====
Changes the distance from the viewpoint for the near-clipping plane.

Takes one argument decimal specifying the distance to the near-clipping plane.

----

===Gameplay===
====-mod====

Specifies in which folders inside Freespace2 directory, the game looks for all the game data (models, missions, textures, tables, ...). Retail version only looks inside ''Freespace2/data/'' structure and ''Freespace2/vp archives''.

This flag allows installing several different mods that modify retail behaviour, and switching between them without needing to erase files or having undesired cross effects. Each mod should be installed in its own folder.

It takes one argument string: the chain of names of the used directories. Comma (''',''') must be used as separator. In this way, '''-mod dir1,dir2,dir3,...,dirx''' causes the game to use the following directory precedence:

#Freespace2/dir1/
#Freespace2/dir2/
#Freespace2/dir3/
# ... (the rest of the typed directories) ...
#Freespace2/dirx/
#Freespace2/

:::Please note. Freespace Open doesn't like spaces in directories (in the full path) so do not install the game within ''Program Files/Freespace2'' or ''Games/Freespace 2'' and, of course, do not use spaces within mod directories (''dir1'' is OK but ''dir 1'' isn't).

This flag can be indirectly set, (and it is normally set), through Launcher MOD tab and mod.ini file. Within this Launcher tab you can select one directory, (let's call it ''moddir''), so the flag is at least set to '''-mod moddir'''. If ''Freespace2/moddir/mod.ini'' exists, (its format must be plain text), it will be read and, inside it, the following section and lines can be used to modify the -mod flag too:

: [multimod] PrimaryList = Pri1,Pri2,...(the rest of desired directories)...,Prix; SecondaryList = Sec1,Sec2,...(the rest of desired directories)...,Secx;

(Please note the ending semicolon (;) in each list line). With these lines the following flag would be built:
: '''-mod Pri1,Pri2,...,Prix,moddir,Sec1,Sec2,...,Secx'''

If primary or secondary folders aren't used, their respective line can be erased or it can be typed as ''xxxxxxList = ;''.

::: '''''PLEASE NOTE''': '''Launcher v 5.4''', or later, '''must be used'''. Earlier versions had some bugs that would cause the previous explanation about mod.ini fail.''

::: The most common use of mod.ini and SecondaryList is sharing resources between mods. And the best example is the enhaced media vps from SCP crew. Most of the people install them in a folder called ''mediavps'' inside ''Freespace2''. In this way when running retail FS2 they do not interfere with this original game version that doesn't use this -mod flag feature. When using FS2_Open but without mods, you just need to select ''mediavps'' in Launcher MOD tab to use them. And if you want to enjoy that enhacements while playing any 'real' mod, you just need to put a mod.ini file inside its ''moddir'' with at least a ''SecondaryList = mediavps;'' line.

Inside each directory, data precedence is the following:

#Individual files located in ''Current_dir/data/'' subdir structure.
#Files located inside vp archives. (These vp archives are 'similar' to zip archives, they just contain other files and folders. Moreover, files have to be stored using the same ''data/'' structure used outside it). Vp archives are read in alphabetical order so aaa.vp files have higher priority than aab.vp files and so on.

The highest priority file overrides the rest of them. In this way, if you have a ''Mission.fs2'' inside ''Freespace2/Pri1/data/missions/'' it doesn't matter how this ''Mission.fs2'' is inside ''Freespace2/Pri1/aaa.vp'', ''Freespace2/Pri1/aab.vp'', ... or ''Freespace2/data/missions/''. This data precedence allows the user to quickly replace old files by corrected or enhaced ones adding them in a higher priority place.

As derived from explanation, the exact names for directories or vp archives are actually irrelevant. It only matters the directory order inside -mod flag argument and the alphabetical order for vp archives inside each used directory.

:'''Additional notes'''

# This flag is also used by FRED. So if there is special mod info, (like backgrounds maps, ship models or whatever), it must be typed, (''Fred2_Open_r.exe -MOD whatever''), or FRED won't be able to use it. No Launcher MOD tab available for this use. 
# Be careful while typing the directory names in the flag argument or inside mod.ini files. The program doesn't check if the typed directories exist. If they do not exist, they are just ignored. No warnings, no errors, no messages at all.

====-fov====
Specifies the Field of View for the player eyepoint.

Takes one argument decimal specifying the angle of the viewing cone in radians, from 0 to 2*pi

You can set the cone of view making things look bigger/smaller. The problem with this is that if you choose a small FOV, you will have a squashed look on the edges of your screen - stretched edges with a too high FOV. It is recommended to change the FOV as FS2 normally has some perspective distortion at the screen edges (FOV too high). Set the FOV to something like 0.39 - it will fix the distortion problem, and (as a nice side effect) will make everything look bigger and more realistic scale-wise. The default is 0.75, if you go higher, you'll get the fish-eye effect. Feel free to experiment. This must be entered into the "Custom flags" field

''Because of an active bug, FOV can misalign target boxes, effects, etc. Please check [http://lore.maxgaming.net/~scp/mantis/bug_view_advanced_page.php?bug_id=0000083 Mantis bug 083 status]if you are going to change the default value.''

----

===Multiplayer===
====-gamename====
Specifies the name of the game to be created by the host. This only works when used in conjunction with -startgame. This does nothing when used with -standalone.

Takes one argument string, the name to be assigned to the game being created.

See related: [[Command-Line_Reference#-startgame|-startgame]]

====-password====
Specifies the password for a stand-alone server. This only works when used in conjunction with -startgame. Cannot be used in conjunction with -closed or -restricted.

Takes one argument string, the required password for the game being created.

See related: [[Command-Line_Reference#-startgame|-startgame]] [[Command-Line_Reference#-closed|-closed]] [[Command-Line_Reference#-restricted|-restricted]]

====-allowabove====
Specifies a player's minimum rank for joining a game. This only works when used in conjunction with -startgame.

Takes one argument integer, the points ranking above which a player must be to enter the game.

See related: [[Command-Line_Reference#-startgame|-startgame]]

====-allowbelow====
Specifies a player's maximum rank for joining a game on a stand-alone server. This only works when used in conjunction with -startgame.

Takes one argument integer, the points ranking below which a player must be to enter the game.

See related: [[Command-Line_Reference#-startgame|-startgame]]

====-port====
Specifies the port on which to host a game or serve a stand-alone game.

Takes one argument integer, the port which the game should use to connect.

====-connect====
'''''What does this do?'''''
====-clientdamage====
'''''What does this do?'''''
====-timeout====
'''''What does this do?'''''

[[Category:Lists]]
[[Category:Source Code Project]]

Command-Line Reference

2006-09-25T05:59:39Z

Martellato: updated -allowbelow

==Launcher Flags==
The following command-line options can be chosen from the launcher.
===Graphics===
====-spec====
Enables specular mapping. Only polygons mapped with textures for which a shinemap exists will recieve specular mapping; no attempt is made to generate spec maps where they do not exist. Specular maps are specified with the base map name plus "-shine" (i.e. TCov3A-shine.pcx).
====-env====
Enables environment mapping. Environment mapping intensity will be determined from the intensity of specular maps. At the time of this writing (build 3.6.9 RC7), environment mapping only works when the video mode is OpenGL. [[Installing_fs2_open#Video setup|See Video setup.]]

====-glow====
Enables glowmapping. Only polygons mapped with textures for which a glowmap exists will be glowmapped. Glow maps are specified with the base map name plus "-glow" (i.e. TCov4A-glow.pcx)

====-jpgtga====
Enables the use of TGA and JPG file formats for image files. If a ship is showing up partially invisible, select this option.
====-pcx32====
'''WARNING - HIGH MEMORY USAGE'''

Enables PCX files to be loaded into 32-bit memory. This will not imporove the rendering of any ships in-game, and is usually more of a burden on performance than is worthwhile. Use at your own risk. Removed from launcher options after 3.6.7.

====-cell====
Enables cell shading. This will make graphics appear more "cartoonish". For use with media in mv_cell.vp. Not considered a standard enhancement.
====-mipmap====
Enables mipmapping.

====-nomotiondebris====
Disables motion debris.
====-2d_poof====
Applies nebula poofs in 2d, effectively preventing them from forming intersections with ships.
====-noscalevid====
Disables scaling of video clips.
====-missile_lighting====
Applys lighting to missiles.
====-rlm====
'''Obsolete Argument'''


Enables more accurate lighting model for OpenGL mode. Always on in current builds, so this command-line option has been removed.

----

===Game Speed===
====-img2dds====
Converts all images to DDS (compressed) format. Decreases memory usage but potentially reduces image quality.
====-no_vsync====
Disables vertical sync.
====-cache_bitmaps====
Caches bitmaps between missions, which will ideally reduce the load-time from one mission to another.

----

===HUD===
====-dualscanlines====
Adds a second pair of scanning lines to the target window when scanning an object.
====-targetinfo====
Displays target info, such as name and class, beside the targeted object.
====-orbradar====
Enables 3D radar (the Orb). 3D radar will replace the standard 2D version.
====-ballistic_gauge====
Adds an ammo gauge to the HUD when armed with a ballistic weapon.
====-rearm_timer====
Displays time remaining until rearm and repair from a support ship is complete.

----

===Gameplay===
====-smart_shields====
Enables "smart" shield recharging. Shield recharge is distributed to the most damaged shield quadrant instead of being distributed equally across the entire shield and be wasted when a quadrant is full.
====-ship_choice_3d====
Use ship and weapon models in ship selection and weapon loadout. Completely disables the standard ANI interface on those screens.
====-3dwarp====
Use full geometry for the subspace warp effect.
====-warp_flash====
Enable a flash at warp in and warp out.
====-UseNewAI====
Tells the game to use new AI routines. This argument alters mission balance and is not considered a standard feature.
====-tbp====
Enable feature set for The Babylon Project
====-wcsaga====
Enable feature set for The Wing Commander Saga

----

===Audio===
====-snd_preload====
Preload mission sounds. Useful in preventing game stuttering when sounds are played for the first time.
====-nosound====
Disables all sounds.
====-nomusic====
Disables music only.

----

===Multiplayer===
====-standalone====
Creates a standalone server.
====-startgame====
'''''What does this do?'''''
====-closed====
Hosts a new game in a closed state, where no one can join until the in-game "Close" button is cleared. This only works when used in conjunction with -startgame. Cannot be used in conjunction with -restricted or -password.

See related: [[Command-Line_Reference#-startgame|-startgame]] [[Command-Line_Reference#-restricted|-restricted]] [[Command-Line_Reference#-password|-password]]

====-restricted====
Hosts a new game in a restricted state. The host is presented with option to accept or deny each client's request to join the game. This only works when used in conjunction with -startgame. Cannot be used in conjunction with -closed or -password.

See related: [[Command-Line_Reference#-startgame|-startgame]] [[Command-Line_Reference#-closed|-closed]] [[Command-Line_Reference#-password|-password]]

====-multilog====
Creates a log file with a summary of packets sent and received in multiplayer games. The file is saved as \data\multi.log within the active mod folder - or with main data folder if no mod is active.

====-clientdamage====
This feature is not available in current builds.

====-mpnoreturn====
Disables return to the flight deck screen after a mission completes.

----

===Troubleshooting===
====-fixbugs====
'''Obsolete Argument - Removed in builds after 3.6.7'''


Originally used to disable certain crashing behavior as a stop-gap measure. This feature is not available in current builds.
====-nocrash====
'''Obsolete Argument - Removed in builds after 3.6.7'''


Originally used to disable certain crashing behavior as a stop-gap measure. This feature is not available in current builds.
====-oldfire====
This feature is not available in current builds.

====-nohtl====
'''WARNING - VERY SLOW'''

Reverts to software rendering mode. Does this work any more?
====-no_set_gamma====
Disables the gamma settings in the options screen.
====-nomovies====
Disables all video playback.
====-noparseerrors====
Disables some parsing warnings and makes other parse errors non-fatal. Do not rely on this when creating new tables, the errors are there for a reason.
====-safeloading====
Loads missions the old way. Typically safer, but slower.
====-query_speech====
Determines if the current build includes text-to-speech.
====-d3d_bad_tsys====
Enable inefficient texture system.
====-novbo====
Disables OpenGL VBO.
====-noibx====
Disables IBX caching of model geometry data. This will dramatically increase load times, but will help troubleshoot a model if one is working incorrectly.
====-loadallweps====
Load all weapons, even those not used.

----

===Experimental===
====-alpha_env====
Enables alpha environment mapping. OpenGL only. Environment mapping intensity will be determined from the alpha channel of specular maps.
====-decals====
Enables damage decals.
====-ingame_join====
Enables ingame joining in multiplayer. FIXME: Host option?
====-tga16====
'''Obsolete Argument - Removed in builds after 3.6.7'''


Originally used to converts TGA images to 16-bits in order to reduce memory footprint (at the expense of image quality), superseded by ''-img2dds''.
----

===Development Tools===
====-fps====
Displays current frames per second.
====-pos====
Displays current position coordinates of camera.
====-window====
Runs the game in a window. No check to make sure that resolution is no higher than your desktop resolution, so be careful.
====-timerbar====
Displays a timing bar across the top of the screen. Timebar format varies by build.
====-stats====
Shows total and free physical memory, virtual memory and system pagefile.

====-coords====
Shows coordinates of the mouse cursor.
====-show_mem_usage====
Shows detailed RAM usage in HUD.

The meaning of the info displayed in the upper right corner is:

'''DYN''' = dynamic memory, basically anything that's been allocated by the vm_* memory functions. This does NOT indicate total memory usage but does account for most of it.

'''POF''' = model memory, how much memory is being used by models (does not include textures)

'''C-BMP, BMP''' = bmpman memory, how much is used by the textures/images that are loaded. C-BMP means that you are using -cache_bitmaps and it will try to keep textures in memory between level loads and as the new level is loading it will keep what it needs and unload what it doesn't. Can greatly increase level loading speed, but does so at the cost of memory between level loads. This does not increase overall memory usage though, only during the loading screen. BMP means that it is not cached and all textures are unloaded from memory at the start of level load and all needed textures are then loaded from the disk again.

'''S-RAM''' = sound memory, how much is used by the sounds loaded in memory at the time. This counts static sounds only (from sounds.tbl, etc.) and not streaming sounds (music, voices, briefing stuff, etc).

'''V-RAM''' = approximate memory usage of video textures. This is not mean that your card has this much memory and can report higher numbers that your card actually has memory. For OpenGL it also includes some of the geometry data, but this number does not reflect the total memory that your video card is using. It only reports how much data the game has purposefully loaded into API memory (meaning it could be in system memory, video card memory, or AGP memory).

''(It only works with debug builds, not with release builds).''

====-pofspew====
'''''What does this do?'''''
====-tablecrcs====
'''''What does this do?'''''
====-missioncrcs====
'''''What does this do?'''''
====-dis_collisions====
Disables all collisions.
====-dis_weapons====
Disables weapons rendering.
====-output_sexps====
Outputs SEXPs to sexps.html.
====-output_scripting====
Outputs scripting to scripting.html.
====-nograb====
Unix only. Disables focus grabbing in a window.
==Other==
The following options are not available as checkboxes in the launcher. Many require parameters, which follow the flag seperated by a space. The prototype for use in this case is "-option argument"
===Graphics===
====-ambient_factor====

This must be entered into the "Custom flags" field. This is a multiplier applied to the intensity of ambient lighting. Ambient light is lighting applied to all parts of a ship. FS2's standard value is 120. Try 75 for a good and realistic looking value. However, that is relative.

====-spec_exp====

This must be used with the -spec command line parameter and must be entered into the "Custom flags" field. Adjusts the size of the shiny spot on ships. Higher number mean smaller spots. Default is 16, however 11 is recommended. However, that is relative.

====-spec_point====

This must be used with the -spec command line parameter and must be entered into the
"Custom flags" field. Adjusts how much laser weapons contribute to specular highlights. Higher number mean greater contributions. Default is 1.0, however 0.6 is recommended. However, that is relative.

====-spec_static====

This must be used with the -spec command line parameter and must be entered into the "Custom flags" field. Adjusts how much suns contribute to specular highlights. Higher numbers mean a greater contribution. Default is 1.0, however is 0.8 recommended. However, that is relative.

====-spec_tube====

This must be used with the -spec command line parameter and must be entered into the "Custom flags" field. Adjusts how much Beam Weapons contribute to specular highlights. Higher numbers mean a greater contribution. Default is 1.0, however 0.4 is recommended. However, that is relative.

====-clipdist====
Changes the distance from the viewpoint for the near-clipping plane.

Takes one argument decimal specifying the distance to the near-clipping plane.

----

===Gameplay===
====-mod====

Specifies in which folders inside Freespace2 directory, the game looks for all the game data (models, missions, textures, tables, ...). Retail version only looks inside ''Freespace2/data/'' structure and ''Freespace2/vp archives''.

This flag allows installing several different mods that modify retail behaviour, and switching between them without needing to erase files or having undesired cross effects. Each mod should be installed in its own folder.

It takes one argument string: the chain of names of the used directories. Comma (''',''') must be used as separator. In this way, '''-mod dir1,dir2,dir3,...,dirx''' causes the game to use the following directory precedence:

#Freespace2/dir1/
#Freespace2/dir2/
#Freespace2/dir3/
# ... (the rest of the typed directories) ...
#Freespace2/dirx/
#Freespace2/

:::Please note. Freespace Open doesn't like spaces in directories (in the full path) so do not install the game within ''Program Files/Freespace2'' or ''Games/Freespace 2'' and, of course, do not use spaces within mod directories (''dir1'' is OK but ''dir 1'' isn't).

This flag can be indirectly set, (and it is normally set), through Launcher MOD tab and mod.ini file. Within this Launcher tab you can select one directory, (let's call it ''moddir''), so the flag is at least set to '''-mod moddir'''. If ''Freespace2/moddir/mod.ini'' exists, (its format must be plain text), it will be read and, inside it, the following section and lines can be used to modify the -mod flag too:

: [multimod] PrimaryList = Pri1,Pri2,...(the rest of desired directories)...,Prix; SecondaryList = Sec1,Sec2,...(the rest of desired directories)...,Secx;

(Please note the ending semicolon (;) in each list line). With these lines the following flag would be built:
: '''-mod Pri1,Pri2,...,Prix,moddir,Sec1,Sec2,...,Secx'''

If primary or secondary folders aren't used, their respective line can be erased or it can be typed as ''xxxxxxList = ;''.

::: '''''PLEASE NOTE''': '''Launcher v 5.4''', or later, '''must be used'''. Earlier versions had some bugs that would cause the previous explanation about mod.ini fail.''

::: The most common use of mod.ini and SecondaryList is sharing resources between mods. And the best example is the enhaced media vps from SCP crew. Most of the people install them in a folder called ''mediavps'' inside ''Freespace2''. In this way when running retail FS2 they do not interfere with this original game version that doesn't use this -mod flag feature. When using FS2_Open but without mods, you just need to select ''mediavps'' in Launcher MOD tab to use them. And if you want to enjoy that enhacements while playing any 'real' mod, you just need to put a mod.ini file inside its ''moddir'' with at least a ''SecondaryList = mediavps;'' line.

Inside each directory, data precedence is the following:

#Individual files located in ''Current_dir/data/'' subdir structure.
#Files located inside vp archives. (These vp archives are 'similar' to zip archives, they just contain other files and folders. Moreover, files have to be stored using the same ''data/'' structure used outside it). Vp archives are read in alphabetical order so aaa.vp files have higher priority than aab.vp files and so on.

The highest priority file overrides the rest of them. In this way, if you have a ''Mission.fs2'' inside ''Freespace2/Pri1/data/missions/'' it doesn't matter how this ''Mission.fs2'' is inside ''Freespace2/Pri1/aaa.vp'', ''Freespace2/Pri1/aab.vp'', ... or ''Freespace2/data/missions/''. This data precedence allows the user to quickly replace old files by corrected or enhaced ones adding them in a higher priority place.

As derived from explanation, the exact names for directories or vp archives are actually irrelevant. It only matters the directory order inside -mod flag argument and the alphabetical order for vp archives inside each used directory.

:'''Additional notes'''

# This flag is also used by FRED. So if there is special mod info, (like backgrounds maps, ship models or whatever), it must be typed, (''Fred2_Open_r.exe -MOD whatever''), or FRED won't be able to use it. No Launcher MOD tab available for this use. 
# Be careful while typing the directory names in the flag argument or inside mod.ini files. The program doesn't check if the typed directories exist. If they do not exist, they are just ignored. No warnings, no errors, no messages at all.

====-fov====
Specifies the Field of View for the player eyepoint.

Takes one argument decimal specifying the angle of the viewing cone in radians, from 0 to 2*pi

You can set the cone of view making things look bigger/smaller. The problem with this is that if you choose a small FOV, you will have a squashed look on the edges of your screen - stretched edges with a too high FOV. It is recommended to change the FOV as FS2 normally has some perspective distortion at the screen edges (FOV too high). Set the FOV to something like 0.39 - it will fix the distortion problem, and (as a nice side effect) will make everything look bigger and more realistic scale-wise. The default is 0.75, if you go higher, you'll get the fish-eye effect. Feel free to experiment. This must be entered into the "Custom flags" field

''Because of an active bug, FOV can misalign target boxes, effects, etc. Please check [http://lore.maxgaming.net/~scp/mantis/bug_view_advanced_page.php?bug_id=0000083 Mantis bug 083 status]if you are going to change the default value.''

----

===Multiplayer===
====-gamename====
Specifies the name of the game to be created by the host. This only works when used in conjunction with -startgame. This does nothing when used with -standalone.

Takes one argument string, the name to be assigned to the game being created.

See related: [[Command-Line_Reference#-startgame|-startgame]]

====-password====
Specifies the password for a stand-alone server. This only works when used in conjunction with -startgame. Cannot be used in conjunction with -closed or -restricted.

Takes one argument string, the required password for the game being created.

See related: [[Command-Line_Reference#-startgame|-startgame]] [[Command-Line_Reference#-closed|-closed]] [[Command-Line_Reference#-restricted|-restricted]]

====-allowabove====
Specifies a player's minimum rank for joining a game. This only works when used in conjunction with -startgame.

Takes one argument integer, the points ranking above which a player must be to enter the game.

See related: [[Command-Line_Reference#-startgame|-startgame]]

====-allowbelow====
Specifies a player's maximum rank for joining a game on a stand-alone server. This only works when used in conjunction with -startgame.

Takes one argument integer, the points ranking below which a player must be to enter the game.

See related: [[Command-Line_Reference#-startgame|-startgame]]

====-port====
Specifies the port on which to run for a stand-alone server.

Takes one argument integer, the port which the game should use to connect.
====-connect====
'''''What does this do?'''''
====-clientdamage====
'''''What does this do?'''''
====-timeout====
'''''What does this do?'''''

[[Category:Lists]]
[[Category:Source Code Project]]

Command-Line Reference

2006-09-25T05:59:07Z

Martellato: updated -allowabove

==Launcher Flags==
The following command-line options can be chosen from the launcher.
===Graphics===
====-spec====
Enables specular mapping. Only polygons mapped with textures for which a shinemap exists will recieve specular mapping; no attempt is made to generate spec maps where they do not exist. Specular maps are specified with the base map name plus "-shine" (i.e. TCov3A-shine.pcx).
====-env====
Enables environment mapping. Environment mapping intensity will be determined from the intensity of specular maps. At the time of this writing (build 3.6.9 RC7), environment mapping only works when the video mode is OpenGL. [[Installing_fs2_open#Video setup|See Video setup.]]

====-glow====
Enables glowmapping. Only polygons mapped with textures for which a glowmap exists will be glowmapped. Glow maps are specified with the base map name plus "-glow" (i.e. TCov4A-glow.pcx)

====-jpgtga====
Enables the use of TGA and JPG file formats for image files. If a ship is showing up partially invisible, select this option.
====-pcx32====
'''WARNING - HIGH MEMORY USAGE'''

Enables PCX files to be loaded into 32-bit memory. This will not imporove the rendering of any ships in-game, and is usually more of a burden on performance than is worthwhile. Use at your own risk. Removed from launcher options after 3.6.7.

====-cell====
Enables cell shading. This will make graphics appear more "cartoonish". For use with media in mv_cell.vp. Not considered a standard enhancement.
====-mipmap====
Enables mipmapping.

====-nomotiondebris====
Disables motion debris.
====-2d_poof====
Applies nebula poofs in 2d, effectively preventing them from forming intersections with ships.
====-noscalevid====
Disables scaling of video clips.
====-missile_lighting====
Applys lighting to missiles.
====-rlm====
'''Obsolete Argument'''


Enables more accurate lighting model for OpenGL mode. Always on in current builds, so this command-line option has been removed.

----

===Game Speed===
====-img2dds====
Converts all images to DDS (compressed) format. Decreases memory usage but potentially reduces image quality.
====-no_vsync====
Disables vertical sync.
====-cache_bitmaps====
Caches bitmaps between missions, which will ideally reduce the load-time from one mission to another.

----

===HUD===
====-dualscanlines====
Adds a second pair of scanning lines to the target window when scanning an object.
====-targetinfo====
Displays target info, such as name and class, beside the targeted object.
====-orbradar====
Enables 3D radar (the Orb). 3D radar will replace the standard 2D version.
====-ballistic_gauge====
Adds an ammo gauge to the HUD when armed with a ballistic weapon.
====-rearm_timer====
Displays time remaining until rearm and repair from a support ship is complete.

----

===Gameplay===
====-smart_shields====
Enables "smart" shield recharging. Shield recharge is distributed to the most damaged shield quadrant instead of being distributed equally across the entire shield and be wasted when a quadrant is full.
====-ship_choice_3d====
Use ship and weapon models in ship selection and weapon loadout. Completely disables the standard ANI interface on those screens.
====-3dwarp====
Use full geometry for the subspace warp effect.
====-warp_flash====
Enable a flash at warp in and warp out.
====-UseNewAI====
Tells the game to use new AI routines. This argument alters mission balance and is not considered a standard feature.
====-tbp====
Enable feature set for The Babylon Project
====-wcsaga====
Enable feature set for The Wing Commander Saga

----

===Audio===
====-snd_preload====
Preload mission sounds. Useful in preventing game stuttering when sounds are played for the first time.
====-nosound====
Disables all sounds.
====-nomusic====
Disables music only.

----

===Multiplayer===
====-standalone====
Creates a standalone server.
====-startgame====
'''''What does this do?'''''
====-closed====
Hosts a new game in a closed state, where no one can join until the in-game "Close" button is cleared. This only works when used in conjunction with -startgame. Cannot be used in conjunction with -restricted or -password.

See related: [[Command-Line_Reference#-startgame|-startgame]] [[Command-Line_Reference#-restricted|-restricted]] [[Command-Line_Reference#-password|-password]]

====-restricted====
Hosts a new game in a restricted state. The host is presented with option to accept or deny each client's request to join the game. This only works when used in conjunction with -startgame. Cannot be used in conjunction with -closed or -password.

See related: [[Command-Line_Reference#-startgame|-startgame]] [[Command-Line_Reference#-closed|-closed]] [[Command-Line_Reference#-password|-password]]

====-multilog====
Creates a log file with a summary of packets sent and received in multiplayer games. The file is saved as \data\multi.log within the active mod folder - or with main data folder if no mod is active.

====-clientdamage====
This feature is not available in current builds.

====-mpnoreturn====
Disables return to the flight deck screen after a mission completes.

----

===Troubleshooting===
====-fixbugs====
'''Obsolete Argument - Removed in builds after 3.6.7'''


Originally used to disable certain crashing behavior as a stop-gap measure. This feature is not available in current builds.
====-nocrash====
'''Obsolete Argument - Removed in builds after 3.6.7'''


Originally used to disable certain crashing behavior as a stop-gap measure. This feature is not available in current builds.
====-oldfire====
This feature is not available in current builds.

====-nohtl====
'''WARNING - VERY SLOW'''

Reverts to software rendering mode. Does this work any more?
====-no_set_gamma====
Disables the gamma settings in the options screen.
====-nomovies====
Disables all video playback.
====-noparseerrors====
Disables some parsing warnings and makes other parse errors non-fatal. Do not rely on this when creating new tables, the errors are there for a reason.
====-safeloading====
Loads missions the old way. Typically safer, but slower.
====-query_speech====
Determines if the current build includes text-to-speech.
====-d3d_bad_tsys====
Enable inefficient texture system.
====-novbo====
Disables OpenGL VBO.
====-noibx====
Disables IBX caching of model geometry data. This will dramatically increase load times, but will help troubleshoot a model if one is working incorrectly.
====-loadallweps====
Load all weapons, even those not used.

----

===Experimental===
====-alpha_env====
Enables alpha environment mapping. OpenGL only. Environment mapping intensity will be determined from the alpha channel of specular maps.
====-decals====
Enables damage decals.
====-ingame_join====
Enables ingame joining in multiplayer. FIXME: Host option?
====-tga16====
'''Obsolete Argument - Removed in builds after 3.6.7'''


Originally used to converts TGA images to 16-bits in order to reduce memory footprint (at the expense of image quality), superseded by ''-img2dds''.
----

===Development Tools===
====-fps====
Displays current frames per second.
====-pos====
Displays current position coordinates of camera.
====-window====
Runs the game in a window. No check to make sure that resolution is no higher than your desktop resolution, so be careful.
====-timerbar====
Displays a timing bar across the top of the screen. Timebar format varies by build.
====-stats====
Shows total and free physical memory, virtual memory and system pagefile.

====-coords====
Shows coordinates of the mouse cursor.
====-show_mem_usage====
Shows detailed RAM usage in HUD.

The meaning of the info displayed in the upper right corner is:

'''DYN''' = dynamic memory, basically anything that's been allocated by the vm_* memory functions. This does NOT indicate total memory usage but does account for most of it.

'''POF''' = model memory, how much memory is being used by models (does not include textures)

'''C-BMP, BMP''' = bmpman memory, how much is used by the textures/images that are loaded. C-BMP means that you are using -cache_bitmaps and it will try to keep textures in memory between level loads and as the new level is loading it will keep what it needs and unload what it doesn't. Can greatly increase level loading speed, but does so at the cost of memory between level loads. This does not increase overall memory usage though, only during the loading screen. BMP means that it is not cached and all textures are unloaded from memory at the start of level load and all needed textures are then loaded from the disk again.

'''S-RAM''' = sound memory, how much is used by the sounds loaded in memory at the time. This counts static sounds only (from sounds.tbl, etc.) and not streaming sounds (music, voices, briefing stuff, etc).

'''V-RAM''' = approximate memory usage of video textures. This is not mean that your card has this much memory and can report higher numbers that your card actually has memory. For OpenGL it also includes some of the geometry data, but this number does not reflect the total memory that your video card is using. It only reports how much data the game has purposefully loaded into API memory (meaning it could be in system memory, video card memory, or AGP memory).

''(It only works with debug builds, not with release builds).''

====-pofspew====
'''''What does this do?'''''
====-tablecrcs====
'''''What does this do?'''''
====-missioncrcs====
'''''What does this do?'''''
====-dis_collisions====
Disables all collisions.
====-dis_weapons====
Disables weapons rendering.
====-output_sexps====
Outputs SEXPs to sexps.html.
====-output_scripting====
Outputs scripting to scripting.html.
====-nograb====
Unix only. Disables focus grabbing in a window.
==Other==
The following options are not available as checkboxes in the launcher. Many require parameters, which follow the flag seperated by a space. The prototype for use in this case is "-option argument"
===Graphics===
====-ambient_factor====

This must be entered into the "Custom flags" field. This is a multiplier applied to the intensity of ambient lighting. Ambient light is lighting applied to all parts of a ship. FS2's standard value is 120. Try 75 for a good and realistic looking value. However, that is relative.

====-spec_exp====

This must be used with the -spec command line parameter and must be entered into the "Custom flags" field. Adjusts the size of the shiny spot on ships. Higher number mean smaller spots. Default is 16, however 11 is recommended. However, that is relative.

====-spec_point====

This must be used with the -spec command line parameter and must be entered into the
"Custom flags" field. Adjusts how much laser weapons contribute to specular highlights. Higher number mean greater contributions. Default is 1.0, however 0.6 is recommended. However, that is relative.

====-spec_static====

This must be used with the -spec command line parameter and must be entered into the "Custom flags" field. Adjusts how much suns contribute to specular highlights. Higher numbers mean a greater contribution. Default is 1.0, however is 0.8 recommended. However, that is relative.

====-spec_tube====

This must be used with the -spec command line parameter and must be entered into the "Custom flags" field. Adjusts how much Beam Weapons contribute to specular highlights. Higher numbers mean a greater contribution. Default is 1.0, however 0.4 is recommended. However, that is relative.

====-clipdist====
Changes the distance from the viewpoint for the near-clipping plane.

Takes one argument decimal specifying the distance to the near-clipping plane.

----

===Gameplay===
====-mod====

Specifies in which folders inside Freespace2 directory, the game looks for all the game data (models, missions, textures, tables, ...). Retail version only looks inside ''Freespace2/data/'' structure and ''Freespace2/vp archives''.

This flag allows installing several different mods that modify retail behaviour, and switching between them without needing to erase files or having undesired cross effects. Each mod should be installed in its own folder.

It takes one argument string: the chain of names of the used directories. Comma (''',''') must be used as separator. In this way, '''-mod dir1,dir2,dir3,...,dirx''' causes the game to use the following directory precedence:

#Freespace2/dir1/
#Freespace2/dir2/
#Freespace2/dir3/
# ... (the rest of the typed directories) ...
#Freespace2/dirx/
#Freespace2/

:::Please note. Freespace Open doesn't like spaces in directories (in the full path) so do not install the game within ''Program Files/Freespace2'' or ''Games/Freespace 2'' and, of course, do not use spaces within mod directories (''dir1'' is OK but ''dir 1'' isn't).

This flag can be indirectly set, (and it is normally set), through Launcher MOD tab and mod.ini file. Within this Launcher tab you can select one directory, (let's call it ''moddir''), so the flag is at least set to '''-mod moddir'''. If ''Freespace2/moddir/mod.ini'' exists, (its format must be plain text), it will be read and, inside it, the following section and lines can be used to modify the -mod flag too:

: [multimod] PrimaryList = Pri1,Pri2,...(the rest of desired directories)...,Prix; SecondaryList = Sec1,Sec2,...(the rest of desired directories)...,Secx;

(Please note the ending semicolon (;) in each list line). With these lines the following flag would be built:
: '''-mod Pri1,Pri2,...,Prix,moddir,Sec1,Sec2,...,Secx'''

If primary or secondary folders aren't used, their respective line can be erased or it can be typed as ''xxxxxxList = ;''.

::: '''''PLEASE NOTE''': '''Launcher v 5.4''', or later, '''must be used'''. Earlier versions had some bugs that would cause the previous explanation about mod.ini fail.''

::: The most common use of mod.ini and SecondaryList is sharing resources between mods. And the best example is the enhaced media vps from SCP crew. Most of the people install them in a folder called ''mediavps'' inside ''Freespace2''. In this way when running retail FS2 they do not interfere with this original game version that doesn't use this -mod flag feature. When using FS2_Open but without mods, you just need to select ''mediavps'' in Launcher MOD tab to use them. And if you want to enjoy that enhacements while playing any 'real' mod, you just need to put a mod.ini file inside its ''moddir'' with at least a ''SecondaryList = mediavps;'' line.

Inside each directory, data precedence is the following:

#Individual files located in ''Current_dir/data/'' subdir structure.
#Files located inside vp archives. (These vp archives are 'similar' to zip archives, they just contain other files and folders. Moreover, files have to be stored using the same ''data/'' structure used outside it). Vp archives are read in alphabetical order so aaa.vp files have higher priority than aab.vp files and so on.

The highest priority file overrides the rest of them. In this way, if you have a ''Mission.fs2'' inside ''Freespace2/Pri1/data/missions/'' it doesn't matter how this ''Mission.fs2'' is inside ''Freespace2/Pri1/aaa.vp'', ''Freespace2/Pri1/aab.vp'', ... or ''Freespace2/data/missions/''. This data precedence allows the user to quickly replace old files by corrected or enhaced ones adding them in a higher priority place.

As derived from explanation, the exact names for directories or vp archives are actually irrelevant. It only matters the directory order inside -mod flag argument and the alphabetical order for vp archives inside each used directory.

:'''Additional notes'''

# This flag is also used by FRED. So if there is special mod info, (like backgrounds maps, ship models or whatever), it must be typed, (''Fred2_Open_r.exe -MOD whatever''), or FRED won't be able to use it. No Launcher MOD tab available for this use. 
# Be careful while typing the directory names in the flag argument or inside mod.ini files. The program doesn't check if the typed directories exist. If they do not exist, they are just ignored. No warnings, no errors, no messages at all.

====-fov====
Specifies the Field of View for the player eyepoint.

Takes one argument decimal specifying the angle of the viewing cone in radians, from 0 to 2*pi

You can set the cone of view making things look bigger/smaller. The problem with this is that if you choose a small FOV, you will have a squashed look on the edges of your screen - stretched edges with a too high FOV. It is recommended to change the FOV as FS2 normally has some perspective distortion at the screen edges (FOV too high). Set the FOV to something like 0.39 - it will fix the distortion problem, and (as a nice side effect) will make everything look bigger and more realistic scale-wise. The default is 0.75, if you go higher, you'll get the fish-eye effect. Feel free to experiment. This must be entered into the "Custom flags" field

''Because of an active bug, FOV can misalign target boxes, effects, etc. Please check [http://lore.maxgaming.net/~scp/mantis/bug_view_advanced_page.php?bug_id=0000083 Mantis bug 083 status]if you are going to change the default value.''

----

===Multiplayer===
====-gamename====
Specifies the name of the game to be created by the host. This only works when used in conjunction with -startgame. This does nothing when used with -standalone.

Takes one argument string, the name to be assigned to the game being created.

See related: [[Command-Line_Reference#-startgame|-startgame]]

====-password====
Specifies the password for a stand-alone server. This only works when used in conjunction with -startgame. Cannot be used in conjunction with -closed or -restricted.

Takes one argument string, the required password for the game being created.

See related: [[Command-Line_Reference#-startgame|-startgame]] [[Command-Line_Reference#-closed|-closed]] [[Command-Line_Reference#-restricted|-restricted]]

====-allowabove====
Specifies a player's minimum rank for joining a game. This only works when used in conjunction with -startgame.

Takes one argument integer, the points ranking above which a player must be to enter the game.

See related: [[Command-Line_Reference#-startgame|-startgame]]

====-allowbelow====
Specifies a player's maximum rank for joining a game on a stand-alone server.

Takes one argument integer, the points ranking below which a player must be to enter the game.
====-port====
Specifies the port on which to run for a stand-alone server.

Takes one argument integer, the port which the game should use to connect.
====-connect====
'''''What does this do?'''''
====-clientdamage====
'''''What does this do?'''''
====-timeout====
'''''What does this do?'''''

[[Category:Lists]]
[[Category:Source Code Project]]

Command-Line Reference

2006-09-25T05:55:53Z

Martellato: updated -password (again

==Launcher Flags==
The following command-line options can be chosen from the launcher.
===Graphics===
====-spec====
Enables specular mapping. Only polygons mapped with textures for which a shinemap exists will recieve specular mapping; no attempt is made to generate spec maps where they do not exist. Specular maps are specified with the base map name plus "-shine" (i.e. TCov3A-shine.pcx).
====-env====
Enables environment mapping. Environment mapping intensity will be determined from the intensity of specular maps. At the time of this writing (build 3.6.9 RC7), environment mapping only works when the video mode is OpenGL. [[Installing_fs2_open#Video setup|See Video setup.]]

====-glow====
Enables glowmapping. Only polygons mapped with textures for which a glowmap exists will be glowmapped. Glow maps are specified with the base map name plus "-glow" (i.e. TCov4A-glow.pcx)

====-jpgtga====
Enables the use of TGA and JPG file formats for image files. If a ship is showing up partially invisible, select this option.
====-pcx32====
'''WARNING - HIGH MEMORY USAGE'''

Enables PCX files to be loaded into 32-bit memory. This will not imporove the rendering of any ships in-game, and is usually more of a burden on performance than is worthwhile. Use at your own risk. Removed from launcher options after 3.6.7.

====-cell====
Enables cell shading. This will make graphics appear more "cartoonish". For use with media in mv_cell.vp. Not considered a standard enhancement.
====-mipmap====
Enables mipmapping.

====-nomotiondebris====
Disables motion debris.
====-2d_poof====
Applies nebula poofs in 2d, effectively preventing them from forming intersections with ships.
====-noscalevid====
Disables scaling of video clips.
====-missile_lighting====
Applys lighting to missiles.
====-rlm====
'''Obsolete Argument'''


Enables more accurate lighting model for OpenGL mode. Always on in current builds, so this command-line option has been removed.

----

===Game Speed===
====-img2dds====
Converts all images to DDS (compressed) format. Decreases memory usage but potentially reduces image quality.
====-no_vsync====
Disables vertical sync.
====-cache_bitmaps====
Caches bitmaps between missions, which will ideally reduce the load-time from one mission to another.

----

===HUD===
====-dualscanlines====
Adds a second pair of scanning lines to the target window when scanning an object.
====-targetinfo====
Displays target info, such as name and class, beside the targeted object.
====-orbradar====
Enables 3D radar (the Orb). 3D radar will replace the standard 2D version.
====-ballistic_gauge====
Adds an ammo gauge to the HUD when armed with a ballistic weapon.
====-rearm_timer====
Displays time remaining until rearm and repair from a support ship is complete.

----

===Gameplay===
====-smart_shields====
Enables "smart" shield recharging. Shield recharge is distributed to the most damaged shield quadrant instead of being distributed equally across the entire shield and be wasted when a quadrant is full.
====-ship_choice_3d====
Use ship and weapon models in ship selection and weapon loadout. Completely disables the standard ANI interface on those screens.
====-3dwarp====
Use full geometry for the subspace warp effect.
====-warp_flash====
Enable a flash at warp in and warp out.
====-UseNewAI====
Tells the game to use new AI routines. This argument alters mission balance and is not considered a standard feature.
====-tbp====
Enable feature set for The Babylon Project
====-wcsaga====
Enable feature set for The Wing Commander Saga

----

===Audio===
====-snd_preload====
Preload mission sounds. Useful in preventing game stuttering when sounds are played for the first time.
====-nosound====
Disables all sounds.
====-nomusic====
Disables music only.

----

===Multiplayer===
====-standalone====
Creates a standalone server.
====-startgame====
'''''What does this do?'''''
====-closed====
Hosts a new game in a closed state, where no one can join until the in-game "Close" button is cleared. This only works when used in conjunction with -startgame. Cannot be used in conjunction with -restricted or -password.

See related: [[Command-Line_Reference#-startgame|-startgame]] [[Command-Line_Reference#-restricted|-restricted]] [[Command-Line_Reference#-password|-password]]

====-restricted====
Hosts a new game in a restricted state. The host is presented with option to accept or deny each client's request to join the game. This only works when used in conjunction with -startgame. Cannot be used in conjunction with -closed or -password.

See related: [[Command-Line_Reference#-startgame|-startgame]] [[Command-Line_Reference#-closed|-closed]] [[Command-Line_Reference#-password|-password]]

====-multilog====
Creates a log file with a summary of packets sent and received in multiplayer games. The file is saved as \data\multi.log within the active mod folder - or with main data folder if no mod is active.

====-clientdamage====
This feature is not available in current builds.

====-mpnoreturn====
Disables return to the flight deck screen after a mission completes.

----

===Troubleshooting===
====-fixbugs====
'''Obsolete Argument - Removed in builds after 3.6.7'''


Originally used to disable certain crashing behavior as a stop-gap measure. This feature is not available in current builds.
====-nocrash====
'''Obsolete Argument - Removed in builds after 3.6.7'''


Originally used to disable certain crashing behavior as a stop-gap measure. This feature is not available in current builds.
====-oldfire====
This feature is not available in current builds.

====-nohtl====
'''WARNING - VERY SLOW'''

Reverts to software rendering mode. Does this work any more?
====-no_set_gamma====
Disables the gamma settings in the options screen.
====-nomovies====
Disables all video playback.
====-noparseerrors====
Disables some parsing warnings and makes other parse errors non-fatal. Do not rely on this when creating new tables, the errors are there for a reason.
====-safeloading====
Loads missions the old way. Typically safer, but slower.
====-query_speech====
Determines if the current build includes text-to-speech.
====-d3d_bad_tsys====
Enable inefficient texture system.
====-novbo====
Disables OpenGL VBO.
====-noibx====
Disables IBX caching of model geometry data. This will dramatically increase load times, but will help troubleshoot a model if one is working incorrectly.
====-loadallweps====
Load all weapons, even those not used.

----

===Experimental===
====-alpha_env====
Enables alpha environment mapping. OpenGL only. Environment mapping intensity will be determined from the alpha channel of specular maps.
====-decals====
Enables damage decals.
====-ingame_join====
Enables ingame joining in multiplayer. FIXME: Host option?
====-tga16====
'''Obsolete Argument - Removed in builds after 3.6.7'''


Originally used to converts TGA images to 16-bits in order to reduce memory footprint (at the expense of image quality), superseded by ''-img2dds''.
----

===Development Tools===
====-fps====
Displays current frames per second.
====-pos====
Displays current position coordinates of camera.
====-window====
Runs the game in a window. No check to make sure that resolution is no higher than your desktop resolution, so be careful.
====-timerbar====
Displays a timing bar across the top of the screen. Timebar format varies by build.
====-stats====
Shows total and free physical memory, virtual memory and system pagefile.

====-coords====
Shows coordinates of the mouse cursor.
====-show_mem_usage====
Shows detailed RAM usage in HUD.

The meaning of the info displayed in the upper right corner is:

'''DYN''' = dynamic memory, basically anything that's been allocated by the vm_* memory functions. This does NOT indicate total memory usage but does account for most of it.

'''POF''' = model memory, how much memory is being used by models (does not include textures)

'''C-BMP, BMP''' = bmpman memory, how much is used by the textures/images that are loaded. C-BMP means that you are using -cache_bitmaps and it will try to keep textures in memory between level loads and as the new level is loading it will keep what it needs and unload what it doesn't. Can greatly increase level loading speed, but does so at the cost of memory between level loads. This does not increase overall memory usage though, only during the loading screen. BMP means that it is not cached and all textures are unloaded from memory at the start of level load and all needed textures are then loaded from the disk again.

'''S-RAM''' = sound memory, how much is used by the sounds loaded in memory at the time. This counts static sounds only (from sounds.tbl, etc.) and not streaming sounds (music, voices, briefing stuff, etc).

'''V-RAM''' = approximate memory usage of video textures. This is not mean that your card has this much memory and can report higher numbers that your card actually has memory. For OpenGL it also includes some of the geometry data, but this number does not reflect the total memory that your video card is using. It only reports how much data the game has purposefully loaded into API memory (meaning it could be in system memory, video card memory, or AGP memory).

''(It only works with debug builds, not with release builds).''

====-pofspew====
'''''What does this do?'''''
====-tablecrcs====
'''''What does this do?'''''
====-missioncrcs====
'''''What does this do?'''''
====-dis_collisions====
Disables all collisions.
====-dis_weapons====
Disables weapons rendering.
====-output_sexps====
Outputs SEXPs to sexps.html.
====-output_scripting====
Outputs scripting to scripting.html.
====-nograb====
Unix only. Disables focus grabbing in a window.
==Other==
The following options are not available as checkboxes in the launcher. Many require parameters, which follow the flag seperated by a space. The prototype for use in this case is "-option argument"
===Graphics===
====-ambient_factor====

This must be entered into the "Custom flags" field. This is a multiplier applied to the intensity of ambient lighting. Ambient light is lighting applied to all parts of a ship. FS2's standard value is 120. Try 75 for a good and realistic looking value. However, that is relative.

====-spec_exp====

This must be used with the -spec command line parameter and must be entered into the "Custom flags" field. Adjusts the size of the shiny spot on ships. Higher number mean smaller spots. Default is 16, however 11 is recommended. However, that is relative.

====-spec_point====

This must be used with the -spec command line parameter and must be entered into the
"Custom flags" field. Adjusts how much laser weapons contribute to specular highlights. Higher number mean greater contributions. Default is 1.0, however 0.6 is recommended. However, that is relative.

====-spec_static====

This must be used with the -spec command line parameter and must be entered into the "Custom flags" field. Adjusts how much suns contribute to specular highlights. Higher numbers mean a greater contribution. Default is 1.0, however is 0.8 recommended. However, that is relative.

====-spec_tube====

This must be used with the -spec command line parameter and must be entered into the "Custom flags" field. Adjusts how much Beam Weapons contribute to specular highlights. Higher numbers mean a greater contribution. Default is 1.0, however 0.4 is recommended. However, that is relative.

====-clipdist====
Changes the distance from the viewpoint for the near-clipping plane.

Takes one argument decimal specifying the distance to the near-clipping plane.

----

===Gameplay===
====-mod====

Specifies in which folders inside Freespace2 directory, the game looks for all the game data (models, missions, textures, tables, ...). Retail version only looks inside ''Freespace2/data/'' structure and ''Freespace2/vp archives''.

This flag allows installing several different mods that modify retail behaviour, and switching between them without needing to erase files or having undesired cross effects. Each mod should be installed in its own folder.

It takes one argument string: the chain of names of the used directories. Comma (''',''') must be used as separator. In this way, '''-mod dir1,dir2,dir3,...,dirx''' causes the game to use the following directory precedence:

#Freespace2/dir1/
#Freespace2/dir2/
#Freespace2/dir3/
# ... (the rest of the typed directories) ...
#Freespace2/dirx/
#Freespace2/

:::Please note. Freespace Open doesn't like spaces in directories (in the full path) so do not install the game within ''Program Files/Freespace2'' or ''Games/Freespace 2'' and, of course, do not use spaces within mod directories (''dir1'' is OK but ''dir 1'' isn't).

This flag can be indirectly set, (and it is normally set), through Launcher MOD tab and mod.ini file. Within this Launcher tab you can select one directory, (let's call it ''moddir''), so the flag is at least set to '''-mod moddir'''. If ''Freespace2/moddir/mod.ini'' exists, (its format must be plain text), it will be read and, inside it, the following section and lines can be used to modify the -mod flag too:

: [multimod] PrimaryList = Pri1,Pri2,...(the rest of desired directories)...,Prix; SecondaryList = Sec1,Sec2,...(the rest of desired directories)...,Secx;

(Please note the ending semicolon (;) in each list line). With these lines the following flag would be built:
: '''-mod Pri1,Pri2,...,Prix,moddir,Sec1,Sec2,...,Secx'''

If primary or secondary folders aren't used, their respective line can be erased or it can be typed as ''xxxxxxList = ;''.

::: '''''PLEASE NOTE''': '''Launcher v 5.4''', or later, '''must be used'''. Earlier versions had some bugs that would cause the previous explanation about mod.ini fail.''

::: The most common use of mod.ini and SecondaryList is sharing resources between mods. And the best example is the enhaced media vps from SCP crew. Most of the people install them in a folder called ''mediavps'' inside ''Freespace2''. In this way when running retail FS2 they do not interfere with this original game version that doesn't use this -mod flag feature. When using FS2_Open but without mods, you just need to select ''mediavps'' in Launcher MOD tab to use them. And if you want to enjoy that enhacements while playing any 'real' mod, you just need to put a mod.ini file inside its ''moddir'' with at least a ''SecondaryList = mediavps;'' line.

Inside each directory, data precedence is the following:

#Individual files located in ''Current_dir/data/'' subdir structure.
#Files located inside vp archives. (These vp archives are 'similar' to zip archives, they just contain other files and folders. Moreover, files have to be stored using the same ''data/'' structure used outside it). Vp archives are read in alphabetical order so aaa.vp files have higher priority than aab.vp files and so on.

The highest priority file overrides the rest of them. In this way, if you have a ''Mission.fs2'' inside ''Freespace2/Pri1/data/missions/'' it doesn't matter how this ''Mission.fs2'' is inside ''Freespace2/Pri1/aaa.vp'', ''Freespace2/Pri1/aab.vp'', ... or ''Freespace2/data/missions/''. This data precedence allows the user to quickly replace old files by corrected or enhaced ones adding them in a higher priority place.

As derived from explanation, the exact names for directories or vp archives are actually irrelevant. It only matters the directory order inside -mod flag argument and the alphabetical order for vp archives inside each used directory.

:'''Additional notes'''

# This flag is also used by FRED. So if there is special mod info, (like backgrounds maps, ship models or whatever), it must be typed, (''Fred2_Open_r.exe -MOD whatever''), or FRED won't be able to use it. No Launcher MOD tab available for this use. 
# Be careful while typing the directory names in the flag argument or inside mod.ini files. The program doesn't check if the typed directories exist. If they do not exist, they are just ignored. No warnings, no errors, no messages at all.

====-fov====
Specifies the Field of View for the player eyepoint.

Takes one argument decimal specifying the angle of the viewing cone in radians, from 0 to 2*pi

You can set the cone of view making things look bigger/smaller. The problem with this is that if you choose a small FOV, you will have a squashed look on the edges of your screen - stretched edges with a too high FOV. It is recommended to change the FOV as FS2 normally has some perspective distortion at the screen edges (FOV too high). Set the FOV to something like 0.39 - it will fix the distortion problem, and (as a nice side effect) will make everything look bigger and more realistic scale-wise. The default is 0.75, if you go higher, you'll get the fish-eye effect. Feel free to experiment. This must be entered into the "Custom flags" field

''Because of an active bug, FOV can misalign target boxes, effects, etc. Please check [http://lore.maxgaming.net/~scp/mantis/bug_view_advanced_page.php?bug_id=0000083 Mantis bug 083 status]if you are going to change the default value.''

----

===Multiplayer===
====-gamename====
Specifies the name of the game to be created by the host. This only works when used in conjunction with -startgame. This does nothing when used with -standalone.

Takes one argument string, the name to be assigned to the game being created.

See related: [[Command-Line_Reference#-startgame|-startgame]]

====-password====
Specifies the password for a stand-alone server. This only works when used in conjunction with -startgame. Cannot be used in conjunction with -closed or -restricted.

Takes one argument string, the required password for the game being created.

See related: [[Command-Line_Reference#-startgame|-startgame]] [[Command-Line_Reference#-closed|-closed]] [[Command-Line_Reference#-restricted|-restricted]]

====-allowabove====
Specifies a player's minimum rank for joining a game on a stand-alone server.

Takes one argument integer, the points ranking above which a player must be to enter the game.
====-allowbelow====
Specifies a player's maximum rank for joining a game on a stand-alone server.

Takes one argument integer, the points ranking below which a player must be to enter the game.
====-port====
Specifies the port on which to run for a stand-alone server.

Takes one argument integer, the port which the game should use to connect.
====-connect====
'''''What does this do?'''''
====-clientdamage====
'''''What does this do?'''''
====-timeout====
'''''What does this do?'''''

[[Category:Lists]]
[[Category:Source Code Project]]

Command-Line Reference

2006-09-25T05:54:38Z

Martellato: updated -password

==Launcher Flags==
The following command-line options can be chosen from the launcher.
===Graphics===
====-spec====
Enables specular mapping. Only polygons mapped with textures for which a shinemap exists will recieve specular mapping; no attempt is made to generate spec maps where they do not exist. Specular maps are specified with the base map name plus "-shine" (i.e. TCov3A-shine.pcx).
====-env====
Enables environment mapping. Environment mapping intensity will be determined from the intensity of specular maps. At the time of this writing (build 3.6.9 RC7), environment mapping only works when the video mode is OpenGL. [[Installing_fs2_open#Video setup|See Video setup.]]

====-glow====
Enables glowmapping. Only polygons mapped with textures for which a glowmap exists will be glowmapped. Glow maps are specified with the base map name plus "-glow" (i.e. TCov4A-glow.pcx)

====-jpgtga====
Enables the use of TGA and JPG file formats for image files. If a ship is showing up partially invisible, select this option.
====-pcx32====
'''WARNING - HIGH MEMORY USAGE'''

Enables PCX files to be loaded into 32-bit memory. This will not imporove the rendering of any ships in-game, and is usually more of a burden on performance than is worthwhile. Use at your own risk. Removed from launcher options after 3.6.7.

====-cell====
Enables cell shading. This will make graphics appear more "cartoonish". For use with media in mv_cell.vp. Not considered a standard enhancement.
====-mipmap====
Enables mipmapping.

====-nomotiondebris====
Disables motion debris.
====-2d_poof====
Applies nebula poofs in 2d, effectively preventing them from forming intersections with ships.
====-noscalevid====
Disables scaling of video clips.
====-missile_lighting====
Applys lighting to missiles.
====-rlm====
'''Obsolete Argument'''


Enables more accurate lighting model for OpenGL mode. Always on in current builds, so this command-line option has been removed.

----

===Game Speed===
====-img2dds====
Converts all images to DDS (compressed) format. Decreases memory usage but potentially reduces image quality.
====-no_vsync====
Disables vertical sync.
====-cache_bitmaps====
Caches bitmaps between missions, which will ideally reduce the load-time from one mission to another.

----

===HUD===
====-dualscanlines====
Adds a second pair of scanning lines to the target window when scanning an object.
====-targetinfo====
Displays target info, such as name and class, beside the targeted object.
====-orbradar====
Enables 3D radar (the Orb). 3D radar will replace the standard 2D version.
====-ballistic_gauge====
Adds an ammo gauge to the HUD when armed with a ballistic weapon.
====-rearm_timer====
Displays time remaining until rearm and repair from a support ship is complete.

----

===Gameplay===
====-smart_shields====
Enables "smart" shield recharging. Shield recharge is distributed to the most damaged shield quadrant instead of being distributed equally across the entire shield and be wasted when a quadrant is full.
====-ship_choice_3d====
Use ship and weapon models in ship selection and weapon loadout. Completely disables the standard ANI interface on those screens.
====-3dwarp====
Use full geometry for the subspace warp effect.
====-warp_flash====
Enable a flash at warp in and warp out.
====-UseNewAI====
Tells the game to use new AI routines. This argument alters mission balance and is not considered a standard feature.
====-tbp====
Enable feature set for The Babylon Project
====-wcsaga====
Enable feature set for The Wing Commander Saga

----

===Audio===
====-snd_preload====
Preload mission sounds. Useful in preventing game stuttering when sounds are played for the first time.
====-nosound====
Disables all sounds.
====-nomusic====
Disables music only.

----

===Multiplayer===
====-standalone====
Creates a standalone server.
====-startgame====
'''''What does this do?'''''
====-closed====
Hosts a new game in a closed state, where no one can join until the in-game "Close" button is cleared. This only works when used in conjunction with -startgame. Cannot be used in conjunction with -restricted or -password.

See related: [[Command-Line_Reference#-startgame|-startgame]] [[Command-Line_Reference#-restricted|-restricted]] [[Command-Line_Reference#-password|-password]]

====-restricted====
Hosts a new game in a restricted state. The host is presented with option to accept or deny each client's request to join the game. This only works when used in conjunction with -startgame. Cannot be used in conjunction with -closed or -password.

See related: [[Command-Line_Reference#-startgame|-startgame]] [[Command-Line_Reference#-closed|-closed]] [[Command-Line_Reference#-password|-password]]

====-multilog====
Creates a log file with a summary of packets sent and received in multiplayer games. The file is saved as \data\multi.log within the active mod folder - or with main data folder if no mod is active.

====-clientdamage====
This feature is not available in current builds.

====-mpnoreturn====
Disables return to the flight deck screen after a mission completes.

----

===Troubleshooting===
====-fixbugs====
'''Obsolete Argument - Removed in builds after 3.6.7'''


Originally used to disable certain crashing behavior as a stop-gap measure. This feature is not available in current builds.
====-nocrash====
'''Obsolete Argument - Removed in builds after 3.6.7'''


Originally used to disable certain crashing behavior as a stop-gap measure. This feature is not available in current builds.
====-oldfire====
This feature is not available in current builds.

====-nohtl====
'''WARNING - VERY SLOW'''

Reverts to software rendering mode. Does this work any more?
====-no_set_gamma====
Disables the gamma settings in the options screen.
====-nomovies====
Disables all video playback.
====-noparseerrors====
Disables some parsing warnings and makes other parse errors non-fatal. Do not rely on this when creating new tables, the errors are there for a reason.
====-safeloading====
Loads missions the old way. Typically safer, but slower.
====-query_speech====
Determines if the current build includes text-to-speech.
====-d3d_bad_tsys====
Enable inefficient texture system.
====-novbo====
Disables OpenGL VBO.
====-noibx====
Disables IBX caching of model geometry data. This will dramatically increase load times, but will help troubleshoot a model if one is working incorrectly.
====-loadallweps====
Load all weapons, even those not used.

----

===Experimental===
====-alpha_env====
Enables alpha environment mapping. OpenGL only. Environment mapping intensity will be determined from the alpha channel of specular maps.
====-decals====
Enables damage decals.
====-ingame_join====
Enables ingame joining in multiplayer. FIXME: Host option?
====-tga16====
'''Obsolete Argument - Removed in builds after 3.6.7'''


Originally used to converts TGA images to 16-bits in order to reduce memory footprint (at the expense of image quality), superseded by ''-img2dds''.
----

===Development Tools===
====-fps====
Displays current frames per second.
====-pos====
Displays current position coordinates of camera.
====-window====
Runs the game in a window. No check to make sure that resolution is no higher than your desktop resolution, so be careful.
====-timerbar====
Displays a timing bar across the top of the screen. Timebar format varies by build.
====-stats====
Shows total and free physical memory, virtual memory and system pagefile.

====-coords====
Shows coordinates of the mouse cursor.
====-show_mem_usage====
Shows detailed RAM usage in HUD.

The meaning of the info displayed in the upper right corner is:

'''DYN''' = dynamic memory, basically anything that's been allocated by the vm_* memory functions. This does NOT indicate total memory usage but does account for most of it.

'''POF''' = model memory, how much memory is being used by models (does not include textures)

'''C-BMP, BMP''' = bmpman memory, how much is used by the textures/images that are loaded. C-BMP means that you are using -cache_bitmaps and it will try to keep textures in memory between level loads and as the new level is loading it will keep what it needs and unload what it doesn't. Can greatly increase level loading speed, but does so at the cost of memory between level loads. This does not increase overall memory usage though, only during the loading screen. BMP means that it is not cached and all textures are unloaded from memory at the start of level load and all needed textures are then loaded from the disk again.

'''S-RAM''' = sound memory, how much is used by the sounds loaded in memory at the time. This counts static sounds only (from sounds.tbl, etc.) and not streaming sounds (music, voices, briefing stuff, etc).

'''V-RAM''' = approximate memory usage of video textures. This is not mean that your card has this much memory and can report higher numbers that your card actually has memory. For OpenGL it also includes some of the geometry data, but this number does not reflect the total memory that your video card is using. It only reports how much data the game has purposefully loaded into API memory (meaning it could be in system memory, video card memory, or AGP memory).

''(It only works with debug builds, not with release builds).''

====-pofspew====
'''''What does this do?'''''
====-tablecrcs====
'''''What does this do?'''''
====-missioncrcs====
'''''What does this do?'''''
====-dis_collisions====
Disables all collisions.
====-dis_weapons====
Disables weapons rendering.
====-output_sexps====
Outputs SEXPs to sexps.html.
====-output_scripting====
Outputs scripting to scripting.html.
====-nograb====
Unix only. Disables focus grabbing in a window.
==Other==
The following options are not available as checkboxes in the launcher. Many require parameters, which follow the flag seperated by a space. The prototype for use in this case is "-option argument"
===Graphics===
====-ambient_factor====

This must be entered into the "Custom flags" field. This is a multiplier applied to the intensity of ambient lighting. Ambient light is lighting applied to all parts of a ship. FS2's standard value is 120. Try 75 for a good and realistic looking value. However, that is relative.

====-spec_exp====

This must be used with the -spec command line parameter and must be entered into the "Custom flags" field. Adjusts the size of the shiny spot on ships. Higher number mean smaller spots. Default is 16, however 11 is recommended. However, that is relative.

====-spec_point====

This must be used with the -spec command line parameter and must be entered into the
"Custom flags" field. Adjusts how much laser weapons contribute to specular highlights. Higher number mean greater contributions. Default is 1.0, however 0.6 is recommended. However, that is relative.

====-spec_static====

This must be used with the -spec command line parameter and must be entered into the "Custom flags" field. Adjusts how much suns contribute to specular highlights. Higher numbers mean a greater contribution. Default is 1.0, however is 0.8 recommended. However, that is relative.

====-spec_tube====

This must be used with the -spec command line parameter and must be entered into the "Custom flags" field. Adjusts how much Beam Weapons contribute to specular highlights. Higher numbers mean a greater contribution. Default is 1.0, however 0.4 is recommended. However, that is relative.

====-clipdist====
Changes the distance from the viewpoint for the near-clipping plane.

Takes one argument decimal specifying the distance to the near-clipping plane.

----

===Gameplay===
====-mod====

Specifies in which folders inside Freespace2 directory, the game looks for all the game data (models, missions, textures, tables, ...). Retail version only looks inside ''Freespace2/data/'' structure and ''Freespace2/vp archives''.

This flag allows installing several different mods that modify retail behaviour, and switching between them without needing to erase files or having undesired cross effects. Each mod should be installed in its own folder.

It takes one argument string: the chain of names of the used directories. Comma (''',''') must be used as separator. In this way, '''-mod dir1,dir2,dir3,...,dirx''' causes the game to use the following directory precedence:

#Freespace2/dir1/
#Freespace2/dir2/
#Freespace2/dir3/
# ... (the rest of the typed directories) ...
#Freespace2/dirx/
#Freespace2/

:::Please note. Freespace Open doesn't like spaces in directories (in the full path) so do not install the game within ''Program Files/Freespace2'' or ''Games/Freespace 2'' and, of course, do not use spaces within mod directories (''dir1'' is OK but ''dir 1'' isn't).

This flag can be indirectly set, (and it is normally set), through Launcher MOD tab and mod.ini file. Within this Launcher tab you can select one directory, (let's call it ''moddir''), so the flag is at least set to '''-mod moddir'''. If ''Freespace2/moddir/mod.ini'' exists, (its format must be plain text), it will be read and, inside it, the following section and lines can be used to modify the -mod flag too:

: [multimod] PrimaryList = Pri1,Pri2,...(the rest of desired directories)...,Prix; SecondaryList = Sec1,Sec2,...(the rest of desired directories)...,Secx;

(Please note the ending semicolon (;) in each list line). With these lines the following flag would be built:
: '''-mod Pri1,Pri2,...,Prix,moddir,Sec1,Sec2,...,Secx'''

If primary or secondary folders aren't used, their respective line can be erased or it can be typed as ''xxxxxxList = ;''.

::: '''''PLEASE NOTE''': '''Launcher v 5.4''', or later, '''must be used'''. Earlier versions had some bugs that would cause the previous explanation about mod.ini fail.''

::: The most common use of mod.ini and SecondaryList is sharing resources between mods. And the best example is the enhaced media vps from SCP crew. Most of the people install them in a folder called ''mediavps'' inside ''Freespace2''. In this way when running retail FS2 they do not interfere with this original game version that doesn't use this -mod flag feature. When using FS2_Open but without mods, you just need to select ''mediavps'' in Launcher MOD tab to use them. And if you want to enjoy that enhacements while playing any 'real' mod, you just need to put a mod.ini file inside its ''moddir'' with at least a ''SecondaryList = mediavps;'' line.

Inside each directory, data precedence is the following:

#Individual files located in ''Current_dir/data/'' subdir structure.
#Files located inside vp archives. (These vp archives are 'similar' to zip archives, they just contain other files and folders. Moreover, files have to be stored using the same ''data/'' structure used outside it). Vp archives are read in alphabetical order so aaa.vp files have higher priority than aab.vp files and so on.

The highest priority file overrides the rest of them. In this way, if you have a ''Mission.fs2'' inside ''Freespace2/Pri1/data/missions/'' it doesn't matter how this ''Mission.fs2'' is inside ''Freespace2/Pri1/aaa.vp'', ''Freespace2/Pri1/aab.vp'', ... or ''Freespace2/data/missions/''. This data precedence allows the user to quickly replace old files by corrected or enhaced ones adding them in a higher priority place.

As derived from explanation, the exact names for directories or vp archives are actually irrelevant. It only matters the directory order inside -mod flag argument and the alphabetical order for vp archives inside each used directory.

:'''Additional notes'''

# This flag is also used by FRED. So if there is special mod info, (like backgrounds maps, ship models or whatever), it must be typed, (''Fred2_Open_r.exe -MOD whatever''), or FRED won't be able to use it. No Launcher MOD tab available for this use. 
# Be careful while typing the directory names in the flag argument or inside mod.ini files. The program doesn't check if the typed directories exist. If they do not exist, they are just ignored. No warnings, no errors, no messages at all.

====-fov====
Specifies the Field of View for the player eyepoint.

Takes one argument decimal specifying the angle of the viewing cone in radians, from 0 to 2*pi

You can set the cone of view making things look bigger/smaller. The problem with this is that if you choose a small FOV, you will have a squashed look on the edges of your screen - stretched edges with a too high FOV. It is recommended to change the FOV as FS2 normally has some perspective distortion at the screen edges (FOV too high). Set the FOV to something like 0.39 - it will fix the distortion problem, and (as a nice side effect) will make everything look bigger and more realistic scale-wise. The default is 0.75, if you go higher, you'll get the fish-eye effect. Feel free to experiment. This must be entered into the "Custom flags" field

''Because of an active bug, FOV can misalign target boxes, effects, etc. Please check [http://lore.maxgaming.net/~scp/mantis/bug_view_advanced_page.php?bug_id=0000083 Mantis bug 083 status]if you are going to change the default value.''

----

===Multiplayer===
====-gamename====
Specifies the name of the game to be created by the host. This only works when used in conjunction with -startgame. This does nothing when used with -standalone.

Takes one argument string, the name to be assigned to the game being created.

See related: [[Command-Line_Reference#-startgame|-startgame]]

====-password====
Specifies the password for a stand-alone server. This only works when used in conjunction with -startgame. Cannot be used in conjunction with -closed or -password.

Takes one argument string, the required password for the game being created.

See related: [[Command-Line_Reference#-startgame|-startgame]] [[Command-Line_Reference#-closed|-closed]] [[Command-Line_Reference#-password|-password]]

====-allowabove====
Specifies a player's minimum rank for joining a game on a stand-alone server.

Takes one argument integer, the points ranking above which a player must be to enter the game.
====-allowbelow====
Specifies a player's maximum rank for joining a game on a stand-alone server.

Takes one argument integer, the points ranking below which a player must be to enter the game.
====-port====
Specifies the port on which to run for a stand-alone server.

Takes one argument integer, the port which the game should use to connect.
====-connect====
'''''What does this do?'''''
====-clientdamage====
'''''What does this do?'''''
====-timeout====
'''''What does this do?'''''

[[Category:Lists]]
[[Category:Source Code Project]]

Command-Line Reference

2006-09-25T05:53:13Z

Martellato: updated -closed

==Launcher Flags==
The following command-line options can be chosen from the launcher.
===Graphics===
====-spec====
Enables specular mapping. Only polygons mapped with textures for which a shinemap exists will recieve specular mapping; no attempt is made to generate spec maps where they do not exist. Specular maps are specified with the base map name plus "-shine" (i.e. TCov3A-shine.pcx).
====-env====
Enables environment mapping. Environment mapping intensity will be determined from the intensity of specular maps. At the time of this writing (build 3.6.9 RC7), environment mapping only works when the video mode is OpenGL. [[Installing_fs2_open#Video setup|See Video setup.]]

====-glow====
Enables glowmapping. Only polygons mapped with textures for which a glowmap exists will be glowmapped. Glow maps are specified with the base map name plus "-glow" (i.e. TCov4A-glow.pcx)

====-jpgtga====
Enables the use of TGA and JPG file formats for image files. If a ship is showing up partially invisible, select this option.
====-pcx32====
'''WARNING - HIGH MEMORY USAGE'''

Enables PCX files to be loaded into 32-bit memory. This will not imporove the rendering of any ships in-game, and is usually more of a burden on performance than is worthwhile. Use at your own risk. Removed from launcher options after 3.6.7.

====-cell====
Enables cell shading. This will make graphics appear more "cartoonish". For use with media in mv_cell.vp. Not considered a standard enhancement.
====-mipmap====
Enables mipmapping.

====-nomotiondebris====
Disables motion debris.
====-2d_poof====
Applies nebula poofs in 2d, effectively preventing them from forming intersections with ships.
====-noscalevid====
Disables scaling of video clips.
====-missile_lighting====
Applys lighting to missiles.
====-rlm====
'''Obsolete Argument'''


Enables more accurate lighting model for OpenGL mode. Always on in current builds, so this command-line option has been removed.

----

===Game Speed===
====-img2dds====
Converts all images to DDS (compressed) format. Decreases memory usage but potentially reduces image quality.
====-no_vsync====
Disables vertical sync.
====-cache_bitmaps====
Caches bitmaps between missions, which will ideally reduce the load-time from one mission to another.

----

===HUD===
====-dualscanlines====
Adds a second pair of scanning lines to the target window when scanning an object.
====-targetinfo====
Displays target info, such as name and class, beside the targeted object.
====-orbradar====
Enables 3D radar (the Orb). 3D radar will replace the standard 2D version.
====-ballistic_gauge====
Adds an ammo gauge to the HUD when armed with a ballistic weapon.
====-rearm_timer====
Displays time remaining until rearm and repair from a support ship is complete.

----

===Gameplay===
====-smart_shields====
Enables "smart" shield recharging. Shield recharge is distributed to the most damaged shield quadrant instead of being distributed equally across the entire shield and be wasted when a quadrant is full.
====-ship_choice_3d====
Use ship and weapon models in ship selection and weapon loadout. Completely disables the standard ANI interface on those screens.
====-3dwarp====
Use full geometry for the subspace warp effect.
====-warp_flash====
Enable a flash at warp in and warp out.
====-UseNewAI====
Tells the game to use new AI routines. This argument alters mission balance and is not considered a standard feature.
====-tbp====
Enable feature set for The Babylon Project
====-wcsaga====
Enable feature set for The Wing Commander Saga

----

===Audio===
====-snd_preload====
Preload mission sounds. Useful in preventing game stuttering when sounds are played for the first time.
====-nosound====
Disables all sounds.
====-nomusic====
Disables music only.

----

===Multiplayer===
====-standalone====
Creates a standalone server.
====-startgame====
'''''What does this do?'''''
====-closed====
Hosts a new game in a closed state, where no one can join until the in-game "Close" button is cleared. This only works when used in conjunction with -startgame. Cannot be used in conjunction with -restricted or -password.

See related: [[Command-Line_Reference#-startgame|-startgame]] [[Command-Line_Reference#-restricted|-restricted]] [[Command-Line_Reference#-password|-password]]

====-restricted====
Hosts a new game in a restricted state. The host is presented with option to accept or deny each client's request to join the game. This only works when used in conjunction with -startgame. Cannot be used in conjunction with -closed or -password.

See related: [[Command-Line_Reference#-startgame|-startgame]] [[Command-Line_Reference#-closed|-closed]] [[Command-Line_Reference#-password|-password]]

====-multilog====
Creates a log file with a summary of packets sent and received in multiplayer games. The file is saved as \data\multi.log within the active mod folder - or with main data folder if no mod is active.

====-clientdamage====
This feature is not available in current builds.

====-mpnoreturn====
Disables return to the flight deck screen after a mission completes.

----

===Troubleshooting===
====-fixbugs====
'''Obsolete Argument - Removed in builds after 3.6.7'''


Originally used to disable certain crashing behavior as a stop-gap measure. This feature is not available in current builds.
====-nocrash====
'''Obsolete Argument - Removed in builds after 3.6.7'''


Originally used to disable certain crashing behavior as a stop-gap measure. This feature is not available in current builds.
====-oldfire====
This feature is not available in current builds.

====-nohtl====
'''WARNING - VERY SLOW'''

Reverts to software rendering mode. Does this work any more?
====-no_set_gamma====
Disables the gamma settings in the options screen.
====-nomovies====
Disables all video playback.
====-noparseerrors====
Disables some parsing warnings and makes other parse errors non-fatal. Do not rely on this when creating new tables, the errors are there for a reason.
====-safeloading====
Loads missions the old way. Typically safer, but slower.
====-query_speech====
Determines if the current build includes text-to-speech.
====-d3d_bad_tsys====
Enable inefficient texture system.
====-novbo====
Disables OpenGL VBO.
====-noibx====
Disables IBX caching of model geometry data. This will dramatically increase load times, but will help troubleshoot a model if one is working incorrectly.
====-loadallweps====
Load all weapons, even those not used.

----

===Experimental===
====-alpha_env====
Enables alpha environment mapping. OpenGL only. Environment mapping intensity will be determined from the alpha channel of specular maps.
====-decals====
Enables damage decals.
====-ingame_join====
Enables ingame joining in multiplayer. FIXME: Host option?
====-tga16====
'''Obsolete Argument - Removed in builds after 3.6.7'''


Originally used to converts TGA images to 16-bits in order to reduce memory footprint (at the expense of image quality), superseded by ''-img2dds''.
----

===Development Tools===
====-fps====
Displays current frames per second.
====-pos====
Displays current position coordinates of camera.
====-window====
Runs the game in a window. No check to make sure that resolution is no higher than your desktop resolution, so be careful.
====-timerbar====
Displays a timing bar across the top of the screen. Timebar format varies by build.
====-stats====
Shows total and free physical memory, virtual memory and system pagefile.

====-coords====
Shows coordinates of the mouse cursor.
====-show_mem_usage====
Shows detailed RAM usage in HUD.

The meaning of the info displayed in the upper right corner is:

'''DYN''' = dynamic memory, basically anything that's been allocated by the vm_* memory functions. This does NOT indicate total memory usage but does account for most of it.

'''POF''' = model memory, how much memory is being used by models (does not include textures)

'''C-BMP, BMP''' = bmpman memory, how much is used by the textures/images that are loaded. C-BMP means that you are using -cache_bitmaps and it will try to keep textures in memory between level loads and as the new level is loading it will keep what it needs and unload what it doesn't. Can greatly increase level loading speed, but does so at the cost of memory between level loads. This does not increase overall memory usage though, only during the loading screen. BMP means that it is not cached and all textures are unloaded from memory at the start of level load and all needed textures are then loaded from the disk again.

'''S-RAM''' = sound memory, how much is used by the sounds loaded in memory at the time. This counts static sounds only (from sounds.tbl, etc.) and not streaming sounds (music, voices, briefing stuff, etc).

'''V-RAM''' = approximate memory usage of video textures. This is not mean that your card has this much memory and can report higher numbers that your card actually has memory. For OpenGL it also includes some of the geometry data, but this number does not reflect the total memory that your video card is using. It only reports how much data the game has purposefully loaded into API memory (meaning it could be in system memory, video card memory, or AGP memory).

''(It only works with debug builds, not with release builds).''

====-pofspew====
'''''What does this do?'''''
====-tablecrcs====
'''''What does this do?'''''
====-missioncrcs====
'''''What does this do?'''''
====-dis_collisions====
Disables all collisions.
====-dis_weapons====
Disables weapons rendering.
====-output_sexps====
Outputs SEXPs to sexps.html.
====-output_scripting====
Outputs scripting to scripting.html.
====-nograb====
Unix only. Disables focus grabbing in a window.
==Other==
The following options are not available as checkboxes in the launcher. Many require parameters, which follow the flag seperated by a space. The prototype for use in this case is "-option argument"
===Graphics===
====-ambient_factor====

This must be entered into the "Custom flags" field. This is a multiplier applied to the intensity of ambient lighting. Ambient light is lighting applied to all parts of a ship. FS2's standard value is 120. Try 75 for a good and realistic looking value. However, that is relative.

====-spec_exp====

This must be used with the -spec command line parameter and must be entered into the "Custom flags" field. Adjusts the size of the shiny spot on ships. Higher number mean smaller spots. Default is 16, however 11 is recommended. However, that is relative.

====-spec_point====

This must be used with the -spec command line parameter and must be entered into the
"Custom flags" field. Adjusts how much laser weapons contribute to specular highlights. Higher number mean greater contributions. Default is 1.0, however 0.6 is recommended. However, that is relative.

====-spec_static====

This must be used with the -spec command line parameter and must be entered into the "Custom flags" field. Adjusts how much suns contribute to specular highlights. Higher numbers mean a greater contribution. Default is 1.0, however is 0.8 recommended. However, that is relative.

====-spec_tube====

This must be used with the -spec command line parameter and must be entered into the "Custom flags" field. Adjusts how much Beam Weapons contribute to specular highlights. Higher numbers mean a greater contribution. Default is 1.0, however 0.4 is recommended. However, that is relative.

====-clipdist====
Changes the distance from the viewpoint for the near-clipping plane.

Takes one argument decimal specifying the distance to the near-clipping plane.

----

===Gameplay===
====-mod====

Specifies in which folders inside Freespace2 directory, the game looks for all the game data (models, missions, textures, tables, ...). Retail version only looks inside ''Freespace2/data/'' structure and ''Freespace2/vp archives''.

This flag allows installing several different mods that modify retail behaviour, and switching between them without needing to erase files or having undesired cross effects. Each mod should be installed in its own folder.

It takes one argument string: the chain of names of the used directories. Comma (''',''') must be used as separator. In this way, '''-mod dir1,dir2,dir3,...,dirx''' causes the game to use the following directory precedence:

#Freespace2/dir1/
#Freespace2/dir2/
#Freespace2/dir3/
# ... (the rest of the typed directories) ...
#Freespace2/dirx/
#Freespace2/

:::Please note. Freespace Open doesn't like spaces in directories (in the full path) so do not install the game within ''Program Files/Freespace2'' or ''Games/Freespace 2'' and, of course, do not use spaces within mod directories (''dir1'' is OK but ''dir 1'' isn't).

This flag can be indirectly set, (and it is normally set), through Launcher MOD tab and mod.ini file. Within this Launcher tab you can select one directory, (let's call it ''moddir''), so the flag is at least set to '''-mod moddir'''. If ''Freespace2/moddir/mod.ini'' exists, (its format must be plain text), it will be read and, inside it, the following section and lines can be used to modify the -mod flag too:

: [multimod] PrimaryList = Pri1,Pri2,...(the rest of desired directories)...,Prix; SecondaryList = Sec1,Sec2,...(the rest of desired directories)...,Secx;

(Please note the ending semicolon (;) in each list line). With these lines the following flag would be built:
: '''-mod Pri1,Pri2,...,Prix,moddir,Sec1,Sec2,...,Secx'''

If primary or secondary folders aren't used, their respective line can be erased or it can be typed as ''xxxxxxList = ;''.

::: '''''PLEASE NOTE''': '''Launcher v 5.4''', or later, '''must be used'''. Earlier versions had some bugs that would cause the previous explanation about mod.ini fail.''

::: The most common use of mod.ini and SecondaryList is sharing resources between mods. And the best example is the enhaced media vps from SCP crew. Most of the people install them in a folder called ''mediavps'' inside ''Freespace2''. In this way when running retail FS2 they do not interfere with this original game version that doesn't use this -mod flag feature. When using FS2_Open but without mods, you just need to select ''mediavps'' in Launcher MOD tab to use them. And if you want to enjoy that enhacements while playing any 'real' mod, you just need to put a mod.ini file inside its ''moddir'' with at least a ''SecondaryList = mediavps;'' line.

Inside each directory, data precedence is the following:

#Individual files located in ''Current_dir/data/'' subdir structure.
#Files located inside vp archives. (These vp archives are 'similar' to zip archives, they just contain other files and folders. Moreover, files have to be stored using the same ''data/'' structure used outside it). Vp archives are read in alphabetical order so aaa.vp files have higher priority than aab.vp files and so on.

The highest priority file overrides the rest of them. In this way, if you have a ''Mission.fs2'' inside ''Freespace2/Pri1/data/missions/'' it doesn't matter how this ''Mission.fs2'' is inside ''Freespace2/Pri1/aaa.vp'', ''Freespace2/Pri1/aab.vp'', ... or ''Freespace2/data/missions/''. This data precedence allows the user to quickly replace old files by corrected or enhaced ones adding them in a higher priority place.

As derived from explanation, the exact names for directories or vp archives are actually irrelevant. It only matters the directory order inside -mod flag argument and the alphabetical order for vp archives inside each used directory.

:'''Additional notes'''

# This flag is also used by FRED. So if there is special mod info, (like backgrounds maps, ship models or whatever), it must be typed, (''Fred2_Open_r.exe -MOD whatever''), or FRED won't be able to use it. No Launcher MOD tab available for this use. 
# Be careful while typing the directory names in the flag argument or inside mod.ini files. The program doesn't check if the typed directories exist. If they do not exist, they are just ignored. No warnings, no errors, no messages at all.

====-fov====
Specifies the Field of View for the player eyepoint.

Takes one argument decimal specifying the angle of the viewing cone in radians, from 0 to 2*pi

You can set the cone of view making things look bigger/smaller. The problem with this is that if you choose a small FOV, you will have a squashed look on the edges of your screen - stretched edges with a too high FOV. It is recommended to change the FOV as FS2 normally has some perspective distortion at the screen edges (FOV too high). Set the FOV to something like 0.39 - it will fix the distortion problem, and (as a nice side effect) will make everything look bigger and more realistic scale-wise. The default is 0.75, if you go higher, you'll get the fish-eye effect. Feel free to experiment. This must be entered into the "Custom flags" field

''Because of an active bug, FOV can misalign target boxes, effects, etc. Please check [http://lore.maxgaming.net/~scp/mantis/bug_view_advanced_page.php?bug_id=0000083 Mantis bug 083 status]if you are going to change the default value.''

----

===Multiplayer===
====-gamename====
Specifies the name of the game to be created by the host. This only works when used in conjunction with -startgame. This does nothing when used with -standalone.

Takes one argument string, the name to be assigned to the game being created.

See related: [[Command-Line_Reference#-startgame|-startgame]]

====-password====
Specifies the password for a stand-alone server.

Takes one argument string, the required password for the game being created.
====-allowabove====
Specifies a player's minimum rank for joining a game on a stand-alone server.

Takes one argument integer, the points ranking above which a player must be to enter the game.
====-allowbelow====
Specifies a player's maximum rank for joining a game on a stand-alone server.

Takes one argument integer, the points ranking below which a player must be to enter the game.
====-port====
Specifies the port on which to run for a stand-alone server.

Takes one argument integer, the port which the game should use to connect.
====-connect====
'''''What does this do?'''''
====-clientdamage====
'''''What does this do?'''''
====-timeout====
'''''What does this do?'''''

[[Category:Lists]]
[[Category:Source Code Project]]

Command-Line Reference

2006-09-25T05:52:21Z

Martellato: updated -restricted

==Launcher Flags==
The following command-line options can be chosen from the launcher.
===Graphics===
====-spec====
Enables specular mapping. Only polygons mapped with textures for which a shinemap exists will recieve specular mapping; no attempt is made to generate spec maps where they do not exist. Specular maps are specified with the base map name plus "-shine" (i.e. TCov3A-shine.pcx).
====-env====
Enables environment mapping. Environment mapping intensity will be determined from the intensity of specular maps. At the time of this writing (build 3.6.9 RC7), environment mapping only works when the video mode is OpenGL. [[Installing_fs2_open#Video setup|See Video setup.]]

====-glow====
Enables glowmapping. Only polygons mapped with textures for which a glowmap exists will be glowmapped. Glow maps are specified with the base map name plus "-glow" (i.e. TCov4A-glow.pcx)

====-jpgtga====
Enables the use of TGA and JPG file formats for image files. If a ship is showing up partially invisible, select this option.
====-pcx32====
'''WARNING - HIGH MEMORY USAGE'''

Enables PCX files to be loaded into 32-bit memory. This will not imporove the rendering of any ships in-game, and is usually more of a burden on performance than is worthwhile. Use at your own risk. Removed from launcher options after 3.6.7.

====-cell====
Enables cell shading. This will make graphics appear more "cartoonish". For use with media in mv_cell.vp. Not considered a standard enhancement.
====-mipmap====
Enables mipmapping.

====-nomotiondebris====
Disables motion debris.
====-2d_poof====
Applies nebula poofs in 2d, effectively preventing them from forming intersections with ships.
====-noscalevid====
Disables scaling of video clips.
====-missile_lighting====
Applys lighting to missiles.
====-rlm====
'''Obsolete Argument'''


Enables more accurate lighting model for OpenGL mode. Always on in current builds, so this command-line option has been removed.

----

===Game Speed===
====-img2dds====
Converts all images to DDS (compressed) format. Decreases memory usage but potentially reduces image quality.
====-no_vsync====
Disables vertical sync.
====-cache_bitmaps====
Caches bitmaps between missions, which will ideally reduce the load-time from one mission to another.

----

===HUD===
====-dualscanlines====
Adds a second pair of scanning lines to the target window when scanning an object.
====-targetinfo====
Displays target info, such as name and class, beside the targeted object.
====-orbradar====
Enables 3D radar (the Orb). 3D radar will replace the standard 2D version.
====-ballistic_gauge====
Adds an ammo gauge to the HUD when armed with a ballistic weapon.
====-rearm_timer====
Displays time remaining until rearm and repair from a support ship is complete.

----

===Gameplay===
====-smart_shields====
Enables "smart" shield recharging. Shield recharge is distributed to the most damaged shield quadrant instead of being distributed equally across the entire shield and be wasted when a quadrant is full.
====-ship_choice_3d====
Use ship and weapon models in ship selection and weapon loadout. Completely disables the standard ANI interface on those screens.
====-3dwarp====
Use full geometry for the subspace warp effect.
====-warp_flash====
Enable a flash at warp in and warp out.
====-UseNewAI====
Tells the game to use new AI routines. This argument alters mission balance and is not considered a standard feature.
====-tbp====
Enable feature set for The Babylon Project
====-wcsaga====
Enable feature set for The Wing Commander Saga

----

===Audio===
====-snd_preload====
Preload mission sounds. Useful in preventing game stuttering when sounds are played for the first time.
====-nosound====
Disables all sounds.
====-nomusic====
Disables music only.

----

===Multiplayer===
====-standalone====
Creates a standalone server.
====-startgame====
'''''What does this do?'''''
====-closed====
Hosts a new game in a closed state, where no one can join until the in-game "Close" button is cleared. This only works when used in conjunction with -startgame.

See related: [[Command-Line_Reference#-startgame|-startgame]]

====-restricted====
Hosts a new game in a restricted state. The host is presented with option to accept or deny each client's request to join the game. This only works when used in conjunction with -startgame. Cannot be used in conjunction with -closed or -password.

See related: [[Command-Line_Reference#-startgame|-startgame]] [[Command-Line_Reference#-closed|-closed]] [[Command-Line_Reference#-password|-password]]

====-multilog====
Creates a log file with a summary of packets sent and received in multiplayer games. The file is saved as \data\multi.log within the active mod folder - or with main data folder if no mod is active.

====-clientdamage====
This feature is not available in current builds.

====-mpnoreturn====
Disables return to the flight deck screen after a mission completes.

----

===Troubleshooting===
====-fixbugs====
'''Obsolete Argument - Removed in builds after 3.6.7'''


Originally used to disable certain crashing behavior as a stop-gap measure. This feature is not available in current builds.
====-nocrash====
'''Obsolete Argument - Removed in builds after 3.6.7'''


Originally used to disable certain crashing behavior as a stop-gap measure. This feature is not available in current builds.
====-oldfire====
This feature is not available in current builds.

====-nohtl====
'''WARNING - VERY SLOW'''

Reverts to software rendering mode. Does this work any more?
====-no_set_gamma====
Disables the gamma settings in the options screen.
====-nomovies====
Disables all video playback.
====-noparseerrors====
Disables some parsing warnings and makes other parse errors non-fatal. Do not rely on this when creating new tables, the errors are there for a reason.
====-safeloading====
Loads missions the old way. Typically safer, but slower.
====-query_speech====
Determines if the current build includes text-to-speech.
====-d3d_bad_tsys====
Enable inefficient texture system.
====-novbo====
Disables OpenGL VBO.
====-noibx====
Disables IBX caching of model geometry data. This will dramatically increase load times, but will help troubleshoot a model if one is working incorrectly.
====-loadallweps====
Load all weapons, even those not used.

----

===Experimental===
====-alpha_env====
Enables alpha environment mapping. OpenGL only. Environment mapping intensity will be determined from the alpha channel of specular maps.
====-decals====
Enables damage decals.
====-ingame_join====
Enables ingame joining in multiplayer. FIXME: Host option?
====-tga16====
'''Obsolete Argument - Removed in builds after 3.6.7'''


Originally used to converts TGA images to 16-bits in order to reduce memory footprint (at the expense of image quality), superseded by ''-img2dds''.
----

===Development Tools===
====-fps====
Displays current frames per second.
====-pos====
Displays current position coordinates of camera.
====-window====
Runs the game in a window. No check to make sure that resolution is no higher than your desktop resolution, so be careful.
====-timerbar====
Displays a timing bar across the top of the screen. Timebar format varies by build.
====-stats====
Shows total and free physical memory, virtual memory and system pagefile.

====-coords====
Shows coordinates of the mouse cursor.
====-show_mem_usage====
Shows detailed RAM usage in HUD.

The meaning of the info displayed in the upper right corner is:

'''DYN''' = dynamic memory, basically anything that's been allocated by the vm_* memory functions. This does NOT indicate total memory usage but does account for most of it.

'''POF''' = model memory, how much memory is being used by models (does not include textures)

'''C-BMP, BMP''' = bmpman memory, how much is used by the textures/images that are loaded. C-BMP means that you are using -cache_bitmaps and it will try to keep textures in memory between level loads and as the new level is loading it will keep what it needs and unload what it doesn't. Can greatly increase level loading speed, but does so at the cost of memory between level loads. This does not increase overall memory usage though, only during the loading screen. BMP means that it is not cached and all textures are unloaded from memory at the start of level load and all needed textures are then loaded from the disk again.

'''S-RAM''' = sound memory, how much is used by the sounds loaded in memory at the time. This counts static sounds only (from sounds.tbl, etc.) and not streaming sounds (music, voices, briefing stuff, etc).

'''V-RAM''' = approximate memory usage of video textures. This is not mean that your card has this much memory and can report higher numbers that your card actually has memory. For OpenGL it also includes some of the geometry data, but this number does not reflect the total memory that your video card is using. It only reports how much data the game has purposefully loaded into API memory (meaning it could be in system memory, video card memory, or AGP memory).

''(It only works with debug builds, not with release builds).''

====-pofspew====
'''''What does this do?'''''
====-tablecrcs====
'''''What does this do?'''''
====-missioncrcs====
'''''What does this do?'''''
====-dis_collisions====
Disables all collisions.
====-dis_weapons====
Disables weapons rendering.
====-output_sexps====
Outputs SEXPs to sexps.html.
====-output_scripting====
Outputs scripting to scripting.html.
====-nograb====
Unix only. Disables focus grabbing in a window.
==Other==
The following options are not available as checkboxes in the launcher. Many require parameters, which follow the flag seperated by a space. The prototype for use in this case is "-option argument"
===Graphics===
====-ambient_factor====

This must be entered into the "Custom flags" field. This is a multiplier applied to the intensity of ambient lighting. Ambient light is lighting applied to all parts of a ship. FS2's standard value is 120. Try 75 for a good and realistic looking value. However, that is relative.

====-spec_exp====

This must be used with the -spec command line parameter and must be entered into the "Custom flags" field. Adjusts the size of the shiny spot on ships. Higher number mean smaller spots. Default is 16, however 11 is recommended. However, that is relative.

====-spec_point====

This must be used with the -spec command line parameter and must be entered into the
"Custom flags" field. Adjusts how much laser weapons contribute to specular highlights. Higher number mean greater contributions. Default is 1.0, however 0.6 is recommended. However, that is relative.

====-spec_static====

This must be used with the -spec command line parameter and must be entered into the "Custom flags" field. Adjusts how much suns contribute to specular highlights. Higher numbers mean a greater contribution. Default is 1.0, however is 0.8 recommended. However, that is relative.

====-spec_tube====

This must be used with the -spec command line parameter and must be entered into the "Custom flags" field. Adjusts how much Beam Weapons contribute to specular highlights. Higher numbers mean a greater contribution. Default is 1.0, however 0.4 is recommended. However, that is relative.

====-clipdist====
Changes the distance from the viewpoint for the near-clipping plane.

Takes one argument decimal specifying the distance to the near-clipping plane.

----

===Gameplay===
====-mod====

Specifies in which folders inside Freespace2 directory, the game looks for all the game data (models, missions, textures, tables, ...). Retail version only looks inside ''Freespace2/data/'' structure and ''Freespace2/vp archives''.

This flag allows installing several different mods that modify retail behaviour, and switching between them without needing to erase files or having undesired cross effects. Each mod should be installed in its own folder.

It takes one argument string: the chain of names of the used directories. Comma (''',''') must be used as separator. In this way, '''-mod dir1,dir2,dir3,...,dirx''' causes the game to use the following directory precedence:

#Freespace2/dir1/
#Freespace2/dir2/
#Freespace2/dir3/
# ... (the rest of the typed directories) ...
#Freespace2/dirx/
#Freespace2/

:::Please note. Freespace Open doesn't like spaces in directories (in the full path) so do not install the game within ''Program Files/Freespace2'' or ''Games/Freespace 2'' and, of course, do not use spaces within mod directories (''dir1'' is OK but ''dir 1'' isn't).

This flag can be indirectly set, (and it is normally set), through Launcher MOD tab and mod.ini file. Within this Launcher tab you can select one directory, (let's call it ''moddir''), so the flag is at least set to '''-mod moddir'''. If ''Freespace2/moddir/mod.ini'' exists, (its format must be plain text), it will be read and, inside it, the following section and lines can be used to modify the -mod flag too:

: [multimod] PrimaryList = Pri1,Pri2,...(the rest of desired directories)...,Prix; SecondaryList = Sec1,Sec2,...(the rest of desired directories)...,Secx;

(Please note the ending semicolon (;) in each list line). With these lines the following flag would be built:
: '''-mod Pri1,Pri2,...,Prix,moddir,Sec1,Sec2,...,Secx'''

If primary or secondary folders aren't used, their respective line can be erased or it can be typed as ''xxxxxxList = ;''.

::: '''''PLEASE NOTE''': '''Launcher v 5.4''', or later, '''must be used'''. Earlier versions had some bugs that would cause the previous explanation about mod.ini fail.''

::: The most common use of mod.ini and SecondaryList is sharing resources between mods. And the best example is the enhaced media vps from SCP crew. Most of the people install them in a folder called ''mediavps'' inside ''Freespace2''. In this way when running retail FS2 they do not interfere with this original game version that doesn't use this -mod flag feature. When using FS2_Open but without mods, you just need to select ''mediavps'' in Launcher MOD tab to use them. And if you want to enjoy that enhacements while playing any 'real' mod, you just need to put a mod.ini file inside its ''moddir'' with at least a ''SecondaryList = mediavps;'' line.

Inside each directory, data precedence is the following:

#Individual files located in ''Current_dir/data/'' subdir structure.
#Files located inside vp archives. (These vp archives are 'similar' to zip archives, they just contain other files and folders. Moreover, files have to be stored using the same ''data/'' structure used outside it). Vp archives are read in alphabetical order so aaa.vp files have higher priority than aab.vp files and so on.

The highest priority file overrides the rest of them. In this way, if you have a ''Mission.fs2'' inside ''Freespace2/Pri1/data/missions/'' it doesn't matter how this ''Mission.fs2'' is inside ''Freespace2/Pri1/aaa.vp'', ''Freespace2/Pri1/aab.vp'', ... or ''Freespace2/data/missions/''. This data precedence allows the user to quickly replace old files by corrected or enhaced ones adding them in a higher priority place.

As derived from explanation, the exact names for directories or vp archives are actually irrelevant. It only matters the directory order inside -mod flag argument and the alphabetical order for vp archives inside each used directory.

:'''Additional notes'''

# This flag is also used by FRED. So if there is special mod info, (like backgrounds maps, ship models or whatever), it must be typed, (''Fred2_Open_r.exe -MOD whatever''), or FRED won't be able to use it. No Launcher MOD tab available for this use. 
# Be careful while typing the directory names in the flag argument or inside mod.ini files. The program doesn't check if the typed directories exist. If they do not exist, they are just ignored. No warnings, no errors, no messages at all.

====-fov====
Specifies the Field of View for the player eyepoint.

Takes one argument decimal specifying the angle of the viewing cone in radians, from 0 to 2*pi

You can set the cone of view making things look bigger/smaller. The problem with this is that if you choose a small FOV, you will have a squashed look on the edges of your screen - stretched edges with a too high FOV. It is recommended to change the FOV as FS2 normally has some perspective distortion at the screen edges (FOV too high). Set the FOV to something like 0.39 - it will fix the distortion problem, and (as a nice side effect) will make everything look bigger and more realistic scale-wise. The default is 0.75, if you go higher, you'll get the fish-eye effect. Feel free to experiment. This must be entered into the "Custom flags" field

''Because of an active bug, FOV can misalign target boxes, effects, etc. Please check [http://lore.maxgaming.net/~scp/mantis/bug_view_advanced_page.php?bug_id=0000083 Mantis bug 083 status]if you are going to change the default value.''

----

===Multiplayer===
====-gamename====
Specifies the name of the game to be created by the host. This only works when used in conjunction with -startgame. This does nothing when used with -standalone.

Takes one argument string, the name to be assigned to the game being created.

See related: [[Command-Line_Reference#-startgame|-startgame]]

====-password====
Specifies the password for a stand-alone server.

Takes one argument string, the required password for the game being created.
====-allowabove====
Specifies a player's minimum rank for joining a game on a stand-alone server.

Takes one argument integer, the points ranking above which a player must be to enter the game.
====-allowbelow====
Specifies a player's maximum rank for joining a game on a stand-alone server.

Takes one argument integer, the points ranking below which a player must be to enter the game.
====-port====
Specifies the port on which to run for a stand-alone server.

Takes one argument integer, the port which the game should use to connect.
====-connect====
'''''What does this do?'''''
====-clientdamage====
'''''What does this do?'''''
====-timeout====
'''''What does this do?'''''

[[Category:Lists]]
[[Category:Source Code Project]]

Command-Line Reference

2006-09-25T05:50:10Z

Martellato: fixed error in description for -restricted

==Launcher Flags==
The following command-line options can be chosen from the launcher.
===Graphics===
====-spec====
Enables specular mapping. Only polygons mapped with textures for which a shinemap exists will recieve specular mapping; no attempt is made to generate spec maps where they do not exist. Specular maps are specified with the base map name plus "-shine" (i.e. TCov3A-shine.pcx).
====-env====
Enables environment mapping. Environment mapping intensity will be determined from the intensity of specular maps. At the time of this writing (build 3.6.9 RC7), environment mapping only works when the video mode is OpenGL. [[Installing_fs2_open#Video setup|See Video setup.]]

====-glow====
Enables glowmapping. Only polygons mapped with textures for which a glowmap exists will be glowmapped. Glow maps are specified with the base map name plus "-glow" (i.e. TCov4A-glow.pcx)

====-jpgtga====
Enables the use of TGA and JPG file formats for image files. If a ship is showing up partially invisible, select this option.
====-pcx32====
'''WARNING - HIGH MEMORY USAGE'''

Enables PCX files to be loaded into 32-bit memory. This will not imporove the rendering of any ships in-game, and is usually more of a burden on performance than is worthwhile. Use at your own risk. Removed from launcher options after 3.6.7.

====-cell====
Enables cell shading. This will make graphics appear more "cartoonish". For use with media in mv_cell.vp. Not considered a standard enhancement.
====-mipmap====
Enables mipmapping.

====-nomotiondebris====
Disables motion debris.
====-2d_poof====
Applies nebula poofs in 2d, effectively preventing them from forming intersections with ships.
====-noscalevid====
Disables scaling of video clips.
====-missile_lighting====
Applys lighting to missiles.
====-rlm====
'''Obsolete Argument'''


Enables more accurate lighting model for OpenGL mode. Always on in current builds, so this command-line option has been removed.

----

===Game Speed===
====-img2dds====
Converts all images to DDS (compressed) format. Decreases memory usage but potentially reduces image quality.
====-no_vsync====
Disables vertical sync.
====-cache_bitmaps====
Caches bitmaps between missions, which will ideally reduce the load-time from one mission to another.

----

===HUD===
====-dualscanlines====
Adds a second pair of scanning lines to the target window when scanning an object.
====-targetinfo====
Displays target info, such as name and class, beside the targeted object.
====-orbradar====
Enables 3D radar (the Orb). 3D radar will replace the standard 2D version.
====-ballistic_gauge====
Adds an ammo gauge to the HUD when armed with a ballistic weapon.
====-rearm_timer====
Displays time remaining until rearm and repair from a support ship is complete.

----

===Gameplay===
====-smart_shields====
Enables "smart" shield recharging. Shield recharge is distributed to the most damaged shield quadrant instead of being distributed equally across the entire shield and be wasted when a quadrant is full.
====-ship_choice_3d====
Use ship and weapon models in ship selection and weapon loadout. Completely disables the standard ANI interface on those screens.
====-3dwarp====
Use full geometry for the subspace warp effect.
====-warp_flash====
Enable a flash at warp in and warp out.
====-UseNewAI====
Tells the game to use new AI routines. This argument alters mission balance and is not considered a standard feature.
====-tbp====
Enable feature set for The Babylon Project
====-wcsaga====
Enable feature set for The Wing Commander Saga

----

===Audio===
====-snd_preload====
Preload mission sounds. Useful in preventing game stuttering when sounds are played for the first time.
====-nosound====
Disables all sounds.
====-nomusic====
Disables music only.

----

===Multiplayer===
====-standalone====
Creates a standalone server.
====-startgame====
'''''What does this do?'''''
====-closed====
Hosts a new game in a closed state, where no one can join until the in-game "Close" button is cleared. This only works when used in conjunction with -startgame.

See related: [[Command-Line_Reference#-startgame|-startgame]]

====-restricted====
Hosts a new game in a restricted state. The host is presented with option to accept or deny each client's request to join the game. This only works when used in conjunction with -startgame.

See related: [[Command-Line_Reference#-startgame|-startgame]]

====-multilog====
Creates a log file with a summary of packets sent and received in multiplayer games. The file is saved as \data\multi.log within the active mod folder - or with main data folder if no mod is active.

====-clientdamage====
This feature is not available in current builds.

====-mpnoreturn====
Disables return to the flight deck screen after a mission completes.

----

===Troubleshooting===
====-fixbugs====
'''Obsolete Argument - Removed in builds after 3.6.7'''


Originally used to disable certain crashing behavior as a stop-gap measure. This feature is not available in current builds.
====-nocrash====
'''Obsolete Argument - Removed in builds after 3.6.7'''


Originally used to disable certain crashing behavior as a stop-gap measure. This feature is not available in current builds.
====-oldfire====
This feature is not available in current builds.

====-nohtl====
'''WARNING - VERY SLOW'''

Reverts to software rendering mode. Does this work any more?
====-no_set_gamma====
Disables the gamma settings in the options screen.
====-nomovies====
Disables all video playback.
====-noparseerrors====
Disables some parsing warnings and makes other parse errors non-fatal. Do not rely on this when creating new tables, the errors are there for a reason.
====-safeloading====
Loads missions the old way. Typically safer, but slower.
====-query_speech====
Determines if the current build includes text-to-speech.
====-d3d_bad_tsys====
Enable inefficient texture system.
====-novbo====
Disables OpenGL VBO.
====-noibx====
Disables IBX caching of model geometry data. This will dramatically increase load times, but will help troubleshoot a model if one is working incorrectly.
====-loadallweps====
Load all weapons, even those not used.

----

===Experimental===
====-alpha_env====
Enables alpha environment mapping. OpenGL only. Environment mapping intensity will be determined from the alpha channel of specular maps.
====-decals====
Enables damage decals.
====-ingame_join====
Enables ingame joining in multiplayer. FIXME: Host option?
====-tga16====
'''Obsolete Argument - Removed in builds after 3.6.7'''


Originally used to converts TGA images to 16-bits in order to reduce memory footprint (at the expense of image quality), superseded by ''-img2dds''.
----

===Development Tools===
====-fps====
Displays current frames per second.
====-pos====
Displays current position coordinates of camera.
====-window====
Runs the game in a window. No check to make sure that resolution is no higher than your desktop resolution, so be careful.
====-timerbar====
Displays a timing bar across the top of the screen. Timebar format varies by build.
====-stats====
Shows total and free physical memory, virtual memory and system pagefile.

====-coords====
Shows coordinates of the mouse cursor.
====-show_mem_usage====
Shows detailed RAM usage in HUD.

The meaning of the info displayed in the upper right corner is:

'''DYN''' = dynamic memory, basically anything that's been allocated by the vm_* memory functions. This does NOT indicate total memory usage but does account for most of it.

'''POF''' = model memory, how much memory is being used by models (does not include textures)

'''C-BMP, BMP''' = bmpman memory, how much is used by the textures/images that are loaded. C-BMP means that you are using -cache_bitmaps and it will try to keep textures in memory between level loads and as the new level is loading it will keep what it needs and unload what it doesn't. Can greatly increase level loading speed, but does so at the cost of memory between level loads. This does not increase overall memory usage though, only during the loading screen. BMP means that it is not cached and all textures are unloaded from memory at the start of level load and all needed textures are then loaded from the disk again.

'''S-RAM''' = sound memory, how much is used by the sounds loaded in memory at the time. This counts static sounds only (from sounds.tbl, etc.) and not streaming sounds (music, voices, briefing stuff, etc).

'''V-RAM''' = approximate memory usage of video textures. This is not mean that your card has this much memory and can report higher numbers that your card actually has memory. For OpenGL it also includes some of the geometry data, but this number does not reflect the total memory that your video card is using. It only reports how much data the game has purposefully loaded into API memory (meaning it could be in system memory, video card memory, or AGP memory).

''(It only works with debug builds, not with release builds).''

====-pofspew====
'''''What does this do?'''''
====-tablecrcs====
'''''What does this do?'''''
====-missioncrcs====
'''''What does this do?'''''
====-dis_collisions====
Disables all collisions.
====-dis_weapons====
Disables weapons rendering.
====-output_sexps====
Outputs SEXPs to sexps.html.
====-output_scripting====
Outputs scripting to scripting.html.
====-nograb====
Unix only. Disables focus grabbing in a window.
==Other==
The following options are not available as checkboxes in the launcher. Many require parameters, which follow the flag seperated by a space. The prototype for use in this case is "-option argument"
===Graphics===
====-ambient_factor====

This must be entered into the "Custom flags" field. This is a multiplier applied to the intensity of ambient lighting. Ambient light is lighting applied to all parts of a ship. FS2's standard value is 120. Try 75 for a good and realistic looking value. However, that is relative.

====-spec_exp====

This must be used with the -spec command line parameter and must be entered into the "Custom flags" field. Adjusts the size of the shiny spot on ships. Higher number mean smaller spots. Default is 16, however 11 is recommended. However, that is relative.

====-spec_point====

This must be used with the -spec command line parameter and must be entered into the
"Custom flags" field. Adjusts how much laser weapons contribute to specular highlights. Higher number mean greater contributions. Default is 1.0, however 0.6 is recommended. However, that is relative.

====-spec_static====

This must be used with the -spec command line parameter and must be entered into the "Custom flags" field. Adjusts how much suns contribute to specular highlights. Higher numbers mean a greater contribution. Default is 1.0, however is 0.8 recommended. However, that is relative.

====-spec_tube====

This must be used with the -spec command line parameter and must be entered into the "Custom flags" field. Adjusts how much Beam Weapons contribute to specular highlights. Higher numbers mean a greater contribution. Default is 1.0, however 0.4 is recommended. However, that is relative.

====-clipdist====
Changes the distance from the viewpoint for the near-clipping plane.

Takes one argument decimal specifying the distance to the near-clipping plane.

----

===Gameplay===
====-mod====

Specifies in which folders inside Freespace2 directory, the game looks for all the game data (models, missions, textures, tables, ...). Retail version only looks inside ''Freespace2/data/'' structure and ''Freespace2/vp archives''.

This flag allows installing several different mods that modify retail behaviour, and switching between them without needing to erase files or having undesired cross effects. Each mod should be installed in its own folder.

It takes one argument string: the chain of names of the used directories. Comma (''',''') must be used as separator. In this way, '''-mod dir1,dir2,dir3,...,dirx''' causes the game to use the following directory precedence:

#Freespace2/dir1/
#Freespace2/dir2/
#Freespace2/dir3/
# ... (the rest of the typed directories) ...
#Freespace2/dirx/
#Freespace2/

:::Please note. Freespace Open doesn't like spaces in directories (in the full path) so do not install the game within ''Program Files/Freespace2'' or ''Games/Freespace 2'' and, of course, do not use spaces within mod directories (''dir1'' is OK but ''dir 1'' isn't).

This flag can be indirectly set, (and it is normally set), through Launcher MOD tab and mod.ini file. Within this Launcher tab you can select one directory, (let's call it ''moddir''), so the flag is at least set to '''-mod moddir'''. If ''Freespace2/moddir/mod.ini'' exists, (its format must be plain text), it will be read and, inside it, the following section and lines can be used to modify the -mod flag too:

: [multimod] PrimaryList = Pri1,Pri2,...(the rest of desired directories)...,Prix; SecondaryList = Sec1,Sec2,...(the rest of desired directories)...,Secx;

(Please note the ending semicolon (;) in each list line). With these lines the following flag would be built:
: '''-mod Pri1,Pri2,...,Prix,moddir,Sec1,Sec2,...,Secx'''

If primary or secondary folders aren't used, their respective line can be erased or it can be typed as ''xxxxxxList = ;''.

::: '''''PLEASE NOTE''': '''Launcher v 5.4''', or later, '''must be used'''. Earlier versions had some bugs that would cause the previous explanation about mod.ini fail.''

::: The most common use of mod.ini and SecondaryList is sharing resources between mods. And the best example is the enhaced media vps from SCP crew. Most of the people install them in a folder called ''mediavps'' inside ''Freespace2''. In this way when running retail FS2 they do not interfere with this original game version that doesn't use this -mod flag feature. When using FS2_Open but without mods, you just need to select ''mediavps'' in Launcher MOD tab to use them. And if you want to enjoy that enhacements while playing any 'real' mod, you just need to put a mod.ini file inside its ''moddir'' with at least a ''SecondaryList = mediavps;'' line.

Inside each directory, data precedence is the following:

#Individual files located in ''Current_dir/data/'' subdir structure.
#Files located inside vp archives. (These vp archives are 'similar' to zip archives, they just contain other files and folders. Moreover, files have to be stored using the same ''data/'' structure used outside it). Vp archives are read in alphabetical order so aaa.vp files have higher priority than aab.vp files and so on.

The highest priority file overrides the rest of them. In this way, if you have a ''Mission.fs2'' inside ''Freespace2/Pri1/data/missions/'' it doesn't matter how this ''Mission.fs2'' is inside ''Freespace2/Pri1/aaa.vp'', ''Freespace2/Pri1/aab.vp'', ... or ''Freespace2/data/missions/''. This data precedence allows the user to quickly replace old files by corrected or enhaced ones adding them in a higher priority place.

As derived from explanation, the exact names for directories or vp archives are actually irrelevant. It only matters the directory order inside -mod flag argument and the alphabetical order for vp archives inside each used directory.

:'''Additional notes'''

# This flag is also used by FRED. So if there is special mod info, (like backgrounds maps, ship models or whatever), it must be typed, (''Fred2_Open_r.exe -MOD whatever''), or FRED won't be able to use it. No Launcher MOD tab available for this use. 
# Be careful while typing the directory names in the flag argument or inside mod.ini files. The program doesn't check if the typed directories exist. If they do not exist, they are just ignored. No warnings, no errors, no messages at all.

====-fov====
Specifies the Field of View for the player eyepoint.

Takes one argument decimal specifying the angle of the viewing cone in radians, from 0 to 2*pi

You can set the cone of view making things look bigger/smaller. The problem with this is that if you choose a small FOV, you will have a squashed look on the edges of your screen - stretched edges with a too high FOV. It is recommended to change the FOV as FS2 normally has some perspective distortion at the screen edges (FOV too high). Set the FOV to something like 0.39 - it will fix the distortion problem, and (as a nice side effect) will make everything look bigger and more realistic scale-wise. The default is 0.75, if you go higher, you'll get the fish-eye effect. Feel free to experiment. This must be entered into the "Custom flags" field

''Because of an active bug, FOV can misalign target boxes, effects, etc. Please check [http://lore.maxgaming.net/~scp/mantis/bug_view_advanced_page.php?bug_id=0000083 Mantis bug 083 status]if you are going to change the default value.''

----

===Multiplayer===
====-gamename====
Specifies the name of the game to be created by the host. This only works when used in conjunction with -startgame. This does nothing when used with -standalone.

Takes one argument string, the name to be assigned to the game being created.

See related: [[Command-Line_Reference#-startgame|-startgame]]

====-password====
Specifies the password for a stand-alone server.

Takes one argument string, the required password for the game being created.
====-allowabove====
Specifies a player's minimum rank for joining a game on a stand-alone server.

Takes one argument integer, the points ranking above which a player must be to enter the game.
====-allowbelow====
Specifies a player's maximum rank for joining a game on a stand-alone server.

Takes one argument integer, the points ranking below which a player must be to enter the game.
====-port====
Specifies the port on which to run for a stand-alone server.

Takes one argument integer, the port which the game should use to connect.
====-connect====
'''''What does this do?'''''
====-clientdamage====
'''''What does this do?'''''
====-timeout====
'''''What does this do?'''''

[[Category:Lists]]
[[Category:Source Code Project]]

Command-Line Reference

2006-09-25T05:48:20Z

Martellato: updated -gamename

==Launcher Flags==
The following command-line options can be chosen from the launcher.
===Graphics===
====-spec====
Enables specular mapping. Only polygons mapped with textures for which a shinemap exists will recieve specular mapping; no attempt is made to generate spec maps where they do not exist. Specular maps are specified with the base map name plus "-shine" (i.e. TCov3A-shine.pcx).
====-env====
Enables environment mapping. Environment mapping intensity will be determined from the intensity of specular maps. At the time of this writing (build 3.6.9 RC7), environment mapping only works when the video mode is OpenGL. [[Installing_fs2_open#Video setup|See Video setup.]]

====-glow====
Enables glowmapping. Only polygons mapped with textures for which a glowmap exists will be glowmapped. Glow maps are specified with the base map name plus "-glow" (i.e. TCov4A-glow.pcx)

====-jpgtga====
Enables the use of TGA and JPG file formats for image files. If a ship is showing up partially invisible, select this option.
====-pcx32====
'''WARNING - HIGH MEMORY USAGE'''

Enables PCX files to be loaded into 32-bit memory. This will not imporove the rendering of any ships in-game, and is usually more of a burden on performance than is worthwhile. Use at your own risk. Removed from launcher options after 3.6.7.

====-cell====
Enables cell shading. This will make graphics appear more "cartoonish". For use with media in mv_cell.vp. Not considered a standard enhancement.
====-mipmap====
Enables mipmapping.

====-nomotiondebris====
Disables motion debris.
====-2d_poof====
Applies nebula poofs in 2d, effectively preventing them from forming intersections with ships.
====-noscalevid====
Disables scaling of video clips.
====-missile_lighting====
Applys lighting to missiles.
====-rlm====
'''Obsolete Argument'''


Enables more accurate lighting model for OpenGL mode. Always on in current builds, so this command-line option has been removed.

----

===Game Speed===
====-img2dds====
Converts all images to DDS (compressed) format. Decreases memory usage but potentially reduces image quality.
====-no_vsync====
Disables vertical sync.
====-cache_bitmaps====
Caches bitmaps between missions, which will ideally reduce the load-time from one mission to another.

----

===HUD===
====-dualscanlines====
Adds a second pair of scanning lines to the target window when scanning an object.
====-targetinfo====
Displays target info, such as name and class, beside the targeted object.
====-orbradar====
Enables 3D radar (the Orb). 3D radar will replace the standard 2D version.
====-ballistic_gauge====
Adds an ammo gauge to the HUD when armed with a ballistic weapon.
====-rearm_timer====
Displays time remaining until rearm and repair from a support ship is complete.

----

===Gameplay===
====-smart_shields====
Enables "smart" shield recharging. Shield recharge is distributed to the most damaged shield quadrant instead of being distributed equally across the entire shield and be wasted when a quadrant is full.
====-ship_choice_3d====
Use ship and weapon models in ship selection and weapon loadout. Completely disables the standard ANI interface on those screens.
====-3dwarp====
Use full geometry for the subspace warp effect.
====-warp_flash====
Enable a flash at warp in and warp out.
====-UseNewAI====
Tells the game to use new AI routines. This argument alters mission balance and is not considered a standard feature.
====-tbp====
Enable feature set for The Babylon Project
====-wcsaga====
Enable feature set for The Wing Commander Saga

----

===Audio===
====-snd_preload====
Preload mission sounds. Useful in preventing game stuttering when sounds are played for the first time.
====-nosound====
Disables all sounds.
====-nomusic====
Disables music only.

----

===Multiplayer===
====-standalone====
Creates a standalone server.
====-startgame====
'''''What does this do?'''''
====-closed====
Hosts a new game in a closed state, where no one can join until the in-game "Close" button is cleared. This only works when used in conjunction with -startgame.

See related: [[Command-Line_Reference#-startgame|-startgame]]

====-restricted====
This feature is not available in current builds.

====-multilog====
Creates a log file with a summary of packets sent and received in multiplayer games. The file is saved as \data\multi.log within the active mod folder - or with main data folder if no mod is active.

====-clientdamage====
This feature is not available in current builds.

====-mpnoreturn====
Disables return to the flight deck screen after a mission completes.

----

===Troubleshooting===
====-fixbugs====
'''Obsolete Argument - Removed in builds after 3.6.7'''


Originally used to disable certain crashing behavior as a stop-gap measure. This feature is not available in current builds.
====-nocrash====
'''Obsolete Argument - Removed in builds after 3.6.7'''


Originally used to disable certain crashing behavior as a stop-gap measure. This feature is not available in current builds.
====-oldfire====
This feature is not available in current builds.

====-nohtl====
'''WARNING - VERY SLOW'''

Reverts to software rendering mode. Does this work any more?
====-no_set_gamma====
Disables the gamma settings in the options screen.
====-nomovies====
Disables all video playback.
====-noparseerrors====
Disables some parsing warnings and makes other parse errors non-fatal. Do not rely on this when creating new tables, the errors are there for a reason.
====-safeloading====
Loads missions the old way. Typically safer, but slower.
====-query_speech====
Determines if the current build includes text-to-speech.
====-d3d_bad_tsys====
Enable inefficient texture system.
====-novbo====
Disables OpenGL VBO.
====-noibx====
Disables IBX caching of model geometry data. This will dramatically increase load times, but will help troubleshoot a model if one is working incorrectly.
====-loadallweps====
Load all weapons, even those not used.

----

===Experimental===
====-alpha_env====
Enables alpha environment mapping. OpenGL only. Environment mapping intensity will be determined from the alpha channel of specular maps.
====-decals====
Enables damage decals.
====-ingame_join====
Enables ingame joining in multiplayer. FIXME: Host option?
====-tga16====
'''Obsolete Argument - Removed in builds after 3.6.7'''


Originally used to converts TGA images to 16-bits in order to reduce memory footprint (at the expense of image quality), superseded by ''-img2dds''.
----

===Development Tools===
====-fps====
Displays current frames per second.
====-pos====
Displays current position coordinates of camera.
====-window====
Runs the game in a window. No check to make sure that resolution is no higher than your desktop resolution, so be careful.
====-timerbar====
Displays a timing bar across the top of the screen. Timebar format varies by build.
====-stats====
Shows total and free physical memory, virtual memory and system pagefile.

====-coords====
Shows coordinates of the mouse cursor.
====-show_mem_usage====
Shows detailed RAM usage in HUD.

The meaning of the info displayed in the upper right corner is:

'''DYN''' = dynamic memory, basically anything that's been allocated by the vm_* memory functions. This does NOT indicate total memory usage but does account for most of it.

'''POF''' = model memory, how much memory is being used by models (does not include textures)

'''C-BMP, BMP''' = bmpman memory, how much is used by the textures/images that are loaded. C-BMP means that you are using -cache_bitmaps and it will try to keep textures in memory between level loads and as the new level is loading it will keep what it needs and unload what it doesn't. Can greatly increase level loading speed, but does so at the cost of memory between level loads. This does not increase overall memory usage though, only during the loading screen. BMP means that it is not cached and all textures are unloaded from memory at the start of level load and all needed textures are then loaded from the disk again.

'''S-RAM''' = sound memory, how much is used by the sounds loaded in memory at the time. This counts static sounds only (from sounds.tbl, etc.) and not streaming sounds (music, voices, briefing stuff, etc).

'''V-RAM''' = approximate memory usage of video textures. This is not mean that your card has this much memory and can report higher numbers that your card actually has memory. For OpenGL it also includes some of the geometry data, but this number does not reflect the total memory that your video card is using. It only reports how much data the game has purposefully loaded into API memory (meaning it could be in system memory, video card memory, or AGP memory).

''(It only works with debug builds, not with release builds).''

====-pofspew====
'''''What does this do?'''''
====-tablecrcs====
'''''What does this do?'''''
====-missioncrcs====
'''''What does this do?'''''
====-dis_collisions====
Disables all collisions.
====-dis_weapons====
Disables weapons rendering.
====-output_sexps====
Outputs SEXPs to sexps.html.
====-output_scripting====
Outputs scripting to scripting.html.
====-nograb====
Unix only. Disables focus grabbing in a window.
==Other==
The following options are not available as checkboxes in the launcher. Many require parameters, which follow the flag seperated by a space. The prototype for use in this case is "-option argument"
===Graphics===
====-ambient_factor====

This must be entered into the "Custom flags" field. This is a multiplier applied to the intensity of ambient lighting. Ambient light is lighting applied to all parts of a ship. FS2's standard value is 120. Try 75 for a good and realistic looking value. However, that is relative.

====-spec_exp====

This must be used with the -spec command line parameter and must be entered into the "Custom flags" field. Adjusts the size of the shiny spot on ships. Higher number mean smaller spots. Default is 16, however 11 is recommended. However, that is relative.

====-spec_point====

This must be used with the -spec command line parameter and must be entered into the
"Custom flags" field. Adjusts how much laser weapons contribute to specular highlights. Higher number mean greater contributions. Default is 1.0, however 0.6 is recommended. However, that is relative.

====-spec_static====

This must be used with the -spec command line parameter and must be entered into the "Custom flags" field. Adjusts how much suns contribute to specular highlights. Higher numbers mean a greater contribution. Default is 1.0, however is 0.8 recommended. However, that is relative.

====-spec_tube====

This must be used with the -spec command line parameter and must be entered into the "Custom flags" field. Adjusts how much Beam Weapons contribute to specular highlights. Higher numbers mean a greater contribution. Default is 1.0, however 0.4 is recommended. However, that is relative.

====-clipdist====
Changes the distance from the viewpoint for the near-clipping plane.

Takes one argument decimal specifying the distance to the near-clipping plane.

----

===Gameplay===
====-mod====

Specifies in which folders inside Freespace2 directory, the game looks for all the game data (models, missions, textures, tables, ...). Retail version only looks inside ''Freespace2/data/'' structure and ''Freespace2/vp archives''.

This flag allows installing several different mods that modify retail behaviour, and switching between them without needing to erase files or having undesired cross effects. Each mod should be installed in its own folder.

It takes one argument string: the chain of names of the used directories. Comma (''',''') must be used as separator. In this way, '''-mod dir1,dir2,dir3,...,dirx''' causes the game to use the following directory precedence:

#Freespace2/dir1/
#Freespace2/dir2/
#Freespace2/dir3/
# ... (the rest of the typed directories) ...
#Freespace2/dirx/
#Freespace2/

:::Please note. Freespace Open doesn't like spaces in directories (in the full path) so do not install the game within ''Program Files/Freespace2'' or ''Games/Freespace 2'' and, of course, do not use spaces within mod directories (''dir1'' is OK but ''dir 1'' isn't).

This flag can be indirectly set, (and it is normally set), through Launcher MOD tab and mod.ini file. Within this Launcher tab you can select one directory, (let's call it ''moddir''), so the flag is at least set to '''-mod moddir'''. If ''Freespace2/moddir/mod.ini'' exists, (its format must be plain text), it will be read and, inside it, the following section and lines can be used to modify the -mod flag too:

: [multimod] PrimaryList = Pri1,Pri2,...(the rest of desired directories)...,Prix; SecondaryList = Sec1,Sec2,...(the rest of desired directories)...,Secx;

(Please note the ending semicolon (;) in each list line). With these lines the following flag would be built:
: '''-mod Pri1,Pri2,...,Prix,moddir,Sec1,Sec2,...,Secx'''

If primary or secondary folders aren't used, their respective line can be erased or it can be typed as ''xxxxxxList = ;''.

::: '''''PLEASE NOTE''': '''Launcher v 5.4''', or later, '''must be used'''. Earlier versions had some bugs that would cause the previous explanation about mod.ini fail.''

::: The most common use of mod.ini and SecondaryList is sharing resources between mods. And the best example is the enhaced media vps from SCP crew. Most of the people install them in a folder called ''mediavps'' inside ''Freespace2''. In this way when running retail FS2 they do not interfere with this original game version that doesn't use this -mod flag feature. When using FS2_Open but without mods, you just need to select ''mediavps'' in Launcher MOD tab to use them. And if you want to enjoy that enhacements while playing any 'real' mod, you just need to put a mod.ini file inside its ''moddir'' with at least a ''SecondaryList = mediavps;'' line.

Inside each directory, data precedence is the following:

#Individual files located in ''Current_dir/data/'' subdir structure.
#Files located inside vp archives. (These vp archives are 'similar' to zip archives, they just contain other files and folders. Moreover, files have to be stored using the same ''data/'' structure used outside it). Vp archives are read in alphabetical order so aaa.vp files have higher priority than aab.vp files and so on.

The highest priority file overrides the rest of them. In this way, if you have a ''Mission.fs2'' inside ''Freespace2/Pri1/data/missions/'' it doesn't matter how this ''Mission.fs2'' is inside ''Freespace2/Pri1/aaa.vp'', ''Freespace2/Pri1/aab.vp'', ... or ''Freespace2/data/missions/''. This data precedence allows the user to quickly replace old files by corrected or enhaced ones adding them in a higher priority place.

As derived from explanation, the exact names for directories or vp archives are actually irrelevant. It only matters the directory order inside -mod flag argument and the alphabetical order for vp archives inside each used directory.

:'''Additional notes'''

# This flag is also used by FRED. So if there is special mod info, (like backgrounds maps, ship models or whatever), it must be typed, (''Fred2_Open_r.exe -MOD whatever''), or FRED won't be able to use it. No Launcher MOD tab available for this use. 
# Be careful while typing the directory names in the flag argument or inside mod.ini files. The program doesn't check if the typed directories exist. If they do not exist, they are just ignored. No warnings, no errors, no messages at all.

====-fov====
Specifies the Field of View for the player eyepoint.

Takes one argument decimal specifying the angle of the viewing cone in radians, from 0 to 2*pi

You can set the cone of view making things look bigger/smaller. The problem with this is that if you choose a small FOV, you will have a squashed look on the edges of your screen - stretched edges with a too high FOV. It is recommended to change the FOV as FS2 normally has some perspective distortion at the screen edges (FOV too high). Set the FOV to something like 0.39 - it will fix the distortion problem, and (as a nice side effect) will make everything look bigger and more realistic scale-wise. The default is 0.75, if you go higher, you'll get the fish-eye effect. Feel free to experiment. This must be entered into the "Custom flags" field

''Because of an active bug, FOV can misalign target boxes, effects, etc. Please check [http://lore.maxgaming.net/~scp/mantis/bug_view_advanced_page.php?bug_id=0000083 Mantis bug 083 status]if you are going to change the default value.''

----

===Multiplayer===
====-gamename====
Specifies the name of the game to be created by the host. This only works when used in conjunction with -startgame. This does nothing when used with -standalone.

Takes one argument string, the name to be assigned to the game being created.

See related: [[Command-Line_Reference#-startgame|-startgame]]

====-password====
Specifies the password for a stand-alone server.

Takes one argument string, the required password for the game being created.
====-allowabove====
Specifies a player's minimum rank for joining a game on a stand-alone server.

Takes one argument integer, the points ranking above which a player must be to enter the game.
====-allowbelow====
Specifies a player's maximum rank for joining a game on a stand-alone server.

Takes one argument integer, the points ranking below which a player must be to enter the game.
====-port====
Specifies the port on which to run for a stand-alone server.

Takes one argument integer, the port which the game should use to connect.
====-connect====
'''''What does this do?'''''
====-clientdamage====
'''''What does this do?'''''
====-timeout====
'''''What does this do?'''''

[[Category:Lists]]
[[Category:Source Code Project]]

Command-Line Reference

2006-09-25T05:41:25Z

Martellato: corrected mistake in description

==Launcher Flags==
The following command-line options can be chosen from the launcher.
===Graphics===
====-spec====
Enables specular mapping. Only polygons mapped with textures for which a shinemap exists will recieve specular mapping; no attempt is made to generate spec maps where they do not exist. Specular maps are specified with the base map name plus "-shine" (i.e. TCov3A-shine.pcx).
====-env====
Enables environment mapping. Environment mapping intensity will be determined from the intensity of specular maps. At the time of this writing (build 3.6.9 RC7), environment mapping only works when the video mode is OpenGL. [[Installing_fs2_open#Video setup|See Video setup.]]

====-glow====
Enables glowmapping. Only polygons mapped with textures for which a glowmap exists will be glowmapped. Glow maps are specified with the base map name plus "-glow" (i.e. TCov4A-glow.pcx)

====-jpgtga====
Enables the use of TGA and JPG file formats for image files. If a ship is showing up partially invisible, select this option.
====-pcx32====
'''WARNING - HIGH MEMORY USAGE'''

Enables PCX files to be loaded into 32-bit memory. This will not imporove the rendering of any ships in-game, and is usually more of a burden on performance than is worthwhile. Use at your own risk. Removed from launcher options after 3.6.7.

====-cell====
Enables cell shading. This will make graphics appear more "cartoonish". For use with media in mv_cell.vp. Not considered a standard enhancement.
====-mipmap====
Enables mipmapping.

====-nomotiondebris====
Disables motion debris.
====-2d_poof====
Applies nebula poofs in 2d, effectively preventing them from forming intersections with ships.
====-noscalevid====
Disables scaling of video clips.
====-missile_lighting====
Applys lighting to missiles.
====-rlm====
'''Obsolete Argument'''


Enables more accurate lighting model for OpenGL mode. Always on in current builds, so this command-line option has been removed.

----

===Game Speed===
====-img2dds====
Converts all images to DDS (compressed) format. Decreases memory usage but potentially reduces image quality.
====-no_vsync====
Disables vertical sync.
====-cache_bitmaps====
Caches bitmaps between missions, which will ideally reduce the load-time from one mission to another.

----

===HUD===
====-dualscanlines====
Adds a second pair of scanning lines to the target window when scanning an object.
====-targetinfo====
Displays target info, such as name and class, beside the targeted object.
====-orbradar====
Enables 3D radar (the Orb). 3D radar will replace the standard 2D version.
====-ballistic_gauge====
Adds an ammo gauge to the HUD when armed with a ballistic weapon.
====-rearm_timer====
Displays time remaining until rearm and repair from a support ship is complete.

----

===Gameplay===
====-smart_shields====
Enables "smart" shield recharging. Shield recharge is distributed to the most damaged shield quadrant instead of being distributed equally across the entire shield and be wasted when a quadrant is full.
====-ship_choice_3d====
Use ship and weapon models in ship selection and weapon loadout. Completely disables the standard ANI interface on those screens.
====-3dwarp====
Use full geometry for the subspace warp effect.
====-warp_flash====
Enable a flash at warp in and warp out.
====-UseNewAI====
Tells the game to use new AI routines. This argument alters mission balance and is not considered a standard feature.
====-tbp====
Enable feature set for The Babylon Project
====-wcsaga====
Enable feature set for The Wing Commander Saga

----

===Audio===
====-snd_preload====
Preload mission sounds. Useful in preventing game stuttering when sounds are played for the first time.
====-nosound====
Disables all sounds.
====-nomusic====
Disables music only.

----

===Multiplayer===
====-standalone====
Creates a standalone server.
====-startgame====
'''''What does this do?'''''
====-closed====
Hosts a new game in a closed state, where no one can join until the in-game "Close" button is cleared. This only works when used in conjunction with -startgame.

See related: [[Command-Line_Reference#-startgame|-startgame]]

====-restricted====
This feature is not available in current builds.

====-multilog====
Creates a log file with a summary of packets sent and received in multiplayer games. The file is saved as \data\multi.log within the active mod folder - or with main data folder if no mod is active.

====-clientdamage====
This feature is not available in current builds.

====-mpnoreturn====
Disables return to the flight deck screen after a mission completes.

----

===Troubleshooting===
====-fixbugs====
'''Obsolete Argument - Removed in builds after 3.6.7'''


Originally used to disable certain crashing behavior as a stop-gap measure. This feature is not available in current builds.
====-nocrash====
'''Obsolete Argument - Removed in builds after 3.6.7'''


Originally used to disable certain crashing behavior as a stop-gap measure. This feature is not available in current builds.
====-oldfire====
This feature is not available in current builds.

====-nohtl====
'''WARNING - VERY SLOW'''

Reverts to software rendering mode. Does this work any more?
====-no_set_gamma====
Disables the gamma settings in the options screen.
====-nomovies====
Disables all video playback.
====-noparseerrors====
Disables some parsing warnings and makes other parse errors non-fatal. Do not rely on this when creating new tables, the errors are there for a reason.
====-safeloading====
Loads missions the old way. Typically safer, but slower.
====-query_speech====
Determines if the current build includes text-to-speech.
====-d3d_bad_tsys====
Enable inefficient texture system.
====-novbo====
Disables OpenGL VBO.
====-noibx====
Disables IBX caching of model geometry data. This will dramatically increase load times, but will help troubleshoot a model if one is working incorrectly.
====-loadallweps====
Load all weapons, even those not used.

----

===Experimental===
====-alpha_env====
Enables alpha environment mapping. OpenGL only. Environment mapping intensity will be determined from the alpha channel of specular maps.
====-decals====
Enables damage decals.
====-ingame_join====
Enables ingame joining in multiplayer. FIXME: Host option?
====-tga16====
'''Obsolete Argument - Removed in builds after 3.6.7'''


Originally used to converts TGA images to 16-bits in order to reduce memory footprint (at the expense of image quality), superseded by ''-img2dds''.
----

===Development Tools===
====-fps====
Displays current frames per second.
====-pos====
Displays current position coordinates of camera.
====-window====
Runs the game in a window. No check to make sure that resolution is no higher than your desktop resolution, so be careful.
====-timerbar====
Displays a timing bar across the top of the screen. Timebar format varies by build.
====-stats====
Shows total and free physical memory, virtual memory and system pagefile.

====-coords====
Shows coordinates of the mouse cursor.
====-show_mem_usage====
Shows detailed RAM usage in HUD.

The meaning of the info displayed in the upper right corner is:

'''DYN''' = dynamic memory, basically anything that's been allocated by the vm_* memory functions. This does NOT indicate total memory usage but does account for most of it.

'''POF''' = model memory, how much memory is being used by models (does not include textures)

'''C-BMP, BMP''' = bmpman memory, how much is used by the textures/images that are loaded. C-BMP means that you are using -cache_bitmaps and it will try to keep textures in memory between level loads and as the new level is loading it will keep what it needs and unload what it doesn't. Can greatly increase level loading speed, but does so at the cost of memory between level loads. This does not increase overall memory usage though, only during the loading screen. BMP means that it is not cached and all textures are unloaded from memory at the start of level load and all needed textures are then loaded from the disk again.

'''S-RAM''' = sound memory, how much is used by the sounds loaded in memory at the time. This counts static sounds only (from sounds.tbl, etc.) and not streaming sounds (music, voices, briefing stuff, etc).

'''V-RAM''' = approximate memory usage of video textures. This is not mean that your card has this much memory and can report higher numbers that your card actually has memory. For OpenGL it also includes some of the geometry data, but this number does not reflect the total memory that your video card is using. It only reports how much data the game has purposefully loaded into API memory (meaning it could be in system memory, video card memory, or AGP memory).

''(It only works with debug builds, not with release builds).''

====-pofspew====
'''''What does this do?'''''
====-tablecrcs====
'''''What does this do?'''''
====-missioncrcs====
'''''What does this do?'''''
====-dis_collisions====
Disables all collisions.
====-dis_weapons====
Disables weapons rendering.
====-output_sexps====
Outputs SEXPs to sexps.html.
====-output_scripting====
Outputs scripting to scripting.html.
====-nograb====
Unix only. Disables focus grabbing in a window.
==Other==
The following options are not available as checkboxes in the launcher. Many require parameters, which follow the flag seperated by a space. The prototype for use in this case is "-option argument"
===Graphics===
====-ambient_factor====

This must be entered into the "Custom flags" field. This is a multiplier applied to the intensity of ambient lighting. Ambient light is lighting applied to all parts of a ship. FS2's standard value is 120. Try 75 for a good and realistic looking value. However, that is relative.

====-spec_exp====

This must be used with the -spec command line parameter and must be entered into the "Custom flags" field. Adjusts the size of the shiny spot on ships. Higher number mean smaller spots. Default is 16, however 11 is recommended. However, that is relative.

====-spec_point====

This must be used with the -spec command line parameter and must be entered into the
"Custom flags" field. Adjusts how much laser weapons contribute to specular highlights. Higher number mean greater contributions. Default is 1.0, however 0.6 is recommended. However, that is relative.

====-spec_static====

This must be used with the -spec command line parameter and must be entered into the "Custom flags" field. Adjusts how much suns contribute to specular highlights. Higher numbers mean a greater contribution. Default is 1.0, however is 0.8 recommended. However, that is relative.

====-spec_tube====

This must be used with the -spec command line parameter and must be entered into the "Custom flags" field. Adjusts how much Beam Weapons contribute to specular highlights. Higher numbers mean a greater contribution. Default is 1.0, however 0.4 is recommended. However, that is relative.

====-clipdist====
Changes the distance from the viewpoint for the near-clipping plane.

Takes one argument decimal specifying the distance to the near-clipping plane.

----

===Gameplay===
====-mod====

Specifies in which folders inside Freespace2 directory, the game looks for all the game data (models, missions, textures, tables, ...). Retail version only looks inside ''Freespace2/data/'' structure and ''Freespace2/vp archives''.

This flag allows installing several different mods that modify retail behaviour, and switching between them without needing to erase files or having undesired cross effects. Each mod should be installed in its own folder.

It takes one argument string: the chain of names of the used directories. Comma (''',''') must be used as separator. In this way, '''-mod dir1,dir2,dir3,...,dirx''' causes the game to use the following directory precedence:

#Freespace2/dir1/
#Freespace2/dir2/
#Freespace2/dir3/
# ... (the rest of the typed directories) ...
#Freespace2/dirx/
#Freespace2/

:::Please note. Freespace Open doesn't like spaces in directories (in the full path) so do not install the game within ''Program Files/Freespace2'' or ''Games/Freespace 2'' and, of course, do not use spaces within mod directories (''dir1'' is OK but ''dir 1'' isn't).

This flag can be indirectly set, (and it is normally set), through Launcher MOD tab and mod.ini file. Within this Launcher tab you can select one directory, (let's call it ''moddir''), so the flag is at least set to '''-mod moddir'''. If ''Freespace2/moddir/mod.ini'' exists, (its format must be plain text), it will be read and, inside it, the following section and lines can be used to modify the -mod flag too:

: [multimod] PrimaryList = Pri1,Pri2,...(the rest of desired directories)...,Prix; SecondaryList = Sec1,Sec2,...(the rest of desired directories)...,Secx;

(Please note the ending semicolon (;) in each list line). With these lines the following flag would be built:
: '''-mod Pri1,Pri2,...,Prix,moddir,Sec1,Sec2,...,Secx'''

If primary or secondary folders aren't used, their respective line can be erased or it can be typed as ''xxxxxxList = ;''.

::: '''''PLEASE NOTE''': '''Launcher v 5.4''', or later, '''must be used'''. Earlier versions had some bugs that would cause the previous explanation about mod.ini fail.''

::: The most common use of mod.ini and SecondaryList is sharing resources between mods. And the best example is the enhaced media vps from SCP crew. Most of the people install them in a folder called ''mediavps'' inside ''Freespace2''. In this way when running retail FS2 they do not interfere with this original game version that doesn't use this -mod flag feature. When using FS2_Open but without mods, you just need to select ''mediavps'' in Launcher MOD tab to use them. And if you want to enjoy that enhacements while playing any 'real' mod, you just need to put a mod.ini file inside its ''moddir'' with at least a ''SecondaryList = mediavps;'' line.

Inside each directory, data precedence is the following:

#Individual files located in ''Current_dir/data/'' subdir structure.
#Files located inside vp archives. (These vp archives are 'similar' to zip archives, they just contain other files and folders. Moreover, files have to be stored using the same ''data/'' structure used outside it). Vp archives are read in alphabetical order so aaa.vp files have higher priority than aab.vp files and so on.

The highest priority file overrides the rest of them. In this way, if you have a ''Mission.fs2'' inside ''Freespace2/Pri1/data/missions/'' it doesn't matter how this ''Mission.fs2'' is inside ''Freespace2/Pri1/aaa.vp'', ''Freespace2/Pri1/aab.vp'', ... or ''Freespace2/data/missions/''. This data precedence allows the user to quickly replace old files by corrected or enhaced ones adding them in a higher priority place.

As derived from explanation, the exact names for directories or vp archives are actually irrelevant. It only matters the directory order inside -mod flag argument and the alphabetical order for vp archives inside each used directory.

:'''Additional notes'''

# This flag is also used by FRED. So if there is special mod info, (like backgrounds maps, ship models or whatever), it must be typed, (''Fred2_Open_r.exe -MOD whatever''), or FRED won't be able to use it. No Launcher MOD tab available for this use. 
# Be careful while typing the directory names in the flag argument or inside mod.ini files. The program doesn't check if the typed directories exist. If they do not exist, they are just ignored. No warnings, no errors, no messages at all.

====-fov====
Specifies the Field of View for the player eyepoint.

Takes one argument decimal specifying the angle of the viewing cone in radians, from 0 to 2*pi

You can set the cone of view making things look bigger/smaller. The problem with this is that if you choose a small FOV, you will have a squashed look on the edges of your screen - stretched edges with a too high FOV. It is recommended to change the FOV as FS2 normally has some perspective distortion at the screen edges (FOV too high). Set the FOV to something like 0.39 - it will fix the distortion problem, and (as a nice side effect) will make everything look bigger and more realistic scale-wise. The default is 0.75, if you go higher, you'll get the fish-eye effect. Feel free to experiment. This must be entered into the "Custom flags" field

''Because of an active bug, FOV can misalign target boxes, effects, etc. Please check [http://lore.maxgaming.net/~scp/mantis/bug_view_advanced_page.php?bug_id=0000083 Mantis bug 083 status]if you are going to change the default value.''

----

===Multiplayer===
====-gamename====
Specifies the name of the game to be created by the host. This only works when used in conjunction with -startgame. This does nothing when used with -standalone.

Takes one argument string, the name to be assigned to the game being created.

See related: [[Command-Line_Reference#-standalone|-standalone]]

====-password====
Specifies the password for a stand-alone server.

Takes one argument string, the required password for the game being created.
====-allowabove====
Specifies a player's minimum rank for joining a game on a stand-alone server.

Takes one argument integer, the points ranking above which a player must be to enter the game.
====-allowbelow====
Specifies a player's maximum rank for joining a game on a stand-alone server.

Takes one argument integer, the points ranking below which a player must be to enter the game.
====-port====
Specifies the port on which to run for a stand-alone server.

Takes one argument integer, the port which the game should use to connect.
====-connect====
'''''What does this do?'''''
====-clientdamage====
'''''What does this do?'''''
====-timeout====
'''''What does this do?'''''

[[Category:Lists]]
[[Category:Source Code Project]]

Command-Line Reference

2006-09-25T05:26:37Z

Martellato: updated -gamename again (minor)

==Launcher Flags==
The following command-line options can be chosen from the launcher.
===Graphics===
====-spec====
Enables specular mapping. Only polygons mapped with textures for which a shinemap exists will recieve specular mapping; no attempt is made to generate spec maps where they do not exist. Specular maps are specified with the base map name plus "-shine" (i.e. TCov3A-shine.pcx).
====-env====
Enables environment mapping. Environment mapping intensity will be determined from the intensity of specular maps. At the time of this writing (build 3.6.9 RC7), environment mapping only works when the video mode is OpenGL. [[Installing_fs2_open#Video setup|See Video setup.]]

====-glow====
Enables glowmapping. Only polygons mapped with textures for which a glowmap exists will be glowmapped. Glow maps are specified with the base map name plus "-glow" (i.e. TCov4A-glow.pcx)

====-jpgtga====
Enables the use of TGA and JPG file formats for image files. If a ship is showing up partially invisible, select this option.
====-pcx32====
'''WARNING - HIGH MEMORY USAGE'''

Enables PCX files to be loaded into 32-bit memory. This will not imporove the rendering of any ships in-game, and is usually more of a burden on performance than is worthwhile. Use at your own risk. Removed from launcher options after 3.6.7.

====-cell====
Enables cell shading. This will make graphics appear more "cartoonish". For use with media in mv_cell.vp. Not considered a standard enhancement.
====-mipmap====
Enables mipmapping.

====-nomotiondebris====
Disables motion debris.
====-2d_poof====
Applies nebula poofs in 2d, effectively preventing them from forming intersections with ships.
====-noscalevid====
Disables scaling of video clips.
====-missile_lighting====
Applys lighting to missiles.
====-rlm====
'''Obsolete Argument'''


Enables more accurate lighting model for OpenGL mode. Always on in current builds, so this command-line option has been removed.

----

===Game Speed===
====-img2dds====
Converts all images to DDS (compressed) format. Decreases memory usage but potentially reduces image quality.
====-no_vsync====
Disables vertical sync.
====-cache_bitmaps====
Caches bitmaps between missions, which will ideally reduce the load-time from one mission to another.

----

===HUD===
====-dualscanlines====
Adds a second pair of scanning lines to the target window when scanning an object.
====-targetinfo====
Displays target info, such as name and class, beside the targeted object.
====-orbradar====
Enables 3D radar (the Orb). 3D radar will replace the standard 2D version.
====-ballistic_gauge====
Adds an ammo gauge to the HUD when armed with a ballistic weapon.
====-rearm_timer====
Displays time remaining until rearm and repair from a support ship is complete.

----

===Gameplay===
====-smart_shields====
Enables "smart" shield recharging. Shield recharge is distributed to the most damaged shield quadrant instead of being distributed equally across the entire shield and be wasted when a quadrant is full.
====-ship_choice_3d====
Use ship and weapon models in ship selection and weapon loadout. Completely disables the standard ANI interface on those screens.
====-3dwarp====
Use full geometry for the subspace warp effect.
====-warp_flash====
Enable a flash at warp in and warp out.
====-UseNewAI====
Tells the game to use new AI routines. This argument alters mission balance and is not considered a standard feature.
====-tbp====
Enable feature set for The Babylon Project
====-wcsaga====
Enable feature set for The Wing Commander Saga

----

===Audio===
====-snd_preload====
Preload mission sounds. Useful in preventing game stuttering when sounds are played for the first time.
====-nosound====
Disables all sounds.
====-nomusic====
Disables music only.

----

===Multiplayer===
====-standalone====
Creates a standalone server.
====-startgame====
'''''What does this do?'''''
====-closed====
This feature is not available in current builds.

====-restricted====
This feature is not available in current builds.

====-multilog====
Creates a log file with a summary of packets sent and received in multiplayer games. The file is saved as \data\multi.log within the active mod folder - or with main data folder if no mod is active.

====-clientdamage====
This feature is not available in current builds.

====-mpnoreturn====
Disables return to the flight deck screen after a mission completes.

----

===Troubleshooting===
====-fixbugs====
'''Obsolete Argument - Removed in builds after 3.6.7'''


Originally used to disable certain crashing behavior as a stop-gap measure. This feature is not available in current builds.
====-nocrash====
'''Obsolete Argument - Removed in builds after 3.6.7'''


Originally used to disable certain crashing behavior as a stop-gap measure. This feature is not available in current builds.
====-oldfire====
This feature is not available in current builds.

====-nohtl====
'''WARNING - VERY SLOW'''

Reverts to software rendering mode. Does this work any more?
====-no_set_gamma====
Disables the gamma settings in the options screen.
====-nomovies====
Disables all video playback.
====-noparseerrors====
Disables some parsing warnings and makes other parse errors non-fatal. Do not rely on this when creating new tables, the errors are there for a reason.
====-safeloading====
Loads missions the old way. Typically safer, but slower.
====-query_speech====
Determines if the current build includes text-to-speech.
====-d3d_bad_tsys====
Enable inefficient texture system.
====-novbo====
Disables OpenGL VBO.
====-noibx====
Disables IBX caching of model geometry data. This will dramatically increase load times, but will help troubleshoot a model if one is working incorrectly.
====-loadallweps====
Load all weapons, even those not used.

----

===Experimental===
====-alpha_env====
Enables alpha environment mapping. OpenGL only. Environment mapping intensity will be determined from the alpha channel of specular maps.
====-decals====
Enables damage decals.
====-ingame_join====
Enables ingame joining in multiplayer. FIXME: Host option?
====-tga16====
'''Obsolete Argument - Removed in builds after 3.6.7'''


Originally used to converts TGA images to 16-bits in order to reduce memory footprint (at the expense of image quality), superseded by ''-img2dds''.
----

===Development Tools===
====-fps====
Displays current frames per second.
====-pos====
Displays current position coordinates of camera.
====-window====
Runs the game in a window. No check to make sure that resolution is no higher than your desktop resolution, so be careful.
====-timerbar====
Displays a timing bar across the top of the screen. Timebar format varies by build.
====-stats====
Shows total and free physical memory, virtual memory and system pagefile.

====-coords====
Shows coordinates of the mouse cursor.
====-show_mem_usage====
Shows detailed RAM usage in HUD.

The meaning of the info displayed in the upper right corner is:

'''DYN''' = dynamic memory, basically anything that's been allocated by the vm_* memory functions. This does NOT indicate total memory usage but does account for most of it.

'''POF''' = model memory, how much memory is being used by models (does not include textures)

'''C-BMP, BMP''' = bmpman memory, how much is used by the textures/images that are loaded. C-BMP means that you are using -cache_bitmaps and it will try to keep textures in memory between level loads and as the new level is loading it will keep what it needs and unload what it doesn't. Can greatly increase level loading speed, but does so at the cost of memory between level loads. This does not increase overall memory usage though, only during the loading screen. BMP means that it is not cached and all textures are unloaded from memory at the start of level load and all needed textures are then loaded from the disk again.

'''S-RAM''' = sound memory, how much is used by the sounds loaded in memory at the time. This counts static sounds only (from sounds.tbl, etc.) and not streaming sounds (music, voices, briefing stuff, etc).

'''V-RAM''' = approximate memory usage of video textures. This is not mean that your card has this much memory and can report higher numbers that your card actually has memory. For OpenGL it also includes some of the geometry data, but this number does not reflect the total memory that your video card is using. It only reports how much data the game has purposefully loaded into API memory (meaning it could be in system memory, video card memory, or AGP memory).

''(It only works with debug builds, not with release builds).''

====-pofspew====
'''''What does this do?'''''
====-tablecrcs====
'''''What does this do?'''''
====-missioncrcs====
'''''What does this do?'''''
====-dis_collisions====
Disables all collisions.
====-dis_weapons====
Disables weapons rendering.
====-output_sexps====
Outputs SEXPs to sexps.html.
====-output_scripting====
Outputs scripting to scripting.html.
====-nograb====
Unix only. Disables focus grabbing in a window.
==Other==
The following options are not available as checkboxes in the launcher. Many require parameters, which follow the flag seperated by a space. The prototype for use in this case is "-option argument"
===Graphics===
====-ambient_factor====

This must be entered into the "Custom flags" field. This is a multiplier applied to the intensity of ambient lighting. Ambient light is lighting applied to all parts of a ship. FS2's standard value is 120. Try 75 for a good and realistic looking value. However, that is relative.

====-spec_exp====

This must be used with the -spec command line parameter and must be entered into the "Custom flags" field. Adjusts the size of the shiny spot on ships. Higher number mean smaller spots. Default is 16, however 11 is recommended. However, that is relative.

====-spec_point====

This must be used with the -spec command line parameter and must be entered into the
"Custom flags" field. Adjusts how much laser weapons contribute to specular highlights. Higher number mean greater contributions. Default is 1.0, however 0.6 is recommended. However, that is relative.

====-spec_static====

This must be used with the -spec command line parameter and must be entered into the "Custom flags" field. Adjusts how much suns contribute to specular highlights. Higher numbers mean a greater contribution. Default is 1.0, however is 0.8 recommended. However, that is relative.

====-spec_tube====

This must be used with the -spec command line parameter and must be entered into the "Custom flags" field. Adjusts how much Beam Weapons contribute to specular highlights. Higher numbers mean a greater contribution. Default is 1.0, however 0.4 is recommended. However, that is relative.

====-clipdist====
Changes the distance from the viewpoint for the near-clipping plane.

Takes one argument decimal specifying the distance to the near-clipping plane.

----

===Gameplay===
====-mod====

Specifies in which folders inside Freespace2 directory, the game looks for all the game data (models, missions, textures, tables, ...). Retail version only looks inside ''Freespace2/data/'' structure and ''Freespace2/vp archives''.

This flag allows installing several different mods that modify retail behaviour, and switching between them without needing to erase files or having undesired cross effects. Each mod should be installed in its own folder.

It takes one argument string: the chain of names of the used directories. Comma (''',''') must be used as separator. In this way, '''-mod dir1,dir2,dir3,...,dirx''' causes the game to use the following directory precedence:

#Freespace2/dir1/
#Freespace2/dir2/
#Freespace2/dir3/
# ... (the rest of the typed directories) ...
#Freespace2/dirx/
#Freespace2/

:::Please note. Freespace Open doesn't like spaces in directories (in the full path) so do not install the game within ''Program Files/Freespace2'' or ''Games/Freespace 2'' and, of course, do not use spaces within mod directories (''dir1'' is OK but ''dir 1'' isn't).

This flag can be indirectly set, (and it is normally set), through Launcher MOD tab and mod.ini file. Within this Launcher tab you can select one directory, (let's call it ''moddir''), so the flag is at least set to '''-mod moddir'''. If ''Freespace2/moddir/mod.ini'' exists, (its format must be plain text), it will be read and, inside it, the following section and lines can be used to modify the -mod flag too:

: [multimod] PrimaryList = Pri1,Pri2,...(the rest of desired directories)...,Prix; SecondaryList = Sec1,Sec2,...(the rest of desired directories)...,Secx;

(Please note the ending semicolon (;) in each list line). With these lines the following flag would be built:
: '''-mod Pri1,Pri2,...,Prix,moddir,Sec1,Sec2,...,Secx'''

If primary or secondary folders aren't used, their respective line can be erased or it can be typed as ''xxxxxxList = ;''.

::: '''''PLEASE NOTE''': '''Launcher v 5.4''', or later, '''must be used'''. Earlier versions had some bugs that would cause the previous explanation about mod.ini fail.''

::: The most common use of mod.ini and SecondaryList is sharing resources between mods. And the best example is the enhaced media vps from SCP crew. Most of the people install them in a folder called ''mediavps'' inside ''Freespace2''. In this way when running retail FS2 they do not interfere with this original game version that doesn't use this -mod flag feature. When using FS2_Open but without mods, you just need to select ''mediavps'' in Launcher MOD tab to use them. And if you want to enjoy that enhacements while playing any 'real' mod, you just need to put a mod.ini file inside its ''moddir'' with at least a ''SecondaryList = mediavps;'' line.

Inside each directory, data precedence is the following:

#Individual files located in ''Current_dir/data/'' subdir structure.
#Files located inside vp archives. (These vp archives are 'similar' to zip archives, they just contain other files and folders. Moreover, files have to be stored using the same ''data/'' structure used outside it). Vp archives are read in alphabetical order so aaa.vp files have higher priority than aab.vp files and so on.

The highest priority file overrides the rest of them. In this way, if you have a ''Mission.fs2'' inside ''Freespace2/Pri1/data/missions/'' it doesn't matter how this ''Mission.fs2'' is inside ''Freespace2/Pri1/aaa.vp'', ''Freespace2/Pri1/aab.vp'', ... or ''Freespace2/data/missions/''. This data precedence allows the user to quickly replace old files by corrected or enhaced ones adding them in a higher priority place.

As derived from explanation, the exact names for directories or vp archives are actually irrelevant. It only matters the directory order inside -mod flag argument and the alphabetical order for vp archives inside each used directory.

:'''Additional notes'''

# This flag is also used by FRED. So if there is special mod info, (like backgrounds maps, ship models or whatever), it must be typed, (''Fred2_Open_r.exe -MOD whatever''), or FRED won't be able to use it. No Launcher MOD tab available for this use. 
# Be careful while typing the directory names in the flag argument or inside mod.ini files. The program doesn't check if the typed directories exist. If they do not exist, they are just ignored. No warnings, no errors, no messages at all.

====-fov====
Specifies the Field of View for the player eyepoint.

Takes one argument decimal specifying the angle of the viewing cone in radians, from 0 to 2*pi

You can set the cone of view making things look bigger/smaller. The problem with this is that if you choose a small FOV, you will have a squashed look on the edges of your screen - stretched edges with a too high FOV. It is recommended to change the FOV as FS2 normally has some perspective distortion at the screen edges (FOV too high). Set the FOV to something like 0.39 - it will fix the distortion problem, and (as a nice side effect) will make everything look bigger and more realistic scale-wise. The default is 0.75, if you go higher, you'll get the fish-eye effect. Feel free to experiment. This must be entered into the "Custom flags" field

''Because of an active bug, FOV can misalign target boxes, effects, etc. Please check [http://lore.maxgaming.net/~scp/mantis/bug_view_advanced_page.php?bug_id=0000083 Mantis bug 083 status]if you are going to change the default value.''

----

===Multiplayer===
====-gamename====
Specifies the name of the game to be created by the host. This only works when used in conjunction with -startgame. This does nothing when used with -standalone.

Takes one argument string, the name to be assigned to the game being created.

See related: [[Command-Line_Reference#-standalone|-standalone]]

====-password====
Specifies the password for a stand-alone server.

Takes one argument string, the required password for the game being created.
====-allowabove====
Specifies a player's minimum rank for joining a game on a stand-alone server.

Takes one argument integer, the points ranking above which a player must be to enter the game.
====-allowbelow====
Specifies a player's maximum rank for joining a game on a stand-alone server.

Takes one argument integer, the points ranking below which a player must be to enter the game.
====-port====
Specifies the port on which to run for a stand-alone server.

Takes one argument integer, the port which the game should use to connect.
====-connect====
'''''What does this do?'''''
====-clientdamage====
'''''What does this do?'''''
====-timeout====
'''''What does this do?'''''

[[Category:Lists]]
[[Category:Source Code Project]]

Command-Line Reference

2006-09-25T05:25:39Z

Martellato: updated -gamename

==Launcher Flags==
The following command-line options can be chosen from the launcher.
===Graphics===
====-spec====
Enables specular mapping. Only polygons mapped with textures for which a shinemap exists will recieve specular mapping; no attempt is made to generate spec maps where they do not exist. Specular maps are specified with the base map name plus "-shine" (i.e. TCov3A-shine.pcx).
====-env====
Enables environment mapping. Environment mapping intensity will be determined from the intensity of specular maps. At the time of this writing (build 3.6.9 RC7), environment mapping only works when the video mode is OpenGL. [[Installing_fs2_open#Video setup|See Video setup.]]

====-glow====
Enables glowmapping. Only polygons mapped with textures for which a glowmap exists will be glowmapped. Glow maps are specified with the base map name plus "-glow" (i.e. TCov4A-glow.pcx)

====-jpgtga====
Enables the use of TGA and JPG file formats for image files. If a ship is showing up partially invisible, select this option.
====-pcx32====
'''WARNING - HIGH MEMORY USAGE'''

Enables PCX files to be loaded into 32-bit memory. This will not imporove the rendering of any ships in-game, and is usually more of a burden on performance than is worthwhile. Use at your own risk. Removed from launcher options after 3.6.7.

====-cell====
Enables cell shading. This will make graphics appear more "cartoonish". For use with media in mv_cell.vp. Not considered a standard enhancement.
====-mipmap====
Enables mipmapping.

====-nomotiondebris====
Disables motion debris.
====-2d_poof====
Applies nebula poofs in 2d, effectively preventing them from forming intersections with ships.
====-noscalevid====
Disables scaling of video clips.
====-missile_lighting====
Applys lighting to missiles.
====-rlm====
'''Obsolete Argument'''


Enables more accurate lighting model for OpenGL mode. Always on in current builds, so this command-line option has been removed.

----

===Game Speed===
====-img2dds====
Converts all images to DDS (compressed) format. Decreases memory usage but potentially reduces image quality.
====-no_vsync====
Disables vertical sync.
====-cache_bitmaps====
Caches bitmaps between missions, which will ideally reduce the load-time from one mission to another.

----

===HUD===
====-dualscanlines====
Adds a second pair of scanning lines to the target window when scanning an object.
====-targetinfo====
Displays target info, such as name and class, beside the targeted object.
====-orbradar====
Enables 3D radar (the Orb). 3D radar will replace the standard 2D version.
====-ballistic_gauge====
Adds an ammo gauge to the HUD when armed with a ballistic weapon.
====-rearm_timer====
Displays time remaining until rearm and repair from a support ship is complete.

----

===Gameplay===
====-smart_shields====
Enables "smart" shield recharging. Shield recharge is distributed to the most damaged shield quadrant instead of being distributed equally across the entire shield and be wasted when a quadrant is full.
====-ship_choice_3d====
Use ship and weapon models in ship selection and weapon loadout. Completely disables the standard ANI interface on those screens.
====-3dwarp====
Use full geometry for the subspace warp effect.
====-warp_flash====
Enable a flash at warp in and warp out.
====-UseNewAI====
Tells the game to use new AI routines. This argument alters mission balance and is not considered a standard feature.
====-tbp====
Enable feature set for The Babylon Project
====-wcsaga====
Enable feature set for The Wing Commander Saga

----

===Audio===
====-snd_preload====
Preload mission sounds. Useful in preventing game stuttering when sounds are played for the first time.
====-nosound====
Disables all sounds.
====-nomusic====
Disables music only.

----

===Multiplayer===
====-standalone====
Creates a standalone server.
====-startgame====
'''''What does this do?'''''
====-closed====
This feature is not available in current builds.

====-restricted====
This feature is not available in current builds.

====-multilog====
Creates a log file with a summary of packets sent and received in multiplayer games. The file is saved as \data\multi.log within the active mod folder - or with main data folder if no mod is active.

====-clientdamage====
This feature is not available in current builds.

====-mpnoreturn====
Disables return to the flight deck screen after a mission completes.

----

===Troubleshooting===
====-fixbugs====
'''Obsolete Argument - Removed in builds after 3.6.7'''


Originally used to disable certain crashing behavior as a stop-gap measure. This feature is not available in current builds.
====-nocrash====
'''Obsolete Argument - Removed in builds after 3.6.7'''


Originally used to disable certain crashing behavior as a stop-gap measure. This feature is not available in current builds.
====-oldfire====
This feature is not available in current builds.

====-nohtl====
'''WARNING - VERY SLOW'''

Reverts to software rendering mode. Does this work any more?
====-no_set_gamma====
Disables the gamma settings in the options screen.
====-nomovies====
Disables all video playback.
====-noparseerrors====
Disables some parsing warnings and makes other parse errors non-fatal. Do not rely on this when creating new tables, the errors are there for a reason.
====-safeloading====
Loads missions the old way. Typically safer, but slower.
====-query_speech====
Determines if the current build includes text-to-speech.
====-d3d_bad_tsys====
Enable inefficient texture system.
====-novbo====
Disables OpenGL VBO.
====-noibx====
Disables IBX caching of model geometry data. This will dramatically increase load times, but will help troubleshoot a model if one is working incorrectly.
====-loadallweps====
Load all weapons, even those not used.

----

===Experimental===
====-alpha_env====
Enables alpha environment mapping. OpenGL only. Environment mapping intensity will be determined from the alpha channel of specular maps.
====-decals====
Enables damage decals.
====-ingame_join====
Enables ingame joining in multiplayer. FIXME: Host option?
====-tga16====
'''Obsolete Argument - Removed in builds after 3.6.7'''


Originally used to converts TGA images to 16-bits in order to reduce memory footprint (at the expense of image quality), superseded by ''-img2dds''.
----

===Development Tools===
====-fps====
Displays current frames per second.
====-pos====
Displays current position coordinates of camera.
====-window====
Runs the game in a window. No check to make sure that resolution is no higher than your desktop resolution, so be careful.
====-timerbar====
Displays a timing bar across the top of the screen. Timebar format varies by build.
====-stats====
Shows total and free physical memory, virtual memory and system pagefile.

====-coords====
Shows coordinates of the mouse cursor.
====-show_mem_usage====
Shows detailed RAM usage in HUD.

The meaning of the info displayed in the upper right corner is:

'''DYN''' = dynamic memory, basically anything that's been allocated by the vm_* memory functions. This does NOT indicate total memory usage but does account for most of it.

'''POF''' = model memory, how much memory is being used by models (does not include textures)

'''C-BMP, BMP''' = bmpman memory, how much is used by the textures/images that are loaded. C-BMP means that you are using -cache_bitmaps and it will try to keep textures in memory between level loads and as the new level is loading it will keep what it needs and unload what it doesn't. Can greatly increase level loading speed, but does so at the cost of memory between level loads. This does not increase overall memory usage though, only during the loading screen. BMP means that it is not cached and all textures are unloaded from memory at the start of level load and all needed textures are then loaded from the disk again.

'''S-RAM''' = sound memory, how much is used by the sounds loaded in memory at the time. This counts static sounds only (from sounds.tbl, etc.) and not streaming sounds (music, voices, briefing stuff, etc).

'''V-RAM''' = approximate memory usage of video textures. This is not mean that your card has this much memory and can report higher numbers that your card actually has memory. For OpenGL it also includes some of the geometry data, but this number does not reflect the total memory that your video card is using. It only reports how much data the game has purposefully loaded into API memory (meaning it could be in system memory, video card memory, or AGP memory).

''(It only works with debug builds, not with release builds).''

====-pofspew====
'''''What does this do?'''''
====-tablecrcs====
'''''What does this do?'''''
====-missioncrcs====
'''''What does this do?'''''
====-dis_collisions====
Disables all collisions.
====-dis_weapons====
Disables weapons rendering.
====-output_sexps====
Outputs SEXPs to sexps.html.
====-output_scripting====
Outputs scripting to scripting.html.
====-nograb====
Unix only. Disables focus grabbing in a window.
==Other==
The following options are not available as checkboxes in the launcher. Many require parameters, which follow the flag seperated by a space. The prototype for use in this case is "-option argument"
===Graphics===
====-ambient_factor====

This must be entered into the "Custom flags" field. This is a multiplier applied to the intensity of ambient lighting. Ambient light is lighting applied to all parts of a ship. FS2's standard value is 120. Try 75 for a good and realistic looking value. However, that is relative.

====-spec_exp====

This must be used with the -spec command line parameter and must be entered into the "Custom flags" field. Adjusts the size of the shiny spot on ships. Higher number mean smaller spots. Default is 16, however 11 is recommended. However, that is relative.

====-spec_point====

This must be used with the -spec command line parameter and must be entered into the
"Custom flags" field. Adjusts how much laser weapons contribute to specular highlights. Higher number mean greater contributions. Default is 1.0, however 0.6 is recommended. However, that is relative.

====-spec_static====

This must be used with the -spec command line parameter and must be entered into the "Custom flags" field. Adjusts how much suns contribute to specular highlights. Higher numbers mean a greater contribution. Default is 1.0, however is 0.8 recommended. However, that is relative.

====-spec_tube====

This must be used with the -spec command line parameter and must be entered into the "Custom flags" field. Adjusts how much Beam Weapons contribute to specular highlights. Higher numbers mean a greater contribution. Default is 1.0, however 0.4 is recommended. However, that is relative.

====-clipdist====
Changes the distance from the viewpoint for the near-clipping plane.

Takes one argument decimal specifying the distance to the near-clipping plane.

----

===Gameplay===
====-mod====

Specifies in which folders inside Freespace2 directory, the game looks for all the game data (models, missions, textures, tables, ...). Retail version only looks inside ''Freespace2/data/'' structure and ''Freespace2/vp archives''.

This flag allows installing several different mods that modify retail behaviour, and switching between them without needing to erase files or having undesired cross effects. Each mod should be installed in its own folder.

It takes one argument string: the chain of names of the used directories. Comma (''',''') must be used as separator. In this way, '''-mod dir1,dir2,dir3,...,dirx''' causes the game to use the following directory precedence:

#Freespace2/dir1/
#Freespace2/dir2/
#Freespace2/dir3/
# ... (the rest of the typed directories) ...
#Freespace2/dirx/
#Freespace2/

:::Please note. Freespace Open doesn't like spaces in directories (in the full path) so do not install the game within ''Program Files/Freespace2'' or ''Games/Freespace 2'' and, of course, do not use spaces within mod directories (''dir1'' is OK but ''dir 1'' isn't).

This flag can be indirectly set, (and it is normally set), through Launcher MOD tab and mod.ini file. Within this Launcher tab you can select one directory, (let's call it ''moddir''), so the flag is at least set to '''-mod moddir'''. If ''Freespace2/moddir/mod.ini'' exists, (its format must be plain text), it will be read and, inside it, the following section and lines can be used to modify the -mod flag too:

: [multimod] PrimaryList = Pri1,Pri2,...(the rest of desired directories)...,Prix; SecondaryList = Sec1,Sec2,...(the rest of desired directories)...,Secx;

(Please note the ending semicolon (;) in each list line). With these lines the following flag would be built:
: '''-mod Pri1,Pri2,...,Prix,moddir,Sec1,Sec2,...,Secx'''

If primary or secondary folders aren't used, their respective line can be erased or it can be typed as ''xxxxxxList = ;''.

::: '''''PLEASE NOTE''': '''Launcher v 5.4''', or later, '''must be used'''. Earlier versions had some bugs that would cause the previous explanation about mod.ini fail.''

::: The most common use of mod.ini and SecondaryList is sharing resources between mods. And the best example is the enhaced media vps from SCP crew. Most of the people install them in a folder called ''mediavps'' inside ''Freespace2''. In this way when running retail FS2 they do not interfere with this original game version that doesn't use this -mod flag feature. When using FS2_Open but without mods, you just need to select ''mediavps'' in Launcher MOD tab to use them. And if you want to enjoy that enhacements while playing any 'real' mod, you just need to put a mod.ini file inside its ''moddir'' with at least a ''SecondaryList = mediavps;'' line.

Inside each directory, data precedence is the following:

#Individual files located in ''Current_dir/data/'' subdir structure.
#Files located inside vp archives. (These vp archives are 'similar' to zip archives, they just contain other files and folders. Moreover, files have to be stored using the same ''data/'' structure used outside it). Vp archives are read in alphabetical order so aaa.vp files have higher priority than aab.vp files and so on.

The highest priority file overrides the rest of them. In this way, if you have a ''Mission.fs2'' inside ''Freespace2/Pri1/data/missions/'' it doesn't matter how this ''Mission.fs2'' is inside ''Freespace2/Pri1/aaa.vp'', ''Freespace2/Pri1/aab.vp'', ... or ''Freespace2/data/missions/''. This data precedence allows the user to quickly replace old files by corrected or enhaced ones adding them in a higher priority place.

As derived from explanation, the exact names for directories or vp archives are actually irrelevant. It only matters the directory order inside -mod flag argument and the alphabetical order for vp archives inside each used directory.

:'''Additional notes'''

# This flag is also used by FRED. So if there is special mod info, (like backgrounds maps, ship models or whatever), it must be typed, (''Fred2_Open_r.exe -MOD whatever''), or FRED won't be able to use it. No Launcher MOD tab available for this use. 
# Be careful while typing the directory names in the flag argument or inside mod.ini files. The program doesn't check if the typed directories exist. If they do not exist, they are just ignored. No warnings, no errors, no messages at all.

====-fov====
Specifies the Field of View for the player eyepoint.

Takes one argument decimal specifying the angle of the viewing cone in radians, from 0 to 2*pi

You can set the cone of view making things look bigger/smaller. The problem with this is that if you choose a small FOV, you will have a squashed look on the edges of your screen - stretched edges with a too high FOV. It is recommended to change the FOV as FS2 normally has some perspective distortion at the screen edges (FOV too high). Set the FOV to something like 0.39 - it will fix the distortion problem, and (as a nice side effect) will make everything look bigger and more realistic scale-wise. The default is 0.75, if you go higher, you'll get the fish-eye effect. Feel free to experiment. This must be entered into the "Custom flags" field

''Because of an active bug, FOV can misalign target boxes, effects, etc. Please check [http://lore.maxgaming.net/~scp/mantis/bug_view_advanced_page.php?bug_id=0000083 Mantis bug 083 status]if you are going to change the default value.''

----

===Multiplayer===
====-gamename====
Specifies the name of the game to be created by the host. This only works when used in conjunction with '''-startgame'''. This does nothing when used with '''-standalone'''.

Takes one argument string, the name to be assigned to the game being created.

See related: [[Command-Line_Reference#-standalone|-standalone]]

====-password====
Specifies the password for a stand-alone server.

Takes one argument string, the required password for the game being created.
====-allowabove====
Specifies a player's minimum rank for joining a game on a stand-alone server.

Takes one argument integer, the points ranking above which a player must be to enter the game.
====-allowbelow====
Specifies a player's maximum rank for joining a game on a stand-alone server.

Takes one argument integer, the points ranking below which a player must be to enter the game.
====-port====
Specifies the port on which to run for a stand-alone server.

Takes one argument integer, the port which the game should use to connect.
====-connect====
'''''What does this do?'''''
====-clientdamage====
'''''What does this do?'''''
====-timeout====
'''''What does this do?'''''

[[Category:Lists]]
[[Category:Source Code Project]]

Command-Line Reference

2006-09-25T05:17:45Z

Martellato: updated -oldfire

==Launcher Flags==
The following command-line options can be chosen from the launcher.
===Graphics===
====-spec====
Enables specular mapping. Only polygons mapped with textures for which a shinemap exists will recieve specular mapping; no attempt is made to generate spec maps where they do not exist. Specular maps are specified with the base map name plus "-shine" (i.e. TCov3A-shine.pcx).
====-env====
Enables environment mapping. Environment mapping intensity will be determined from the intensity of specular maps. At the time of this writing (build 3.6.9 RC7), environment mapping only works when the video mode is OpenGL. [[Installing_fs2_open#Video setup|See Video setup.]]

====-glow====
Enables glowmapping. Only polygons mapped with textures for which a glowmap exists will be glowmapped. Glow maps are specified with the base map name plus "-glow" (i.e. TCov4A-glow.pcx)

====-jpgtga====
Enables the use of TGA and JPG file formats for image files. If a ship is showing up partially invisible, select this option.
====-pcx32====
'''WARNING - HIGH MEMORY USAGE'''

Enables PCX files to be loaded into 32-bit memory. This will not imporove the rendering of any ships in-game, and is usually more of a burden on performance than is worthwhile. Use at your own risk. Removed from launcher options after 3.6.7.

====-cell====
Enables cell shading. This will make graphics appear more "cartoonish". For use with media in mv_cell.vp. Not considered a standard enhancement.
====-mipmap====
Enables mipmapping.

====-nomotiondebris====
Disables motion debris.
====-2d_poof====
Applies nebula poofs in 2d, effectively preventing them from forming intersections with ships.
====-noscalevid====
Disables scaling of video clips.
====-missile_lighting====
Applys lighting to missiles.
====-rlm====
'''Obsolete Argument'''


Enables more accurate lighting model for OpenGL mode. Always on in current builds, so this command-line option has been removed.

----

===Game Speed===
====-img2dds====
Converts all images to DDS (compressed) format. Decreases memory usage but potentially reduces image quality.
====-no_vsync====
Disables vertical sync.
====-cache_bitmaps====
Caches bitmaps between missions, which will ideally reduce the load-time from one mission to another.

----

===HUD===
====-dualscanlines====
Adds a second pair of scanning lines to the target window when scanning an object.
====-targetinfo====
Displays target info, such as name and class, beside the targeted object.
====-orbradar====
Enables 3D radar (the Orb). 3D radar will replace the standard 2D version.
====-ballistic_gauge====
Adds an ammo gauge to the HUD when armed with a ballistic weapon.
====-rearm_timer====
Displays time remaining until rearm and repair from a support ship is complete.

----

===Gameplay===
====-smart_shields====
Enables "smart" shield recharging. Shield recharge is distributed to the most damaged shield quadrant instead of being distributed equally across the entire shield and be wasted when a quadrant is full.
====-ship_choice_3d====
Use ship and weapon models in ship selection and weapon loadout. Completely disables the standard ANI interface on those screens.
====-3dwarp====
Use full geometry for the subspace warp effect.
====-warp_flash====
Enable a flash at warp in and warp out.
====-UseNewAI====
Tells the game to use new AI routines. This argument alters mission balance and is not considered a standard feature.
====-tbp====
Enable feature set for The Babylon Project
====-wcsaga====
Enable feature set for The Wing Commander Saga

----

===Audio===
====-snd_preload====
Preload mission sounds. Useful in preventing game stuttering when sounds are played for the first time.
====-nosound====
Disables all sounds.
====-nomusic====
Disables music only.

----

===Multiplayer===
====-standalone====
Creates a standalone server.
====-startgame====
'''''What does this do?'''''
====-closed====
This feature is not available in current builds.

====-restricted====
This feature is not available in current builds.

====-multilog====
Creates a log file with a summary of packets sent and received in multiplayer games. The file is saved as \data\multi.log within the active mod folder - or with main data folder if no mod is active.

====-clientdamage====
This feature is not available in current builds.

====-mpnoreturn====
Disables return to the flight deck screen after a mission completes.

----

===Troubleshooting===
====-fixbugs====
'''Obsolete Argument - Removed in builds after 3.6.7'''


Originally used to disable certain crashing behavior as a stop-gap measure. This feature is not available in current builds.
====-nocrash====
'''Obsolete Argument - Removed in builds after 3.6.7'''


Originally used to disable certain crashing behavior as a stop-gap measure. This feature is not available in current builds.
====-oldfire====
This feature is not available in current builds.

====-nohtl====
'''WARNING - VERY SLOW'''

Reverts to software rendering mode. Does this work any more?
====-no_set_gamma====
Disables the gamma settings in the options screen.
====-nomovies====
Disables all video playback.
====-noparseerrors====
Disables some parsing warnings and makes other parse errors non-fatal. Do not rely on this when creating new tables, the errors are there for a reason.
====-safeloading====
Loads missions the old way. Typically safer, but slower.
====-query_speech====
Determines if the current build includes text-to-speech.
====-d3d_bad_tsys====
Enable inefficient texture system.
====-novbo====
Disables OpenGL VBO.
====-noibx====
Disables IBX caching of model geometry data. This will dramatically increase load times, but will help troubleshoot a model if one is working incorrectly.
====-loadallweps====
Load all weapons, even those not used.

----

===Experimental===
====-alpha_env====
Enables alpha environment mapping. OpenGL only. Environment mapping intensity will be determined from the alpha channel of specular maps.
====-decals====
Enables damage decals.
====-ingame_join====
Enables ingame joining in multiplayer. FIXME: Host option?
====-tga16====
'''Obsolete Argument - Removed in builds after 3.6.7'''


Originally used to converts TGA images to 16-bits in order to reduce memory footprint (at the expense of image quality), superseded by ''-img2dds''.
----

===Development Tools===
====-fps====
Displays current frames per second.
====-pos====
Displays current position coordinates of camera.
====-window====
Runs the game in a window. No check to make sure that resolution is no higher than your desktop resolution, so be careful.
====-timerbar====
Displays a timing bar across the top of the screen. Timebar format varies by build.
====-stats====
Shows total and free physical memory, virtual memory and system pagefile.

====-coords====
Shows coordinates of the mouse cursor.
====-show_mem_usage====
Shows detailed RAM usage in HUD.

The meaning of the info displayed in the upper right corner is:

'''DYN''' = dynamic memory, basically anything that's been allocated by the vm_* memory functions. This does NOT indicate total memory usage but does account for most of it.

'''POF''' = model memory, how much memory is being used by models (does not include textures)

'''C-BMP, BMP''' = bmpman memory, how much is used by the textures/images that are loaded. C-BMP means that you are using -cache_bitmaps and it will try to keep textures in memory between level loads and as the new level is loading it will keep what it needs and unload what it doesn't. Can greatly increase level loading speed, but does so at the cost of memory between level loads. This does not increase overall memory usage though, only during the loading screen. BMP means that it is not cached and all textures are unloaded from memory at the start of level load and all needed textures are then loaded from the disk again.

'''S-RAM''' = sound memory, how much is used by the sounds loaded in memory at the time. This counts static sounds only (from sounds.tbl, etc.) and not streaming sounds (music, voices, briefing stuff, etc).

'''V-RAM''' = approximate memory usage of video textures. This is not mean that your card has this much memory and can report higher numbers that your card actually has memory. For OpenGL it also includes some of the geometry data, but this number does not reflect the total memory that your video card is using. It only reports how much data the game has purposefully loaded into API memory (meaning it could be in system memory, video card memory, or AGP memory).

''(It only works with debug builds, not with release builds).''

====-pofspew====
'''''What does this do?'''''
====-tablecrcs====
'''''What does this do?'''''
====-missioncrcs====
'''''What does this do?'''''
====-dis_collisions====
Disables all collisions.
====-dis_weapons====
Disables weapons rendering.
====-output_sexps====
Outputs SEXPs to sexps.html.
====-output_scripting====
Outputs scripting to scripting.html.
====-nograb====
Unix only. Disables focus grabbing in a window.
==Other==
The following options are not available as checkboxes in the launcher. Many require parameters, which follow the flag seperated by a space. The prototype for use in this case is "-option argument"
===Graphics===
====-ambient_factor====

This must be entered into the "Custom flags" field. This is a multiplier applied to the intensity of ambient lighting. Ambient light is lighting applied to all parts of a ship. FS2's standard value is 120. Try 75 for a good and realistic looking value. However, that is relative.

====-spec_exp====

This must be used with the -spec command line parameter and must be entered into the "Custom flags" field. Adjusts the size of the shiny spot on ships. Higher number mean smaller spots. Default is 16, however 11 is recommended. However, that is relative.

====-spec_point====

This must be used with the -spec command line parameter and must be entered into the
"Custom flags" field. Adjusts how much laser weapons contribute to specular highlights. Higher number mean greater contributions. Default is 1.0, however 0.6 is recommended. However, that is relative.

====-spec_static====

This must be used with the -spec command line parameter and must be entered into the "Custom flags" field. Adjusts how much suns contribute to specular highlights. Higher numbers mean a greater contribution. Default is 1.0, however is 0.8 recommended. However, that is relative.

====-spec_tube====

This must be used with the -spec command line parameter and must be entered into the "Custom flags" field. Adjusts how much Beam Weapons contribute to specular highlights. Higher numbers mean a greater contribution. Default is 1.0, however 0.4 is recommended. However, that is relative.

====-clipdist====
Changes the distance from the viewpoint for the near-clipping plane.

Takes one argument decimal specifying the distance to the near-clipping plane.

----

===Gameplay===
====-mod====

Specifies in which folders inside Freespace2 directory, the game looks for all the game data (models, missions, textures, tables, ...). Retail version only looks inside ''Freespace2/data/'' structure and ''Freespace2/vp archives''.

This flag allows installing several different mods that modify retail behaviour, and switching between them without needing to erase files or having undesired cross effects. Each mod should be installed in its own folder.

It takes one argument string: the chain of names of the used directories. Comma (''',''') must be used as separator. In this way, '''-mod dir1,dir2,dir3,...,dirx''' causes the game to use the following directory precedence:

#Freespace2/dir1/
#Freespace2/dir2/
#Freespace2/dir3/
# ... (the rest of the typed directories) ...
#Freespace2/dirx/
#Freespace2/

:::Please note. Freespace Open doesn't like spaces in directories (in the full path) so do not install the game within ''Program Files/Freespace2'' or ''Games/Freespace 2'' and, of course, do not use spaces within mod directories (''dir1'' is OK but ''dir 1'' isn't).

This flag can be indirectly set, (and it is normally set), through Launcher MOD tab and mod.ini file. Within this Launcher tab you can select one directory, (let's call it ''moddir''), so the flag is at least set to '''-mod moddir'''. If ''Freespace2/moddir/mod.ini'' exists, (its format must be plain text), it will be read and, inside it, the following section and lines can be used to modify the -mod flag too:

: [multimod] PrimaryList = Pri1,Pri2,...(the rest of desired directories)...,Prix; SecondaryList = Sec1,Sec2,...(the rest of desired directories)...,Secx;

(Please note the ending semicolon (;) in each list line). With these lines the following flag would be built:
: '''-mod Pri1,Pri2,...,Prix,moddir,Sec1,Sec2,...,Secx'''

If primary or secondary folders aren't used, their respective line can be erased or it can be typed as ''xxxxxxList = ;''.

::: '''''PLEASE NOTE''': '''Launcher v 5.4''', or later, '''must be used'''. Earlier versions had some bugs that would cause the previous explanation about mod.ini fail.''

::: The most common use of mod.ini and SecondaryList is sharing resources between mods. And the best example is the enhaced media vps from SCP crew. Most of the people install them in a folder called ''mediavps'' inside ''Freespace2''. In this way when running retail FS2 they do not interfere with this original game version that doesn't use this -mod flag feature. When using FS2_Open but without mods, you just need to select ''mediavps'' in Launcher MOD tab to use them. And if you want to enjoy that enhacements while playing any 'real' mod, you just need to put a mod.ini file inside its ''moddir'' with at least a ''SecondaryList = mediavps;'' line.

Inside each directory, data precedence is the following:

#Individual files located in ''Current_dir/data/'' subdir structure.
#Files located inside vp archives. (These vp archives are 'similar' to zip archives, they just contain other files and folders. Moreover, files have to be stored using the same ''data/'' structure used outside it). Vp archives are read in alphabetical order so aaa.vp files have higher priority than aab.vp files and so on.

The highest priority file overrides the rest of them. In this way, if you have a ''Mission.fs2'' inside ''Freespace2/Pri1/data/missions/'' it doesn't matter how this ''Mission.fs2'' is inside ''Freespace2/Pri1/aaa.vp'', ''Freespace2/Pri1/aab.vp'', ... or ''Freespace2/data/missions/''. This data precedence allows the user to quickly replace old files by corrected or enhaced ones adding them in a higher priority place.

As derived from explanation, the exact names for directories or vp archives are actually irrelevant. It only matters the directory order inside -mod flag argument and the alphabetical order for vp archives inside each used directory.

:'''Additional notes'''

# This flag is also used by FRED. So if there is special mod info, (like backgrounds maps, ship models or whatever), it must be typed, (''Fred2_Open_r.exe -MOD whatever''), or FRED won't be able to use it. No Launcher MOD tab available for this use. 
# Be careful while typing the directory names in the flag argument or inside mod.ini files. The program doesn't check if the typed directories exist. If they do not exist, they are just ignored. No warnings, no errors, no messages at all.

====-fov====
Specifies the Field of View for the player eyepoint.

Takes one argument decimal specifying the angle of the viewing cone in radians, from 0 to 2*pi

You can set the cone of view making things look bigger/smaller. The problem with this is that if you choose a small FOV, you will have a squashed look on the edges of your screen - stretched edges with a too high FOV. It is recommended to change the FOV as FS2 normally has some perspective distortion at the screen edges (FOV too high). Set the FOV to something like 0.39 - it will fix the distortion problem, and (as a nice side effect) will make everything look bigger and more realistic scale-wise. The default is 0.75, if you go higher, you'll get the fish-eye effect. Feel free to experiment. This must be entered into the "Custom flags" field

''Because of an active bug, FOV can misalign target boxes, effects, etc. Please check [http://lore.maxgaming.net/~scp/mantis/bug_view_advanced_page.php?bug_id=0000083 Mantis bug 083 status]if you are going to change the default value.''

----

===Multiplayer===
====-gamename====
Specifies the name of the game to be created by a stand-alone server.

Takes one argument string, the name to be assigned to the game being created.
====-password====
Specifies the password for a stand-alone server.

Takes one argument string, the required password for the game being created.
====-allowabove====
Specifies a player's minimum rank for joining a game on a stand-alone server.

Takes one argument integer, the points ranking above which a player must be to enter the game.
====-allowbelow====
Specifies a player's maximum rank for joining a game on a stand-alone server.

Takes one argument integer, the points ranking below which a player must be to enter the game.
====-port====
Specifies the port on which to run for a stand-alone server.

Takes one argument integer, the port which the game should use to connect.
====-connect====
'''''What does this do?'''''
====-clientdamage====
'''''What does this do?'''''
====-timeout====
'''''What does this do?'''''

[[Category:Lists]]
[[Category:Source Code Project]]

Command-Line Reference

2006-09-25T05:17:01Z

Martellato: updated -clientdamage

==Launcher Flags==
The following command-line options can be chosen from the launcher.
===Graphics===
====-spec====
Enables specular mapping. Only polygons mapped with textures for which a shinemap exists will recieve specular mapping; no attempt is made to generate spec maps where they do not exist. Specular maps are specified with the base map name plus "-shine" (i.e. TCov3A-shine.pcx).
====-env====
Enables environment mapping. Environment mapping intensity will be determined from the intensity of specular maps. At the time of this writing (build 3.6.9 RC7), environment mapping only works when the video mode is OpenGL. [[Installing_fs2_open#Video setup|See Video setup.]]

====-glow====
Enables glowmapping. Only polygons mapped with textures for which a glowmap exists will be glowmapped. Glow maps are specified with the base map name plus "-glow" (i.e. TCov4A-glow.pcx)

====-jpgtga====
Enables the use of TGA and JPG file formats for image files. If a ship is showing up partially invisible, select this option.
====-pcx32====
'''WARNING - HIGH MEMORY USAGE'''

Enables PCX files to be loaded into 32-bit memory. This will not imporove the rendering of any ships in-game, and is usually more of a burden on performance than is worthwhile. Use at your own risk. Removed from launcher options after 3.6.7.

====-cell====
Enables cell shading. This will make graphics appear more "cartoonish". For use with media in mv_cell.vp. Not considered a standard enhancement.
====-mipmap====
Enables mipmapping.

====-nomotiondebris====
Disables motion debris.
====-2d_poof====
Applies nebula poofs in 2d, effectively preventing them from forming intersections with ships.
====-noscalevid====
Disables scaling of video clips.
====-missile_lighting====
Applys lighting to missiles.
====-rlm====
'''Obsolete Argument'''


Enables more accurate lighting model for OpenGL mode. Always on in current builds, so this command-line option has been removed.

----

===Game Speed===
====-img2dds====
Converts all images to DDS (compressed) format. Decreases memory usage but potentially reduces image quality.
====-no_vsync====
Disables vertical sync.
====-cache_bitmaps====
Caches bitmaps between missions, which will ideally reduce the load-time from one mission to another.

----

===HUD===
====-dualscanlines====
Adds a second pair of scanning lines to the target window when scanning an object.
====-targetinfo====
Displays target info, such as name and class, beside the targeted object.
====-orbradar====
Enables 3D radar (the Orb). 3D radar will replace the standard 2D version.
====-ballistic_gauge====
Adds an ammo gauge to the HUD when armed with a ballistic weapon.
====-rearm_timer====
Displays time remaining until rearm and repair from a support ship is complete.

----

===Gameplay===
====-smart_shields====
Enables "smart" shield recharging. Shield recharge is distributed to the most damaged shield quadrant instead of being distributed equally across the entire shield and be wasted when a quadrant is full.
====-ship_choice_3d====
Use ship and weapon models in ship selection and weapon loadout. Completely disables the standard ANI interface on those screens.
====-3dwarp====
Use full geometry for the subspace warp effect.
====-warp_flash====
Enable a flash at warp in and warp out.
====-UseNewAI====
Tells the game to use new AI routines. This argument alters mission balance and is not considered a standard feature.
====-tbp====
Enable feature set for The Babylon Project
====-wcsaga====
Enable feature set for The Wing Commander Saga

----

===Audio===
====-snd_preload====
Preload mission sounds. Useful in preventing game stuttering when sounds are played for the first time.
====-nosound====
Disables all sounds.
====-nomusic====
Disables music only.

----

===Multiplayer===
====-standalone====
Creates a standalone server.
====-startgame====
'''''What does this do?'''''
====-closed====
This feature is not available in current builds.

====-restricted====
This feature is not available in current builds.

====-multilog====
Creates a log file with a summary of packets sent and received in multiplayer games. The file is saved as \data\multi.log within the active mod folder - or with main data folder if no mod is active.

====-clientdamage====
This feature is not available in current builds.

====-mpnoreturn====
Disables return to the flight deck screen after a mission completes.

----

===Troubleshooting===
====-fixbugs====
'''Obsolete Argument - Removed in builds after 3.6.7'''


Originally used to disable certain crashing behavior as a stop-gap measure. This feature is not available in current builds.
====-nocrash====
'''Obsolete Argument - Removed in builds after 3.6.7'''


Originally used to disable certain crashing behavior as a stop-gap measure. This feature is not available in current builds.
====-oldfire====
'''''What does this do?'''''
====-nohtl====
'''WARNING - VERY SLOW'''

Reverts to software rendering mode. Does this work any more?
====-no_set_gamma====
Disables the gamma settings in the options screen.
====-nomovies====
Disables all video playback.
====-noparseerrors====
Disables some parsing warnings and makes other parse errors non-fatal. Do not rely on this when creating new tables, the errors are there for a reason.
====-safeloading====
Loads missions the old way. Typically safer, but slower.
====-query_speech====
Determines if the current build includes text-to-speech.
====-d3d_bad_tsys====
Enable inefficient texture system.
====-novbo====
Disables OpenGL VBO.
====-noibx====
Disables IBX caching of model geometry data. This will dramatically increase load times, but will help troubleshoot a model if one is working incorrectly.
====-loadallweps====
Load all weapons, even those not used.

----

===Experimental===
====-alpha_env====
Enables alpha environment mapping. OpenGL only. Environment mapping intensity will be determined from the alpha channel of specular maps.
====-decals====
Enables damage decals.
====-ingame_join====
Enables ingame joining in multiplayer. FIXME: Host option?
====-tga16====
'''Obsolete Argument - Removed in builds after 3.6.7'''


Originally used to converts TGA images to 16-bits in order to reduce memory footprint (at the expense of image quality), superseded by ''-img2dds''.
----

===Development Tools===
====-fps====
Displays current frames per second.
====-pos====
Displays current position coordinates of camera.
====-window====
Runs the game in a window. No check to make sure that resolution is no higher than your desktop resolution, so be careful.
====-timerbar====
Displays a timing bar across the top of the screen. Timebar format varies by build.
====-stats====
Shows total and free physical memory, virtual memory and system pagefile.

====-coords====
Shows coordinates of the mouse cursor.
====-show_mem_usage====
Shows detailed RAM usage in HUD.

The meaning of the info displayed in the upper right corner is:

'''DYN''' = dynamic memory, basically anything that's been allocated by the vm_* memory functions. This does NOT indicate total memory usage but does account for most of it.

'''POF''' = model memory, how much memory is being used by models (does not include textures)

'''C-BMP, BMP''' = bmpman memory, how much is used by the textures/images that are loaded. C-BMP means that you are using -cache_bitmaps and it will try to keep textures in memory between level loads and as the new level is loading it will keep what it needs and unload what it doesn't. Can greatly increase level loading speed, but does so at the cost of memory between level loads. This does not increase overall memory usage though, only during the loading screen. BMP means that it is not cached and all textures are unloaded from memory at the start of level load and all needed textures are then loaded from the disk again.

'''S-RAM''' = sound memory, how much is used by the sounds loaded in memory at the time. This counts static sounds only (from sounds.tbl, etc.) and not streaming sounds (music, voices, briefing stuff, etc).

'''V-RAM''' = approximate memory usage of video textures. This is not mean that your card has this much memory and can report higher numbers that your card actually has memory. For OpenGL it also includes some of the geometry data, but this number does not reflect the total memory that your video card is using. It only reports how much data the game has purposefully loaded into API memory (meaning it could be in system memory, video card memory, or AGP memory).

''(It only works with debug builds, not with release builds).''

====-pofspew====
'''''What does this do?'''''
====-tablecrcs====
'''''What does this do?'''''
====-missioncrcs====
'''''What does this do?'''''
====-dis_collisions====
Disables all collisions.
====-dis_weapons====
Disables weapons rendering.
====-output_sexps====
Outputs SEXPs to sexps.html.
====-output_scripting====
Outputs scripting to scripting.html.
====-nograb====
Unix only. Disables focus grabbing in a window.
==Other==
The following options are not available as checkboxes in the launcher. Many require parameters, which follow the flag seperated by a space. The prototype for use in this case is "-option argument"
===Graphics===
====-ambient_factor====

This must be entered into the "Custom flags" field. This is a multiplier applied to the intensity of ambient lighting. Ambient light is lighting applied to all parts of a ship. FS2's standard value is 120. Try 75 for a good and realistic looking value. However, that is relative.

====-spec_exp====

This must be used with the -spec command line parameter and must be entered into the "Custom flags" field. Adjusts the size of the shiny spot on ships. Higher number mean smaller spots. Default is 16, however 11 is recommended. However, that is relative.

====-spec_point====

This must be used with the -spec command line parameter and must be entered into the
"Custom flags" field. Adjusts how much laser weapons contribute to specular highlights. Higher number mean greater contributions. Default is 1.0, however 0.6 is recommended. However, that is relative.

====-spec_static====

This must be used with the -spec command line parameter and must be entered into the "Custom flags" field. Adjusts how much suns contribute to specular highlights. Higher numbers mean a greater contribution. Default is 1.0, however is 0.8 recommended. However, that is relative.

====-spec_tube====

This must be used with the -spec command line parameter and must be entered into the "Custom flags" field. Adjusts how much Beam Weapons contribute to specular highlights. Higher numbers mean a greater contribution. Default is 1.0, however 0.4 is recommended. However, that is relative.

====-clipdist====
Changes the distance from the viewpoint for the near-clipping plane.

Takes one argument decimal specifying the distance to the near-clipping plane.

----

===Gameplay===
====-mod====

Specifies in which folders inside Freespace2 directory, the game looks for all the game data (models, missions, textures, tables, ...). Retail version only looks inside ''Freespace2/data/'' structure and ''Freespace2/vp archives''.

This flag allows installing several different mods that modify retail behaviour, and switching between them without needing to erase files or having undesired cross effects. Each mod should be installed in its own folder.

It takes one argument string: the chain of names of the used directories. Comma (''',''') must be used as separator. In this way, '''-mod dir1,dir2,dir3,...,dirx''' causes the game to use the following directory precedence:

#Freespace2/dir1/
#Freespace2/dir2/
#Freespace2/dir3/
# ... (the rest of the typed directories) ...
#Freespace2/dirx/
#Freespace2/

:::Please note. Freespace Open doesn't like spaces in directories (in the full path) so do not install the game within ''Program Files/Freespace2'' or ''Games/Freespace 2'' and, of course, do not use spaces within mod directories (''dir1'' is OK but ''dir 1'' isn't).

This flag can be indirectly set, (and it is normally set), through Launcher MOD tab and mod.ini file. Within this Launcher tab you can select one directory, (let's call it ''moddir''), so the flag is at least set to '''-mod moddir'''. If ''Freespace2/moddir/mod.ini'' exists, (its format must be plain text), it will be read and, inside it, the following section and lines can be used to modify the -mod flag too:

: [multimod] PrimaryList = Pri1,Pri2,...(the rest of desired directories)...,Prix; SecondaryList = Sec1,Sec2,...(the rest of desired directories)...,Secx;

(Please note the ending semicolon (;) in each list line). With these lines the following flag would be built:
: '''-mod Pri1,Pri2,...,Prix,moddir,Sec1,Sec2,...,Secx'''

If primary or secondary folders aren't used, their respective line can be erased or it can be typed as ''xxxxxxList = ;''.

::: '''''PLEASE NOTE''': '''Launcher v 5.4''', or later, '''must be used'''. Earlier versions had some bugs that would cause the previous explanation about mod.ini fail.''

::: The most common use of mod.ini and SecondaryList is sharing resources between mods. And the best example is the enhaced media vps from SCP crew. Most of the people install them in a folder called ''mediavps'' inside ''Freespace2''. In this way when running retail FS2 they do not interfere with this original game version that doesn't use this -mod flag feature. When using FS2_Open but without mods, you just need to select ''mediavps'' in Launcher MOD tab to use them. And if you want to enjoy that enhacements while playing any 'real' mod, you just need to put a mod.ini file inside its ''moddir'' with at least a ''SecondaryList = mediavps;'' line.

Inside each directory, data precedence is the following:

#Individual files located in ''Current_dir/data/'' subdir structure.
#Files located inside vp archives. (These vp archives are 'similar' to zip archives, they just contain other files and folders. Moreover, files have to be stored using the same ''data/'' structure used outside it). Vp archives are read in alphabetical order so aaa.vp files have higher priority than aab.vp files and so on.

The highest priority file overrides the rest of them. In this way, if you have a ''Mission.fs2'' inside ''Freespace2/Pri1/data/missions/'' it doesn't matter how this ''Mission.fs2'' is inside ''Freespace2/Pri1/aaa.vp'', ''Freespace2/Pri1/aab.vp'', ... or ''Freespace2/data/missions/''. This data precedence allows the user to quickly replace old files by corrected or enhaced ones adding them in a higher priority place.

As derived from explanation, the exact names for directories or vp archives are actually irrelevant. It only matters the directory order inside -mod flag argument and the alphabetical order for vp archives inside each used directory.

:'''Additional notes'''

# This flag is also used by FRED. So if there is special mod info, (like backgrounds maps, ship models or whatever), it must be typed, (''Fred2_Open_r.exe -MOD whatever''), or FRED won't be able to use it. No Launcher MOD tab available for this use. 
# Be careful while typing the directory names in the flag argument or inside mod.ini files. The program doesn't check if the typed directories exist. If they do not exist, they are just ignored. No warnings, no errors, no messages at all.

====-fov====
Specifies the Field of View for the player eyepoint.

Takes one argument decimal specifying the angle of the viewing cone in radians, from 0 to 2*pi

You can set the cone of view making things look bigger/smaller. The problem with this is that if you choose a small FOV, you will have a squashed look on the edges of your screen - stretched edges with a too high FOV. It is recommended to change the FOV as FS2 normally has some perspective distortion at the screen edges (FOV too high). Set the FOV to something like 0.39 - it will fix the distortion problem, and (as a nice side effect) will make everything look bigger and more realistic scale-wise. The default is 0.75, if you go higher, you'll get the fish-eye effect. Feel free to experiment. This must be entered into the "Custom flags" field

''Because of an active bug, FOV can misalign target boxes, effects, etc. Please check [http://lore.maxgaming.net/~scp/mantis/bug_view_advanced_page.php?bug_id=0000083 Mantis bug 083 status]if you are going to change the default value.''

----

===Multiplayer===
====-gamename====
Specifies the name of the game to be created by a stand-alone server.

Takes one argument string, the name to be assigned to the game being created.
====-password====
Specifies the password for a stand-alone server.

Takes one argument string, the required password for the game being created.
====-allowabove====
Specifies a player's minimum rank for joining a game on a stand-alone server.

Takes one argument integer, the points ranking above which a player must be to enter the game.
====-allowbelow====
Specifies a player's maximum rank for joining a game on a stand-alone server.

Takes one argument integer, the points ranking below which a player must be to enter the game.
====-port====
Specifies the port on which to run for a stand-alone server.

Takes one argument integer, the port which the game should use to connect.
====-connect====
'''''What does this do?'''''
====-clientdamage====
'''''What does this do?'''''
====-timeout====
'''''What does this do?'''''

[[Category:Lists]]
[[Category:Source Code Project]]

Command-Line Reference

2006-09-25T05:14:24Z

Martellato: updated -restricted

==Launcher Flags==
The following command-line options can be chosen from the launcher.
===Graphics===
====-spec====
Enables specular mapping. Only polygons mapped with textures for which a shinemap exists will recieve specular mapping; no attempt is made to generate spec maps where they do not exist. Specular maps are specified with the base map name plus "-shine" (i.e. TCov3A-shine.pcx).
====-env====
Enables environment mapping. Environment mapping intensity will be determined from the intensity of specular maps. At the time of this writing (build 3.6.9 RC7), environment mapping only works when the video mode is OpenGL. [[Installing_fs2_open#Video setup|See Video setup.]]

====-glow====
Enables glowmapping. Only polygons mapped with textures for which a glowmap exists will be glowmapped. Glow maps are specified with the base map name plus "-glow" (i.e. TCov4A-glow.pcx)

====-jpgtga====
Enables the use of TGA and JPG file formats for image files. If a ship is showing up partially invisible, select this option.
====-pcx32====
'''WARNING - HIGH MEMORY USAGE'''

Enables PCX files to be loaded into 32-bit memory. This will not imporove the rendering of any ships in-game, and is usually more of a burden on performance than is worthwhile. Use at your own risk. Removed from launcher options after 3.6.7.

====-cell====
Enables cell shading. This will make graphics appear more "cartoonish". For use with media in mv_cell.vp. Not considered a standard enhancement.
====-mipmap====
Enables mipmapping.

====-nomotiondebris====
Disables motion debris.
====-2d_poof====
Applies nebula poofs in 2d, effectively preventing them from forming intersections with ships.
====-noscalevid====
Disables scaling of video clips.
====-missile_lighting====
Applys lighting to missiles.
====-rlm====
'''Obsolete Argument'''


Enables more accurate lighting model for OpenGL mode. Always on in current builds, so this command-line option has been removed.

----

===Game Speed===
====-img2dds====
Converts all images to DDS (compressed) format. Decreases memory usage but potentially reduces image quality.
====-no_vsync====
Disables vertical sync.
====-cache_bitmaps====
Caches bitmaps between missions, which will ideally reduce the load-time from one mission to another.

----

===HUD===
====-dualscanlines====
Adds a second pair of scanning lines to the target window when scanning an object.
====-targetinfo====
Displays target info, such as name and class, beside the targeted object.
====-orbradar====
Enables 3D radar (the Orb). 3D radar will replace the standard 2D version.
====-ballistic_gauge====
Adds an ammo gauge to the HUD when armed with a ballistic weapon.
====-rearm_timer====
Displays time remaining until rearm and repair from a support ship is complete.

----

===Gameplay===
====-smart_shields====
Enables "smart" shield recharging. Shield recharge is distributed to the most damaged shield quadrant instead of being distributed equally across the entire shield and be wasted when a quadrant is full.
====-ship_choice_3d====
Use ship and weapon models in ship selection and weapon loadout. Completely disables the standard ANI interface on those screens.
====-3dwarp====
Use full geometry for the subspace warp effect.
====-warp_flash====
Enable a flash at warp in and warp out.
====-UseNewAI====
Tells the game to use new AI routines. This argument alters mission balance and is not considered a standard feature.
====-tbp====
Enable feature set for The Babylon Project
====-wcsaga====
Enable feature set for The Wing Commander Saga

----

===Audio===
====-snd_preload====
Preload mission sounds. Useful in preventing game stuttering when sounds are played for the first time.
====-nosound====
Disables all sounds.
====-nomusic====
Disables music only.

----

===Multiplayer===
====-standalone====
Creates a standalone server.
====-startgame====
'''''What does this do?'''''
====-closed====
This feature is not available in current builds.

====-restricted====
This feature is not available in current builds.

====-multilog====
Creates a log file with a summary of packets sent and received in multiplayer games. The file is saved as \data\multi.log within the active mod folder - or with main data folder if no mod is active.

====-clientdamage====
'''''What does this do?'''''
====-mpnoreturn====
Disables return to the flight deck screen after a mission completes.

----

===Troubleshooting===
====-fixbugs====
'''Obsolete Argument - Removed in builds after 3.6.7'''


Originally used to disable certain crashing behavior as a stop-gap measure. This feature is not available in current builds.
====-nocrash====
'''Obsolete Argument - Removed in builds after 3.6.7'''


Originally used to disable certain crashing behavior as a stop-gap measure. This feature is not available in current builds.
====-oldfire====
'''''What does this do?'''''
====-nohtl====
'''WARNING - VERY SLOW'''

Reverts to software rendering mode. Does this work any more?
====-no_set_gamma====
Disables the gamma settings in the options screen.
====-nomovies====
Disables all video playback.
====-noparseerrors====
Disables some parsing warnings and makes other parse errors non-fatal. Do not rely on this when creating new tables, the errors are there for a reason.
====-safeloading====
Loads missions the old way. Typically safer, but slower.
====-query_speech====
Determines if the current build includes text-to-speech.
====-d3d_bad_tsys====
Enable inefficient texture system.
====-novbo====
Disables OpenGL VBO.
====-noibx====
Disables IBX caching of model geometry data. This will dramatically increase load times, but will help troubleshoot a model if one is working incorrectly.
====-loadallweps====
Load all weapons, even those not used.

----

===Experimental===
====-alpha_env====
Enables alpha environment mapping. OpenGL only. Environment mapping intensity will be determined from the alpha channel of specular maps.
====-decals====
Enables damage decals.
====-ingame_join====
Enables ingame joining in multiplayer. FIXME: Host option?
====-tga16====
'''Obsolete Argument - Removed in builds after 3.6.7'''


Originally used to converts TGA images to 16-bits in order to reduce memory footprint (at the expense of image quality), superseded by ''-img2dds''.
----

===Development Tools===
====-fps====
Displays current frames per second.
====-pos====
Displays current position coordinates of camera.
====-window====
Runs the game in a window. No check to make sure that resolution is no higher than your desktop resolution, so be careful.
====-timerbar====
Displays a timing bar across the top of the screen. Timebar format varies by build.
====-stats====
Shows total and free physical memory, virtual memory and system pagefile.

====-coords====
Shows coordinates of the mouse cursor.
====-show_mem_usage====
Shows detailed RAM usage in HUD.

The meaning of the info displayed in the upper right corner is:

'''DYN''' = dynamic memory, basically anything that's been allocated by the vm_* memory functions. This does NOT indicate total memory usage but does account for most of it.

'''POF''' = model memory, how much memory is being used by models (does not include textures)

'''C-BMP, BMP''' = bmpman memory, how much is used by the textures/images that are loaded. C-BMP means that you are using -cache_bitmaps and it will try to keep textures in memory between level loads and as the new level is loading it will keep what it needs and unload what it doesn't. Can greatly increase level loading speed, but does so at the cost of memory between level loads. This does not increase overall memory usage though, only during the loading screen. BMP means that it is not cached and all textures are unloaded from memory at the start of level load and all needed textures are then loaded from the disk again.

'''S-RAM''' = sound memory, how much is used by the sounds loaded in memory at the time. This counts static sounds only (from sounds.tbl, etc.) and not streaming sounds (music, voices, briefing stuff, etc).

'''V-RAM''' = approximate memory usage of video textures. This is not mean that your card has this much memory and can report higher numbers that your card actually has memory. For OpenGL it also includes some of the geometry data, but this number does not reflect the total memory that your video card is using. It only reports how much data the game has purposefully loaded into API memory (meaning it could be in system memory, video card memory, or AGP memory).

''(It only works with debug builds, not with release builds).''

====-pofspew====
'''''What does this do?'''''
====-tablecrcs====
'''''What does this do?'''''
====-missioncrcs====
'''''What does this do?'''''
====-dis_collisions====
Disables all collisions.
====-dis_weapons====
Disables weapons rendering.
====-output_sexps====
Outputs SEXPs to sexps.html.
====-output_scripting====
Outputs scripting to scripting.html.
====-nograb====
Unix only. Disables focus grabbing in a window.
==Other==
The following options are not available as checkboxes in the launcher. Many require parameters, which follow the flag seperated by a space. The prototype for use in this case is "-option argument"
===Graphics===
====-ambient_factor====

This must be entered into the "Custom flags" field. This is a multiplier applied to the intensity of ambient lighting. Ambient light is lighting applied to all parts of a ship. FS2's standard value is 120. Try 75 for a good and realistic looking value. However, that is relative.

====-spec_exp====

This must be used with the -spec command line parameter and must be entered into the "Custom flags" field. Adjusts the size of the shiny spot on ships. Higher number mean smaller spots. Default is 16, however 11 is recommended. However, that is relative.

====-spec_point====

This must be used with the -spec command line parameter and must be entered into the
"Custom flags" field. Adjusts how much laser weapons contribute to specular highlights. Higher number mean greater contributions. Default is 1.0, however 0.6 is recommended. However, that is relative.

====-spec_static====

This must be used with the -spec command line parameter and must be entered into the "Custom flags" field. Adjusts how much suns contribute to specular highlights. Higher numbers mean a greater contribution. Default is 1.0, however is 0.8 recommended. However, that is relative.

====-spec_tube====

This must be used with the -spec command line parameter and must be entered into the "Custom flags" field. Adjusts how much Beam Weapons contribute to specular highlights. Higher numbers mean a greater contribution. Default is 1.0, however 0.4 is recommended. However, that is relative.

====-clipdist====
Changes the distance from the viewpoint for the near-clipping plane.

Takes one argument decimal specifying the distance to the near-clipping plane.

----

===Gameplay===
====-mod====

Specifies in which folders inside Freespace2 directory, the game looks for all the game data (models, missions, textures, tables, ...). Retail version only looks inside ''Freespace2/data/'' structure and ''Freespace2/vp archives''.

This flag allows installing several different mods that modify retail behaviour, and switching between them without needing to erase files or having undesired cross effects. Each mod should be installed in its own folder.

It takes one argument string: the chain of names of the used directories. Comma (''',''') must be used as separator. In this way, '''-mod dir1,dir2,dir3,...,dirx''' causes the game to use the following directory precedence:

#Freespace2/dir1/
#Freespace2/dir2/
#Freespace2/dir3/
# ... (the rest of the typed directories) ...
#Freespace2/dirx/
#Freespace2/

:::Please note. Freespace Open doesn't like spaces in directories (in the full path) so do not install the game within ''Program Files/Freespace2'' or ''Games/Freespace 2'' and, of course, do not use spaces within mod directories (''dir1'' is OK but ''dir 1'' isn't).

This flag can be indirectly set, (and it is normally set), through Launcher MOD tab and mod.ini file. Within this Launcher tab you can select one directory, (let's call it ''moddir''), so the flag is at least set to '''-mod moddir'''. If ''Freespace2/moddir/mod.ini'' exists, (its format must be plain text), it will be read and, inside it, the following section and lines can be used to modify the -mod flag too:

: [multimod] PrimaryList = Pri1,Pri2,...(the rest of desired directories)...,Prix; SecondaryList = Sec1,Sec2,...(the rest of desired directories)...,Secx;

(Please note the ending semicolon (;) in each list line). With these lines the following flag would be built:
: '''-mod Pri1,Pri2,...,Prix,moddir,Sec1,Sec2,...,Secx'''

If primary or secondary folders aren't used, their respective line can be erased or it can be typed as ''xxxxxxList = ;''.

::: '''''PLEASE NOTE''': '''Launcher v 5.4''', or later, '''must be used'''. Earlier versions had some bugs that would cause the previous explanation about mod.ini fail.''

::: The most common use of mod.ini and SecondaryList is sharing resources between mods. And the best example is the enhaced media vps from SCP crew. Most of the people install them in a folder called ''mediavps'' inside ''Freespace2''. In this way when running retail FS2 they do not interfere with this original game version that doesn't use this -mod flag feature. When using FS2_Open but without mods, you just need to select ''mediavps'' in Launcher MOD tab to use them. And if you want to enjoy that enhacements while playing any 'real' mod, you just need to put a mod.ini file inside its ''moddir'' with at least a ''SecondaryList = mediavps;'' line.

Inside each directory, data precedence is the following:

#Individual files located in ''Current_dir/data/'' subdir structure.
#Files located inside vp archives. (These vp archives are 'similar' to zip archives, they just contain other files and folders. Moreover, files have to be stored using the same ''data/'' structure used outside it). Vp archives are read in alphabetical order so aaa.vp files have higher priority than aab.vp files and so on.

The highest priority file overrides the rest of them. In this way, if you have a ''Mission.fs2'' inside ''Freespace2/Pri1/data/missions/'' it doesn't matter how this ''Mission.fs2'' is inside ''Freespace2/Pri1/aaa.vp'', ''Freespace2/Pri1/aab.vp'', ... or ''Freespace2/data/missions/''. This data precedence allows the user to quickly replace old files by corrected or enhaced ones adding them in a higher priority place.

As derived from explanation, the exact names for directories or vp archives are actually irrelevant. It only matters the directory order inside -mod flag argument and the alphabetical order for vp archives inside each used directory.

:'''Additional notes'''

# This flag is also used by FRED. So if there is special mod info, (like backgrounds maps, ship models or whatever), it must be typed, (''Fred2_Open_r.exe -MOD whatever''), or FRED won't be able to use it. No Launcher MOD tab available for this use. 
# Be careful while typing the directory names in the flag argument or inside mod.ini files. The program doesn't check if the typed directories exist. If they do not exist, they are just ignored. No warnings, no errors, no messages at all.

====-fov====
Specifies the Field of View for the player eyepoint.

Takes one argument decimal specifying the angle of the viewing cone in radians, from 0 to 2*pi

You can set the cone of view making things look bigger/smaller. The problem with this is that if you choose a small FOV, you will have a squashed look on the edges of your screen - stretched edges with a too high FOV. It is recommended to change the FOV as FS2 normally has some perspective distortion at the screen edges (FOV too high). Set the FOV to something like 0.39 - it will fix the distortion problem, and (as a nice side effect) will make everything look bigger and more realistic scale-wise. The default is 0.75, if you go higher, you'll get the fish-eye effect. Feel free to experiment. This must be entered into the "Custom flags" field

''Because of an active bug, FOV can misalign target boxes, effects, etc. Please check [http://lore.maxgaming.net/~scp/mantis/bug_view_advanced_page.php?bug_id=0000083 Mantis bug 083 status]if you are going to change the default value.''

----

===Multiplayer===
====-gamename====
Specifies the name of the game to be created by a stand-alone server.

Takes one argument string, the name to be assigned to the game being created.
====-password====
Specifies the password for a stand-alone server.

Takes one argument string, the required password for the game being created.
====-allowabove====
Specifies a player's minimum rank for joining a game on a stand-alone server.

Takes one argument integer, the points ranking above which a player must be to enter the game.
====-allowbelow====
Specifies a player's maximum rank for joining a game on a stand-alone server.

Takes one argument integer, the points ranking below which a player must be to enter the game.
====-port====
Specifies the port on which to run for a stand-alone server.

Takes one argument integer, the port which the game should use to connect.
====-connect====
'''''What does this do?'''''
====-clientdamage====
'''''What does this do?'''''
====-timeout====
'''''What does this do?'''''

[[Category:Lists]]
[[Category:Source Code Project]]

Command-Line Reference

2006-09-25T05:13:55Z

Martellato: updated -closed

==Launcher Flags==
The following command-line options can be chosen from the launcher.
===Graphics===
====-spec====
Enables specular mapping. Only polygons mapped with textures for which a shinemap exists will recieve specular mapping; no attempt is made to generate spec maps where they do not exist. Specular maps are specified with the base map name plus "-shine" (i.e. TCov3A-shine.pcx).
====-env====
Enables environment mapping. Environment mapping intensity will be determined from the intensity of specular maps. At the time of this writing (build 3.6.9 RC7), environment mapping only works when the video mode is OpenGL. [[Installing_fs2_open#Video setup|See Video setup.]]

====-glow====
Enables glowmapping. Only polygons mapped with textures for which a glowmap exists will be glowmapped. Glow maps are specified with the base map name plus "-glow" (i.e. TCov4A-glow.pcx)

====-jpgtga====
Enables the use of TGA and JPG file formats for image files. If a ship is showing up partially invisible, select this option.
====-pcx32====
'''WARNING - HIGH MEMORY USAGE'''

Enables PCX files to be loaded into 32-bit memory. This will not imporove the rendering of any ships in-game, and is usually more of a burden on performance than is worthwhile. Use at your own risk. Removed from launcher options after 3.6.7.

====-cell====
Enables cell shading. This will make graphics appear more "cartoonish". For use with media in mv_cell.vp. Not considered a standard enhancement.
====-mipmap====
Enables mipmapping.

====-nomotiondebris====
Disables motion debris.
====-2d_poof====
Applies nebula poofs in 2d, effectively preventing them from forming intersections with ships.
====-noscalevid====
Disables scaling of video clips.
====-missile_lighting====
Applys lighting to missiles.
====-rlm====
'''Obsolete Argument'''


Enables more accurate lighting model for OpenGL mode. Always on in current builds, so this command-line option has been removed.

----

===Game Speed===
====-img2dds====
Converts all images to DDS (compressed) format. Decreases memory usage but potentially reduces image quality.
====-no_vsync====
Disables vertical sync.
====-cache_bitmaps====
Caches bitmaps between missions, which will ideally reduce the load-time from one mission to another.

----

===HUD===
====-dualscanlines====
Adds a second pair of scanning lines to the target window when scanning an object.
====-targetinfo====
Displays target info, such as name and class, beside the targeted object.
====-orbradar====
Enables 3D radar (the Orb). 3D radar will replace the standard 2D version.
====-ballistic_gauge====
Adds an ammo gauge to the HUD when armed with a ballistic weapon.
====-rearm_timer====
Displays time remaining until rearm and repair from a support ship is complete.

----

===Gameplay===
====-smart_shields====
Enables "smart" shield recharging. Shield recharge is distributed to the most damaged shield quadrant instead of being distributed equally across the entire shield and be wasted when a quadrant is full.
====-ship_choice_3d====
Use ship and weapon models in ship selection and weapon loadout. Completely disables the standard ANI interface on those screens.
====-3dwarp====
Use full geometry for the subspace warp effect.
====-warp_flash====
Enable a flash at warp in and warp out.
====-UseNewAI====
Tells the game to use new AI routines. This argument alters mission balance and is not considered a standard feature.
====-tbp====
Enable feature set for The Babylon Project
====-wcsaga====
Enable feature set for The Wing Commander Saga

----

===Audio===
====-snd_preload====
Preload mission sounds. Useful in preventing game stuttering when sounds are played for the first time.
====-nosound====
Disables all sounds.
====-nomusic====
Disables music only.

----

===Multiplayer===
====-standalone====
Creates a standalone server.
====-startgame====
'''''What does this do?'''''
====-closed====
This feature is not available in current builds.

====-restricted====
'''''What does this do?'''''
====-multilog====
Creates a log file with a summary of packets sent and received in multiplayer games. The file is saved as \data\multi.log within the active mod folder - or with main data folder if no mod is active.

====-clientdamage====
'''''What does this do?'''''
====-mpnoreturn====
Disables return to the flight deck screen after a mission completes.

----

===Troubleshooting===
====-fixbugs====
'''Obsolete Argument - Removed in builds after 3.6.7'''


Originally used to disable certain crashing behavior as a stop-gap measure. This feature is not available in current builds.
====-nocrash====
'''Obsolete Argument - Removed in builds after 3.6.7'''


Originally used to disable certain crashing behavior as a stop-gap measure. This feature is not available in current builds.
====-oldfire====
'''''What does this do?'''''
====-nohtl====
'''WARNING - VERY SLOW'''

Reverts to software rendering mode. Does this work any more?
====-no_set_gamma====
Disables the gamma settings in the options screen.
====-nomovies====
Disables all video playback.
====-noparseerrors====
Disables some parsing warnings and makes other parse errors non-fatal. Do not rely on this when creating new tables, the errors are there for a reason.
====-safeloading====
Loads missions the old way. Typically safer, but slower.
====-query_speech====
Determines if the current build includes text-to-speech.
====-d3d_bad_tsys====
Enable inefficient texture system.
====-novbo====
Disables OpenGL VBO.
====-noibx====
Disables IBX caching of model geometry data. This will dramatically increase load times, but will help troubleshoot a model if one is working incorrectly.
====-loadallweps====
Load all weapons, even those not used.

----

===Experimental===
====-alpha_env====
Enables alpha environment mapping. OpenGL only. Environment mapping intensity will be determined from the alpha channel of specular maps.
====-decals====
Enables damage decals.
====-ingame_join====
Enables ingame joining in multiplayer. FIXME: Host option?
====-tga16====
'''Obsolete Argument - Removed in builds after 3.6.7'''


Originally used to converts TGA images to 16-bits in order to reduce memory footprint (at the expense of image quality), superseded by ''-img2dds''.
----

===Development Tools===
====-fps====
Displays current frames per second.
====-pos====
Displays current position coordinates of camera.
====-window====
Runs the game in a window. No check to make sure that resolution is no higher than your desktop resolution, so be careful.
====-timerbar====
Displays a timing bar across the top of the screen. Timebar format varies by build.
====-stats====
Shows total and free physical memory, virtual memory and system pagefile.

====-coords====
Shows coordinates of the mouse cursor.
====-show_mem_usage====
Shows detailed RAM usage in HUD.

The meaning of the info displayed in the upper right corner is:

'''DYN''' = dynamic memory, basically anything that's been allocated by the vm_* memory functions. This does NOT indicate total memory usage but does account for most of it.

'''POF''' = model memory, how much memory is being used by models (does not include textures)

'''C-BMP, BMP''' = bmpman memory, how much is used by the textures/images that are loaded. C-BMP means that you are using -cache_bitmaps and it will try to keep textures in memory between level loads and as the new level is loading it will keep what it needs and unload what it doesn't. Can greatly increase level loading speed, but does so at the cost of memory between level loads. This does not increase overall memory usage though, only during the loading screen. BMP means that it is not cached and all textures are unloaded from memory at the start of level load and all needed textures are then loaded from the disk again.

'''S-RAM''' = sound memory, how much is used by the sounds loaded in memory at the time. This counts static sounds only (from sounds.tbl, etc.) and not streaming sounds (music, voices, briefing stuff, etc).

'''V-RAM''' = approximate memory usage of video textures. This is not mean that your card has this much memory and can report higher numbers that your card actually has memory. For OpenGL it also includes some of the geometry data, but this number does not reflect the total memory that your video card is using. It only reports how much data the game has purposefully loaded into API memory (meaning it could be in system memory, video card memory, or AGP memory).

''(It only works with debug builds, not with release builds).''

====-pofspew====
'''''What does this do?'''''
====-tablecrcs====
'''''What does this do?'''''
====-missioncrcs====
'''''What does this do?'''''
====-dis_collisions====
Disables all collisions.
====-dis_weapons====
Disables weapons rendering.
====-output_sexps====
Outputs SEXPs to sexps.html.
====-output_scripting====
Outputs scripting to scripting.html.
====-nograb====
Unix only. Disables focus grabbing in a window.
==Other==
The following options are not available as checkboxes in the launcher. Many require parameters, which follow the flag seperated by a space. The prototype for use in this case is "-option argument"
===Graphics===
====-ambient_factor====

This must be entered into the "Custom flags" field. This is a multiplier applied to the intensity of ambient lighting. Ambient light is lighting applied to all parts of a ship. FS2's standard value is 120. Try 75 for a good and realistic looking value. However, that is relative.

====-spec_exp====

This must be used with the -spec command line parameter and must be entered into the "Custom flags" field. Adjusts the size of the shiny spot on ships. Higher number mean smaller spots. Default is 16, however 11 is recommended. However, that is relative.

====-spec_point====

This must be used with the -spec command line parameter and must be entered into the
"Custom flags" field. Adjusts how much laser weapons contribute to specular highlights. Higher number mean greater contributions. Default is 1.0, however 0.6 is recommended. However, that is relative.

====-spec_static====

This must be used with the -spec command line parameter and must be entered into the "Custom flags" field. Adjusts how much suns contribute to specular highlights. Higher numbers mean a greater contribution. Default is 1.0, however is 0.8 recommended. However, that is relative.

====-spec_tube====

This must be used with the -spec command line parameter and must be entered into the "Custom flags" field. Adjusts how much Beam Weapons contribute to specular highlights. Higher numbers mean a greater contribution. Default is 1.0, however 0.4 is recommended. However, that is relative.

====-clipdist====
Changes the distance from the viewpoint for the near-clipping plane.

Takes one argument decimal specifying the distance to the near-clipping plane.

----

===Gameplay===
====-mod====

Specifies in which folders inside Freespace2 directory, the game looks for all the game data (models, missions, textures, tables, ...). Retail version only looks inside ''Freespace2/data/'' structure and ''Freespace2/vp archives''.

This flag allows installing several different mods that modify retail behaviour, and switching between them without needing to erase files or having undesired cross effects. Each mod should be installed in its own folder.

It takes one argument string: the chain of names of the used directories. Comma (''',''') must be used as separator. In this way, '''-mod dir1,dir2,dir3,...,dirx''' causes the game to use the following directory precedence:

#Freespace2/dir1/
#Freespace2/dir2/
#Freespace2/dir3/
# ... (the rest of the typed directories) ...
#Freespace2/dirx/
#Freespace2/

:::Please note. Freespace Open doesn't like spaces in directories (in the full path) so do not install the game within ''Program Files/Freespace2'' or ''Games/Freespace 2'' and, of course, do not use spaces within mod directories (''dir1'' is OK but ''dir 1'' isn't).

This flag can be indirectly set, (and it is normally set), through Launcher MOD tab and mod.ini file. Within this Launcher tab you can select one directory, (let's call it ''moddir''), so the flag is at least set to '''-mod moddir'''. If ''Freespace2/moddir/mod.ini'' exists, (its format must be plain text), it will be read and, inside it, the following section and lines can be used to modify the -mod flag too:

: [multimod] PrimaryList = Pri1,Pri2,...(the rest of desired directories)...,Prix; SecondaryList = Sec1,Sec2,...(the rest of desired directories)...,Secx;

(Please note the ending semicolon (;) in each list line). With these lines the following flag would be built:
: '''-mod Pri1,Pri2,...,Prix,moddir,Sec1,Sec2,...,Secx'''

If primary or secondary folders aren't used, their respective line can be erased or it can be typed as ''xxxxxxList = ;''.

::: '''''PLEASE NOTE''': '''Launcher v 5.4''', or later, '''must be used'''. Earlier versions had some bugs that would cause the previous explanation about mod.ini fail.''

::: The most common use of mod.ini and SecondaryList is sharing resources between mods. And the best example is the enhaced media vps from SCP crew. Most of the people install them in a folder called ''mediavps'' inside ''Freespace2''. In this way when running retail FS2 they do not interfere with this original game version that doesn't use this -mod flag feature. When using FS2_Open but without mods, you just need to select ''mediavps'' in Launcher MOD tab to use them. And if you want to enjoy that enhacements while playing any 'real' mod, you just need to put a mod.ini file inside its ''moddir'' with at least a ''SecondaryList = mediavps;'' line.

Inside each directory, data precedence is the following:

#Individual files located in ''Current_dir/data/'' subdir structure.
#Files located inside vp archives. (These vp archives are 'similar' to zip archives, they just contain other files and folders. Moreover, files have to be stored using the same ''data/'' structure used outside it). Vp archives are read in alphabetical order so aaa.vp files have higher priority than aab.vp files and so on.

The highest priority file overrides the rest of them. In this way, if you have a ''Mission.fs2'' inside ''Freespace2/Pri1/data/missions/'' it doesn't matter how this ''Mission.fs2'' is inside ''Freespace2/Pri1/aaa.vp'', ''Freespace2/Pri1/aab.vp'', ... or ''Freespace2/data/missions/''. This data precedence allows the user to quickly replace old files by corrected or enhaced ones adding them in a higher priority place.

As derived from explanation, the exact names for directories or vp archives are actually irrelevant. It only matters the directory order inside -mod flag argument and the alphabetical order for vp archives inside each used directory.

:'''Additional notes'''

# This flag is also used by FRED. So if there is special mod info, (like backgrounds maps, ship models or whatever), it must be typed, (''Fred2_Open_r.exe -MOD whatever''), or FRED won't be able to use it. No Launcher MOD tab available for this use. 
# Be careful while typing the directory names in the flag argument or inside mod.ini files. The program doesn't check if the typed directories exist. If they do not exist, they are just ignored. No warnings, no errors, no messages at all.

====-fov====
Specifies the Field of View for the player eyepoint.

Takes one argument decimal specifying the angle of the viewing cone in radians, from 0 to 2*pi

You can set the cone of view making things look bigger/smaller. The problem with this is that if you choose a small FOV, you will have a squashed look on the edges of your screen - stretched edges with a too high FOV. It is recommended to change the FOV as FS2 normally has some perspective distortion at the screen edges (FOV too high). Set the FOV to something like 0.39 - it will fix the distortion problem, and (as a nice side effect) will make everything look bigger and more realistic scale-wise. The default is 0.75, if you go higher, you'll get the fish-eye effect. Feel free to experiment. This must be entered into the "Custom flags" field

''Because of an active bug, FOV can misalign target boxes, effects, etc. Please check [http://lore.maxgaming.net/~scp/mantis/bug_view_advanced_page.php?bug_id=0000083 Mantis bug 083 status]if you are going to change the default value.''

----

===Multiplayer===
====-gamename====
Specifies the name of the game to be created by a stand-alone server.

Takes one argument string, the name to be assigned to the game being created.
====-password====
Specifies the password for a stand-alone server.

Takes one argument string, the required password for the game being created.
====-allowabove====
Specifies a player's minimum rank for joining a game on a stand-alone server.

Takes one argument integer, the points ranking above which a player must be to enter the game.
====-allowbelow====
Specifies a player's maximum rank for joining a game on a stand-alone server.

Takes one argument integer, the points ranking below which a player must be to enter the game.
====-port====
Specifies the port on which to run for a stand-alone server.

Takes one argument integer, the port which the game should use to connect.
====-connect====
'''''What does this do?'''''
====-clientdamage====
'''''What does this do?'''''
====-timeout====
'''''What does this do?'''''

[[Category:Lists]]
[[Category:Source Code Project]]

FS2 Status Page

2006-09-23T03:44:39Z

Martellato: Removed the links to game-warden and fs2netd sites "via ip"

{| style="background-color: #000;" border="0"
|colspan="3" align="left"|

==Latest Recommended Release==
|-
|[http://www.hard-light.net/forums/index.php/topic,41891.0.html '''Build''' 3.6.9 RC 7]
|align="center" style="color: limegreen;"|GOOD
|Mostly bug fixes of 3.6.7.
|-
|[http://fs2source.warpcore.org/exes/Launcher.rar '''Launcher''' 5.4]
|align="center" style="color: limegreen;"|GOOD
|
|-
|'''MediaVPs''' 3.6.8 Zeta
|align="center" style="color: limegreen;"|GOOD
|[http://www.hard-light.net/forums/index.php/topic,39905.0.html 3.6.8 Zeta]  Patches: [http://fs2source.warpcore.org/mediavp/mp-710_models.rar mp-710_models.rar]  [http://fs2source.warpcore.org/mediavp/mp-710_effects.rar mp-710_effects.rar]  [http://fs2source.warpcore.org/mediavp/mp-710_adveffects.rar mp-710_adveffects.rar]
|-
|'''OpenAL'''
|align="center" style="color: limegreen;"|GOOD
|If your fs2_open does not recognize OpenAL with this [http://fs2source.warpcore.org/exes/latest/OpenALwEAX.exe older installer], then [http://www.hard-light.net/forums/index.php/topic,41802.0.html please refer to this topic].

|-
|colspan="3" align="left"|
==Last Official Release==
|-
|'''Build''' 3.6.7
|align="center" style="color: limegreen;"|GOOD
|[http://scp.indiegames.us/download.php?list.8 Refer to scp.indiegames.us downloads page]
|-
|'''Launcher''' 5.3
|align="center" style="color: limegreen;"|GOOD
|[http://scp.indiegames.us/download.php?list.8 Refer to scp.indiegames.us downloads page]
|-
|'''MediaVPs''' 3.6.7
|align="center" style="color: limegreen;"|GOOD
|[http://scp.indiegames.us/download.php?list.2 Refer to scp.indiegames.us .vp files page]

|-
|colspan="3" align="left"|
==Multiplayer==
|-
|valign="top"|[http://www.game-warden.com/fs2open_pxo.cfg '''Multiplayer config file''']
|align="center" valign="top" style="color: limegreen;"|GOOD
|Tip: Save this file as data\fs2open_pxo.cfg AND mediavps\data\fs2open_pxo.cfg
If you are not able to connect to FS2NetD in-game when it is known to be online, [http://www.hard-light.net/forums/index.php/topic,41508.msg849031.html#msg849031 see this post].
|-
|[http://fs2netd.game-warden.com/ '''FS2NetD''' web site]
|align="center"|[http://www.hard-light.net/forums/index.php/topic,42138.msg859904.html#msg859904 Server Status Check]
|← Click any of the "Server Status Check" links to see the status of several FS2 servers

|-
|colspan="3" align="left"|

==Community==
|-
|[http://www.game-warden.com/ '''game-warden.com''']
|align="center"|[http://www.hard-light.net/forums/index.php/topic,42138.msg859904.html#msg859904 Server Status Check]
|
|}

FS2 Status Page

2006-09-22T18:10:39Z

Martellato: Changed links for fs2netd

{| style="background-color: #000;" border="0"
|colspan="3" align="left"|

==Latest Recommended Release==
|-
|[http://www.hard-light.net/forums/index.php/topic,41891.0.html '''Build''' 3.6.9 RC 7]
|align="center" style="color: limegreen;"|GOOD
|Mostly bug fixes of 3.6.7.
|-
|[http://fs2source.warpcore.org/exes/Launcher.rar '''Launcher''' 5.4]
|align="center" style="color: limegreen;"|GOOD
|
|-
|'''MediaVPs''' 3.6.8 Zeta
|align="center" style="color: limegreen;"|GOOD
|[http://www.hard-light.net/forums/index.php/topic,39905.0.html 3.6.8 Zeta]  Patches: [http://fs2source.warpcore.org/mediavp/mp-710_models.rar mp-710_models.rar]  [http://fs2source.warpcore.org/mediavp/mp-710_effects.rar mp-710_effects.rar]  [http://fs2source.warpcore.org/mediavp/mp-710_adveffects.rar mp-710_adveffects.rar]
|-
|'''OpenAL'''
|align="center" style="color: limegreen;"|GOOD
|If your fs2_open does not recognize OpenAL with this [http://fs2source.warpcore.org/exes/latest/OpenALwEAX.exe older installer], then [http://www.hard-light.net/forums/index.php/topic,41802.0.html please refer to this topic].

|-
|colspan="3" align="left"|
==Last Official Release==
|-
|'''Build''' 3.6.7
|align="center" style="color: limegreen;"|GOOD
|[http://scp.indiegames.us/download.php?list.8 Refer to scp.indiegames.us downloads page]
|-
|'''Launcher''' 5.3
|align="center" style="color: limegreen;"|GOOD
|[http://scp.indiegames.us/download.php?list.8 Refer to scp.indiegames.us downloads page]
|-
|'''MediaVPs''' 3.6.7
|align="center" style="color: limegreen;"|GOOD
|[http://scp.indiegames.us/download.php?list.2 Refer to scp.indiegames.us .vp files page]

|-
|colspan="3" align="left"|
==Multiplayer==
|-
|valign="top"|[http://64.92.160.250/fs2open_pxo.cfg '''Multiplayer config file''']
|align="center" valign="top" style="color: limegreen;"|GOOD
|Tip: Save this file as data\fs2open_pxo.cfg AND mediavps\data\fs2open_pxo.cfg
If you are not able to connect to FS2NetD in-game when it is known to be online, [http://www.hard-light.net/forums/index.php/topic,41508.msg849031.html#msg849031 see this post].
|-
|[http://fs2netd.game-warden.com/ '''FS2NetD''' web site]
|align="center"|[http://www.hard-light.net/forums/index.php/topic,42138.msg859904.html#msg859904 Server Status Check]
|← Click any of the "Server Status Check" links to see the status of several FS2 servers
|-
|[http://64.92.160.251/ '''FS2NetD''' web site ''via ip'']
|align="center"|[http://www.hard-light.net/forums/index.php/topic,42138.msg859904.html#msg859904 Server Status Check]
|

|-
|colspan="3" align="left"|

==Community==
|-
|[http://www.game-warden.com/ '''game-warden.com''']
|align="center"|[http://www.hard-light.net/forums/index.php/topic,42138.msg859904.html#msg859904 Server Status Check]
|
|-
|[http://64.92.160.250/ '''game-warden.com''' ''via ip'']
|align="center"|[http://www.hard-light.net/forums/index.php/topic,42138.msg859904.html#msg859904 Server Status Check]
|
|}

Command-Line Reference

2006-09-21T22:30:43Z

Martellato: -multilog description

==Launcher Flags==
The following command-line options can be chosen from the launcher.
===Graphics===
====-spec====
Enables specular mapping. Only polygons mapped with textures for which a shinemap exists will recieve specular mapping; no attempt is made to generate spec maps where they do not exist. Specular maps are specified with the base map name plus "-shine" (i.e. TCov3A-shine.pcx).
====-env====
Enables environment mapping. Environment mapping intensity will be determined from the intensity of specular maps. At the time of this writing (build 3.6.9 RC7), environment mapping only works when the video mode is OpenGL. [[Installing_fs2_open#Video setup|See Video setup.]]

====-glow====
Enables glowmapping. Only polygons mapped with textures for which a glowmap exists will be glowmapped. Glow maps are specified with the base map name plus "-glow" (i.e. TCov4A-glow.pcx)

====-jpgtga====
Enables the use of TGA and JPG file formats for image files. If a ship is showing up partially invisible, select this option.
====-pcx32====
'''WARNING - HIGH MEMORY USAGE'''

Enables PCX files to be loaded into 32-bit memory. This will not imporove the rendering of any ships in-game, and is usually more of a burden on performance than is worthwhile. Use at your own risk. Removed from launcher options after 3.6.7.

====-cell====
Enables cell shading. This will make graphics appear more "cartoonish". For use with media in mv_cell.vp. Not considered a standard enhancement.
====-mipmap====
Enables mipmapping.

====-nomotiondebris====
Disables motion debris.
====-2d_poof====
Applies nebula poofs in 2d, effectively preventing them from forming intersections with ships.
====-noscalevid====
Disables scaling of video clips.
====-missile_lighting====
Applys lighting to missiles.
====-rlm====
'''Obsolete Argument'''


Enables more accurate lighting model for OpenGL mode. Always on in current builds, so this command-line option has been removed.

----

===Game Speed===
====-img2dds====
Converts all images to DDS (compressed) format. Decreases memory usage but potentially reduces image quality.
====-no_vsync====
Disables vertical sync.
====-cache_bitmaps====
Caches bitmaps between missions, which will ideally reduce the load-time from one mission to another.

----

===HUD===
====-dualscanlines====
Adds a second pair of scanning lines to the target window when scanning an object.
====-targetinfo====
Displays target info, such as name and class, beside the targeted object.
====-orbradar====
Enables 3D radar (the Orb). 3D radar will replace the standard 2D version.
====-ballistic_gauge====
Adds an ammo gauge to the HUD when armed with a ballistic weapon.
====-rearm_timer====
Displays time remaining until rearm and repair from a support ship is complete.

----

===Gameplay===
====-smart_shields====
Enables "smart" shield recharging. Shield recharge is distributed to the most damaged shield quadrant instead of being distributed equally across the entire shield and be wasted when a quadrant is full.
====-ship_choice_3d====
Use ship and weapon models in ship selection and weapon loadout. Completely disables the standard ANI interface on those screens.
====-3dwarp====
Use full geometry for the subspace warp effect.
====-warp_flash====
Enable a flash at warp in and warp out.
====-UseNewAI====
Tells the game to use new AI routines. This argument alters mission balance and is not considered a standard feature.
====-tbp====
Enable feature set for The Babylon Project
====-wcsaga====
Enable feature set for The Wing Commander Saga

----

===Audio===
====-snd_preload====
Preload mission sounds. Useful in preventing game stuttering when sounds are played for the first time.
====-nosound====
Disables all sounds.
====-nomusic====
Disables music only.

----

===Multiplayer===
====-standalone====
Creates a standalone server.
====-startgame====
'''''What does this do?'''''
====-closed====
'''''What does this do?'''''
====-restricted====
'''''What does this do?'''''
====-multilog====
Creates a log file with a summary of packets sent and received in multiplayer games. The file is saved as \data\multi.log within the active mod folder - or with main data folder if no mod is active.

====-clientdamage====
'''''What does this do?'''''
====-mpnoreturn====
Disables return to the flight deck screen after a mission completes.

----

===Troubleshooting===
====-fixbugs====
'''Obsolete Argument - Removed in builds after 3.6.7'''


Originally used to disable certain crashing behavior as a stop-gap measure. This feature is not available in current builds.
====-nocrash====
'''Obsolete Argument - Removed in builds after 3.6.7'''


Originally used to disable certain crashing behavior as a stop-gap measure. This feature is not available in current builds.
====-oldfire====
'''''What does this do?'''''
====-nohtl====
'''WARNING - VERY SLOW'''

Reverts to software rendering mode. Does this work any more?
====-no_set_gamma====
Disables the gamma settings in the options screen.
====-nomovies====
Disables all video playback.
====-noparseerrors====
Disables some parsing warnings and makes other parse errors non-fatal. Do not rely on this when creating new tables, the errors are there for a reason.
====-safeloading====
Loads missions the old way. Typically safer, but slower.
====-query_speech====
Determines if the current build includes text-to-speech.
====-d3d_bad_tsys====
Enable inefficient texture system.
====-novbo====
Disables OpenGL VBO.
====-noibx====
Disables IBX caching of model geometry data. This will dramatically increase load times, but will help troubleshoot a model if one is working incorrectly.
====-loadallweps====
Load all weapons, even those not used.

----

===Experimental===
====-alpha_env====
Enables alpha environment mapping. OpenGL only. Environment mapping intensity will be determined from the alpha channel of specular maps.
====-decals====
Enables damage decals.
====-ingame_join====
Enables ingame joining in multiplayer. FIXME: Host option?
====-tga16====
'''Obsolete Argument - Removed in builds after 3.6.7'''


Originally used to converts TGA images to 16-bits in order to reduce memory footprint (at the expense of image quality), superseded by ''-img2dds''.
----

===Development Tools===
====-fps====
Displays current frames per second.
====-pos====
Displays current position coordinates of camera.
====-window====
Runs the game in a window. No check to make sure that resolution is no higher than your desktop resolution, so be careful.
====-timerbar====
Displays a timing bar across the top of the screen. Timebar format varies by build.
====-stats====
Shows total and free physical memory, virtual memory and system pagefile.

====-coords====
Shows coordinates of the mouse cursor.
====-show_mem_usage====
Shows detailed RAM usage in HUD.

The meaning of the info displayed in the upper right corner is:

'''DYN''' = dynamic memory, basically anything that's been allocated by the vm_* memory functions. This does NOT indicate total memory usage but does account for most of it.

'''POF''' = model memory, how much memory is being used by models (does not include textures)

'''C-BMP, BMP''' = bmpman memory, how much is used by the textures/images that are loaded. C-BMP means that you are using -cache_bitmaps and it will try to keep textures in memory between level loads and as the new level is loading it will keep what it needs and unload what it doesn't. Can greatly increase level loading speed, but does so at the cost of memory between level loads. This does not increase overall memory usage though, only during the loading screen. BMP means that it is not cached and all textures are unloaded from memory at the start of level load and all needed textures are then loaded from the disk again.

'''S-RAM''' = sound memory, how much is used by the sounds loaded in memory at the time. This counts static sounds only (from sounds.tbl, etc.) and not streaming sounds (music, voices, briefing stuff, etc).

'''V-RAM''' = approximate memory usage of video textures. This is not mean that your card has this much memory and can report higher numbers that your card actually has memory. For OpenGL it also includes some of the geometry data, but this number does not reflect the total memory that your video card is using. It only reports how much data the game has purposefully loaded into API memory (meaning it could be in system memory, video card memory, or AGP memory).

''(It only works with debug builds, not with release builds).''

====-pofspew====
'''''What does this do?'''''
====-tablecrcs====
'''''What does this do?'''''
====-missioncrcs====
'''''What does this do?'''''
====-dis_collisions====
Disables all collisions.
====-dis_weapons====
Disables weapons rendering.
====-output_sexps====
Outputs SEXPs to sexps.html.
====-output_scripting====
Outputs scripting to scripting.html.
====-nograb====
Unix only. Disables focus grabbing in a window.
==Other==
The following options are not available as checkboxes in the launcher. Many require parameters, which follow the flag seperated by a space. The prototype for use in this case is "-option argument"
===Graphics===
====-ambient_factor====

This must be entered into the "Custom flags" field. This is a multiplier applied to the intensity of ambient lighting. Ambient light is lighting applied to all parts of a ship. FS2's standard value is 120. Try 75 for a good and realistic looking value. However, that is relative.

====-spec_exp====

This must be used with the -spec command line parameter and must be entered into the "Custom flags" field. Adjusts the size of the shiny spot on ships. Higher number mean smaller spots. Default is 16, however 11 is recommended. However, that is relative.

====-spec_point====

This must be used with the -spec command line parameter and must be entered into the
"Custom flags" field. Adjusts how much laser weapons contribute to specular highlights. Higher number mean greater contributions. Default is 1.0, however 0.6 is recommended. However, that is relative.

====-spec_static====

This must be used with the -spec command line parameter and must be entered into the "Custom flags" field. Adjusts how much suns contribute to specular highlights. Higher numbers mean a greater contribution. Default is 1.0, however is 0.8 recommended. However, that is relative.

====-spec_tube====

This must be used with the -spec command line parameter and must be entered into the "Custom flags" field. Adjusts how much Beam Weapons contribute to specular highlights. Higher numbers mean a greater contribution. Default is 1.0, however 0.4 is recommended. However, that is relative.

====-clipdist====
Changes the distance from the viewpoint for the near-clipping plane.

Takes one argument decimal specifying the distance to the near-clipping plane.

----

===Gameplay===
====-mod====

Specifies in which folders inside Freespace2 directory, the game looks for all the game data (models, missions, textures, tables, ...). Retail version only looks inside ''Freespace2/data/'' structure and ''Freespace2/vp archives''.

This flag allows installing several different mods that modify retail behaviour, and switching between them without needing to erase files or having undesired cross effects. Each mod should be installed in its own folder.

It takes one argument string: the chain of names of the used directories. Comma (''',''') must be used as separator. In this way, '''-mod dir1,dir2,dir3,...,dirx''' causes the game to use the following directory precedence:

#Freespace2/dir1/
#Freespace2/dir2/
#Freespace2/dir3/
# ... (the rest of the typed directories) ...
#Freespace2/dirx/
#Freespace2/

:::Please note. Freespace Open doesn't like spaces in directories (in the full path) so do not install the game within ''Program Files/Freespace2'' or ''Games/Freespace 2'' and, of course, do not use spaces within mod directories (''dir1'' is OK but ''dir 1'' isn't).

This flag can be indirectly set, (and it is normally set), through Launcher MOD tab and mod.ini file. Within this Launcher tab you can select one directory, (let's call it ''moddir''), so the flag is at least set to '''-mod moddir'''. If ''Freespace2/moddir/mod.ini'' exists, (its format must be plain text), it will be read and, inside it, the following section and lines can be used to modify the -mod flag too:

: [multimod] PrimaryList = Pri1,Pri2,...(the rest of desired directories)...,Prix; SecondaryList = Sec1,Sec2,...(the rest of desired directories)...,Secx;

(Please note the ending semicolon (;) in each list line). With these lines the following flag would be built:
: '''-mod Pri1,Pri2,...,Prix,moddir,Sec1,Sec2,...,Secx'''

If primary or secondary folders aren't used, their respective line can be erased or it can be typed as ''xxxxxxList = ;''.

::: '''''PLEASE NOTE''': '''Launcher v 5.4''', or later, '''must be used'''. Earlier versions had some bugs that would cause the previous explanation about mod.ini fail.''

::: The most common use of mod.ini and SecondaryList is sharing resources between mods. And the best example is the enhaced media vps from SCP crew. Most of the people install them in a folder called ''mediavps'' inside ''Freespace2''. In this way when running retail FS2 they do not interfere with this original game version that doesn't use this -mod flag feature. When using FS2_Open but without mods, you just need to select ''mediavps'' in Launcher MOD tab to use them. And if you want to enjoy that enhacements while playing any 'real' mod, you just need to put a mod.ini file inside its ''moddir'' with at least a ''SecondaryList = mediavps;'' line.

Inside each directory, data precedence is the following:

#Individual files located in ''Current_dir/data/'' subdir structure.
#Files located inside vp archives. (These vp archives are 'similar' to zip archives, they just contain other files and folders. Moreover, files have to be stored using the same ''data/'' structure used outside it). Vp archives are read in alphabetical order so aaa.vp files have higher priority than aab.vp files and so on.

The highest priority file overrides the rest of them. In this way, if you have a ''Mission.fs2'' inside ''Freespace2/Pri1/data/missions/'' it doesn't matter how this ''Mission.fs2'' is inside ''Freespace2/Pri1/aaa.vp'', ''Freespace2/Pri1/aab.vp'', ... or ''Freespace2/data/missions/''. This data precedence allows the user to quickly replace old files by corrected or enhaced ones adding them in a higher priority place.

As derived from explanation, the exact names for directories or vp archives are actually irrelevant. It only matters the directory order inside -mod flag argument and the alphabetical order for vp archives inside each used directory.

:'''Additional notes'''

# This flag is also used by FRED. So if there is special mod info, (like backgrounds maps, ship models or whatever), it must be typed, (''Fred2_Open_r.exe -MOD whatever''), or FRED won't be able to use it. No Launcher MOD tab available for this use. 
# Be careful while typing the directory names in the flag argument or inside mod.ini files. The program doesn't check if the typed directories exist. If they do not exist, they are just ignored. No warnings, no errors, no messages at all.

====-fov====
Specifies the Field of View for the player eyepoint.

Takes one argument decimal specifying the angle of the viewing cone in radians, from 0 to 2*pi

You can set the cone of view making things look bigger/smaller. The problem with this is that if you choose a small FOV, you will have a squashed look on the edges of your screen - stretched edges with a too high FOV. It is recommended to change the FOV as FS2 normally has some perspective distortion at the screen edges (FOV too high). Set the FOV to something like 0.39 - it will fix the distortion problem, and (as a nice side effect) will make everything look bigger and more realistic scale-wise. The default is 0.75, if you go higher, you'll get the fish-eye effect. Feel free to experiment. This must be entered into the "Custom flags" field

''Because of an active bug, FOV can misalign target boxes, effects, etc. Please check [http://lore.maxgaming.net/~scp/mantis/bug_view_advanced_page.php?bug_id=0000083 Mantis bug 083 status]if you are going to change the default value.''

----

===Multiplayer===
====-gamename====
Specifies the name of the game to be created by a stand-alone server.

Takes one argument string, the name to be assigned to the game being created.
====-password====
Specifies the password for a stand-alone server.

Takes one argument string, the required password for the game being created.
====-allowabove====
Specifies a player's minimum rank for joining a game on a stand-alone server.

Takes one argument integer, the points ranking above which a player must be to enter the game.
====-allowbelow====
Specifies a player's maximum rank for joining a game on a stand-alone server.

Takes one argument integer, the points ranking below which a player must be to enter the game.
====-port====
Specifies the port on which to run for a stand-alone server.

Takes one argument integer, the port which the game should use to connect.
====-connect====
'''''What does this do?'''''
====-clientdamage====
'''''What does this do?'''''
====-timeout====
'''''What does this do?'''''

[[Category:Lists]]
[[Category:Source Code Project]]

Source Code Project index

2006-09-14T04:30:30Z

Martellato: Changed the link to [FS2 Status Page]

===Getting Started with the Source Code Project===

[[FSSCP Introduction]]
 [[Installing fs2_open]]
 [[FS2 data installation]]
 [[Installing mods for fs2_open]]
 [[Troubleshooting]]
 [[Bug Reporting]]
 [[FS2 Status Page]]

===Getting Started with Development===
 [[Coding In C]]
 [[Linux CVS Howto]]

[[Category:Source Code Project]]

FS2 Status Page

2006-09-14T04:26:32Z

Martellato: Status indicators were added, as well as minor formatting changes

{| style="background-color: #000;" border="0"
|colspan="3" align="left"|

==Latest Recommended Release==
|-
|[http://www.hard-light.net/forums/index.php/topic,41891.0.html '''Build''' 3.6.9 RC 7]
|align="center" style="color: limegreen;"|GOOD
|Mostly bug fixes of 3.6.7.
|-
|[http://fs2source.warpcore.org/exes/Launcher.rar '''Launcher''' 5.4]
|align="center" style="color: limegreen;"|GOOD
|
|-
|'''MediaVPs''' 3.6.8 Zeta
|align="center" style="color: limegreen;"|GOOD
|[http://www.hard-light.net/forums/index.php/topic,39905.0.html 3.6.8 Zeta]  Patches: [http://fs2source.warpcore.org/mediavp/mp-710_models.rar mp-710_models.rar]  [http://fs2source.warpcore.org/mediavp/mp-710_effects.rar mp-710_effects.rar]  [http://fs2source.warpcore.org/mediavp/mp-710_adveffects.rar mp-710_adveffects.rar]
|-
|'''OpenAL'''
|align="center" style="color: limegreen;"|GOOD
|If your fs2_open does not recognize OpenAL with this [http://fs2source.warpcore.org/exes/latest/OpenALwEAX.exe older installer], then [http://www.hard-light.net/forums/index.php/topic,41802.0.html please refer to this topic].

|-
|colspan="3" align="left"|
==Last Official Release==
|-
|'''Build''' 3.6.7
|align="center" style="color: limegreen;"|GOOD
|[http://scp.indiegames.us/download.php?list.8 Refer to scp.indiegames.us downloads page]
|-
|'''Launcher''' 5.3
|align="center" style="color: limegreen;"|GOOD
|[http://scp.indiegames.us/download.php?list.8 Refer to scp.indiegames.us downloads page]
|-
|'''MediaVPs''' 3.6.7
|align="center" style="color: limegreen;"|GOOD
|[http://scp.indiegames.us/download.php?list.2 Refer to scp.indiegames.us .vp files page]

|-
|colspan="3" align="left"|
==Multiplayer==
|-
|valign="top"|[http://64.92.160.250/fs2open_pxo.cfg '''Multiplayer config file''']
|align="center" valign="top" style="color: limegreen;"|GOOD
|Tip: Save this file as data\fs2open_pxo.cfg AND mediavps\data\fs2open_pxo.cfg
If you are not able to connect to FS2NetD in-game when it is known to be online, [http://www.hard-light.net/forums/index.php/topic,41508.msg849031.html#msg849031 see this post].
|-
|[http://freespaceserver.cjb.net/fs2netd/ '''FS2NetD''' web site]
|align="center"|[http://www.hard-light.net/forums/index.php/topic,42138.msg859904.html#msg859904 Server Status Check]
|← Click any of the "Server Status Check" links to see the status of several FS2 servers
|-
|[http://66.25.7.198/fs2netd/ '''FS2NetD''' web site ''via ip'']
|align="center"|[http://www.hard-light.net/forums/index.php/topic,42138.msg859904.html#msg859904 Server Status Check]
|

|-
|colspan="3" align="left"|
==Community==
|-
|[http://www.game-warden.com/ '''game-warden.com''']
|align="center"|[http://www.hard-light.net/forums/index.php/topic,42138.msg859904.html#msg859904 Server Status Check]
|
|-
|[http://64.92.160.250/ '''game-warden.com''' ''via ip'']
|align="center"|[http://www.hard-light.net/forums/index.php/topic,42138.msg859904.html#msg859904 Server Status Check]
|
|}

Relevant Links

2006-09-14T02:35:49Z

Martellato: Relevant Links moved to FS2 Status Page: Hopefully this is a better description of the links included on this page; they are meant to give visitors a general update on the state of fs2_open, as well as updates on relavent web sites that may be off

#REDIRECT [[FS2 Status Page]]

FS2 Status Page

2006-09-14T02:35:49Z

==Latest Recommended Release==
[http://www.hard-light.net/forums/index.php/topic,41891.0.html Build 3.6.9 RC 7]: Mostly bug fixes of 3.6.7.
 [http://fs2source.warpcore.org/exes/Launcher.rar Launcher 5.4]
 MediaVPs 3.6.8 Zeta: [http://www.hard-light.net/forums/index.php/topic,39905.0.html 3.6.8 Zeta] Patches: [http://fs2source.warpcore.org/mediavp/mp-710_models.rar mp-710_models.rar] [http://fs2source.warpcore.org/mediavp/mp-710_effects.rar mp-710_effects.rar] [http://fs2source.warpcore.org/mediavp/mp-710_adveffects.rar mp-710_adveffects.rar]
 [http://fs2source.warpcore.org/exes/latest/OpenALwEAX.exe OpenAL (version 1.1)]

==Last Official Release==
Build 3.6.7
 Launcher 5.3
 MediaVPs 3.6.7
 Refer to http://scp.indiegames.us/download.php

==Multiplayer==
[http://64.92.160.250/fs2open_pxo.cfg Multiplayer config file]
 [http://freespaceserver.cjb.net/fs2netd/ FS2NetD web site] If the 1st link doesn't work, try [http://66.25.7.198/fs2netd/ http://66.25.7.198/fs2netd/]

==Community==
[http://64.92.160.250 game-warden.com]

FS2 Status Page

2006-09-10T22:29:48Z

Martellato: /* Multiplayer */

Installing fs2 open

2006-09-08T07:52:09Z

Martellato: /* Video setup */

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.

== Step One: Understanding what you need ==

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

First, 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.

Next, the fs2_open build. This is the core game engine, a single executable file.

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.3. Otherwise, go with Launcher 4. To install either, extract it to your main Freespace 2 folder. (You can have both on your computer at the same time, although it's not recommended)

[http://scp.indiegames.us/download.php?view.133 Launcher 5.3 download page]

== 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. Depending on the version, there may be some minor bugs that made it into the final release. (In 3.6, you can't warp out in Very Easy difficulty; in 3.6.5, OGG music, and thus the MediaVP package mv_music, will cause a crash to desktop, 3.6.7 has issues with dual core processors). However, they are more consistently stable than "recent builds", as they represent a group effort to get a stable build out, by all coders on the [[FSSCP]].

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.

[http://scp.indiegames.us/download.php?list.8 Official release download page]

=== Recent Builds ===
Recent Builds are ones that individual coders release. These may be more stable than Official Releases, in some cases. 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.

[http://scp.indiegames.us/download.php?list.7 Recent builds download page]

== Step Four: Choosing your MediaVPs ==

There are a variety of different [[MediaVP]]s available for download. No matter what system you have, it should be able to support mv_core with no degradation in performance. This will enable a few interface improvements that require extra art.

mv_music should only be used with builds from April 2005 or after. mv_models should not be used on systems that do not support HT&L (video cards such as the TNT2 and below do not support HT&L). mv_adveffects should only be used if you have an high-end system. (In the neighborhood of an X800 or 6800, and with a P4 or AMD64 processor.) The rest of the MediaVPs can be installed as your computer allows. (You may want to download them one at a time after you have configured fs2_open so you can get an idea of how much they will slow fs2_open down)

There are two ways to set up the media VPs. The quick and dirty method is to simply dump them in your main Freespace 2 folder. This will allow FS2_open to work but will prevent you from playing the standard retail version or from playing games on FS2NetD (The FS2 online service) without getting a "hacked tables" error message. The second way preserves both of these and requires minimal extra time to set up. (See step six for further details)

[http://scp.indiegames.us/download.php?list.2 MediaVP download page]

== 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.

Next, ensure that the "Audio/Joystick" and "Network" tabs have the proper settings. (If you have trouble with your joystick not working properly in fs2_open, you may try the "Force 0" or "Force 1" options, which will force fs2_open to use the first or second joysticks, respectively.

=== 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.

=== 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. At the time of this writing (build 3.6.9 RC7), [[Command-Line_Reference#-env|environment mapping]] only works when the video mode is OpenGL. Note that if you're using an ATI card, with Catalyst drivers above 4.3, shinemaps will not work in Direct3D.

"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. Note that this option is only visible on launcher 5.3 and below. Regarding more recent launchers (5.4+): while this check-box is not shown, all non-standard modes are always included in the resolution options.

=== 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 Flags]] 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 jpg,tga textures", "Enable more realistic lighting", and "Load only used weapons". (You may have to choose a different section in the drop-down box to get to some of these days). There are many, many more options, but these should get you started.

[http://www.hard-light.net/wiki/index.php/Command-Line_Reference Command line Flags]

== 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 "scp" or "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.)

[[Category:Source Code Project]]

Command-Line Reference

2006-09-08T07:07:18Z

Martellato: /* -env */

==Launcher Flags==
The following command-line options can be chosen from the launcher.
===Graphics===
====-spec====
Enables specular mapping. Only polygons mapped with textures for which a shinemap exists will recieve specular mapping; no attempt is made to generate spec maps where they do not exist. Specular maps are specified with the base map name plus "-shine" (i.e. TCov3A-shine.pcx).
====-env====
Enables environment mapping. Environment mapping intensity will be determined from the intensity of specular maps. At the time of this writing (build 3.6.9 RC7), environment mapping only works when the video mode is OpenGL. [[Installing_fs2_open#Video setup|See Video setup.]]

====-glow====
Enables glowmapping. Only polygons mapped with textures for which a glowmap exists will be glowmapped. Glow maps are specified with the base map name plus "-glow" (i.e. TCov4A-glow.pcx)

====-jpgtga====
Enables the use of TGA and JPG file formats for image files. If a ship is showing up partially invisible, select this option.
====-pcx32====
'''WARNING - HIGH MEMORY USAGE'''

Enables PCX files to be loaded into 32-bit memory. This will not imporove the rendering of any ships in-game, and is usually more of a burden on performance than is worthwhile. Use at your own risk. Removed from launcher options after 3.6.7.

====-cell====
Enables cell shading. This will make graphics appear more "cartoonish". For use with media in mv_cell.vp. Not considered a standard enhancement.
====-mipmap====
Enables mipmapping.

====-nomotiondebris====
Disables motion debris.
====-2d_poof====
Applies nebula poofs in 2d, effectively preventing them from forming intersections with ships.
====-noscalevid====
Disables scaling of video clips.
====-missile_lighting====
Applys lighting to missiles.
====-rlm====
'''Obsolete Argument'''


Enables more accurate lighting model for OpenGL mode. Always on in current builds, so this command-line option has been removed.

----

===Game Speed===
====-img2dds====
Converts all images to DDS (compressed) format. Decreases memory usage but potentially reduces image quality.
====-no_vsync====
Disables vertical sync.
====-cache_bitmaps====
Caches bitmaps between missions, which will ideally reduce the load-time from one mission to another.

----

===HUD===
====-dualscanlines====
Adds a second pair of scanning lines to the target window when scanning an object.
====-targetinfo====
Displays target info, such as name and class, beside the targeted object.
====-orbradar====
Enables 3D radar (the Orb). 3D radar will replace the standard 2D version.
====-ballistic_gauge====
Adds an ammo gauge to the HUD when armed with a ballistic weapon.
====-rearm_timer====
Displays time remaining until rearm and repair from a support ship is complete.

----

===Gameplay===
====-smart_shields====
Enables "smart" shield recharging. Shield recharge is distributed to the most damaged shield quadrant instead of being distributed equally across the entire shield and be wasted when a quadrant is full.
====-ship_choice_3d====
Use ship and weapon models in ship selection and weapon loadout. Completely disables the standard ANI interface on those screens.
====-3dwarp====
Use full geometry for the subspace warp effect.
====-warp_flash====
Enable a flash at warp in and warp out.
====-UseNewAI====
Tells the game to use new AI routines. This argument alters mission balance and is not considered a standard feature.
====-tbp====
Enable feature set for The Babylon Project
====-wcsaga====
Enable feature set for The Wing Commander Saga

----

===Audio===
====-snd_preload====
Preload mission sounds. Useful in preventing game stuttering when sounds are played for the first time.
====-nosound====
Disables all sounds.
====-nomusic====
Disables music only.

----

===Multiplayer===
====-standalone====
Creates a standalone server.
====-startgame====
'''''What does this do?'''''
====-closed====
'''''What does this do?'''''
====-restricted====
'''''What does this do?'''''
====-multilog====
'''''What does this do?'''''
====-clientdamage====
'''''What does this do?'''''
====-mpnoreturn====
Disables return to the flight deck screen after a mission completes.

----

===Troubleshooting===
====-fixbugs====
'''Obsolete Argument - Removed in builds after 3.6.7'''


Originally used to disable certain crashing behavior as a stop-gap measure. This feature is not available in current builds.
====-nocrash====
'''Obsolete Argument - Removed in builds after 3.6.7'''


Originally used to disable certain crashing behavior as a stop-gap measure. This feature is not available in current builds.
====-oldfire====
'''''What does this do?'''''
====-nohtl====
'''WARNING - VERY SLOW'''

Reverts to software rendering mode. Does this work any more?
====-no_set_gamma====
Disables the gamma settings in the options screen.
====-nomovies====
Disables all video playback.
====-noparseerrors====
Disables some parsing warnings and makes other parse errors non-fatal. Do not rely on this when creating new tables, the errors are there for a reason.
====-safeloading====
Loads missions the old way. Typically safer, but slower.
====-query_speech====
Determines if the current build includes text-to-speech.
====-d3d_bad_tsys====
Enable inefficient texture system.
====-novbo====
Disables OpenGL VBO.
====-noibx====
Disables IBX caching of model geometry data. This will dramatically increase load times, but will help troubleshoot a model if one is working incorrectly.
====-loadallweps====
Load all weapons, even those not used.

----

===Experimental===
====-alpha_env====
Enables alpha environment mapping. OpenGL only. Environment mapping intensity will be determined from the alpha channel of specular maps.
====-decals====
Enables damage decals.
====-ingame_join====
Enables ingame joining in multiplayer. FIXME: Host option?
====-tga16====
'''Obsolete Argument - Removed in builds after 3.6.7'''


Originally used to converts TGA images to 16-bits in order to reduce memory footprint (at the expense of image quality), superseded by ''-img2dds''.
----

===Development Tools===
====-fps====
Displays current frames per second.
====-pos====
Displays current position coordinates of camera.
====-window====
Runs the game in a window. No check to make sure that resolution is no higher than your desktop resolution, so be careful.
====-timerbar====
Displays a timing bar across the top of the screen. Timebar format varies by build.
====-stats====
Shows total and free physical memory, virtual memory and system pagefile.

====-coords====
Shows coordinates of the mouse cursor.
====-show_mem_usage====
Shows detailed RAM usage in HUD.

The meaning of the info displayed in the upper right corner is:

'''DYN''' = dynamic memory, basically anything that's been allocated by the vm_* memory functions. This does NOT indicate total memory usage but does account for most of it.

'''POF''' = model memory, how much memory is being used by models (does not include textures)

'''C-BMP, BMP''' = bmpman memory, how much is used by the textures/images that are loaded. C-BMP means that you are using -cache_bitmaps and it will try to keep textures in memory between level loads and as the new level is loading it will keep what it needs and unload what it doesn't. Can greatly increase level loading speed, but does so at the cost of memory between level loads. This does not increase overall memory usage though, only during the loading screen. BMP means that it is not cached and all textures are unloaded from memory at the start of level load and all needed textures are then loaded from the disk again.

'''S-RAM''' = sound memory, how much is used by the sounds loaded in memory at the time. This counts static sounds only (from sounds.tbl, etc.) and not streaming sounds (music, voices, briefing stuff, etc).

'''V-RAM''' = approximate memory usage of video textures. This is not mean that your card has this much memory and can report higher numbers that your card actually has memory. For OpenGL it also includes some of the geometry data, but this number does not reflect the total memory that your video card is using. It only reports how much data the game has purposefully loaded into API memory (meaning it could be in system memory, video card memory, or AGP memory).

''(It only works with debug builds, not with release builds).''

====-pofspew====
'''''What does this do?'''''
====-tablecrcs====
'''''What does this do?'''''
====-missioncrcs====
'''''What does this do?'''''
====-dis_collisions====
Disables all collisions.
====-dis_weapons====
Disables weapons rendering.
====-output_sexps====
Outputs SEXPs to sexps.html.
====-output_scripting====
Outputs scripting to scripting.html.
====-nograb====
Unix only. Disables focus grabbing in a window.
==Other==
The following options are not available as checkboxes in the launcher. Many require parameters, which follow the flag seperated by a space. The prototype for use in this case is "-option argument"
===Graphics===
====-ambient_factor====

This must be entered into the "Custom flags" field. This is a multiplier applied to the intensity of ambient lighting. Ambient light is lighting applied to all parts of a ship. FS2's standard value is 120. Try 75 for a good and realistic looking value. However, that is relative.

====-spec_exp====

This must be used with the -spec command line parameter and must be entered into the "Custom flags" field. Adjusts the size of the shiny spot on ships. Higher number mean smaller spots. Default is 16, however 11 is recommended. However, that is relative.

====-spec_point====

This must be used with the -spec command line parameter and must be entered into the
"Custom flags" field. Adjusts how much laser weapons contribute to specular highlights. Higher number mean greater contributions. Default is 1.0, however 0.6 is recommended. However, that is relative.

====-spec_static====

This must be used with the -spec command line parameter and must be entered into the "Custom flags" field. Adjusts how much suns contribute to specular highlights. Higher numbers mean a greater contribution. Default is 1.0, however is 0.8 recommended. However, that is relative.

====-spec_tube====

This must be used with the -spec command line parameter and must be entered into the "Custom flags" field. Adjusts how much Beam Weapons contribute to specular highlights. Higher numbers mean a greater contribution. Default is 1.0, however 0.4 is recommended. However, that is relative.

====-clipdist====
Changes the distance from the viewpoint for the near-clipping plane.

Takes one argument decimal specifying the distance to the near-clipping plane.

----

===Gameplay===
====-mod====

Specifies in which folders inside Freespace2 directory, the game looks for all the game data (models, missions, textures, tables, ...). Retail version only looks inside ''Freespace2/data/'' structure and ''Freespace2/vp archives''.

This flag allows installing several different mods that modify retail behaviour, and switching between them without needing to erase files or having undesired cross effects. Each mod should be installed in its own folder.

It takes one argument string: the chain of names of the used directories. Comma (''',''') must be used as separator. In this way, '''-mod dir1,dir2,dir3,...,dirx''' causes the game to use the following directory precedence:

#Freespace2/dir1/
#Freespace2/dir2/
#Freespace2/dir3/
# ... (the rest of the typed directories) ...
#Freespace2/dirx/
#Freespace2/

:::Please note. Freespace Open doesn't like spaces in directories (in the full path) so do not install the game within ''Program Files/Freespace2'' or ''Games/Freespace 2'' and, of course, do not use spaces within mod directories (''dir1'' is OK but ''dir 1'' isn't).

This flag can be indirectly set, (and it is normally set), through Launcher MOD tab and mod.ini file. Within this Launcher tab you can select one directory, (let's call it ''moddir''), so the flag is at least set to '''-mod moddir'''. If ''Freespace2/moddir/mod.ini'' exists, (its format must be plain text), it will be read and, inside it, the following section and lines can be used to modify the -mod flag too:

: [multimod] PrimaryList = Pri1,Pri2,...(the rest of desired directories)...,Prix; SecondaryList = Sec1,Sec2,...(the rest of desired directories)...,Secx;

(Please note the ending semicolon (;) in each list line). With these lines the following flag would be built:
: '''-mod Pri1,Pri2,...,Prix,moddir,Sec1,Sec2,...,Secx'''

If primary or secondary folders aren't used, their respective line can be erased or it can be typed as ''xxxxxxList = ;''.

::: '''''PLEASE NOTE''': '''Launcher v 5.4''', or later, '''must be used'''. Earlier versions had some bugs that would cause the previous explanation about mod.ini fail.''

::: The most common use of mod.ini and SecondaryList is sharing resources between mods. And the best example is the enhaced media vps from SCP crew. Most of the people install them in a folder called ''mediavps'' inside ''Freespace2''. In this way when running retail FS2 they do not interfere with this original game version that doesn't use this -mod flag feature. When using FS2_Open but without mods, you just need to select ''mediavps'' in Launcher MOD tab to use them. And if you want to enjoy that enhacements while playing any 'real' mod, you just need to put a mod.ini file inside its ''moddir'' with at least a ''SecondaryList = mediavps;'' line.

Inside each directory, data precedence is the following:

#Individual files located in ''Current_dir/data/'' subdir structure.
#Files located inside vp archives. (These vp archives are 'similar' to zip archives, they just contain other files and folders. Moreover, files have to be stored using the same ''data/'' structure used outside it). Vp archives are read in alphabetical order so aaa.vp files have higher priority than aab.vp files and so on.

The highest priority file overrides the rest of them. In this way, if you have a ''Mission.fs2'' inside ''Freespace2/Pri1/data/missions/'' it doesn't matter how this ''Mission.fs2'' is inside ''Freespace2/Pri1/aaa.vp'', ''Freespace2/Pri1/aab.vp'', ... or ''Freespace2/data/missions/''. This data precedence allows the user to quickly replace old files by corrected or enhaced ones adding them in a higher priority place.

As derived from explanation, the exact names for directories or vp archives are actually irrelevant. It only matters the directory order inside -mod flag argument and the alphabetical order for vp archives inside each used directory.

:'''Additional notes'''

# This flag is also used by FRED. So if there is special mod info, (like backgrounds maps, ship models or whatever), it must be typed, (''Fred2_Open_r.exe -MOD whatever''), or FRED won't be able to use it. No Launcher MOD tab available for this use. 
# Be careful while typing the directory names in the flag argument or inside mod.ini files. The program doesn't check if the typed directories exist. If they do not exist, they are just ignored. No warnings, no errors, no messages at all.

====-fov====
Specifies the Field of View for the player eyepoint.

Takes one argument decimal specifying the angle of the viewing cone in radians, from 0 to 2*pi

You can set the cone of view making things look bigger/smaller. The problem with this is that if you choose a small FOV, you will have a squashed look on the edges of your screen - stretched edges with a too high FOV. It is recommended to change the FOV as FS2 normally has some perspective distortion at the screen edges (FOV too high). Set the FOV to something like 0.39 - it will fix the distortion problem, and (as a nice side effect) will make everything look bigger and more realistic scale-wise. The default is 0.75, if you go higher, you'll get the fish-eye effect. Feel free to experiment. This must be entered into the "Custom flags" field

''Because of an active bug, FOV can misalign target boxes, effects, etc. Please check [http://lore.maxgaming.net/~scp/mantis/bug_view_advanced_page.php?bug_id=0000083 Mantis bug 083 status]if you are going to change the default value.''

----

===Multiplayer===
====-gamename====
Specifies the name of the game to be created by a stand-alone server.

Takes one argument string, the name to be assigned to the game being created.
====-password====
Specifies the password for a stand-alone server.

Takes one argument string, the required password for the game being created.
====-allowabove====
Specifies a player's minimum rank for joining a game on a stand-alone server.

Takes one argument integer, the points ranking above which a player must be to enter the game.
====-allowbelow====
Specifies a player's maximum rank for joining a game on a stand-alone server.

Takes one argument integer, the points ranking below which a player must be to enter the game.
====-port====
Specifies the port on which to run for a stand-alone server.

Takes one argument integer, the port which the game should use to connect.
====-connect====
'''''What does this do?'''''
====-clientdamage====
'''''What does this do?'''''
====-timeout====
'''''What does this do?'''''

[[Category:Lists]]
[[Category:Source Code Project]]

Installing fs2 open

2006-09-08T07:07:06Z

Martellato: /* Video setup */

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.

== Step One: Understanding what you need ==

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

First, 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.

Next, the fs2_open build. This is the core game engine, a single executable file.

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.3. Otherwise, go with Launcher 4. To install either, extract it to your main Freespace 2 folder. (You can have both on your computer at the same time, although it's not recommended)

[http://scp.indiegames.us/download.php?view.133 Launcher 5.3 download page]

== 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. Depending on the version, there may be some minor bugs that made it into the final release. (In 3.6, you can't warp out in Very Easy difficulty; in 3.6.5, OGG music, and thus the MediaVP package mv_music, will cause a crash to desktop, 3.6.7 has issues with dual core processors). However, they are more consistently stable than "recent builds", as they represent a group effort to get a stable build out, by all coders on the [[FSSCP]].

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.

[http://scp.indiegames.us/download.php?list.8 Official release download page]

=== Recent Builds ===
Recent Builds are ones that individual coders release. These may be more stable than Official Releases, in some cases. 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.

[http://scp.indiegames.us/download.php?list.7 Recent builds download page]

== Step Four: Choosing your MediaVPs ==

There are a variety of different [[MediaVP]]s available for download. No matter what system you have, it should be able to support mv_core with no degradation in performance. This will enable a few interface improvements that require extra art.

mv_music should only be used with builds from April 2005 or after. mv_models should not be used on systems that do not support HT&L (video cards such as the TNT2 and below do not support HT&L). mv_adveffects should only be used if you have an high-end system. (In the neighborhood of an X800 or 6800, and with a P4 or AMD64 processor.) The rest of the MediaVPs can be installed as your computer allows. (You may want to download them one at a time after you have configured fs2_open so you can get an idea of how much they will slow fs2_open down)

There are two ways to set up the media VPs. The quick and dirty method is to simply dump them in your main Freespace 2 folder. This will allow FS2_open to work but will prevent you from playing the standard retail version or from playing games on FS2NetD (The FS2 online service) without getting a "hacked tables" error message. The second way preserves both of these and requires minimal extra time to set up. (See step six for further details)

[http://scp.indiegames.us/download.php?list.2 MediaVP download page]

== 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.

Next, ensure that the "Audio/Joystick" and "Network" tabs have the proper settings. (If you have trouble with your joystick not working properly in fs2_open, you may try the "Force 0" or "Force 1" options, which will force fs2_open to use the first or second joysticks, respectively.

=== 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.

=== 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. At the time of this writing (build 3.6.9 RC7), [[Command-Line_Reference#-env|environment mapping]] only works when the video mode is OpenGL. Note that if you're using an ATI card, with Catalyst drivers above 4.3, shinemaps will not work in Direct3D.

"Allow non standard modes" will let you choose resoltuions 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 Flags]] 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 jpg,tga textures", "Enable more realistic lighting", and "Load only used weapons". (You may have to choose a different section in the drop-down box to get to some of these days). There are many, many more options, but these should get you started.

[http://www.hard-light.net/wiki/index.php/Command-Line_Reference Command line Flags]

== 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 "scp" or "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.)

[[Category:Source Code Project]]