FreeSpace Wiki - User contributions [en]

Command-Line Reference

2015-11-06T03:40:24Z

Echelon9: Document -enable_shadows command line option

{{TableVersionGit|2015-11-06|1d66596bfb}}

Command-Line Flags (also called Command-Line Parameters) are optional flags passed to the FSO executable, and generally enables one or more features added to the FS2 Open engine. These flags are accessed conveniently through an [[FSO Launcher]]. To have FSO list all available flags, use any one of the following: [[Command-Line_Reference#-help|-help]], [[Command-Line_Reference#-help|--help]], [[Command-Line_Reference#-help|-h]], or [[Command-Line_Reference#-help|-?]].



===Graphics===
====-spec====
'''"Enable Specular"'''

Only polygons mapped with textures for which a shinemap exists will receive 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).
{{Table3615|
*This feature is on by default, use launcher option Disable Specular or if necessary to manually disable enter the flag -nospec}}

====-env====
'''"Enable Environment maps"'''

It only works if [[Command-Line_Reference#-spec|-spec]] is also set. Environment mapping intensity will be determined from the shine map too (see [[Texturing]] for more info). [[Installing FreeSpace 2 Open#Video setup|See Video setup.]]
{{Table3615|
*This feature is on by default, use launcher option Disable Environment Maps or if necessary to manually disable enter the flag -noenv }}

====-glow====
'''"Enable Glowmaps"'''

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)
{{Table3615|
*This feature is on by default, use launcher option Disable Glow Maps or if necessary to manually disable enter the flag -noglow }}

====-nomotiondebris====
'''"Disable motion debris"'''

====-noscalevid====
"Disable scale-to-window for Movies"

Disables fullscreen scaling of video clips.

====-missile_lighting====
'''"Apply Lighting to Missiles"'''

====-normal====
'''"Enable Normal Maps"'''

Normal maps require GLSL rendering, (see [[OpenGL_Shaders_(GLSL)|OpenGL Shaders (GLSL)]] for further info). It needs auxiliary normal maps (the same name of the base map plus "-normal"). DXT5_NM DDS format is needed. (Technical note: DXT5 will work, since only the GREEN and ALPHA channels are read by the current shader system. One direction of lines goes into the GREEN channel, the other direction goes into the ALPHA channel. RED and BLUE can be either base gray (#808080) or black. Usual practice is after creating the DXT5_NM, copy the RED channel to the ALPHA channel, black out the RED and BLUE an then save as either a DXT5 or u8888 (uncompressed) DDS file.)
{{Table3615|
*This feature is on by default, use launcher option Disable Normal Maps or if necessary to manually disable enter the flag -nonormal }}

====-height====
Enables height maps (parallax mapping). It only works if [[Command-Line_Reference#-normal|-normal]] is also set. It also needs GLSL rendering, (see [[OpenGL_Shaders_(GLSL)|OpenGL Shaders (GLSL)]] for further info). It needs auxiliary height maps (with the same name than base map plus "-height").
{{Table3615|
*This feature is on by default. To manually disable, enter the flag -noheight}}

====-post_process====
'''"Enable Post Processing"'''

enables the use (if present) of post-processing effects as defined by the post_process.tbl. Bloom usage has an additional cmdline option for setting it's value, most post processing effects are achieved in mission per the mission designer or can be enabled globally in the table.

====-soft_particles====
'''"Enable soft particles"'''

====-3dshockwave====
'''"Enable 3D Shockwaves"'''

This only has any effect when both a 2d and 3d shockwave effect are present, otherwise the only available effect is used (2d shockwave is defined by effects/shockwave01.eff or .ani, and 3d shockwave by models/shockwave.pof)

Note that 3d shockwaves are usually flat discs, that FSO scales up. The animated 2d billboards used by 2d shockwaves with the addition of [[Command-Line Reference#-soft_particles|soft particles]], may look better when intersecting with models (which shockwaves often do). Use at your discretion.

====-fxaa====
'''"Enable FXAA antialiasing"'''

Enables the FXAA postprocessing stage. Further information can be found here: http://www.hard-light.net/forums/index.php?topic=76145.0

====-nolightshafts====
'''"Disable lightshafts"'''

Disables Lightshafts even if a mission designer enables them via SEXP in a mission. This was previously documented as -flightshaftsoff but appears to have been changed to -nolightshafts for consistency before -flightshaftsoff was ever used in a released build.

====-enable_shadows====
{{table373|
'''"Enable shadows"'''

Enables shadows where supported by the OpenGL version provided by the user's GPU. -shadow_quality can be used to control the quality level.}}

===Game Speed===
====-img2dds====
'''"Compress non-compressed images"'''

Converts all images to DDS (compressed) format. Decreases memory usage but potentially reduces image quality.

====-no_vsync====
'''"Disable vertical sync"'''

====-no_fps_capping====
'''"Don't limit frames-per-second"'''

====-cache_bitmaps====
'''"Cache bitmaps between missions"'''

Will ideally reduce the load-time from one mission to another.

===HUD===
====-dualscanlines====
'''"Another Pair of Scanning Lines"'''

Adds a second pair of scanning lines to the target window when scanning an object.

====-targetinfo====
'''"Enable Info next to Target"'''

Displays target info, such as name and class, beside the targeted object.

====-orbradar====
'''"Enables 3D radar"'''

An Orb style 3D radar will replace the standard 2D version.

====-rearm_timer====
'''"Enable Rearm/Repair Completion Timer"'''

Displays time remaining until rearm and repair from a support ship is complete.

====-ballistic_gauge====
'''"Enable the analog Ballistic Ammo gauge"'''

Adds an ammo gauge to the HUD when armed with a ballistic weapon.

===Gameplay===
====-ship_choice_3d====
'''"Use Models for Ship Selection"'''

Uses ship models in ship selection window. It completely disables the standard ANI interface in this screen. 
Some mods need a compulsory use of this flag because they don't have available animations for their ships. In this situation, and if it is not used, the game will probably crash to desktop in the ship selection window.

====-weapon_choice_3d====
'''"Use Models for Weapon Selection"'''

Uses weapon models in weapon loadout window for secondary weapons (missiles and bombs). It completely disables the standard ANI interface in this screen. 
Some mods need a compulsory use of this flag because they don't have available animations for their secondary weapons. In this situation, and if it is not used, the game will probably crash to desktop in the weapon loadout window.

====-3dwarp====
'''"Enable 3D Warp"'''

Use full geometry for the subspace warp effect.

====-warp_flash====
'''"Enable Flash upon Warp"'''

Enable a flash at warp in and warp out.

====-no_ap_interrupt====
'''"Disable Interrupting of AutoPilot"'''

Tells the game to not allow players to interrupt an autopilot already-in-progress.

====-stretch_menu====
'''"Stretch interface to fill screen"'''

Scales the interface to fill the screen without preserving the aspect ratio. Omit this to keep the aspect ratio, adding black bars where appropriate.

===Audio===
====-snd_preload====
'''"Preload mission game sounds"'''

Useful in preventing game stuttering when sounds are played for the first time.

====-nosound====
'''"Disable Sound and Music"'''

====-nomusic====
'''"Disables Music"'''

===Multiplayer===
====-standalone====
'''"Run as Stand Alone Server"'''

Creates a standalone multi-player server.

====-startgame====
'''"Skip Mainhall and Start Hosting"'''

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====
'''"Start Hosted Server as 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====
'''"Host Confirms Join requests"'''

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====
{{Note| This feature is not available in current builds.}}

====-mpnoreturn====
'''"Disables Flight Deck option"'''

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

===Troubleshooting===
====-nohtl====
'''"Software Mode (very slow)"'''
{{Warning| Enabling this will significantly reduce performance.}}
Reverts to software rendering mode.

====-no_set_gamma====
'''"Disable Setting of Gamma"'''

Disables the gamma settings in the options screen.

====-nomovies====
'''"Disable Video Playback"'''

Disables all video playback.

====-noparseerrors====
'''"Disable Parsing Errors"'''

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.

====-parse_cmdline_only====
'''"Parse Command Line Only"'''

Parse only the application command line settings, and ignore any that may have been set in the on-disk data/cmdline_fso.cfg or per-user cmdline_fso.cfg (on Linux/Mac)

====-safeloading====
Loads missions the old way. Typically safer, but slower.
{{Note| This parameter was removed as of the July 5, 2011 nightly build.}}

====-query_speech====
'''"Does this build have Speech?"'''

Determines if the current build includes text-to-speech.

====-novbo====
'''"Disable OpenGL VBO"'''

====-noibx====
'''"Don't use cached index buffers (IBX)"'''

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"'''

====-disable_fbo====
'''"Disable OpenGL RenderTargets"'''

====-disable_pbo====
'''"Disable OpenGL Pixel Buffer Objects"'''

Disables the use of Pixel Buffer Objects (PBO) which may cause certain OpenGL operations to perform slower. Note PBO's were only used at three places in FSO anyway so it's *probably* not going to have a noticeable effect.

May be required to workaround issues in certain versions of Linux's Mesa drivers for Intel integrated graphics cards where crashes occur in the mainhall (i.e. whenever a popup occurs). Distros that seem to have this problem presently include Ubuntu 13.10 and openSUSE 13.1.
{{Table371|
*This feature is present to work around a bug in Linux's Mesa drivers for Intel integrated graphics cards}}

====-no_glsl====
'''"Disable GLSL (shader) Support"'''

Disables the use of GLSL rendering (OpenGL shaders). The game will revert to legacy fixed render pipeline. Please note that Normal and Height map effects will be unavailable.

====-disable_glsl_model====
'''"Don't use shaders for model rendering"'''

====-ati_swap====
'''"Fix Color issues on some ATI cards"'''

[http://scp.indiegames.us/mantis/view.php?id=1669 Mantis #1669] is what led to this flag's creation.

====-no_3d_sound====
'''"Use only 2D/stereo for sound effects"'''

====-disable_di_mouse====
'''"Disables the DirectInput mouse code for FSO on windows."'''

'''Windows Only''' Can make mouse movement smoother on certain machines.

====-mipmap====
'''"Enable mipmapping"'''

Causes for non-mipmapped textures to have mipmaps generated within the GPU on certain kind of texture formats, (IIRC, DDS formatted textures with a power of 2 size in both width and height). 
Since the use of already mipmapped DDS textures has become common, it has become deprecated.
The quality of the generated mipmaps depends on each GPU and used driver. It is normally used with [[Command-Line_Reference#-img2dds|-img2dds]] flag.

====-use_gldrawelements====
'''"Use glDrawElements instead of glDrawRangeElements"'''

Introduced as a means of switching to the slower OpenGL call glDrawElements, instead of glDrawRangeElements.
{{Table3614|
*This feature may resolve certain rendering problems where parts of models are not drawn on Linux drivers}}

====-keyboard_layout====
'''"Manually sets a keyboard layout"'''

A commandline parameter to set the keyboard layout as a string parameter.
{{Table3614|
*Currently the only valid string is "qwertz" (German) but French azerty may be added in future.}}

====-old_collision====
'''"Use old collision detection system"'''

Uses the old collision code instead of Swifty's new collision code introduced in the 'go_even_faster' project.

====-gl_finish====
'''"Fix input lag on AMD+Linux"'''
{{Table371|
This option adds a "glFinish()" call just prior to swapping buffers. It works around an issue with "recent" (HD 6000 & newer?) AMD cards using proprietary drivers on Linux. Be warned that enabling this may reduce framerate.
}}

Refer to [http://www.hard-light.net/forums/index.php?topic=88102.0 this thread] and [https://github.com/ValveSoftware/Source-1-Games/issues/765 Valve's bugtracker] for more details).

===Experimental===
====-ingame_join====
'''"Allows Ingame Joining"'''

Enables ingame joining in multiplayer. FIXME: Host option?

====-voicer====
'''"Voice Recognition"'''

Windows-only. Enables voice-recognition for wingmen commands. Must be specifically compiled into a build in order for it to be available; 3.6.10 final includes the feature. See [[Voice Recognition]] for more details.

====-fb_explosions====
'''"Enable Framebuffer Shockwaves"'''

===Development Tools===
====-fps====
'''"Show frames per second on HUD"'''

Displays current frames per second.

====-pos====
'''"Show Position of Camera"'''

Displays current position coordinates of camera.

====-window====
'''"Run in Window"'''

Runs the game in a window. No check to make sure that resolution is no higher than your desktop resolution, so be careful.

====-fullscreen_window====
'''"Run in Fullscreen Window"'''
{{Note| This feature is only available on Windows.}}

====-timerbar====
Displays a timing bar across the top of the screen. Timerbar format varies by build. This is a relic from the Volition development days, and is unmaintained.
{{Note| This parameter was removed as of the July 5, 2011 nightly build.}}

====-stats====
'''"Show Statistics"'''

Shows total and free physical memory, virtual memory and system pagefile.

====-coords====
'''"Show Coordinates"'''

Shows coordinates of the mouse cursor.

====-show_mem_usage====
'''"Show Memory Usage"'''

Shows detailed RAM usage based on file, handler and process usage and display on the left-center side of the screen during mission load and while in mission.

The meaning of the info displayed in the upper right corner of the HUD 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 does 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====
Reads all objects in the pof file of the selected mod, and creates an ibx cache file for each object in the data/cache folder for that mod. 
Details for each object are output to a pofspew.txt file created in the data folder. 
Otherwise, ibx files are created in game before each mission.

====-tablecrcs====
Is actually now (or should be) a typed reference rather than as a selection item. Takes 1 argument, usually a descriptive name.
Example usage: "-table_crcs MediaVPs" will create a table_crcs.csv file in the running mod (name can be separate of the mod selected) that allows for the validation of the tables used by that mod while on-line. The descriptive parameter given helps "allocate" that .csv file to the mod in question, and as such should closely or exactly match that mods name if possible.

====-missioncrcs====
Is actually now (or should be) a typed reference rather than as a selection item. Takes 1 argument, usually a descriptive name.
Example usage: "-mission_crcs MediaVPs" will create a mission_crcs.csv file in the running mod (name can be separate of the mod selected) that allows for the validation of the missions used by that mod while on-line. The descriptive parameter given helps "allocate" that .csv file to the mod in question, and as such should closely or exactly match that mods name if possible.

====-dis_collisions====
'''"Disable Collisions"'''

Disables all collisions.

====-dis_weapons====
'''"Disable Weapon Rendering"'''

Disables weapons rendering.

====-output_sexps====
This will make the FSO build spit out an html file that documents the supported SEXP's.

Just double click on sexps.html and it should open in your default web browser.

====-output_scripting====
This will make the FSO build spit out an html file that documents the supported scripting hooks and LUA libraries.

Just double click on scripting.html and it should open in your default web browser.

====-nograb====
Disables focus grabbing in a window.
{{Note| This feature is not available on Windows.}}

====-save_render_target====
'''"Save Render Targets to file"'''

====-debug_window====
'''"Display Debug Window"'''

Lists the fs2_open.log in (nearly)real-time generation.

====-verify_vps====
'''"Spew VP crcs to vp_crcs.txt"'''

Exports the CRC values of the VP files being loaded into a vp_crcs.txt file.

====-reparse_mainhall====
'''"Reparse mainhall.tbl when loading halls"'''

Mainhall.tbl will be reparsed every time a mainhall is loaded, as opposed to just once at game startup.

====-profile_frame_time====
'''"Profile engine subsystems"'''

Activates the frame profiling code. This presents a readout showing the current, minimum, maximum and average percentages of frametime a given section of code has taken up; this can be used to identify particular bottlenecks or measure the effectiveness of certain optimizations.

====-profile_write_file====
'''"Write profiling information to file"'''

This will write the frame times of each gameplay frame to the file 'profiling.csv' where each line is ''<framenumber>;<frametime>''. The first two frames are usually very long because the timer is set at engine startup so you might want to exclude those from your data.

====-no_unfocused_pause====
'''"Don't pause if the window isn't focused"'''

When the FSO window looses focus it will not pause the game, useful for doing non-interactive test runs.

==Other==
The following options are not available as checkboxes in the launcher. Many require parameters, which follow the flag separated by a space. The prototype for use in this case is "-option argument"

===Lighting===
These factors can dramatically alter the atmosphere of the game. [[Sample Lighting Settings|This page]] has some sample lighting settings with screenshots.

====-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.

====-no_emissive_light====
By default, all ships in FS2 have a light generated on their own, it is more or less similar to a minimal amount of -ambient_factor. This feature was implemented to help the player seeing the ships over a black background. This flag disables this feature. Use it with a low -ambient_factor value to obtain an ultra-realistic dark looking.

====-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. This is a relative value.

====-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. This is a relative value.

====-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. This is a relative value.

====-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. This is a relative value.

====-ogl_spec====
Takes a numerical argument. This value changes the basic shininess of the specular light in OpenGL. A lower value reduces the overall intensity of the light making it broader and less powerful. A higher value makes it more focused and brighter. The default value is 80, and the usable range is 0 to 128 (clamped). The original default value was 60, but it was raised to behave more D3D like.

===Graphics===
====-bloom_intensity====
Requires -post_processing ("Enable Post Processing") command.
Default value is 75. Range is 0-200.

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

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

====-res====
Allows you to specify a resolution if the desired one cannot be set in the Launcher.
For example, -res 1920x1080 would run the game in 1920 x 1080 resolution. Since it requires an argument, it needs to be entered as a custom flag when using the Launcher. The "Run at specified resolution" option the Launcher gives is essentially this, but without being able to actually specify a resolution, it doesn't work.

====-center_res====
Specifies how much of the screen area should be utilized by menus, movies, the HUD, and various other 2D graphics. Intended for use with configurations with an extremely wide field of view, such as triple-monitor setups.

By default, if the screen resolution's aspect ratio is wider than 7:2, most 2D elements utilize only the center 3/10 of the screen area. This setting allows users to override this behavior to make better use of the center monitor. (The reason for using 3/10 rather than 1/3 is that many triple-monitor setups use bezel correction, which reduces the fraction of the screen area that the center monitor displays.)

For example, if the screen resolution is 6000x1080, then -center_res 1920x1080 will keep most 2D graphics in the center 1920x1080 area. This setting is automatically scaled to fit the screen resolution, so (assuming the resolution is still 6000x1080) -center_res 1280x720 is given, then that resolution is enlarged to 1920x1080.

====-fxaa_preset====
Requires both -post_processing and -fxaa. Can be used to adjust the FXAA quality and speed, 0 is fastest, 9 is highest quality. Default setting is 6.

===Gameplay===
====-start_mission====
'''"Skip the mainhall in jump right into the specified mission"'''

Jump into the mission specified by the filename. Only in effect on the first run. This will skip load of the mainhall and its other related things altogether.

====-mod====
Specifies in which folders inside FreeSpace 2 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 behavior, 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/

This flag can be indirectly set, (and it is normally set), through Launcher MOD tab and [[mod.ini]] file.

Within the Launcher's MOD 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 it will be used to modify the -mod flag, too.

For further details, see '''[[mod.ini]]'''

'''Data precedence'''

As already said, within the different directories, the data precedence is set by the specified order in the -mod flag. The lowest priority goes to the Freespace2 installation directory.

Inside each directory, data precedence is the following:

#Individual files located in ''Current_dir/data/'' subdir structure. See [[FS2_Data_Structure|FS2 Data Structure topic]] for deeper info about the different folders and contents this structure has.
#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 that this ''Mission.fs2'' is also 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 enhanced ones adding them in a higher priority place.

'''Additional notes'''
# As derived from the 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.
# This flag is also used by [[Portal:FRED|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. A special build of wxLauncher is able to configure FRED so that the -mod doesn't have to be done manually see [http://www.hard-light.net/forums/index.php?topic=67950.msg1387911#msg1387911 the forum post] for more details.
{{Table3612|As of 3.6.12 FRED now loads cmdline_fso.cfg just like FS does so FRED will use the same settings as FS including the -mod settings}}
# 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.

{{Warning| '''Priority and Texture Formats'''

''Obsolete behavior - Until FS2_open v3.6.9.:''

FS2_Open can use several file formats in textures: [http://en.wikipedia.org/wiki/PCX PCX], [http://en.wikipedia.org/wiki/DirectDraw_Surface DDS], [http://en.wikipedia.org/wiki/JPG JPG] and [http://en.wikipedia.org/wiki/TGA TGA]. Make sure you keep the format when you update your texture. For example if you update the old ''TextureOfMyFighter.tga'', do not save it as ''TextureOfMyFighter.dds'' in a higher priority place, because there is a chance of the game loading the old one despite of all.

The reason to do this is that, loading process (including priorities) is applied firstly for a kind of textures (TGAs), then for another kind (JPGs), and so on. This behavior can lead to situation where your new, updated and higher priority placed texture is not read because the format of the older one.

''New behavior - From FS2_open v3.6.10. (including previous beta testing releases):''

The former issue has been fixed. Now texture format priority is only applied within the same location. In this ''strange'' situation it goes DDS -> TGA -> JPG -> PCX. Examples:
* ''/Freespace2/MyVp.vp>>>data/maps/MyTexture.dds'' is loaded instead of ''/Freespace2/MyVp.vp>>>data/maps/MyTexture.tga''.
* But your improved ''/Freespace2/data/maps/MyTexture.xxx'' will override them both despite of its format.
In this way, when you update any texture, you don't have to pay attention to its original format. Just place it in a higher priority place.

Nevertheless, global priority is kept between animated and static textures. Because of their management, animated textures (ANIs and EFFs) are looked for BEFORE static ones. In this way there's no way to update an animated texture with a static one (an obsolete ANI is always going to be loaded before the newer DDS version). The solution: use an updated EFF with just one frame.

}}

====-fov====
This flag allows the player to specify the ''vertical'' Field of View (FoV) angle, in radians, for the player eyepoint. The angle is measured across the full height of the viewing cone. The FoV angle is technically known as the Angle of View (AoV)

*Syntax: '''''float''''' Angle
*Valid Values: 0 to 2*Pi radians
*Default Value: 0.75 radians

{{Note|For peculiar reasons, the actual FoV/AoV used by the game will be the supplied value multiplied by 1.39626348.}}

The the FoV angle/AoV is what determines the relative zoom level of the main game camera. Smaller angles generally equal to higher zoom levels, while larger angles equal to lower zoom levels (down to the theoretical x0 magnification).

However, too small of an angle will have a squashed look on the edges of your screen, and too high of an angle will greatly stretch edges. It is recommended to change the AoV, as FS2's default AoV has some perspective distortion at the screen edges (the default AoV is too high).

A natural looking (as if you where physically in the cockpit) AoV depends on the distance the player's actual eyes are away from the screen: the further away from the screen, the smaller the AoV should be, and vice versa. "Ergonomic" distances generally yield a '''''diagonal''''' AoV of 0.523 radians (30 degrees), but you can easily find the natural AoV by the following formula:

AoV (radians) = 2 * atan( H / ( 2*D ))

where:

Height of screen = H

Distance between head/eye and the screen = D

Generally, gamers like to increase the AoV in order to increase their peripheral vision on the screen, so as to gain a better situational awareness around their craft. An AoV of 0.39 radians seems to be a good start, but feel free to experiment and use whatever AoV you are most comfortable with.

===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 standalone 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 standalone 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 standalone game.

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

====-connect====
Automatically connect to multiplayer IP:PORT.

Takes one string value, such as 192.168.0.1:

====-timeout====
Multiplayer network timeout (secs).

Takes one integer argument, the timeout value in seconds. Default is 30.

====-cap_object_update====
Caps the maximum object update the server will respond to regardless of what the client has set. If the client is set to request high object updates but the server is capped to low, then that's all the client will get.

Takes one argument integer (0 to 3) which corresponds to the object update cap (With 0 being low and 3 being LAN).

===Help===
====-help====
Instructs FSO to print out all supported parameters. Some launchers can use these options to automatically populate the available command line options, even if the version of FSO is far newer than the launcher itself. NOTE: This option only works in Linux builds...

====--help====
See [[Command-Line_Reference#-help|-help]]

====-h====
See [[Command-Line_Reference#-help|-help]]

====-?====
See [[Command-Line_Reference#-help|-help]]

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

Source Code Reference

2015-05-03T05:30:00Z

Echelon9: /* Alphabetical View */

== External Libraries ==

FreeSpace 2 relies on the following libraries which are included in the source tree:
* jansson: JSON library
* libjpeg: JPEG library
* libpng: PNG library
* lua: LUA Scripting language
* mongoose: HTTP server library
* oggvorbis: Ogg Vorbis sound library
* openal: OpenAL sound library
* zlib: ZIP compression library; necessary for libpng

For information on each library, look in the respective README files.

== FreeSpace 2 Source Code ==

The root also contains the actual FreeSpace 2 code, in the code/ directory. The FreeSpace 2 source code consists of several components, each of which is kept in a separate subdirectory. These components are listed below from different views.

=== Alphabetical View ===

* [[Source ai|ai]] (Computer AI)
* [[Source anim|anim]] (Displaying .ani animated bitmaps)
* asteroid (Handle asteroids - movement, collisions, creating smaller asteroids when larger ones are blown up etc.)
* autopilot (Handles autopilot control - where if there are no enemies, travelling a long distance etc. control is temporarily switched to the computer)
* [[Source bmpman|bmpman]] (Manage 2d graphics files, such as .bmp, .tga, .jpg etc.)
* camera (used for ingame cutscenes ???)
* cfile (File/directory management routines including .VP file handling that are OS independent e.g. handles differences between Linux & Windows)
* cmdline (Handles command line switches, such as -mipmap etc.)
* cmeasure (Handles countermeasures - flares that the player & AI can drop to disrupt missiles)
* controlconfig (Configures keyboard/mouse/joystick controls)
* cutscene (Handles cutscene viewing)
* [[Source ddsutils|ddsutils]] (Handles compressed textures for 3d graphics cards that support it)
* debris (Creates & handles flying debris from exploding ships)
* debugconsole (Handles debugging console and file)
* decals (Adds support for painting decals - small 2d textures - onto ships etc.)
* demo (Allows you to save & playback games to show as demos)
* directx (Specific includes for the Microsoft DirectX library - Windows only)
* exceptionhandler (Deals with crashes, saving stack trace, system info etc.)
* fireball (Displays & handles fireballs and warping effects)
* freespace2 (Main code - handles engine initialisation, loading resources, plus windows resources like icons & dialog boxes)
* fs2netd (Game matchmaker network client code)
* gamehelp (Displays context sensitive help text)
* gamesequence (Handles progression of events during a campaign, such as entering a mission, showing credits etc.)
* gamesnd (Handles sounds & music)
* globalincs (Basic global constants & definitions, eg. version, colours)
* [[Source graphics|graphics]] (Low-level wrapper for all 2d & 3d graphics that handles different display engines (DirectX, OpenGL etc)
* hud (Handles the HUD - all the 2d cockpit graphics that the player can see e.g. radar, ammo, escort list, squad etc)
* iff_defs (Handles the iffs in [[iff_defs.tbl]], controlling what color they show up as and what iffs they attack)
* io (Handles IO devices, such as keyboard, mouse & joystick)
* irc (Adds support for an IRC chat client)
* [[Source jpgutils|jpgutils]] (Opens, reads JPG files)
* jumpnode (Displays & handles jump nodes)
* lab (Responsible for WMCoolmon's F3 lab screen)
* lighting (Handles light sources, and their effect on ships)
* localization (Handles a global string table for translating all written text into foreign languages)
* math (Library of math routines for handling vectors, splines etc)
* menuui (Handles all the misc user interface, such as the main menu, tech room, campaign list etc)
* mission (Handles general mission actions e.g. briefing, goals, training info, in-mission messages etc)
* missionui (Handles UI for general mission actions)
* mm (Headers for older MS Multimedia library)
* model (Displays and handles ship models e.g. reading files, collision detection etc)
* nebula (Displays and handles nebulae)
* network (All multi-player code, e.g. UI, network traffic)
* object (High-level code to handle all objects eg. ships, weapons, debris, asteroids, waypoints, fireballs, shockwaves)
* observer (Responsible for the multiplayer observer mode)
* osapi (Wraps low-level Operating System calls, for different OS, eg. multi-threads, windows event loops, main app window)
* padlock (Handles cockpit views with a simulated head tracking of targets relative to the ship)
* palman (Handles bitmap palettes - different colour maps for the same 2d bitmap)
* parse (Handles scripting files, eg. python, LUA etc)
* particle (Displays and handles particles, such as smoke, fire)
* [[Source pcxutils|pcxutils]] (Handles 2d .pcx graphics files)
* physics (Handles realistic physical behaviour of objects, such as ship acceleration/deceleration, rotation etc.)
* playerman (Handles pilot files & player ship movement)
* popup (Displays & handles 2d pop-up windows, e.g. when the player dies)
* radar (Displays & handles the radar)
* [[Source render|render]] (Low-level 3d rendering code for some primitives)
* ship (Displays & handles all ship code, e.g. shields, afterburner)
* sound (Low-level sound, speech & music routines)
* species_defs (Reads species_defs.tbl to handle different behaviour for different species)
* starfield (Displays & handles background images such as starfields, nebulae etc)
* stats (Displays & handles player statistics, medals etc)
* [[Source tgautils|tgautils]] (Handles .tga 2d graphics files)
* ui (Low-level user inteface routines e.g. buttons, scrollbars)
* vcodec (Handles player voice streaming for multiplayer ???)
* weapon (Displays & handles everything to do with weapons)
* windows_stub (Low-level windows functions that are needed for Unix)

There are also some directories that are only used for generating tools (not part of the main fs2 executable):
* cfilearchiver (Creates .VP file archives)
* cfileextractor (Extracts .VP file archives)
* cryptstring (Creates encrypted strings)
* fred2 (The FReespace EDitor)
* inetfile (FTP & HTTP network handlers)
* scramble (Utility to scramble file tables for the Demo version)
* variables (???)
* wxfred2 (Cross-platform version of FRED2)

=== Layer View ===

* Infrastructure
** System
*** cfile/
*** exceptionhandler/
*** irc/
*** localization/
*** osapi/
** Math
*** math/
** Sound
*** sound/
*** vcodec/
** Windows
*** ui/
*** windows_stub/
** 2D graphics
*** [[Source anim|anim]]
*** [[Source bmpman|bmpman]]
*** [[Source ddsutils|ddsutils]]
*** [[Source jpgutils|jpgutils]]
*** [[Source pcxutils|pcxutils]]
*** [[Source tgautils|tgautils]]
*** palman/
** 3D graphics
*** decals/
*** mm/
*** directx/
*** [[Source graphics|graphics]]
*** camera/
*** [[Source render|render]]
** User Input
*** controlconfig/
*** io/
* Freespace2
** Common
*** globalincs/
*** cutscene/
*** cmdline/
*** debugconsole/
** In Space
*** [[Source ai|ai]]
*** asteroid/
*** autopilot/
*** cmeasure/
*** debris/
*** demo/
*** fireball/
*** gamehelp/
*** gamesequence/
*** gamesnd/
*** hud/
*** iff_defs/
*** jumpnode/
*** lighting/
*** nebula/
*** object/
*** observer/
*** model/
*** network/
*** particle/
*** parse/
*** popup/
*** physics/
*** radar/
*** ship/
*** species_defs/
*** starfield/
*** weapon/
** In Base
*** stats/
*** menuui/
*** mission/
*** missionui/
** Engine
*** fs2open_pxo/
*** freespace2/
*** playerman/
* FRED
** fred2/
** wxfred2/
* Tools
** cfilearchiver/
** cfileextractor/
** cryptstring/
** lab/
** scramble/
** inetfile/
** variables/

=== Category Browser ===
The subdirectories above are also categorised by function. See the Category:Source Code to browse this way.

[[Category:Source Code]]

Source Code Reference

2015-05-03T05:27:48Z

Echelon9: /* External Libraries */ Update to reflect current source code structure

== External Libraries ==

FreeSpace 2 relies on the following libraries which are included in the source tree:
* jansson: JSON library
* libjpeg: JPEG library
* libpng: PNG library
* lua: LUA Scripting language
* mongoose: HTTP server library
* oggvorbis: Ogg Vorbis sound library
* openal: OpenAL sound library
* zlib: ZIP compression library; necessary for libpng

For information on each library, look in the respective README files.

== FreeSpace 2 Source Code ==

The root also contains the actual FreeSpace 2 code, in the code/ directory. The FreeSpace 2 source code consists of several components, each of which is kept in a separate subdirectory. These components are listed below from different views.

=== Alphabetical View ===

* [[Source ai|ai]] (Computer AI)
* [[Source anim|anim]] (Displaying .ani animated bitmaps)
* asteroid (Handle asteroids - movement, collisions, creating smaller asteroids when larger ones are blown up etc.)
* autopilot (Handles autopilot control - where if there are no enemies, travelling a long distance etc. control is temporarily switched to the computer)
* [[Source bmpman|bmpman]] (Manage 2d graphics files, such as .bmp, .tga, .jpg etc.)
* camera (used for ingame cutscenes ???)
* cfile (File/directory management routines including .VP file handling that are OS independent e.g. handles differences between Linux & Windows)
* cmdline (Handles command line switches, such as -mipmap etc.)
* cmeasure (Handles countermeasures - flares that the player & AI can drop to disrupt missiles)
* controlconfig (Configures keyboard/mouse/joystick controls)
* cutscene (Handles cutscene viewing)
* [[Source ddsutils|ddsutils]] (Handles compressed textures for 3d graphics cards that support it)
* debris (Creates & handles flying debris from exploding ships)
* debugconsole (Handles debugging console and file)
* decals (Adds support for painting decals - small 2d textures - onto ships etc.)
* demo (Allows you to save & playback games to show as demos)
* directx (Specific includes for the Microsoft DirectX library - Windows only)
* exceptionhandler (Deals with crashes, saving stack trace, system info etc.)
* fireball (Displays & handles fireballs and warping effects)
* freespace2 (Main code - handles engine initialisation, loading resources, plus windows resources like icons & dialog boxes)
* fs2open_pxo (Network code)
* gamehelp (Displays context sensitive help text)
* gamesequence (Handles progression of events during a campaign, such as entering a mission, showing credits etc.)
* gamesnd (Handles sounds & music)
* globalincs (Basic global constants & definitions, eg. version, colours)
* [[Source graphics|graphics]] (Low-level wrapper for all 2d & 3d graphics that handles different display engines (DirectX, OpenGL etc)
* hud (Handles the HUD - all the 2d cockpit graphics that the player can see e.g. radar, ammo, escort list, squad etc)
* iff_defs (Handles the iffs in [[iff_defs.tbl]], controlling what color they show up as and what iffs they attack)
* io (Handles IO devices, such as keyboard, mouse & joystick)
* irc (Adds support for an IRC chat client)
* [[Source jpgutils|jpgutils]] (Opens, reads JPG files)
* jumpnode (Displays & handles jump nodes)
* lab (Responsible for WMCoolmon's F3 lab screen)
* lighting (Handles light sources, and their effect on ships)
* localization (Handles a global string table for translating all written text into foreign languages)
* math (Library of math routines for handling vectors, splines etc)
* menuui (Handles all the misc user interface, such as the main menu, tech room, campaign list etc)
* mission (Handles general mission actions e.g. briefing, goals, training info, in-mission messages etc)
* missionui (Handles UI for general mission actions)
* mm (Headers for older MS Multimedia library)
* model (Displays and handles ship models e.g. reading files, collision detection etc)
* nebula (Displays and handles nebulae)
* network (All multi-player code, e.g. UI, network traffic)
* object (High-level code to handle all objects eg. ships, weapons, debris, asteroids, waypoints, fireballs, shockwaves)
* observer (Responsible for the multiplayer observer mode)
* osapi (Wraps low-level Operating System calls, for different OS, eg. multi-threads, windows event loops, main app window)
* padlock (Handles cockpit views with a simulated head tracking of targets relative to the ship)
* palman (Handles bitmap palettes - different colour maps for the same 2d bitmap)
* parse (Handles scripting files, eg. python, LUA etc)
* particle (Displays and handles particles, such as smoke, fire)
* [[Source pcxutils|pcxutils]] (Handles 2d .pcx graphics files)
* physics (Handles realistic physical behaviour of objects, such as ship acceleration/deceleration, rotation etc.)
* playerman (Handles pilot files & player ship movement)
* popup (Displays & handles 2d pop-up windows, e.g. when the player dies)
* radar (Displays & handles the radar)
* [[Source render|render]] (Low-level 3d rendering code for some primitives)
* ship (Displays & handles all ship code, e.g. shields, afterburner)
* sound (Low-level sound, speech & music routines)
* species_defs (Reads species_defs.tbl to handle different behaviour for different species)
* starfield (Displays & handles background images such as starfields, nebulae etc)
* stats (Displays & handles player statistics, medals etc)
* [[Source tgautils|tgautils]] (Handles .tga 2d graphics files)
* ui (Low-level user inteface routines e.g. buttons, scrollbars)
* vcodec (Handles player voice streaming for multiplayer ???)
* weapon (Displays & handles everything to do with weapons)
* windows_stub (Low-level windows functions that are needed for Unix)

There are also some directories that are only used for generating tools (not part of the main fs2 executable):
* cfilearchiver (Creates .VP file archives)
* cfileextractor (Extracts .VP file archives)
* cryptstring (Creates encrypted strings)
* fred2 (The FReespace EDitor)
* inetfile (FTP & HTTP network handlers)
* scramble (Utility to scramble file tables for the Demo version)
* variables (???)
* wxfred2 (Cross-platform version of FRED2)

=== Layer View ===

* Infrastructure
** System
*** cfile/
*** exceptionhandler/
*** irc/
*** localization/
*** osapi/
** Math
*** math/
** Sound
*** sound/
*** vcodec/
** Windows
*** ui/
*** windows_stub/
** 2D graphics
*** [[Source anim|anim]]
*** [[Source bmpman|bmpman]]
*** [[Source ddsutils|ddsutils]]
*** [[Source jpgutils|jpgutils]]
*** [[Source pcxutils|pcxutils]]
*** [[Source tgautils|tgautils]]
*** palman/
** 3D graphics
*** decals/
*** mm/
*** directx/
*** [[Source graphics|graphics]]
*** camera/
*** [[Source render|render]]
** User Input
*** controlconfig/
*** io/
* Freespace2
** Common
*** globalincs/
*** cutscene/
*** cmdline/
*** debugconsole/
** In Space
*** [[Source ai|ai]]
*** asteroid/
*** autopilot/
*** cmeasure/
*** debris/
*** demo/
*** fireball/
*** gamehelp/
*** gamesequence/
*** gamesnd/
*** hud/
*** iff_defs/
*** jumpnode/
*** lighting/
*** nebula/
*** object/
*** observer/
*** model/
*** network/
*** particle/
*** parse/
*** popup/
*** physics/
*** radar/
*** ship/
*** species_defs/
*** starfield/
*** weapon/
** In Base
*** stats/
*** menuui/
*** mission/
*** missionui/
** Engine
*** fs2open_pxo/
*** freespace2/
*** playerman/
* FRED
** fred2/
** wxfred2/
* Tools
** cfilearchiver/
** cfileextractor/
** cryptstring/
** lab/
** scramble/
** inetfile/
** variables/

=== Category Browser ===
The subdirectories above are also categorised by function. See the Category:Source Code to browse this way.

[[Category:Source Code]]

OpenGL Shaders (GLSL)

2015-05-03T05:14:38Z

Echelon9: /* Known issues */ OS X 10.6 is ancient now, so remove from known issues list

==Introduction==

Starting with FS2 Open version 3.6.10, the graphics pipeline has been rewritten to make it possible to use Shaders written in [[wikipedia:GLSL|GLSL]]. These allow the use of various new graphical effects, such as parallax mapping, normal mapping, or pixel-accurate lighting.
In FSO version 3.6.12, a post-processing pipeline was added, allowing the application of screen-space effects, like bloom, or noise effects.

==Notes and system requirements==
In FSO 3.6.12, the basic requirements for the use of shaders are:
*A Shader Model 3.0 capable GPU is needed for shaders to work. So you need:
**nVidia: GeForce 6xxx or newer card.
**ATI/AMD: Radeon (X1xxx), HD 2xxx or newer card.
*A set of shader files (as distributed with the [[MediaVPs]])

As of version 3.6.13, the Shader Model requirement has been dropped to allow cards that are only capable of Shader Model 2 support to use shaders.

==Known issues==
===ATI/AMD X1xxx GPUs===
These GPUs are, in theory, SM 3.0 capable so they should run the shaders fine. BUT THEY DON'T. The game usually crashes or freezes with these GPUs.

Several SCP people are studying the issue. Speculation about its lack of Vertex Texture Fetch support has been stated as the source of the issue. But nothing has been set as the final conclusion. Here you have a [http://www.opengl.org/wiki/Vertex_Texture_Fetch link to VTF article in opengl.org wiki].

Possible solutions:
* Use -no_glsl.
* Use-at-your-own-risk hack for Windows XP 32-bit users:
** Update your Catalyst to the latest version.
** Locate 7.9 or older Catalyst version.
** Extract the installation archive but do not install it.
** Grab Atioglxx.dll from it.
** Copy Atioglxx.dll in FS2 folder. In this way your system will be updated to the last Catalyst version BUT FS2 will use an old one.
** Run the game. Expect possible bad performance.
** (If you prefer, you can look for just old Atioglxx.dll download links in HLP forums).

===ForceWare 169.xx===
These drivers are buggy and don't work fine (several graphical glitches). Why the hell are you using them? They're ancient. Update to a newer version NOW.

==Description of shaders==
* Shader files have got .sdr extension.
* They are placed in [[FS2_Data_Structure#effects|effects subfolder]] within general data structure. They work like any other game file: they can be packed in vp archives and they are fully affected by overall precedence priority.
* Starting from version 3.6.10., MediaVP package includes a full set of shaders within mv_core.vp.
* The MediaVPs shaders are so-called "unified" shaders. These are designed to perform all necessary operations in one file, where the specific behaviour for all possible usage scenarios is defined through the use of preprocessor directives. These shaders can be found in mv_root.vp, in the data/effects folder, under the names "main-f.sdr" and "main-v.sdr"

==Examples==
===Per-Fragment Lighting Shaders for FSO 3.6.13===

These shaders use the so-called per-fragment lighting model. This means that, unlike the fixed-function graphics pipeline, lighting values are computed for every pixel (or fragment) on the screen. This leads to a more accurate, smoother lighting across the lit surface. The code examples here assume a working knowledge of GLSL, consult the GLSL Tutorial linked to below for details.
Here's an example of fixed-function lighting (Also called per-vertex lighting):
[[image:Pointgl.gif]]

And the same scene with per-fragment lighting:
[[image:Pointpix.gif]]

We start off with the vertex shader, main-v.sdr.

<pre>#ifdef FLAG_ENV_MAP
uniform mat4 envMatrix;
varying vec3 envReflect;
#endif

#ifdef FLAG_NORMAL_MAP
varying mat3 tbnMatrix;
#endif

#ifdef FLAG_FOG
varying float fogDist;
#endif

varying vec4 position;
varying vec3 lNormal;

void main()
{
gl_TexCoord[0] = gl_MultiTexCoord0;
gl_Position = ftransform();
gl_FrontColor = gl_Color;
gl_FrontSecondaryColor = vec4(0.0, 0.0, 0.0, 1.0);

// Transform the normal into eye space and normalize the result.
position = gl_ModelViewMatrix * gl_Vertex;
vec3 normal = normalize(gl_NormalMatrix * gl_Normal);
lNormal = normal;

#ifdef FLAG_NORMAL_MAP
// Setup stuff for normal maps
vec3 t = normalize(gl_NormalMatrix * gl_MultiTexCoord1.xyz);
vec3 b = cross(normal, t) * gl_MultiTexCoord1.w;
tbnMatrix = mat3(t, b, normal);
#endif

#ifdef FLAG_ENV_MAP
// Environment mapping reflection vector.
envReflect = reflect(position.xyz, normal);
envReflect = vec3(envMatrix * vec4(envReflect, 0.0));
envReflect = normalize(envReflect);
#endif

#ifdef FLAG_FOG
fogDist = clamp((gl_Position.z - gl_Fog.start) * 0.75 * gl_Fog.scale, 0.0, 1.0);
#endif

#ifdef __GLSL_CG_DATA_TYPES
// Check necessary for ATI specific behavior
gl_ClipVertex = (gl_ModelViewMatrix * gl_Vertex);
#endif
}</pre>

The fragment shader, main-f.sdr:

<pre>#ifdef FLAG_LIGHT
uniform int n_lights;
#endif

#ifdef FLAG_DIFFUSE_MAP
uniform sampler2D sBasemap;
#endif

#ifdef FLAG_GLOW_MAP
uniform sampler2D sGlowmap;
#endif

#ifdef FLAG_SPEC_MAP
uniform sampler2D sSpecmap;
#endif

#ifdef FLAG_ENV_MAP
uniform samplerCube sEnvmap;
uniform bool alpha_spec;
varying vec3 envReflect;
#endif

#ifdef FLAG_NORMAL_MAP
uniform sampler2D sNormalmap;
varying mat3 tbnMatrix;
#endif

#ifdef FLAG_FOG
varying float fogDist;
#endif

varying vec4 position;
varying vec3 lNormal;

#if SHADER_MODEL == 2
#define MAX_LIGHTS 2
#else
#define MAX_LIGHTS 8
#endif

#define SPEC_INTENSITY_POINT 4.3 // Point light
#define SPEC_INTENSITY_DIRECTIONAL 1.5 // Directional light
#define SPECULAR_FACTOR 1.75
#define SPECULAR_ALPHA 0.1
#define SPEC_FACTOR_NO_SPEC_MAP 0.6
#define ENV_ALPHA_FACTOR 0.3
#define GLOW_MAP_INTENSITY 1.5
#define AMBIENT_LIGHT_BOOST 1.0

void main()
{
vec3 eyeDir = vec3(normalize(-position).xyz); // Camera is at (0,0,0) in ModelView space
vec4 lightAmbientDiffuse = vec4(0.0, 0.0, 0.0, 1.0);
vec4 lightDiffuse = vec4(0.0, 0.0, 0.0, 1.0);
vec4 lightAmbient = vec4(0.0, 0.0, 0.0, 1.0);
vec4 lightSpecular = vec4(0.0, 0.0, 0.0, 1.0);
vec2 texCoord = gl_TexCoord[0].xy;

#ifdef FLAG_LIGHT
#ifdef FLAG_NORMAL_MAP
// Normal map - convert from DXT5nm
vec3 normal;
normal.rg = (texture2D(sNormalmap, texCoord).ag * 2.0) - 1.0;
normal.b = sqrt(1.0 - dot(normal.rg, normal.rg));
normal = normalize(tbnMatrix * normal);
#else
vec3 normal = lNormal;
#endif

vec3 lightDir;
lightAmbient = gl_FrontMaterial.emission + (gl_LightModel.ambient * gl_FrontMaterial.ambient);

#pragma optionNV unroll all
for (int i = 0; i < MAX_LIGHTS; ++i) {
#if SHADER_MODEL > 2
if (i > n_lights)
break;
#endif
float specularIntensity = 1.0;
float attenuation = 1.0;

// Attenuation and light direction
#if SHADER_MODEL > 2
if (gl_LightSource[i].position.w == 1.0) {
#else
if (gl_LightSource[i].position.w == 1.0 && i != 0) {
#endif
// Positional light source
float dist = distance(gl_LightSource[i].position.xyz, position.xyz);

float spotEffect = 1.0;

#if SHADER_MODEL > 2
if (gl_LightSource[i].spotCutoff < 91.0) {
spotEffect = dot(normalize(gl_LightSource[i].spotDirection), normalize(-position.xyz));

if (spotEffect < gl_LightSource[i].spotCosCutoff) {
spotEffect = 0.0;
}
}
#endif

attenuation = spotEffect / (gl_LightSource[i].constantAttenuation + (gl_LightSource[i].linearAttenuation * dist) + (gl_LightSource[i].quadraticAttenuation * dist * dist));

lightDir = normalize(gl_LightSource[i].position.xyz - position.xyz);

specularIntensity = SPEC_INTENSITY_POINT; // Point light
} else {
// Directional light source
lightDir = normalize(gl_LightSource[i].position.xyz);

specularIntensity = SPEC_INTENSITY_DIRECTIONAL; // Directional light
}

// Ambient and Diffuse
lightAmbient += (gl_FrontLightProduct[i].ambient * attenuation);
lightDiffuse += ((gl_FrontLightProduct[i].diffuse * max(dot(normal, lightDir), 0.0)) * attenuation);

// Specular
float NdotHV = clamp(dot(normal, normalize(eyeDir + lightDir)), 0.0, 1.0);
lightSpecular += ((gl_FrontLightProduct[i].specular * pow(max(0.0, NdotHV), gl_FrontMaterial.shininess)) * attenuation) * specularIntensity;
}

lightAmbientDiffuse = lightAmbient + lightDiffuse;
#else
lightAmbientDiffuse = gl_Color;
lightSpecular = gl_SecondaryColor;
#endif

#ifdef FLAG_DIFFUSE_MAP
// Base color
vec4 baseColor = texture2D(sBasemap, texCoord);
#else
vec4 baseColor = gl_Color;
#endif

vec4 fragmentColor;
fragmentColor.rgb = baseColor.rgb * max(lightAmbientDiffuse.rgb * AMBIENT_LIGHT_BOOST, gl_LightModel.ambient.rgb - 0.425);
fragmentColor.a = baseColor.a;

#ifdef FLAG_SPEC_MAP
// Spec color
fragmentColor.rgb += lightSpecular.rgb * (texture2D(sSpecmap, texCoord).rgb * SPECULAR_FACTOR);
fragmentColor.a += (dot(lightSpecular.a, lightSpecular.a) * SPECULAR_ALPHA);
#else
fragmentColor.rgb += lightSpecular.rgb * (baseColor.rgb * SPEC_FACTOR_NO_SPEC_MAP);
#endif

#ifdef FLAG_ENV_MAP
// Env color
vec3 envIntensity = (alpha_spec) ? vec3(texture2D(sSpecmap, texCoord).a) : texture2D(sSpecmap, texCoord).rgb;
fragmentColor.a += (dot(textureCube(sEnvmap, envReflect).rgb, textureCube(sEnvmap, envReflect).rgb) * ENV_ALPHA_FACTOR);
fragmentColor.rgb += textureCube(sEnvmap, envReflect).rgb * envIntensity;
#endif

#ifdef FLAG_GLOW_MAP
// Glow color
fragmentColor.rgb += texture2D(sGlowmap, texCoord).rgb * GLOW_MAP_INTENSITY;
#endif

#ifdef FLAG_FOG
fragmentColor.rgb = mix(fragmentColor.rgb, gl_Fog.color.rgb, fogDist);
#endif

gl_FragColor = fragmentColor;
}</pre>

===Preprocessor defines===

*FLAG_LIGHT
**The shader is expected to handle lighting. This flag has one associated uniform:
**uniform int n_lights // The number of lights in the current scene, 0..8 inclusive.

*FLAG_DIFFUSE_MAP
**The shader is expected to handle the application of the basic diffuse map. This flag has one associated uniform:
**uniform sampler2D sBasemap // The diffuse texture

*FLAG_GLOW_MAP
**The shader is expected to handle the application of the glowmap. This flag has one associated uniform:
**uniform sampler2D sGlowmap // The glow texture

*FLAG_SPEC_MAP
**The shader is expected to handle the application of the specular map. This flag has one associated uniform:
**uniform sampler2D sSpecmap // The specular texture

*FLAG_ENV_MAP
**This shader is expected to handle environment mapping. There are several uniforms associated with this flag:
**uniform samplerCube sEnvmap; //The cubemap
**uniform bool alpha_spec; //Whether or not there's a specular map with an alpha channel present.
**uniform mat4 envMatrix;

*FLAG_NORMAL_MAP
**This shader is expected to handle normal mapping. One associated uniform:
**uniform sampler2D sNormalmap // The normal map

*FLAG_HEIGHT_MAP
**This shader is expected to handle parallax mapping. One associated uniform:
**uniform sampler2D sHeightmap // The height map

*FLAG_FOG
**Fogging effects are enabled (as in a nebula). No associated uniforms.
{{Table3613|
*SHADER_MODEL
**An integer, which will tell you which shader model the current hardware supports.}}

==Shader Limitations==
*Due to limitations of OpenGL, only 8 lights can be handled at once. While the Engine keeps track of up to 256 lights per scene, only the 8 strongest ones are passed to the shader.

==External links:==
http://en.wikipedia.org/wiki/Shader

http://en.wikipedia.org/wiki/GLSL

http://www.opengl.org/documentation/glsl/

===OpenGL Org's Typhoon Labs Shader Designer===

http://www.opengl.org/sdk/tools/ShaderDesigner/

===nVidia Shader applications:===

http://developer.nvidia.com/object/fx_composer_home.html

http://developer.nvidia.com/object/nv_shader_debugger_home.html

http://developer.download.nvidia.com/shaderlibrary/webpages/shader_library.html

===ATI Shader tools===

http://developer.amd.com/gpu/rendermonkey/Pages/default.aspx

http://developer.amd.com/gpu/archive/ashli/Pages/default.aspx

===Apple OpenGL tools===

http://developer.apple.com/graphicsimaging/opengl/opengl_serious.html

[[Category:Source Code Project]]

FS2 Open Lua Scripting

2015-05-03T05:07:13Z

Echelon9: Reflect source code hosting via Git

This page is intended as a crash-course in Lua scripting as it relates to Freespace 2. It's only meant to get you started with Lua scripting - more advanced concepts such as metatables will not be covered.

You don't need to read the Appendices, but I recommend at least reading the "Optimizing" section if you're doing much scripting.

'''IMPORTANT: This page was last updated on 5/27/2007 and assumes you are using the most up-to-date build at that time, [http://www.hard-light.net/forums/index.php/topic,47201.0.html C05202007]. There may be slight syntax differences with significantly newer or older builds. You should also make sure you are using a development build.'''

== What You Need ==
You will need a basic understanding of how to open and edit computer files, a copy of Freespace 2, and an open mind. Any kind of prior scripting experience will be immensely helpful, but you shouldn't need any to understand this document.

Here we go!

Note: Although all the examples should not cause syntax errors anywhere, they may not work in certain places. For example, you have to load a mission before you can get handles to ships in the mission.

== Scripting hooks ==
A scripting hook is a segment of Lua code, that is run at a specific place in FS2_Open. Some scripting hooks, such as $GameInit, are executed only once. Others, such as state hooks, are executed every frame. Others may be executed only when a specific action occurs (such as a keypress or a ship warping out).

There are three different types of hooks. All hooks are parsed and loaded into memory when they are read, so there is no speed difference. Also, the optional field "+Override: YES" can be used to make a scripting hook completely override fs2_open's usual behavior. (For example, for the HUD, this would completely disable the default fs2_open HUD and use the scripting version instead)

For the sake of organization, information on different scripting hooks can be found in the wiki page for the table that they are actually in.

=== Return hook ===
$Hook: 2 + #Mission.Ships
This works like a normal table variable, except that you can use scripting functions as well.

=== Normal hook ===
$Hook: [
gr.setColor(255, 255, 255)
gr.drawString("Hello, world!")

return 2 + #Mission.Ships
]
A normal hook is denoted by [ and ]. Whatever is within the brackets is passed to the Lua interpreter. This means that you cannot use table-style ;; comments within brackets; you must use Lua's comments.

However, you can still use it with a .tbl field that takes a value, using the "return" command. In this case, even though the other lines are still run, the $Hook: variable would be set to the same value as in the 'Return hook' example.

=== File hook ===
<pre>$Hook: [[script.lua]]</pre>
A file hook loads the scripting from the file in the data/scripts directory. In all other respects, it is the same as a normal hook.

== Comments ==
A "comment" (in any programming or scripting language) is a block of a script that is ignored. In Lua there is only one kind of comment, which starts with double-dashes. Any time you put two dashes in a Lua script outside of a string, the rest of the line will be ignored. (This is the same as putting a double-semicolon in a Freespace table)

For example, this:
--Load a mission for use in the mainhall
Mission.loadMission("sm2-10.fs2") --Use 'King's Gambit' for now.

Will do exactly the same thing as this:
Mission.loadMission("sm2-10.fs2")

== Variables ==
A variable is the simplest kind of thing that there is in Lua. All it really does is hold data; no more, no less. They really aren't that scary. Here are some different types of variables

--Number variable
life = 42

--String variable
name = "Bob"

--Boolean variables
smoking = true
healthy = false

--Userdata (Handle or object) variable
player = Mission.Ships['Alpha 1']

--Nil variable
--Erases a previously set variable
life = nil

--Member variable of userdata. Can be any of the above types.
player.Name = "Ship"

Note: Although technically objects and handles are all userdata, it's easier to just think of every object and handle as being different types of variables.

=== Arrays ===

An array is a special type of variable, that holds multiple variables. The '''''index''''' of all Lua arrays starts at 1.

--Set the fifth element of array to 1
a[5] = 12
--Set n to the fifth element (tehe)
n = a[5]
--n will be 12

The size of arrays may also be determined using the '''''#''''' sign

--Create an array
a = {2, 4, 6, 8}
--Set s to the size of the array
s = #a
--s will be 4

== Libraries ==
In order to gain access to the FS2_Open engine through scripting, you must use the FS2_Open libraries. Each library represents a different section of the engine. In addition, libraries may be referenced one of two ways: the full name, or a shorthand version of the name made up of two letters. Here, the same setColor '''''function''''' is used twice.

Graphics.setColor(255, 255, 255)
gr.setColor(255, 255, 255)

For the sake of easy reading, I've used the longhand version of names in the wiki. However, I recommend you learn the shorthand versions as they're generally faster to work with when scripting.

To get a full list of library functions, use the "-output_scripting" command line parameter. This should create a file called scripting.html, with a list of the different libraries, functions, and types supported by that build. (Use a web browser to open it)

== Functions ==
A function is an instruction to Lua to do something. It may change variables, or it may call (activate) other functions. Functions are the meat of scripting; they get everything done. Essentially, they are much like an individual SEXP.

As a result, this section is pretty tough, but covers almost all of the specific knowledge you'll need to work within Lua.

=== Function vocabulary ===
* '''''Return value''''' - Data that a function returns. Any data that a function returns may be stored in a variable.
* '''''Arguments''''' - Data that is given to a function. May be data itself, a variable containing the data, or even the return value of another function.
* '''''Call''''' - To run a function.

=== Typical function use ===
Example: This will write "Alpha 1" in the upper-left corner of the screen.
player = Mission.Ships['Alpha 1']
Graphics.setColor(255, 255, 255)
Graphics.drawString(player.Name, 5, 5)

* Line 1: In the first line, the "Ships" array of the mission library is indexed. Because 'Alpha 1' is specified, it will set either the handle to the ship named 'Alpha 1', or it will return an invalid handle if Alpha 1 is dead or there was no Alpha 1 in the mission to begin with. Because the player variable is set to the result of the Array index, it will receive whatever handle is accessed by the array. Result After the first line, the player variable is a ship handle to the ship named "Alpha 1" in the current mission.

* Line 2 In the second line, the "setColor" function is used to set the current drawing color to pure white. Unlike getShipByName, it takes at least three arguments, all numbers - the red, green, and blue scale of the current color, from 0 to 255. It's always a good idea to use the setColor function before doing any drawing in scripting, as the engine can and will change the current color between scripting hooks. Result Current drawing color is set to pure white

* Line 3 In the third line, the drawString function takes three arguments - a string, followed by two numbers. The string specifies the text to write, the numbers specify the x and y position of the upper-left corner of the written text. As you can see, we've directly used a '''''member variable''''' of the player variable to fill the first argument. Because we got the ship handle by its name, the Name variable will be the same as the name that we got it by ("Alpha 1"). Result After the third line, "Alpha 1" will appear in the upper-left corner of the string in white text.

Note: Numbers and certain types of userdata will automatically convert to strings. In all other cases, functions will give an error if you try to use the wrong type of argument.

Debugging note: If Alpha 1 were dead in the above example, you would get an error about 'trying to index a nil value' because it would not be able to run the getName() function.

=== Userdata functions ===
Handles and objects may also have functions.

Example: This will write the number of subsystem's on Alpha 1's ship in the upper-left corner.
player = Mission.Ships['Alpha 1']
Graphics.drawString(#player, 5, 5)

As before, we get the handle to the Alpha 1 ship with the Ships array.

=== Optional arguments ===

Sometimes you don't have to use an argument. For example, the setColor function has an optional fourth argument - how opaque the color should be. If the argument isn't used, the color is totally opaque. These two lines do the same thing:

Graphics.setColor(255, 255, 255)
Graphics.setColor(255, 255, 255, 255)

== Quick, a full example! ==
By this point, you may be bored of all this exposition. So here's your typical "Hello, World!" example.

For this amazing trick, we'll make our very own splash screen. Turn off all Freespace 2 mods, and create a file called "scripting.tbl" in your data/tables directory. Open that up in a text editor, and write:
#Conditional Hooks
$Version: 3.7
$On Splash Screen: [
--Set the color to white
Graphics.setColor(255, 255, 255)
--Write "Hello, world!"
Graphics.drawString("Hello, world!", 5, 10)
]
+Override: YES
#End

Now, when you start up FS2_Open, you should see "Hello, world!" in the upper-left, as it loads.

== Control structures ==
A control structure is a series of statements that let you change how a script runs, based on some condition - say, a ship is dead, or the life of a certain ship has fallen below a certain amount.

=== If statements ===
If statements are a way to check if something is some way or not. All if statements have the form:
if (something) then
(execute)
end

(something) can be true, or false. If it's true, then (execute) will be run. If it's false, then the script will skip down to "end" and go on from there.

To check that a handle is valid:
ship = Mission.Ships['Alpha 2']
if ship:isValid() then
--This will always happen while Alpha 2 is alive
Graphics.drawString("MACKIE LIVES!", 5, 10)
end

To check a variable value
x = 42
y = 23
if x < y or x is y then
--We never get here, because x is bigger than y
end

=== For statements ===
A for statement is generally used to iterate through a list.

Example:
This bit of scripting will run through all of Alpha 2's subsystems if she isn't dead, and display a list of them in the upper-left.

ship = Mission.Ships['Alpha 2']
if ship then
num_subsys = #ship
x = 5
y = 5
for i=1,num_subsys do
--Use the i variable to go through the ship's subsystems,
--and to change the y position of the text.
gr.drawString(ship[i].Name, x, y + i*10)
end
end

=== More information ===
For other keywords you can use with control structures, see the [http://www.lua.org/manual/5.0/manual.html#2.5.2 Lua Documentation]

For more detailed information on if statements and other types of control structures, see the [http://lua-users.org/wiki/ControlStructureTutorial Lua-users wiki]

== Appendices ==

There's more depth to scripting than what's covered above. To make the rest of the article shorter, I've put the topics still within the scope of this article, but not necessary to know in most cases, down here.

However, I HIGHLY recommend you read the optimizing scripting section.

=== Appendix: Optimizing scripting ===

Because fs2_open is written in C, which is much faster than Lua, it is much better to store variables in C and provide Lua functions to work with them. In addition, to keep Lua scripting from messing with C scripting and to make it as friendly as possible, there are a number of safeguards to catch problems, in most of the Lua functions.

As a result, whenever you're working with a value provided by a library or object function, you should set it to a Lua variable if you're going to use it more than 1-2 times due to the large overhead resulting from the interface.

Thus, even though it may look like "Name" is a member variable of the ship handle, it is actually a function that performs 3-4 validity checks before returning the value, which must also be converted from C to Lua. Setting a variable to the return value of the function means that you can use that variable wherever you want to use the ship name using the native Lua environment.

=== Appendix: Debugging scripting ===

Unfortunately, the Lua interpreter provides only limited debugging information about hooks. (Supposedly, it will provide more information about scripting within user functions, but I haven't tested that claim yet)

Generally, error messages complaining about referencing or indexing a 'nil value' occur because a function could not return a handle, so it returned nil. Some functions also return false to indicate that the handle is correct, but due to some kind of wrong information being passed, it couldn't complete.

Generally, you should check all handles before using them:
player = Mission.Ships['Alpha 1']
if player:isValid() then

end

With all uses of the player handle falling in the "if" statement.

=== Appendix: Function types ===

Here's all the different kinds of functions you can have:
--A function provided by itself
x = cos(y)
--A function provided by a library
x = Math.cos(y)
--A function provided by a userdata variable.
x = y:cos()
In every case, x would be set to the cosine of y, which is 1.

Note: You must use a ":" with userdata functions, as in the example. This tells Lua that it needs to give the function the value of the variable that it's being called from.

=== Appendix: Making your own functions ===
So, let's make the doSomething() function do, well, something.
doSomething = function()
color = "red"
end
As you can see, creating a function is much like creating a variable; you just use function() instead of the value, then write what you want the function to do. To end the function, you just write "end"

Now, let's use our new doSomething() function.
color = "black"
doSomething()
--After using doSomething(), color is now red

Functions can also '''''return''''' values.
--Make a new function
doSomethingElse = function()
return 10
end
x = 0
doSomething()
--x is now 27
x = doSomethingElse()
--x is now 10

=== Appendix: Variable Scope ===
The '''''scope''''' of a variable is the area where it exists. Writing <tt>local</tt> in front of the variable name will tell Lua that the variable should only exist within that function or hook.

Note that this means that if you use the same variable name in two different hooks without using local, the same variable will be used.

Note:

You may find it useful to have some way of distinguishing global variables from local ones, to remind yourself that the value does carry over. For example, starting global variable names with "g_".

Example: The following will draw the text "Media VP" in the upper-left corner of the main hall, even though the variable is set in a different hook than it is used in.

#Conditional Hooks
$Version: 3.7
$On Game Init: [g_mod = "Media VP"]

$State: GS_STATE_MAIN_MENU
$On Frame: [Graphics.drawString(g_mod, 0, 0)]
#End

=== Appendix: Variable Types ===
Variables can hold different types of data. These basic types are:

==== Boolean ====
A boolean is a simple variable - it can be true, or false.
--It's Monday, and Dilbert is at the office
working = true
--Oops, he just opened Solitaire
working = false

==== Numbers ====
A number is any variable that holds (As you might've guessed) a number. A number will automatically convert into a string, if needed.
--A variable can be a whole number, like this
x = 5
--Or it can be a decimal value
x = 3.141592654
--Or you can divide two numbers for a fraction
x = 3/4

==== Strings ====
A string is a variable that holds a series of characters, and a character is any number, letter, or symbol on your keyboard (and then some). Basically, strings are the way that words and sentences are passed around in Lua.
--A cow says moo!
cow = "moo"
--A friend's name
friend = "Bob"
Note that actual string content is contained within double quotation marks, to mark it as a string.

==== nil ====
nil isn't really a variable type, but it is important. nil means that a variable doesn't hold anything. If you want to get rid of a variable, you just set it to be nil.

--Today I got a new dog
dog = "Spot"
--But then he ran away
dog = nil

Any time an error says that a variable is nil, it usually means that it doesn't exist (Double-check your spelling).

==== Userdata/objects ====
Objects (or "userdata", as they are known in Lua) is a variable that can contain other variables, or functions. Variables or functions within an object are known as "member variables" or "member functions".

--Assuming we have a my_car object, this will copy it to your_car
your_car = my_car
--Congratulations! But maybe you want to customize it?
--Note how I refer to the member variable, color
your_car.color = "Red"

==== Handles ====
A handle isn't technically a Lua type, but handles are used a lot in FS2_Open Lua scripting. Essentially, a handle is a variable that refers to a specific object; but doesn't actually contain that object's data. An example is the "shipclass" type; it doesn't actually contain the data in ships.tbl, it just serves to reference the ship class so that you can get and set data.
--Get the "GTF Ulysses" ship type
--For this, I use the ShipClasses array
ulysses = tb.ShipClasses['GTF Ulysses']
--Now get rid of the handle
ulysses = nil
--Even though we've gotten rid of the handle, the Ulysses will still exist.

In situations where a handle variable is an object, you must set the entire variable at once; you cannot change elements of the array individually.
--So intead of this...
ship = mn.Ships[1]
ship.Position["y"] = 0

--You would go...
ship = mn.Ships[1]
pos = ship.Position["y"]
pos["y"] = 0
ship.Position = pos

=== Appendix: External Lua references ===
* [http://www.devmaster.net/articles/lua/lua1.php DevMaster.net - Lua Scripting 101]
* [http://www.lua.org/manual/5.1/ Official Lua 5.1 Reference Manual]
* [http://www.lua.org/pil/ Programming in Lua]
* [http://www.lua-users.org/ lua-users.org]

[[Category:Source Code Project]]

FS2 Open on Solaris

2015-05-03T05:01:33Z

Echelon9: Reflect source code hosting via Git

== Grab a copy of Solaris ==

Download the Oracle Solaris 11.2 x86 VirtualBox Appliance, update the guest additions, or install Solaris 11.2 for x86 on a desktop PC.

== Install needed dependencies ==
<ul>
<li>developer/gcc (currently installs 4.8.2)</li>
<li>Make sure the matching gcc runtime is installed</li>
<li>developer/build/autoconf (currently 2.68)</li>
<li>developer/build/automake (currently 1.11.2)</li>
<li>developer/build/gnu-make (Appliance already has this)</li>
<li>developer/build/libtool (currently 2.4.2)</li>
<li>library/readline (Appliance already has this)</li>
<li>runtime/lua (Appliance already has this)</li>
<li>developer/versioning/git</li>
<li>library/sdl (currently 1.2.14)</li>
<li>developer/versioning/git (currently 1.7.9.2)</li>
<li>developer/build/cmake (currently 2.8.6)</li>
</ul>

On OpenSXCE (OpenIndiana based distro for Sparc) I had to install CSWautoconf (included 2.63 is too old), CSWpkgconfig (very important to fix parse error in configure script), and uninstalled the original autoconf program. I still had to install OpenAL and Jansson, but OpenAL Soft had to be version 1.11.753 because no newer version would compile due to some opcode errors, and newer versions from git would not configure due to a pthread.h issue which doesn't seem to occur in the last release version or prior. Also, that openal soft's "gmake install" command ignored the cmake install prefix, so I had to install it by manually copying files to their destinations. The latest official Solaris from Oracle doesn't seem to have that problem with the newest versions of OpenAL Soft in git. OpenSXCE did not need a newer gcc though.

== Install OpenAL ==
This is why git and cmake were installed while you had the package manager open. Download OpenAL Soft 1.15.1 (1.16 and latest git currently fail with a PThreads error) from http://kcat.strangesoft.net/openal-releases/, follow the build instructions on http://kcat.strangesoft.net/openal.html, except use the following command instead of 'cmake ..': 
cmake -DCMAKE_INSTALL_PREFIX=/usr ..

== Install Jansson ==
[http://www.digip.org/jansson/ Jansson] is the JSON library for C that is needed for the new WebUI dedicated server code. There is currently no Solaris package, so you will have to compile this from source. The latest version I can get working out of the box on Solaris 11.2 is from their Git repo, as 2.6 will not compile with a complaint about the isnan macro. Clone the source repo to a new directory and cd into that directory, then:
<ul>
<li>cmake -DCMAKE_INSTALL_PREFIX=/usr ..</li>
<li>gmake</li>
<li>gmake check</li>
<li>sudo gmake install</li>
</ul>
That will give you an installation of Jansson which pkg-config can find with no other environment editing required. Keep the jansson git folder around if you think you might want to run 'sudo gmake uninstall' at some point down the line, like if jansson ever gets into the package manager, or you want to upgrade.

== Install OpenCSW packages ==
Installing these packages will fix the linking errors with libjpeg and libGL. bzflag bring mesa, libglew, and probably some other stuff that's needed and it was easier to get it all in one go. Yes, Solaris will indicate that jpeg, mesa, etc are already installed, but they don't link correctly for some reason. Installing the CSW versions fixes that.
<ul>
<li>sudo pkgadd -d http://get.opencsw.org/now</li>
<li>sudo pkgutil -U</li>
<li>sudo pkgutil -y -i CSWlibjpeg-dev</li>
<li>sudo pkgutil -y -i CSWbzflag</li>
<li>sudo ln -s /opt/csw/lib/libjpeg.so.7 /usr/lib/ (might be needed to fix issue with finding libjpeg after these packages are installed)</li>
</ul>

== Compile FS2 ==
<ul>
<li>git clone https://github.com/scp-fs2open/fs2open.github.com.git fs2_open</li>
<li>cd fs2_open</li>
<li>./autogen.sh</li>
<li>gmake</li>
<li>cp code/fs2_open_* ../</li>
</ul>

== References ==
[http://rsaxvc.net/blog/2010/9/30/Building%20FS2_Open%20on%20OpenSolaris.html Building FS2_Open on OpenSolaris] 
[http://rsaxvc.net/blog/2010/9/19/Building%20OpenAL%20on%20Solaris.html Building OpenAL on Solaris]

Getting the FreeSpace2: SCP Source Code

2015-05-03T04:59:59Z

Echelon9: Typo

{{Note| In April 2015, the SCP team transitioned the source code repository from SVN-based to GitHub-based (Git).}}

==Windows==

{{Warning| The Windows section has yet to be updated for the transition to GitHub.}}

''Ported from karajorma's [http://www.hard-light.net/forums/index.php/topic,52845.0.html thread] on the [http://www.hard-light.net/forums/index.php HLP Forums].''

Here's how you set things up:

*Go to the [http://tortoisesvn..or/ Tortoise SVN homepage] and download the latest version.
*Install it. You'll probably have to restart your PC afterwards.
*Make a new folder on your HD where you'd like to install the code. You'll need a fair bit of space for the code + the intermediate files when building it. Press right mouse and choose SVN Checkout from the list.
[[Image:CheckingOutSVN1.jpg]]
*An new window will open up. Cut and paste this into the URL of repository box: '''svn://svn.icculus.org/fs2open/trunk/fs2_open'''
*By default the HEAD revision will be selected. You probably don't want to change this. Your screen should now look like this:
[[Image:CheckingOutSVN2.jpg]]
*Press OK to begin downloading from the repository.

It's pretty easy. It shouldn't take you more than a minute or two to do once you've installed Tortoise.

== Mac ==

Please see the [[Mac_Development_Guide#Getting_the_Freespace_2_Open_SCP_source_code|Mac Development Guide]].

== Unixes ==

Please see the [[Guide_to_FS_Open_on_Linux|Linux Development Guide]].

[[Category:Source Code Project]]

Release Build Process

2015-05-03T04:59:48Z

Echelon9: Reflect source code hosting via Git

{{Note| In April 2015, the SCP team transitioned the source code repository from SVN-based to GitHub-based (Git).}}
{{Warning| This page has yet to be updated for the transition to GitHub.}}

<nowiki>1) (One time) Create branch for new release. This is an entirely remote op and can be done from anywhere, by anyone with write access.

svn copy [-r REV] svn://svn.icculus.org/fs2open/trunk/fs2_open svn://svn.icculus.org/fs2open/branches/fs2_open_<VERSION> -m "Copy trunk r<REV> to <VERSION> branch."
# REV is only needed after copy if not just copying the latest HEAD revision in trunk.

2) (Once per platform) Checkout the branch.

cd <CODE DIRECTORY>
svn co svn://svn.icculus.org/fs2open/branches/fs2_open_<VERSION> fs2_open_<VERSION>_svn

3) (Once per release) Commit a output filename/versioning commit.

https://svn.icculus.org/fs2open?view=rev&revision=9638 should be a complete diff of everything that should be modified.

Since the pilot code, this has been simplified a bit as far as project files are concerned.
Windows project version strings are a bit different (more consistent, fewer). Most consist of replacing 2_open_<PREV_VERSION> with 2_open_<NEXT_VERSION>.
A search and replace through all the necessary files will cover most of the build output filenames for the Windows project files. For instance:
s/2_open_3_6_19/2_open_3_7_0_RC1
That will cover all instances of fred2_open_3_6_19[-DEBUG], fs2_open_3_6_19[-DEBUG], and wxfred2_open_3_6_19[-DEBUG].
For enabling text-to-speech and voice recognition in MSVC_2008, open the Fred2.vcproj, Freespace2.vcproj, and code.vcproj. In all three, you need to:
s/_SECURE_SCL=0;_HAS_ITERATOR_DEBUGGING=0;"/_SECURE_SCL=0;_HAS_ITERATOR_DEBUGGING=0;FS2_SPEECH;FS2_VOICER;"
There should be 18 replacements total, 6 per file. In Freespace2.vcproj, you must also:
s/_VC08;/_VC08;FS2_VOICER;
There should be six of those.
For the Xcode projects, the InfoPlist.strings files are binary, but editable in most decent editors and should be obvious what needs to be changed.
The project.pbxproj files just need the CURRENT_PROJECT_VERSION fields updated from, for example, 3.6.19-trunk to 3.7.0-RC1, etc.
BE SURE TO GET THE CODEBLOCKS Freespace2 project file. It was somehow still missed in the 9638 commit.

4) (Following instructions are once per release per platform) Export at the desired revision from the branch checkout.

cd <CODE DIRECTORY>
svn up fs2_open_<VERSION>_svn
svn export fs2_open_<VERSION>_svn fs2_open_<VERSION>[_RCx]
# (Linux only)
tar -cvzf fs2_open_<VERSION>[_RCx]_src.tgz fs2_open_<VERSION>[_RCx]
md5sum fs2_open_<VERSION>[_RCx]_src.tgz > fs2_open_<VERSION>[_RCx]_src.md5
# Upload source export and md5 to builds folder.

5) Follow the specific platform's build method.

Windows: Currently use MSVC 2008.
Open the .sln, and batch build all configs (Release and Debug Standard, SSE, SSE2) for Freespace2 and Fred2.
-or-
"C:\Program Files (x86)\Microsoft Visual Studio 9.0\VC\vcpackages\vcbuild" /nocolor /nologo /rebuild Freespace2.sln "Release|Win32" && \
"C:\Program Files (x86)\Microsoft Visual Studio 9.0\VC\vcpackages\vcbuild" /nocolor /nologo /rebuild Freespace2.sln "Debug|Win32" && \
"C:\Program Files (x86)\Microsoft Visual Studio 9.0\VC\vcpackages\vcbuild" /nocolor /nologo /rebuild Freespace2.sln "Release SSE|Win32" && \
"C:\Program Files (x86)\Microsoft Visual Studio 9.0\VC\vcpackages\vcbuild" /nocolor /nologo /rebuild Freespace2.sln "Debug SSE|Win32" && \
"C:\Program Files (x86)\Microsoft Visual Studio 9.0\VC\vcpackages\vcbuild" /nocolor /nologo /rebuild Freespace2.sln "Release SSE2|Win32" && \
"C:\Program Files (x86)\Microsoft Visual Studio 9.0\VC\vcpackages\vcbuild" /nocolor /nologo /rebuild Freespace2.sln "Debug SSE2|Win32"
Copy the 2 release exes into the respective debug folder, and archive the 4 exes, the 2 map files, and the 2 pdb files using standard zip compression.
You should end up with three files: fs2_open_<VERSION>[_RCx].zip (SSE2), fs2_open_<VERSION>[_RCx]_SSE.zip, and fs2_open_<VERSION>[_RCx]_NO-SSE.zip.
MD5 the three zip files into fs2_open_<VERSION>[_RCx].md5.
Upload these 4 files to the mirrors under builds/WIN.

OSX: Currently use Xcode 5.1.1.
cd <CODE DIRECTORY>/fs2_open_<VERSION>[_RCx]/projects/Xcode
tar -xvzf Frameworks.tgz
/<xcodebuild_path>/xcodebuild -configuration Release && /<xcodebuild_path>/xcodebuild -configuration Debug
# Copy .apps from build/Debug and build/Release to a folder names FS2_Open <VERSION>[ RCx].
mkdir ~/Desktop/FS2_Open\ <VERSION>[ RCx]
cp -rf build/Release/FS2_Open.app ~/Desktop/FS2_Open\ <VERSION>[\ RCx]/FS2_Open\ <VERSION>[\ RCx].app
cp -rf build/Debug/FS2_Open\ $debug$.app ~/Desktop/FS2_Open\ <VERSION>[\ RCx]/FS2_Open\ <VERSION>[\ RCx]\ $debug$.app
# Use hdiutil to create an archive named FS2_Open-<VERSION>[_RCx].dmg.
hdiutil create -srcfolder ~/Desktop/FS2_Open\ <VERSION>[\ RCx] ~/Desktop/FS2_Open-<VERSION>[_RCx].dmg
# MD5 the .dmg file into FS2_Open-<VERSION>[_RCx].md5.
md5 ~/Desktop/FS2_Open*.dmg > ~/Desktop/FS2_Open-<VERSION>[_RCx].md5
# Upload these 2 files to the mirrors under builds/OSX.

Linux/FreeBSD: Use whichever latest GCC/Clang is available and working.
cd <CODE DIRECTORY/fs2_open_<VERSION>[_RCx]
./autogen.sh --enable-debug && make && cp code/fs2_open_<VERSION>[_RCx]_DEBUG ../ && make clean && make distclean && ./autogen.sh && make && cp code/fs2_open_<VERSION>[_RCx] ../
# Archive the fs2_open_<VERSION>* binary files into one fs2_open_<VERSION>[_RCx].tar.bz2 file.
cd
tar -cvjf fs2_open_<VERSION>[_RCx].tar.bz2 fs2_open_<VERSION>[_RCx]_DEBUG fs2_open_<VERSION>[_RCx]
# MD5 the bz2 file into fs2_open_<VERSION>[_RCx].md5.
md5sum fs2_open_<VERSION>[_RCx].tar.bz2 > fs2_open_<VERSION>[_RCx].md5
# Upload these 2 files to the mirrors under builds/LINUX or builds/FREEBSD, accordingly.

6) Update Mantis versions.

If making a final release, be sure to make a released version for the next trunk version.
Also for finals, bump any remaining Fix For <VERSION> to the next release version.

7) Make the main forum release post. Use previous release post as template, update all filename links, MD5s, Known Issues, and changelog. Sticky it. Unsticky previous RC posts if there was one. Irrelephant previous RC posts. Unsticky previous final release post if new final release post.

8) Update SCP website with news post, and links for a final release.

9) Make other forum and news posts as necessary (Announcements, ModDB for final releases possibly, etc).

10) Update FSO Installer source files to serve up the new release. Use the checksum files uploaded by the release script to make this easy.

Steps 1-5, and 7 are now encompassed by release.pl found at https://svn.icculus.org/fs2open/trunk/nightly-build/ folder. This greatly speeds up the release process. The script is generally run with the following options on each platform, and in this order:

Mac (RC1 only): ./release.pl --lastversion <OLDVERSION> --nextversion <NEWVERSION> --nextsubversion RC1 --lastreleaserevision 000000 --createbranch
Mac: ./release.pl --lastversion <NEWVERSION> --lastsubversion RCx --nextversion <NEWVERSION [--nextsubversion RCx] --lastreleaserevision <OLDREVISION>
Linux: ./release.pl --nextversion <NEWVERSION> [--nextsubversion RCx] --doarchive
FreeBSD: ./release.pl --nextversion <NEWVERSION> [--nextsubversion RCx]
Windows: perl release.pl --nextversion <NEWVERSION> [--nextsubversion RCx] --message "Release message here, its existence will lead to the forum post."
If the Windows one gives trouble with arguments, read http://www.perlmonks.org/?node_id=1054513 for help.</nowiki>

Hud gauges.tbl

2015-05-03T04:57:32Z

Echelon9: /* +ETS Retail: */ Clean up in-text SVN reference.

{{SCP table}}

{{TableVersion|10210}}

The '''hud_gauges.tbl''' is used for modifying the elements of the HUD. Not all gauges can be modified. However, custom gauges may be added to mimic their behavior (such as the wingman status display).

HUD Elements in FS2 are called Gauges, and each gauge has various options to customize appearance and, in some cases, their behavior as well.

This table is one of the [[Modular Tables]] and can be extended with xxx-hdg.tbm

[[Tables|List of Tables]]

==HUD Configurations==
The following entries are used on the HUD system, but have not been grouped with any particular gauge.

===$Load Retail Configuration:===
Optional. If yes, any gauge missing from the HUD gauge definitions below will be loaded using the retail defaults.

If no, any missing (default) gauge will prompt an error.

*Syntax: '''Boolean'''

===$Color:===
Optional. Sets the default HUD color for all gauges.

*Syntax: ('''Integer''' Red, '''Integer''' Green, '''Integer''' Blue)
*Valid Values: all values from 0 to 255

===$Font:===
Optional. Sets the font type to use for the HUD.

*Syntax: '''Integer''' font index number
*Valid Values: Any font index as defined in [[Fonts.tbl]]

===$Max Directives:===
Optional. Sets the default maximum number of directives displayed simultaneously.

*Syntax: '''Integer''' maximum number of directives
*Valid Values: Any positive number
*Default Value: '''5'''

===$Max Escort Ships:===
Optional. Sets the default maximum number of escort ships to be shown in the escort list.

*Syntax: '''Integer'''
*Valid Values: Any positive number
{{Warning|
Entries more than 16 will cause the list to overflow into the weapons list for resolutions lower than 1024x768.}}

===$Length Unit Multiplier:===
Optional. Sets the multiplier to applied to the reported distances. For example, if the multiplier is 0.5, then the distance reported to the player will (or at least should) be 0.5 x actual distance.

*Syntax: '''Float'''
*Valid Values: Any positive number

===$Speed Unit Multiplier:===
Optional. Analogous to [[Hud_gauges.tbl#$Length Unit Multiplier:|$Length Unit Multiplier]], this sets the multiplier to be applied to all speeds reported to the player. For example, if the multiplier is 0.5, the the speed reported to the player will (or at least should) be 0.5 x actual speed.

*Syntax: '''Float'''
*Valid Values: Any positive number
*Default Values:
:'''The value used in $Length Unit Multiplier''', or
:'''1''', if $Length Unit Multiplier is undefined

===$Wireframe Targetbox:===
Optional. Defines the default draw method for the target viewer (a.k.a. targetbox).

*Syntax: '''Integer''' Draw method ID
*Valid Values:
::'''0''' - Standard with full, bright lighting
::'''1''' - Wireframe
::'''2''' - Standard with proper lighting (i.e. lit the same as the actual target)
{{Table3615|
::'''3''' - Untextured with full bright lighting (i.e. drawn with a single flat color)}}

===$Targetbox Shader Effect:===
{{Table3615|
Optional. If set, defines a unique ID for a shader effect to be used when rendering a ship for the targeting box. The ID will be passed to the main shader as in [[Post_processing.tbl##Ship_Effects|#Ship_Effects]], but a table entry for the effect is not needed.

*Syntax: '''Integer'''
*Valid Values: Any positive number
}}

===$Lock Wireframe Mode:===
Optional. If set, prevents targetbox draw method from being changed during the gaming session.
*Syntax: '''Boolean'''

===$Scale Gauges:===
{{Table371|
Optional. If set, all gauges will use this value as the default for scaling individual gauge sizes (i.e. doesn't affect gauges that use Position:, and doesn't affect the values of Offset:. In addition, if "$Load Retail Configuration:" is true then all unspecified retail gauges will use this value.

If not set, defaults to yes.

*Syntax: '''Boolean'''
}}

===$Reticle Style:===
Optional. Defines which aiming reticle to use.
*Syntax: '''String'''
*Valid Values:
:'''FS1''' - uses '''''reticle1_fs1.ani'''''
:'''FS2''' - uses '''''reticle1.ani'''''

==#Gauge Config==
The following entries define default gauge appearance and behavior. Each gauge has the option of overriding these options.

===$Ship:===
Deprecated and superceded by $Ships in FSO revision 9208. If defined, the following config data will only be used if the player ship is of the supplied ship class. Can be defined multiple times within a #Gauge config group to allow unique HUD configurations per ship class.

If not defined, all following config data will be applied to all ships.

*Syntax: '''String''', ship class name

===$Ships:===
Optional. Can be used to define a list of ships the hud definition that follows will be applied to. Can be defined multiple times within a #Gauge config group to allow unique HUD configurations per ship class.

If not defined, all following config data will be applied to all ships.

*`Syntax: '''( "Class name 1" "Class name 2" )''', ship class names formatted like a flag list.

====$Load Retail Configuration:====
Optional. Overrides the [[Hud_gauges.tbl#$Load Retail Configuration: 1|$Load Retail Configuration]] global option for this ship class.

*Syntax: '''Boolean'''

====$Color:====
Optional. Overrides the [[Hud_gauges.tbl#$Color: 1|$Color]] global option for this ship class.

*Syntax: See [[Hud_gauges.tbl#$Color: 1|$Color]]

====$Font:====
Optional. Overrides the [[Hud_gauges.tbl#$Font: 1|$Font]] global option for this ship class.

*Syntax: See [[Hud_gauges.tbl#$Font: 1|$Font]]

===$Base:===
Required. Defines the base resolution for this HUD configuration, upon which other gauge options (such as [[Hud_gauges.tbl#Position:|Position:]] / [[Hud_gauges.tbl#Origin:|Origin:]] / [[Hud_gauges.tbl#Offset:|Offset:]]) will use as its coordinate system.

*Syntax: ('''Integer''' width, '''Integer''' height)
*Valid Values: All supported resolutions (?)

===$Scale Gauges:===
{{Table371|
Optional. If set, will configure gauges Scaling behaviour for gauges in this #Gauge Config section. i.e. overriding the default, or the value specified at the top of the file. Individual gauges can override this setting.

*Syntax: '''Boolean'''
}}

===$Required Aspect:===
Optional. If set, this configuration will only be loaded for the specified aspect ratios.

Used as a filter when there are multiple $Base: resolutions in the table

*Syntax: '''String'''
*Valid Values:
:"Full Screen" (4:3, aspect ratio < 1.5)
:"Wide Screen" (16:9, 16:10, or similar, aspect ratio >= 1.5)

===$Min:===
Optional. Minimum resolution for this config. Any resolution lower than specified will not use this configuration.

Used as a filter when there are multiple $Base: resolutions in the table

*Syntax: ('''Integer''' width, '''Integer''' height)
*Valid Values: All supported resolutions (?)

===$Max:===
Optional. Maximum resolution for this config. Any resolution higher than specified will not use this configuration.

Used as a filter when there are multiple $Base: resolutions in the table

*Syntax: ('''Integer''' width, '''Integer''' height)
*Valid Values: All supported resolutions (?)

===$Gauges:===
Following entries define gauge-specific behavior. For the most part, each gauge has its own overrides that, if not defined, would otherwise use the global values.

Since many gauges have the same configuration options, each gauge entry has a list of valid sub-entries. Unless stated otherwise, these options must be defined in the same order as they are shown, starting from the top and ending at the bottom.

====+Custom:====
Adds a custom gauge type.

*Valid Sub-Entries:
:[[Hud_gauges.tbl#Position:|Position:]]
{{table371|
:[[Hud_gauges.tbl#Scale Gauge:|Scale Gauge:]] (Optional)
:[[Hud_gauges.tbl#Origin:|Origin:]] (Optional, incompatible with [[Hud_gauges.tbl#Position:|Position:]], requires [[Hud_gauges.tbl#Offset:|Offset:]])
:[[Hud_gauges.tbl#Offset:|Offset:]] (Optional, incompatible with [[Hud_gauges.tbl#Position:|Position:]], requires [[Hud_gauges.tbl#Origin:|Origin:]])
}}
{{table3615|
:[[Hud_gauges.tbl#Cockpit Target:|Cockpit Target:]] (Optional)
::[[Hud_gauges.tbl#Canvas Size:|Canvas Size:]] (Optional)
::[[Hud_gauges.tbl#Display Offset:|Display Offset:]] (Optional)
::[[Hud_gauges.tbl#Display Size:|Display Size:]]}}
:[[Hud_gauges.tbl#Color:|Color:]] (Optional)
:[[Hud_gauges.tbl#Font:|Font:]] (Optional)
:[[Hud_gauges.tbl#Name:|Name:]]
:[[Hud_gauges.tbl#Text:|Text:]]
:[[Hud_gauges.tbl#X Offset:|X Offset:]] (Optional)
:[[Hud_gauges.tbl#Y Offset:|Y Offset:]] (Optional)
:[[Hud_gauges.tbl#Gauge Type:|Gauge Type:]]
:[[Hud_gauges.tbl#Slew:|Slew:]] (Optional)
:[[Hud_gauges.tbl#Active by default:|Active by default:]] (Optional)
:[[Hud_gauges.tbl#Filename:|Filename:]]

====+Messages:====
Adds a gauge that display mission messages.

*Valid Sub-Entries:
:[[Hud_gauges.tbl#Position:|Position]]
{{table371|
:[[Hud_gauges.tbl#Scale Gauge:|Scale Gauge:]] (Optional)
:[[Hud_gauges.tbl#Origin:|Origin:]] (Optional, incompatible with [[Hud_gauges.tbl#Position:|Position:]], requires [[Hud_gauges.tbl#Offset:|Offset:]])
:[[Hud_gauges.tbl#Offset:|Offset:]] (Optional, incompatible with [[Hud_gauges.tbl#Position:|Position:]], requires [[Hud_gauges.tbl#Origin:|Origin:]])
}}
{{table3615|
:[[Hud_gauges.tbl#Cockpit Target:|Cockpit Target:]] (Optional)
::[[Hud_gauges.tbl#Canvas Size:|Canvas Size:]] (Optional)
::[[Hud_gauges.tbl#Display Offset:|Display Offset:]] (Optional)
::[[Hud_gauges.tbl#Display Size:|Display Size:]]
}}
:[[Hud_gauges.tbl#Color:|Color:]] (Optional)
:[[Hud_gauges.tbl#Font:|Font:]] (Optional)
:[[Hud_gauges.tbl#Slew:|Slew:]] (Optional)
:[[Hud_gauges.tbl#Max Lines:|Max Lines:]] (Optional)
:[[Hud_gauges.tbl#Max Width:|Max Width:]] (Optional)
:[[Hud_gauges.tbl#Line Height:|Line Height]] (Optional)
:[[Hud_gauges.tbl#Total Lifetime:|Total Lifetime:]] (Optional)
:[[Hud_gauges.tbl#Scroll Time:|Scroll Time]] (Optional)
:[[Hud_gauges.tbl#Step Size:|Step Size:]] (Optional)
:[[Hud_gauges.tbl#Hidden By Comms Menu:|Hidden By Comms Menu:]] (Optional)

====+Training Messages:====
Adds a text box, like the ones seen in the FS1 and FS2 training missions.

*Valid Sub-Entries:
:[[Hud_gauges.tbl#Position:|Position]]
{{table371|
:[[Hud_gauges.tbl#Scale Gauge:|Scale Gauge:]] (Optional)
:[[Hud_gauges.tbl#Origin:|Origin:]] (Optional, incompatible with [[Hud_gauges.tbl#Position:|Position:]], requires [[Hud_gauges.tbl#Offset:|Offset:]])
:[[Hud_gauges.tbl#Offset:|Offset:]] (Optional, incompatible with [[Hud_gauges.tbl#Position:|Position:]], requires [[Hud_gauges.tbl#Origin:|Origin:]])
}}
{{table3615|
:[[Hud_gauges.tbl#Cockpit Target:|Cockpit Target:]] (Optional)
::[[Hud_gauges.tbl#Canvas Size:|Canvas Size:]] (Optional)
::[[Hud_gauges.tbl#Display Offset:|Display Offset:]] (Optional)
::[[Hud_gauges.tbl#Display Size:|Display Size:]]
}}
:[[Hud_gauges.tbl#Font:|Font:]] (Optional)

====+Support:====
Adds a text box that shows the Support ship's status and ETA

*Valid Sub-Entries:
:[[Hud_gauges.tbl#Position:|Position]]
{{table371|
:[[Hud_gauges.tbl#Scale Gauge:|Scale Gauge:]] (Optional)
:[[Hud_gauges.tbl#Origin:|Origin:]] (Optional, incompatible with [[Hud_gauges.tbl#Position:|Position:]], requires [[Hud_gauges.tbl#Offset:|Offset:]])
:[[Hud_gauges.tbl#Offset:|Offset:]] (Optional, incompatible with [[Hud_gauges.tbl#Position:|Position:]], requires [[Hud_gauges.tbl#Origin:|Origin:]])
}}
{{table3615|
:[[Hud_gauges.tbl#Cockpit Target:|Cockpit Target:]] (Optional)
::[[Hud_gauges.tbl#Canvas Size:|Canvas Size:]] (Optional)
::[[Hud_gauges.tbl#Display Offset:|Display Offset:]] (Optional)
::[[Hud_gauges.tbl#Display Size:|Display Size:]]
}}
:[[Hud_gauges.tbl#Color:|Color:]] (Optional)
:[[Hud_gauges.tbl#Font:|Font:]] (Optional)
:[[Hud_gauges.tbl#Slew:|Slew:]] (Optional)
:[[Hud_gauges.tbl#Filename:|Filename:]]
:[[Hud_gauges.tbl#Header Offsets:|Header Offsets:]] (Optional)
:[[Hud_gauges.tbl#Text Y-offset:|Text Y-offset:]] (Optional)
:[[Hud_gauges.tbl#Dock Status X-offset:|Dock Status X-offset:]] (Optional)
:[[Hud_gauges.tbl#Dock Time X-offset:|Dock Time X-offset:]] (Optional)

====+Damage:====
Adds a gauge that shows how much damage a target (or the player?) has.

*Valid Sub-Entries:
:[[Hud_gauges.tbl#Position:|Position]]
{{table371|
:[[Hud_gauges.tbl#Scale Gauge:|Scale Gauge:]] (Optional)
:[[Hud_gauges.tbl#Origin:|Origin:]] (Optional, incompatible with [[Hud_gauges.tbl#Position:|Position:]], requires [[Hud_gauges.tbl#Offset:|Offset:]])
:[[Hud_gauges.tbl#Offset:|Offset:]] (Optional, incompatible with [[Hud_gauges.tbl#Position:|Position:]], requires [[Hud_gauges.tbl#Origin:|Origin:]])
}}
{{table3615|
:[[Hud_gauges.tbl#Cockpit Target:|Cockpit Target:]] (Optional)
::[[Hud_gauges.tbl#Canvas Size:|Canvas Size:]] (Optional)
::[[Hud_gauges.tbl#Display Offset:|Display Offset:]] (Optional)
::[[Hud_gauges.tbl#Display Size:|Display Size:]]
}}
:[[Hud_gauges.tbl#Color:|Color:]] (Optional)
:[[Hud_gauges.tbl#Font:|Font:]] (Optional)
:[[Hud_gauges.tbl#Slew:|Slew:]] (Optional)
:[[Hud_gauges.tbl#Top Background Filename:|Top Background Filename:]] (Optional)
:[[Hud_gauges.tbl#Entry Background Filename:|Entry Background Filename:]] (Optional)
:[[Hud_gauges.tbl#Bottom Background Filename:|Bottom Background Filename:]] (Optional)
:[[Hud_gauges.tbl#Header Offsets:|Header Offsets:]] (Optional)
:[[Hud_gauges.tbl#Hull Integrity Offsets:|Hull Integrity Offsets]] (Optional)
:[[Hud_gauges.tbl#Hull Integrity Value X-offset:|Hull Integrity Value X-offset]] (Optional)
:[[Hud_gauges.tbl#Top Background Height:|Top Background Height:]] (Optional)
:[[Hud_gauges.tbl#Subsystem Entry Height:|Subsystem Entry Height:]] (Optional)
:[[Hud_gauges.tbl#Subsystem List Start Offsets:|Subsystem List Start Offsets:]] (Optional)
:[[Hud_gauges.tbl#Subsystem Entry Value X-offset:|Subsystem Entry Value X-offset:]] (Optional)
:[[Hud_gauges.tbl#Bottom Background Offset:|Bottom Background Offset:]] (Optional)

====+Wingman Status:====
Adds a gauge that monitors the status of your wing and squadron.

*Valid Sub-entries:
:[[Hud_gauges.tbl#Position:|Position]]
{{table371|
:[[Hud_gauges.tbl#Scale Gauge:|Scale Gauge:]] (Optional)
:[[Hud_gauges.tbl#Origin:|Origin:]] (Optional, incompatible with [[Hud_gauges.tbl#Position:|Position:]], requires [[Hud_gauges.tbl#Offset:|Offset:]])
:[[Hud_gauges.tbl#Offset:|Offset:]] (Optional, incompatible with [[Hud_gauges.tbl#Position:|Position:]], requires [[Hud_gauges.tbl#Origin:|Origin:]])
}}
{{table3615|
:[[Hud_gauges.tbl#Cockpit Target:|Cockpit Target:]] (Optional)
::[[Hud_gauges.tbl#Canvas Size:|Canvas Size:]] (Optional)
::[[Hud_gauges.tbl#Display Offset:|Display Offset:]] (Optional)
::[[Hud_gauges.tbl#Display Size:|Display Size:]]
}}
:[[Hud_gauges.tbl#Color:|Color:]] (Optional)
:[[Hud_gauges.tbl#Font:|Font:]] (Optional)
:[[Hud_gauges.tbl#Slew:|Slew:]] (Optional)
:[[Hud_gauges.tbl#Left Background Filename:|Left Background Filename:]] (Optional)
{{table3615|
:[[Hud_gauges.tbl#First Background Filename:|First Background Filename:]] (Optional)}}
:[[Hud_gauges.tbl#Right Background Filename:|Right Background Filename:]] (Optional)
{{table3615|
:[[Hud_gauges.tbl#Last Background Filename:|Last Background Filename:]] (Optional)}}
:[[Hud_gauges.tbl#Entry Background Filename:|Entry Background Filename:]] (Optional)
:[[Hud_gauges.tbl#Dot Filename:|Dot Filename:]] (Optional)
:[[Hud_gauges.tbl#Header Offsets:|Header Offsets:]] (Optional)
:[[Hud_gauges.tbl#Left Background Width:|Left Background Width:]] (Optional)
{{table3615|
:[[Hud_gauges.tbl#First Background Size:|First Background Size:]] (Optional)}}
:[[Hud_gauges.tbl#Entry Width:|Entry Width:]] (Optional)
{{table3615|
:[[Hud_gauges.tbl#Entry Size:|Entry Size:]] (Optional)
:[[Hud_gauges.tbl#Right Background Offset:|Right Background Offset:]] (Optional)
:[[Hud_gauges.tbl#Last Background Offset:|Last Background Offset:]] (Optional)}}
:[[Hud_gauges.tbl#Single Wing Offsets:|Single Wing Offsets:]] (Optional)
:[[Hud_gauges.tbl#Multiple Wing Start Offsets:|Multiple Wing Start Offsets:]] (Optional)
:[[Hud_gauges.tbl#Wing Name Offsets:|Wing Name Offsets:]] (Optional)
:[[Hud_gauges.tbl#Dot Offsets:|Dot Offsets:]] (Optional)
:[[Hud_gauges.tbl#Expansion Mode:|Expansion Mode:]] (Optional)

====+Auto Speed:====
Adds the Auto-Speed mode gauge.

*Valid Sub-entries:
:[[Hud_gauges.tbl#Position:|Position]]
{{table371|
:[[Hud_gauges.tbl#Scale Gauge:|Scale Gauge:]] (Optional)
:[[Hud_gauges.tbl#Origin:|Origin:]] (Optional, incompatible with [[Hud_gauges.tbl#Position:|Position:]], requires [[Hud_gauges.tbl#Offset:|Offset:]])
:[[Hud_gauges.tbl#Offset:|Offset:]] (Optional, incompatible with [[Hud_gauges.tbl#Position:|Position:]], requires [[Hud_gauges.tbl#Origin:|Origin:]])
}}
{{table3615|
:[[Hud_gauges.tbl#Cockpit Target:|Cockpit Target:]] (Optional)
::[[Hud_gauges.tbl#Canvas Size:|Canvas Size:]] (Optional)
::[[Hud_gauges.tbl#Display Offset:|Display Offset:]] (Optional)
::[[Hud_gauges.tbl#Display Size:|Display Size:]]
}}
:[[Hud_gauges.tbl#Color:|Color:]] (Optional)
:[[Hud_gauges.tbl#Font:|Font:]] (Optional)
:[[Hud_gauges.tbl#Slew:|Slew:]] (Optional)
:[[Hud_gauges.tbl#Filename:|Filename:]]
:[[Hud_gauges.tbl#Auto Offsets:|Auto Offsets:]] (Optional)
:[[Hud_gauges.tbl#Speed Offsets:|Speed Offsets:]] (Optional)
{{table3615|
:[[Hud_gauges.tbl#On Text Color:|On Text Color:]] (Optional)
:[[Hud_gauges.tbl#On Text Color:|Off Text Color:]] (Optional)}}

====+Auto Target:====
Adds the Auto-target mode gauge.

*Valid Sub-entries:
:[[Hud_gauges.tbl#Position:|Position]]
{{table371|
:[[Hud_gauges.tbl#Scale Gauge:|Scale Gauge:]] (Optional)
:[[Hud_gauges.tbl#Origin:|Origin:]] (Optional, incompatible with [[Hud_gauges.tbl#Position:|Position:]], requires [[Hud_gauges.tbl#Offset:|Offset:]])
:[[Hud_gauges.tbl#Offset:|Offset:]] (Optional, incompatible with [[Hud_gauges.tbl#Position:|Position:]], requires [[Hud_gauges.tbl#Origin:|Origin:]])
}}
{{table3615|
:[[Hud_gauges.tbl#Cockpit Target:|Cockpit Target:]] (Optional)
::[[Hud_gauges.tbl#Canvas Size:|Canvas Size:]] (Optional)
::[[Hud_gauges.tbl#Display Offset:|Display Offset:]] (Optional)
::[[Hud_gauges.tbl#Display Size:|Display Size:]]
}}
:[[Hud_gauges.tbl#Color:|Color:]] (Optional)
:[[Hud_gauges.tbl#Font:|Font:]] (Optional)
:[[Hud_gauges.tbl#Slew:|Slew:]] (Optional)
:[[Hud_gauges.tbl#Filename:|Filename:]]
:[[Hud_gauges.tbl#Auto Offsets:|Auto Offsets:]] (Optional)
:[[Hud_gauges.tbl#Target Offsets:|Target Offsets:]] (Optional)
{{table3615|
:[[Hud_gauges.tbl#On Text Color:|On Text Color:]] (Optional)
:[[Hud_gauges.tbl#On Text Color:|Off Text Color:]] (Optional)}}

====+Countermeasures:====
Adds a gauge that monitors the amount of remaining countermeasures the player's ship currently has.

*Valid Sub-entries:
:[[Hud_gauges.tbl#Position:|Position]]
{{table371|
:[[Hud_gauges.tbl#Scale Gauge:|Scale Gauge:]] (Optional)
:[[Hud_gauges.tbl#Origin:|Origin:]] (Optional, incompatible with [[Hud_gauges.tbl#Position:|Position:]], requires [[Hud_gauges.tbl#Offset:|Offset:]])
:[[Hud_gauges.tbl#Offset:|Offset:]] (Optional, incompatible with [[Hud_gauges.tbl#Position:|Position:]], requires [[Hud_gauges.tbl#Origin:|Origin:]])
}}
{{table3615|
:[[Hud_gauges.tbl#Cockpit Target:|Cockpit Target:]] (Optional)
::[[Hud_gauges.tbl#Canvas Size:|Canvas Size:]] (Optional)
::[[Hud_gauges.tbl#Display Offset:|Display Offset:]] (Optional)
::[[Hud_gauges.tbl#Display Size:|Display Size:]]
}}
:[[Hud_gauges.tbl#Color:|Color:]] (Optional)
:[[Hud_gauges.tbl#Font:|Font:]] (Optional)
:[[Hud_gauges.tbl#Slew:|Slew:]] (Optional)
:[[Hud_gauges.tbl#Filename:|Filename:]]
:[[Hud_gauges.tbl#Text Offsets:|Text Offsets:]] (Optional)
:[[Hud_gauges.tbl#Value Offsets:|Value Offsets:]] (Optional)

====+Talking Head:====
Adds a video window to display pilot message videos (a.k.a talking heads).

*Valid Sub-entries:
:[[Hud_gauges.tbl#Position:|Position]]
{{table371|
:[[Hud_gauges.tbl#Scale Gauge:|Scale Gauge:]] (Optional)
:[[Hud_gauges.tbl#Origin:|Origin:]] (Optional, incompatible with [[Hud_gauges.tbl#Position:|Position:]], requires [[Hud_gauges.tbl#Offset:|Offset:]])
:[[Hud_gauges.tbl#Offset:|Offset:]] (Optional, incompatible with [[Hud_gauges.tbl#Position:|Position:]], requires [[Hud_gauges.tbl#Origin:|Origin:]])
}}
{{table3615|
:[[Hud_gauges.tbl#Cockpit Target:|Cockpit Target:]] (Optional)
::[[Hud_gauges.tbl#Canvas Size:|Canvas Size:]] (Optional)
::[[Hud_gauges.tbl#Display Offset:|Display Offset:]] (Optional)
::[[Hud_gauges.tbl#Display Size:|Display Size:]]
}}
:[[Hud_gauges.tbl#Color:|Color:]] (Optional)
:[[Hud_gauges.tbl#Font:|Font:]] (Optional)
:[[Hud_gauges.tbl#Slew:|Slew:]] (Optional)
:[[Hud_gauges.tbl#Filename:|Filename:]]
:[[Hud_gauges.tbl#Header Offsets:|Header Offsets:]] (Optional)
:[[Hud_gauges.tbl#Animation Offsets:|Animation Offsets:]] (Optional)
:[[Hud_gauges.tbl#Animation Background Size:|Animation Background Size:]] (Optional)

====+Directives:====
Adds a gauge that displays all currently active directives (includes current , completed, and failed)

*Valid Sub-entries:
:[[Hud_gauges.tbl#Position:|Position]]
{{table371|
:[[Hud_gauges.tbl#Scale Gauge:|Scale Gauge:]] (Optional)
:[[Hud_gauges.tbl#Origin:|Origin:]] (Optional, incompatible with [[Hud_gauges.tbl#Position:|Position:]], requires [[Hud_gauges.tbl#Offset:|Offset:]])
:[[Hud_gauges.tbl#Offset:|Offset:]] (Optional, incompatible with [[Hud_gauges.tbl#Position:|Position:]], requires [[Hud_gauges.tbl#Origin:|Origin:]])
}}
{{table3615|
:[[Hud_gauges.tbl#Cockpit Target:|Cockpit Target:]] (Optional)
::[[Hud_gauges.tbl#Canvas Size:|Canvas Size:]] (Optional)
::[[Hud_gauges.tbl#Display Offset:|Display Offset:]] (Optional)
::[[Hud_gauges.tbl#Display Size:|Display Size:]]
}}
:[[Hud_gauges.tbl#Color:|Color:]] (Optional)
:[[Hud_gauges.tbl#Font:|Font:]] (Optional)
:[[Hud_gauges.tbl#Top Background Filename:|Top Background Filename:]] (Optional)
:[[Hud_gauges.tbl#Entry Background Filename:|Entry Background Filename:]] (Optional)
:[[Hud_gauges.tbl#Bottom Background Filename:|Bottom Background Filename:]] (Optional)
:[[Hud_gauges.tbl#Header Offsets:|Header Offsets:]] (Optional)
:[[Hud_gauges.tbl#Top Background Height:|Top Background Height:]] (Optional)
:[[Hud_gauges.tbl#List Start Offsets:|List Start Offsets:]] (Optional)
:[[Hud_gauges.tbl#Entry Height:|Entry Height:]] (Optional)
{{table3615|
:[[Hud_gauges.tbl#Bottom Background Offset:|Bottom Background Offset:]] (Optional)
:[[Hud_gauges.tbl#Max Line Width:|Max Line Width:]] (Optional)
}}

====+Weapons:====
Adds a weapon status and ammunition gauge.

*Valid Sub-entries:
:[[Hud_gauges.tbl#Position:|Position]]
{{table371|
:[[Hud_gauges.tbl#Scale Gauge:|Scale Gauge:]] (Optional)
:[[Hud_gauges.tbl#Origin:|Origin:]] (Optional, incompatible with [[Hud_gauges.tbl#Position:|Position:]], requires [[Hud_gauges.tbl#Offset:|Offset:]])
:[[Hud_gauges.tbl#Offset:|Offset:]] (Optional, incompatible with [[Hud_gauges.tbl#Position:|Position:]], requires [[Hud_gauges.tbl#Origin:|Origin:]])
}}
{{table3615|
:[[Hud_gauges.tbl#Cockpit Target:|Cockpit Target:]] (Optional)
::[[Hud_gauges.tbl#Canvas Size:|Canvas Size:]] (Optional)
::[[Hud_gauges.tbl#Display Offset:|Display Offset:]] (Optional)
::[[Hud_gauges.tbl#Display Size:|Display Size:]]
}}
:[[Hud_gauges.tbl#Color:|Color:]] (Optional)
:[[Hud_gauges.tbl#Font:|Font:]] (Optional)
:[[Hud_gauges.tbl#Slew:|Slew:]] (Optional)
:[[Hud_gauges.tbl#Primary List Top Background Filename:|Primary List Top Background Filename:]] (Optional)
:[[Hud_gauges.tbl#Primary List Middle Background Filename:|Primary List Middle Background Filename:]] (Optional)
:[[Hud_gauges.tbl#Primary List Bottom Background Filename:|Primary List Bottom Background Filename:]] (Optional)
:[[Hud_gauges.tbl#Secondary List Top Background Filename:|Secondary List Top Background Filename:]] (Optional)
:[[Hud_gauges.tbl#Secondary List Entry Background Filename:|Secondary List Entry Background Filename:]] (Optional)
:[[Hud_gauges.tbl#Secondary List Bottom Background Filename:|Secondary List Bottom Background Filename:]] (Optional)
:[[Hud_gauges.tbl#Header Offsets:|Header Offsets:]] (Optional)
:[[Hud_gauges.tbl#Text X-offset:|Text X-offset:]] (Optional)
:[[Hud_gauges.tbl#Top Primary Frame Height:|Top Primary Frame Height:]] (Optional)
:[[Hud_gauges.tbl#Top Secondary Frame Height:|Top Secondary Frame Height:]] (Optional)
:[[Hud_gauges.tbl#Primary List Start Y-offset:|Primary List Start Y-offset:]] (Optional)
:[[Hud_gauges.tbl#Secondary List Start Y-offset:|Secondary List Start Y-offset:]] (Optional)
:[[Hud_gauges.tbl#Primary Weapon Ammo X-offset:|Primary Weapon Ammo X-offset:]] (Optional)
:[[Hud_gauges.tbl#Primary Weapon Link X-offset:|Primary Weapon Link X-offset:]] (Optional)
:[[Hud_gauges.tbl#Primary Weapon Name X-offset:|Primary Weapon Name X-offset:]] (Optional)
:[[Hud_gauges.tbl#Secondary Weapon Ammo X-offset:|Secondary Weapon Ammo X-offset:]] (Optional)
:[[Hud_gauges.tbl#Secondary Weapon Linked X-offset:|Secondary Weapon Linked X-offset:]] (Optional)
:[[Hud_gauges.tbl#Secondary Weapon Name X-offset:|Secondary Weapon Name X-offset:]] (Optional)
:[[Hud_gauges.tbl#Secondary Weapon Reload X-offset:|Secondary Weapon Reload X-offset:]] (Optional)
:[[Hud_gauges.tbl#Primary Weapon Entry Height:|Primary Weapon Entry Height:]] (Optional)
:[[Hud_gauges.tbl#Secondary Weapon Entry Height:|Secondary Weapon Entry Height:]] (Optional)

====+Objective notify:====
Adds a Objective notifier gauge. This gauge alerts the player when receiving a new objective, or when an objective has been completed or failed. Additionally, this gauge alerts the player when entering subspace, and when a Red Alert mission orders are being received (prior to a forced subspace jump).

*Valid Sub-entries:
:[[Hud_gauges.tbl#Position:|Position]]
{{table371|
:[[Hud_gauges.tbl#Scale Gauge:|Scale Gauge:]] (Optional)
:[[Hud_gauges.tbl#Origin:|Origin:]] (Optional, incompatible with [[Hud_gauges.tbl#Position:|Position:]], requires [[Hud_gauges.tbl#Offset:|Offset:]])
:[[Hud_gauges.tbl#Offset:|Offset:]] (Optional, incompatible with [[Hud_gauges.tbl#Position:|Position:]], requires [[Hud_gauges.tbl#Origin:|Origin:]])
}}
{{table3615|
:[[Hud_gauges.tbl#Cockpit Target:|Cockpit Target:]] (Optional)
::[[Hud_gauges.tbl#Canvas Size:|Canvas Size:]] (Optional)
::[[Hud_gauges.tbl#Display Offset:|Display Offset:]] (Optional)
::[[Hud_gauges.tbl#Display Size:|Display Size:]]
}}
:[[Hud_gauges.tbl#Color:|Color:]] (Optional)
:[[Hud_gauges.tbl#Font:|Font:]] (Optional)
:[[Hud_gauges.tbl#Slew:|Slew:]] (Optional)
:[[Hud_gauges.tbl#Filename:|Filename:]]
:[[Hud_gauges.tbl#Objective Text Y-offset:|Objective Text Y-offset:]] (Optional)
:[[Hud_gauges.tbl#Objective Value Y-offset:|Objective Value Y-offset:]] (Optional)
:[[Hud_gauges.tbl#Subspace Text Y-offset:|Subspace Text Y-offset:]] (Optional)
:[[Hud_gauges.tbl#Subspace Value Y-offset:|Subspace Value Y-offset:]] (Optional)
:[[Hud_gauges.tbl#Red Alert Text Y-offset:|Red Alert Text Y-offset:]] (Optional)
:[[Hud_gauges.tbl#Red Alert Value Y-offset:|Red Alert Value Y-offset:]] (Optional)

====+Squad Message====
Adds the squad message gauge. In FS1 and FS2, this gauge is used to send commands to your squad. (?)

*Valid sub-entries:
:[[Hud_gauges.tbl#Position:|Position]] (Optional)
{{table371|
:[[Hud_gauges.tbl#Scale Gauge:|Scale Gauge:]] (Optional)
:[[Hud_gauges.tbl#Origin:|Origin:]] (Optional, incompatible with [[Hud_gauges.tbl#Position:|Position:]], requires [[Hud_gauges.tbl#Offset:|Offset:]])
:[[Hud_gauges.tbl#Offset:|Offset:]] (Optional, incompatible with [[Hud_gauges.tbl#Position:|Position:]], requires [[Hud_gauges.tbl#Origin:|Origin:]])
}}
{{table3615|
:[[Hud_gauges.tbl#Cockpit Target:|Cockpit Target:]] (Optional)
::[[Hud_gauges.tbl#Canvas Size:|Canvas Size:]] (Optional)
::[[Hud_gauges.tbl#Display Offset:|Display Offset:]] (Optional)
::[[Hud_gauges.tbl#Display Size:|Display Size:]]
}}
:[[Hud_gauges.tbl#Color:|Color:]] (Optional)
:[[Hud_gauges.tbl#Font:|Font:]] (Optional)
:[[Hud_gauges.tbl#Slew:|Slew:]] (Optional)
:[[Hud_gauges.tbl#Top Background Filename:|Top Background Filename:]] (Optional)
:[[Hud_gauges.tbl#Entry Background Filename:|Entry Background Filename:]] (Optional)
:[[Hud_gauges.tbl#Bottom Background Filename:|Bottom Background Filename:]] (Optional)
:[[Hud_gauges.tbl#Header Offsets:|Header Offsets:]] (Optional)
:[[Hud_gauges.tbl#Top Background Height:|Top Background Height:]] (Optional)
:[[Hud_gauges.tbl#List Start Offsets:|List Start Offsets:]] (Optional)
:[[Hud_gauges.tbl#Entry Height:|Entry Height:]] (Optional)
{{table3615|
:[[Hud_gauges.tbl#Bottom Background Offset|Bottom Background Offset]] (Optional)}}
:[[Hud_gauges.tbl#Command X-offset:|Command X-offset:]] (Optional)
:[[Hud_gauges.tbl#Page Up Offsets:|Page Up Offsets:]] (Optional)
:[[Hud_gauges.tbl#Page Down Offsets:|Page Down Offsets:]] (Optional)

====+Lag:====
Adds a Lag gauge.

*Valid Sub-entries:
:[[Hud_gauges.tbl#Position:|Position]]
{{table371|
:[[Hud_gauges.tbl#Scale Gauge:|Scale Gauge:]] (Optional)
:[[Hud_gauges.tbl#Origin:|Origin:]] (Optional, incompatible with [[Hud_gauges.tbl#Position:|Position:]], requires [[Hud_gauges.tbl#Offset:|Offset:]])
:[[Hud_gauges.tbl#Offset:|Offset:]] (Optional, incompatible with [[Hud_gauges.tbl#Position:|Position:]], requires [[Hud_gauges.tbl#Origin:|Origin:]])
}}
{{table3615|
:[[Hud_gauges.tbl#Cockpit Target:|Cockpit Target:]] (Optional)
::[[Hud_gauges.tbl#Canvas Size:|Canvas Size:]] (Optional)
::[[Hud_gauges.tbl#Display Offset:|Display Offset:]] (Optional)
::[[Hud_gauges.tbl#Display Size:|Display Size:]]
}}
:[[Hud_gauges.tbl#Color:|Color:]] (Optional)
:[[Hud_gauges.tbl#Font:|Font:]] (Optional)
:[[Hud_gauges.tbl#Slew:|Slew:]] (Optional)
:[[Hud_gauges.tbl#Filename:|Filename:]]

====+Mini Target Shields:====
Adds a mini Target shields gauge. In FS1 and FS2, the Mini Target Shield gauge is the one right below the center reticle, and shows the hull damage in %

*Valid Sub-entries:
:[[Hud_gauges.tbl#Position:|Position]]
{{table371|
:[[Hud_gauges.tbl#Scale Gauge:|Scale Gauge:]] (Optional)
:[[Hud_gauges.tbl#Origin:|Origin:]] (Optional, incompatible with [[Hud_gauges.tbl#Position:|Position:]], requires [[Hud_gauges.tbl#Offset:|Offset:]])
:[[Hud_gauges.tbl#Offset:|Offset:]] (Optional, incompatible with [[Hud_gauges.tbl#Position:|Position:]], requires [[Hud_gauges.tbl#Origin:|Origin:]])
}}
{{table3615|
:[[Hud_gauges.tbl#Cockpit Target:|Cockpit Target:]] (Optional)
::[[Hud_gauges.tbl#Canvas Size:|Canvas Size:]] (Optional)
::[[Hud_gauges.tbl#Display Offset:|Display Offset:]] (Optional)
::[[Hud_gauges.tbl#Display Size:|Display Size:]]
}}
:[[Hud_gauges.tbl#Color:|Color:]] (Optional)
:[[Hud_gauges.tbl#Font:|Font:]] (Optional)
:[[Hud_gauges.tbl#Slew:|Slew:]] (Optional)
:[[Hud_gauges.tbl#Filename:|Filename:]]
:[[Hud_gauges.tbl#3 Digit Hull Offsets:|3 Digit Hull Offsets:]] (Optional)
:[[Hud_gauges.tbl#2 Digit Hull Offsets:|2 Digit Hull Offsets:]] (Optional)
:[[Hud_gauges.tbl#1 Digit Hull Offsets:|1 Digit Hull Offsets:]] (Optional)

====+Player Shields:====
Adds a gauge that shows the shield and hull status icon of the player's craft or ship.

*Valid Sub-entries:
:[[Hud_gauges.tbl#Position:|Position]] (Optional)
{{table371|
:[[Hud_gauges.tbl#Scale Gauge:|Scale Gauge:]] (Optional)
:[[Hud_gauges.tbl#Origin:|Origin:]] (Optional, incompatible with [[Hud_gauges.tbl#Position:|Position:]], requires [[Hud_gauges.tbl#Offset:|Offset:]])
:[[Hud_gauges.tbl#Offset:|Offset:]] (Optional, incompatible with [[Hud_gauges.tbl#Position:|Position:]], requires [[Hud_gauges.tbl#Origin:|Origin:]])
}}
{{table3615|
:[[Hud_gauges.tbl#Cockpit Target:|Cockpit Target:]] (Optional)
::[[Hud_gauges.tbl#Canvas Size:|Canvas Size:]] (Optional)
::[[Hud_gauges.tbl#Display Offset:|Display Offset:]] (Optional)
::[[Hud_gauges.tbl#Display Size:|Display Size:]]
}}
:[[Hud_gauges.tbl#Color:|Color:]] (Optional)
:[[Hud_gauges.tbl#Font:|Font:]] (Optional)
:[[Hud_gauges.tbl#Slew:|Slew:]] (Optional)

====+Target Shields:====
Adds a gauge that shows the shield and hull status icon of the targeted craft or ship.

*Valid Sub-entries:
:[[Hud_gauges.tbl#Position:|Position]] (Optional)
{{table371|
:[[Hud_gauges.tbl#Scale Gauge:|Scale Gauge:]] (Optional)
:[[Hud_gauges.tbl#Origin:|Origin:]] (Optional, incompatible with [[Hud_gauges.tbl#Position:|Position:]], requires [[Hud_gauges.tbl#Offset:|Offset:]])
:[[Hud_gauges.tbl#Offset:|Offset:]] (Optional, incompatible with [[Hud_gauges.tbl#Position:|Position:]], requires [[Hud_gauges.tbl#Origin:|Origin:]])
}}
{{table3615|
:[[Hud_gauges.tbl#Cockpit Target:|Cockpit Target:]] (Optional)
::[[Hud_gauges.tbl#Canvas Size:|Canvas Size:]] (Optional)
::[[Hud_gauges.tbl#Display Offset:|Display Offset:]] (Optional)
::[[Hud_gauges.tbl#Display Size:|Display Size:]]
}}
:[[Hud_gauges.tbl#Color:|Color:]] (Optional)
:[[Hud_gauges.tbl#Font:|Font:]] (Optional)
:[[Hud_gauges.tbl#Slew:|Slew:]] (Optional)

====+Escort View:====
Adds an escort monitor/view gauge. This gauge monitors the status of all ships assigned to the player to escort.

*Valid Sub-entries:
:[[Hud_gauges.tbl#Position:|Position]] (Optional)
{{table371|
:[[Hud_gauges.tbl#Scale Gauge:|Scale Gauge:]] (Optional)
:[[Hud_gauges.tbl#Origin:|Origin:]] (Optional, incompatible with [[Hud_gauges.tbl#Position:|Position:]], requires [[Hud_gauges.tbl#Offset:|Offset:]])
:[[Hud_gauges.tbl#Offset:|Offset:]] (Optional, incompatible with [[Hud_gauges.tbl#Position:|Position:]], requires [[Hud_gauges.tbl#Origin:|Origin:]])
}}
{{table3615|
:[[Hud_gauges.tbl#Cockpit Target:|Cockpit Target:]] (Optional)
::[[Hud_gauges.tbl#Canvas Size:|Canvas Size:]] (Optional)
::[[Hud_gauges.tbl#Display Offset:|Display Offset:]] (Optional)
::[[Hud_gauges.tbl#Display Size:|Display Size:]]
}}
:[[Hud_gauges.tbl#Color:|Color:]] (Optional)
:[[Hud_gauges.tbl#Font:|Font:]] (Optional)
:[[Hud_gauges.tbl#Slew:|Slew:]] (Optional)
:[[Hud_gauges.tbl#Top Background Filename:|Top Background Filename:]] (Optional)
:[[Hud_gauges.tbl#Entry Background Filename:|Entry Background Filename:]] (Optional)
:[[Hud_gauges.tbl#Bottom Background Filename:|Bottom Background Filename:]] (Optional)
:[[Hud_gauges.tbl#Entry Height:|Entry Height]] (Optional)
:[[Hud_gauges.tbl#Entry Stagger Width:|Entry Stagger Width:]] (Optional)
{{table3615|
:[[Hud_gauges.tbl#Bottom Background Offset:|Bottom Background Offset:]] (Optional)}}
:[[Hud_gauges.tbl#Header Text:|Header Text]] (Optional)
:[[Hud_gauges.tbl#Header Offsets:|Header Offsets:]] (Optional)
:[[Hud_gauges.tbl#List Start Offsets:|List Start Offsets:]] (Optional)
:[[Hud_gauges.tbl#Hull X-offset:|Hull X-offset]] (Optional)
:[[Hud_gauges.tbl#Name X-offset:|Name X-offset]] (Optional)
:[[Hud_gauges.tbl#Status X-offset:|Status X-offset]] (Optional)
{{table3615|
:[[Hud_gauges.tbl#Ship Name Max Width:|Ship Name Max Width:]] (Optional)}}

====+Mission Time:====
Adds a gauge that displays the current mission time.

*Valid Sub-entries:
:[[Hud_gauges.tbl#Position:|Position]] (Optional)
{{table371|
:[[Hud_gauges.tbl#Scale Gauge:|Scale Gauge:]] (Optional)
:[[Hud_gauges.tbl#Origin:|Origin:]] (Optional, incompatible with [[Hud_gauges.tbl#Position:|Position:]], requires [[Hud_gauges.tbl#Offset:|Offset:]])
:[[Hud_gauges.tbl#Offset:|Offset:]] (Optional, incompatible with [[Hud_gauges.tbl#Position:|Position:]], requires [[Hud_gauges.tbl#Origin:|Origin:]])
}}
{{table3615|
:[[Hud_gauges.tbl#Cockpit Target:|Cockpit Target:]] (Optional)
::[[Hud_gauges.tbl#Canvas Size:|Canvas Size:]] (Optional)
::[[Hud_gauges.tbl#Display Offset:|Display Offset:]] (Optional)
::[[Hud_gauges.tbl#Display Size:|Display Size:]]
}}
:[[Hud_gauges.tbl#Color:|Color:]] (Optional)
:[[Hud_gauges.tbl#Font:|Font:]] (Optional)
:[[Hud_gauges.tbl#Slew:|Slew:]] (Optional)
:[[Hud_gauges.tbl#Filename:|Filename:]] (Optional)
:[[Hud_gauges.tbl#Text Offsets:|Text Offsets:]] (Optional)
:[[Hud_gauges.tbl#Value Offsets:|Value Offsets:]] (Optional)

====+ETS Retail:====
{{Table3613|
Draws the three other ETS gauges as a single gauge. Will automatically rearrange itself (like retail) if shields or other systems are missing.

*Valid Sub-entries:
:[[Hud_gauges.tbl#Position:|Position]] (Optional)
}}
{{table371|
:[[Hud_gauges.tbl#Scale Gauge:|Scale Gauge:]] (Optional)
:[[Hud_gauges.tbl#Origin:|Origin:]] (Optional, incompatible with [[Hud_gauges.tbl#Position:|Position:]], requires [[Hud_gauges.tbl#Offset:|Offset:]])
:[[Hud_gauges.tbl#Offset:|Offset:]] (Optional, incompatible with [[Hud_gauges.tbl#Position:|Position:]], requires [[Hud_gauges.tbl#Origin:|Origin:]])
}}
{{table3615|
:[[Hud_gauges.tbl#Cockpit Target:|Cockpit Target:]] (Optional)
::[[Hud_gauges.tbl#Canvas Size:|Canvas Size:]] (Optional)
::[[Hud_gauges.tbl#Display Offset:|Display Offset:]] (Optional)
::[[Hud_gauges.tbl#Display Size:|Display Size:]]
}}
{{Table3613|
:[[Hud_gauges.tbl#Color:|Color:]] (Optional)
:[[Hud_gauges.tbl#Font:|Font:]] (Optional)
:[[Hud_gauges.tbl#Slew:|Slew:]] (Optional)
:[[Hud_gauges.tbl#Filename:|Filename:]] (Optional)
:[[Hud_gauges.tbl#Foreground Clip Height:|Foreground Clip Height:]] (Optional)
:[[Hud_gauges.tbl#Letter Offsets:|Letter Offsets:]] (Optional)
:[[Hud_gauges.tbl#Top Offsets:|Top Offsets:]] (Optional)
:[[Hud_gauges.tbl#Bottom Offsets:|Bottom Offsets:]] (Optional)
:[[Hud_gauges.tbl#Gauge Offset:|Gauge Offset:]] (Optional)

}}

====+ETS Weapons:====
Adds a gauge that displays the energy transfer rate for the energy weapons.

*Valid Sub-entries:
:[[Hud_gauges.tbl#Position:|Position]] (Optional)
{{table371|
:[[Hud_gauges.tbl#Scale Gauge:|Scale Gauge:]] (Optional)
:[[Hud_gauges.tbl#Origin:|Origin:]] (Optional, incompatible with [[Hud_gauges.tbl#Position:|Position:]], requires [[Hud_gauges.tbl#Offset:|Offset:]])
:[[Hud_gauges.tbl#Offset:|Offset:]] (Optional, incompatible with [[Hud_gauges.tbl#Position:|Position:]], requires [[Hud_gauges.tbl#Origin:|Origin:]])
}}
{{table3615|
:[[Hud_gauges.tbl#Cockpit Target:|Cockpit Target:]] (Optional)
::[[Hud_gauges.tbl#Canvas Size:|Canvas Size:]] (Optional)
::[[Hud_gauges.tbl#Display Offset:|Display Offset:]] (Optional)
::[[Hud_gauges.tbl#Display Size:|Display Size:]]
}}
:[[Hud_gauges.tbl#Color:|Color:]] (Optional)
:[[Hud_gauges.tbl#Font:|Font:]] (Optional)
:[[Hud_gauges.tbl#Slew:|Slew:]] (Optional)
:[[Hud_gauges.tbl#Filename:|Filename:]] (Optional)
:[[Hud_gauges.tbl#Foreground Clip Height:|Foreground Clip Height:]] (Optional)
:[[Hud_gauges.tbl#Letter Offsets:|Letter Offsets:]] (Optional)
:[[Hud_gauges.tbl#Top Offsets:|Top Offsets:]] (Optional)
:[[Hud_gauges.tbl#Bottom Offsets:|Bottom Offsets:]] (Optional)

====+ETS Engines:====
Adds a gauge that displays the energy transfer rate for the afterburner/engines.

*Valid Sub-entries:
:[[Hud_gauges.tbl#Position:|Position]] (Optional)
{{table371|
:[[Hud_gauges.tbl#Scale Gauge:|Scale Gauge:]] (Optional)
:[[Hud_gauges.tbl#Origin:|Origin:]] (Optional, incompatible with [[Hud_gauges.tbl#Position:|Position:]], requires [[Hud_gauges.tbl#Offset:|Offset:]])
:[[Hud_gauges.tbl#Offset:|Offset:]] (Optional, incompatible with [[Hud_gauges.tbl#Position:|Position:]], requires [[Hud_gauges.tbl#Origin:|Origin:]])
}}
{{table3615|
:[[Hud_gauges.tbl#Cockpit Target:|Cockpit Target:]] (Optional)
::[[Hud_gauges.tbl#Canvas Size:|Canvas Size:]] (Optional)
::[[Hud_gauges.tbl#Display Offset:|Display Offset:]] (Optional)
::[[Hud_gauges.tbl#Display Size:|Display Size:]]
}}
:[[Hud_gauges.tbl#Color:|Color:]] (Optional)
:[[Hud_gauges.tbl#Font:|Font:]] (Optional)
:[[Hud_gauges.tbl#Slew:|Slew:]] (Optional)
:[[Hud_gauges.tbl#Filename:|Filename:]] (Optional)
:[[Hud_gauges.tbl#Foreground Clip Height:|Foreground Clip Height:]] (Optional)
:[[Hud_gauges.tbl#Letter Offsets:|Letter Offsets:]] (Optional)
:[[Hud_gauges.tbl#Top Offsets:|Top Offsets:]] (Optional)
:[[Hud_gauges.tbl#Bottom Offsets:|Bottom Offsets:]] (Optional)

====+ETS Shields:====
Adds a gauge that displays the energy transfer rate for the shields.

*Valid Sub-entries:
:[[Hud_gauges.tbl#Position:|Position]] (Optional)
{{table371|
:[[Hud_gauges.tbl#Scale Gauge:|Scale Gauge:]] (Optional)
:[[Hud_gauges.tbl#Origin:|Origin:]] (Optional, incompatible with [[Hud_gauges.tbl#Position:|Position:]], requires [[Hud_gauges.tbl#Offset:|Offset:]])
:[[Hud_gauges.tbl#Offset:|Offset:]] (Optional, incompatible with [[Hud_gauges.tbl#Position:|Position:]], requires [[Hud_gauges.tbl#Origin:|Origin:]])
}}
{{table3615|
:[[Hud_gauges.tbl#Cockpit Target:|Cockpit Target:]] (Optional)
::[[Hud_gauges.tbl#Canvas Size:|Canvas Size:]] (Optional)
::[[Hud_gauges.tbl#Display Offset:|Display Offset:]] (Optional)
::[[Hud_gauges.tbl#Display Size:|Display Size:]]
}}
:[[Hud_gauges.tbl#Color:|Color:]] (Optional)
:[[Hud_gauges.tbl#Font:|Font:]] (Optional)
:[[Hud_gauges.tbl#Slew:|Slew:]] (Optional)
:[[Hud_gauges.tbl#Filename:|Filename:]] (Optional)
:[[Hud_gauges.tbl#Foreground Clip Height:|Foreground Clip Height:]] (Optional)
:[[Hud_gauges.tbl#Letter Offsets:|Letter Offsets:]] (Optional)
:[[Hud_gauges.tbl#Top Offsets:|Top Offsets:]] (Optional)
:[[Hud_gauges.tbl#Bottom Offsets:|Bottom Offsets:]] (Optional)

====+Target Monitor:====
Adds a target monitor gauge that shows the targeted ship's relative orientation and hull strength, among other things.

*Valid Sub-entries:
:[[Hud_gauges.tbl#Position:|Position]] (Optional)
{{table371|
:[[Hud_gauges.tbl#Scale Gauge:|Scale Gauge:]] (Optional)
:[[Hud_gauges.tbl#Origin:|Origin:]] (Optional, incompatible with [[Hud_gauges.tbl#Position:|Position:]], requires [[Hud_gauges.tbl#Offset:|Offset:]])
:[[Hud_gauges.tbl#Offset:|Offset:]] (Optional, incompatible with [[Hud_gauges.tbl#Position:|Position:]], requires [[Hud_gauges.tbl#Origin:|Origin:]])
}}
{{table3615|
:[[Hud_gauges.tbl#Cockpit Target:|Cockpit Target:]] (Optional)
::[[Hud_gauges.tbl#Canvas Size:|Canvas Size:]] (Optional)
::[[Hud_gauges.tbl#Display Offset:|Display Offset:]] (Optional)
::[[Hud_gauges.tbl#Display Size:|Display Size:]]
}}
:[[Hud_gauges.tbl#Color:|Color:]] (Optional)
:[[Hud_gauges.tbl#Font:|Font:]] (Optional)
:[[Hud_gauges.tbl#Monitor Filename:|Monitor Filename:]] (Optional)
{{table3615|
:[[Hud_gauges.tbl#Monitor Alpha Mask Filename:|Monitor Alpha Mask Filename:]] (Optional)}}
:[[Hud_gauges.tbl#Integrity Bar Filename:|Integrity Bar Filename:]] (Optional)
:[[Hud_gauges.tbl#Viewport Offsets:|Viewport Offsets:]] (Optional)
:[[Hud_gauges.tbl#Viewport Size:|Viewport Size:]] (Optional)
:[[Hud_gauges.tbl#Integrity Bar Offsets:|Integrity Bar Offsets:]] (Optional)
:[[Hud_gauges.tbl#Integrity Bar Foreground Clip Height:|Integrity Bar Foreground Clip Height:]] (Optional)
:[[Hud_gauges.tbl#Status Offsets:|Status Offsets:]] (Optional)
:[[Hud_gauges.tbl#Name Offsets:|Name Offsets:]] (Optional)
:[[Hud_gauges.tbl#Class Offsets:|Class Offsets:]] (Optional)
:[[Hud_gauges.tbl#Distance Offsets:|Distance Offsets:]] (Optional)
:[[Hud_gauges.tbl#Speed Offsets:|Speed Offsets:]] (Optional)
:[[Hud_gauges.tbl#Hull Offsets:|Hull Offsets:]] (Optional)
:[[Hud_gauges.tbl#Cargo Contents Offsets:|Cargo Contents Offsets:]] (Optional)
:[[Hud_gauges.tbl#Cargo Scan Start Offsets:|Cargo Scan Start Offsets:]] (Optional)
:[[Hud_gauges.tbl#Cargo Scan Size:|Cargo Scan Size:]] (Optional)
{{table3615|
:[[Hud_gauges.tbl#Subsystem Name Offsets:|Subsystem Name Offsets:]] (Optional)
:[[Hud_gauges.tbl#Subsystem Integrity Offsets:|Subsystem Integrity Offsets:]] (Optional)
:[[Hud_gauges.tbl#Disabled Status Offsets:|Disabled Status Offsets:]] (Optional)
:[[Hud_gauges.tbl#Desaturate:|Desaturate:]] (Optional)
}}

====+Extra Target Data:====
Adds a gauge that displays "extra" target data, such as its current orders and docking status.

*Valid Sub-Entries:
:[[Hud_gauges.tbl#Position:|Position]] (Optional)
{{table371|
:[[Hud_gauges.tbl#Scale Gauge:|Scale Gauge:]] (Optional)
:[[Hud_gauges.tbl#Origin:|Origin:]] (Optional, incompatible with [[Hud_gauges.tbl#Position:|Position:]], requires [[Hud_gauges.tbl#Offset:|Offset:]])
:[[Hud_gauges.tbl#Offset:|Offset:]] (Optional, incompatible with [[Hud_gauges.tbl#Position:|Position:]], requires [[Hud_gauges.tbl#Origin:|Origin:]])
}}
{{table3615|
:[[Hud_gauges.tbl#Cockpit Target:|Cockpit Target:]] (Optional)
::[[Hud_gauges.tbl#Canvas Size:|Canvas Size:]] (Optional)
::[[Hud_gauges.tbl#Display Offset:|Display Offset:]] (Optional)
::[[Hud_gauges.tbl#Display Size:|Display Size:]]
}}
:[[Hud_gauges.tbl#Color:|Color:]] (Optional)
:[[Hud_gauges.tbl#Font:|Font:]] (Optional)
:[[Hud_gauges.tbl#Slew:|Slew:]] (Optional)
:[[Hud_gauges.tbl#Filename:|Filename:]] (Optional)
:[[Hud_gauges.tbl#Bracket Offsets:|Bracket Offsets:]] (Optional)
:[[Hud_gauges.tbl#Dock Offsets:|Dock Offsets:]] (Optional)
:[[Hud_gauges.tbl#Order Offsets:|Order Offsets:]] (Optional)
:[[Hud_gauges.tbl#Time Offsets:|Time Offsets:]] (Optional)

====+Radar:====
Adds a standard radar gauge

*Valid Sub-entries:
:[[Hud_gauges.tbl#Position:|Position]] (Optional)
{{table371|
:[[Hud_gauges.tbl#Scale Gauge:|Scale Gauge:]] (Optional)
:[[Hud_gauges.tbl#Origin:|Origin:]] (Optional, incompatible with [[Hud_gauges.tbl#Position:|Position:]], requires [[Hud_gauges.tbl#Offset:|Offset:]])
:[[Hud_gauges.tbl#Offset:|Offset:]] (Optional, incompatible with [[Hud_gauges.tbl#Position:|Position:]], requires [[Hud_gauges.tbl#Origin:|Origin:]])
}}
{{table3615|
:[[Hud_gauges.tbl#Cockpit Target:|Cockpit Target:]] (Optional)
::[[Hud_gauges.tbl#Canvas Size:|Canvas Size:]] (Optional)
::[[Hud_gauges.tbl#Display Offset:|Display Offset:]] (Optional)
::[[Hud_gauges.tbl#Display Size:|Display Size:]]
}}
:[[Hud_gauges.tbl#Color:|Color:]] (Optional)
:[[Hud_gauges.tbl#Font:|Font:]] (Optional)
:[[Hud_gauges.tbl#Filename:|Filename:]] (Optional)
:[[Hud_gauges.tbl#Infinity Distance Offsets:|Infinity Distance Offsets]] (Optional)
:[[Hud_gauges.tbl#Long Distance Offsets:|Long Distance Offsets:]] (Optional)
:[[Hud_gauges.tbl#Short Distance Offsets:|Short Distance Offsets:]] (Optional)

====+Radar Orb:====
Adds a 3D orb radar gauge

*Valid Sub-entries:
:[[Hud_gauges.tbl#Position:|Position]] (Optional)
{{table371|
:[[Hud_gauges.tbl#Scale Gauge:|Scale Gauge:]] (Optional)
:[[Hud_gauges.tbl#Origin:|Origin:]] (Optional, incompatible with [[Hud_gauges.tbl#Position:|Position:]], requires [[Hud_gauges.tbl#Offset:|Offset:]])
:[[Hud_gauges.tbl#Offset:|Offset:]] (Optional, incompatible with [[Hud_gauges.tbl#Position:|Position:]], requires [[Hud_gauges.tbl#Origin:|Origin:]])
}}
{{table3615|
:[[Hud_gauges.tbl#Cockpit Target:|Cockpit Target:]] (Optional)
::[[Hud_gauges.tbl#Canvas Size:|Canvas Size:]] (Optional)
::[[Hud_gauges.tbl#Display Offset:|Display Offset:]] (Optional)
::[[Hud_gauges.tbl#Display Size:|Display Size:]]
}}
:[[Hud_gauges.tbl#Color:|Color:]] (Optional)
:[[Hud_gauges.tbl#Font:|Font:]] (Optional)
:[[Hud_gauges.tbl#Filename:|Filename:]] (Optional)
:[[Hud_gauges.tbl#Infinity Distance Offsets:|Infinity Distance Offsets]] (Optional)
:[[Hud_gauges.tbl#Long Distance Offsets:|Long Distance Offsets:]] (Optional)
:[[Hud_gauges.tbl#Short Distance Offsets:|Short Distance Offsets:]] (Optional)

====+Radar BSG:====
Adds a BSG style radar (a.k.a DRADIS).

:[[Hud_gauges.tbl#Position:|Position]] (Optional)
{{table371|
:[[Hud_gauges.tbl#Scale Gauge:|Scale Gauge:]] (Optional)
:[[Hud_gauges.tbl#Origin:|Origin:]] (Optional, incompatible with [[Hud_gauges.tbl#Position:|Position:]], requires [[Hud_gauges.tbl#Offset:|Offset:]])
:[[Hud_gauges.tbl#Offset:|Offset:]] (Optional, incompatible with [[Hud_gauges.tbl#Position:|Position:]], requires [[Hud_gauges.tbl#Origin:|Origin:]])
}}
:[[Hud_gauges.tbl#Font:|Font:]] (Optional)
:[[Hud_gauges.tbl#Size:|Size:]] (Optional)
:[[Hud_gauges.tbl#XY Disc Filename:|XY Disc Filename:]] (Optional)
:[[Hud_gauges.tbl#XZ YZ Disc Filename:|XZ YZ Disc Filename:]] (Optional)
:[[Hud_gauges.tbl#Sweep Disc Filename:|Sweep Disc Filename:]] (Optional)
:[[Hud_gauges.tbl#Default Contact Filename:|Default Contact Filename:]] (Optional)
:[[Hud_gauges.tbl#Unknown Contact Filename:|Unknown Contact Filename:]] (Optional)
:[[Hud_gauges.tbl#Cockpit Target:|Cockpit Target:]] (Optional)
::[[Hud_gauges.tbl#Canvas Size:|Canvas Size:]]
::[[Hud_gauges.tbl#Display Offset:|Display Offset:]]
::[[Hud_gauges.tbl#Display Size:|Display Size:]]
:[[Hud_gauges.tbl#Loop Volume:|Loop Volume:]] (Optional)
:[[Hud_gauges.tbl#Minimum Beep Delay:|Minimum Beep Delay]] (Optional)

====+Afterburner Energy:====
Adds a gauge that shows the remaining afterburner energy.

*Valid Sub-Entries:
:[[Hud_gauges.tbl#Position:|Position]] (Optional)
{{table371|
:[[Hud_gauges.tbl#Scale Gauge:|Scale Gauge:]] (Optional)
:[[Hud_gauges.tbl#Origin:|Origin:]] (Optional, incompatible with [[Hud_gauges.tbl#Position:|Position:]], requires [[Hud_gauges.tbl#Offset:|Offset:]])
:[[Hud_gauges.tbl#Offset:|Offset:]] (Optional, incompatible with [[Hud_gauges.tbl#Position:|Position:]], requires [[Hud_gauges.tbl#Origin:|Origin:]])
}}
{{table3615|
:[[Hud_gauges.tbl#Cockpit Target:|Cockpit Target:]] (Optional)
::[[Hud_gauges.tbl#Canvas Size:|Canvas Size:]] (Optional)
::[[Hud_gauges.tbl#Display Offset:|Display Offset:]] (Optional)
::[[Hud_gauges.tbl#Display Size:|Display Size:]]
}}
:[[Hud_gauges.tbl#Color:|Color:]] (Optional)
:[[Hud_gauges.tbl#Font:|Font:]] (Optional)
:[[Hud_gauges.tbl#Slew:|Slew:]] (Optional)
:[[Hud_gauges.tbl#Filename:|Filename:]] (Optional)
:[[Hud_gauges.tbl#Foreground Clip Height:|Foreground Clip Height:]] (Optional)

====+Weapon Energy:====
Adds a gauge that shows the remaining weapon energy.

*Valid Sub-Entries:
:[[Hud_gauges.tbl#Position:|Position]] (Optional)
{{table371|
:[[Hud_gauges.tbl#Scale Gauge:|Scale Gauge:]] (Optional)
:[[Hud_gauges.tbl#Origin:|Origin:]] (Optional, incompatible with [[Hud_gauges.tbl#Position:|Position:]], requires [[Hud_gauges.tbl#Offset:|Offset:]])
:[[Hud_gauges.tbl#Offset:|Offset:]] (Optional, incompatible with [[Hud_gauges.tbl#Position:|Position:]], requires [[Hud_gauges.tbl#Origin:|Origin:]])
}}
{{table3615|
:[[Hud_gauges.tbl#Cockpit Target:|Cockpit Target:]] (Optional)
::[[Hud_gauges.tbl#Canvas Size:|Canvas Size:]] (Optional)
::[[Hud_gauges.tbl#Display Offset:|Display Offset:]] (Optional)
::[[Hud_gauges.tbl#Display Size:|Display Size:]]
}}
:[[Hud_gauges.tbl#Color:|Color:]] (Optional)
:[[Hud_gauges.tbl#Font:|Font:]] (Optional)
:[[Hud_gauges.tbl#Slew:|Slew:]] (Optional)
:[[Hud_gauges.tbl#Filename:|Filename:]] (Optional)
:[[Hud_gauges.tbl#Foreground Clip Height:|Foreground Clip Height:]] (Optional)
:[[Hud_gauges.tbl#Text Offsets:|Text Offsets:]] (Optional)
{{table3615|
:[[Hud_gauges.tbl#Text Alignment:|Text Alignment:]] (Optional)
:[[Hud_gauges.tbl#Always Show Text:|Always Show Text:]] (Optional)
:[[Hud_gauges.tbl#Text Follows:|Text Follows:]] (Optional)
:[[Hud_gauges.tbl#Show Ballistic Ammo:|Show Ballistic Ammo:]] (Optional)
:[[Hud_gauges.tbl#Armed Guns List Offsets:|Armed Guns List Offsets:]] (Optional)
:[[Hud_gauges.tbl#Armed Guns List Alignment:|Armed Guns List Alignment:]] (Optional)
:[[Hud_gauges.tbl#Armed Guns List Entry Height:|Armed Guns List Entry Height:]] (Optional)
}}

====+Text Warnings:====
Adds a gauge that warns the player (current warnings are EMP, Launch, Evaded, Collision, Blast & Engine Wash).

*Valid Sub-Entries:
:[[Hud_gauges.tbl#Position:|Position]] (Optional)
{{table371|
:[[Hud_gauges.tbl#Scale Gauge:|Scale Gauge:]] (Optional)
:[[Hud_gauges.tbl#Origin:|Origin:]] (Optional, incompatible with [[Hud_gauges.tbl#Position:|Position:]], requires [[Hud_gauges.tbl#Offset:|Offset:]])
:[[Hud_gauges.tbl#Offset:|Offset:]] (Optional, incompatible with [[Hud_gauges.tbl#Position:|Position:]], requires [[Hud_gauges.tbl#Origin:|Origin:]])
}}
{{table3615|
:[[Hud_gauges.tbl#Cockpit Target:|Cockpit Target:]] (Optional)
::[[Hud_gauges.tbl#Canvas Size:|Canvas Size:]] (Optional)
::[[Hud_gauges.tbl#Display Offset:|Display Offset:]] (Optional)
::[[Hud_gauges.tbl#Display Size:|Display Size:]]
}}
:[[Hud_gauges.tbl#Color:|Color:]] (Optional)
:[[Hud_gauges.tbl#Font:|Font:]] (Optional)
:[[Hud_gauges.tbl#Slew:|Slew:]] (Optional)

====+Center Reticle:====
Adds a "custom" center reticle.

*Valid Sub-Entries:
:[[Hud_gauges.tbl#Position:|Position]] (Optional)
{{table371|
:[[Hud_gauges.tbl#Scale Gauge:|Scale Gauge:]] (Optional)
:[[Hud_gauges.tbl#Origin:|Origin:]] (Optional, incompatible with [[Hud_gauges.tbl#Position:|Position:]], requires [[Hud_gauges.tbl#Offset:|Offset:]])
:[[Hud_gauges.tbl#Offset:|Offset:]] (Optional, incompatible with [[Hud_gauges.tbl#Position:|Position:]], requires [[Hud_gauges.tbl#Origin:|Origin:]])
}}
:[[Hud_gauges.tbl#Color:|Color:]] (Optional)
:[[Hud_gauges.tbl#Font:|Font:]] (Optional)
:[[Hud_gauges.tbl#Filename:|Filename:]] (Optional)
:[[Hud_gauges.tbl#Firepoint display:|Firepoint display:]] (Optional)
:[[Hud_gauges.tbl#Firepoint size:|Firepoint size:]] (Optional)
:[[Hud_gauges.tbl#Firepoint X coordinate multiplier:|Firepoint X coordinate multiplier:]] (Optional)
:[[Hud_gauges.tbl#Firepoint Y coordinate multiplier:|Firepoint Y coordinate multiplier:]] (Optional)

====+Throttle:====
Adds a gauge that shows the current throttle position.

*Valid Sub-Entries:
:[[Hud_gauges.tbl#Position:|Position]] (Optional)
{{table371|
:[[Hud_gauges.tbl#Scale Gauge:|Scale Gauge:]] (Optional)
:[[Hud_gauges.tbl#Origin:|Origin:]] (Optional, incompatible with [[Hud_gauges.tbl#Position:|Position:]], requires [[Hud_gauges.tbl#Offset:|Offset:]])
:[[Hud_gauges.tbl#Offset:|Offset:]] (Optional, incompatible with [[Hud_gauges.tbl#Position:|Position:]], requires [[Hud_gauges.tbl#Origin:|Origin:]])
}}
{{table3615|
:[[Hud_gauges.tbl#Cockpit Target:|Cockpit Target:]] (Optional)
::[[Hud_gauges.tbl#Canvas Size:|Canvas Size:]] (Optional)
::[[Hud_gauges.tbl#Display Offset:|Display Offset:]] (Optional)
::[[Hud_gauges.tbl#Display Size:|Display Size:]]
}}
:[[Hud_gauges.tbl#Color:|Color:]] (Optional)
:[[Hud_gauges.tbl#Font:|Font:]] (Optional)
:[[Hud_gauges.tbl#Filename:|Filename:]] (Optional)
:[[Hud_gauges.tbl#Foreground Clip Bottom Y-offset:|Foreground Clip Bottom Y-offset:]] (Optional)
:[[Hud_gauges.tbl#Foreground Clip Width:|Foreground Clip Width:]] (Optional)
:[[Hud_gauges.tbl#Foreground Clip Height:|Foreground Clip Height:]] (Optional)
:[[Hud_gauges.tbl#Afterburner Clip Height:|Afterburner Clip Height:]] (Optional)
:[[Hud_gauges.tbl#Show Background:|Show Background:]] (Optional)
:[[Hud_gauges.tbl#Max Speed Label Offsets:|Max Speed Label Offsets:]] (Optional)
{{table3615|
:[[Hud_gauges.tbl#Show Max Speed Label:|Show Max Speed Label:]] (Optional)}}
:[[Hud_gauges.tbl#Min Speed Label Offsets:|Min Speed Label Offsets:]] (Optional)
{{table3615|
:[[Hud_gauges.tbl#Show Min Speed Label:|Show Min Speed Label:]] (Optional)}}
:[[Hud_gauges.tbl#Orbit Center Offsets:|Orbit Center Offsets:]] (Optional)
:[[Hud_gauges.tbl#Orbit Radius:|Orbit Radius:]] (Optional)
{{table3615|
:[[Hud_gauges.tbl#Current Speed Offsets:|Current Speed Offsets:]] (Optional)
:[[Hud_gauges.tbl#Target Speed Offsets:|Target Speed Offsets:]] (Optional)
:[[Hud_gauges.tbl#Show Percentage:|Show Percentage:]] (Optional)
:[[Hud_gauges.tbl#Glide Status Offsets:|Glide Status Offsets:]] (Optional)
:[[Hud_gauges.tbl#Match Speed Status Offsets:|Match Speed Status Offsets:]] (Optional)
}}

====+Threat Indicator:====
Adds a gauge that indicates when a lock-on has been achieved by an attacker, and if the player is being shot at.

*Valid Sub-Entries:
:[[Hud_gauges.tbl#Position:|Position]] (Optional)
{{table371|
:[[Hud_gauges.tbl#Scale Gauge:|Scale Gauge:]] (Optional)
:[[Hud_gauges.tbl#Origin:|Origin:]] (Optional, incompatible with [[Hud_gauges.tbl#Position:|Position:]], requires [[Hud_gauges.tbl#Offset:|Offset:]])
:[[Hud_gauges.tbl#Offset:|Offset:]] (Optional, incompatible with [[Hud_gauges.tbl#Position:|Position:]], requires [[Hud_gauges.tbl#Origin:|Origin:]])
}}
{{table3615|
:[[Hud_gauges.tbl#Cockpit Target:|Cockpit Target:]] (Optional)
::[[Hud_gauges.tbl#Canvas Size:|Canvas Size:]] (Optional)
::[[Hud_gauges.tbl#Display Offset:|Display Offset:]] (Optional)
::[[Hud_gauges.tbl#Display Size:|Display Size:]]
}}
:[[Hud_gauges.tbl#Color:|Color:]] (Optional)
:[[Hud_gauges.tbl#Font:|Font:]] (Optional)
:[[Hud_gauges.tbl#Slew:|Slew:]] (Optional)
:[[Hud_gauges.tbl#Arc Filename:|Arc Filename:]] (Optional)
:[[Hud_gauges.tbl#Dumbfire Filename:|Dumbfire Filename:]] (Optional)
:[[Hud_gauges.tbl#Lock Filename:|Lock Filename:]] (Optional)
:[[Hud_gauges.tbl#Dumbfire Offsets:|Dumbfire Offsets:]] (Optional)
:[[Hud_gauges.tbl#Lock Offsets:|Lock Offsets:]] (Optional)

====+Multiplayer Messages:====
Adds a gauge that displays the multiplayer messages.

*Valid Sub-Entries:
:[[Hud_gauges.tbl#Position:|Position]] (Optional)
{{table371|
:[[Hud_gauges.tbl#Scale Gauge:|Scale Gauge:]] (Optional)
:[[Hud_gauges.tbl#Origin:|Origin:]] (Optional, incompatible with [[Hud_gauges.tbl#Position:|Position:]], requires [[Hud_gauges.tbl#Offset:|Offset:]])
:[[Hud_gauges.tbl#Offset:|Offset:]] (Optional, incompatible with [[Hud_gauges.tbl#Position:|Position:]], requires [[Hud_gauges.tbl#Origin:|Origin:]])
}}
{{table3615|
:[[Hud_gauges.tbl#Cockpit Target:|Cockpit Target:]] (Optional)
::[[Hud_gauges.tbl#Canvas Size:|Canvas Size:]] (Optional)
::[[Hud_gauges.tbl#Display Offset:|Display Offset:]] (Optional)
::[[Hud_gauges.tbl#Display Size:|Display Size:]]
}}
:[[Hud_gauges.tbl#Font:|Font:]] (Optional)

====+Voice Status:====
Adds a gauge that displays the voice status.

*Valid Sub-Entries:
:[[Hud_gauges.tbl#Position:|Position]] (Optional)
{{table371|
:[[Hud_gauges.tbl#Scale Gauge:|Scale Gauge:]] (Optional)
:[[Hud_gauges.tbl#Origin:|Origin:]] (Optional, incompatible with [[Hud_gauges.tbl#Position:|Position:]], requires [[Hud_gauges.tbl#Offset:|Offset:]])
:[[Hud_gauges.tbl#Offset:|Offset:]] (Optional, incompatible with [[Hud_gauges.tbl#Position:|Position:]], requires [[Hud_gauges.tbl#Origin:|Origin:]])
}}
{{table3615|
:[[Hud_gauges.tbl#Cockpit Target:|Cockpit Target:]] (Optional)
::[[Hud_gauges.tbl#Canvas Size:|Canvas Size:]] (Optional)
::[[Hud_gauges.tbl#Display Offset:|Display Offset:]] (Optional)
::[[Hud_gauges.tbl#Display Size:|Display Size:]]
}}
:[[Hud_gauges.tbl#Color:|Color:]] (Optional)
:[[Hud_gauges.tbl#Font:|Font:]] (Optional)

====+Ping:====
Adds a gauge that the ping time to the multiplayer server.

*Valid Sub-Entries:
:[[Hud_gauges.tbl#Position:|Position]] (Optional)
{{table371|
:[[Hud_gauges.tbl#Scale Gauge:|Scale Gauge:]] (Optional)
:[[Hud_gauges.tbl#Origin:|Origin:]] (Optional, incompatible with [[Hud_gauges.tbl#Position:|Position:]], requires [[Hud_gauges.tbl#Offset:|Offset:]])
:[[Hud_gauges.tbl#Offset:|Offset:]] (Optional, incompatible with [[Hud_gauges.tbl#Position:|Position:]], requires [[Hud_gauges.tbl#Origin:|Origin:]])
}}
{{table3615|
:[[Hud_gauges.tbl#Cockpit Target:|Cockpit Target:]] (Optional)
::[[Hud_gauges.tbl#Canvas Size:|Canvas Size:]] (Optional)
::[[Hud_gauges.tbl#Display Offset:|Display Offset:]] (Optional)
::[[Hud_gauges.tbl#Display Size:|Display Size:]]
}}
:[[Hud_gauges.tbl#Color:|Color:]] (Optional)
:[[Hud_gauges.tbl#Font:|Font:]] (Optional)

====+Supernova:====
Adds a gauge that warns the player of an impending supernova shock wave.

*Valid Sub-Entries:
:[[Hud_gauges.tbl#Position:|Position]] (Optional)
{{table371|
:[[Hud_gauges.tbl#Scale Gauge:|Scale Gauge:]] (Optional)
:[[Hud_gauges.tbl#Origin:|Origin:]] (Optional, incompatible with [[Hud_gauges.tbl#Position:|Position:]], requires [[Hud_gauges.tbl#Offset:|Offset:]])
:[[Hud_gauges.tbl#Offset:|Offset:]] (Optional, incompatible with [[Hud_gauges.tbl#Position:|Position:]], requires [[Hud_gauges.tbl#Origin:|Origin:]])
}}
{{table3615|
:[[Hud_gauges.tbl#Cockpit Target:|Cockpit Target:]] (Optional)
::[[Hud_gauges.tbl#Canvas Size:|Canvas Size:]] (Optional)
::[[Hud_gauges.tbl#Display Offset:|Display Offset:]] (Optional)
::[[Hud_gauges.tbl#Display Size:|Display Size:]]
}}
:[[Hud_gauges.tbl#Color:|Color:]] (Optional)
:[[Hud_gauges.tbl#Font:|Font:]] (Optional)

====+Lock Indicator:====
Adds a Lock Indicator gauge.

*Valid Sub-Entries:
:[[Hud_gauges.tbl#Font:|Font:]] (Optional)
:[[Hud_gauges.tbl#Lock Filename:|Lock Filename:]] (Optional)
:[[Hud_gauges.tbl#Locked Filename:|Locked Filename:]] (Optional)
:[[Hud_gauges.tbl#Lock Center Offsets:|Lock Center Offsets:]] (Optional)
:[[Hud_gauges.tbl#Locked Center Offsets:|Locked Center Offsets:]] (Optional)

====+Offscreen Indicator:====
Adds an Offscreen Indicator.

*Valid Sub-Entries:
:[[Hud_gauges.tbl#Font:|Font:]] (Optional)

====+Target Brackets:====
Adds a Target Bracket gauge. This is drawn around current target(s) and talkers.

*Valid Sub-Entries:
:[[Hud_gauges.tbl#Font:|Font:]] (Optional)
:[[Hud_gauges.tbl#Dot Filename:|Dot Filename:]] (Optional)

====+Hostile Triangle:====
Adds a gauge that points to the nearest attacker, if it is off-screen and is not currently targeted.

*Valid Sub-entries:
:[[Hud_gauges.tbl#Font:|Font:]] (Optional)
:[[Hud_gauges.tbl#Slew:|Slew:]] (Optional)
:[[Hud_gauges.tbl#Radius:|Radius]] (Optional)
:[[Hud_gauges.tbl#Triangle Base:|Triangle Base:]] (Optional)
:[[Hud_gauges.tbl#Triangle Height:|Triangle Height:]] (Optional)

====+Target Triangle:====
Adds a gauge that points to the targeted craft, if it is currently off-screen.

*Valid Sub-entries:
:[[Hud_gauges.tbl#Font:|Font:]] (Optional)
:[[Hud_gauges.tbl#Slew:|Slew:]] (Optional)
:[[Hud_gauges.tbl#Radius:|Radius]] (Optional)
:[[Hud_gauges.tbl#Triangle Base:|Triangle Base:]] (Optional)
:[[Hud_gauges.tbl#Triangle Height:|Triangle Height:]] (Optional)

====+Missile Triangles:====
Adds a gauge that is used during attempting to lock onto a target when using an aspect seeking missile.

*Valid Sub-entries:
:[[Hud_gauges.tbl#Font:|Font:]] (Optional)
:[[Hud_gauges.tbl#Slew:|Slew:]] (Optional)
:[[Hud_gauges.tbl#Radius:|Radius]] (Optional)
:[[Hud_gauges.tbl#Triangle Base:|Triangle Base:]] (Optional)
:[[Hud_gauges.tbl#Triangle Height:|Triangle Height:]] (Optional)

====+Lead Indicator:====
Adds a gauge that is used to raise the probability of hitting a target with primary weapons.

*Valid Sub-entries:
:[[Hud_gauges.tbl#Font:|Font:]] (Optional)
:[[Hud_gauges.tbl#Filename:|Filename:]] (Optional)
::Frame #0: Secondaries lead indicator (Dumbfire)
::Frame #1: Secondaries lead indicator (Homing)
::Frame #2: Primaries lead indicator
:[[Hud_gauges.tbl#Center Offsets:|Center Offsets:]] (Optional)

====+Orientation Tee:====
Adds a gauge that indicates the targeted craft's orientation in relation to the player's craft.

*Valid Sub-Entries:
:[[Hud_gauges.tbl#Position:|Position]] (Optional)
:[[Hud_gauges.tbl#Font:|Font:]] (Optional)
:[[Hud_gauges.tbl#Slew:|Slew:]] (Optional)
:[[Hud_gauges.tbl#Radius:|Radius]] (Optional)

====+Lead Sight:====
Adds a gauge that indicates where your shots will end up, as opposed to Lead Indicator that indicates where you have to shoot at to hit your target. Notably used by [[Diaspora]].

*Valid Sub-Entries:
:[[Hud_gauges.tbl#Position:|Position]] (Optional)
:[[Hud_gauges.tbl#Color:|Color:]] (Optional)
:[[Hud_gauges.tbl#Font:|Font:]] (Optional)
:[[Hud_gauges.tbl#Slew:|Slew:]] (Optional)
:[[Hud_gauges.tbl#Filename:|Filename:]] (Optional)
::Frame #0 is used for secondaries
::* If only one frame is found in the file, then it is used for primaries instead
::Frame #1 is used for primaries

====+Kills:====
Adds a gauge that keeps track of how many kills the player has scored during a mission.

*Valid Sub-Entries:
:[[Hud_gauges.tbl#Position:|Position]] (Optional)
{{table371|
:[[Hud_gauges.tbl#Scale Gauge:|Scale Gauge:]] (Optional)
:[[Hud_gauges.tbl#Origin:|Origin:]] (Optional, incompatible with [[Hud_gauges.tbl#Position:|Position:]], requires [[Hud_gauges.tbl#Offset:|Offset:]])
:[[Hud_gauges.tbl#Offset:|Offset:]] (Optional, incompatible with [[Hud_gauges.tbl#Position:|Position:]], requires [[Hud_gauges.tbl#Origin:|Origin:]])
}}
{{table3615|
:[[Hud_gauges.tbl#Cockpit Target:|Cockpit Target:]] (Optional)
::[[Hud_gauges.tbl#Canvas Size:|Canvas Size:]] (Optional)
::[[Hud_gauges.tbl#Display Offset:|Display Offset:]] (Optional)
::[[Hud_gauges.tbl#Display Size:|Display Size:]]
}}
:[[Hud_gauges.tbl#Color:|Color:]] (Optional)
:[[Hud_gauges.tbl#Font:|Font:]] (Optional)
:[[Hud_gauges.tbl#Slew:|Slew:]] (Optional)
:[[Hud_gauges.tbl#Filename:|Filename:]] (Optional)
:[[Hud_gauges.tbl#Text Offsets:|Text Offsets:]] (Optional)
:[[Hud_gauges.tbl#Value Offsets:|Value Offsets:]] (Optional)

====+Weapon Linking:====
Adds a gauge that indicates the selected weapons and their firing rates.

*Valid Sub-Entries:
:[[Hud_gauges.tbl#Position:|Position]] (Optional)
{{table371|
:[[Hud_gauges.tbl#Scale Gauge:|Scale Gauge:]] (Optional)
:[[Hud_gauges.tbl#Origin:|Origin:]] (Optional, incompatible with [[Hud_gauges.tbl#Position:|Position:]], requires [[Hud_gauges.tbl#Offset:|Offset:]])
:[[Hud_gauges.tbl#Offset:|Offset:]] (Optional, incompatible with [[Hud_gauges.tbl#Position:|Position:]], requires [[Hud_gauges.tbl#Origin:|Origin:]])
}}
{{table3615|
:[[Hud_gauges.tbl#Cockpit Target:|Cockpit Target:]] (Optional)
::[[Hud_gauges.tbl#Canvas Size:|Canvas Size:]] (Optional)
::[[Hud_gauges.tbl#Display Offset:|Display Offset:]] (Optional)
::[[Hud_gauges.tbl#Display Size:|Display Size:]]
}}
:[[Hud_gauges.tbl#Color:|Color:]] (Optional)
:[[Hud_gauges.tbl#Font:|Font:]] (Optional)
:[[Hud_gauges.tbl#Slew:|Slew:]] (Optional)
:[[Hud_gauges.tbl#Arc Filename:|Arc Filename:]] (Optional)
:[[Hud_gauges.tbl#Single Primary Filename:|Single Primary Filename:]] (Optional)
:[[Hud_gauges.tbl#Double Primary Filename:|Double Primary Filename:]] (Optional)
:[[Hud_gauges.tbl#Single Secondary Filename:|Single Secondary Filename:]] (Optional)
:[[Hud_gauges.tbl#Double Secondary Filename:|Double Secondary Filename:]] (Optional)
:[[Hud_gauges.tbl#Triple Secondary Filename:|Triple Secondary Filename:]] (Optional)
:[[Hud_gauges.tbl#Single Primary Offsets:|Single Primary Offsets:]] (Optional)
:[[Hud_gauges.tbl#Double Primary Offsets:|Double Primary Offsets:]] (Optional)
:[[Hud_gauges.tbl#Single Secondary Offsets:|Single Secondary Offsets:]] (Optional)
:[[Hud_gauges.tbl#Double Secondary Offsets:|Double Secondary Offsets:]] (Optional)
:[[Hud_gauges.tbl#Triple Secondary Offsets:|Triple Secondary Offsets:]] (Optional)

====+Fixed Messages:====

*Valid Sub-Entries:
:[[Hud_gauges.tbl#Position:|Position]] (Optional)
{{table371|
:[[Hud_gauges.tbl#Scale Gauge:|Scale Gauge:]] (Optional)
:[[Hud_gauges.tbl#Origin:|Origin:]] (Optional, incompatible with [[Hud_gauges.tbl#Position:|Position:]], requires [[Hud_gauges.tbl#Offset:|Offset:]])
:[[Hud_gauges.tbl#Offset:|Offset:]] (Optional, incompatible with [[Hud_gauges.tbl#Position:|Position:]], requires [[Hud_gauges.tbl#Origin:|Origin:]])
}}
{{table3615|
:[[Hud_gauges.tbl#Cockpit Target:|Cockpit Target:]] (Optional)
::[[Hud_gauges.tbl#Canvas Size:|Canvas Size:]] (Optional)
::[[Hud_gauges.tbl#Display Offset:|Display Offset:]] (Optional)
::[[Hud_gauges.tbl#Display Size:|Display Size:]]
}}
:[[Hud_gauges.tbl#Color:|Color:]] (Optional)
:[[Hud_gauges.tbl#Font:|Font:]] (Optional)

====+Flight Path Marker:====
{{table3615|
Adds a gauge that indicates the direction where your ship is traveling. Notably used by [[Diaspora]].

*Valid Sub-Entries:
:[[Hud_gauges.tbl#Color:|Color:]] (Optional)
:[[Hud_gauges.tbl#Filename:|Filename:]] (Optional)
:[[Hud_gauges.tbl#Center Offsets:|Center Offsets:]] (Optional)}}

====+Warhead Count:====
{{table3615|
Displays the name of the current secondary weapon. Tallies the ammo left. Notably used by [[Diaspora]].

*Valid Sub-Entries:
:[[Hud_gauges.tbl#Position:|Position:]] (Optional)
:[[Hud_gauges.tbl#Cockpit Target:|Cockpit Target:]] (Optional)
::[[Hud_gauges.tbl#Canvas Size:|Canvas Size:]] (Optional)
::[[Hud_gauges.tbl#Display Offset:|Display Offset:]] (Optional)
::[[Hud_gauges.tbl#Display Size:|Display Size:]]
:[[Hud_gauges.tbl#Color:|Color:]] (Optional)
:[[Hud_gauges.tbl#Font:|Font:]] (Optional)
:[[Hud_gauges.tbl#Slew:|Slew:]] (Optional)
:[[Hud_gauges.tbl#Filename:|Filename:]] (Optional)
:[[Hud_gauges.tbl#Name Offsets:|Name Offsets:]] (Optional)
:[[Hud_gauges.tbl#Count Offsets:|Count Offsets:]] (Optional)
:[[Hud_gauges.tbl#Icon Width:|Icon Width:]] (Optional)
:[[Hud_gauges.tbl#Icon Height:|Icon Height:]] (Optional)
:[[Hud_gauges.tbl#Max Icons:|Max Icons:]] (Optional)
:[[Hud_gauges.tbl#Max Columns:|Max Columns:]] (Optional)
:[[Hud_gauges.tbl#Name Alignment:|Name Alignment:]] (Optional)
}}

====+Hardpoints:====
{{table3615|
Draws a silhouette of the player's ship and mounted weapons. Notably used by [[Diaspora]].

*Valid Sub-Entries:
:[[Hud_gauges.tbl#Position:|Position:]] (Optional)
:[[Hud_gauges.tbl#Cockpit Target:|Cockpit Target:]] (Optional)
::[[Hud_gauges.tbl#Canvas Size:|Canvas Size:]] (Optional)
::[[Hud_gauges.tbl#Display Offset:|Display Offset:]] (Optional)
::[[Hud_gauges.tbl#Display Size:|Display Size:]]
:[[Hud_gauges.tbl#Color:|Color:]] (Optional)
:[[Hud_gauges.tbl#Size:|Size:]] (Optional)
:[[Hud_gauges.tbl#Line Width:|Line Width:]] (Optional)
:[[Hud_gauges.tbl#View Direction:|View Direction:]] (Optional)
:[[Hud_gauges.tbl#Show Primary Weapons:|Show Primary Weapons:]] (Optional)
:[[Hud_gauges.tbl#Show Secondary Weapons:|Show Secondary Weapons:]] (Optional)
}}

====+Primary Weapons:====
{{table3615|
Like the Weapons gauge but simpler. Only displays primary weapons. Notably used by [[Diaspora]].

*Valid Sub-Entries:
:[[Hud_gauges.tbl#Position:|Position:]] (Optional)
:[[Hud_gauges.tbl#Cockpit Target:|Cockpit Target:]] (Optional)
::[[Hud_gauges.tbl#Canvas Size:|Canvas Size:]] (Optional)
::[[Hud_gauges.tbl#Display Offset:|Display Offset:]] (Optional)
::[[Hud_gauges.tbl#Display Size:|Display Size:]]
:[[Hud_gauges.tbl#Color:|Color:]] (Optional)
:[[Hud_gauges.tbl#Font:|Font:]] (Optional)
:[[Hud_gauges.tbl#Slew:|Slew:]] (Optional)
:[[Hud_gauges.tbl#Header Offsets:|Header Offsets:]] (Optional)
:[[Hud_gauges.tbl#Header Text:|Header Text:]] (Optional)
:[[Hud_gauges.tbl#First Background Filename:|First Background Filename:]] (Optional)
:[[Hud_gauges.tbl#First Background Height:|First Background Height:]] (Optional)
:[[Hud_gauges.tbl#First Background X-offset:|First Background X-offset:]] (Optional)
:[[Hud_gauges.tbl#Entry Background Filename:|Entry Background Filename:]] (Optional)
:[[Hud_gauges.tbl#Entry Background Height:|Entry Background Height:]] (Optional)
:[[Hud_gauges.tbl#Entry Background X-offset:|Entry Background X-offset:]] (Optional)
:[[Hud_gauges.tbl#Last Background Filename:|Last Background Filename:]] (Optional)
:[[Hud_gauges.tbl#Last Background X-offset:|Last Background X-offset:]] (Optional)
:[[Hud_gauges.tbl#Last Background Y-offset:|Last Background Y-offset:]] (Optional)
:[[Hud_gauges.tbl#Entry Height:|Entry Height:]] (Optional)
:[[Hud_gauges.tbl#List Start Y-offset:|List Start Y-offset:]] (Optional)
:[[Hud_gauges.tbl#Ammo X-offset:|Ammo X-offset:]] (Optional)
:[[Hud_gauges.tbl#Link X-offset:|Link X-offset:]] (Optional)
:[[Hud_gauges.tbl#Name X-offset:|Name X-offset:]] (Optional)
}}

====+Secondary Weapons:====
{{table3615|
Like the Weapons gauge but simpler. Only displays secondary weapons. Notably used by [[Diaspora]].

*Valid Sub-Entries:
:[[Hud_gauges.tbl#Position:|Position:]] (Optional)
:[[Hud_gauges.tbl#Cockpit Target:|Cockpit Target:]] (Optional)
::[[Hud_gauges.tbl#Canvas Size:|Canvas Size:]] (Optional)
::[[Hud_gauges.tbl#Display Offset:|Display Offset:]] (Optional)
::[[Hud_gauges.tbl#Display Size:|Display Size:]]
:[[Hud_gauges.tbl#Color:|Color:]] (Optional)
:[[Hud_gauges.tbl#Font:|Font:]] (Optional)
:[[Hud_gauges.tbl#Slew:|Slew:]] (Optional)
:[[Hud_gauges.tbl#Header Offsets:|Header Offsets:]] (Optional)
:[[Hud_gauges.tbl#Header Text:|Header Text:]] (Optional)
:[[Hud_gauges.tbl#First Background Filename:|First Background Filename:]] (Optional)
:[[Hud_gauges.tbl#First Background Height:|First Background Height:]] (Optional)
:[[Hud_gauges.tbl#First Background X-offset:|First Background X-offset:]] (Optional)
:[[Hud_gauges.tbl#Entry Background Filename:|Entry Background Filename:]] (Optional)
:[[Hud_gauges.tbl#Entry Background Height:|Entry Background Height:]] (Optional)
:[[Hud_gauges.tbl#Entry Background X-offset:|Entry Background X-offset:]] (Optional)
:[[Hud_gauges.tbl#Last Background Filename:|Last Background Filename:]] (Optional)
:[[Hud_gauges.tbl#Last Background X-offset:|Last Background X-offset:]] (Optional)
:[[Hud_gauges.tbl#Last Background Y-offset:|Last Background Y-offset:]] (Optional)
:[[Hud_gauges.tbl#Entry Height:|Entry Height:]] (Optional)
:[[Hud_gauges.tbl#List Start Y-offset:|List Start Y-offset:]] (Optional)
:[[Hud_gauges.tbl#Ammo X-offset:|Ammo X-offset:]] (Optional)
:[[Hud_gauges.tbl#Link X-offset:|Link X-offset:]] (Optional)
:[[Hud_gauges.tbl#Name X-offset:|Name X-offset:]] (Optional)
:[[Hud_gauges.tbl#Unlink X-offset:|Unlink X-offset:]] (Optional)
:[[Hud_gauges.tbl#Reload X-offset:|Reload X-offset:]] (Optional)
}}

===$End Gauges===
The Gauges section must end with $End Gauges. No Exceptions.

==#End==
The very last entry in the Hud_gauges.tbl must be #End. No Exceptions.

----
----

==Gauge Configuration Options==
Since a vast majority of gauges share the same entries, the configuration options for each gauge have been grouped here for formatting consistency.

====Position:====
Defines the screen coordinates for the upper left corner of this gauge.

*Syntax: '''Integer''' horizontal pixel, '''Integer''' vertical pixel position

Used by: [[Hud_gauges.tbl#+Custom:|+Custom:]], [[Hud_gauges.tbl#+Training Messages:|+Training Messages:]], [[Hud_gauges.tbl#+Support:|+Support]] (and many others)

====Scale Gauge:====

{{table371|
Define if a gauge size will scale or not.

If false then gauge bitmaps will always show at their original size which may result in gauges being very small at high resolutions.

If true then gauge bitmaps will scale in proportion to the current resolution vs the base HUD resolution in use. This may result in gauges becoming blurry at non-base resolutions.

Defaults to yes/true.

Incompatible with [[Hud_gauges.tbl#Position:|Position:]]

*Syntax: '''Boolean''' scale_this_gauge

Used by: most gauges
}}

====Origin:====

{{table371|
Define gauge position as a ratio of the screen size (base or current, it doesn't matter).

Requires [[Hud_gauges.tbl#Offset:|Offset:]]

Incompatible with [[Hud_gauges.tbl#Position:|Position:]]

*Syntax: '''Float''' horizontal ratio 0.0 - 1.0, '''Float''' vertical ratio 0.0 - 1.0

Used by: most gauges
}}

====Offset:====

{{table371|
Define gauge offset from [[Hud_gauges.tbl#Origin:|Origin:]] in base resolution pixels

Requires [[Hud_gauges.tbl#Origin:|Origin:]]

Incompatible with [[Hud_gauges.tbl#Position:|Position:]]

*Syntax: '''Integer''' horizontal pixel offset from Origin:, '''Integer''' vertical pixel offset from Origin:

Used by: most gauges
}}

====Cockpit Target:====
The cockpit display that this gauge will be rendered to. Refers to the +Display Name: defined in [[ships.tbl#$Cockpit Display:|$Cockpit Display:]].

*Syntax: '''String''' String defined in +Display Name: in [[ships.tbl#$Cockpit Display:|$Cockpit Display:]]

=====Canvas Size:=====
The off-screen canvas this gauge will be rendered to before being interpolated into the actual cockpit display. The smaller this number is, the larger the gauge will appear on the cockpit display.

*Syntax: '''Integer''' width, '''Integer''' height

=====Display Offset:=====
The position of the canvas on the cockpit display texture

*Syntax: '''Integer''' width, '''Integer''' height

=====Display Size:=====
The interpolated size on the cockpit display texture that the canvas will be rendered to.

*Syntax: '''Integer''' width, '''Integer''' height

====Color:====
Optional. Overrides both previous color settings ([[Hud_gauges.tbl#$Color: 1|$Color]] HUD option and [[Hud_gauges#$Color: 2|$Color]] ship class option) for this particular gauge.

*Syntax: See [[Hud_gauges.tbl#$Color: 1|$Color:]]

Used by: [[Hud_gauges.tbl#+Custom:|+Custom:]], [[Hud_gauges.tbl#+Support:|+Support]]

====Font:====
Optional. Overrides both previous font settings ([[Hud_gauges.tbl#$Font: 1|$Font]] HUD option and [[Hud_gauges#$Font: 2|$Font]] ship class option) for this particular gauge.

*Syntax: See [[Hud_gauges.tbl#$Font: 1|$Font:]]

Used by: [[Hud_gauges.tbl#+Custom:|+Custom:]], [[Hud_gauges.tbl#+Training Messages:|+Training Messages:]], [[Hud_gauges.tbl#+Support:|+Support]]

====Name:====
Defines the name of this custom gauge.

*Syntax: '''String'''
*Max Length: 32 characters

Used by: [[Hud_gauges.tbl#+Custom:|+Custom:]]

====Text:====
Default text to be displayed. Can be altered using the hud-set-message, hud-set-text and hud-set-directive sexps.

*Syntax: '''String'''
*Max Length: 32 characters

Used by: [[Hud_gauges.tbl#+Custom:|+Custom:]]

====X Offset:====
Optional. Defines the horizontal pixel offset (from the gauge's origin as defined by [[Hud_gauges.tbl#Position:|Position:]]) that the Text will be displayed.

*Syntax: '''Integer'''
*Units: Pixels

Used by: [[Hud_gauges.tbl#+Custom:|+Custom:]]

====Y Offset:====
Optional. Defines the vertical pixel offset (from the gauge's origin defined by [[Hud_gauges.tbl#Position:|Position:]]) that the Text will be displayed.

*Syntax: '''Integer'''
*Units: Pixels

Used by: [[Hud_gauges.tbl#+Custom:|+Custom:]]

====Gauge Type:====
Defines the type of gauge this is.

*Syntax: '''String'''
*Valid Values: Any one of the possible [[gauge types]].

Used by: [[Hud_gauges.tbl#+Custom:|+Custom:]]

====Slew:====
Optional. Determines whether or not this gauge is affected by afterburner shaking or similar effects. If set to "true", the gauge will not follow the player's head movements when using TrackIR/padlock. i.e. should be used for gauges like the gunsight/leadsight.

*Syntax: '''Boolean'''

Used by: [[Hud_gauges.tbl#+Custom:|+Custom:]], [[Hud_gauges.tbl#+Support:|+Support]]

====Max Lines:====
Optional. Specifies the maximum number of message lines that are displayed.

*Syntax: '''Integer'''
*Default Value: 3

Used by: [[Hud_gauges.tbl#+Messages:|+Messages:]]

====Max Width:====
Optional. Determines how long each message line may be.

*Syntax: '''Integer'''
*Units: Pixels

Used by: [[Hud_gauges.tbl#+Messages:|+Messages:]]

====Line Height:====
Optional. Determines the distance between line origins. (i.g. for a 12pt Font, there are needs to be at least 12 pixels between the bottom of one line and the next, otherwise the text will overlap each)

*Syntax: '''Integer'''
*Units: Pixels
*Default Value: 12

Used by: [[Hud_gauges.tbl#+Messages:|+Messages:]]

====Total Lifetime:====
Optional. Determines the maximum time the message gauge will be displayed from the time a new message is received.

*Syntax: '''Integer'''
*Units: milliseconds
*Default Value: 14000 (14 seconds)

Used by: [[Hud_gauges.tbl#+Messages:|+Messages:]]

====Scroll Time:====
Optional. Determines the time for the messages to scroll up one step.( See [[Hud_gauges.tbl#Step Size:|Step Size:]] )

*Syntax: '''Integer'''
*Units: milliseconds
*Default Value: 30

Used by: [[Hud_gauges.tbl#+Messages:|+Messages:]]

====Step Size:====
Optional. Determines how many pixels to shift message lines during scrolling. Messages will be shifted up by this amount until they are on the next line (as defined by [[Hud_gauges.tbl#Line Height:|Line Height:]])

*Syntax: '''Integer'''
*Units: Pixels
*Default Value: 3

Used by: [[Hud_gauges.tbl#+Messages:|+Messages:]]

====Active by default:====
Optional. Determines whether or not this gauge is always active, or only available after being activated via sexp.

*Syntax: '''Boolean'''

Used by: [[Hud_gauges.tbl#+Custom:|+Custom:]]

====Filename:====
Designates the [[Multimedia_Files#ANI|.ANI]] or [[Multimedia_Files#EFF|.EFF]] used for this gauge's background graphic.
{{Note| All HUD .ANI's must have the same color palette as the retail .ANI's in order to render properly. (.EFF's do not have this restriction)}}

*Syntax: '''Filename'''
**No filename extension is needed.

Used by: [[Hud_gauges.tbl#+Custom:|+Custom:]], [[Hud_gauges.tbl#+Support:|+Support]]

====Top Background Filename:====
Optional. Designates which file to use for the top background. (?)

*Syntax: '''Filename'''

Used by: [[Hud_gauges.tbl#+Damage|+Damage]]

====Bottom Background Filename:====
Optional. Designates which file to use for the Bottom background (?)

*Syntax: '''Filename'''

Used by: [[Hud_gauges.tbl#+Damage|+Damage]]

====Left Background Filename:====
Optional. Designates which file to use for the Left background (?)

*Syntax: '''Filename'''

Used by: [[Hud_gagues.tbl#+Wingman Status:|+Wingman Status:]]

====Right Background Filename:====
Optional. Designates which file to use for the Right background (?)

*Syntax: '''Filename'''

Used by: [[Hud_gagues.tbl#+Wingman Status:|+Wingman Status:]]

====Entry Background Filename:====
Optional. Designates which file to use for the Entry background

*Syntax: '''Filename'''

Used by: [[Hud_gauges.tbl#+Damage|+Damage]], [[Hud_gagues.tbl#+Wingman Status:|+Wingman Status:]]

====Primary List Top Background Filename:====
Optional. Designates which file to use for the Primary List Top Background

Used by: [[Hud_gauges.tbl#+Weapons:|+Weapons:]]

====Primary List Middle Background Filename:====
Optional. Designates which file to use for the Primary List Middle Background

Used by: [[Hud_gauges.tbl#+Weapons:|+Weapons:]]

====Primary List Bottom Background Filename:====
Optional. Designates which file to use for the Primary List Bottom Background

Used by: [[Hud_gauges.tbl#+Weapons:|+Weapons:]]

====Secondary List Top Background Filename:====
Optional. Designates which file to use for the Secondary List Top Background

Used by: [[Hud_gauges.tbl#+Weapons:|+Weapons:]]

====Secondary List Entry Background Filename:====
Optional. Designates which file to use for the Secondary List Entry Background

Used by: [[Hud_gauges.tbl#+Weapons:|+Weapons:]]

====Secondary List Bottom Background Filename:====
Optional. Designates which file to use for the Secondary List Bottom Background

Used by: [[Hud_gauges.tbl#+Weapons:|+Weapons:]]

====Dot Filename:====
Optional. Designates which file to use for the wingman graphic (a.k.a. the Dot)

*Syntax: '''Filename'''

Used by: [[Hud_gagues.tbl#+Wingman Status:|+Wingman Status:]]

====Header Offsets:====
Optional. Designates the offset from the gauge's upper left corner for the Support Ship header (?)

*Syntax: '''Integer''' horizontal offset, '''Integer''' vertical offset
*Units: Pixels

Used by: [[Hud_gauges.tbl#+Support:|+Support:]], [[Hud_gauges.tbl#+Damage|+Damage:]]

====Text Y-offset:====
Optional. Designates the offset from the gauge's upper left corner for the Support Ship Text. (?)

*Syntax: '''Integer''' vertical offset
*Units: Pixels

Used by: [[Hud_gauges.tbl#+Support:|+Support:]]

====Text Offsets:====
Optional. Defines the screen position offsets for the text label.

*Syntax: '''Integer''' horizontal position, '''Integer''' vertical position
*Units: Pixels

Used by: :[[Hud_gauges.tbl#+Countermeasures:|+Countermeasures:]]

====Value Offsets:====
Optional. Defines the screen position offsets for the value label.

*Syntax: '''Integer''' horizontal position, '''Integer''' vertical position
*Units: Pixels

Used by: :[[Hud_gauges.tbl#+Countermeasures:|+Countermeasures:]]

====Dock Status X-offset:====
Optional. Designates the offset from the gauge's upper left corner for the Support Ship's dock status. (?)

*Syntax: '''Integer''' vertical offset
*Units: Pixels

Used by: [[Hud_gauges.tbl#+Support:|+Support:]]

====Dock Time X-offset:====
Optional. Designates the offset from the gauge's upper left corner for the Support Ship's dock time. (?)

*Syntax: '''Integer''' vertical offset
*Units: Pixels

Used by: [[Hud_gauges.tbl#+Support:|+Support:]]

====Hull Integrity Offsets:====
Optional. Designates the offsets from the gauge's upper left corner for the for the Damage gauge Hull integrity textbox(?)

*Syntax: '''Integer''' horizontal offset, '''Integer''' vertical offset
*Units: Pixels

Used by: [[Hud_gauges.tbl#+Damage:|+Damage:]]

====Hull Integrity Value X-offset:====
Optional. Designates the offsets from the hull integrity textbox's upper left corner for the hull integrity value. (?)

*Syntax: '''Integer''' horizontal offset
*Units: Pixels

Used by: [[Hud_gauges.tbl#+Damage:|+Damage:]]

====Top Background Height:====
Optional. Designates the height of the Top background (?)

*Syntax: '''Integer'''
*Units: Pixels

Used by: [[Hud_gauges.tbl#+Damage:|+Damage:]]

====Left Background Width:====
Optional. Defines the width of the Left Background.

*Syntax: '''Integer'''
*Units: Pixels

Used by: [[Hud_gagues.tbl#+Wingman Status:|+Wingman Status:]]

====Entry Width:====
Optional. Defines the width of the Entry Background (?)

*Syntax: '''Integer'''
*Units: Pixels

Used by: [[Hud_gagues.tbl#+Wingman Status:|+Wingman Status:]]

====Subsystem Entry Height:====
Optional. Designates the height of the Subsystem entry (?)

*Syntax: '''Integer'''
*Units: Pixels

Used by: [[Hud_gauges.tbl#+Damage:|+Damage:]]

====Subsystem List Start Offsets:====
Optional. Designates the offsets from the gauge's upper left corner for the for the start of the Subsytem List (?)

*Syntax: '''Integer''' horizontal offset, '''Integer''' vertical offset
*Units: Pixels

Used by: [[Hud_gauges.tbl#+Damage:|+Damage:]]

====Subsystem Entry Value X-offset:====
Optional. Designates the horizontal offset from the Subsystem List's position (?)

*Syntax: '''Integer'''
*Units: Pixels

Used by: [[Hud_gauges.tbl#+Damage:|+Damage:]]

====Single Wing Offsets:====
Optional. Designates the offset from the gauge's upper left corner for a single wing (?)

*Syntax: '''Integer''' horizontal offset, '''Integer''' vertical offset
*Units: Pixels

Used by: [[Hud_gagues.tbl#+Wingman Status:|+Wingman Status:]]

====Multiple Wing Start Offsets:====
Optional. Designates the offset from the gauge's upper left corner for multiple wings (?)

*Syntax: '''Integer''' horizontal offset, '''Integer''' vertical offset
*Units: Pixels

Used by: [[Hud_gagues.tbl#+Wingman Status:|+Wingman Status:]]

====Wing Name Offsets:====
Optional. Designates the offset from the gauge's upper left corner for the Support Ship header (?)

*Syntax: '''Integer''' horizontal offset, '''Integer''' vertical offset
*Units: Pixels

Used by: [[Hud_gagues.tbl#+Wingman Status:|+Wingman Status:]]

====Dot Offsets:====
Optional. Designates the offset from the gauge's upper left corner for the All wingman status icons.
*Syntax:
:'''Integer''' x, '''Integer''' y ;; Wingman 1
:'''Integer''' x, '''Integer''' y ;; Wingman 2
:'''Integer''' x, '''Integer''' y ;; Wingman 3
:'''Integer''' x, '''Integer''' y ;; Wingman 4
:'''Integer''' x, '''Integer''' y ;; Wingman 5
*Units: Pixels

{{Warning|
All 5 wingman positions must be defined}}

Used by: [[Hud_gagues.tbl#+Wingman Status:|+Wingman Status:]]

====Expansion Mode:====
Optional. Denotes which direction (in relation to the player's wing) that the other wings should be appended to the gauge

*Syntax: '''String'''
*Valid Values:
:*"Right" ;; Wings are added to the right of the previous wing

Used by: [[Hud_gagues.tbl#+Wingman Status:|+Wingman Status:]]

====Auto Offsets:====
Optional. Defines the screen coordinates for the "Auto" text label.

*Syntax: '''Integer''' horizontal position, '''Integer''' vertical position
*Units: Pixels

Used by: [[Hud_gagues.tbl#+Auto Speed:|+Auto Speed:]], [[Hud_gagues.tbl#+Auto Target:|+Auto Target:]]

====Speed Offsets:====
Optional. Defines the screen coordinates for the "Speed" text label.

*Syntax: '''Integer''' horizontal position, '''Integer''' vertical position
*Units: Pixels

Used by: [[Hud_gagues.tbl#+Auto Speed:|+Auto Speed:]]

====Target Offsets:====
Optional. Defines the screen coordinates for the "Target" text label.

*Syntax: '''Integer''' horizontal position, '''Integer''' vertical position
*Units: Pixels

Used by: [[Hud_gauges.tbl#+Auto Target:|+Auto Target:]]

====Animation Offsets:====
Optional. Defines the offsets for the animation graphics.

*Syntax: '''Integer''' horizontal offset, '''Integer''' vertical offset
*Units: Pixels

Used by: [[Hud_gauges.tbl#+Talking Head:|+Talking Head:]]

====Animation Background Size:====
Optional. Defines the size of the animation's background (?)

*Syntax: '''Integer''' horizontal offset, '''Integer''' vertical offset
*Units: Pixels

Used by: [[Hud_gauges.tbl#+Talking Head:|+Talking Head:]]

====List Start Offsets:====
Optional. Defines the screen coordinate offsets for the start of the Directives list.

*Syntax: '''Integer''' x, '''Integer''' y
*Units: Pixels

Used by: [[Hud_guages.tbl#+Directives:|+Directives:]]

====Entry Height:====
Optional. Defines the height of each Directive

*Syntax: '''Integer'''
*Units: Pixels

Used by: [[Hud_guages.tbl#+Directives:|+Directives:]]

====Top Primary Background X-offset:====
Optional. Defines the screen coordinate offset for the Top Primary Background

*Syntax: '''Integer'''
*Units: Pixels

Used by: [[Hud_gauges.tbl#+Weapons:|+Weapons:]]

====Text X-offset:====

Used by: [[Hud_gauges.tbl#+Weapons:|+Weapons:]]

====Top Primary Frame Height:====

Used by: [[Hud_gauges.tbl#+Weapons:|+Weapons:]]

====Top Secondary Frame Height:====

Used by: [[Hud_gauges.tbl#+Weapons:|+Weapons:]]

====Primary List Start Y-offset:====

Used by: [[Hud_gauges.tbl#+Weapons:|+Weapons:]]

====Secondary List Start Y-offset:====

Used by: [[Hud_gauges.tbl#+Weapons:|+Weapons:]]

====Primary Weapon Ammo X-offset:====

Used by: [[Hud_gauges.tbl#+Weapons:|+Weapons:]]

====Primary Weapon Link X-offset:====

Used by: [[Hud_gauges.tbl#+Weapons:|+Weapons:]]

====Primary Weapon Name X-offset:====

Used by: [[Hud_gauges.tbl#+Weapons:|+Weapons:]]

====Secondary Weapon Ammo X-offset:====

Used by: [[Hud_gauges.tbl#+Weapons:|+Weapons:]]

====Secondary Weapon Linked X-offset:====

Used by: [[Hud_gauges.tbl#+Weapons:|+Weapons:]]

====Secondary Weapon Name X-offset:====

Used by: [[Hud_gauges.tbl#+Weapons:|+Weapons:]]

====Secondary Weapon Reload X-offset:====

Used by: [[Hud_gauges.tbl#+Weapons:|+Weapons:]]

====Primary Weapon Entry Height:====

Used by: [[Hud_gauges.tbl#+Weapons:|+Weapons:]]

====Secondary Weapon Entry Height:====

Used by: [[Hud_gauges.tbl#+Weapons:|+Weapons:]]

====3 Digit Hull Offsets:====
Designates the screen position offsets for the hull damage % when it is the 3 digit range (i.e. >= 100%)

*Syntax: '''Integer''' x offset, '''Integer''' y offset
*Units: Pixels

Used by: [[Hud_gauges.tbl#+Mini Target Shields:|+Mini Target Shields:]]

====2 Digit Hull Offsets:====
Designates the screen position offsets for the hull damage % when it is the 2 digit range (i.e. 100% > hull damage% >= 10%)

*Syntax: '''Integer''' x offset, '''Integer''' y offset
*Units: Pixels

Used by: [[Hud_gauges.tbl#+Mini Target Shields:|+Mini Target Shields:]]

====1 Digit Hull Offsets:====
Designates the screen position offsets for the hull damage % when it is the 1 digit range (i.e. 10% > hull damage% >= 0%)

*Syntax: '''Integer''' x offset, '''Integer''' y offset
*Units: Pixels

Used by: [[Hud_gauges.tbl#+Mini Target Shields:|+Mini Target Shields:]]

====Objective Text Y-offset:====
Designates the screen position offset for the Objective label

*Syntax: '''Integer''' y offset
*Units: Pixels

Used by: [[Hud_gauges.tbl#+Objective notify:|+Objective notify:]]

====Objective Value Y-offset====
Designates the screen position offset for the Objective value

*Syntax: '''Integer''' y offset
*Units: Pixels

Used by: [[Hud_gauges.tbl#+Objective notify:|+Objective notify:]]

====Subspace Text Y-offset:====
Designates the screen position offset for the Subspace label

*Syntax: '''Integer''' y offset
*Units: Pixels

Used by: [[Hud_gauges.tbl#+Objective notify:|+Objective notify:]]

====Subspace Value Y-offset====
Designates the screen position offset for the Subspace value (?)

*Syntax: '''Integer''' y offset
*Units: Pixels

Used by: [[Hud_gauges.tbl#+Objective notify:|+Objective notify:]]

====Red Alert Text Y-offset====
Designates the screen position offset for the Red Alert label

*Syntax: '''Integer''' y offset
*Units: Pixels

Used by: [[Hud_gauges.tbl#+Objective notify:|+Objective notify:]]

====Red Alert Value Y-offset====
Designates the screen position offset for the Red Alert value (?)

*Syntax: '''Integer''' y offset
*Units: Pixels

Used by: [[Hud_gauges.tbl#+Objective notify:|+Objective notify:]]

====Command X-offset:====
*Syntax: '''Integer''' x offset
*Units: Pixels

Used by: [[Hud_gauges.tbl#+Squad Message:|+Squad Message:]]

====Page Up Offsets:====
*Syntax: '''Integer''' x offset, '''Integer''' y offset
*Units: Pixels

Used by: [[Hud_gauges.tbl#+Squad Message:|+Squad Message:]]

====Page Down Offsets:====
*Syntax: '''Integer''' x offset, ''' Integer y offset
*Units: Pixels

Used by: [[Hud_gauges.tbl#+Squad Message:|+Squad Message:]]

====Entry Height:====

Used by: [[Hud_gauges.tbl#+Escort View:|+Escort View:]]

====Entry Stagger Width:====

Used by: [[Hud_gauges.tbl#+Escort View:|+Escort View:]]

====Header Text:====

Used by: [[Hud_gauges.tbl#+Escort View:|+Escort View:]]

====Header Offsets:====

Used by: [[Hud_gauges.tbl#+Escort View:|+Escort View:]]

====List Start Offsets:====

Used by: [[Hud_gauges.tbl#+Escort View:|+Escort View:]]

====Hull X-offset:====

Used by: [[Hud_gauges.tbl#+Escort View:|+Escort View:]]

====Name X-offset:====

Used by: [[Hud_gauges.tbl#+Escort View:|+Escort View:]]

====Status X-offset:====

Used by: [[Hud_gauges.tbl#+Escort View:|+Escort View:]]

====Foreground Clip Height:====

Used by: [[Hud_gauges.tbl#+ETS Retail:|+ETS Retail:]]

====Letter Offsets:====

Used by: [[Hud_gauges.tbl#+ETS Retail:|+ETS Retail:]]

====Top Offsets:====

Used by: [[Hud_gauges.tbl#+ETS Retail:|+ETS Retail:]]

====Bottom Offsets:====

Used by: [[Hud_gauges.tbl#+ETS Retail:|+ETS Retail:]]

====Gauge Offset:====
*Distance between the individual weapon/shield/engine ETS gauges that comprise this gauge
*Syntax: '''Integer'''

Used by: [[Hud_gauges.tbl#+ETS Retail:|+ETS Retail:]]

====Monitor Filename:====

Used by: [[Hud_gauges.tbl#+Target Monitor:|+Target Monitor:]]

====Integrity Bar Filename:====

Used by: [[Hud_gauges.tbl#+Target Monitor:|+Target Monitor:]]

====Viewport Offsets:====

Used by: [[Hud_gauges.tbl#+Target Monitor:|+Target Monitor:]]

====Viewport Size:====

Used by: [[Hud_gauges.tbl#+Target Monitor:|+Target Monitor:]]

====Integrity Bar Offsets:====

Used by: [[Hud_gauges.tbl#+Target Monitor:|+Target Monitor:]]

====Integrity Bar Foreground Clip Height:====

Used by: [[Hud_gauges.tbl#+Target Monitor:|+Target Monitor:]]

====Status Offsets:====

Used by: [[Hud_gauges.tbl#+Target Monitor:|+Target Monitor:]]

====Name Offsets:====

Used by: [[Hud_gauges.tbl#+Target Monitor:|+Target Monitor:]]

====Class Offsets:====

Used by: [[Hud_gauges.tbl#+Target Monitor:|+Target Monitor:]]

====Distance Offsets:====

Used by: [[Hud_gauges.tbl#+Target Monitor:|+Target Monitor:]]

====Speed Offsets:====

Used by: [[Hud_gauges.tbl#+Target Monitor:|+Target Monitor:]]

====Hull Offsets:====

Used by: [[Hud_gauges.tbl#+Target Monitor:|+Target Monitor:]]

====Cargo Contents Offsets:====

Used by: [[Hud_gauges.tbl#+Target Monitor:|+Target Monitor:]]

====Cargo Scan Start Offsets:====

Used by: [[Hud_gauges.tbl#+Target Monitor:|+Target Monitor:]]

====Cargo Scan Size:====

Used by: [[Hud_gauges.tbl#+Target Monitor:|+Target Monitor:]]

====Bracket Offsets:====

Used by: [[Hud_gauges.tbl#+Extra Target Data:|+Extra Target Data:]]

====Dock Offsets:====

Used by: [[Hud_gauges.tbl#+Extra Target Data:|+Extra Target Data:]]

====Order Offsets:====

Used by: [[Hud_gauges.tbl#+Extra Target Data:|+Extra Target Data:]]

====Time Offsets:====

Used by: [[Hud_gauges.tbl#+Extra Target Data:|+Extra Target Data:]]

====Infinity Distance Offsets:====

Used by: [[Hud_gauges.tbl#+Radar:|+Radar:]]

Offset to draw the infinity radar range symbol.

====Long Distance Offsets:====

Used by: [[Hud_gauges.tbl#+Radar:|+Radar:]]

Offset to draw the long range radar text (i.e. 10k).

====Short Distance Offsets:====

Used by: [[Hud_gauges.tbl#+Radar:|+Radar:]]

Offset to draw the short range radar text (i.e. 2k).

====Size:====

Used by: [[Hud_gauges.tbl#+Radar BSG:|+Radar BSG:]]

====XY Disc Filename:====

Used by: [[Hud_gauges.tbl#+Radar BSG:|+Radar BSG:]]

====XZ YZ Disc Filename:====

Used by: [[Hud_gauges.tbl#+Radar BSG:|+Radar BSG:]]

====Sweep Disc Filename:====

Used by: [[Hud_gauges.tbl#+Radar BSG:|+Radar BSG:]]

====Default Contact Filename:====

Used by: [[Hud_gauges.tbl#+Radar BSG:|+Radar BSG:]]

====Unknown Contact Filename:====

Used by: [[Hud_gauges.tbl#+Radar BSG:|+Radar BSG:]]

====Loop Volume:====

Used by: [[Hud_gauges.tbl#+Radar BSG:|+Radar BSG]]

====Minimum Beep Delay:====

Used by: [[Hud_gauges.tbl#+Radar BSG:|+Radar BSG]]

====Foreground Clip Height:====

Used by: [[Hud_gauges.tbl#+Afterburner Energy:|+Afterburner Energy:]]

====Firepoint display:====
Displays the positions of the gun firepoints on your ship
*Syntax: '''Boolean''', YES or NO

NOTE: The position of the firepoints is calculated from the Eye Point position in the POF. You may encounter weird results if you have no Eye Point defined, but no debug warnings will be raised.

Used by: [[Hud_gauges.tbl#+Center Reticle:|+Center Reticle]]

====Firepoint size:====
Diameter of the gunpoint circles. '''Must be 4 or greater''' in order to work properly.
*Syntax: '''Integer'''

Used by: [[Hud_gauges.tbl#+Center Reticle:|+Center Reticle]]

====Firepoint X coordinate multiplier:====
Used by: [[Hud_gauges.tbl#+Center Reticle:|+Center Reticle]]

====Firepoint Y coordinate multiplier:====
Used by: [[Hud_gauges.tbl#+Center Reticle:|+Center Reticle]]

====Foreground Clip Bottom Y-offset:====

Used by: [[Hud_gauges.tbl#+Throttle:|+Throttle:]]

====Foreground Clip Width:====

Used by: [[Hud_gauges.tbl#+Throttle:|+Throttle:]]

====Foreground Clip Height:====

Used by: [[Hud_gauges.tbl#+Throttle:|+Throttle:]]

====Afterburner Clip Height:====

Used by: [[Hud_gauges.tbl#+Throttle:|+Throttle:]]

====Show Background:====

Used by: [[Hud_gauges.tbl#+Throttle:|+Throttle:]]

====Max Speed Label Offsets:====

Used by: [[Hud_gauges.tbl#+Throttle:|+Throttle:]]

====Min Speed Label Offsets:====

Used by: [[Hud_gauges.tbl#+Throttle:|+Throttle:]]

====Orbit Center Offsets:====

Used by: [[Hud_gauges.tbl#+Throttle:|+Throttle:]]

====Orbit Radius:====

Used by: [[Hud_gauges.tbl#+Throttle:|+Throttle:]]

====Arc Filename:====
*Filename for the background graphic for this gauge
*Syntax: '''Filename'''

Used by: [[Hud_gauges.tbl#+Threat Indicator:|+Threat Indicator:]]

====Dumbfire Filename:====
*Filename for the background graphic for this gauge
*Syntax: '''Filename'''

Used by: [[Hud_gauges.tbl#+Threat Indicator:|+Threat Indicator:]]

====Lock Filename:====
*Filename for the background graphic for this gauge
*Syntax: '''Filename'''

Used by: [[Hud_gauges.tbl#+Threat Indicator:|+Threat Indicator:]]

====Dumbfire Offsets:====
*Filename for the background graphic for this gauge
*Syntax: '''Filename'''

Used by: [[Hud_gauges.tbl#+Threat Indicator:|+Threat Indicator:]]

====Lock Offsets:====
*Filename for the background graphic for this gauge
*Syntax: '''Filename'''

Used by: [[Hud_gauges.tbl#+Threat Indicator:|+Threat Indicator:]]

====Lock Filename:====

Used by: [[Hud_gauges.tbl#+Lock Indicator:|+Lock Indicator:]]

====Locked Filename:====

Used by: [[Hud_gauges.tbl#+Lock Indicator:|+Lock Indicator:]]

====Lock Center Offsets:====

Used by: [[Hud_gauges.tbl#+Lock Indicator:|+Lock Indicator:]]

====Locked Center Offsets:====

Used by: [[Hud_gauges.tbl#+Lock Indicator:|+Lock Indicator:]]

====Radius:====
Defines the distance from the center of the screen to the base of the Hostile Triangle gauge.

*Syntax: '''Integer'''
*Default value:
*Units: Pixels

Used by: [[Hud_gauges.tbl#+Hostile Triangle:|+Hostile Triangle:]]

====Triangle Base:====
Defines the width of the Hostile Triangle's base.

*Syntax: '''Float'''
*Default value:
*Units: Pixels

Used by: [[Hud_gauges.tbl#+Hostile Triangle:|+Hostile Triangle:]]

====Triangle Height:====
Defines the height of the Hostile Triangle.

*Syntax: '''Float'''
Default value:
*Units: Pixels

Used by: [[Hud_gauges.tbl#+Hostile Triangle:|+Hostile Triangle:]]

====Center Offsets:====

Used by: [[Hud_gauges.tbl#+Lead Indicator:|+Lead Indicator:]]

====Single Primary Filename:====
Designates the file to use for the primary single fire-mode.

Used by: [[Hud_gauges.tbl#+Weapon Linking:|+Weapon Linking:]]

====Double Primary Filename:====
Used by: [[Hud_gauges.tbl#+Weapon Linking:|+Weapon Linking:]]

====Single Secondary Filename:====
Used by: [[Hud_gauges.tbl#+Weapon Linking:|+Weapon Linking:]]

====Double Secondary Filename:====
Used by: [[Hud_gauges.tbl#+Weapon Linking:|+Weapon Linking:]]

====Triple Secondary Filename:====
Used by: [[Hud_gauges.tbl#+Weapon Linking:|+Weapon Linking:]]

====Single Primary Offsets:====
Used by: [[Hud_gauges.tbl#+Weapon Linking:|+Weapon Linking:]]

====Double Primary Offsets:====
Used by: [[Hud_gauges.tbl#+Weapon Linking:|+Weapon Linking:]]

====Single Secondary Offsets:====
Used by: [[Hud_gauges.tbl#+Weapon Linking:|+Weapon Linking:]]

====Double Secondary Offsets:====
Used by: [[Hud_gauges.tbl#+Weapon Linking:|+Weapon Linking:]]

====Triple Secondary Offsets:====
Used by: [[Hud_gauges.tbl#+Weapon Linking:|+Weapon Linking:]]

====Hidden By Comms Menu:====
{{Table3615|
Defines whether the messages gauge may be drawn at the same time as the wingman comms menu.
*Syntax: '''Boolean'''
*Default Value: '''false''' (messages are not visible while the comms menu is open)
Used by: [[Hud_gauges.tbl#+Messages:|+Messages:]]}}

====Bottom Background Offset:====
{{Table3615|
Defines the vertical pixel offset added to the position of the bottom background frame.
*Syntax: '''Integer''' vertical offset
*Units: Pixels
Used by: [[Hud_gauges.tbl#+Damage:|+Damage:]]}}

[[Category:Tables]]

Debug filter.cfg

2015-05-03T04:56:24Z

Echelon9: Use the templated revision information.

{{TableVersion|6515}}

== debug_filter.cfg ==

The following list is the possible options for putting into a debug_filter.cfg which should be located in your FreeSpace2/Data directory

A '+' means that the item listed will have output generated to the fs2_open.log or Fred2_open.log. A '-' means to disregard those items and not print output from them.

<pre>
+AB TRAIL
+AI
+Alan
+Allender
+Andsager
+Beam
+BMP DEBUG
+BmpFastLoad
+BmpInfo
+BmpMan
+CD
+Collision
+Error
+EVENTMUSIC
+Fred routing
+General
+Jim
+JOYSTICK
+Lethality
+Lightning
+Maps
+Messaging
+Mike
+MissionLog
+MK
+Model
+ModelAnim
+MOVIE
+MVE
+Network
+OGGISH
+OpenAL
+OpenGL
+Paging
+Parse
+Particles
+Physics
+Registry
+Sandeep
+SEXP
+SHADER-DEBUG
+Sound
+UI
+Warning
+Wash
</pre>

Getting the FreeSpace2: SCP Source Code

2015-05-03T04:48:06Z

Echelon9: Reflect source code hosting via Git

{{Note| In April 2015, the SCP team transitioned the source code repository from SVN-based to GitHub-based (Git).}}

==Windows==

{{Warning| The Windows section has yet to be update for the transition to GitHub.}}

''Ported from karajorma's [http://www.hard-light.net/forums/index.php/topic,52845.0.html thread] on the [http://www.hard-light.net/forums/index.php HLP Forums].''

Here's how you set things up:

*Go to the [http://tortoisesvn..or/ Tortoise SVN homepage] and download the latest version.
*Install it. You'll probably have to restart your PC afterwards.
*Make a new folder on your HD where you'd like to install the code. You'll need a fair bit of space for the code + the intermediate files when building it. Press right mouse and choose SVN Checkout from the list.
[[Image:CheckingOutSVN1.jpg]]
*An new window will open up. Cut and paste this into the URL of repository box: '''svn://svn.icculus.org/fs2open/trunk/fs2_open'''
*By default the HEAD revision will be selected. You probably don't want to change this. Your screen should now look like this:
[[Image:CheckingOutSVN2.jpg]]
*Press OK to begin downloading from the repository.

It's pretty easy. It shouldn't take you more than a minute or two to do once you've installed Tortoise.

== Mac ==

Please see the [[Mac_Development_Guide#Getting_the_Freespace_2_Open_SCP_source_code|Mac Development Guide]].

== Unixes ==

Please see the [[Guide_to_FS_Open_on_Linux|Linux Development Guide]].

[[Category:Source Code Project]]

Fs2 open on Linux/Installing Subversion

2015-05-03T04:40:35Z

Echelon9: Reflect source code hosting via Git

#REDIRECT [[Fs2 open on Linux/Installing_Git]]

{{Page Navigation|
BookName=[[The fs2_open on Linux Guide]]|
CurrentPage=Installing Subversion|Installing Subversion|
PrevPage=[[Fs2_open on Linux/Preparation|Preparation]]|
NextPage=[[Fs2_open_on_Linux/Installing_the_Development_Libraries|Installing the Development Libraries]]}}

{{Note| This step is only for those who want the bleeding-edge source code to compile on their own. You can skip this if you intend to use a provided binary executable.}}
{{Note| If your distribution is not listed below and you are familiar with how to install Subversion on it, please add that information to this section. }}

Subversion (SVN) is a version control system used to manage changes to documents, such as source files. Developers use Subversion so they can easily coordinate their code changes with those of other developers through a SVN repository.

Be aware that when you use a copy of fs2_open from Subversion, you are using the most recent revision of the fs2_open code. The newest code might have new features and bug fixes, but it might also be less stable, perform worse, or might not even compile.

You will need a Subversion client to download ("check out" in SVN terminology) a copy of fs2_open from the Source Code Project's SVN repository. The instructions for getting a client are specific to each Linux distribution.

'''Debian''', '''Ubuntu''', and '''Linux Mint''' users should run:
$ apt-get install subversion

'''Gentoo''' users should run:
$ emerge -a subversion

'''Arch Linux''' users should run:
$ pacman -Sy subversion

'''Fedora Core 6 (Zod)''' (and most likely Red Hat) users should run:
# yum install subversion

'''Mandriva''' users should run:
# urpmi subversion

'''Novell SuSE''' users should install Subversion via [http://en.opensuse.org/YaST YaST] (if it is not already available after installing the build tools).

'''FreeBSD 10''' users should already have Subversion, but if not, should run:
$ sudo pkg install subversion

[[Category:FreeSpace Open on Linux|Installing Subversion]]

Wxfred2Contributions

2015-05-03T04:38:00Z

Echelon9: Reflect source code hosting via Git

First off, thanks for stopping by!

If you've found this page, it probably means that you or someone you know is interested in the development of the upcoming wxFRED2, a port of the Freespace 2 Editor to use the wxWidgets GUI library. Here we'll post some useful links as well as a guideline or two.

If you have not done so already, please skim over this forum topic: [http://www.hard-light.net/forums/index.php?topic=82688.0 The "Read Me First" Posts]

=Getting the source code=
We'll be starting off by using the GitHub repository for the wxFRED2, so as to achieve familiarity with the GitHub workflow.

* Download and install the [http://git-scm.com/downloads latest version of git]
* Sign Up on or Log Into [http://github.com GitHub]
* Fork the [https://github.com/scp-fs2open/fs2open.github.com/tree/wxfred2 wxFRED2 branch] from the GitHub repository
* Make changes to the wxfred2 branch
** Verify the changes are compilable and buildable
* Commit your changes to your local repo, then push your local repo onto your forked repo on GitHub
* Issue a Pull Request, and a badged SCP member (probably z64555) will review & commit your changes

=Mission statement of the wxFRED2 project=
Trash the MFC UI elements, Use wxWidgets UI elements, use as much of the existing code as possible (while not screwing over future development)

=Coding Gudelines=
"The Golden Rule"
* No business logic be located in the UI elements
* UI stuff is strictly UI
* Any operations in the UI that do actual work must go through an API provided by wxfred2.h and wxfred2.cpp

=Coding Style=
* Any coding style is permitted, just be sure to follow the existing style if you are editing a file
* "Allman" is the most prevalent brace and spacing style
* wxWidgets class names are camel case, and have a lowercase prefix of 2 to 4 letters. ex: "frmFRED" for frame, "glcVieport" for a glCanvas, etc.
** All other class names are camel case and have no prefix, and first letter is capitalized. ex: ViewSettings
* wxWidgets Handler methods/functions are camel case, and have the first letter capitalized ex: OnPaint()
** All other methods/functions may have their own style, but please be sure to follow existing style if present

=Features and Bugs=
<nowiki>Maintainers: Please be sure to mark the date this was last edited by using --~~~~----</nowiki>

Updated by: --[[User:Z64555|Z64555]] 11:13, 23 October 2013 (UTC)----

{| class="wikitable" style="color:red"
|- style="color:black"
! Component or Feature
! Active Developer(s)
! Completed
|- style="color:green"
| create all windows
| z64555
| yes
|-
| glViewport
| z64555
| no
|-
| docFRED
| z64555
| no
|-
| File-New Mission
| ?
| no
|-
| File-Save Mission
| niffiwan?
| no
|}

Some Pastebins for reference/discussion
* http://pastebin.com/qBSATeP2 Early API for UI/backend
* http://pastebin.com/BWXamnrf viewport header
* http://pastebin.com/uu87vurg viewport source
* http://pastebin.com/v9Sh58v9 mission frame (context) header
* http://pastebin.com/z8nADzxt mission frame (context) source

Please use [http://scp.indiegames.us/mantis/set_project.php?project_id=1;2 Mantis] for bug tracking.

FS2 Open on Solaris

2015-05-03T04:37:00Z

Echelon9: Reflect source code hosting via Git

== Grab a copy of Solaris ==

Download the Oracle Solaris 11.2 x86 VirtualBox Appliance, update the guest additions, or install Solaris 11.2 for x86 on a desktop PC.

== Install needed dependencies ==
<ul>
<li>developer/gcc (currently installs 4.8.2)</li>
<li>Make sure the matching gcc runtime is installed</li>
<li>developer/build/autoconf (currently 2.68)</li>
<li>developer/build/automake (currently 1.11.2)</li>
<li>developer/build/gnu-make (Appliance already has this)</li>
<li>developer/build/libtool (currently 2.4.2)</li>
<li>library/readline (Appliance already has this)</li>
<li>runtime/lua (Appliance already has this)</li>
<li>developer/versioning/subversion (currently 1.7.5)</li>
<li>library/sdl (currently 1.2.14)</li>
<li>developer/versioning/git (currently 1.7.9.2)</li>
<li>developer/build/cmake (currently 2.8.6)</li>
</ul>

On OpenSXCE (OpenIndiana based distro for Sparc) I had to install CSWautoconf (included 2.63 is too old), CSWpkgconfig (very important to fix parse error in configure script), and uninstalled the original autoconf program. I still had to install OpenAL and Jansson, but OpenAL Soft had to be version 1.11.753 because no newer version would compile due to some opcode errors, and newer versions from git would not configure due to a pthread.h issue which doesn't seem to occur in the last release version or prior. Also, that openal soft's "gmake install" command ignored the cmake install prefix, so I had to install it by manually copying files to their destinations. The latest official Solaris from Oracle doesn't seem to have that problem with the newest versions of OpenAL Soft in git. OpenSXCE did not need a newer gcc though.

== Install OpenAL ==
This is why git and cmake were installed while you had the package manager open. Download OpenAL Soft 1.15.1 (1.16 and latest git currently fail with a PThreads error) from http://kcat.strangesoft.net/openal-releases/, follow the build instructions on http://kcat.strangesoft.net/openal.html, except use the following command instead of 'cmake ..': 
cmake -DCMAKE_INSTALL_PREFIX=/usr ..

== Install Jansson ==
[http://www.digip.org/jansson/ Jansson] is the JSON library for C that is needed for the new WebUI dedicated server code. There is currently no Solaris package, so you will have to compile this from source. The latest version I can get working out of the box on Solaris 11.2 is from their Git repo, as 2.6 will not compile with a complaint about the isnan macro. Clone the source repo to a new directory and cd into that directory, then:
<ul>
<li>cmake -DCMAKE_INSTALL_PREFIX=/usr ..</li>
<li>gmake</li>
<li>gmake check</li>
<li>sudo gmake install</li>
</ul>
That will give you an installation of Jansson which pkg-config can find with no other environment editing required. Keep the jansson git folder around if you think you might want to run 'sudo gmake uninstall' at some point down the line, like if jansson ever gets into the package manager, or you want to upgrade.

== Install OpenCSW packages ==
Installing these packages will fix the linking errors with libjpeg and libGL. bzflag bring mesa, libglew, and probably some other stuff that's needed and it was easier to get it all in one go. Yes, Solaris will indicate that jpeg, mesa, etc are already installed, but they don't link correctly for some reason. Installing the CSW versions fixes that.
<ul>
<li>sudo pkgadd -d http://get.opencsw.org/now</li>
<li>sudo pkgutil -U</li>
<li>sudo pkgutil -y -i CSWlibjpeg-dev</li>
<li>sudo pkgutil -y -i CSWbzflag</li>
<li>sudo ln -s /opt/csw/lib/libjpeg.so.7 /usr/lib/ (might be needed to fix issue with finding libjpeg after these packages are installed)</li>
</ul>

== Compile FS2 ==
<ul>
<li>git clone https://github.com/scp-fs2open/fs2open.github.com.git fs2_open</li>
<li>cd fs2_open</li>
<li>./autogen.sh</li>
<li>gmake</li>
<li>cp code/fs2_open_* ../</li>
</ul>

== References ==
[http://rsaxvc.net/blog/2010/9/30/Building%20FS2_Open%20on%20OpenSolaris.html Building FS2_Open on OpenSolaris] 
[http://rsaxvc.net/blog/2010/9/19/Building%20OpenAL%20on%20Solaris.html Building OpenAL on Solaris]

Guide to FS Open on Linux

2015-05-03T04:34:21Z

Echelon9: Reflect source code hosting via Git

{{Warning|This guide assumes some fundamental command line knowledge. As a rule of thumb, do not copy & paste commands without fully understanding them, especially as root. With great power comes great responsibility.}}

*[[Fs2_open_on_Linux/Introduction|Introduction]]
*[[Fs2_open_on_Linux/Quickstart|Quickstart]]
*[[Fs2_open_on_Linux/Preparation|Preparation]]
**[[Fs2_open_on_Linux/Installing Git|Installing Git]]
**[[Fs2_open_on_Linux/Installing the Development Libraries|Installing the Development Libraries]]
*[[Fs2_open_on_Linux/Acquiring the Code|Acquiring the Code]]
*[[Fs2_open_on_Linux/Pre-Compile Configuration|Pre-Compile Configuration]]
**[[Fs2_open_on_Linux/Optimization|Optimization]]
*[[Fs2_open_on_Linux/Compiling|Compiling]]
**[[Fs2_open_on_Linux/Compile Script|Compile Script]]
*[[Fs2_open_on_Linux/Acquiring the Game Data|Acquiring the Game Data]]
**[[Fs2_open_on_Linux/Extracting data from CD|Extracting data from CD]]
***[[Fs2_open_on_Linux/Installing unshield|Installing unshield]]
****[[Fs2_open_on_Linux/Data Installation script|Data Installation script]]
*[[Fs2_open_on_Linux/Post-Compile Configuration|Post-Compile Configuration]]
**[[Fs2_open_on_Linux/Graphics Settings|Graphics Settings]]
**[[Fs2_open_on_Linux/StartUp Script|StartUp Script]]
*[[Fs2_open_on_Linux/Troubleshooting|Troubleshooting]]
**[[Fs2_open_on_Linux/Common Compile-time Errors|Common Compile-time Errors]]
***[[Fs2_open_on_Linux/Novell SuSE and the Dependencies|Novell SuSE and the Dependencies]]
***[[Fs2_open_on_Linux/SDL: undefined reference to ...|SDL: undefined reference to ...]]
***[[Fs2_open_on_Linux/Missing -lGLU compile error|Missing -lGLU compile error]]
**[[Fs2_open_on_Linux/Common Runtime Errors|Common Runtime Errors]]
***[[Fs2_open_on_Linux/ERROR: "Web cursor bitmap not found."|ERROR: "Web cursor bitmap not found."]]
***[[Fs2_open_on_Linux/I18n and Key mapping problems|I18n and Key mapping problems]]
***[[Fs2_open_on_Linux/Dedicated X Display|Dedicated X Display]]
***[[Fs2_open_on_Linux/Joystick Errors|Joystick Errors]]
***[[Mouse jumping to bottom right corner]]
***[[Fullscreen issue with multiple monitors]]

----

*[[Fs2_open_on_Linux/Compiling_PCS2|Compiling PCS2]]

[[Category:FreeSpace Open on Linux]]

Fs2 open on Linux/Installing the Development Libraries

2015-05-03T04:33:28Z

Echelon9: Reflect source code hosting via Git

{{Page Navigation|
BookName=[[The fs2_open on Linux Guide]]|
CurrentPage=Installing the Development Libraries|Installing the Development Libraries|
PrevPage=[[Fs2_open on Linux/Installing Git|Installing Git]]|
NextPage=[[Fs2_open on Linux/Acquiring the Code|Acquiring the Code]]}}

{{Note| This step is only for those who want the bleeding-edge source code to compile on their own. You can skip this if you intend to use a provided binary executable.}}

{{Note| If your distribution is not listed below and you are familiar with how to install the needed libraries on it, please add that information to this section. }}

To build FS2 Open, you'll need the [http://www.libsdl.org/ SDL], [http://www.openal.org/ OpenAL], [http://www.xiph.org/ogg/ libogg], [http://vorbis.com/ libvorbis], [http://www.theora.org/ libtheora], [http://cnswww.cns.cwru.edu/php/chet/readline/rltop.html readline], [http://www.lua.org liblua (version 5.1.3 or higher)], [http://www.digip.org/jansson/ Jansson], and OpenGL (most likely provided with your video card driver) development packages. And of course, you'll need the [http://gcc.gnu.org/ GNU Compiler Collection] and [http://sourceware.org/autobook/ make].

'''Ubuntu''' and '''Linux Mint (except for Debian Edition)''' users should run:
$ apt-get install libopenal-dev libogg-dev libvorbis-dev build-essential automake1.10 autoconf libsdl1.2-dev libtheora-dev libreadline6-dev libpng12-dev libjpeg62-dev liblua5.1-0-dev libjansson-dev libtool
{{Note| The [http://packages.debian.org/unstable/devel/build-essential build-essential] package is a metapackage that installs the essential build tools.}}

'''Debian''' and '''Linux Mint Debian Edition''' users should run:
$ apt-get install libopenal-dev libvorbis-dev build-essential automake1.10 autoconf libsdl1.2-dev libtheora-dev libreadline6-dev libpng12-dev liblua5.1-0-dev libjansson-dev libtool
{{Note| The [http://packages.debian.org/unstable/devel/build-essential build-essential] package is a metapackage that installs the essential build tools.}}

'''Fedora Core''' users (and most likely Red Hat users too) should run:
$ yum install openal-devel libvorbis-devel gcc gcc-c++ automake autoconf SDL-devel libtheora-devel readline-devel lua-devel libpng-devel libjpeg-devel jansson-devel libtool

'''Gentoo''' users should run:
$ emerge -va openal libvorbis libsdl libtheora readline lua jansson
{{Note| media-libs/openal needs the "alsa" USE-flag if you intend to use ALSA, and media-libs/libsdl needs the "X","opengl" and "xv" USE-flags.}}

'''Mandriva''' users should run:
$ urpmi libsdl-devel libopenal-devel libvorbis-devel libtheora-devel gcc gcc-c++ automake autoconf liblua-devel jansson-devel

'''OpenSUSE''' users should run:
$ sudo zypper install -t pattern devel_C_C++
$ sudo zypper install libSDL-devel libogg-devel libvorbis-devel libtheora-devel openal-soft-devel lua51-devel libjpeg8-devel libjansson-devel

'''FreeBSD 10''' users should run:
$ sudo pkg install automake openal-soft jansson lua51 readline libogg libtheora libvorbis png jpeg sdl libtool
{{Note| Everything after 'lua51' is already installed on PC-BSD 10, and likely any other FreeBSD distro with a full desktop environment.}}

[[Category:FreeSpace Open on Linux|Installing the Development Libraries]]

Fs2 open on Linux/Acquiring the Code

2015-05-03T04:32:03Z

Echelon9: Reflect source code hosting via Git

{{Page Navigation|
BookName=[[The fs2_open on Linux Guide]]|
CurrentPage=Acquiring the Code|Acquiring the Code|
PrevPage=[[Fs2_open on Linux/Installing the Development Libraries|Installing the Development Libraries]]|
NextPage=[[Fs2 open on Linux/Pre-Compile Configuration|Pre-Compile Configuration]]}}

{{Note| This step is only for those who want the bleeding-edge source code to compile on their own. You can skip this if you intend to use a provided binary
executable.}}
Before you begin, make sure you have write permissions on your current working directory. $HOME/$USER is a pretty safe bet. I recommend that you create a permanent /$HOME/$USER/src directory from which you run the git command, this way git will only update the files changed the next time you download the source and it's always nice to have things organized. Make sure you have git installed on your system. See the [[Fs2_open_on_Linux/Installing Git|Installing Git]] chapter on installing Git.

Now get the source. Run from a terminal:

$ git clone https://github.com/scp-fs2open/fs2open.github.com.git

This will pull in the most recent source code from the 'master' branch.
 

[[Category:FreeSpace Open on Linux|Acquiring the Code]]

Fs2 open on Linux/Preparation

2015-05-03T04:30:08Z

Echelon9: Reflect source code hosting via Git

{{Page Navigation|
BookName=[[The fs2_open on Linux Guide]]|
CurrentPage=Preparation|Preparation|
PrevPage=[[Fs2 open on Linux/Introduction|Introduction]]|
NextPage=[[Fs2 open on Linux/Installing Git|Installing Git]]}}

If you don't intend to follow the latest code developments available from the source code repositories, instead using a [http://www.hard-light.net/forums/index.php?board=50.0 source tarball] from the latest release post, you can skip the Git chapter.
* [[Fs2 open on Linux/Installing Git]]
* [[Fs2 open on Linux/Installing the Development Libraries]]

[[Category:FreeSpace Open on Linux|Installation]]

Guide to FS Open on Linux

2015-05-03T04:27:28Z

Echelon9: Reflect source code hosting via Git

{{Warning|This guide assumes some fundamental command line knowledge. As a rule of thumb, do not copy & paste commands without fully understanding them, especially as root. With great power comes great responsibility.}}

*[[Fs2_open_on_Linux/Introduction|Introduction]]
*[[Fs2_open_on_Linux/Quickstart|Quickstart]]
*[[Fs2_open_on_Linux/Preparation|Preparation]]
**[[Fs2_open_on_Linux/Installing Git|Installing Git]]
**[[Fs2_open_on_Linux/Installing Subversion|Installing Subversion]]
**[[Fs2_open_on_Linux/Installing the Development Libraries|Installing the Development Libraries]]
*[[Fs2_open_on_Linux/Acquiring the Code|Acquiring the Code]]
*[[Fs2_open_on_Linux/Pre-Compile Configuration|Pre-Compile Configuration]]
**[[Fs2_open_on_Linux/Optimization|Optimization]]
*[[Fs2_open_on_Linux/Compiling|Compiling]]
**[[Fs2_open_on_Linux/Compile Script|Compile Script]]
*[[Fs2_open_on_Linux/Acquiring the Game Data|Acquiring the Game Data]]
**[[Fs2_open_on_Linux/Extracting data from CD|Extracting data from CD]]
***[[Fs2_open_on_Linux/Installing unshield|Installing unshield]]
****[[Fs2_open_on_Linux/Data Installation script|Data Installation script]]
*[[Fs2_open_on_Linux/Post-Compile Configuration|Post-Compile Configuration]]
**[[Fs2_open_on_Linux/Graphics Settings|Graphics Settings]]
**[[Fs2_open_on_Linux/StartUp Script|StartUp Script]]
*[[Fs2_open_on_Linux/Troubleshooting|Troubleshooting]]
**[[Fs2_open_on_Linux/Common Compile-time Errors|Common Compile-time Errors]]
***[[Fs2_open_on_Linux/Novell SuSE and the Dependencies|Novell SuSE and the Dependencies]]
***[[Fs2_open_on_Linux/SDL: undefined reference to ...|SDL: undefined reference to ...]]
***[[Fs2_open_on_Linux/Missing -lGLU compile error|Missing -lGLU compile error]]
**[[Fs2_open_on_Linux/Common Runtime Errors|Common Runtime Errors]]
***[[Fs2_open_on_Linux/ERROR: "Web cursor bitmap not found."|ERROR: "Web cursor bitmap not found."]]
***[[Fs2_open_on_Linux/I18n and Key mapping problems|I18n and Key mapping problems]]
***[[Fs2_open_on_Linux/Dedicated X Display|Dedicated X Display]]
***[[Fs2_open_on_Linux/Joystick Errors|Joystick Errors]]
***[[Mouse jumping to bottom right corner]]
***[[Fullscreen issue with multiple monitors]]

----

*[[Fs2_open_on_Linux/Compiling_PCS2|Compiling PCS2]]

[[Category:FreeSpace Open on Linux]]

Fs2 open on Linux/Installing GIT

2015-05-03T04:26:53Z

Echelon9: moved Fs2 open on Linux/Installing GIT to Fs2 open on Linux/Installing Git: Git is not an acronym (in it's current form).

#REDIRECT [[Fs2 open on Linux/Installing Git]]

Fs2 open on Linux/Installing Git

2015-05-03T04:26:53Z

Echelon9: moved Fs2 open on Linux/Installing GIT to Fs2 open on Linux/Installing Git: Git is not an acronym (in it's current form).

{{Page Navigation|
BookName=[[The fs2_open on Linux Guide]]|
CurrentPage=Installing Git|Installing Git|
PrevPage=[[Fs2_open on Linux/Preparation|Preparation]]|
NextPage=[[Fs2_open_on_Linux/Installing_the_Development_Libraries|Installing the Development Libraries]]}}

{{Note| As of FSO version 3.7.2, git has replaced subversion as the primary source code repository}}
{{Note| This step is only for those who want the bleeding-edge source code to compile on their own. You can skip this if you intend to use a provided binary executable.}}
{{Note| If your distribution is not listed below and you are familiar with how to install git on it, please add that information to this section. }}

Git is a version control system used to manage changes to documents, such as source files. Developers use git so they can easily coordinate their code changes with those of other developers through a git repository.

Be aware that when you use a copy of fs2_open from git, you are using the most recent revision of the fs2_open code. The newest code might have new features and bug fixes, but it might also be less stable, perform worse, or might not even compile.

You will need a git client to download ("check out" in git terminology) a copy of fs2_open from the Source Code Project's github repository. The instructions for getting a client are specific to each Linux distribution.

'''Debian''', '''Ubuntu''', and '''Linux Mint''' users should run:
$ apt-get install git

'''Gentoo''' users should run:
$ emerge -a git

'''Arch Linux''' users should run:
$ pacman -Sy git

'''Fedora Core )''' (and most likely Red Hat / Centos) users should run:
# yum install git

'''Mandriva''' users should run:
# urpmi git

'''Novell SuSE''' users should install git via [http://en.opensuse.org/YaST YaST] (if it is not already available after installing the build tools).

'''FreeBSD 10''' users may already have git, but if not, should run:
$ sudo pkg install git

[[Category:FreeSpace Open on Linux|Installing Git]]

Mac Development Guide

2015-05-03T04:22:59Z

Echelon9: Reflect source code hosting via Git

This page provides background and instructions to setup the Xcode development environment in order to compile FreeSpace 2 Open SCP. After following these instructions you will have a working Xcode build environment, a checked out copy of the latest FS2_Open source code, and compiled binaries of the latest revision of the FS2_Open engine.

[[Image:Xcode icon.png‎|right|110px]]

==Getting Xcode==
Xcode is the integrated development environment (IDE) that Apple provides free of charge for the Mac OS platform. It is the Mac equivalent to Microsoft Visual Studio. In practice, Xcode provides a graphical interface to an underlying Clang/LLVM compiler; with the addition of platform libraries (Frameworks), code completion, project management and the other features you would expect of a modern IDE.

The latest Xcode is available free from the Mac App Store. Xcode 3.2.6 is available to those with a free Apple Developer account on the [https://developer.apple.com/downloads/index.action Apple Developer Downloads] page, search for 'Xcode 3.2.6' and it should be the only result. This may be useful for those with older hardware/software needs.

It is '''strongly recommended''' that you update to the latest version of Xcode compatible with your Mac OS version, as prior versions have bugs which prevent FS2_Open from compiling properly.

{| style="text-align:center"
|+ ''Known working combinations''
! !! OS X 10.9 !! OS X 10.8 !! OS X 10.7
|-
! Xcode 5.1.1
| Yes || Yes || n/a
|-
! Xcode 5.0.2
| Yes || Yes || n/a
|-
! Xcode 4.2.1
| n/a || n/a || Partially
|-
! Xcode 3.2.6
| n/a || Yes || Yes
|}

==Getting FreeSpace 2 Open SCP source code==

Open Terminal.app through Spotlight, or it can be found in /Applications/Utilities/Terminal.app. This is the console command line for Mac OS. You will need a location to save the checked out source code. The following commands will create a new folder in your personal Documents called 'coding' and then within a subfolder specific for FS2_Open called 'fs2_open' checkout the latest source code.

$ cd Documents
$ mkdir coding
$ cd coding
$ git clone https://github.com/scp-fs2open/fs2open.github.com.git fs2open

Open Finder and browse to ~/Documents/coding/fs2open to see the new files that have been downloaded from the FS2_Open source code repository.

FS2_Open currently uses some precompiled third party Frameworks to handle music and video on Mac OS, which are stored in compressed form within the source code repository. Open the 'projects' folder and then 'Xcode4'. This is the location of recent Xcode specific project files and settings. For now, double click on Frameworks.tgz to uncompress these Frameworks to a new folder called Frameworks.

Your local checkout of the source code can be keep up to date with the latest changes by opening Terminal.app again, and running the following commands

$ cd Documents/coding/fs2open
$ git pull

Xcode and the FreeSpace 2 Open SCP source code is now setup, so let's start our first compilation by double clicking on the FS2_Open.xcodeproj Xcode project file.

==Compiling FreeSpace 2 Open SCP source code (GUI)==

Click the 'Build' button or press Apple key+B. This should complete successfully, and once done the binary application can be found within 'projects/Xcode4/build/'. Open the folder with the same name as the build type you selected previously to find the compiled FS2_Open application.
[[Category:Source Code Project]][[Category:FreeSpace_Open_on_Mac]]

==Compiling FreeSpace 2 Open SCP source code (Command line)==

Open Terminal.app and run the following commands to build a Debug version of FS2_Open

cd Documents/coding/fs2_open/projects/Xcode4
xcodebuild

In order to build an AddressSanitizer build, first a trunk version of Clang/LLVM must be downloaded and installed as the Apple-supplied Clang does not enable AddressSanitizer features.

Following the instructions at http://clang.llvm.org/get_started.html

Then use this trunk build of Clang instead of the Apple-supplied Clang to build FS2_Open with AddressSanitizer

cd Documents/coding/fs2_open/projects/Xcode4
export CC=/path/to/llvm/../build/Debug+Asserts/bin/clang
export CXX=/path/to/llvm/../build/Debug+Asserts/bin/clang++
export CFLAGS=-fsanitize=address
export LDFLAGS=-fsanitize=address
xcodebuild CC=$CC CXX=$CXX OTHER_CFLAGS=$CFLAGS LDFLAGS=$LDFLAGS LDPLUSPLUS=$CXX CLANG_LINK_OBJC_RUNTIME=NO

You may need to open the Xcode GUI and copy the following file into the Linked Frameworks

/path/to/llvm/build/Debug+Asserts/lib/clang/3.5.0/lib/darwin/libclang_rt.asan_osx_dynamic.dylib

FS2_Open must be run from the Terminal to enable to AddressSanitizer feature at runtime. Additionally, to ensure line references and the like are cleanly shown the output must be piped to a Python script which symobilizes line references

./FS2_Open\ $debug$.app/Contents/MacOS/FS2_Open\ $debug$ 2>&1 | /path/to/llvm/projects/compiler-rt/lib/asan/scripts/asan_symbolize.py | c++filt

FreeSpace Open Installer

2015-05-03T04:18:19Z

Echelon9: Reflect source code hosting via Git

The FreeSpace Open Installer is currently the only official online installer for FS2_Open. The Installer was originally written by Turey, and then completely rewritten by Goober5000. The source code is hosted by the [[SCP]].

The program's web page is [http://www.fsoinstaller.com/ here].

Instructions on creating an install.txt file are [[FSO Installer Text Files|here]]. These are only for modders who are ready to add their released mod or campaign to the installer's list of available mods to install.

A mirror monitor for the various mods can be found [https://dev.tproxy.de/fs2/mirrors/ here].

=== Download Links ===
* [http://www.fsoinstaller.com/files/installer/FreeSpaceOpenInstaller.jar fsoinstaller.com]
* [http://scp.indiegames.us/fsoinstaller/FreeSpaceOpenInstaller.jar scp.indiegames.us]

Both links contain the same installer. The program requires Java version 1.5 or higher, and can be run on any operating system that can run a compatible version of Java.

You can access the source code from https://github.com/scp-fs2open/fsoinstaller.

[[Category:Source Code Project]]

Getting started with FreeSpace 2

2015-05-03T04:15:16Z

Echelon9: Reflect source code hosting via Git

<center>'''For up-to-date instructions, choose your platform: [http://www.hard-light.net/forums/index.php?topic=78710.0 Windows] [http://www.hard-light.net/forums/index.php?topic=79545.0 Linux] [http://www.hard-light.net/forums/index.php?topic=79546.0 Mac OS X]'''</center>

This page is under construction (if this page is deemed necessary that is -> [[Talk:Getting_started_with_FreeSpace_2|talk page]]).

It is also outdated. Both the builds and mediaVPs are in 3.6.10 beta phase at this point in time, check Hard-Light Forums for the latest news and stuff.

==Getting Retail FreeSpace 2==
::''Main article [[Getting_FreeSpace]]...''
*Buy CDs
*Buy it online, for example from [http://www.gog.com/en/gamecard/freespace_2 GOG.com]

==Installing Retail FreeSpace 2==
::''Main article [[Installing Freespace 2]]...''
*Install the game
*To use FreeSpace 2 Open only the the retail data files are needed ([[*.VP]] files). This makes it possible for user to 'install' or extract the '''vp''' files from the main game data and then move the files to another platform for example to Linux or OS X. However it is recommended that the data files should be patched before moving them. See [[Fs2 open on Linux]] for more information.
*Make sure you have [http://connect.creativelabs.com/openal/Downloads/Forms/AllItems.aspx OpenAL] installed

==Update the Retail FreeSpace 2==
{{Note|This step is only required if the data has not already been patched}}
*Download and run Freespace 1.2 update
*[http://homepage.ntlworld.com/karajorma/FAQ/Downloads/HotUv1.20Pack.rar FreeSpace 2 Patch (version 1.2)] | Alternate link: [http://www.gameupdates.org/details.php?id=4722 FS2 1.2 patch from gameupdates.org] Note that you will need a [http://en.wikipedia.org/wiki/Comparison_of_BitTorrent_clients BitTorrent] client to download from gameupdates; I recommend uTorrent.
*Some versions have this already preinstalled

==Installing FreeSpace Open==
::''Main articles [[Installing FreeSpace 2 Open]] and [[FreeSpace Open Installer]]...''

===Launcher===
Using a Launcher makes configuring & running FSO much easier. Unless you know what you're doing, use either wxLauncher (preferred) or Launcher 5.5g.
{{Note|In some cases on Windows, you need to run the Launcher as Administrator in order to be able to update the registry correctly}}
*[http://www.hard-light.net/forums/index.php?topic=67950.0 wxLauncher] (Cross Platform)
*[http://swc.fs2downloads.com/files/Launcher55g.zip Launcher 5.5g] (Windows only)

====Launchers still in development====
*[http://www.hard-light.net/forums/index.php?topic=86364.0 Knossos] (Cross Platform, includes installer functionality)
* m!m's new launcher (but I can't find the release thread :() (Windows only)

===Game Builds===
====Latest Official Build====
*[http://www.hard-light.net/forums/index.php?topic=89597.0 Link to FS2 Open 3.7.2]

====Current Development Builds====
*[http://www.hard-light.net/forums/index.php/board,173.0.html Nightly Builds]

===MediaVP File Sets===
*The MediaVPs are a set of upgrades to the game assets, e.g. models, textures, sounds, etc.
*MediaVP sets should always be installed to their own directory that is located in the FreeSpace root directory. The [[FreeSpace_Open_Installer|installer]] is the preferred way to install the mediavps. For manual installs they should in be installed to a versioned directory, e.g. '''c:\games\freespace2\mediavps_3612''' or '''c:\games\freespace2\MediaVPs_2014'''
----
====Latest Official MediaVPs====
*[http://www.hard-light.net/forums/index.php/topic,58230.0.html 3.6.10 MediaVP Release Thread]
*[http://www.hard-light.net/forums/index.php?topic=70739.0 3.6.12 MediaVP Release Thread]
*[http://www.hard-light.net/forums/index.php?topic=86475.0 2014 MediaVP Release Thread]

==Setting up the Launcher==
===Selecting the Game Build===
*First thing to do is to click on the '''Browse...''' button at the top of the Launcher and select the build you installed.
===Audio/Joystic===
*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.
===Network===
*Adjust the settings according to your setup.
===Speech===
*If you are using Windows XP, or have the Speech API installed, FS2_Open will be able to read briefings, techroom descriptions, and even in game 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.
===Registry===
*Unless you know what you are doing '''don't''' tamper with these settings
*Default location is: HKEY_LOCAL_MACHINE -> Software -> Volition -> Freespace2
*On 64 bit Windows: HKEY_CURRENT_USER -> Software -> Classes -> VirtualStore -> MACHINE -> SOFTWARE -> Wow6432Node -> Volition -> Freespace2

On OSX / Linux / BSD an .ini file is used instead of the registry. It is located here:

*~/Library/FS2_Open/fs2_open.ini (OSX)
*~/.fs2_open/fs2_open.ini (other *nix variants)

===Video===
* On some older or special builds user can choose which API to use (OpenGL or Direct3D) however usually it defaults to '''OpenGL'''. In any case it is '''recommended to use OpenGL''' as DirectX is unstable and not actively supported.
* Select the preferred resolution for the game.
===Features===
*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 if you ever need to report an error with FS2_Open.
*'''Easy setup''' basically allows you to turn lots of features on or off at once. Generally most people use it and then fine tune the settings immediately afterwards.
*'''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, you can see the [[Command-Line Reference]] page of the wiki). Its recommended to add '''''-ambient_factor 50''''' to the command line.
*Finally, the two boxes below this let you toggle the various new features in FS2 Open individually. The list type option lets you choose between graphics, sound etc and the tickboxes let you turn the feature on or off.
===MOD===
*This tab is used to select mods for the game. For example this installation guide directs you to install MediaVPs in such a way that FS2 will treat them as a mod. Click '''Select MOD''' and choose '''''mediavps''''' folder that you picked earlier.
*The reason that we installed the media VPs as a mod is that if FS2_Open doesn't work you can select the '''no MOD''' button and run without them and check if the problem is with the build or with the media VPs. It also means that you can still run retail FS2 if you want to.

[[Category:The games]]

Fs2 open on Linux/Preparation

2015-05-03T04:14:13Z

Echelon9: Reflect source code hosting via Git

{{Page Navigation|
BookName=[[The fs2_open on Linux Guide]]|
CurrentPage=Preparation|Preparation|
PrevPage=[[Fs2 open on Linux/Introduction|Introduction]]|
NextPage=[[Fs2_open on Linux/Installing Subversion|Installing Subversion]]}}

If you don't intend to follow the latest code developments available from the source code repositories, instead using a [http://www.hard-light.net/forums/index.php?board=50.0 source tarball] from the latest release post, you can skip the Git or Subversion (deprecated) chapter.
* [[Fs2_open_on_Linux/Installing Git]]
* [[Fs2 open on Linux/Installing Subversion]] (deprecated)
* [[Fs2 open on Linux/Installing the Development Libraries]]

[[Category:FreeSpace Open on Linux|Installation]]

Fs2 open on Linux/Preparation

2015-05-03T04:11:15Z

Echelon9: Reflect source code hosting via Git

{{Page Navigation|
BookName=[[The fs2_open on Linux Guide]]|
CurrentPage=Preparation|Preparation|
PrevPage=[[Fs2 open on Linux/Introduction|Introduction]]|
NextPage=[[Fs2_open on Linux/Installing Subversion|Installing Subversion]]}}

If you don't intend to use the code available from the source code repositories, instead using a [http://www.hard-light.net/forums/index.php?board=50.0 source tarball] from the latest release post, you can skip the [[Fs2 open on Linux/Installing Subversion]] chapter.
* [[Fs2 open on Linux/Installing Subversion]]
* [[Fs2 open on Linux/Installing the Development Libraries]]

[[Category:FreeSpace Open on Linux|Installation]]

Manually Installing FreeSpace 2 Open

2015-05-03T04:09:16Z

Echelon9: Reflect source code hosting via Git

This guide assumes you already have a working copy of FreeSpace 2 installed. If not, see [[Installing FreeSpace 2]]. 


== Step One: Understanding what you need ==
There are three main components that you need to get the most out of fs2_open.

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

== Step Two: Getting the Launcher ==

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

Windows: [http://www.hard-light.net/forums/index.php?topic=67950.0 wxLauncher] (recommended) or [http://swc.fs2downloads.com/files/Launcher55g.zip Launcher 5.5g]

OS X: [http://www.hard-light.net/forums/index.php?topic=67950.0 wxLauncher] unless you are using Tiger or a PowerPC Mac, in which case use Soulstorm's [http://www.hard-light.net/forums/index.php?topic=51391.0 OS X Launcher 3.0] ([[Soulstorm's OS X Launcher|instructions]])

Linux: [http://www.hard-light.net/forums/index.php?topic=67950.0 wxLauncher] (build it from source; see the [http://code.google.com/p/wxlauncher/source/browse/ReadMe.txt readme] for instructions)

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

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

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

[http://www.hard-light.net/forums/index.php?topic=85435.0 FreeSpace Open 3.7.0 release thread]

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

[http://www.hard-light.net/forums/index.php/board,97.0.html Test builds forum]

[http://www.hard-light.net/forums/index.php/board,113.0.html Cross Platform Development forum (for Linux/OS X builds)]

=== Nightly Builds ===

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

[http://www.hard-light.net/forums/index.php/board,173.0.html Nightly builds forum]

== Step Four: MediaVPs ==

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

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

[http://www.hard-light.net/forums/index.php?topic=86475.0 2014 MediaVPs Release Thread]

== Step Five: Configuring Everything ==

=== Basic setup ===

At this point, you have one final stage remaining before fs2_open is ready to go. Open up the Launcher. (It should be in your main FreeSpace 2 folder). Select the EXE you'd like to use by clicking the "Browse..." button at the top of the Launcher. There are two types typically for any build release:
* a debug build with the name containing 'd' or 'debug' right after the version number. For example, fs2_open_3_6_10'''d'''.exe.
* a regular/release build with the name containing 'r' or nothing right after the version number. For example, fs2_open_3_6_10.exe or fs2_open_3_6_11'''r'''_sse2-20100131_r5862.exe.

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

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

=== Speech setup ===

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

=== Video setup ===

On the "Video" tab, you can choose choose various graphics options. Here, you can set the resolution as well as the colour depth. It is recommended to use a resolution greater or equal to 1024x768 at 32 bits of colour depth. The other options, especially the anisotropic filter and antialiasing sliders, should not be altered.

=== Features setup ===

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

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

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

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

[http://www.hard-light.net/wiki/index.php/Command-Line_Reference Command line Flags]

=== Language Setup ===

Freespace & Freespace 2 supported non-English languages such as French, German & Polish. Some mods (most notably Freespace Port) also support non-English languages. The steps required to change the language differ depending on which OS FSO is running on.

Note that due to pilot file limitations, pilots can only be used with '''one''' language. If you switch languages you need to have multiple pilots.

To set the language, modify the Language entry in the [[Getting_started_with_FreeSpace_2#Registry|registry or the [Default] section of the .ini file]].

e.g.

<code>
[Default]

...

Language=French
</code>

== Step Six: Cutscenes ==

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

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

[[Category:Source Code Project]]

Doxygen Documentation

2015-05-03T04:07:50Z

Echelon9: Reflect source code hosting via Git

This page provides background and instructions to setup the Doxygen documentation sytem. Doxygen is used to parse the source code for suitable comment blocks to automatically generate clean Freespace 2 Open documentation in a number of formats.

Doxygen uses a small text file, called a Doxyfile, as a script to analyse source code and produce the required output formats.

Doxygen's ease of regenerating documentation from source code allows the production of up to date documentation reflecting the latest source code changes at any time.

[[Image:Doxygen.png‎|right|110px]]

==Getting Doxygen==
From [http://www.doxygen.org the Doxygen website], "Doxygen is a documentation system for C++, C, Java, Objective-C, Python, IDL (Corba and Microsoft flavors), Fortran, VHDL, PHP, C#, and to some extent D."

Doxygen is an open source application available for Windows, OS X and Linux.

'''Steps'''

* Download [http://www.doxygen.org/download.html#latestsrc the appropriate Doxygen release] for your computer.
* Follow the standard setup instructions.
* Open the Doxygen program.

==Preparing your first set of Doxygen Documentation==
{{note|The Doxygen GUI wizard layout is nearly identical between platforms. Windows has been shown here for simplicity.}}
[[Image:Wizard tab.png‎|right|thumb|150px|''Doxygen's GUI wizard after opening the fs2open.Doxyfile'']]
[[Image:Run tab.png‎|right|thumb|150px|''Doxygen's GUI wizard after compiling the documentation'']]

To prepare a fresh batch of documentation, based on the current source code, first ensure that you have checked out the latest version of the FS2_Open source code.

* Open the Doxygen GUI wizard, called Doxywizard.
* Click File and then browse to the location of your checked out copy of the FS2_Open source code.
* Select in the top level folder fs2open.Doxyfile.
* This will populate the Doxywizard with the standard settings.
* On the Run tab, click on "Run Doxygen".

When this is completed, clicking on "Show HTML output" will open your web browser pointed at the documentation output.

==Accessing the prepared Doxygen Documentation==
[[Image:Browser view.png‎|right|thumb|150px|''Doxygen's Documentation in HTML form'']]
The output from Doxygen can come in many formats, including:

* HTML output for using in a standard web browser
* PDF (including hyperlinks)
* Xcode documentation sets for inclusion in the IDE
* Man pages

At present, the default outputs are HTML output and PDF (if additional support is available on your computer).

==Quick overview of the underlying documentation==
A full featured article on writing fully featured documentation to take advantage of Doxygen will go up shortly. An example documentation block for the static_rand_range() function in staticrand.cpp follows:

/**
* @brief Return a random integer within a range. Note: min and max are inclusive
*
* @param num Seed input number
* @param min Minimum range integer to return
* @param max Maximum range integer to return
* @return Random integer within the range
*/
int static_rand_range(int num, int min, int max)
{
int rval = static_rand(num);
rval = (rval % (max - min + 1)) + min;
CLAMP(rval, min, max);
return rval;
}

This corresponds to the following HTML output

[[Image:Static rand range.png‎|''Documentation for the static_rand_range() function in HTML output'']]

[[Category:Source Code Project]]

==Notes on Doxygen Style==
Although you can have a number of documentation style options for Doxygen, it is recommended that you stay consistent to existing doc comments. For example, if you come across a number of comment blocks in a file that use the /** style, then it's recommended that you use that style in that file instead of, say, /*!

When documenting a enumeration or a list of variables, it may be desired to document each value per line. To do this, use the //!< character string in place of the normal // comment string on the same line of the value your documenting, or on the line immediately below it.

==Useful Plugins for Common Editors==
This section provides info on some useful plugins for common text editors that will aide in the documentation effort, such as automation.

===Notepad++===
Notepad++ offers a plugin called [http://sourceforge.net/projects/doxyit/ DoxyIt] that will set up a documentation block for functions and files fairly quickly, through the Alt+Ctrl+Shift+D shortcut. The main feature is that it will automatically template the @param's for all of the function arguments.

Fs2 open on Linux/Pre-Compile Configuration

2015-05-03T04:05:07Z

Echelon9: Reflect source code hosting via Git

{{Page Navigation|
BookName=[[The fs2_open on Linux Guide]]|
CurrentPage=Pre-Compile Configuration|Pre-Compile Configuration|
PrevPage=[[Fs2 open on Linux/Acquiring the Code|Acquiring the Code]]|
NextPage=[[Fs2_open on Linux/Optimization|Optimization]]}}

{{Note| This step is only for those who want the bleeding-edge source code to compile on their own. You can skip this if you intend to use a provided binary executable.}}
Before you compile you need to configure it for your system. In the directory you ran the Git command from, a new directory has appear, namely fs2_open.
If your fs2_open is a completely new checkout, you will first need to run the autogen.sh script.
Run from inside your newly created fs2_open directory:
$ ./autogen.sh
autogen.sh is a script that will generate the required makefiles. You will see alot of "checking for this" and "checking for that", this is actually the "configure" script (which can be run with <tt>./configure</tt> if you need to change the options) examining and configuring fs2_open for your system. 
It is possible to give autogen.sh configure options as well, autogen.sh will pass them along to configure.

A full list of configure options can be found by running the configure script with the '--help' option.
$ ./configure --help

Note: if you have multiple versions of a dependency installed, and FSO is picking the wrong one, AND it's causing a compile issue, you should be able to select the correct version of the library with something like this: (specific example is given for lua5.1 (good) vs lua5.2 (causes problems) - thanks to ZekeS for this advice
$ LDFLAGS="-l:liblua.so.5.1 $LDFLAGS" CXXFLAGS="-I/usr/include/lua5.1 $CXXFLAGS" ./autogen.sh

If you end up doing this, let a member of the SCP know about it so that configure.ac can be updated to exclude the incompatible version of the library.

[[Category:FreeSpace Open on Linux|Pre-Compile Configuration]]

Command-Line Reference

2014-06-14T07:28:30Z

Echelon9: /* Troubleshooting */ Reflect the meta -parse_cmdline_only

Command-Line Flags (also called Command-Line Parameters) are optional flags passed to the FSO executable, and generally enables one or more features added to the FS2 Open engine. These flags are accessed conveniently through an [[FSO Launcher]]. To have FSO list all available flags, use any one of the following: [[Command-Line_Reference#-help|-help]], [[Command-Line_Reference#-help|--help]], [[Command-Line_Reference#-help|-h]], or [[Command-Line_Reference#-help|-?]].



===Graphics===
====-spec====
'''"Enable Specular"'''

Only polygons mapped with textures for which a shinemap exists will receive 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).
{{Table3615|
*This feature is on by default, use launcher option Disable Specular or if necessary to manually disable enter the flag -nospec}}

====-env====
'''"Enable Environment maps"'''

It only works if [[Command-Line_Reference#-spec|-spec]] is also set. Environment mapping intensity will be determined from the shine map too (see [[Texturing]] for more info). [[Installing FreeSpace 2 Open#Video setup|See Video setup.]]
{{Table3615|
*This feature is on by default, use launcher option Disable Environment Maps or if necessary to manually disable enter the flag -noenv }}

====-glow====
'''"Enable Glowmaps"'''

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)
{{Table3615|
*This feature is on by default, use launcher option Disable Glow Maps or if necessary to manually disable enter the flag -noglow }}

====-nomotiondebris====
'''"Disable motion debris"'''

====-noscalevid====
"Disable scale-to-window for Movies"

Disables fullscreen scaling of video clips.

====-missile_lighting====
'''"Apply Lighting to Missiles"'''

====-normal====
'''"Enable Normal Maps"'''

Normal maps require GLSL rendering, (see [[OpenGL_Shaders_(GLSL)|OpenGL Shaders (GLSL)]] for further info). It needs auxiliary normal maps (the same name of the base map plus "-normal"). DXT5_NM DDS format is needed. (Technical note: DXT5 will work, since only the GREEN and ALPHA channels are read by the current shader system. One direction of lines goes into the GREEN channel, the other direction goes into the ALPHA channel. RED and BLUE can be either base gray (#808080) or black. Usual practice is after creating the DXT5_NM, copy the RED channel to the ALPHA channel, black out the RED and BLUE an then save as either a DXT5 or u8888 (uncompressed) DDS file.)
{{Table3615|
*This feature is on by default, use launcher option Disable Normal Maps or if necessary to manually disable enter the flag -nonormal }}

====-post_process====
'''"Enable Post Processing"'''

enables the use (if present) of post-processing effects as defined by the post_process.tbl. Bloom usage has an additional cmdline option for setting it's value, most post processing effects are achieved in mission per the mission designer or can be enabled globally in the table.

====-soft_particles====
'''"Enable soft particles"'''

====-3dshockwave====
'''"Enable 3D Shockwaves"'''

This only has any effect when both a 2d and 3d shockwave effect are present, otherwise the only available effect is used (2d shockwave is defined by effects/shockwave01.eff or .ani, and 3d shockwave by models/shockwave.pof)

Note that 3d shockwaves are usually flat discs, that FSO scales up. The animated 2d billboards used by 2d shockwaves with the addition of [[Command-Line Reference#-soft_particles|soft particles]], may look better when intersecting with models (which shockwaves often do). Use at your discretion.

====-fxaa====
'''"Enable FXAA antialiasing"'''

Enables the FXAA postprocessing stage. Further information can be found here: http://www.hard-light.net/forums/index.php?topic=76145.0

====-flightshaftsoff====
'''"Force Lightshafts off"'''

Disables Lightshafts even if a mission designer enables them via SEXP in a mission.

===Game Speed===
====-img2dds====
'''"Compress non-compressed images"'''

Converts all images to DDS (compressed) format. Decreases memory usage but potentially reduces image quality.

====-no_vsync====
'''"Disable vertical sync"'''

====-cache_bitmaps====
'''"Cache bitmaps between missions"'''

Will ideally reduce the load-time from one mission to another.

===HUD===
====-dualscanlines====
'''"Another Pair of Scanning Lines"'''

Adds a second pair of scanning lines to the target window when scanning an object.

====-targetinfo====
'''"Enable Info next to Target"'''

Displays target info, such as name and class, beside the targeted object.

====-orbradar====
'''"Enables 3D radar"'''

An Orb style 3D radar will replace the standard 2D version.

====-rearm_timer====
'''"Enable Rearm/Repair Completion Timer"'''

Displays time remaining until rearm and repair from a support ship is complete.

====-ballistic_gauge====
'''"Enable the analog Ballistic Ammo gauge"'''

Adds an ammo gauge to the HUD when armed with a ballistic weapon.

===Gameplay===
====-ship_choice_3d====
'''"Use Models for Ship Selection"'''

Uses ship models in ship selection window. It completely disables the standard ANI interface in this screen. 
Some mods need a compulsory use of this flag because they don't have available animations for their ships. In this situation, and if it is not used, the game will probably crash to desktop in the ship selection window.

====-weapon_choice_3d====
'''"Use Models for Weapon Selection"'''

Uses weapon models in weapon loadout window for secondary weapons (missiles and bombs). It completely disables the standard ANI interface in this screen. 
Some mods need a compulsory use of this flag because they don't have available animations for their secondary weapons. In this situation, and if it is not used, the game will probably crash to desktop in the weapon loadout window.

====-3dwarp====
'''"Enable 3D Warp"'''

Use full geometry for the subspace warp effect.

====-warp_flash====
'''"Enable Flash upon Warp"'''

Enable a flash at warp in and warp out.

====-no_ap_interrupt====
'''"Disable Interrupting of AutoPilot"'''

Tells the game to not allow players to interrupt an autopilot already-in-progress.

====-stretch_menu====
'''"Stretch interface to fill screen"'''

Scales the interface to fill the screen without preserving the aspect ratio. Omit this to keep the aspect ratio, adding black bars where appropriate.

===Audio===
====-snd_preload====
'''"Preload mission game sounds"'''

Useful in preventing game stuttering when sounds are played for the first time.

====-nosound====
'''"Disable Sound and Music"'''

====-nomusic====
'''"Disables Music"'''

===Multiplayer===
====-standalone====
'''"Run as Stand Alone Server"'''

Creates a standalone multi-player server.

====-startgame====
'''"Skip Mainhall and Start Hosting"'''

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====
'''"Start Hosted Server as 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====
'''"Host Confirms Join requests"'''

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====
{{Note| This feature is not available in current builds.}}

====-mpnoreturn====
'''"Disables Flight Deck option"'''

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

===Troubleshooting===
====-nohtl====
'''"Software Mode (very slow)"'''
{{Warning| Enabling this will significantly reduce performance.}}
Reverts to software rendering mode.

====-no_set_gamma====
'''"Disable Setting of Gamma"'''

Disables the gamma settings in the options screen.

====-nomovies====
'''"Disable Video Playback"'''

Disables all video playback.

====-noparseerrors====
'''"Disable Parsing Errors"'''

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.

====-parse_cmdline_only====
'''"Parse Command Line Only"'''

Parse only the application command line settings, and ignore any that may have been set in the on-disk data/cmdline_fso.cfg or per-user cmdline_fso.cfg (on Linux/Mac)

====-safeloading====
Loads missions the old way. Typically safer, but slower.
{{Note| This parameter was removed as of the July 5, 2011 nightly build.}}

====-query_speech====
'''"Does this build have Speech?"'''

Determines if the current build includes text-to-speech.

====-novbo====
'''"Disable OpenGL VBO"'''

====-noibx====
'''"Don't use cached index buffers (IBX)"'''

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"'''

====-disable_fbo====
'''"Disable OpenGL RenderTargets"'''

====-disable_pbo====
'''"Disable OpenGL Pixel Buffer Objects"'''

Disables the use of Pixel Buffer Objects (PBO) which may cause certain OpenGL operations to perform slower. Note PBO's were only used at three places in FSO anyway so it's *probably* not going to have a noticeable effect.

May be required to workaround issues in certain versions of Linux's Mesa drivers for Intel integrated graphics cards where crashes occur in the mainhall (i.e. whenever a popup occurs). Distros that seem to have this problem presently include Ubuntu 13.10 and openSUSE 13.1.
{{Table371|
*This feature is present to work around a bug in Linux's Mesa drivers for Intel integrated graphics cards}}

====-no_glsl====
'''"Disable GLSL (shader) Support"'''

Disables the use of GLSL rendering (OpenGL shaders). The game will revert to legacy fixed render pipeline. Please note that Normal and Height map effects will be unavailable.

====-disable_glsl_model====
'''"Don't use shaders for model rendering"'''

====-ati_swap====
'''"Fix Color issues on some ATI cards"'''

====-no_3d_sound====
'''"Use only 2D/stereo for sound effects"'''

====-disable_di_mouse====
'''"Disables the DirectInput mouse code for FSO on windows."'''

'''Windows Only''' Can make mouse movement smoother on certain machines.

====-mipmap====
'''"Enable mipmapping"'''

Causes for non-mipmapped textures to have mipmaps generated within the GPU on certain kind of texture formats, (IIRC, DDS formatted textures with a power of 2 size in both width and height). 
Since the use of already mipmapped DDS textures has become common, it has become deprecated.
The quality of the generated mipmaps depends on each GPU and used driver. It is normally used with [[Command-Line_Reference#-img2dds|-img2dds]] flag.

====-use_gldrawelements====
'''"Use glDrawElements instead of glDrawRangeElements"'''

Introduced as a means of switching to the slower OpenGL call glDrawElements, instead of glDrawRangeElements.
{{Table3614|
*This feature may resolve certain rendering problems where parts of models are not drawn on Linux drivers}}

====-keyboard_layout====
'''"Manually sets a keyboard layout"'''

A commandline parameter to set the keyboard layout as a string parameter.
{{Table3614|
*Currently the only valid string is "qwertz" (German) but French azerty may be added in future.}}

===Experimental===
====-ingame_join====
'''"Allows Ingame Joining"'''

Enables ingame joining in multiplayer. FIXME: Host option?

====-voicer====
'''"Voice Recognition"'''

Windows-only. Enables voice-recognition for wingmen commands. Must be specifically compiled into a build in order for it to be available; 3.6.10 final includes the feature. See [[Voice Recognition]] for more details.

====-fb_explosions====
'''"Enable Framebuffer Shockwaves"'''

===Development Tools===
====-fps====
'''"Show frames per second on HUD"'''

Displays current frames per second.

====-pos====
'''"Show Position of Camera"'''

Displays current position coordinates of camera.

====-window====
'''"Run in Window"'''

Runs the game in a window. No check to make sure that resolution is no higher than your desktop resolution, so be careful.

====-fullscreen_window====
'''"Run in Fullscreen Window"'''
{{Note| This feature is only available on Windows.}}

====-timerbar====
Displays a timing bar across the top of the screen. Timerbar format varies by build. This is a relic from the Volition development days, and is unmaintained.
{{Note| This parameter was removed as of the July 5, 2011 nightly build.}}

====-stats====
'''"Show Statistics"'''

Shows total and free physical memory, virtual memory and system pagefile.

====-coords====
'''"Show Coordinates"'''

Shows coordinates of the mouse cursor.

====-show_mem_usage====
'''"Show Memory Usage"'''

Shows detailed RAM usage based on file, handler and process usage and display on the left-center side of the screen during mission load and while in mission.

The meaning of the info displayed in the upper right corner of the HUD 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 does 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====
Reads all objects in the pof file of the selected mod, and creates an ibx cache file for each object in the data/cache folder for that mod. 
Details for each object are output to a pofspew.txt file created in the data folder. 
Otherwise, ibx files are created in game before each mission.

====-tablecrcs====
Is actually now (or should be) a typed reference rather than as a selection item. Takes 1 argument, usually a descriptive name.
Example usage: "-table_crcs MediaVPs" will create a table_crcs.csv file in the running mod (name can be separate of the mod selected) that allows for the validation of the tables used by that mod while on-line. The descriptive parameter given helps "allocate" that .csv file to the mod in question, and as such should closely or exactly match that mods name if possible.

====-missioncrcs====
Is actually now (or should be) a typed reference rather than as a selection item. Takes 1 argument, usually a descriptive name.
Example usage: "-mission_crcs MediaVPs" will create a mission_crcs.csv file in the running mod (name can be separate of the mod selected) that allows for the validation of the missions used by that mod while on-line. The descriptive parameter given helps "allocate" that .csv file to the mod in question, and as such should closely or exactly match that mods name if possible.

====-dis_collisions====
'''"Disable Collisions"'''

Disables all collisions.

====-dis_weapons====
'''"Disable Weapon Rendering"'''

Disables weapons rendering.

====-output_sexps====
This will make the FSO build spit out an html file that documents the supported SEXP's.

Just double click on sexps.html and it should open in your default web browser.

====-output_scripting====
This will make the FSO build spit out an html file that documents the supported scripting hooks and LUA libraries.

Just double click on scripting.html and it should open in your default web browser.

====-nograb====
Disables focus grabbing in a window.
{{Note| This feature is not available on Windows.}}

====-save_render_target====
'''"Save Render Targets to file"'''

====-debug_window====
'''"Display Debug Window"'''

Lists the fs2_open.log in (nearly)real-time generation.

====-verify_vps====
'''"Spew VP crcs to vp_crcs.txt"'''

Exports the CRC values of the VP files being loaded into a vp_crcs.txt file.

====-reparse_mainhall====
'''"Reparse mainhall.tbl when loading halls"'''

Mainhall.tbl will be reparsed every time a mainhall is loaded, as opposed to just once at game startup.

====-start_mission====
'''"Skip the mainhall in jump right into the specified mission"'''

Jump into the mission specified by the filename. Only in effect on the first run. This will skip load of the mainhall and its other related things altogether.

====-profile_frame_time====
'''"Profile engine subsystems"'''

Activates the frame profiling code. This presents a readout showing the current, minimum, maximum and average percentages of frametime a given section of code has taken up; this can be used to identify particular bottlenecks or measure the effectiveness of certain optimizations.

====-profile_write_file====
'''"Write profiling information to file"'''

This will write the frame times of each gameplay frame to the file 'profiling.csv' where each line is ''<framenumber>;<frametime>''. The first two frames are usually very long because the timer is set at engine startup so you might want to exclude those from your data.

====-no_unfocused_pause====
'''"Don't pause if the window isn't focused"'''

When the FSO window looses focus it will not pause the game, useful for doing non-interactive test runs.

==Other==
The following options are not available as checkboxes in the launcher. Many require parameters, which follow the flag separated by a space. The prototype for use in this case is "-option argument"

===Lighting===
These factors can dramatically alter the atmosphere of the game. [[Sample Lighting Settings|This page]] has some sample lighting settings with screenshots.

====-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.

====-no_emissive_light====
By default, all ships in FS2 have a light generated on their own, it is more or less similar to a minimal amount of -ambient_factor. This feature was implemented to help the player seeing the ships over a black background. This flag disables this feature. Use it with a low -ambient_factor value to obtain an ultra-realistic dark looking.

====-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. This is a relative value.

====-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. This is a relative value.

====-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. This is a relative value.

====-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. This is a relative value.

====-ogl_spec====
Takes a numerical argument. This value changes the basic shininess of the specular light in OpenGL. A lower value reduces the overall intensity of the light making it broader and less powerful. A higher value makes it more focused and brighter. The default value is 80, and the usable range is 0 to 128 (clamped). The original default value was 60, but it was raised to behave more D3D like.

===Graphics===
====-bloom_intensity====
Requires -post_processing ("Enable Post Processing") command.
Default value is 75. Range is 0-200.

====-height====
Enables height maps (parallax mapping). It only works if [[Command-Line_Reference#-normal|-normal]] is also set. It also needs GLSL rendering, (see [[OpenGL_Shaders_(GLSL)|OpenGL Shaders (GLSL)]] for further info). It needs auxiliary height maps (with the same name than base map plus "-height").
{{Table3615|
*This feature is on by default. To manually disable, enter the flag -noheight}}

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

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

====-res====
Allows you to specify a resolution if the desired one cannot be set in the Launcher.
For example, -res 1920x1080 would run the game in 1920 x 1080 resolution. Since it requires an argument, it needs to be entered as a custom flag when using the Launcher. The "Run at specified resolution" option the Launcher gives is essentially this, but without being able to actually specify a resolution, it doesn't work.

====-fxaa_preset====
Requires both -post_processing and -fxaa. Can be used to adjust the FXAA quality and speed, 0 is fastest, 9 is highest quality. Default setting is 6.

===Gameplay===
====-mod====
Specifies in which folders inside FreeSpace 2 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 behavior, 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/

This flag can be indirectly set, (and it is normally set), through Launcher MOD tab and [[mod.ini]] file.

Within the Launcher's MOD 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 it will be used to modify the -mod flag, too.

For further details, see '''[[mod.ini]]'''

'''Data precedence'''

As already said, within the different directories, the data precedence is set by the specified order in the -mod flag. The lowest priority goes to the Freespace2 installation directory.

Inside each directory, data precedence is the following:

#Individual files located in ''Current_dir/data/'' subdir structure. See [[FS2_Data_Structure|FS2 Data Structure topic]] for deeper info about the different folders and contents this structure has.
#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 that this ''Mission.fs2'' is also 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 enhanced ones adding them in a higher priority place.

'''Additional notes'''
# As derived from the 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.
# This flag is also used by [[Portal:FRED|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. A special build of wxLauncher is able to configure FRED so that the -mod doesn't have to be done manually see [http://www.hard-light.net/forums/index.php?topic=67950.msg1387911#msg1387911 the forum post] for more details.
{{Table3612|As of 3.6.12 FRED now loads cmdline_fso.cfg just like FS does so FRED will use the same settings as FS including the -mod settings}}
# 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.

{{Warning| '''Priority and Texture Formats'''

''Obsolete behavior - Until FS2_open v3.6.9.:''

FS2_Open can use several file formats in textures: [http://en.wikipedia.org/wiki/PCX PCX], [http://en.wikipedia.org/wiki/DirectDraw_Surface DDS], [http://en.wikipedia.org/wiki/JPG JPG] and [http://en.wikipedia.org/wiki/TGA TGA]. Make sure you keep the format when you update your texture. For example if you update the old ''TextureOfMyFighter.tga'', do not save it as ''TextureOfMyFighter.dds'' in a higher priority place, because there is a chance of the game loading the old one despite of all.

The reason to do this is that, loading process (including priorities) is applied firstly for a kind of textures (TGAs), then for another kind (JPGs), and so on. This behavior can lead to situation where your new, updated and higher priority placed texture is not read because the format of the older one.

''New behavior - From FS2_open v3.6.10. (including previous beta testing releases):''

The former issue has been fixed. Now texture format priority is only applied within the same location. In this ''strange'' situation it goes DDS -> TGA -> JPG -> PCX. Examples:
* ''/Freespace2/MyVp.vp>>>data/maps/MyTexture.dds'' is loaded instead of ''/Freespace2/MyVp.vp>>>data/maps/MyTexture.tga''.
* But your improved ''/Freespace2/data/maps/MyTexture.xxx'' will override them both despite of its format.
In this way, when you update any texture, you don't have to pay attention to its original format. Just place it in a higher priority place.

Nevertheless, global priority is kept between animated and static textures. Because of their management, animated textures (ANIs and EFFs) are looked for BEFORE static ones. In this way there's no way to update an animated texture with a static one (an obsolete ANI is always going to be loaded before the newer DDS version). The solution: use an updated EFF with just one frame.

}}

====-fov====
This flag allows the player to specify the ''vertical'' Field of View (FoV) angle, in radians, for the player eyepoint. The angle is measured across the full height of the viewing cone. The FoV angle is technically known as the Angle of View (AoV)

*Syntax: '''''float''''' Angle
*Valid Values: 0 to 2*Pi radians
*Default Value: 0.75 radians

{{Note|For peculiar reasons, the actual FoV/AoV used by the game will be the supplied value multiplied by 1.39626348.}}

The the FoV angle/AoV is what determines the relative zoom level of the main game camera. Smaller angles generally equal to higher zoom levels, while larger angles equal to lower zoom levels (down to the theoretical x0 magnification).

However, too small of an angle will have a squashed look on the edges of your screen, and too high of an angle will greatly stretch edges. It is recommended to change the AoV, as FS2's default AoV has some perspective distortion at the screen edges (the default AoV is too high).

A natural looking (as if you where physically in the cockpit) AoV depends on the distance the player's actual eyes are away from the screen: the further away from the screen, the smaller the AoV should be, and vice versa. "Ergonomic" distances generally yield a '''''diagonal''''' AoV of 0.523 radians (30 degrees), but you can easily find the natural AoV by the following formula:

AoV (radians) = 2 * atan( H / ( 2*D ))

where:

Height of screen = H

Distance between head/eye and the screen = D

Generally, gamers like to increase the AoV in order to increase their peripheral vision on the screen, so as to gain a better situational awareness around their craft. An AoV of 0.39 radians seems to be a good start, but feel free to experiment and use whatever AoV you are most comfortable with.

===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 standalone 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 standalone 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 standalone game.

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

====-connect====
{{Sectstub}}
====-timeout====
{{Sectstub}}
====-cap_object_update====
Caps the maximum object update the server will respond to regardless of what the client has set. If the client is set to request high object updates but the server is capped to low, then that's all the client will get.

Takes one argument integer (0 to 3) which corresponds to the object update cap (With 0 being low and 3 being LAN).

===Help===
====-help====
Instructs FSO to print out all supported parameters. Some launchers can use these options to automatically populate the available command line options, even if the version of FSO is far newer than the launcher itself. NOTE: This option only works in Linux builds...

====--help====
See [[Command-Line_Reference#-help|-help]]

====-h====
See [[Command-Line_Reference#-help|-help]]

====-?====
See [[Command-Line_Reference#-help|-help]]

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

Mac Development Guide

2014-04-20T08:57:29Z

Echelon9: Reflect latest Xcode version number and the path naming of trunk LLVM

This page provides background and instructions to setup the Xcode development environment in order to compile FreeSpace 2 Open SCP. After following these instructions you will have a working Xcode build environment, a checked out copy of the latest FS2_Open source code, and compiled binaries of the latest revision of the FS2_Open engine.

[[Image:Xcode icon.png‎|right|110px]]

==Getting Xcode==
Xcode is the integrated development environment (IDE) that Apple provides free of charge for the Mac OS platform. It is the Mac equivalent to Microsoft Visual Studio. In practice, Xcode provides a graphical interface to an underlying Clang/LLVM compiler; with the addition of platform libraries (Frameworks), code completion, project management and the other features you would expect of a modern IDE.

Xcode is available free from the Mac App Store.

It is '''strongly recommended''' that you update to the latest version of Xcode compatible with your Mac OS version, as prior versions have bugs which prevent FS2_Open from compiling properly.

{| style="text-align:center"
|+ ''Known working combinations''
! !! OS X 10.9 !! OS X 10.8 !! OS X 10.7
|-
! Xcode 5.1.1
| Yes || Yes || n/a
|-
! Xcode 5.0.2
| Yes || Yes || n/a
|-
! Xcode 4.2.1
| n/a || n/a || Partially
|-
! Xcode 3.2.6
| n/a || n/a || Yes
|}

==Getting FreeSpace 2 Open SCP source code==

Open Terminal.app through Spotlight, or it can be found in /Applications/Utilities/Terminal.app. This is the console command line for Mac OS. You will need a location to save the checked out source code. The following commands will create a new folder in your personal Documents called 'coding' and then within a subfolder specific for FS2_Open called 'fs2_open' checkout the latest Subversion revision.

cd Documents
mkdir coding
cd coding
svn checkout svn://svn.icculus.org/fs2open/trunk/fs2_open fs2_open

Open Finder and browse to ~/Documents/coding/fs2_open/ to see the new files that have been downloaded from the FS2_Open Subversion source code repository.

FS2_Open currently uses some precompiled third party Frameworks to handle music and video on Mac OS, which are stored in compressed form within Subversion. Open the 'projects' folder and then 'Xcode4'. This is the location of recent Xcode specific project files and settings. For now, double click on Frameworks.tgz to uncompress these Frameworks to a new folder called Frameworks.

Your local SVN checkout of the FreeSpace 2 Open SCP code can be keep up to date with the latest changes by opening Terminal.app again, and running the following commands

cd Documents/coding/fs2_open
svn up

Xcode and the FreeSpace 2 Open SCP source code is now setup, so let's start our first compilation by double clicking on the FS2_Open.xcodeproj Xcode project file.

==Compiling FreeSpace 2 Open SCP source code (GUI)==

Click the 'Build' button or press Apple key+B. This should complete successfully, and once done the binary application can be found within 'projects/Xcode4/build/'. Open the folder with the same name as the build type you selected previously to find the compiled FS2_Open application.
[[Category:Source Code Project]][[Category:FreeSpace_Open_on_Mac]]

==Compiling FreeSpace 2 Open SCP source code (Command line)==

Open Terminal.app and run the following commands to build a Debug version of FS2_Open

cd Documents/coding/fs2_open/projects/Xcode4
xcodebuild

In order to build an AddressSanitizer build, first a trunk version of Clang/LLVM must be downloaded and installed as the Apple-supplied Clang does not enable AddressSanitizer features.

Following the instructions at http://clang.llvm.org/get_started.html

Then use this trunk build of Clang instead of the Apple-supplied Clang to build FS2_Open with AddressSanitizer

cd Documents/coding/fs2_open/projects/Xcode4
export CC=/path/to/llvm/../build/Debug+Asserts/bin/clang
export CXX=/path/to/llvm/../build/Debug+Asserts/bin/clang++
export CFLAGS=-fsanitize=address
export LDFLAGS=-fsanitize=address
xcodebuild CC=$CC CXX=$CXX OTHER_CFLAGS=$CFLAGS LDFLAGS=$LDFLAGS LDPLUSPLUS=$CXX CLANG_LINK_OBJC_RUNTIME=NO

You may need to open the Xcode GUI and copy the following file into the Linked Frameworks

/path/to/llvm/build/Debug+Asserts/lib/clang/3.5.0/lib/darwin/libclang_rt.asan_osx_dynamic.dylib

FS2_Open must be run from the Terminal to enable to AddressSanitizer feature at runtime. Additionally, to ensure line references and the like are cleanly shown the output must be piped to a Python script which symobilizes line references

./FS2_Open\ $debug$.app/Contents/MacOS/FS2_Open\ $debug$ 2>&1 | /path/to/llvm/projects/compiler-rt/lib/asan/scripts/asan_symbolize.py | c++filt

FS2 WebUI Standalone

2014-03-24T13:02:32Z

Echelon9: Clarify that WebUI standalone works on Mac as well

The WebUI standalone was created by SCP member Eli2 to enable *nix and Mac machines to run a standalone FS2 server.

==How to Use==

Just add the -standalone command line option to your startup script, or run the game with the Standalone option enabled from wxLauncher, etc. I highly recommend avoiding wxLauncher for the time being, as it isn't really aware of the *nix standalone and I don't think it can open a monitoring terminal window for you.

==Configuration==

The following items are specific to the *nix <fs2_local_data_folder>/data/multi.cfg file, where the local data folder is likely ~/Library/FS2_Open/ for OS X or ~/.fs2_open/ for other *nix platforms. The rest of the file should work like a normal Windows standalone. An example file can be found at the bottom of the page.

===+webui_root===
*Set this value to wherever you have placed the webui document root. You can grab it by downloading and extracting the [https://github.com/scp-fs2open/fs2open_webui/archive/master.zip master branch archive] from Github, or by cloning the [https://github.com/scp-fs2open/fs2open_webui Github Webui repository], in the directory you would like to store the WebUI pages. So if you run extract or clone the repo in your home folder, your setting might look something like:
<pre>+webui_root /home/username/fs2open_webui</pre>

===+webapi_username===
Username for accessing the WebUI administration page.

===+webapi_password===
Password for accessing the WebUI administration page.

===+webapi_server_port===
Set to change the WebUI server to be running on a different port than the default 8080.

===+use_pxo===
For FS2NetD connectivity, you will also need to define +use_pxo, as you probably don't have the ability to run the GUI and turn on the PXO checkbox in the game when running the standalone on a headless server.

==Connecting==

The WebUI currently listens on port 8080 by default, using unencrypted HTTP. The default user and pass for administration is admin:admin. It is highly recommended to change these default settings in your multi.cfg file. To secure this, the current recommendation is to run the server behind a firewall and access it via an SSH tunnel or VPN. Since most *nix machines are themselves accessible via SSH, I will describe the basics needed to set up an SSH tunnel as pertains to this standalone.

===From Windows===
[http://howto.ccs.neu.edu/howto/windows/ssh-port-tunneling-with-putty/ This page] has almost the exact directions you will need to set up a tunnel from Windows to your standalone server. The two things you need to know on the SSH tunnel tab are the ip/hostname of the computer running the standalone, that will resolve on the ssh server (if you SSH into a different machine on the network than the one running the standalone), and the port number on that machine will be 8080. You can set the Source Port to whatever you like, I will use a different port for clarity (8081). So if the SSH server computer can access your standalone server on its network via the hostname 'standalone', your destination line will be standalone:8080. If you use 8081 for your client port as well, the final entry in the forwarded ports list will look like:
<pre>L8081 standalone:8080</pre>

===From CLI SSH on Linux/OSX/etc===
You'll need to open a terminal window, and know the normal SSH command you use to access the SSH server on the network where the standalone is running. Let's say you SSH into myip.dyndns.com, on the default port 22. Your username on the ssh server is 'me'. The standalone is running on another machine on the same network as the SSH server, named standalone. The standalone runs on port 8080. You want to be able to access the WebUI in your browser on port 8081. You need to add the -L parameter to your ssh command to resemble the following:
<pre>ssh -L 8081:standalone:8080 me@myip.dyndns.com</pre>

===Connect to the WebUI===
Now that the SSH tunnel is set up in Putty or your shell, you can just open your browser and point it to [http://localhost:8081/ http://localhost:8081/]. Then you can log in with the credentials (default admin:admin unless set otherwise in multi.cfg) and access the interface.

==WebUI Interface==

Below is a description of the tabs in the WebUI interface.

===Server===
This tab displays the server's current configuration, and allows you to set various options.

===Mission===
Information about the currently running mission on the server.

===Chat===
You can send chat messages directly to participants on the standalone, and see the messages from the players to all recipients.

===Debug===
This contains debugging output information from the server. If things go wrong, please include this information as well as your fs2_standalone.log (found in same location as fs2_open.log) if using a Debug build in any bug reports.

==Known Issues==

This server is still in beta stage. So far, the current issues still exist:

*No SSL to protect your authentication password, which is why the SSH tunnel is currently recommended, as that essentially solves the issue for the time being.
*Servers (whether WebUI standalone or otherwise) do not feature NAT punchthrough, as much of the traffic is UDP traffic. This means the standalone host must be on a public facing IP address, or you must set up port forwarding using standard FreeSpace 2 Open ports. For those on cable or ADSL modem connections, the "DMZ" feature of your modem/router will achieve the equivalent outcome.

==Sample multi.cfg for WebUI standalone server==

<pre>
+name WebUI Test
+no_voice
+datarate 1000000000
+high_update
+max_players 12
+use_pxo
+pxo #Eleh
+pxo_login chief_standalone
+pxo_password [Insert Password]
+webui_root /home/chief1983/fs2open_webui
+webapi_username [Insert Username]
+webapi_password [Insert Password]
+webapi_server_port 8080
</pre>

Mac Development Guide

2014-03-15T11:26:52Z

Echelon9: Revise and update the OSX and Xcode support table to reflect the modern reality of developer systems (95% confidence interval)

This page provides background and instructions to setup the Xcode development environment in order to compile FreeSpace 2 Open SCP. After following these instructions you will have a working Xcode build environment, a checked out copy of the latest FS2_Open source code, and compiled binaries of the latest revision of the FS2_Open engine.

[[Image:Xcode icon.png‎|right|110px]]

==Getting Xcode==
Xcode is the integrated development environment (IDE) that Apple provides free of charge for the Mac OS platform. It is the Mac equivalent to Microsoft Visual Studio. In practice, Xcode provides a graphical interface to an underlying Clang/LLVM compiler; with the addition of platform libraries (Frameworks), code completion, project management and the other features you would expect of a modern IDE.

Xcode is available free from the Mac App Store.

It is '''strongly recommended''' that you update to the latest version of Xcode compatible with your Mac OS version, as prior versions have bugs which prevent FS2_Open from compiling properly.

{| style="text-align:center"
|+ ''Known working combinations''
! !! OS X 10.9 !! OS X 10.8 !! OS X 10.7
|-
! Xcode 5.1
| Yes || Yes || n/a
|-
! Xcode 5.0.2
| Yes || Yes || n/a
|-
! Xcode 4.2.1
| n/a || n/a || Partially
|-
! Xcode 3.2.6
| n/a || n/a || Yes
|}

==Getting FreeSpace 2 Open SCP source code==

Open Terminal.app through Spotlight, or it can be found in /Applications/Utilities/Terminal.app. This is the console command line for Mac OS. You will need a location to save the checked out source code. The following commands will create a new folder in your personal Documents called 'coding' and then within a subfolder specific for FS2_Open called 'fs2_open' checkout the latest Subversion revision.

cd Documents
mkdir coding
cd coding
svn checkout svn://svn.icculus.org/fs2open/trunk/fs2_open fs2_open

Open Finder and browse to ~/Documents/coding/fs2_open/ to see the new files that have been downloaded from the FS2_Open Subversion source code repository.

FS2_Open currently uses some precompiled third party Frameworks to handle music and video on Mac OS, which are stored in compressed form within Subversion. Open the 'projects' folder and then 'Xcode4'. This is the location of recent Xcode specific project files and settings. For now, double click on Frameworks.tgz to uncompress these Frameworks to a new folder called Frameworks.

Your local SVN checkout of the FreeSpace 2 Open SCP code can be keep up to date with the latest changes by opening Terminal.app again, and running the following commands

cd Documents/coding/fs2_open
svn up

Xcode and the FreeSpace 2 Open SCP source code is now setup, so let's start our first compilation by double clicking on the FS2_Open.xcodeproj Xcode project file.

==Compiling FreeSpace 2 Open SCP source code (GUI)==

Click the 'Build' button or press Apple key+B. This should complete successfully, and once done the binary application can be found within 'projects/Xcode4/build/'. Open the folder with the same name as the build type you selected previously to find the compiled FS2_Open application.
[[Category:Source Code Project]][[Category:FreeSpace_Open_on_Mac]]

==Compiling FreeSpace 2 Open SCP source code (Command line)==

Open Terminal.app and run the following commands to build a Debug version of FS2_Open

cd Documents/coding/fs2_open/projects/Xcode4
xcodebuild

In order to build an AddressSanitizer build, first a trunk version of Clang/LLVM must be downloaded and installed as the Apple-supplied Clang does not enable AddressSanitizer features.

Following the instructions at http://clang.llvm.org/get_started.html

Then use this trunk build of Clang instead of the Apple-supplied Clang to build FS2_Open with AddressSanitizer

cd Documents/coding/fs2_open/projects/Xcode4
export CC=/path/to/llvm/../build/Debug+Asserts/bin/clang
export CXX=/path/to/llvm/../build/Debug+Asserts/bin/clang++
export CFLAGS=-fsanitize=address
export LDFLAGS=-fsanitize=address
xcodebuild CC=$CC CXX=$CXX OTHER_CFLAGS=$CFLAGS LDFLAGS=$LDFLAGS LDPLUSPLUS=$CXX CLANG_LINK_OBJC_RUNTIME=NO

You may need to open the Xcode GUI and copy the following file into the Linked Frameworks

/path/to/llvm/build/Debug+Asserts/lib/clang/3.5/lib/darwin/libclang_rt.asan_osx_dynamic.dylib

FS2_Open must be run from the Terminal to enable to AddressSanitizer feature at runtime. Additionally, to ensure line references and the like are cleanly shown the output must be piped to a Python script which symobilizes line references

./FS2_Open\ $debug$.app/Contents/MacOS/FS2_Open\ $debug$ 2>&1 | /path/to/llvm/projects/compiler-rt/lib/asan/scripts/asan_symbolize.py | c++filt

Mac Development Guide

2014-01-26T11:45:14Z

Echelon9: /* Compiling FreeSpace 2 Open SCP source code (Command line) */ Pick up latest Clang version upstream

This page provides background and instructions to setup the Xcode development environment in order to compile FreeSpace 2 Open SCP. After following these instructions you will have a working Xcode build environment, a checked out copy of the latest FS2_Open source code, and compiled binaries of the latest revision of the FS2_Open engine.

[[Image:Xcode icon.png‎|right|110px]]

==Getting Xcode==
Xcode is the integrated development environment (IDE) that Apple provides free of charge for the Mac OS platform. It is the Mac equivalent to Microsoft Visual Studio. In practice, Xcode provides a graphical interface to an underlying Clang/LLVM compiler; with the addition of platform libraries (Frameworks), code completion, project management and the other features you would expect of a modern IDE.

Xcode is available free from the Mac App Store.

It is '''strongly recommended''' that you update to the latest version of Xcode compatible with your Mac OS version, as prior versions have bugs which prevent FS2_Open from compiling properly.

{| style="text-align:center"
|+ ''Known working combinations''
! !! OS X 10.9 !! OS X 10.8.5 !! OS X 10.7 !! OS X 10.6.8
|-
! Xcode 5.0.2
| Yes || Yes || n/a || n/a
|-
! Xcode 4.2.1
| n/a || n/a || Partially || Not as yet
|-
! Xcode 3.2.6
| n/a || n/a || Yes || Yes
|-
! Xcode 3.1.4
| n/a || n/a || n/a || No
|-
! Xcode 3.0.0
| n/a || n/a || n/a || Unknown
|}

==Getting FreeSpace 2 Open SCP source code==

Open Terminal.app through Spotlight, or it can be found in /Applications/Utilities/Terminal.app. This is the console command line for Mac OS. You will need a location to save the checked out source code. The following commands will create a new folder in your personal Documents called 'coding' and then within a subfolder specific for FS2_Open called 'fs2_open' checkout the latest Subversion revision.

cd Documents
mkdir coding
cd coding
svn checkout svn://svn.icculus.org/fs2open/trunk/fs2_open fs2_open

Open Finder and browse to ~/Documents/coding/fs2_open/ to see the new files that have been downloaded from the FS2_Open Subversion source code repository.

FS2_Open currently uses some precompiled third party Frameworks to handle music and video on Mac OS, which are stored in compressed form within Subversion. Open the 'projects' folder and then 'Xcode4'. This is the location of recent Xcode specific project files and settings. For now, double click on Frameworks.tgz to uncompress these Frameworks to a new folder called Frameworks.

Your local SVN checkout of the FreeSpace 2 Open SCP code can be keep up to date with the latest changes by opening Terminal.app again, and running the following commands

cd Documents/coding/fs2_open
svn up

Xcode and the FreeSpace 2 Open SCP source code is now setup, so let's start our first compilation by double clicking on the FS2_Open.xcodeproj Xcode project file.

==Compiling FreeSpace 2 Open SCP source code (GUI)==

Click the 'Build' button or press Apple key+B. This should complete successfully, and once done the binary application can be found within 'projects/Xcode4/build/'. Open the folder with the same name as the build type you selected previously to find the compiled FS2_Open application.
[[Category:Source Code Project]][[Category:FreeSpace_Open_on_Mac]]

==Compiling FreeSpace 2 Open SCP source code (Command line)==

Open Terminal.app and run the following commands to build a Debug version of FS2_Open

cd Documents/coding/fs2_open/projects/Xcode4
xcodebuild

In order to build an AddressSanitizer build, first a trunk version of Clang/LLVM must be downloaded and installed as the Apple-supplied Clang does not enable AddressSanitizer features.

Following the instructions at http://clang.llvm.org/get_started.html

Then use this trunk build of Clang instead of the Apple-supplied Clang to build FS2_Open with AddressSanitizer

cd Documents/coding/fs2_open/projects/Xcode4
export CC=/path/to/llvm/../build/Debug+Asserts/bin/clang
export CXX=/path/to/llvm/../build/Debug+Asserts/bin/clang++
export CFLAGS=-fsanitize=address
export LDFLAGS=-fsanitize=address
xcodebuild CC=$CC CXX=$CXX OTHER_CFLAGS=$CFLAGS LDFLAGS=$LDFLAGS LDPLUSPLUS=$CXX CLANG_LINK_OBJC_RUNTIME=NO

You may need to open the Xcode GUI and copy the following file into the Linked Frameworks

/path/to/llvm/build/Debug+Asserts/lib/clang/3.5/lib/darwin/libclang_rt.asan_osx_dynamic.dylib

FS2_Open must be run from the Terminal to enable to AddressSanitizer feature at runtime. Additionally, to ensure line references and the like are cleanly shown the output must be piped to a Python script which symobilizes line references

./FS2_Open\ $debug$.app/Contents/MacOS/FS2_Open\ $debug$ 2>&1 | /path/to/llvm/projects/compiler-rt/lib/asan/scripts/asan_symbolize.py | c++filt

Command-Line Reference

2014-01-02T04:34:04Z

Echelon9: /* -nograb */

Command-Line Flags (also called Command-Line Parameters) are optional flags passed to the FSO executable, and generally enables one or more features added to the FS2 Open engine. These flags are accessed conveniently through an [[FSO Launcher]]. To have FSO list all available flags, use any one of the following: [[Command-Line_Reference#-help|-help]], [[Command-Line_Reference#-help|--help]], [[Command-Line_Reference#-help|-h]], or [[Command-Line_Reference#-help|-?]].



===Graphics===
====-spec====
'''"Enable Specular"'''

Only polygons mapped with textures for which a shinemap exists will receive 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).
{{Table3615|
*This feature is on by default, use launcher option Disable Specular or if necessary to manually disable enter the flag -nospec}}

====-env====
'''"Enable Environment maps"'''

It only works if [[Command-Line_Reference#-spec|-spec]] is also set. Environment mapping intensity will be determined from the shine map too (see [[Texturing]] for more info). [[Installing FreeSpace 2 Open#Video setup|See Video setup.]]
{{Table3615|
*This feature is on by default, use launcher option Disable Environment Maps or if necessary to manually disable enter the flag -noenv }}

====-glow====
'''"Enable Glowmaps"'''

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)
{{Table3615|
*This feature is on by default, use launcher option Disable Glow Maps or if necessary to manually disable enter the flag -noglow }}

====-nomotiondebris====
'''"Disable motion debris"'''

====-noscalevid====
"Disable scale-to-window for Movies"

Disables fullscreen scaling of video clips.

====-missile_lighting====
'''"Apply Lighting to Missiles"'''

====-normal====
'''"Enable Normal Maps"'''

Normal maps require GLSL rendering, (see [[OpenGL_Shaders_(GLSL)|OpenGL Shaders (GLSL)]] for further info). It needs auxiliary normal maps (the same name of the base map plus "-normal"). DXT5_NM DDS format is needed. (Technical note: DXT5 will work, since only the GREEN and ALPHA channels are read by the current shader system. One direction of lines goes into the GREEN channel, the other direction goes into the ALPHA channel. RED and BLUE can be either base gray (#808080) or black. Usual practice is after creating the DXT5_NM, copy the RED channel to the ALPHA channel, black out the RED and BLUE an then save as either a DXT5 or u8888 (uncompressed) DDS file.)
{{Table3615|
*This feature is on by default, use launcher option Disable Normal Maps or if necessary to manually disable enter the flag -nonormal }}

====-post_process====
'''"Enable Post Processing"'''

enables the use (if present) of post-processing effects as defined by the post_process.tbl. Bloom usage has an additional cmdline option for setting it's value, most post processing effects are achieved in mission per the mission designer or can be enabled globally in the table.

====-soft_particles====
'''"Enable soft particles"'''

====-3dshockwave====
'''"Enable 3D Shockwaves"'''

This only has any effect when both a 2d and 3d shockwave effect are present, otherwise the only available effect is used.

====-fxaa====
'''"Enable FXAA antialiasing"'''

Enables the FXAA postprocessing stage. Further information can be found here: http://www.hard-light.net/forums/index.php?topic=76145.0

====-flightshaftsoff====
'''"Force Lightshafts off"'''

Disables Lightshafts even if a mission designer enables them via SEXP in a mission.

===Game Speed===
====-img2dds====
'''"Compress non-compressed images"'''

Converts all images to DDS (compressed) format. Decreases memory usage but potentially reduces image quality.

====-no_vsync====
'''"Disable vertical sync"'''

====-cache_bitmaps====
'''"Cache bitmaps between missions"'''

Will ideally reduce the load-time from one mission to another.

===HUD===
====-dualscanlines====
'''"Another Pair of Scanning Lines"'''

Adds a second pair of scanning lines to the target window when scanning an object.

====-targetinfo====
'''"Enable Info next to Target"'''

Displays target info, such as name and class, beside the targeted object.

====-orbradar====
'''"Enables 3D radar"'''

An Orb style 3D radar will replace the standard 2D version.

====-rearm_timer====
'''"Enable Rearm/Repair Completion Timer"'''

Displays time remaining until rearm and repair from a support ship is complete.

====-ballistic_gauge====
'''"Enable the analog Ballistic Ammo gauge"'''

Adds an ammo gauge to the HUD when armed with a ballistic weapon.

===Gameplay===
====-ship_choice_3d====
'''"Use Models for Ship Selection"'''

Uses ship models in ship selection window. It completely disables the standard ANI interface in this screen. 
Some mods need a compulsory use of this flag because they don't have available animations for their ships. In this situation, and if it is not used, the game will probably crash to desktop in the ship selection window.

====-weapon_choice_3d====
'''"Use Models for Weapon Selection"'''

Uses weapon models in weapon loadout window for secondary weapons (missiles and bombs). It completely disables the standard ANI interface in this screen. 
Some mods need a compulsory use of this flag because they don't have available animations for their secondary weapons. In this situation, and if it is not used, the game will probably crash to desktop in the weapon loadout window.

====-3dwarp====
'''"Enable 3D Warp"'''

Use full geometry for the subspace warp effect.

====-warp_flash====
'''"Enable Flash upon Warp"'''

Enable a flash at warp in and warp out.

====-no_ap_interrupt====
'''"Disable Interrupting of AutoPilot"'''

Tells the game to not allow players to interrupt an autopilot already-in-progress.

===Audio===
====-snd_preload====
'''"Preload mission game sounds"'''

Useful in preventing game stuttering when sounds are played for the first time.

====-nosound====
'''"Disable Sound and Music"'''

====-nomusic====
'''"Disables Music"'''

===Multiplayer===
====-standalone====
'''"Run as Stand Alone Server"'''

Creates a standalone multi-player server.

====-startgame====
'''"Skip Mainhall and Start Hosting"'''

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====
'''"Start Hosted Server as 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====
'''"Host Confirms Join requests"'''

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====
{{Warning| This feature is not available in current builds.}}

====-mpnoreturn====
'''"Disables Flight Deck option"'''

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

===Troubleshooting===
====-nohtl====
'''"Software Mode (very slow)"'''
{{Warning| Enabling this will significantly reduce performance.}}
Reverts to software rendering mode.

====-no_set_gamma====
'''"Disable Setting of Gamma"'''

Disables the gamma settings in the options screen.

====-nomovies====
'''"Disable Video Playback"'''

Disables all video playback.

====-noparseerrors====
'''"Disable Parsing Errors"'''

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.
{{Warning| This parameter was removed as of the July 5, 2011 nightly build.}}

====-query_speech====
'''"Does this build have Speech?"'''

Determines if the current build includes text-to-speech.

====-novbo====
'''"Disable OpenGL VBO"'''

====-noibx====
'''"Don't use cached index buffers (IBX)"'''

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"'''

====-disable_fbo====
'''"Disable OpenGL RenderTargets"'''

====-disable_pbo====
'''"Disable OpenGL Pixel Buffer Objects"'''

Disables the use of Pixel Buffer Objects (PBO) which may cause certain OpenGL operations to perform slower. Note PBO's were only used at three places in FSO anyway so it's *probably* not going to have a noticeable effect.

May be required to workaround issues in certain versions of Linux's Mesa drivers for Intel integrated graphics cards where crashes occur in the mainhall (i.e. whenever a popup occurs). Distros that seem to have this problem presently include Ubuntu 13.10 and openSUSE 13.1.
{{Table371|
*This feature is present to work around a bug in Linux's Mesa drivers for Intel integrated graphics cards}}

====-no_glsl====
'''"Disable GLSL (shader) Support"'''

Disables the use of GLSL rendering (OpenGL shaders). The game will revert to legacy fixed render pipeline. Please note that Normal and Height map effects will be unavailable.

====-disable_glsl_model====
'''"Don't use shaders for model rendering"'''

====-ati_swap====
'''"Fix Color issues on some ATI cards"'''

====-no_3d_sound====
'''"Use only 2D/stereo for sound effects"'''

====-disable_di_mouse====
'''"Disables the DirectInput mouse code for FSO on windows."'''

'''Windows Only''' Can make mouse movement smoother on certain machines.

====-mipmap====
'''"Enable mipmapping"'''

Causes for non-mipmapped textures to have mipmaps generated within the GPU on certain kind of texture formats, (IIRC, DDS formatted textures with a power of 2 size in both width and height). 
Since the use of already mipmapped DDS textures has become common, it has become deprecated.
The quality of the generated mipmaps depends on each GPU and used driver. It is normally used with [[Command-Line_Reference#-img2dds|-img2dds]] flag.

====-use_gldrawelements====
'''"Use glDrawElements instead of glDrawRangeElements"'''

Introduced as a means of switching to the slower OpenGL call glDrawElements, instead of glDrawRangeElements.
{{Table3614|
*This feature may resolve certain rendering problems where parts of models are not drawn on Linux drivers}}

====-keyboard_layout====
'''"Manually sets a keyboard layout"'''

A commandline parameter to set the keyboard layout as a string parameter.
{{Table3614|
*Currently the only valid string is "qwertz" (German) but French azerty may be added in future.}}

===Experimental===
====-ingame_join====
'''"Allows Ingame Joining"'''

Enables ingame joining in multiplayer. FIXME: Host option?

====-voicer====
'''"Voice Recognition"'''

Windows-only. Enables voice-recognition for wingmen commands. Must be specifically compiled into a build in order for it to be available; 3.6.10 final includes the feature. See [[Voice Recognition]] for more details.

====-fb_explosions====
'''"Enable Framebuffer Shockwaves"'''

===Development Tools===
====-fps====
'''"Show frames per second on HUD"'''

Displays current frames per second.

====-pos====
'''"Show Position of Camera"'''

Displays current position coordinates of camera.

====-window====
'''"Run in Window"'''

Runs the game in a window. No check to make sure that resolution is no higher than your desktop resolution, so be careful.

====-fullscreen_window====
'''"Run in Fullscreen Window"'''
{{Warning| This feature is only available on Windows.}}

====-timerbar====
Displays a timing bar across the top of the screen. Timerbar format varies by build. This is a relic from the Volition development days, and is unmaintained.
{{Warning| This parameter was removed as of the July 5, 2011 nightly build.}}

====-stats====
'''"Show Statistics"'''

Shows total and free physical memory, virtual memory and system pagefile.

====-coords====
'''"Show Coordinates"'''

Shows coordinates of the mouse cursor.

====-show_mem_usage====
'''"Show Memory Usage"'''

Shows detailed RAM usage based on file, handler and process usage and display on the left-center side of the screen during mission load and while in mission.

The meaning of the info displayed in the upper right corner of the HUD 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 does 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====
Reads all objects in the pof file of the selected mod, and creates an ibx cache file for each object in the data/cache folder for that mod. 
Details for each object are output to a pofspew.txt file created in the data folder. 
Otherwise, ibx files are created in game before each mission.

====-tablecrcs====
Is actually now (or should be) a typed reference rather than as a selection item. Takes 1 argument, usually a descriptive name.
Example usage: "-table_crcs MediaVPs" will create a table_crcs.csv file in the running mod (name can be separate of the mod selected) that allows for the validation of the tables used by that mod while on-line. The descriptive parameter given helps "allocate" that .csv file to the mod in question, and as such should closely or exactly match that mods name if possible.

====-missioncrcs====
Is actually now (or should be) a typed reference rather than as a selection item. Takes 1 argument, usually a descriptive name.
Example usage: "-mission_crcs MediaVPs" will create a mission_crcs.csv file in the running mod (name can be separate of the mod selected) that allows for the validation of the missions used by that mod while on-line. The descriptive parameter given helps "allocate" that .csv file to the mod in question, and as such should closely or exactly match that mods name if possible.

====-dis_collisions====
'''"Disable Collisions"'''

Disables all collisions.

====-dis_weapons====
'''"Disable Weapon Rendering"'''

Disables weapons rendering.

====-output_sexps====
This will make the FSO build spit out an html file that documents the supported SEXP's.

Just double click on sexps.html and it should open in your default web browser.

====-output_scripting====
This will make the FSO build spit out an html file that documents the supported scripting hooks and LUA libraries.

Just double click on scripting.html and it should open in your default web browser.

====-nograb====
Disables focus grabbing in a window.
{{Warning| This feature is not available on Windows.}}

====-save_render_target====
'''"Save Render Targets to file"'''

====-debug_window====
'''"Display Debug Window"'''

Lists the fs2_open.log in (nearly)real-time generation.

====-verify_vps====
'''"Spew VP crcs to vp_crcs.txt"'''

Exports the CRC values of the VP files being loaded into a vp_crcs.txt file.

====-reparse_mainhall====
'''"Reparse mainhall.tbl when loading halls"'''

Mainhall.tbl will be reparsed every time a mainhall is loaded, as opposed to just once at game startup.

====-start_mission====
'''"Skip the mainhall in jump right into the specified mission"'''

Jump into the mission specified by the filename. Only in effect on the first run. This will skip load of the mainhall and its other related things altogether.

====-profile_frame_time====
'''"Profile engine subsystems"'''

Activates the frame profiling code. This presents a readout showing the current, minimum, maximum and average percentages of frametime a given section of code has taken up; this can be used to identify particular bottlenecks or measure the effectiveness of certain optimizations.

==Other==
The following options are not available as checkboxes in the launcher. Many require parameters, which follow the flag separated by a space. The prototype for use in this case is "-option argument"

===Lighting===
These factors can dramatically alter the atmosphere of the game. [[Sample Lighting Settings|This page]] has some sample lighting settings with screenshots.

====-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.

====-no_emissive_light====
By default, all ships in FS2 have a light generated on their own, it is more or less similar to a minimal amount of -ambient_factor. This feature was implemented to help the player seeing the ships over a black background. This flag disables this feature. Use it with a low -ambient_factor value to obtain an ultra-realistic dark looking.

====-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. This is a relative value.

====-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. This is a relative value.

====-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. This is a relative value.

====-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. This is a relative value.

====-ogl_spec====
Takes a numerical argument. This value changes the basic shininess of the specular light in OpenGL. A lower value reduces the overall intensity of the light making it broader and less powerful. A higher value makes it more focused and brighter. The default value is 80, and the usable range is 0 to 128 (clamped). The original default value was 60, but it was raised to behave more D3D like.

===Graphics===
====-bloom_intensity====
Requires -post_processing ("Enable Post Processing") command.
Default value is 75. Range is 0-200.

====-height====
Enables height maps (parallax mapping). It only works if [[Command-Line_Reference#-normal|-normal]] is also set. It also needs GLSL rendering, (see [[OpenGL_Shaders_(GLSL)|OpenGL Shaders (GLSL)]] for further info). It needs auxiliary height maps (with the same name than base map plus "-height").
{{Table3615|
*This feature is on by default. To manually disable, enter the flag -noheight}}

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

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

====-res====
Allows you to specify a resolution if the desired one cannot be set in the Launcher.
For example, -res 1920x1080 would run the game in 1920 x 1080 resolution. Since it requires an argument, it needs to be entered as a custom flag when using the Launcher. The "Run at specified resolution" option the Launcher gives is essentially this, but without being able to actually specify a resolution, it doesn't work.

====-fxaa_preset====
Requires both -post_processing and -fxaa. Can be used to adjust the FXAA quality and speed, 0 is fastest, 9 is highest quality. Default setting is 6.

===Gameplay===
====-mod====
Specifies in which folders inside FreeSpace 2 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 behavior, 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/

This flag can be indirectly set, (and it is normally set), through Launcher MOD tab and [[mod.ini]] file.

Within the Launcher's MOD 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 it will be used to modify the -mod flag, too.

For further details, see '''[[mod.ini]]'''

'''Data precedence'''

As already said, within the different directories, the data precedence is set by the specified order in the -mod flag. The lowest priority goes to the Freespace2 installation directory.

Inside each directory, data precedence is the following:

#Individual files located in ''Current_dir/data/'' subdir structure. See [[FS2_Data_Structure|FS2 Data Structure topic]] for deeper info about the different folders and contents this structure has.
#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 that this ''Mission.fs2'' is also 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 enhanced ones adding them in a higher priority place.

'''Additional notes'''
# As derived from the 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.
# This flag is also used by [[Portal:FRED|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. A special build of wxLauncher is able to configure FRED so that the -mod doesn't have to be done manually see [http://www.hard-light.net/forums/index.php?topic=67950.msg1387911#msg1387911 the forum post] for more details.
{{Table3612|As of 3.6.12 FRED now loads cmdline_fso.cfg just like FS does so FRED will use the same settings as FS including the -mod settings}}
# 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.

{{Warning| '''Priority and Texture Formats'''

''Obsolete behavior - Until FS2_open v3.6.9.:''

FS2_Open can use several file formats in textures: [http://en.wikipedia.org/wiki/PCX PCX], [http://en.wikipedia.org/wiki/DirectDraw_Surface DDS], [http://en.wikipedia.org/wiki/JPG JPG] and [http://en.wikipedia.org/wiki/TGA TGA]. Make sure you keep the format when you update your texture. For example if you update the old ''TextureOfMyFighter.tga'', do not save it as ''TextureOfMyFighter.dds'' in a higher priority place, because there is a chance of the game loading the old one despite of all.

The reason to do this is that, loading process (including priorities) is applied firstly for a kind of textures (TGAs), then for another kind (JPGs), and so on. This behavior can lead to situation where your new, updated and higher priority placed texture is not read because the format of the older one.

''New behavior - From FS2_open v3.6.10. (including previous beta testing releases):''

The former issue has been fixed. Now texture format priority is only applied within the same location. In this ''strange'' situation it goes DDS -> TGA -> JPG -> PCX. Examples:
* ''/Freespace2/MyVp.vp>>>data/maps/MyTexture.dds'' is loaded instead of ''/Freespace2/MyVp.vp>>>data/maps/MyTexture.tga''.
* But your improved ''/Freespace2/data/maps/MyTexture.xxx'' will override them both despite of its format.
In this way, when you update any texture, you don't have to pay attention to its original format. Just place it in a higher priority place.

Nevertheless, global priority is kept between animated and static textures. Because of their management, animated textures (ANIs and EFFs) are looked for BEFORE static ones. In this way there's no way to update an animated texture with a static one (an obsolete ANI is always going to be loaded before the newer DDS version). The solution: use an updated EFF with just one frame.

}}

====-fov====
This flag allows the player to specify the ''vertical'' Field of View (FoV) angle, in radians, for the player eyepoint. The angle is measured across the full height of the viewing cone. The FoV angle is technically known as the Angle of View (AoV)

*Syntax: '''''float''''' Angle
*Valid Values: 0 to 2*Pi radians
*Default Value: 0.75 radians

{{Note|For peculiar reasons, the actual FoV/AoV used by the game will be the supplied value multiplied by 1.39626348.}}

The the FoV angle/AoV is what determines the relative zoom level of the main game camera. Smaller angles generally equal to higher zoom levels, while larger angles equal to lower zoom levels (down to the theoretical x0 magnification).

However, too small of an angle will have a squashed look on the edges of your screen, and too high of an angle will greatly stretch edges. It is recommended to change the AoV, as FS2's default AoV has some perspective distortion at the screen edges (the default AoV is too high).

A natural looking (as if you where physically in the cockpit) AoV depends on the distance the player's actual eyes are away from the screen: the further away from the screen, the smaller the AoV should be, and vice versa. "Ergonomic" distances generally yield a '''''diagonal''''' AoV of 0.523 radians (30 degrees), but you can easily find the natural AoV by the following formula:

AoV (radians) = 2 * atan( H / ( 2*D ))

where:

Height of screen = H

Distance between head/eye and the screen = D

Generally, gamers like to increase the AoV in order to increase their peripheral vision on the screen, so as to gain a better situational awareness around their craft. An AoV of 0.39 radians seems to be a good start, but feel free to experiment and use whatever AoV you are most comfortable with.

===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 standalone 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 standalone 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 standalone game.

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

====-connect====
{{Sectstub}}
====-timeout====
{{Sectstub}}
====-cap_object_update====
Caps the maximum object update the server will respond to regardless of what the client has set. If the client is set to request high object updates but the server is capped to low, then that's all the client will get.

Takes one argument integer (0 to 3) which corresponds to the object update cap (With 0 being low and 3 being LAN).

===Help===
====-help====
Instructs FSO to print out all supported parameters. Some launchers can use these options to automatically populate the available command line options, even if the version of FSO is far newer than the launcher itself. NOTE: This option only works in Linux builds...

====--help====
See [[Command-Line_Reference#-help|-help]]

====-h====
See [[Command-Line_Reference#-help|-help]]

====-?====
See [[Command-Line_Reference#-help|-help]]

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

Command-Line Reference

2014-01-02T04:33:03Z

Echelon9: /* -fullscreen_window */

Command-Line Flags (also called Command-Line Parameters) are optional flags passed to the FSO executable, and generally enables one or more features added to the FS2 Open engine. These flags are accessed conveniently through an [[FSO Launcher]]. To have FSO list all available flags, use any one of the following: [[Command-Line_Reference#-help|-help]], [[Command-Line_Reference#-help|--help]], [[Command-Line_Reference#-help|-h]], or [[Command-Line_Reference#-help|-?]].



===Graphics===
====-spec====
'''"Enable Specular"'''

Only polygons mapped with textures for which a shinemap exists will receive 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).
{{Table3615|
*This feature is on by default, use launcher option Disable Specular or if necessary to manually disable enter the flag -nospec}}

====-env====
'''"Enable Environment maps"'''

It only works if [[Command-Line_Reference#-spec|-spec]] is also set. Environment mapping intensity will be determined from the shine map too (see [[Texturing]] for more info). [[Installing FreeSpace 2 Open#Video setup|See Video setup.]]
{{Table3615|
*This feature is on by default, use launcher option Disable Environment Maps or if necessary to manually disable enter the flag -noenv }}

====-glow====
'''"Enable Glowmaps"'''

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)
{{Table3615|
*This feature is on by default, use launcher option Disable Glow Maps or if necessary to manually disable enter the flag -noglow }}

====-nomotiondebris====
'''"Disable motion debris"'''

====-noscalevid====
"Disable scale-to-window for Movies"

Disables fullscreen scaling of video clips.

====-missile_lighting====
'''"Apply Lighting to Missiles"'''

====-normal====
'''"Enable Normal Maps"'''

Normal maps require GLSL rendering, (see [[OpenGL_Shaders_(GLSL)|OpenGL Shaders (GLSL)]] for further info). It needs auxiliary normal maps (the same name of the base map plus "-normal"). DXT5_NM DDS format is needed. (Technical note: DXT5 will work, since only the GREEN and ALPHA channels are read by the current shader system. One direction of lines goes into the GREEN channel, the other direction goes into the ALPHA channel. RED and BLUE can be either base gray (#808080) or black. Usual practice is after creating the DXT5_NM, copy the RED channel to the ALPHA channel, black out the RED and BLUE an then save as either a DXT5 or u8888 (uncompressed) DDS file.)
{{Table3615|
*This feature is on by default, use launcher option Disable Normal Maps or if necessary to manually disable enter the flag -nonormal }}

====-post_process====
'''"Enable Post Processing"'''

enables the use (if present) of post-processing effects as defined by the post_process.tbl. Bloom usage has an additional cmdline option for setting it's value, most post processing effects are achieved in mission per the mission designer or can be enabled globally in the table.

====-soft_particles====
'''"Enable soft particles"'''

====-3dshockwave====
'''"Enable 3D Shockwaves"'''

This only has any effect when both a 2d and 3d shockwave effect are present, otherwise the only available effect is used.

====-fxaa====
'''"Enable FXAA antialiasing"'''

Enables the FXAA postprocessing stage. Further information can be found here: http://www.hard-light.net/forums/index.php?topic=76145.0

====-flightshaftsoff====
'''"Force Lightshafts off"'''

Disables Lightshafts even if a mission designer enables them via SEXP in a mission.

===Game Speed===
====-img2dds====
'''"Compress non-compressed images"'''

Converts all images to DDS (compressed) format. Decreases memory usage but potentially reduces image quality.

====-no_vsync====
'''"Disable vertical sync"'''

====-cache_bitmaps====
'''"Cache bitmaps between missions"'''

Will ideally reduce the load-time from one mission to another.

===HUD===
====-dualscanlines====
'''"Another Pair of Scanning Lines"'''

Adds a second pair of scanning lines to the target window when scanning an object.

====-targetinfo====
'''"Enable Info next to Target"'''

Displays target info, such as name and class, beside the targeted object.

====-orbradar====
'''"Enables 3D radar"'''

An Orb style 3D radar will replace the standard 2D version.

====-rearm_timer====
'''"Enable Rearm/Repair Completion Timer"'''

Displays time remaining until rearm and repair from a support ship is complete.

====-ballistic_gauge====
'''"Enable the analog Ballistic Ammo gauge"'''

Adds an ammo gauge to the HUD when armed with a ballistic weapon.

===Gameplay===
====-ship_choice_3d====
'''"Use Models for Ship Selection"'''

Uses ship models in ship selection window. It completely disables the standard ANI interface in this screen. 
Some mods need a compulsory use of this flag because they don't have available animations for their ships. In this situation, and if it is not used, the game will probably crash to desktop in the ship selection window.

====-weapon_choice_3d====
'''"Use Models for Weapon Selection"'''

Uses weapon models in weapon loadout window for secondary weapons (missiles and bombs). It completely disables the standard ANI interface in this screen. 
Some mods need a compulsory use of this flag because they don't have available animations for their secondary weapons. In this situation, and if it is not used, the game will probably crash to desktop in the weapon loadout window.

====-3dwarp====
'''"Enable 3D Warp"'''

Use full geometry for the subspace warp effect.

====-warp_flash====
'''"Enable Flash upon Warp"'''

Enable a flash at warp in and warp out.

====-no_ap_interrupt====
'''"Disable Interrupting of AutoPilot"'''

Tells the game to not allow players to interrupt an autopilot already-in-progress.

===Audio===
====-snd_preload====
'''"Preload mission game sounds"'''

Useful in preventing game stuttering when sounds are played for the first time.

====-nosound====
'''"Disable Sound and Music"'''

====-nomusic====
'''"Disables Music"'''

===Multiplayer===
====-standalone====
'''"Run as Stand Alone Server"'''

Creates a standalone multi-player server.

====-startgame====
'''"Skip Mainhall and Start Hosting"'''

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====
'''"Start Hosted Server as 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====
'''"Host Confirms Join requests"'''

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====
{{Warning| This feature is not available in current builds.}}

====-mpnoreturn====
'''"Disables Flight Deck option"'''

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

===Troubleshooting===
====-nohtl====
'''"Software Mode (very slow)"'''
{{Warning| Enabling this will significantly reduce performance.}}
Reverts to software rendering mode.

====-no_set_gamma====
'''"Disable Setting of Gamma"'''

Disables the gamma settings in the options screen.

====-nomovies====
'''"Disable Video Playback"'''

Disables all video playback.

====-noparseerrors====
'''"Disable Parsing Errors"'''

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.
{{Warning| This parameter was removed as of the July 5, 2011 nightly build.}}

====-query_speech====
'''"Does this build have Speech?"'''

Determines if the current build includes text-to-speech.

====-novbo====
'''"Disable OpenGL VBO"'''

====-noibx====
'''"Don't use cached index buffers (IBX)"'''

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"'''

====-disable_fbo====
'''"Disable OpenGL RenderTargets"'''

====-disable_pbo====
'''"Disable OpenGL Pixel Buffer Objects"'''

Disables the use of Pixel Buffer Objects (PBO) which may cause certain OpenGL operations to perform slower. Note PBO's were only used at three places in FSO anyway so it's *probably* not going to have a noticeable effect.

May be required to workaround issues in certain versions of Linux's Mesa drivers for Intel integrated graphics cards where crashes occur in the mainhall (i.e. whenever a popup occurs). Distros that seem to have this problem presently include Ubuntu 13.10 and openSUSE 13.1.
{{Table371|
*This feature is present to work around a bug in Linux's Mesa drivers for Intel integrated graphics cards}}

====-no_glsl====
'''"Disable GLSL (shader) Support"'''

Disables the use of GLSL rendering (OpenGL shaders). The game will revert to legacy fixed render pipeline. Please note that Normal and Height map effects will be unavailable.

====-disable_glsl_model====
'''"Don't use shaders for model rendering"'''

====-ati_swap====
'''"Fix Color issues on some ATI cards"'''

====-no_3d_sound====
'''"Use only 2D/stereo for sound effects"'''

====-disable_di_mouse====
'''"Disables the DirectInput mouse code for FSO on windows."'''

'''Windows Only''' Can make mouse movement smoother on certain machines.

====-mipmap====
'''"Enable mipmapping"'''

Causes for non-mipmapped textures to have mipmaps generated within the GPU on certain kind of texture formats, (IIRC, DDS formatted textures with a power of 2 size in both width and height). 
Since the use of already mipmapped DDS textures has become common, it has become deprecated.
The quality of the generated mipmaps depends on each GPU and used driver. It is normally used with [[Command-Line_Reference#-img2dds|-img2dds]] flag.

====-use_gldrawelements====
'''"Use glDrawElements instead of glDrawRangeElements"'''

Introduced as a means of switching to the slower OpenGL call glDrawElements, instead of glDrawRangeElements.
{{Table3614|
*This feature may resolve certain rendering problems where parts of models are not drawn on Linux drivers}}

====-keyboard_layout====
'''"Manually sets a keyboard layout"'''

A commandline parameter to set the keyboard layout as a string parameter.
{{Table3614|
*Currently the only valid string is "qwertz" (German) but French azerty may be added in future.}}

===Experimental===
====-ingame_join====
'''"Allows Ingame Joining"'''

Enables ingame joining in multiplayer. FIXME: Host option?

====-voicer====
'''"Voice Recognition"'''

Windows-only. Enables voice-recognition for wingmen commands. Must be specifically compiled into a build in order for it to be available; 3.6.10 final includes the feature. See [[Voice Recognition]] for more details.

====-fb_explosions====
'''"Enable Framebuffer Shockwaves"'''

===Development Tools===
====-fps====
'''"Show frames per second on HUD"'''

Displays current frames per second.

====-pos====
'''"Show Position of Camera"'''

Displays current position coordinates of camera.

====-window====
'''"Run in Window"'''

Runs the game in a window. No check to make sure that resolution is no higher than your desktop resolution, so be careful.

====-fullscreen_window====
'''"Run in Fullscreen Window"'''
{{Warning| This feature is only available on Windows.}}

====-timerbar====
Displays a timing bar across the top of the screen. Timerbar format varies by build. This is a relic from the Volition development days, and is unmaintained.
{{Warning| This parameter was removed as of the July 5, 2011 nightly build.}}

====-stats====
'''"Show Statistics"'''

Shows total and free physical memory, virtual memory and system pagefile.

====-coords====
'''"Show Coordinates"'''

Shows coordinates of the mouse cursor.

====-show_mem_usage====
'''"Show Memory Usage"'''

Shows detailed RAM usage based on file, handler and process usage and display on the left-center side of the screen during mission load and while in mission.

The meaning of the info displayed in the upper right corner of the HUD 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 does 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====
Reads all objects in the pof file of the selected mod, and creates an ibx cache file for each object in the data/cache folder for that mod. 
Details for each object are output to a pofspew.txt file created in the data folder. 
Otherwise, ibx files are created in game before each mission.

====-tablecrcs====
Is actually now (or should be) a typed reference rather than as a selection item. Takes 1 argument, usually a descriptive name.
Example usage: "-table_crcs MediaVPs" will create a table_crcs.csv file in the running mod (name can be separate of the mod selected) that allows for the validation of the tables used by that mod while on-line. The descriptive parameter given helps "allocate" that .csv file to the mod in question, and as such should closely or exactly match that mods name if possible.

====-missioncrcs====
Is actually now (or should be) a typed reference rather than as a selection item. Takes 1 argument, usually a descriptive name.
Example usage: "-mission_crcs MediaVPs" will create a mission_crcs.csv file in the running mod (name can be separate of the mod selected) that allows for the validation of the missions used by that mod while on-line. The descriptive parameter given helps "allocate" that .csv file to the mod in question, and as such should closely or exactly match that mods name if possible.

====-dis_collisions====
'''"Disable Collisions"'''

Disables all collisions.

====-dis_weapons====
'''"Disable Weapon Rendering"'''

Disables weapons rendering.

====-output_sexps====
This will make the FSO build spit out an html file that documents the supported SEXP's.

Just double click on sexps.html and it should open in your default web browser.

====-output_scripting====
This will make the FSO build spit out an html file that documents the supported scripting hooks and LUA libraries.

Just double click on scripting.html and it should open in your default web browser.

====-nograb====
Unix only. Disables focus grabbing in a window.

====-save_render_target====
'''"Save Render Targets to file"'''

====-debug_window====
'''"Display Debug Window"'''

Lists the fs2_open.log in (nearly)real-time generation.

====-verify_vps====
'''"Spew VP crcs to vp_crcs.txt"'''

Exports the CRC values of the VP files being loaded into a vp_crcs.txt file.

====-reparse_mainhall====
'''"Reparse mainhall.tbl when loading halls"'''

Mainhall.tbl will be reparsed every time a mainhall is loaded, as opposed to just once at game startup.

====-start_mission====
'''"Skip the mainhall in jump right into the specified mission"'''

Jump into the mission specified by the filename. Only in effect on the first run. This will skip load of the mainhall and its other related things altogether.

====-profile_frame_time====
'''"Profile engine subsystems"'''

Activates the frame profiling code. This presents a readout showing the current, minimum, maximum and average percentages of frametime a given section of code has taken up; this can be used to identify particular bottlenecks or measure the effectiveness of certain optimizations.

==Other==
The following options are not available as checkboxes in the launcher. Many require parameters, which follow the flag separated by a space. The prototype for use in this case is "-option argument"

===Lighting===
These factors can dramatically alter the atmosphere of the game. [[Sample Lighting Settings|This page]] has some sample lighting settings with screenshots.

====-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.

====-no_emissive_light====
By default, all ships in FS2 have a light generated on their own, it is more or less similar to a minimal amount of -ambient_factor. This feature was implemented to help the player seeing the ships over a black background. This flag disables this feature. Use it with a low -ambient_factor value to obtain an ultra-realistic dark looking.

====-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. This is a relative value.

====-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. This is a relative value.

====-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. This is a relative value.

====-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. This is a relative value.

====-ogl_spec====
Takes a numerical argument. This value changes the basic shininess of the specular light in OpenGL. A lower value reduces the overall intensity of the light making it broader and less powerful. A higher value makes it more focused and brighter. The default value is 80, and the usable range is 0 to 128 (clamped). The original default value was 60, but it was raised to behave more D3D like.

===Graphics===
====-bloom_intensity====
Requires -post_processing ("Enable Post Processing") command.
Default value is 75. Range is 0-200.

====-height====
Enables height maps (parallax mapping). It only works if [[Command-Line_Reference#-normal|-normal]] is also set. It also needs GLSL rendering, (see [[OpenGL_Shaders_(GLSL)|OpenGL Shaders (GLSL)]] for further info). It needs auxiliary height maps (with the same name than base map plus "-height").
{{Table3615|
*This feature is on by default. To manually disable, enter the flag -noheight}}

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

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

====-res====
Allows you to specify a resolution if the desired one cannot be set in the Launcher.
For example, -res 1920x1080 would run the game in 1920 x 1080 resolution. Since it requires an argument, it needs to be entered as a custom flag when using the Launcher. The "Run at specified resolution" option the Launcher gives is essentially this, but without being able to actually specify a resolution, it doesn't work.

====-fxaa_preset====
Requires both -post_processing and -fxaa. Can be used to adjust the FXAA quality and speed, 0 is fastest, 9 is highest quality. Default setting is 6.

===Gameplay===
====-mod====
Specifies in which folders inside FreeSpace 2 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 behavior, 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/

This flag can be indirectly set, (and it is normally set), through Launcher MOD tab and [[mod.ini]] file.

Within the Launcher's MOD 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 it will be used to modify the -mod flag, too.

For further details, see '''[[mod.ini]]'''

'''Data precedence'''

As already said, within the different directories, the data precedence is set by the specified order in the -mod flag. The lowest priority goes to the Freespace2 installation directory.

Inside each directory, data precedence is the following:

#Individual files located in ''Current_dir/data/'' subdir structure. See [[FS2_Data_Structure|FS2 Data Structure topic]] for deeper info about the different folders and contents this structure has.
#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 that this ''Mission.fs2'' is also 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 enhanced ones adding them in a higher priority place.

'''Additional notes'''
# As derived from the 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.
# This flag is also used by [[Portal:FRED|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. A special build of wxLauncher is able to configure FRED so that the -mod doesn't have to be done manually see [http://www.hard-light.net/forums/index.php?topic=67950.msg1387911#msg1387911 the forum post] for more details.
{{Table3612|As of 3.6.12 FRED now loads cmdline_fso.cfg just like FS does so FRED will use the same settings as FS including the -mod settings}}
# 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.

{{Warning| '''Priority and Texture Formats'''

''Obsolete behavior - Until FS2_open v3.6.9.:''

FS2_Open can use several file formats in textures: [http://en.wikipedia.org/wiki/PCX PCX], [http://en.wikipedia.org/wiki/DirectDraw_Surface DDS], [http://en.wikipedia.org/wiki/JPG JPG] and [http://en.wikipedia.org/wiki/TGA TGA]. Make sure you keep the format when you update your texture. For example if you update the old ''TextureOfMyFighter.tga'', do not save it as ''TextureOfMyFighter.dds'' in a higher priority place, because there is a chance of the game loading the old one despite of all.

The reason to do this is that, loading process (including priorities) is applied firstly for a kind of textures (TGAs), then for another kind (JPGs), and so on. This behavior can lead to situation where your new, updated and higher priority placed texture is not read because the format of the older one.

''New behavior - From FS2_open v3.6.10. (including previous beta testing releases):''

The former issue has been fixed. Now texture format priority is only applied within the same location. In this ''strange'' situation it goes DDS -> TGA -> JPG -> PCX. Examples:
* ''/Freespace2/MyVp.vp>>>data/maps/MyTexture.dds'' is loaded instead of ''/Freespace2/MyVp.vp>>>data/maps/MyTexture.tga''.
* But your improved ''/Freespace2/data/maps/MyTexture.xxx'' will override them both despite of its format.
In this way, when you update any texture, you don't have to pay attention to its original format. Just place it in a higher priority place.

Nevertheless, global priority is kept between animated and static textures. Because of their management, animated textures (ANIs and EFFs) are looked for BEFORE static ones. In this way there's no way to update an animated texture with a static one (an obsolete ANI is always going to be loaded before the newer DDS version). The solution: use an updated EFF with just one frame.

}}

====-fov====
This flag allows the player to specify the ''vertical'' Field of View (FoV) angle, in radians, for the player eyepoint. The angle is measured across the full height of the viewing cone. The FoV angle is technically known as the Angle of View (AoV)

*Syntax: '''''float''''' Angle
*Valid Values: 0 to 2*Pi radians
*Default Value: 0.75 radians

{{Note|For peculiar reasons, the actual FoV/AoV used by the game will be the supplied value multiplied by 1.39626348.}}

The the FoV angle/AoV is what determines the relative zoom level of the main game camera. Smaller angles generally equal to higher zoom levels, while larger angles equal to lower zoom levels (down to the theoretical x0 magnification).

However, too small of an angle will have a squashed look on the edges of your screen, and too high of an angle will greatly stretch edges. It is recommended to change the AoV, as FS2's default AoV has some perspective distortion at the screen edges (the default AoV is too high).

A natural looking (as if you where physically in the cockpit) AoV depends on the distance the player's actual eyes are away from the screen: the further away from the screen, the smaller the AoV should be, and vice versa. "Ergonomic" distances generally yield a '''''diagonal''''' AoV of 0.523 radians (30 degrees), but you can easily find the natural AoV by the following formula:

AoV (radians) = 2 * atan( H / ( 2*D ))

where:

Height of screen = H

Distance between head/eye and the screen = D

Generally, gamers like to increase the AoV in order to increase their peripheral vision on the screen, so as to gain a better situational awareness around their craft. An AoV of 0.39 radians seems to be a good start, but feel free to experiment and use whatever AoV you are most comfortable with.

===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 standalone 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 standalone 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 standalone game.

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

====-connect====
{{Sectstub}}
====-timeout====
{{Sectstub}}
====-cap_object_update====
Caps the maximum object update the server will respond to regardless of what the client has set. If the client is set to request high object updates but the server is capped to low, then that's all the client will get.

Takes one argument integer (0 to 3) which corresponds to the object update cap (With 0 being low and 3 being LAN).

===Help===
====-help====
Instructs FSO to print out all supported parameters. Some launchers can use these options to automatically populate the available command line options, even if the version of FSO is far newer than the launcher itself. NOTE: This option only works in Linux builds...

====--help====
See [[Command-Line_Reference#-help|-help]]

====-h====
See [[Command-Line_Reference#-help|-help]]

====-?====
See [[Command-Line_Reference#-help|-help]]

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

Command-Line Reference

2014-01-02T04:31:42Z

Echelon9: /* -timerbar */

Command-Line Flags (also called Command-Line Parameters) are optional flags passed to the FSO executable, and generally enables one or more features added to the FS2 Open engine. These flags are accessed conveniently through an [[FSO Launcher]]. To have FSO list all available flags, use any one of the following: [[Command-Line_Reference#-help|-help]], [[Command-Line_Reference#-help|--help]], [[Command-Line_Reference#-help|-h]], or [[Command-Line_Reference#-help|-?]].



===Graphics===
====-spec====
'''"Enable Specular"'''

Only polygons mapped with textures for which a shinemap exists will receive 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).
{{Table3615|
*This feature is on by default, use launcher option Disable Specular or if necessary to manually disable enter the flag -nospec}}

====-env====
'''"Enable Environment maps"'''

It only works if [[Command-Line_Reference#-spec|-spec]] is also set. Environment mapping intensity will be determined from the shine map too (see [[Texturing]] for more info). [[Installing FreeSpace 2 Open#Video setup|See Video setup.]]
{{Table3615|
*This feature is on by default, use launcher option Disable Environment Maps or if necessary to manually disable enter the flag -noenv }}

====-glow====
'''"Enable Glowmaps"'''

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)
{{Table3615|
*This feature is on by default, use launcher option Disable Glow Maps or if necessary to manually disable enter the flag -noglow }}

====-nomotiondebris====
'''"Disable motion debris"'''

====-noscalevid====
"Disable scale-to-window for Movies"

Disables fullscreen scaling of video clips.

====-missile_lighting====
'''"Apply Lighting to Missiles"'''

====-normal====
'''"Enable Normal Maps"'''

Normal maps require GLSL rendering, (see [[OpenGL_Shaders_(GLSL)|OpenGL Shaders (GLSL)]] for further info). It needs auxiliary normal maps (the same name of the base map plus "-normal"). DXT5_NM DDS format is needed. (Technical note: DXT5 will work, since only the GREEN and ALPHA channels are read by the current shader system. One direction of lines goes into the GREEN channel, the other direction goes into the ALPHA channel. RED and BLUE can be either base gray (#808080) or black. Usual practice is after creating the DXT5_NM, copy the RED channel to the ALPHA channel, black out the RED and BLUE an then save as either a DXT5 or u8888 (uncompressed) DDS file.)
{{Table3615|
*This feature is on by default, use launcher option Disable Normal Maps or if necessary to manually disable enter the flag -nonormal }}

====-post_process====
'''"Enable Post Processing"'''

enables the use (if present) of post-processing effects as defined by the post_process.tbl. Bloom usage has an additional cmdline option for setting it's value, most post processing effects are achieved in mission per the mission designer or can be enabled globally in the table.

====-soft_particles====
'''"Enable soft particles"'''

====-3dshockwave====
'''"Enable 3D Shockwaves"'''

This only has any effect when both a 2d and 3d shockwave effect are present, otherwise the only available effect is used.

====-fxaa====
'''"Enable FXAA antialiasing"'''

Enables the FXAA postprocessing stage. Further information can be found here: http://www.hard-light.net/forums/index.php?topic=76145.0

====-flightshaftsoff====
'''"Force Lightshafts off"'''

Disables Lightshafts even if a mission designer enables them via SEXP in a mission.

===Game Speed===
====-img2dds====
'''"Compress non-compressed images"'''

Converts all images to DDS (compressed) format. Decreases memory usage but potentially reduces image quality.

====-no_vsync====
'''"Disable vertical sync"'''

====-cache_bitmaps====
'''"Cache bitmaps between missions"'''

Will ideally reduce the load-time from one mission to another.

===HUD===
====-dualscanlines====
'''"Another Pair of Scanning Lines"'''

Adds a second pair of scanning lines to the target window when scanning an object.

====-targetinfo====
'''"Enable Info next to Target"'''

Displays target info, such as name and class, beside the targeted object.

====-orbradar====
'''"Enables 3D radar"'''

An Orb style 3D radar will replace the standard 2D version.

====-rearm_timer====
'''"Enable Rearm/Repair Completion Timer"'''

Displays time remaining until rearm and repair from a support ship is complete.

====-ballistic_gauge====
'''"Enable the analog Ballistic Ammo gauge"'''

Adds an ammo gauge to the HUD when armed with a ballistic weapon.

===Gameplay===
====-ship_choice_3d====
'''"Use Models for Ship Selection"'''

Uses ship models in ship selection window. It completely disables the standard ANI interface in this screen. 
Some mods need a compulsory use of this flag because they don't have available animations for their ships. In this situation, and if it is not used, the game will probably crash to desktop in the ship selection window.

====-weapon_choice_3d====
'''"Use Models for Weapon Selection"'''

Uses weapon models in weapon loadout window for secondary weapons (missiles and bombs). It completely disables the standard ANI interface in this screen. 
Some mods need a compulsory use of this flag because they don't have available animations for their secondary weapons. In this situation, and if it is not used, the game will probably crash to desktop in the weapon loadout window.

====-3dwarp====
'''"Enable 3D Warp"'''

Use full geometry for the subspace warp effect.

====-warp_flash====
'''"Enable Flash upon Warp"'''

Enable a flash at warp in and warp out.

====-no_ap_interrupt====
'''"Disable Interrupting of AutoPilot"'''

Tells the game to not allow players to interrupt an autopilot already-in-progress.

===Audio===
====-snd_preload====
'''"Preload mission game sounds"'''

Useful in preventing game stuttering when sounds are played for the first time.

====-nosound====
'''"Disable Sound and Music"'''

====-nomusic====
'''"Disables Music"'''

===Multiplayer===
====-standalone====
'''"Run as Stand Alone Server"'''

Creates a standalone multi-player server.

====-startgame====
'''"Skip Mainhall and Start Hosting"'''

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====
'''"Start Hosted Server as 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====
'''"Host Confirms Join requests"'''

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====
{{Warning| This feature is not available in current builds.}}

====-mpnoreturn====
'''"Disables Flight Deck option"'''

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

===Troubleshooting===
====-nohtl====
'''"Software Mode (very slow)"'''
{{Warning| Enabling this will significantly reduce performance.}}
Reverts to software rendering mode.

====-no_set_gamma====
'''"Disable Setting of Gamma"'''

Disables the gamma settings in the options screen.

====-nomovies====
'''"Disable Video Playback"'''

Disables all video playback.

====-noparseerrors====
'''"Disable Parsing Errors"'''

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.
{{Warning| This parameter was removed as of the July 5, 2011 nightly build.}}

====-query_speech====
'''"Does this build have Speech?"'''

Determines if the current build includes text-to-speech.

====-novbo====
'''"Disable OpenGL VBO"'''

====-noibx====
'''"Don't use cached index buffers (IBX)"'''

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"'''

====-disable_fbo====
'''"Disable OpenGL RenderTargets"'''

====-disable_pbo====
'''"Disable OpenGL Pixel Buffer Objects"'''

Disables the use of Pixel Buffer Objects (PBO) which may cause certain OpenGL operations to perform slower. Note PBO's were only used at three places in FSO anyway so it's *probably* not going to have a noticeable effect.

May be required to workaround issues in certain versions of Linux's Mesa drivers for Intel integrated graphics cards where crashes occur in the mainhall (i.e. whenever a popup occurs). Distros that seem to have this problem presently include Ubuntu 13.10 and openSUSE 13.1.
{{Table371|
*This feature is present to work around a bug in Linux's Mesa drivers for Intel integrated graphics cards}}

====-no_glsl====
'''"Disable GLSL (shader) Support"'''

Disables the use of GLSL rendering (OpenGL shaders). The game will revert to legacy fixed render pipeline. Please note that Normal and Height map effects will be unavailable.

====-disable_glsl_model====
'''"Don't use shaders for model rendering"'''

====-ati_swap====
'''"Fix Color issues on some ATI cards"'''

====-no_3d_sound====
'''"Use only 2D/stereo for sound effects"'''

====-disable_di_mouse====
'''"Disables the DirectInput mouse code for FSO on windows."'''

'''Windows Only''' Can make mouse movement smoother on certain machines.

====-mipmap====
'''"Enable mipmapping"'''

Causes for non-mipmapped textures to have mipmaps generated within the GPU on certain kind of texture formats, (IIRC, DDS formatted textures with a power of 2 size in both width and height). 
Since the use of already mipmapped DDS textures has become common, it has become deprecated.
The quality of the generated mipmaps depends on each GPU and used driver. It is normally used with [[Command-Line_Reference#-img2dds|-img2dds]] flag.

====-use_gldrawelements====
'''"Use glDrawElements instead of glDrawRangeElements"'''

Introduced as a means of switching to the slower OpenGL call glDrawElements, instead of glDrawRangeElements.
{{Table3614|
*This feature may resolve certain rendering problems where parts of models are not drawn on Linux drivers}}

====-keyboard_layout====
'''"Manually sets a keyboard layout"'''

A commandline parameter to set the keyboard layout as a string parameter.
{{Table3614|
*Currently the only valid string is "qwertz" (German) but French azerty may be added in future.}}

===Experimental===
====-ingame_join====
'''"Allows Ingame Joining"'''

Enables ingame joining in multiplayer. FIXME: Host option?

====-voicer====
'''"Voice Recognition"'''

Windows-only. Enables voice-recognition for wingmen commands. Must be specifically compiled into a build in order for it to be available; 3.6.10 final includes the feature. See [[Voice Recognition]] for more details.

====-fb_explosions====
'''"Enable Framebuffer Shockwaves"'''

===Development Tools===
====-fps====
'''"Show frames per second on HUD"'''

Displays current frames per second.

====-pos====
'''"Show Position of Camera"'''

Displays current position coordinates of camera.

====-window====
'''"Run in Window"'''

Runs the game in a window. No check to make sure that resolution is no higher than your desktop resolution, so be careful.

====-fullscreen_window====
'''"Run in Fullscreen Window"'''
{{Warning| This feature is not available on Windows.}}

====-timerbar====
Displays a timing bar across the top of the screen. Timerbar format varies by build. This is a relic from the Volition development days, and is unmaintained.
{{Warning| This parameter was removed as of the July 5, 2011 nightly build.}}

====-stats====
'''"Show Statistics"'''

Shows total and free physical memory, virtual memory and system pagefile.

====-coords====
'''"Show Coordinates"'''

Shows coordinates of the mouse cursor.

====-show_mem_usage====
'''"Show Memory Usage"'''

Shows detailed RAM usage based on file, handler and process usage and display on the left-center side of the screen during mission load and while in mission.

The meaning of the info displayed in the upper right corner of the HUD 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 does 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====
Reads all objects in the pof file of the selected mod, and creates an ibx cache file for each object in the data/cache folder for that mod. 
Details for each object are output to a pofspew.txt file created in the data folder. 
Otherwise, ibx files are created in game before each mission.

====-tablecrcs====
Is actually now (or should be) a typed reference rather than as a selection item. Takes 1 argument, usually a descriptive name.
Example usage: "-table_crcs MediaVPs" will create a table_crcs.csv file in the running mod (name can be separate of the mod selected) that allows for the validation of the tables used by that mod while on-line. The descriptive parameter given helps "allocate" that .csv file to the mod in question, and as such should closely or exactly match that mods name if possible.

====-missioncrcs====
Is actually now (or should be) a typed reference rather than as a selection item. Takes 1 argument, usually a descriptive name.
Example usage: "-mission_crcs MediaVPs" will create a mission_crcs.csv file in the running mod (name can be separate of the mod selected) that allows for the validation of the missions used by that mod while on-line. The descriptive parameter given helps "allocate" that .csv file to the mod in question, and as such should closely or exactly match that mods name if possible.

====-dis_collisions====
'''"Disable Collisions"'''

Disables all collisions.

====-dis_weapons====
'''"Disable Weapon Rendering"'''

Disables weapons rendering.

====-output_sexps====
This will make the FSO build spit out an html file that documents the supported SEXP's.

Just double click on sexps.html and it should open in your default web browser.

====-output_scripting====
This will make the FSO build spit out an html file that documents the supported scripting hooks and LUA libraries.

Just double click on scripting.html and it should open in your default web browser.

====-nograb====
Unix only. Disables focus grabbing in a window.

====-save_render_target====
'''"Save Render Targets to file"'''

====-debug_window====
'''"Display Debug Window"'''

Lists the fs2_open.log in (nearly)real-time generation.

====-verify_vps====
'''"Spew VP crcs to vp_crcs.txt"'''

Exports the CRC values of the VP files being loaded into a vp_crcs.txt file.

====-reparse_mainhall====
'''"Reparse mainhall.tbl when loading halls"'''

Mainhall.tbl will be reparsed every time a mainhall is loaded, as opposed to just once at game startup.

====-start_mission====
'''"Skip the mainhall in jump right into the specified mission"'''

Jump into the mission specified by the filename. Only in effect on the first run. This will skip load of the mainhall and its other related things altogether.

====-profile_frame_time====
'''"Profile engine subsystems"'''

Activates the frame profiling code. This presents a readout showing the current, minimum, maximum and average percentages of frametime a given section of code has taken up; this can be used to identify particular bottlenecks or measure the effectiveness of certain optimizations.

==Other==
The following options are not available as checkboxes in the launcher. Many require parameters, which follow the flag separated by a space. The prototype for use in this case is "-option argument"

===Lighting===
These factors can dramatically alter the atmosphere of the game. [[Sample Lighting Settings|This page]] has some sample lighting settings with screenshots.

====-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.

====-no_emissive_light====
By default, all ships in FS2 have a light generated on their own, it is more or less similar to a minimal amount of -ambient_factor. This feature was implemented to help the player seeing the ships over a black background. This flag disables this feature. Use it with a low -ambient_factor value to obtain an ultra-realistic dark looking.

====-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. This is a relative value.

====-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. This is a relative value.

====-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. This is a relative value.

====-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. This is a relative value.

====-ogl_spec====
Takes a numerical argument. This value changes the basic shininess of the specular light in OpenGL. A lower value reduces the overall intensity of the light making it broader and less powerful. A higher value makes it more focused and brighter. The default value is 80, and the usable range is 0 to 128 (clamped). The original default value was 60, but it was raised to behave more D3D like.

===Graphics===
====-bloom_intensity====
Requires -post_processing ("Enable Post Processing") command.
Default value is 75. Range is 0-200.

====-height====
Enables height maps (parallax mapping). It only works if [[Command-Line_Reference#-normal|-normal]] is also set. It also needs GLSL rendering, (see [[OpenGL_Shaders_(GLSL)|OpenGL Shaders (GLSL)]] for further info). It needs auxiliary height maps (with the same name than base map plus "-height").
{{Table3615|
*This feature is on by default. To manually disable, enter the flag -noheight}}

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

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

====-res====
Allows you to specify a resolution if the desired one cannot be set in the Launcher.
For example, -res 1920x1080 would run the game in 1920 x 1080 resolution. Since it requires an argument, it needs to be entered as a custom flag when using the Launcher. The "Run at specified resolution" option the Launcher gives is essentially this, but without being able to actually specify a resolution, it doesn't work.

====-fxaa_preset====
Requires both -post_processing and -fxaa. Can be used to adjust the FXAA quality and speed, 0 is fastest, 9 is highest quality. Default setting is 6.

===Gameplay===
====-mod====
Specifies in which folders inside FreeSpace 2 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 behavior, 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/

This flag can be indirectly set, (and it is normally set), through Launcher MOD tab and [[mod.ini]] file.

Within the Launcher's MOD 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 it will be used to modify the -mod flag, too.

For further details, see '''[[mod.ini]]'''

'''Data precedence'''

As already said, within the different directories, the data precedence is set by the specified order in the -mod flag. The lowest priority goes to the Freespace2 installation directory.

Inside each directory, data precedence is the following:

#Individual files located in ''Current_dir/data/'' subdir structure. See [[FS2_Data_Structure|FS2 Data Structure topic]] for deeper info about the different folders and contents this structure has.
#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 that this ''Mission.fs2'' is also 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 enhanced ones adding them in a higher priority place.

'''Additional notes'''
# As derived from the 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.
# This flag is also used by [[Portal:FRED|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. A special build of wxLauncher is able to configure FRED so that the -mod doesn't have to be done manually see [http://www.hard-light.net/forums/index.php?topic=67950.msg1387911#msg1387911 the forum post] for more details.
{{Table3612|As of 3.6.12 FRED now loads cmdline_fso.cfg just like FS does so FRED will use the same settings as FS including the -mod settings}}
# 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.

{{Warning| '''Priority and Texture Formats'''

''Obsolete behavior - Until FS2_open v3.6.9.:''

FS2_Open can use several file formats in textures: [http://en.wikipedia.org/wiki/PCX PCX], [http://en.wikipedia.org/wiki/DirectDraw_Surface DDS], [http://en.wikipedia.org/wiki/JPG JPG] and [http://en.wikipedia.org/wiki/TGA TGA]. Make sure you keep the format when you update your texture. For example if you update the old ''TextureOfMyFighter.tga'', do not save it as ''TextureOfMyFighter.dds'' in a higher priority place, because there is a chance of the game loading the old one despite of all.

The reason to do this is that, loading process (including priorities) is applied firstly for a kind of textures (TGAs), then for another kind (JPGs), and so on. This behavior can lead to situation where your new, updated and higher priority placed texture is not read because the format of the older one.

''New behavior - From FS2_open v3.6.10. (including previous beta testing releases):''

The former issue has been fixed. Now texture format priority is only applied within the same location. In this ''strange'' situation it goes DDS -> TGA -> JPG -> PCX. Examples:
* ''/Freespace2/MyVp.vp>>>data/maps/MyTexture.dds'' is loaded instead of ''/Freespace2/MyVp.vp>>>data/maps/MyTexture.tga''.
* But your improved ''/Freespace2/data/maps/MyTexture.xxx'' will override them both despite of its format.
In this way, when you update any texture, you don't have to pay attention to its original format. Just place it in a higher priority place.

Nevertheless, global priority is kept between animated and static textures. Because of their management, animated textures (ANIs and EFFs) are looked for BEFORE static ones. In this way there's no way to update an animated texture with a static one (an obsolete ANI is always going to be loaded before the newer DDS version). The solution: use an updated EFF with just one frame.

}}

====-fov====
This flag allows the player to specify the ''vertical'' Field of View (FoV) angle, in radians, for the player eyepoint. The angle is measured across the full height of the viewing cone. The FoV angle is technically known as the Angle of View (AoV)

*Syntax: '''''float''''' Angle
*Valid Values: 0 to 2*Pi radians
*Default Value: 0.75 radians

{{Note|For peculiar reasons, the actual FoV/AoV used by the game will be the supplied value multiplied by 1.39626348.}}

The the FoV angle/AoV is what determines the relative zoom level of the main game camera. Smaller angles generally equal to higher zoom levels, while larger angles equal to lower zoom levels (down to the theoretical x0 magnification).

However, too small of an angle will have a squashed look on the edges of your screen, and too high of an angle will greatly stretch edges. It is recommended to change the AoV, as FS2's default AoV has some perspective distortion at the screen edges (the default AoV is too high).

A natural looking (as if you where physically in the cockpit) AoV depends on the distance the player's actual eyes are away from the screen: the further away from the screen, the smaller the AoV should be, and vice versa. "Ergonomic" distances generally yield a '''''diagonal''''' AoV of 0.523 radians (30 degrees), but you can easily find the natural AoV by the following formula:

AoV (radians) = 2 * atan( H / ( 2*D ))

where:

Height of screen = H

Distance between head/eye and the screen = D

Generally, gamers like to increase the AoV in order to increase their peripheral vision on the screen, so as to gain a better situational awareness around their craft. An AoV of 0.39 radians seems to be a good start, but feel free to experiment and use whatever AoV you are most comfortable with.

===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 standalone 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 standalone 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 standalone game.

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

====-connect====
{{Sectstub}}
====-timeout====
{{Sectstub}}
====-cap_object_update====
Caps the maximum object update the server will respond to regardless of what the client has set. If the client is set to request high object updates but the server is capped to low, then that's all the client will get.

Takes one argument integer (0 to 3) which corresponds to the object update cap (With 0 being low and 3 being LAN).

===Help===
====-help====
Instructs FSO to print out all supported parameters. Some launchers can use these options to automatically populate the available command line options, even if the version of FSO is far newer than the launcher itself. NOTE: This option only works in Linux builds...

====--help====
See [[Command-Line_Reference#-help|-help]]

====-h====
See [[Command-Line_Reference#-help|-help]]

====-?====
See [[Command-Line_Reference#-help|-help]]

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

Command-Line Reference

2014-01-02T04:30:56Z

Echelon9: /* -fullscreen_window */

Command-Line Flags (also called Command-Line Parameters) are optional flags passed to the FSO executable, and generally enables one or more features added to the FS2 Open engine. These flags are accessed conveniently through an [[FSO Launcher]]. To have FSO list all available flags, use any one of the following: [[Command-Line_Reference#-help|-help]], [[Command-Line_Reference#-help|--help]], [[Command-Line_Reference#-help|-h]], or [[Command-Line_Reference#-help|-?]].



===Graphics===
====-spec====
'''"Enable Specular"'''

Only polygons mapped with textures for which a shinemap exists will receive 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).
{{Table3615|
*This feature is on by default, use launcher option Disable Specular or if necessary to manually disable enter the flag -nospec}}

====-env====
'''"Enable Environment maps"'''

It only works if [[Command-Line_Reference#-spec|-spec]] is also set. Environment mapping intensity will be determined from the shine map too (see [[Texturing]] for more info). [[Installing FreeSpace 2 Open#Video setup|See Video setup.]]
{{Table3615|
*This feature is on by default, use launcher option Disable Environment Maps or if necessary to manually disable enter the flag -noenv }}

====-glow====
'''"Enable Glowmaps"'''

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)
{{Table3615|
*This feature is on by default, use launcher option Disable Glow Maps or if necessary to manually disable enter the flag -noglow }}

====-nomotiondebris====
'''"Disable motion debris"'''

====-noscalevid====
"Disable scale-to-window for Movies"

Disables fullscreen scaling of video clips.

====-missile_lighting====
'''"Apply Lighting to Missiles"'''

====-normal====
'''"Enable Normal Maps"'''

Normal maps require GLSL rendering, (see [[OpenGL_Shaders_(GLSL)|OpenGL Shaders (GLSL)]] for further info). It needs auxiliary normal maps (the same name of the base map plus "-normal"). DXT5_NM DDS format is needed. (Technical note: DXT5 will work, since only the GREEN and ALPHA channels are read by the current shader system. One direction of lines goes into the GREEN channel, the other direction goes into the ALPHA channel. RED and BLUE can be either base gray (#808080) or black. Usual practice is after creating the DXT5_NM, copy the RED channel to the ALPHA channel, black out the RED and BLUE an then save as either a DXT5 or u8888 (uncompressed) DDS file.)
{{Table3615|
*This feature is on by default, use launcher option Disable Normal Maps or if necessary to manually disable enter the flag -nonormal }}

====-post_process====
'''"Enable Post Processing"'''

enables the use (if present) of post-processing effects as defined by the post_process.tbl. Bloom usage has an additional cmdline option for setting it's value, most post processing effects are achieved in mission per the mission designer or can be enabled globally in the table.

====-soft_particles====
'''"Enable soft particles"'''

====-3dshockwave====
'''"Enable 3D Shockwaves"'''

This only has any effect when both a 2d and 3d shockwave effect are present, otherwise the only available effect is used.

====-fxaa====
'''"Enable FXAA antialiasing"'''

Enables the FXAA postprocessing stage. Further information can be found here: http://www.hard-light.net/forums/index.php?topic=76145.0

====-flightshaftsoff====
'''"Force Lightshafts off"'''

Disables Lightshafts even if a mission designer enables them via SEXP in a mission.

===Game Speed===
====-img2dds====
'''"Compress non-compressed images"'''

Converts all images to DDS (compressed) format. Decreases memory usage but potentially reduces image quality.

====-no_vsync====
'''"Disable vertical sync"'''

====-cache_bitmaps====
'''"Cache bitmaps between missions"'''

Will ideally reduce the load-time from one mission to another.

===HUD===
====-dualscanlines====
'''"Another Pair of Scanning Lines"'''

Adds a second pair of scanning lines to the target window when scanning an object.

====-targetinfo====
'''"Enable Info next to Target"'''

Displays target info, such as name and class, beside the targeted object.

====-orbradar====
'''"Enables 3D radar"'''

An Orb style 3D radar will replace the standard 2D version.

====-rearm_timer====
'''"Enable Rearm/Repair Completion Timer"'''

Displays time remaining until rearm and repair from a support ship is complete.

====-ballistic_gauge====
'''"Enable the analog Ballistic Ammo gauge"'''

Adds an ammo gauge to the HUD when armed with a ballistic weapon.

===Gameplay===
====-ship_choice_3d====
'''"Use Models for Ship Selection"'''

Uses ship models in ship selection window. It completely disables the standard ANI interface in this screen. 
Some mods need a compulsory use of this flag because they don't have available animations for their ships. In this situation, and if it is not used, the game will probably crash to desktop in the ship selection window.

====-weapon_choice_3d====
'''"Use Models for Weapon Selection"'''

Uses weapon models in weapon loadout window for secondary weapons (missiles and bombs). It completely disables the standard ANI interface in this screen. 
Some mods need a compulsory use of this flag because they don't have available animations for their secondary weapons. In this situation, and if it is not used, the game will probably crash to desktop in the weapon loadout window.

====-3dwarp====
'''"Enable 3D Warp"'''

Use full geometry for the subspace warp effect.

====-warp_flash====
'''"Enable Flash upon Warp"'''

Enable a flash at warp in and warp out.

====-no_ap_interrupt====
'''"Disable Interrupting of AutoPilot"'''

Tells the game to not allow players to interrupt an autopilot already-in-progress.

===Audio===
====-snd_preload====
'''"Preload mission game sounds"'''

Useful in preventing game stuttering when sounds are played for the first time.

====-nosound====
'''"Disable Sound and Music"'''

====-nomusic====
'''"Disables Music"'''

===Multiplayer===
====-standalone====
'''"Run as Stand Alone Server"'''

Creates a standalone multi-player server.

====-startgame====
'''"Skip Mainhall and Start Hosting"'''

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====
'''"Start Hosted Server as 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====
'''"Host Confirms Join requests"'''

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====
{{Warning| This feature is not available in current builds.}}

====-mpnoreturn====
'''"Disables Flight Deck option"'''

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

===Troubleshooting===
====-nohtl====
'''"Software Mode (very slow)"'''
{{Warning| Enabling this will significantly reduce performance.}}
Reverts to software rendering mode.

====-no_set_gamma====
'''"Disable Setting of Gamma"'''

Disables the gamma settings in the options screen.

====-nomovies====
'''"Disable Video Playback"'''

Disables all video playback.

====-noparseerrors====
'''"Disable Parsing Errors"'''

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.
{{Warning| This parameter was removed as of the July 5, 2011 nightly build.}}

====-query_speech====
'''"Does this build have Speech?"'''

Determines if the current build includes text-to-speech.

====-novbo====
'''"Disable OpenGL VBO"'''

====-noibx====
'''"Don't use cached index buffers (IBX)"'''

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"'''

====-disable_fbo====
'''"Disable OpenGL RenderTargets"'''

====-disable_pbo====
'''"Disable OpenGL Pixel Buffer Objects"'''

Disables the use of Pixel Buffer Objects (PBO) which may cause certain OpenGL operations to perform slower. Note PBO's were only used at three places in FSO anyway so it's *probably* not going to have a noticeable effect.

May be required to workaround issues in certain versions of Linux's Mesa drivers for Intel integrated graphics cards where crashes occur in the mainhall (i.e. whenever a popup occurs). Distros that seem to have this problem presently include Ubuntu 13.10 and openSUSE 13.1.
{{Table371|
*This feature is present to work around a bug in Linux's Mesa drivers for Intel integrated graphics cards}}

====-no_glsl====
'''"Disable GLSL (shader) Support"'''

Disables the use of GLSL rendering (OpenGL shaders). The game will revert to legacy fixed render pipeline. Please note that Normal and Height map effects will be unavailable.

====-disable_glsl_model====
'''"Don't use shaders for model rendering"'''

====-ati_swap====
'''"Fix Color issues on some ATI cards"'''

====-no_3d_sound====
'''"Use only 2D/stereo for sound effects"'''

====-disable_di_mouse====
'''"Disables the DirectInput mouse code for FSO on windows."'''

'''Windows Only''' Can make mouse movement smoother on certain machines.

====-mipmap====
'''"Enable mipmapping"'''

Causes for non-mipmapped textures to have mipmaps generated within the GPU on certain kind of texture formats, (IIRC, DDS formatted textures with a power of 2 size in both width and height). 
Since the use of already mipmapped DDS textures has become common, it has become deprecated.
The quality of the generated mipmaps depends on each GPU and used driver. It is normally used with [[Command-Line_Reference#-img2dds|-img2dds]] flag.

====-use_gldrawelements====
'''"Use glDrawElements instead of glDrawRangeElements"'''

Introduced as a means of switching to the slower OpenGL call glDrawElements, instead of glDrawRangeElements.
{{Table3614|
*This feature may resolve certain rendering problems where parts of models are not drawn on Linux drivers}}

====-keyboard_layout====
'''"Manually sets a keyboard layout"'''

A commandline parameter to set the keyboard layout as a string parameter.
{{Table3614|
*Currently the only valid string is "qwertz" (German) but French azerty may be added in future.}}

===Experimental===
====-ingame_join====
'''"Allows Ingame Joining"'''

Enables ingame joining in multiplayer. FIXME: Host option?

====-voicer====
'''"Voice Recognition"'''

Windows-only. Enables voice-recognition for wingmen commands. Must be specifically compiled into a build in order for it to be available; 3.6.10 final includes the feature. See [[Voice Recognition]] for more details.

====-fb_explosions====
'''"Enable Framebuffer Shockwaves"'''

===Development Tools===
====-fps====
'''"Show frames per second on HUD"'''

Displays current frames per second.

====-pos====
'''"Show Position of Camera"'''

Displays current position coordinates of camera.

====-window====
'''"Run in Window"'''

Runs the game in a window. No check to make sure that resolution is no higher than your desktop resolution, so be careful.

====-fullscreen_window====
'''"Run in Fullscreen Window"'''
{{Warning| This feature is not available on Windows.}}

====-timerbar====
Displays a timing bar across the top of the screen. Timerbar format varies by build. This is a relic from the Volition development days, and is unmaintained.
*'''Note:''' the parameter was removed as of the July 5, 2011 nightly build.

====-stats====
'''"Show Statistics"'''

Shows total and free physical memory, virtual memory and system pagefile.

====-coords====
'''"Show Coordinates"'''

Shows coordinates of the mouse cursor.

====-show_mem_usage====
'''"Show Memory Usage"'''

Shows detailed RAM usage based on file, handler and process usage and display on the left-center side of the screen during mission load and while in mission.

The meaning of the info displayed in the upper right corner of the HUD 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 does 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====
Reads all objects in the pof file of the selected mod, and creates an ibx cache file for each object in the data/cache folder for that mod. 
Details for each object are output to a pofspew.txt file created in the data folder. 
Otherwise, ibx files are created in game before each mission.

====-tablecrcs====
Is actually now (or should be) a typed reference rather than as a selection item. Takes 1 argument, usually a descriptive name.
Example usage: "-table_crcs MediaVPs" will create a table_crcs.csv file in the running mod (name can be separate of the mod selected) that allows for the validation of the tables used by that mod while on-line. The descriptive parameter given helps "allocate" that .csv file to the mod in question, and as such should closely or exactly match that mods name if possible.

====-missioncrcs====
Is actually now (or should be) a typed reference rather than as a selection item. Takes 1 argument, usually a descriptive name.
Example usage: "-mission_crcs MediaVPs" will create a mission_crcs.csv file in the running mod (name can be separate of the mod selected) that allows for the validation of the missions used by that mod while on-line. The descriptive parameter given helps "allocate" that .csv file to the mod in question, and as such should closely or exactly match that mods name if possible.

====-dis_collisions====
'''"Disable Collisions"'''

Disables all collisions.

====-dis_weapons====
'''"Disable Weapon Rendering"'''

Disables weapons rendering.

====-output_sexps====
This will make the FSO build spit out an html file that documents the supported SEXP's.

Just double click on sexps.html and it should open in your default web browser.

====-output_scripting====
This will make the FSO build spit out an html file that documents the supported scripting hooks and LUA libraries.

Just double click on scripting.html and it should open in your default web browser.

====-nograb====
Unix only. Disables focus grabbing in a window.

====-save_render_target====
'''"Save Render Targets to file"'''

====-debug_window====
'''"Display Debug Window"'''

Lists the fs2_open.log in (nearly)real-time generation.

====-verify_vps====
'''"Spew VP crcs to vp_crcs.txt"'''

Exports the CRC values of the VP files being loaded into a vp_crcs.txt file.

====-reparse_mainhall====
'''"Reparse mainhall.tbl when loading halls"'''

Mainhall.tbl will be reparsed every time a mainhall is loaded, as opposed to just once at game startup.

====-start_mission====
'''"Skip the mainhall in jump right into the specified mission"'''

Jump into the mission specified by the filename. Only in effect on the first run. This will skip load of the mainhall and its other related things altogether.

====-profile_frame_time====
'''"Profile engine subsystems"'''

Activates the frame profiling code. This presents a readout showing the current, minimum, maximum and average percentages of frametime a given section of code has taken up; this can be used to identify particular bottlenecks or measure the effectiveness of certain optimizations.

==Other==
The following options are not available as checkboxes in the launcher. Many require parameters, which follow the flag separated by a space. The prototype for use in this case is "-option argument"

===Lighting===
These factors can dramatically alter the atmosphere of the game. [[Sample Lighting Settings|This page]] has some sample lighting settings with screenshots.

====-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.

====-no_emissive_light====
By default, all ships in FS2 have a light generated on their own, it is more or less similar to a minimal amount of -ambient_factor. This feature was implemented to help the player seeing the ships over a black background. This flag disables this feature. Use it with a low -ambient_factor value to obtain an ultra-realistic dark looking.

====-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. This is a relative value.

====-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. This is a relative value.

====-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. This is a relative value.

====-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. This is a relative value.

====-ogl_spec====
Takes a numerical argument. This value changes the basic shininess of the specular light in OpenGL. A lower value reduces the overall intensity of the light making it broader and less powerful. A higher value makes it more focused and brighter. The default value is 80, and the usable range is 0 to 128 (clamped). The original default value was 60, but it was raised to behave more D3D like.

===Graphics===
====-bloom_intensity====
Requires -post_processing ("Enable Post Processing") command.
Default value is 75. Range is 0-200.

====-height====
Enables height maps (parallax mapping). It only works if [[Command-Line_Reference#-normal|-normal]] is also set. It also needs GLSL rendering, (see [[OpenGL_Shaders_(GLSL)|OpenGL Shaders (GLSL)]] for further info). It needs auxiliary height maps (with the same name than base map plus "-height").
{{Table3615|
*This feature is on by default. To manually disable, enter the flag -noheight}}

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

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

====-res====
Allows you to specify a resolution if the desired one cannot be set in the Launcher.
For example, -res 1920x1080 would run the game in 1920 x 1080 resolution. Since it requires an argument, it needs to be entered as a custom flag when using the Launcher. The "Run at specified resolution" option the Launcher gives is essentially this, but without being able to actually specify a resolution, it doesn't work.

====-fxaa_preset====
Requires both -post_processing and -fxaa. Can be used to adjust the FXAA quality and speed, 0 is fastest, 9 is highest quality. Default setting is 6.

===Gameplay===
====-mod====
Specifies in which folders inside FreeSpace 2 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 behavior, 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/

This flag can be indirectly set, (and it is normally set), through Launcher MOD tab and [[mod.ini]] file.

Within the Launcher's MOD 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 it will be used to modify the -mod flag, too.

For further details, see '''[[mod.ini]]'''

'''Data precedence'''

As already said, within the different directories, the data precedence is set by the specified order in the -mod flag. The lowest priority goes to the Freespace2 installation directory.

Inside each directory, data precedence is the following:

#Individual files located in ''Current_dir/data/'' subdir structure. See [[FS2_Data_Structure|FS2 Data Structure topic]] for deeper info about the different folders and contents this structure has.
#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 that this ''Mission.fs2'' is also 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 enhanced ones adding them in a higher priority place.

'''Additional notes'''
# As derived from the 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.
# This flag is also used by [[Portal:FRED|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. A special build of wxLauncher is able to configure FRED so that the -mod doesn't have to be done manually see [http://www.hard-light.net/forums/index.php?topic=67950.msg1387911#msg1387911 the forum post] for more details.
{{Table3612|As of 3.6.12 FRED now loads cmdline_fso.cfg just like FS does so FRED will use the same settings as FS including the -mod settings}}
# 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.

{{Warning| '''Priority and Texture Formats'''

''Obsolete behavior - Until FS2_open v3.6.9.:''

FS2_Open can use several file formats in textures: [http://en.wikipedia.org/wiki/PCX PCX], [http://en.wikipedia.org/wiki/DirectDraw_Surface DDS], [http://en.wikipedia.org/wiki/JPG JPG] and [http://en.wikipedia.org/wiki/TGA TGA]. Make sure you keep the format when you update your texture. For example if you update the old ''TextureOfMyFighter.tga'', do not save it as ''TextureOfMyFighter.dds'' in a higher priority place, because there is a chance of the game loading the old one despite of all.

The reason to do this is that, loading process (including priorities) is applied firstly for a kind of textures (TGAs), then for another kind (JPGs), and so on. This behavior can lead to situation where your new, updated and higher priority placed texture is not read because the format of the older one.

''New behavior - From FS2_open v3.6.10. (including previous beta testing releases):''

The former issue has been fixed. Now texture format priority is only applied within the same location. In this ''strange'' situation it goes DDS -> TGA -> JPG -> PCX. Examples:
* ''/Freespace2/MyVp.vp>>>data/maps/MyTexture.dds'' is loaded instead of ''/Freespace2/MyVp.vp>>>data/maps/MyTexture.tga''.
* But your improved ''/Freespace2/data/maps/MyTexture.xxx'' will override them both despite of its format.
In this way, when you update any texture, you don't have to pay attention to its original format. Just place it in a higher priority place.

Nevertheless, global priority is kept between animated and static textures. Because of their management, animated textures (ANIs and EFFs) are looked for BEFORE static ones. In this way there's no way to update an animated texture with a static one (an obsolete ANI is always going to be loaded before the newer DDS version). The solution: use an updated EFF with just one frame.

}}

====-fov====
This flag allows the player to specify the ''vertical'' Field of View (FoV) angle, in radians, for the player eyepoint. The angle is measured across the full height of the viewing cone. The FoV angle is technically known as the Angle of View (AoV)

*Syntax: '''''float''''' Angle
*Valid Values: 0 to 2*Pi radians
*Default Value: 0.75 radians

{{Note|For peculiar reasons, the actual FoV/AoV used by the game will be the supplied value multiplied by 1.39626348.}}

The the FoV angle/AoV is what determines the relative zoom level of the main game camera. Smaller angles generally equal to higher zoom levels, while larger angles equal to lower zoom levels (down to the theoretical x0 magnification).

However, too small of an angle will have a squashed look on the edges of your screen, and too high of an angle will greatly stretch edges. It is recommended to change the AoV, as FS2's default AoV has some perspective distortion at the screen edges (the default AoV is too high).

A natural looking (as if you where physically in the cockpit) AoV depends on the distance the player's actual eyes are away from the screen: the further away from the screen, the smaller the AoV should be, and vice versa. "Ergonomic" distances generally yield a '''''diagonal''''' AoV of 0.523 radians (30 degrees), but you can easily find the natural AoV by the following formula:

AoV (radians) = 2 * atan( H / ( 2*D ))

where:

Height of screen = H

Distance between head/eye and the screen = D

Generally, gamers like to increase the AoV in order to increase their peripheral vision on the screen, so as to gain a better situational awareness around their craft. An AoV of 0.39 radians seems to be a good start, but feel free to experiment and use whatever AoV you are most comfortable with.

===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 standalone 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 standalone 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 standalone game.

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

====-connect====
{{Sectstub}}
====-timeout====
{{Sectstub}}
====-cap_object_update====
Caps the maximum object update the server will respond to regardless of what the client has set. If the client is set to request high object updates but the server is capped to low, then that's all the client will get.

Takes one argument integer (0 to 3) which corresponds to the object update cap (With 0 being low and 3 being LAN).

===Help===
====-help====
Instructs FSO to print out all supported parameters. Some launchers can use these options to automatically populate the available command line options, even if the version of FSO is far newer than the launcher itself. NOTE: This option only works in Linux builds...

====--help====
See [[Command-Line_Reference#-help|-help]]

====-h====
See [[Command-Line_Reference#-help|-help]]

====-?====
See [[Command-Line_Reference#-help|-help]]

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

Command-Line Reference

2014-01-02T04:29:33Z

Echelon9: /* Experimental */

Command-Line Flags (also called Command-Line Parameters) are optional flags passed to the FSO executable, and generally enables one or more features added to the FS2 Open engine. These flags are accessed conveniently through an [[FSO Launcher]]. To have FSO list all available flags, use any one of the following: [[Command-Line_Reference#-help|-help]], [[Command-Line_Reference#-help|--help]], [[Command-Line_Reference#-help|-h]], or [[Command-Line_Reference#-help|-?]].



===Graphics===
====-spec====
'''"Enable Specular"'''

Only polygons mapped with textures for which a shinemap exists will receive 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).
{{Table3615|
*This feature is on by default, use launcher option Disable Specular or if necessary to manually disable enter the flag -nospec}}

====-env====
'''"Enable Environment maps"'''

It only works if [[Command-Line_Reference#-spec|-spec]] is also set. Environment mapping intensity will be determined from the shine map too (see [[Texturing]] for more info). [[Installing FreeSpace 2 Open#Video setup|See Video setup.]]
{{Table3615|
*This feature is on by default, use launcher option Disable Environment Maps or if necessary to manually disable enter the flag -noenv }}

====-glow====
'''"Enable Glowmaps"'''

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)
{{Table3615|
*This feature is on by default, use launcher option Disable Glow Maps or if necessary to manually disable enter the flag -noglow }}

====-nomotiondebris====
'''"Disable motion debris"'''

====-noscalevid====
"Disable scale-to-window for Movies"

Disables fullscreen scaling of video clips.

====-missile_lighting====
'''"Apply Lighting to Missiles"'''

====-normal====
'''"Enable Normal Maps"'''

Normal maps require GLSL rendering, (see [[OpenGL_Shaders_(GLSL)|OpenGL Shaders (GLSL)]] for further info). It needs auxiliary normal maps (the same name of the base map plus "-normal"). DXT5_NM DDS format is needed. (Technical note: DXT5 will work, since only the GREEN and ALPHA channels are read by the current shader system. One direction of lines goes into the GREEN channel, the other direction goes into the ALPHA channel. RED and BLUE can be either base gray (#808080) or black. Usual practice is after creating the DXT5_NM, copy the RED channel to the ALPHA channel, black out the RED and BLUE an then save as either a DXT5 or u8888 (uncompressed) DDS file.)
{{Table3615|
*This feature is on by default, use launcher option Disable Normal Maps or if necessary to manually disable enter the flag -nonormal }}

====-post_process====
'''"Enable Post Processing"'''

enables the use (if present) of post-processing effects as defined by the post_process.tbl. Bloom usage has an additional cmdline option for setting it's value, most post processing effects are achieved in mission per the mission designer or can be enabled globally in the table.

====-soft_particles====
'''"Enable soft particles"'''

====-3dshockwave====
'''"Enable 3D Shockwaves"'''

This only has any effect when both a 2d and 3d shockwave effect are present, otherwise the only available effect is used.

====-fxaa====
'''"Enable FXAA antialiasing"'''

Enables the FXAA postprocessing stage. Further information can be found here: http://www.hard-light.net/forums/index.php?topic=76145.0

====-flightshaftsoff====
'''"Force Lightshafts off"'''

Disables Lightshafts even if a mission designer enables them via SEXP in a mission.

===Game Speed===
====-img2dds====
'''"Compress non-compressed images"'''

Converts all images to DDS (compressed) format. Decreases memory usage but potentially reduces image quality.

====-no_vsync====
'''"Disable vertical sync"'''

====-cache_bitmaps====
'''"Cache bitmaps between missions"'''

Will ideally reduce the load-time from one mission to another.

===HUD===
====-dualscanlines====
'''"Another Pair of Scanning Lines"'''

Adds a second pair of scanning lines to the target window when scanning an object.

====-targetinfo====
'''"Enable Info next to Target"'''

Displays target info, such as name and class, beside the targeted object.

====-orbradar====
'''"Enables 3D radar"'''

An Orb style 3D radar will replace the standard 2D version.

====-rearm_timer====
'''"Enable Rearm/Repair Completion Timer"'''

Displays time remaining until rearm and repair from a support ship is complete.

====-ballistic_gauge====
'''"Enable the analog Ballistic Ammo gauge"'''

Adds an ammo gauge to the HUD when armed with a ballistic weapon.

===Gameplay===
====-ship_choice_3d====
'''"Use Models for Ship Selection"'''

Uses ship models in ship selection window. It completely disables the standard ANI interface in this screen. 
Some mods need a compulsory use of this flag because they don't have available animations for their ships. In this situation, and if it is not used, the game will probably crash to desktop in the ship selection window.

====-weapon_choice_3d====
'''"Use Models for Weapon Selection"'''

Uses weapon models in weapon loadout window for secondary weapons (missiles and bombs). It completely disables the standard ANI interface in this screen. 
Some mods need a compulsory use of this flag because they don't have available animations for their secondary weapons. In this situation, and if it is not used, the game will probably crash to desktop in the weapon loadout window.

====-3dwarp====
'''"Enable 3D Warp"'''

Use full geometry for the subspace warp effect.

====-warp_flash====
'''"Enable Flash upon Warp"'''

Enable a flash at warp in and warp out.

====-no_ap_interrupt====
'''"Disable Interrupting of AutoPilot"'''

Tells the game to not allow players to interrupt an autopilot already-in-progress.

===Audio===
====-snd_preload====
'''"Preload mission game sounds"'''

Useful in preventing game stuttering when sounds are played for the first time.

====-nosound====
'''"Disable Sound and Music"'''

====-nomusic====
'''"Disables Music"'''

===Multiplayer===
====-standalone====
'''"Run as Stand Alone Server"'''

Creates a standalone multi-player server.

====-startgame====
'''"Skip Mainhall and Start Hosting"'''

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====
'''"Start Hosted Server as 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====
'''"Host Confirms Join requests"'''

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====
{{Warning| This feature is not available in current builds.}}

====-mpnoreturn====
'''"Disables Flight Deck option"'''

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

===Troubleshooting===
====-nohtl====
'''"Software Mode (very slow)"'''
{{Warning| Enabling this will significantly reduce performance.}}
Reverts to software rendering mode.

====-no_set_gamma====
'''"Disable Setting of Gamma"'''

Disables the gamma settings in the options screen.

====-nomovies====
'''"Disable Video Playback"'''

Disables all video playback.

====-noparseerrors====
'''"Disable Parsing Errors"'''

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.
{{Warning| This parameter was removed as of the July 5, 2011 nightly build.}}

====-query_speech====
'''"Does this build have Speech?"'''

Determines if the current build includes text-to-speech.

====-novbo====
'''"Disable OpenGL VBO"'''

====-noibx====
'''"Don't use cached index buffers (IBX)"'''

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"'''

====-disable_fbo====
'''"Disable OpenGL RenderTargets"'''

====-disable_pbo====
'''"Disable OpenGL Pixel Buffer Objects"'''

Disables the use of Pixel Buffer Objects (PBO) which may cause certain OpenGL operations to perform slower. Note PBO's were only used at three places in FSO anyway so it's *probably* not going to have a noticeable effect.

May be required to workaround issues in certain versions of Linux's Mesa drivers for Intel integrated graphics cards where crashes occur in the mainhall (i.e. whenever a popup occurs). Distros that seem to have this problem presently include Ubuntu 13.10 and openSUSE 13.1.
{{Table371|
*This feature is present to work around a bug in Linux's Mesa drivers for Intel integrated graphics cards}}

====-no_glsl====
'''"Disable GLSL (shader) Support"'''

Disables the use of GLSL rendering (OpenGL shaders). The game will revert to legacy fixed render pipeline. Please note that Normal and Height map effects will be unavailable.

====-disable_glsl_model====
'''"Don't use shaders for model rendering"'''

====-ati_swap====
'''"Fix Color issues on some ATI cards"'''

====-no_3d_sound====
'''"Use only 2D/stereo for sound effects"'''

====-disable_di_mouse====
'''"Disables the DirectInput mouse code for FSO on windows."'''

'''Windows Only''' Can make mouse movement smoother on certain machines.

====-mipmap====
'''"Enable mipmapping"'''

Causes for non-mipmapped textures to have mipmaps generated within the GPU on certain kind of texture formats, (IIRC, DDS formatted textures with a power of 2 size in both width and height). 
Since the use of already mipmapped DDS textures has become common, it has become deprecated.
The quality of the generated mipmaps depends on each GPU and used driver. It is normally used with [[Command-Line_Reference#-img2dds|-img2dds]] flag.

====-use_gldrawelements====
'''"Use glDrawElements instead of glDrawRangeElements"'''

Introduced as a means of switching to the slower OpenGL call glDrawElements, instead of glDrawRangeElements.
{{Table3614|
*This feature may resolve certain rendering problems where parts of models are not drawn on Linux drivers}}

====-keyboard_layout====
'''"Manually sets a keyboard layout"'''

A commandline parameter to set the keyboard layout as a string parameter.
{{Table3614|
*Currently the only valid string is "qwertz" (German) but French azerty may be added in future.}}

===Experimental===
====-ingame_join====
'''"Allows Ingame Joining"'''

Enables ingame joining in multiplayer. FIXME: Host option?

====-voicer====
'''"Voice Recognition"'''

Windows-only. Enables voice-recognition for wingmen commands. Must be specifically compiled into a build in order for it to be available; 3.6.10 final includes the feature. See [[Voice Recognition]] for more details.

====-fb_explosions====
'''"Enable Framebuffer Shockwaves"'''

===Development Tools===
====-fps====
'''"Show frames per second on HUD"'''

Displays current frames per second.

====-pos====
'''"Show Position of Camera"'''

Displays current position coordinates of camera.

====-window====
'''"Run in Window"'''

Runs the game in a window. No check to make sure that resolution is no higher than your desktop resolution, so be careful.

====-fullscreen_window====
'''"Run in Fullscreen Window"'''

====-timerbar====
Displays a timing bar across the top of the screen. Timerbar format varies by build. This is a relic from the Volition development days, and is unmaintained.
*'''Note:''' the parameter was removed as of the July 5, 2011 nightly build.

====-stats====
'''"Show Statistics"'''

Shows total and free physical memory, virtual memory and system pagefile.

====-coords====
'''"Show Coordinates"'''

Shows coordinates of the mouse cursor.

====-show_mem_usage====
'''"Show Memory Usage"'''

Shows detailed RAM usage based on file, handler and process usage and display on the left-center side of the screen during mission load and while in mission.

The meaning of the info displayed in the upper right corner of the HUD 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 does 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====
Reads all objects in the pof file of the selected mod, and creates an ibx cache file for each object in the data/cache folder for that mod. 
Details for each object are output to a pofspew.txt file created in the data folder. 
Otherwise, ibx files are created in game before each mission.

====-tablecrcs====
Is actually now (or should be) a typed reference rather than as a selection item. Takes 1 argument, usually a descriptive name.
Example usage: "-table_crcs MediaVPs" will create a table_crcs.csv file in the running mod (name can be separate of the mod selected) that allows for the validation of the tables used by that mod while on-line. The descriptive parameter given helps "allocate" that .csv file to the mod in question, and as such should closely or exactly match that mods name if possible.

====-missioncrcs====
Is actually now (or should be) a typed reference rather than as a selection item. Takes 1 argument, usually a descriptive name.
Example usage: "-mission_crcs MediaVPs" will create a mission_crcs.csv file in the running mod (name can be separate of the mod selected) that allows for the validation of the missions used by that mod while on-line. The descriptive parameter given helps "allocate" that .csv file to the mod in question, and as such should closely or exactly match that mods name if possible.

====-dis_collisions====
'''"Disable Collisions"'''

Disables all collisions.

====-dis_weapons====
'''"Disable Weapon Rendering"'''

Disables weapons rendering.

====-output_sexps====
This will make the FSO build spit out an html file that documents the supported SEXP's.

Just double click on sexps.html and it should open in your default web browser.

====-output_scripting====
This will make the FSO build spit out an html file that documents the supported scripting hooks and LUA libraries.

Just double click on scripting.html and it should open in your default web browser.

====-nograb====
Unix only. Disables focus grabbing in a window.

====-save_render_target====
'''"Save Render Targets to file"'''

====-debug_window====
'''"Display Debug Window"'''

Lists the fs2_open.log in (nearly)real-time generation.

====-verify_vps====
'''"Spew VP crcs to vp_crcs.txt"'''

Exports the CRC values of the VP files being loaded into a vp_crcs.txt file.

====-reparse_mainhall====
'''"Reparse mainhall.tbl when loading halls"'''

Mainhall.tbl will be reparsed every time a mainhall is loaded, as opposed to just once at game startup.

====-start_mission====
'''"Skip the mainhall in jump right into the specified mission"'''

Jump into the mission specified by the filename. Only in effect on the first run. This will skip load of the mainhall and its other related things altogether.

====-profile_frame_time====
'''"Profile engine subsystems"'''

Activates the frame profiling code. This presents a readout showing the current, minimum, maximum and average percentages of frametime a given section of code has taken up; this can be used to identify particular bottlenecks or measure the effectiveness of certain optimizations.

==Other==
The following options are not available as checkboxes in the launcher. Many require parameters, which follow the flag separated by a space. The prototype for use in this case is "-option argument"

===Lighting===
These factors can dramatically alter the atmosphere of the game. [[Sample Lighting Settings|This page]] has some sample lighting settings with screenshots.

====-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.

====-no_emissive_light====
By default, all ships in FS2 have a light generated on their own, it is more or less similar to a minimal amount of -ambient_factor. This feature was implemented to help the player seeing the ships over a black background. This flag disables this feature. Use it with a low -ambient_factor value to obtain an ultra-realistic dark looking.

====-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. This is a relative value.

====-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. This is a relative value.

====-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. This is a relative value.

====-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. This is a relative value.

====-ogl_spec====
Takes a numerical argument. This value changes the basic shininess of the specular light in OpenGL. A lower value reduces the overall intensity of the light making it broader and less powerful. A higher value makes it more focused and brighter. The default value is 80, and the usable range is 0 to 128 (clamped). The original default value was 60, but it was raised to behave more D3D like.

===Graphics===
====-bloom_intensity====
Requires -post_processing ("Enable Post Processing") command.
Default value is 75. Range is 0-200.

====-height====
Enables height maps (parallax mapping). It only works if [[Command-Line_Reference#-normal|-normal]] is also set. It also needs GLSL rendering, (see [[OpenGL_Shaders_(GLSL)|OpenGL Shaders (GLSL)]] for further info). It needs auxiliary height maps (with the same name than base map plus "-height").
{{Table3615|
*This feature is on by default. To manually disable, enter the flag -noheight}}

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

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

====-res====
Allows you to specify a resolution if the desired one cannot be set in the Launcher.
For example, -res 1920x1080 would run the game in 1920 x 1080 resolution. Since it requires an argument, it needs to be entered as a custom flag when using the Launcher. The "Run at specified resolution" option the Launcher gives is essentially this, but without being able to actually specify a resolution, it doesn't work.

====-fxaa_preset====
Requires both -post_processing and -fxaa. Can be used to adjust the FXAA quality and speed, 0 is fastest, 9 is highest quality. Default setting is 6.

===Gameplay===
====-mod====
Specifies in which folders inside FreeSpace 2 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 behavior, 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/

This flag can be indirectly set, (and it is normally set), through Launcher MOD tab and [[mod.ini]] file.

Within the Launcher's MOD 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 it will be used to modify the -mod flag, too.

For further details, see '''[[mod.ini]]'''

'''Data precedence'''

As already said, within the different directories, the data precedence is set by the specified order in the -mod flag. The lowest priority goes to the Freespace2 installation directory.

Inside each directory, data precedence is the following:

#Individual files located in ''Current_dir/data/'' subdir structure. See [[FS2_Data_Structure|FS2 Data Structure topic]] for deeper info about the different folders and contents this structure has.
#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 that this ''Mission.fs2'' is also 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 enhanced ones adding them in a higher priority place.

'''Additional notes'''
# As derived from the 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.
# This flag is also used by [[Portal:FRED|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. A special build of wxLauncher is able to configure FRED so that the -mod doesn't have to be done manually see [http://www.hard-light.net/forums/index.php?topic=67950.msg1387911#msg1387911 the forum post] for more details.
{{Table3612|As of 3.6.12 FRED now loads cmdline_fso.cfg just like FS does so FRED will use the same settings as FS including the -mod settings}}
# 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.

{{Warning| '''Priority and Texture Formats'''

''Obsolete behavior - Until FS2_open v3.6.9.:''

FS2_Open can use several file formats in textures: [http://en.wikipedia.org/wiki/PCX PCX], [http://en.wikipedia.org/wiki/DirectDraw_Surface DDS], [http://en.wikipedia.org/wiki/JPG JPG] and [http://en.wikipedia.org/wiki/TGA TGA]. Make sure you keep the format when you update your texture. For example if you update the old ''TextureOfMyFighter.tga'', do not save it as ''TextureOfMyFighter.dds'' in a higher priority place, because there is a chance of the game loading the old one despite of all.

The reason to do this is that, loading process (including priorities) is applied firstly for a kind of textures (TGAs), then for another kind (JPGs), and so on. This behavior can lead to situation where your new, updated and higher priority placed texture is not read because the format of the older one.

''New behavior - From FS2_open v3.6.10. (including previous beta testing releases):''

The former issue has been fixed. Now texture format priority is only applied within the same location. In this ''strange'' situation it goes DDS -> TGA -> JPG -> PCX. Examples:
* ''/Freespace2/MyVp.vp>>>data/maps/MyTexture.dds'' is loaded instead of ''/Freespace2/MyVp.vp>>>data/maps/MyTexture.tga''.
* But your improved ''/Freespace2/data/maps/MyTexture.xxx'' will override them both despite of its format.
In this way, when you update any texture, you don't have to pay attention to its original format. Just place it in a higher priority place.

Nevertheless, global priority is kept between animated and static textures. Because of their management, animated textures (ANIs and EFFs) are looked for BEFORE static ones. In this way there's no way to update an animated texture with a static one (an obsolete ANI is always going to be loaded before the newer DDS version). The solution: use an updated EFF with just one frame.

}}

====-fov====
This flag allows the player to specify the ''vertical'' Field of View (FoV) angle, in radians, for the player eyepoint. The angle is measured across the full height of the viewing cone. The FoV angle is technically known as the Angle of View (AoV)

*Syntax: '''''float''''' Angle
*Valid Values: 0 to 2*Pi radians
*Default Value: 0.75 radians

{{Note|For peculiar reasons, the actual FoV/AoV used by the game will be the supplied value multiplied by 1.39626348.}}

The the FoV angle/AoV is what determines the relative zoom level of the main game camera. Smaller angles generally equal to higher zoom levels, while larger angles equal to lower zoom levels (down to the theoretical x0 magnification).

However, too small of an angle will have a squashed look on the edges of your screen, and too high of an angle will greatly stretch edges. It is recommended to change the AoV, as FS2's default AoV has some perspective distortion at the screen edges (the default AoV is too high).

A natural looking (as if you where physically in the cockpit) AoV depends on the distance the player's actual eyes are away from the screen: the further away from the screen, the smaller the AoV should be, and vice versa. "Ergonomic" distances generally yield a '''''diagonal''''' AoV of 0.523 radians (30 degrees), but you can easily find the natural AoV by the following formula:

AoV (radians) = 2 * atan( H / ( 2*D ))

where:

Height of screen = H

Distance between head/eye and the screen = D

Generally, gamers like to increase the AoV in order to increase their peripheral vision on the screen, so as to gain a better situational awareness around their craft. An AoV of 0.39 radians seems to be a good start, but feel free to experiment and use whatever AoV you are most comfortable with.

===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 standalone 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 standalone 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 standalone game.

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

====-connect====
{{Sectstub}}
====-timeout====
{{Sectstub}}
====-cap_object_update====
Caps the maximum object update the server will respond to regardless of what the client has set. If the client is set to request high object updates but the server is capped to low, then that's all the client will get.

Takes one argument integer (0 to 3) which corresponds to the object update cap (With 0 being low and 3 being LAN).

===Help===
====-help====
Instructs FSO to print out all supported parameters. Some launchers can use these options to automatically populate the available command line options, even if the version of FSO is far newer than the launcher itself. NOTE: This option only works in Linux builds...

====--help====
See [[Command-Line_Reference#-help|-help]]

====-h====
See [[Command-Line_Reference#-help|-help]]

====-?====
See [[Command-Line_Reference#-help|-help]]

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

Command-Line Reference

2014-01-02T04:25:55Z

Echelon9: /* -safeloading */

Command-Line Flags (also called Command-Line Parameters) are optional flags passed to the FSO executable, and generally enables one or more features added to the FS2 Open engine. These flags are accessed conveniently through an [[FSO Launcher]]. To have FSO list all available flags, use any one of the following: [[Command-Line_Reference#-help|-help]], [[Command-Line_Reference#-help|--help]], [[Command-Line_Reference#-help|-h]], or [[Command-Line_Reference#-help|-?]].



===Graphics===
====-spec====
'''"Enable Specular"'''

Only polygons mapped with textures for which a shinemap exists will receive 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).
{{Table3615|
*This feature is on by default, use launcher option Disable Specular or if necessary to manually disable enter the flag -nospec}}

====-env====
'''"Enable Environment maps"'''

It only works if [[Command-Line_Reference#-spec|-spec]] is also set. Environment mapping intensity will be determined from the shine map too (see [[Texturing]] for more info). [[Installing FreeSpace 2 Open#Video setup|See Video setup.]]
{{Table3615|
*This feature is on by default, use launcher option Disable Environment Maps or if necessary to manually disable enter the flag -noenv }}

====-glow====
'''"Enable Glowmaps"'''

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)
{{Table3615|
*This feature is on by default, use launcher option Disable Glow Maps or if necessary to manually disable enter the flag -noglow }}

====-nomotiondebris====
'''"Disable motion debris"'''

====-noscalevid====
"Disable scale-to-window for Movies"

Disables fullscreen scaling of video clips.

====-missile_lighting====
'''"Apply Lighting to Missiles"'''

====-normal====
'''"Enable Normal Maps"'''

Normal maps require GLSL rendering, (see [[OpenGL_Shaders_(GLSL)|OpenGL Shaders (GLSL)]] for further info). It needs auxiliary normal maps (the same name of the base map plus "-normal"). DXT5_NM DDS format is needed. (Technical note: DXT5 will work, since only the GREEN and ALPHA channels are read by the current shader system. One direction of lines goes into the GREEN channel, the other direction goes into the ALPHA channel. RED and BLUE can be either base gray (#808080) or black. Usual practice is after creating the DXT5_NM, copy the RED channel to the ALPHA channel, black out the RED and BLUE an then save as either a DXT5 or u8888 (uncompressed) DDS file.)
{{Table3615|
*This feature is on by default, use launcher option Disable Normal Maps or if necessary to manually disable enter the flag -nonormal }}

====-post_process====
'''"Enable Post Processing"'''

enables the use (if present) of post-processing effects as defined by the post_process.tbl. Bloom usage has an additional cmdline option for setting it's value, most post processing effects are achieved in mission per the mission designer or can be enabled globally in the table.

====-soft_particles====
'''"Enable soft particles"'''

====-3dshockwave====
'''"Enable 3D Shockwaves"'''

This only has any effect when both a 2d and 3d shockwave effect are present, otherwise the only available effect is used.

====-fxaa====
'''"Enable FXAA antialiasing"'''

Enables the FXAA postprocessing stage. Further information can be found here: http://www.hard-light.net/forums/index.php?topic=76145.0

====-flightshaftsoff====
'''"Force Lightshafts off"'''

Disables Lightshafts even if a mission designer enables them via SEXP in a mission.

===Game Speed===
====-img2dds====
'''"Compress non-compressed images"'''

Converts all images to DDS (compressed) format. Decreases memory usage but potentially reduces image quality.

====-no_vsync====
'''"Disable vertical sync"'''

====-cache_bitmaps====
'''"Cache bitmaps between missions"'''

Will ideally reduce the load-time from one mission to another.

===HUD===
====-dualscanlines====
'''"Another Pair of Scanning Lines"'''

Adds a second pair of scanning lines to the target window when scanning an object.

====-targetinfo====
'''"Enable Info next to Target"'''

Displays target info, such as name and class, beside the targeted object.

====-orbradar====
'''"Enables 3D radar"'''

An Orb style 3D radar will replace the standard 2D version.

====-rearm_timer====
'''"Enable Rearm/Repair Completion Timer"'''

Displays time remaining until rearm and repair from a support ship is complete.

====-ballistic_gauge====
'''"Enable the analog Ballistic Ammo gauge"'''

Adds an ammo gauge to the HUD when armed with a ballistic weapon.

===Gameplay===
====-ship_choice_3d====
'''"Use Models for Ship Selection"'''

Uses ship models in ship selection window. It completely disables the standard ANI interface in this screen. 
Some mods need a compulsory use of this flag because they don't have available animations for their ships. In this situation, and if it is not used, the game will probably crash to desktop in the ship selection window.

====-weapon_choice_3d====
'''"Use Models for Weapon Selection"'''

Uses weapon models in weapon loadout window for secondary weapons (missiles and bombs). It completely disables the standard ANI interface in this screen. 
Some mods need a compulsory use of this flag because they don't have available animations for their secondary weapons. In this situation, and if it is not used, the game will probably crash to desktop in the weapon loadout window.

====-3dwarp====
'''"Enable 3D Warp"'''

Use full geometry for the subspace warp effect.

====-warp_flash====
'''"Enable Flash upon Warp"'''

Enable a flash at warp in and warp out.

====-no_ap_interrupt====
'''"Disable Interrupting of AutoPilot"'''

Tells the game to not allow players to interrupt an autopilot already-in-progress.

===Audio===
====-snd_preload====
'''"Preload mission game sounds"'''

Useful in preventing game stuttering when sounds are played for the first time.

====-nosound====
'''"Disable Sound and Music"'''

====-nomusic====
'''"Disables Music"'''

===Multiplayer===
====-standalone====
'''"Run as Stand Alone Server"'''

Creates a standalone multi-player server.

====-startgame====
'''"Skip Mainhall and Start Hosting"'''

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====
'''"Start Hosted Server as 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====
'''"Host Confirms Join requests"'''

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====
{{Warning| This feature is not available in current builds.}}

====-mpnoreturn====
'''"Disables Flight Deck option"'''

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

===Troubleshooting===
====-nohtl====
'''"Software Mode (very slow)"'''
{{Warning| Enabling this will significantly reduce performance.}}
Reverts to software rendering mode.

====-no_set_gamma====
'''"Disable Setting of Gamma"'''

Disables the gamma settings in the options screen.

====-nomovies====
'''"Disable Video Playback"'''

Disables all video playback.

====-noparseerrors====
'''"Disable Parsing Errors"'''

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.
{{Warning| This parameter was removed as of the July 5, 2011 nightly build.}}

====-query_speech====
'''"Does this build have Speech?"'''

Determines if the current build includes text-to-speech.

====-novbo====
'''"Disable OpenGL VBO"'''

====-noibx====
'''"Don't use cached index buffers (IBX)"'''

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"'''

====-disable_fbo====
'''"Disable OpenGL RenderTargets"'''

====-disable_pbo====
'''"Disable OpenGL Pixel Buffer Objects"'''

Disables the use of Pixel Buffer Objects (PBO) which may cause certain OpenGL operations to perform slower. Note PBO's were only used at three places in FSO anyway so it's *probably* not going to have a noticeable effect.

May be required to workaround issues in certain versions of Linux's Mesa drivers for Intel integrated graphics cards where crashes occur in the mainhall (i.e. whenever a popup occurs). Distros that seem to have this problem presently include Ubuntu 13.10 and openSUSE 13.1.
{{Table371|
*This feature is present to work around a bug in Linux's Mesa drivers for Intel integrated graphics cards}}

====-no_glsl====
'''"Disable GLSL (shader) Support"'''

Disables the use of GLSL rendering (OpenGL shaders). The game will revert to legacy fixed render pipeline. Please note that Normal and Height map effects will be unavailable.

====-disable_glsl_model====
'''"Don't use shaders for model rendering"'''

====-ati_swap====
'''"Fix Color issues on some ATI cards"'''

====-no_3d_sound====
'''"Use only 2D/stereo for sound effects"'''

====-disable_di_mouse====
'''"Disables the DirectInput mouse code for FSO on windows."'''

'''Windows Only''' Can make mouse movement smoother on certain machines.

====-mipmap====
'''"Enable mipmapping"'''

Causes for non-mipmapped textures to have mipmaps generated within the GPU on certain kind of texture formats, (IIRC, DDS formatted textures with a power of 2 size in both width and height). 
Since the use of already mipmapped DDS textures has become common, it has become deprecated.
The quality of the generated mipmaps depends on each GPU and used driver. It is normally used with [[Command-Line_Reference#-img2dds|-img2dds]] flag.

====-use_gldrawelements====
'''"Use glDrawElements instead of glDrawRangeElements"'''

Introduced as a means of switching to the slower OpenGL call glDrawElements, instead of glDrawRangeElements.
{{Table3614|
*This feature may resolve certain rendering problems where parts of models are not drawn on Linux drivers}}

====-keyboard_layout====
'''"Manually sets a keyboard layout"'''

A commandline parameter to set the keyboard layout as a string parameter.
{{Table3614|
*Currently the only valid string is "qwertz" (German) but French azerty may be added in future.}}

===Experimental===
====-ingame_join====
'''"Allows Ingame Joining"'''

Enables ingame joining in multiplayer. FIXME: Host option?

====-voicer====
'''"Voice Recognition"'''

Windows-only. Enables voice-recognition for wingmen commands. Must be specifically compiled into a build in order for it to be available; 3.6.10 final includes the feature. See [[Voice Recognition]] for more details.

===Development Tools===
====-fps====
'''"Show frames per second on HUD"'''

Displays current frames per second.

====-pos====
'''"Show Position of Camera"'''

Displays current position coordinates of camera.

====-window====
'''"Run in Window"'''

Runs the game in a window. No check to make sure that resolution is no higher than your desktop resolution, so be careful.

====-fullscreen_window====
'''"Run in Fullscreen Window"'''

====-timerbar====
Displays a timing bar across the top of the screen. Timerbar format varies by build. This is a relic from the Volition development days, and is unmaintained.
*'''Note:''' the parameter was removed as of the July 5, 2011 nightly build.

====-stats====
'''"Show Statistics"'''

Shows total and free physical memory, virtual memory and system pagefile.

====-coords====
'''"Show Coordinates"'''

Shows coordinates of the mouse cursor.

====-show_mem_usage====
'''"Show Memory Usage"'''

Shows detailed RAM usage based on file, handler and process usage and display on the left-center side of the screen during mission load and while in mission.

The meaning of the info displayed in the upper right corner of the HUD 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 does 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====
Reads all objects in the pof file of the selected mod, and creates an ibx cache file for each object in the data/cache folder for that mod. 
Details for each object are output to a pofspew.txt file created in the data folder. 
Otherwise, ibx files are created in game before each mission.

====-tablecrcs====
Is actually now (or should be) a typed reference rather than as a selection item. Takes 1 argument, usually a descriptive name.
Example usage: "-table_crcs MediaVPs" will create a table_crcs.csv file in the running mod (name can be separate of the mod selected) that allows for the validation of the tables used by that mod while on-line. The descriptive parameter given helps "allocate" that .csv file to the mod in question, and as such should closely or exactly match that mods name if possible.

====-missioncrcs====
Is actually now (or should be) a typed reference rather than as a selection item. Takes 1 argument, usually a descriptive name.
Example usage: "-mission_crcs MediaVPs" will create a mission_crcs.csv file in the running mod (name can be separate of the mod selected) that allows for the validation of the missions used by that mod while on-line. The descriptive parameter given helps "allocate" that .csv file to the mod in question, and as such should closely or exactly match that mods name if possible.

====-dis_collisions====
'''"Disable Collisions"'''

Disables all collisions.

====-dis_weapons====
'''"Disable Weapon Rendering"'''

Disables weapons rendering.

====-output_sexps====
This will make the FSO build spit out an html file that documents the supported SEXP's.

Just double click on sexps.html and it should open in your default web browser.

====-output_scripting====
This will make the FSO build spit out an html file that documents the supported scripting hooks and LUA libraries.

Just double click on scripting.html and it should open in your default web browser.

====-nograb====
Unix only. Disables focus grabbing in a window.

====-save_render_target====
'''"Save Render Targets to file"'''

====-debug_window====
'''"Display Debug Window"'''

Lists the fs2_open.log in (nearly)real-time generation.

====-verify_vps====
'''"Spew VP crcs to vp_crcs.txt"'''

Exports the CRC values of the VP files being loaded into a vp_crcs.txt file.

====-reparse_mainhall====
'''"Reparse mainhall.tbl when loading halls"'''

Mainhall.tbl will be reparsed every time a mainhall is loaded, as opposed to just once at game startup.

====-start_mission====
'''"Skip the mainhall in jump right into the specified mission"'''

Jump into the mission specified by the filename. Only in effect on the first run. This will skip load of the mainhall and its other related things altogether.

====-profile_frame_time====
'''"Profile engine subsystems"'''

Activates the frame profiling code. This presents a readout showing the current, minimum, maximum and average percentages of frametime a given section of code has taken up; this can be used to identify particular bottlenecks or measure the effectiveness of certain optimizations.

==Other==
The following options are not available as checkboxes in the launcher. Many require parameters, which follow the flag separated by a space. The prototype for use in this case is "-option argument"

===Lighting===
These factors can dramatically alter the atmosphere of the game. [[Sample Lighting Settings|This page]] has some sample lighting settings with screenshots.

====-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.

====-no_emissive_light====
By default, all ships in FS2 have a light generated on their own, it is more or less similar to a minimal amount of -ambient_factor. This feature was implemented to help the player seeing the ships over a black background. This flag disables this feature. Use it with a low -ambient_factor value to obtain an ultra-realistic dark looking.

====-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. This is a relative value.

====-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. This is a relative value.

====-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. This is a relative value.

====-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. This is a relative value.

====-ogl_spec====
Takes a numerical argument. This value changes the basic shininess of the specular light in OpenGL. A lower value reduces the overall intensity of the light making it broader and less powerful. A higher value makes it more focused and brighter. The default value is 80, and the usable range is 0 to 128 (clamped). The original default value was 60, but it was raised to behave more D3D like.

===Graphics===
====-bloom_intensity====
Requires -post_processing ("Enable Post Processing") command.
Default value is 75. Range is 0-200.

====-height====
Enables height maps (parallax mapping). It only works if [[Command-Line_Reference#-normal|-normal]] is also set. It also needs GLSL rendering, (see [[OpenGL_Shaders_(GLSL)|OpenGL Shaders (GLSL)]] for further info). It needs auxiliary height maps (with the same name than base map plus "-height").
{{Table3615|
*This feature is on by default. To manually disable, enter the flag -noheight}}

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

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

====-res====
Allows you to specify a resolution if the desired one cannot be set in the Launcher.
For example, -res 1920x1080 would run the game in 1920 x 1080 resolution. Since it requires an argument, it needs to be entered as a custom flag when using the Launcher. The "Run at specified resolution" option the Launcher gives is essentially this, but without being able to actually specify a resolution, it doesn't work.

====-fxaa_preset====
Requires both -post_processing and -fxaa. Can be used to adjust the FXAA quality and speed, 0 is fastest, 9 is highest quality. Default setting is 6.

===Gameplay===
====-mod====
Specifies in which folders inside FreeSpace 2 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 behavior, 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/

This flag can be indirectly set, (and it is normally set), through Launcher MOD tab and [[mod.ini]] file.

Within the Launcher's MOD 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 it will be used to modify the -mod flag, too.

For further details, see '''[[mod.ini]]'''

'''Data precedence'''

As already said, within the different directories, the data precedence is set by the specified order in the -mod flag. The lowest priority goes to the Freespace2 installation directory.

Inside each directory, data precedence is the following:

#Individual files located in ''Current_dir/data/'' subdir structure. See [[FS2_Data_Structure|FS2 Data Structure topic]] for deeper info about the different folders and contents this structure has.
#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 that this ''Mission.fs2'' is also 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 enhanced ones adding them in a higher priority place.

'''Additional notes'''
# As derived from the 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.
# This flag is also used by [[Portal:FRED|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. A special build of wxLauncher is able to configure FRED so that the -mod doesn't have to be done manually see [http://www.hard-light.net/forums/index.php?topic=67950.msg1387911#msg1387911 the forum post] for more details.
{{Table3612|As of 3.6.12 FRED now loads cmdline_fso.cfg just like FS does so FRED will use the same settings as FS including the -mod settings}}
# 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.

{{Warning| '''Priority and Texture Formats'''

''Obsolete behavior - Until FS2_open v3.6.9.:''

FS2_Open can use several file formats in textures: [http://en.wikipedia.org/wiki/PCX PCX], [http://en.wikipedia.org/wiki/DirectDraw_Surface DDS], [http://en.wikipedia.org/wiki/JPG JPG] and [http://en.wikipedia.org/wiki/TGA TGA]. Make sure you keep the format when you update your texture. For example if you update the old ''TextureOfMyFighter.tga'', do not save it as ''TextureOfMyFighter.dds'' in a higher priority place, because there is a chance of the game loading the old one despite of all.

The reason to do this is that, loading process (including priorities) is applied firstly for a kind of textures (TGAs), then for another kind (JPGs), and so on. This behavior can lead to situation where your new, updated and higher priority placed texture is not read because the format of the older one.

''New behavior - From FS2_open v3.6.10. (including previous beta testing releases):''

The former issue has been fixed. Now texture format priority is only applied within the same location. In this ''strange'' situation it goes DDS -> TGA -> JPG -> PCX. Examples:
* ''/Freespace2/MyVp.vp>>>data/maps/MyTexture.dds'' is loaded instead of ''/Freespace2/MyVp.vp>>>data/maps/MyTexture.tga''.
* But your improved ''/Freespace2/data/maps/MyTexture.xxx'' will override them both despite of its format.
In this way, when you update any texture, you don't have to pay attention to its original format. Just place it in a higher priority place.

Nevertheless, global priority is kept between animated and static textures. Because of their management, animated textures (ANIs and EFFs) are looked for BEFORE static ones. In this way there's no way to update an animated texture with a static one (an obsolete ANI is always going to be loaded before the newer DDS version). The solution: use an updated EFF with just one frame.

}}

====-fov====
This flag allows the player to specify the ''vertical'' Field of View (FoV) angle, in radians, for the player eyepoint. The angle is measured across the full height of the viewing cone. The FoV angle is technically known as the Angle of View (AoV)

*Syntax: '''''float''''' Angle
*Valid Values: 0 to 2*Pi radians
*Default Value: 0.75 radians

{{Note|For peculiar reasons, the actual FoV/AoV used by the game will be the supplied value multiplied by 1.39626348.}}

The the FoV angle/AoV is what determines the relative zoom level of the main game camera. Smaller angles generally equal to higher zoom levels, while larger angles equal to lower zoom levels (down to the theoretical x0 magnification).

However, too small of an angle will have a squashed look on the edges of your screen, and too high of an angle will greatly stretch edges. It is recommended to change the AoV, as FS2's default AoV has some perspective distortion at the screen edges (the default AoV is too high).

A natural looking (as if you where physically in the cockpit) AoV depends on the distance the player's actual eyes are away from the screen: the further away from the screen, the smaller the AoV should be, and vice versa. "Ergonomic" distances generally yield a '''''diagonal''''' AoV of 0.523 radians (30 degrees), but you can easily find the natural AoV by the following formula:

AoV (radians) = 2 * atan( H / ( 2*D ))

where:

Height of screen = H

Distance between head/eye and the screen = D

Generally, gamers like to increase the AoV in order to increase their peripheral vision on the screen, so as to gain a better situational awareness around their craft. An AoV of 0.39 radians seems to be a good start, but feel free to experiment and use whatever AoV you are most comfortable with.

===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 standalone 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 standalone 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 standalone game.

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

====-connect====
{{Sectstub}}
====-timeout====
{{Sectstub}}
====-cap_object_update====
Caps the maximum object update the server will respond to regardless of what the client has set. If the client is set to request high object updates but the server is capped to low, then that's all the client will get.

Takes one argument integer (0 to 3) which corresponds to the object update cap (With 0 being low and 3 being LAN).

===Help===
====-help====
Instructs FSO to print out all supported parameters. Some launchers can use these options to automatically populate the available command line options, even if the version of FSO is far newer than the launcher itself. NOTE: This option only works in Linux builds...

====--help====
See [[Command-Line_Reference#-help|-help]]

====-h====
See [[Command-Line_Reference#-help|-help]]

====-?====
See [[Command-Line_Reference#-help|-help]]

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

Command-Line Reference

2014-01-02T04:25:04Z

Echelon9: /* -clientdamage */

Command-Line Flags (also called Command-Line Parameters) are optional flags passed to the FSO executable, and generally enables one or more features added to the FS2 Open engine. These flags are accessed conveniently through an [[FSO Launcher]]. To have FSO list all available flags, use any one of the following: [[Command-Line_Reference#-help|-help]], [[Command-Line_Reference#-help|--help]], [[Command-Line_Reference#-help|-h]], or [[Command-Line_Reference#-help|-?]].



===Graphics===
====-spec====
'''"Enable Specular"'''

Only polygons mapped with textures for which a shinemap exists will receive 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).
{{Table3615|
*This feature is on by default, use launcher option Disable Specular or if necessary to manually disable enter the flag -nospec}}

====-env====
'''"Enable Environment maps"'''

It only works if [[Command-Line_Reference#-spec|-spec]] is also set. Environment mapping intensity will be determined from the shine map too (see [[Texturing]] for more info). [[Installing FreeSpace 2 Open#Video setup|See Video setup.]]
{{Table3615|
*This feature is on by default, use launcher option Disable Environment Maps or if necessary to manually disable enter the flag -noenv }}

====-glow====
'''"Enable Glowmaps"'''

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)
{{Table3615|
*This feature is on by default, use launcher option Disable Glow Maps or if necessary to manually disable enter the flag -noglow }}

====-nomotiondebris====
'''"Disable motion debris"'''

====-noscalevid====
"Disable scale-to-window for Movies"

Disables fullscreen scaling of video clips.

====-missile_lighting====
'''"Apply Lighting to Missiles"'''

====-normal====
'''"Enable Normal Maps"'''

Normal maps require GLSL rendering, (see [[OpenGL_Shaders_(GLSL)|OpenGL Shaders (GLSL)]] for further info). It needs auxiliary normal maps (the same name of the base map plus "-normal"). DXT5_NM DDS format is needed. (Technical note: DXT5 will work, since only the GREEN and ALPHA channels are read by the current shader system. One direction of lines goes into the GREEN channel, the other direction goes into the ALPHA channel. RED and BLUE can be either base gray (#808080) or black. Usual practice is after creating the DXT5_NM, copy the RED channel to the ALPHA channel, black out the RED and BLUE an then save as either a DXT5 or u8888 (uncompressed) DDS file.)
{{Table3615|
*This feature is on by default, use launcher option Disable Normal Maps or if necessary to manually disable enter the flag -nonormal }}

====-post_process====
'''"Enable Post Processing"'''

enables the use (if present) of post-processing effects as defined by the post_process.tbl. Bloom usage has an additional cmdline option for setting it's value, most post processing effects are achieved in mission per the mission designer or can be enabled globally in the table.

====-soft_particles====
'''"Enable soft particles"'''

====-3dshockwave====
'''"Enable 3D Shockwaves"'''

This only has any effect when both a 2d and 3d shockwave effect are present, otherwise the only available effect is used.

====-fxaa====
'''"Enable FXAA antialiasing"'''

Enables the FXAA postprocessing stage. Further information can be found here: http://www.hard-light.net/forums/index.php?topic=76145.0

====-flightshaftsoff====
'''"Force Lightshafts off"'''

Disables Lightshafts even if a mission designer enables them via SEXP in a mission.

===Game Speed===
====-img2dds====
'''"Compress non-compressed images"'''

Converts all images to DDS (compressed) format. Decreases memory usage but potentially reduces image quality.

====-no_vsync====
'''"Disable vertical sync"'''

====-cache_bitmaps====
'''"Cache bitmaps between missions"'''

Will ideally reduce the load-time from one mission to another.

===HUD===
====-dualscanlines====
'''"Another Pair of Scanning Lines"'''

Adds a second pair of scanning lines to the target window when scanning an object.

====-targetinfo====
'''"Enable Info next to Target"'''

Displays target info, such as name and class, beside the targeted object.

====-orbradar====
'''"Enables 3D radar"'''

An Orb style 3D radar will replace the standard 2D version.

====-rearm_timer====
'''"Enable Rearm/Repair Completion Timer"'''

Displays time remaining until rearm and repair from a support ship is complete.

====-ballistic_gauge====
'''"Enable the analog Ballistic Ammo gauge"'''

Adds an ammo gauge to the HUD when armed with a ballistic weapon.

===Gameplay===
====-ship_choice_3d====
'''"Use Models for Ship Selection"'''

Uses ship models in ship selection window. It completely disables the standard ANI interface in this screen. 
Some mods need a compulsory use of this flag because they don't have available animations for their ships. In this situation, and if it is not used, the game will probably crash to desktop in the ship selection window.

====-weapon_choice_3d====
'''"Use Models for Weapon Selection"'''

Uses weapon models in weapon loadout window for secondary weapons (missiles and bombs). It completely disables the standard ANI interface in this screen. 
Some mods need a compulsory use of this flag because they don't have available animations for their secondary weapons. In this situation, and if it is not used, the game will probably crash to desktop in the weapon loadout window.

====-3dwarp====
'''"Enable 3D Warp"'''

Use full geometry for the subspace warp effect.

====-warp_flash====
'''"Enable Flash upon Warp"'''

Enable a flash at warp in and warp out.

====-no_ap_interrupt====
'''"Disable Interrupting of AutoPilot"'''

Tells the game to not allow players to interrupt an autopilot already-in-progress.

===Audio===
====-snd_preload====
'''"Preload mission game sounds"'''

Useful in preventing game stuttering when sounds are played for the first time.

====-nosound====
'''"Disable Sound and Music"'''

====-nomusic====
'''"Disables Music"'''

===Multiplayer===
====-standalone====
'''"Run as Stand Alone Server"'''

Creates a standalone multi-player server.

====-startgame====
'''"Skip Mainhall and Start Hosting"'''

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====
'''"Start Hosted Server as 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====
'''"Host Confirms Join requests"'''

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====
{{Warning| This feature is not available in current builds.}}

====-mpnoreturn====
'''"Disables Flight Deck option"'''

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

===Troubleshooting===
====-nohtl====
'''"Software Mode (very slow)"'''
{{Warning| Enabling this will significantly reduce performance.}}
Reverts to software rendering mode.

====-no_set_gamma====
'''"Disable Setting of Gamma"'''

Disables the gamma settings in the options screen.

====-nomovies====
'''"Disable Video Playback"'''

Disables all video playback.

====-noparseerrors====
'''"Disable Parsing Errors"'''

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.
*'''Note:''' the parameter was removed as of the July 5, 2011 nightly build.

====-query_speech====
'''"Does this build have Speech?"'''

Determines if the current build includes text-to-speech.

====-novbo====
'''"Disable OpenGL VBO"'''

====-noibx====
'''"Don't use cached index buffers (IBX)"'''

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"'''

====-disable_fbo====
'''"Disable OpenGL RenderTargets"'''

====-disable_pbo====
'''"Disable OpenGL Pixel Buffer Objects"'''

Disables the use of Pixel Buffer Objects (PBO) which may cause certain OpenGL operations to perform slower. Note PBO's were only used at three places in FSO anyway so it's *probably* not going to have a noticeable effect.

May be required to workaround issues in certain versions of Linux's Mesa drivers for Intel integrated graphics cards where crashes occur in the mainhall (i.e. whenever a popup occurs). Distros that seem to have this problem presently include Ubuntu 13.10 and openSUSE 13.1.
{{Table371|
*This feature is present to work around a bug in Linux's Mesa drivers for Intel integrated graphics cards}}

====-no_glsl====
'''"Disable GLSL (shader) Support"'''

Disables the use of GLSL rendering (OpenGL shaders). The game will revert to legacy fixed render pipeline. Please note that Normal and Height map effects will be unavailable.

====-disable_glsl_model====
'''"Don't use shaders for model rendering"'''

====-ati_swap====
'''"Fix Color issues on some ATI cards"'''

====-no_3d_sound====
'''"Use only 2D/stereo for sound effects"'''

====-disable_di_mouse====
'''"Disables the DirectInput mouse code for FSO on windows."'''

'''Windows Only''' Can make mouse movement smoother on certain machines.

====-mipmap====
'''"Enable mipmapping"'''

Causes for non-mipmapped textures to have mipmaps generated within the GPU on certain kind of texture formats, (IIRC, DDS formatted textures with a power of 2 size in both width and height). 
Since the use of already mipmapped DDS textures has become common, it has become deprecated.
The quality of the generated mipmaps depends on each GPU and used driver. It is normally used with [[Command-Line_Reference#-img2dds|-img2dds]] flag.

====-use_gldrawelements====
'''"Use glDrawElements instead of glDrawRangeElements"'''

Introduced as a means of switching to the slower OpenGL call glDrawElements, instead of glDrawRangeElements.
{{Table3614|
*This feature may resolve certain rendering problems where parts of models are not drawn on Linux drivers}}

====-keyboard_layout====
'''"Manually sets a keyboard layout"'''

A commandline parameter to set the keyboard layout as a string parameter.
{{Table3614|
*Currently the only valid string is "qwertz" (German) but French azerty may be added in future.}}

===Experimental===
====-ingame_join====
'''"Allows Ingame Joining"'''

Enables ingame joining in multiplayer. FIXME: Host option?

====-voicer====
'''"Voice Recognition"'''

Windows-only. Enables voice-recognition for wingmen commands. Must be specifically compiled into a build in order for it to be available; 3.6.10 final includes the feature. See [[Voice Recognition]] for more details.

===Development Tools===
====-fps====
'''"Show frames per second on HUD"'''

Displays current frames per second.

====-pos====
'''"Show Position of Camera"'''

Displays current position coordinates of camera.

====-window====
'''"Run in Window"'''

Runs the game in a window. No check to make sure that resolution is no higher than your desktop resolution, so be careful.

====-fullscreen_window====
'''"Run in Fullscreen Window"'''

====-timerbar====
Displays a timing bar across the top of the screen. Timerbar format varies by build. This is a relic from the Volition development days, and is unmaintained.
*'''Note:''' the parameter was removed as of the July 5, 2011 nightly build.

====-stats====
'''"Show Statistics"'''

Shows total and free physical memory, virtual memory and system pagefile.

====-coords====
'''"Show Coordinates"'''

Shows coordinates of the mouse cursor.

====-show_mem_usage====
'''"Show Memory Usage"'''

Shows detailed RAM usage based on file, handler and process usage and display on the left-center side of the screen during mission load and while in mission.

The meaning of the info displayed in the upper right corner of the HUD 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 does 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====
Reads all objects in the pof file of the selected mod, and creates an ibx cache file for each object in the data/cache folder for that mod. 
Details for each object are output to a pofspew.txt file created in the data folder. 
Otherwise, ibx files are created in game before each mission.

====-tablecrcs====
Is actually now (or should be) a typed reference rather than as a selection item. Takes 1 argument, usually a descriptive name.
Example usage: "-table_crcs MediaVPs" will create a table_crcs.csv file in the running mod (name can be separate of the mod selected) that allows for the validation of the tables used by that mod while on-line. The descriptive parameter given helps "allocate" that .csv file to the mod in question, and as such should closely or exactly match that mods name if possible.

====-missioncrcs====
Is actually now (or should be) a typed reference rather than as a selection item. Takes 1 argument, usually a descriptive name.
Example usage: "-mission_crcs MediaVPs" will create a mission_crcs.csv file in the running mod (name can be separate of the mod selected) that allows for the validation of the missions used by that mod while on-line. The descriptive parameter given helps "allocate" that .csv file to the mod in question, and as such should closely or exactly match that mods name if possible.

====-dis_collisions====
'''"Disable Collisions"'''

Disables all collisions.

====-dis_weapons====
'''"Disable Weapon Rendering"'''

Disables weapons rendering.

====-output_sexps====
This will make the FSO build spit out an html file that documents the supported SEXP's.

Just double click on sexps.html and it should open in your default web browser.

====-output_scripting====
This will make the FSO build spit out an html file that documents the supported scripting hooks and LUA libraries.

Just double click on scripting.html and it should open in your default web browser.

====-nograb====
Unix only. Disables focus grabbing in a window.

====-save_render_target====
'''"Save Render Targets to file"'''

====-debug_window====
'''"Display Debug Window"'''

Lists the fs2_open.log in (nearly)real-time generation.

====-verify_vps====
'''"Spew VP crcs to vp_crcs.txt"'''

Exports the CRC values of the VP files being loaded into a vp_crcs.txt file.

====-reparse_mainhall====
'''"Reparse mainhall.tbl when loading halls"'''

Mainhall.tbl will be reparsed every time a mainhall is loaded, as opposed to just once at game startup.

====-start_mission====
'''"Skip the mainhall in jump right into the specified mission"'''

Jump into the mission specified by the filename. Only in effect on the first run. This will skip load of the mainhall and its other related things altogether.

====-profile_frame_time====
'''"Profile engine subsystems"'''

Activates the frame profiling code. This presents a readout showing the current, minimum, maximum and average percentages of frametime a given section of code has taken up; this can be used to identify particular bottlenecks or measure the effectiveness of certain optimizations.

==Other==
The following options are not available as checkboxes in the launcher. Many require parameters, which follow the flag separated by a space. The prototype for use in this case is "-option argument"

===Lighting===
These factors can dramatically alter the atmosphere of the game. [[Sample Lighting Settings|This page]] has some sample lighting settings with screenshots.

====-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.

====-no_emissive_light====
By default, all ships in FS2 have a light generated on their own, it is more or less similar to a minimal amount of -ambient_factor. This feature was implemented to help the player seeing the ships over a black background. This flag disables this feature. Use it with a low -ambient_factor value to obtain an ultra-realistic dark looking.

====-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. This is a relative value.

====-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. This is a relative value.

====-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. This is a relative value.

====-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. This is a relative value.

====-ogl_spec====
Takes a numerical argument. This value changes the basic shininess of the specular light in OpenGL. A lower value reduces the overall intensity of the light making it broader and less powerful. A higher value makes it more focused and brighter. The default value is 80, and the usable range is 0 to 128 (clamped). The original default value was 60, but it was raised to behave more D3D like.

===Graphics===
====-bloom_intensity====
Requires -post_processing ("Enable Post Processing") command.
Default value is 75. Range is 0-200.

====-height====
Enables height maps (parallax mapping). It only works if [[Command-Line_Reference#-normal|-normal]] is also set. It also needs GLSL rendering, (see [[OpenGL_Shaders_(GLSL)|OpenGL Shaders (GLSL)]] for further info). It needs auxiliary height maps (with the same name than base map plus "-height").
{{Table3615|
*This feature is on by default. To manually disable, enter the flag -noheight}}

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

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

====-res====
Allows you to specify a resolution if the desired one cannot be set in the Launcher.
For example, -res 1920x1080 would run the game in 1920 x 1080 resolution. Since it requires an argument, it needs to be entered as a custom flag when using the Launcher. The "Run at specified resolution" option the Launcher gives is essentially this, but without being able to actually specify a resolution, it doesn't work.

====-fxaa_preset====
Requires both -post_processing and -fxaa. Can be used to adjust the FXAA quality and speed, 0 is fastest, 9 is highest quality. Default setting is 6.

===Gameplay===
====-mod====
Specifies in which folders inside FreeSpace 2 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 behavior, 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/

This flag can be indirectly set, (and it is normally set), through Launcher MOD tab and [[mod.ini]] file.

Within the Launcher's MOD 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 it will be used to modify the -mod flag, too.

For further details, see '''[[mod.ini]]'''

'''Data precedence'''

As already said, within the different directories, the data precedence is set by the specified order in the -mod flag. The lowest priority goes to the Freespace2 installation directory.

Inside each directory, data precedence is the following:

#Individual files located in ''Current_dir/data/'' subdir structure. See [[FS2_Data_Structure|FS2 Data Structure topic]] for deeper info about the different folders and contents this structure has.
#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 that this ''Mission.fs2'' is also 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 enhanced ones adding them in a higher priority place.

'''Additional notes'''
# As derived from the 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.
# This flag is also used by [[Portal:FRED|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. A special build of wxLauncher is able to configure FRED so that the -mod doesn't have to be done manually see [http://www.hard-light.net/forums/index.php?topic=67950.msg1387911#msg1387911 the forum post] for more details.
{{Table3612|As of 3.6.12 FRED now loads cmdline_fso.cfg just like FS does so FRED will use the same settings as FS including the -mod settings}}
# 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.

{{Warning| '''Priority and Texture Formats'''

''Obsolete behavior - Until FS2_open v3.6.9.:''

FS2_Open can use several file formats in textures: [http://en.wikipedia.org/wiki/PCX PCX], [http://en.wikipedia.org/wiki/DirectDraw_Surface DDS], [http://en.wikipedia.org/wiki/JPG JPG] and [http://en.wikipedia.org/wiki/TGA TGA]. Make sure you keep the format when you update your texture. For example if you update the old ''TextureOfMyFighter.tga'', do not save it as ''TextureOfMyFighter.dds'' in a higher priority place, because there is a chance of the game loading the old one despite of all.

The reason to do this is that, loading process (including priorities) is applied firstly for a kind of textures (TGAs), then for another kind (JPGs), and so on. This behavior can lead to situation where your new, updated and higher priority placed texture is not read because the format of the older one.

''New behavior - From FS2_open v3.6.10. (including previous beta testing releases):''

The former issue has been fixed. Now texture format priority is only applied within the same location. In this ''strange'' situation it goes DDS -> TGA -> JPG -> PCX. Examples:
* ''/Freespace2/MyVp.vp>>>data/maps/MyTexture.dds'' is loaded instead of ''/Freespace2/MyVp.vp>>>data/maps/MyTexture.tga''.
* But your improved ''/Freespace2/data/maps/MyTexture.xxx'' will override them both despite of its format.
In this way, when you update any texture, you don't have to pay attention to its original format. Just place it in a higher priority place.

Nevertheless, global priority is kept between animated and static textures. Because of their management, animated textures (ANIs and EFFs) are looked for BEFORE static ones. In this way there's no way to update an animated texture with a static one (an obsolete ANI is always going to be loaded before the newer DDS version). The solution: use an updated EFF with just one frame.

}}

====-fov====
This flag allows the player to specify the ''vertical'' Field of View (FoV) angle, in radians, for the player eyepoint. The angle is measured across the full height of the viewing cone. The FoV angle is technically known as the Angle of View (AoV)

*Syntax: '''''float''''' Angle
*Valid Values: 0 to 2*Pi radians
*Default Value: 0.75 radians

{{Note|For peculiar reasons, the actual FoV/AoV used by the game will be the supplied value multiplied by 1.39626348.}}

The the FoV angle/AoV is what determines the relative zoom level of the main game camera. Smaller angles generally equal to higher zoom levels, while larger angles equal to lower zoom levels (down to the theoretical x0 magnification).

However, too small of an angle will have a squashed look on the edges of your screen, and too high of an angle will greatly stretch edges. It is recommended to change the AoV, as FS2's default AoV has some perspective distortion at the screen edges (the default AoV is too high).

A natural looking (as if you where physically in the cockpit) AoV depends on the distance the player's actual eyes are away from the screen: the further away from the screen, the smaller the AoV should be, and vice versa. "Ergonomic" distances generally yield a '''''diagonal''''' AoV of 0.523 radians (30 degrees), but you can easily find the natural AoV by the following formula:

AoV (radians) = 2 * atan( H / ( 2*D ))

where:

Height of screen = H

Distance between head/eye and the screen = D

Generally, gamers like to increase the AoV in order to increase their peripheral vision on the screen, so as to gain a better situational awareness around their craft. An AoV of 0.39 radians seems to be a good start, but feel free to experiment and use whatever AoV you are most comfortable with.

===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 standalone 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 standalone 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 standalone game.

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

====-connect====
{{Sectstub}}
====-timeout====
{{Sectstub}}
====-cap_object_update====
Caps the maximum object update the server will respond to regardless of what the client has set. If the client is set to request high object updates but the server is capped to low, then that's all the client will get.

Takes one argument integer (0 to 3) which corresponds to the object update cap (With 0 being low and 3 being LAN).

===Help===
====-help====
Instructs FSO to print out all supported parameters. Some launchers can use these options to automatically populate the available command line options, even if the version of FSO is far newer than the launcher itself. NOTE: This option only works in Linux builds...

====--help====
See [[Command-Line_Reference#-help|-help]]

====-h====
See [[Command-Line_Reference#-help|-help]]

====-?====
See [[Command-Line_Reference#-help|-help]]

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

Newbie Projects

2014-01-02T03:54:22Z

Echelon9:

== Projects suitable for new developers ==

This is a collection of small, fairly simple tasks which developers new to Freespace 2 Open can use to get a start with the project.

The lists below are broken down into a logical workflow that will likely match the set of patches that you will produce.

Please create a thread on the [http://www.hard-light.net/forums/index.php?board=50.0 HLP forums] with your proposed patches attached or link to a [https://github.com/scp-fs2open/fs2open.github.com Github pull request]. The suggested patch series below are designed to encourage the good practice of providing a series of small standalone patches that are capable of easy review.

Inspired by the [http://wiki.freedesktop.org/dri/NewbieProjects/ Freedesktop DRI Newbie Projects].

== Improve documentation of [https://github.com/scp-fs2open/fs2open.github.com/blob/master/code/cmdline/cmdline.cpp#L127 -nolightshafts] command line option ==

Freespace 2 Open provides a command line option -nolightshafts to disable lightshafts in game, even if a mission designer enables them in a mission.

This feature was previously called -flightshaftsoff and references remain to the old name within the Freespace 2 Open code base and the Freespace Wiki documentation system.

The patch series to implement this functionality would likely consist of the following patches:

* Modify the <code>cmdline_parm flightshaftsoff_arg()</code> name in code/cmdline/cmdline.cpp so that it reads <code>cmdline_parm nolightshafts_arg</code>
* Modify <code>SetCmdlineParams()</code> in code/cmdline/cmdline.cpp so that <code>nolightshafts_arg()</code> is used in the if() test
* Modify the [http://www.hard-light.net/wiki/index.php/Command-Line_Reference#-flightshaftsoff -flightshaftsoff] documentation to refer to -nolightshafts instead
* Modify the <code>exe_params[]</code> array in code/cmdline/cmdline.cpp to correct the URL location of -nolightshafts Wiki documentation

You will need to register an account on the Freespace Wiki to complete the third step.

== Enable the <code>AIM_GET_BEHIND</code> feature ==

TODO: This would involve implementing the AIM_GET_BEHIND artificial intelligence feature as was originally completed in The Babylon Project source code fork

Development Reference

2014-01-02T03:52:13Z

Echelon9: Introduce the Newbie Projects page

* [[Getting the FreeSpace2: SCP Source Code|Getting the Source Code]]
* [[Newbie Projects]]
* [[Sourcecode Reference]]
* [[Doxygen Documentation]]
* [[Scripting API]]
* [[FS2_Open Lua Scripting]]
* [[OpenGL Shaders (GLSL)]]
* [[Deprecation|List of deprecated game features (WIP)]]

===wxFRED2 WIP===

* [[wxfred2Contributions|Contributing]]

===External Links===
[http://scp.indiegames.us/ SCP Developers' Page]

[[Category:Source Code Project]]

Newbie Projects

2014-01-02T00:01:25Z

Echelon9: Develop the first Newbie Project idea

Command-Line Reference

2014-01-01T23:13:21Z

Echelon9: /* Troubleshooting */ Add a reference to the commandline option -keyboard_layout

Command-Line Flags (also called Command-Line Parameters) are optional flags passed to the FSO executable, and generally enables one or more features added to the FS2 Open engine. These flags are accessed conveniently through an [[FSO Launcher]]. To have FSO list all available flags, use any one of the following: [[Command-Line_Reference#-help|-help]], [[Command-Line_Reference#-help|--help]], [[Command-Line_Reference#-help|-h]], or [[Command-Line_Reference#-help|-?]].



===Graphics===
====-spec====
'''"Enable Specular"'''

Only polygons mapped with textures for which a shinemap exists will receive 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).
{{Table3615|
*This feature is on by default, use launcher option Disable Specular or if necessary to manually disable enter the flag -nospec}}

====-env====
'''"Enable Environment maps"'''

It only works if [[Command-Line_Reference#-spec|-spec]] is also set. Environment mapping intensity will be determined from the shine map too (see [[Texturing]] for more info). [[Installing FreeSpace 2 Open#Video setup|See Video setup.]]
{{Table3615|
*This feature is on by default, use launcher option Disable Environment Maps or if necessary to manually disable enter the flag -noenv }}

====-glow====
'''"Enable Glowmaps"'''

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)
{{Table3615|
*This feature is on by default, use launcher option Disable Glow Maps or if necessary to manually disable enter the flag -noglow }}

====-nomotiondebris====
'''"Disable motion debris"'''

====-noscalevid====
"Disable scale-to-window for Movies"

Disables fullscreen scaling of video clips.

====-missile_lighting====
'''"Apply Lighting to Missiles"'''

====-normal====
'''"Enable Normal Maps"'''

Normal maps require GLSL rendering, (see [[OpenGL_Shaders_(GLSL)|OpenGL Shaders (GLSL)]] for further info). It needs auxiliary normal maps (the same name of the base map plus "-normal"). DXT5_NM DDS format is needed. (Technical note: DXT5 will work, since only the GREEN and ALPHA channels are read by the current shader system. One direction of lines goes into the GREEN channel, the other direction goes into the ALPHA channel. RED and BLUE can be either base gray (#808080) or black. Usual practice is after creating the DXT5_NM, copy the RED channel to the ALPHA channel, black out the RED and BLUE an then save as either a DXT5 or u8888 (uncompressed) DDS file.)
{{Table3615|
*This feature is on by default, use launcher option Disable Normal Maps or if necessary to manually disable enter the flag -nonormal }}

====-post_process====
'''"Enable Post Processing"'''

enables the use (if present) of post-processing effects as defined by the post_process.tbl. Bloom usage has an additional cmdline option for setting it's value, most post processing effects are achieved in mission per the mission designer or can be enabled globally in the table.

====-soft_particles====
'''"Enable soft particles"'''

====-3dshockwave====
'''"Enable 3D Shockwaves"'''

This only has any effect when both a 2d and 3d shockwave effect are present, otherwise the only available effect is used.

====-fxaa====
'''"Enable FXAA antialiasing"'''

Enables the FXAA postprocessing stage. Further information can be found here: http://www.hard-light.net/forums/index.php?topic=76145.0

====-flightshaftsoff====
'''"Force Lightshafts off"'''

Disables Lightshafts even if a mission designer enables them via SEXP in a mission.

===Game Speed===
====-img2dds====
'''"Compress non-compressed images"'''

Converts all images to DDS (compressed) format. Decreases memory usage but potentially reduces image quality.

====-no_vsync====
'''"Disable vertical sync"'''

====-cache_bitmaps====
'''"Cache bitmaps between missions"'''

Will ideally reduce the load-time from one mission to another.

===HUD===
====-dualscanlines====
'''"Another Pair of Scanning Lines"'''

Adds a second pair of scanning lines to the target window when scanning an object.

====-targetinfo====
'''"Enable Info next to Target"'''

Displays target info, such as name and class, beside the targeted object.

====-orbradar====
'''"Enables 3D radar"'''

An Orb style 3D radar will replace the standard 2D version.

====-rearm_timer====
'''"Enable Rearm/Repair Completion Timer"'''

Displays time remaining until rearm and repair from a support ship is complete.

====-ballistic_gauge====
'''"Enable the analog Ballistic Ammo gauge"'''

Adds an ammo gauge to the HUD when armed with a ballistic weapon.

===Gameplay===
====-ship_choice_3d====
'''"Use Models for Ship Selection"'''

Uses ship models in ship selection window. It completely disables the standard ANI interface in this screen. 
Some mods need a compulsory use of this flag because they don't have available animations for their ships. In this situation, and if it is not used, the game will probably crash to desktop in the ship selection window.

====-weapon_choice_3d====
'''"Use Models for Weapon Selection"'''

Uses weapon models in weapon loadout window for secondary weapons (missiles and bombs). It completely disables the standard ANI interface in this screen. 
Some mods need a compulsory use of this flag because they don't have available animations for their secondary weapons. In this situation, and if it is not used, the game will probably crash to desktop in the weapon loadout window.

====-3dwarp====
'''"Enable 3D Warp"'''

Use full geometry for the subspace warp effect.

====-warp_flash====
'''"Enable Flash upon Warp"'''

Enable a flash at warp in and warp out.

====-no_ap_interrupt====
'''"Disable Interrupting of AutoPilot"'''

Tells the game to not allow players to interrupt an autopilot already-in-progress.

===Audio===
====-snd_preload====
'''"Preload mission game sounds"'''

Useful in preventing game stuttering when sounds are played for the first time.

====-nosound====
'''"Disable Sound and Music"'''

====-nomusic====
'''"Disables Music"'''

===Multiplayer===
====-standalone====
'''"Run as Stand Alone Server"'''

Creates a standalone multi-player server.

====-startgame====
'''"Skip Mainhall and Start Hosting"'''

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====
'''"Start Hosted Server as 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====
'''"Host Confirms Join requests"'''

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 Flight Deck option"'''

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

===Troubleshooting===
====-nohtl====
'''"Software Mode (very slow)"'''
{{Warning| Enabling this will significantly reduce performance.}}
Reverts to software rendering mode.

====-no_set_gamma====
'''"Disable Setting of Gamma"'''

Disables the gamma settings in the options screen.

====-nomovies====
'''"Disable Video Playback"'''

Disables all video playback.

====-noparseerrors====
'''"Disable Parsing Errors"'''

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.
*'''Note:''' the parameter was removed as of the July 5, 2011 nightly build.

====-query_speech====
'''"Does this build have Speech?"'''

Determines if the current build includes text-to-speech.

====-novbo====
'''"Disable OpenGL VBO"'''

====-noibx====
'''"Don't use cached index buffers (IBX)"'''

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"'''

====-disable_fbo====
'''"Disable OpenGL RenderTargets"'''

====-disable_pbo====
'''"Disable OpenGL Pixel Buffer Objects"'''

Disables the use of Pixel Buffer Objects (PBO) which may cause certain OpenGL operations to perform slower. Note PBO's were only used at three places in FSO anyway so it's *probably* not going to have a noticeable effect.

May be required to workaround issues in certain versions of Linux's Mesa drivers for Intel integrated graphics cards where crashes occur in the mainhall (i.e. whenever a popup occurs). Distros that seem to have this problem presently include Ubuntu 13.10 and openSUSE 13.1.
{{Table371|
*This feature is present to work around a bug in Linux's Mesa drivers for Intel integrated graphics cards}}

====-no_glsl====
'''"Disable GLSL (shader) Support"'''

Disables the use of GLSL rendering (OpenGL shaders). The game will revert to legacy fixed render pipeline. Please note that Normal and Height map effects will be unavailable.

====-disable_glsl_model====
'''"Don't use shaders for model rendering"'''

====-ati_swap====
'''"Fix Color issues on some ATI cards"'''

====-no_3d_sound====
'''"Use only 2D/stereo for sound effects"'''

====-disable_di_mouse====
'''"Disables the DirectInput mouse code for FSO on windows."'''

'''Windows Only''' Can make mouse movement smoother on certain machines.

====-mipmap====
'''"Enable mipmapping"'''

Causes for non-mipmapped textures to have mipmaps generated within the GPU on certain kind of texture formats, (IIRC, DDS formatted textures with a power of 2 size in both width and height). 
Since the use of already mipmapped DDS textures has become common, it has become deprecated.
The quality of the generated mipmaps depends on each GPU and used driver. It is normally used with [[Command-Line_Reference#-img2dds|-img2dds]] flag.

====-use_gldrawelements====
'''"Use glDrawElements instead of glDrawRangeElements"'''

Introduced as a means of switching to the slower OpenGL call glDrawElements, instead of glDrawRangeElements.
{{Table3614|
*This feature may resolve certain rendering problems where parts of models are not drawn on Linux drivers}}

====-keyboard_layout====
'''"Manually sets a keyboard layout"'''

A commandline parameter to set the keyboard layout as a string parameter.
{{Table3614|
*Currently the only valid string is "qwertz" (German) but French azerty may be added in future.}}

===Experimental===
====-ingame_join====
'''"Allows Ingame Joining"'''

Enables ingame joining in multiplayer. FIXME: Host option?

====-voicer====
'''"Voice Recognition"'''

Windows-only. Enables voice-recognition for wingmen commands. Must be specifically compiled into a build in order for it to be available; 3.6.10 final includes the feature. See [[Voice Recognition]] for more details.

===Development Tools===
====-fps====
'''"Show frames per second on HUD"'''

Displays current frames per second.

====-pos====
'''"Show Position of Camera"'''

Displays current position coordinates of camera.

====-window====
'''"Run in Window"'''

Runs the game in a window. No check to make sure that resolution is no higher than your desktop resolution, so be careful.

====-fullscreen_window====
'''"Run in Fullscreen Window"'''

====-timerbar====
Displays a timing bar across the top of the screen. Timerbar format varies by build. This is a relic from the Volition development days, and is unmaintained.
*'''Note:''' the parameter was removed as of the July 5, 2011 nightly build.

====-stats====
'''"Show Statistics"'''

Shows total and free physical memory, virtual memory and system pagefile.

====-coords====
'''"Show Coordinates"'''

Shows coordinates of the mouse cursor.

====-show_mem_usage====
'''"Show Memory Usage"'''

Shows detailed RAM usage based on file, handler and process usage and display on the left-center side of the screen during mission load and while in mission.

The meaning of the info displayed in the upper right corner of the HUD 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 does 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====
Reads all objects in the pof file of the selected mod, and creates an ibx cache file for each object in the data/cache folder for that mod. 
Details for each object are output to a pofspew.txt file created in the data folder. 
Otherwise, ibx files are created in game before each mission.

====-tablecrcs====
Is actually now (or should be) a typed reference rather than as a selection item. Takes 1 argument, usually a descriptive name.
Example usage: "-table_crcs MediaVPs" will create a table_crcs.csv file in the running mod (name can be separate of the mod selected) that allows for the validation of the tables used by that mod while on-line. The descriptive parameter given helps "allocate" that .csv file to the mod in question, and as such should closely or exactly match that mods name if possible.

====-missioncrcs====
Is actually now (or should be) a typed reference rather than as a selection item. Takes 1 argument, usually a descriptive name.
Example usage: "-mission_crcs MediaVPs" will create a mission_crcs.csv file in the running mod (name can be separate of the mod selected) that allows for the validation of the missions used by that mod while on-line. The descriptive parameter given helps "allocate" that .csv file to the mod in question, and as such should closely or exactly match that mods name if possible.

====-dis_collisions====
'''"Disable Collisions"'''

Disables all collisions.

====-dis_weapons====
'''"Disable Weapon Rendering"'''

Disables weapons rendering.

====-output_sexps====
This will make the FSO build spit out an html file that documents the supported SEXP's.

Just double click on sexps.html and it should open in your default web browser.

====-output_scripting====
This will make the FSO build spit out an html file that documents the supported scripting hooks and LUA libraries.

Just double click on scripting.html and it should open in your default web browser.

====-nograb====
Unix only. Disables focus grabbing in a window.

====-save_render_target====
'''"Save Render Targets to file"'''

====-debug_window====
'''"Display Debug Window"'''

Lists the fs2_open.log in (nearly)real-time generation.

====-verify_vps====
'''"Spew VP crcs to vp_crcs.txt"'''

Exports the CRC values of the VP files being loaded into a vp_crcs.txt file.

====-reparse_mainhall====
'''"Reparse mainhall.tbl when loading halls"'''

Mainhall.tbl will be reparsed every time a mainhall is loaded, as opposed to just once at game startup.

====-start_mission====
'''"Skip the mainhall in jump right into the specified mission"'''

Jump into the mission specified by the filename. Only in effect on the first run. This will skip load of the mainhall and its other related things altogether.

====-profile_frame_time====
'''"Profile engine subsystems"'''

Activates the frame profiling code. This presents a readout showing the current, minimum, maximum and average percentages of frametime a given section of code has taken up; this can be used to identify particular bottlenecks or measure the effectiveness of certain optimizations.

==Other==
The following options are not available as checkboxes in the launcher. Many require parameters, which follow the flag separated by a space. The prototype for use in this case is "-option argument"

===Lighting===
These factors can dramatically alter the atmosphere of the game. [[Sample Lighting Settings|This page]] has some sample lighting settings with screenshots.

====-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.

====-no_emissive_light====
By default, all ships in FS2 have a light generated on their own, it is more or less similar to a minimal amount of -ambient_factor. This feature was implemented to help the player seeing the ships over a black background. This flag disables this feature. Use it with a low -ambient_factor value to obtain an ultra-realistic dark looking.

====-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. This is a relative value.

====-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. This is a relative value.

====-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. This is a relative value.

====-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. This is a relative value.

====-ogl_spec====
Takes a numerical argument. This value changes the basic shininess of the specular light in OpenGL. A lower value reduces the overall intensity of the light making it broader and less powerful. A higher value makes it more focused and brighter. The default value is 80, and the usable range is 0 to 128 (clamped). The original default value was 60, but it was raised to behave more D3D like.

===Graphics===
====-bloom_intensity====
Requires -post_processing ("Enable Post Processing") command.
Default value is 75. Range is 0-200.

====-height====
Enables height maps (parallax mapping). It only works if [[Command-Line_Reference#-normal|-normal]] is also set. It also needs GLSL rendering, (see [[OpenGL_Shaders_(GLSL)|OpenGL Shaders (GLSL)]] for further info). It needs auxiliary height maps (with the same name than base map plus "-height").
{{Table3615|
*This feature is on by default. To manually disable, enter the flag -noheight}}

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

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

====-res====
Allows you to specify a resolution if the desired one cannot be set in the Launcher.
For example, -res 1920x1080 would run the game in 1920 x 1080 resolution. Since it requires an argument, it needs to be entered as a custom flag when using the Launcher. The "Run at specified resolution" option the Launcher gives is essentially this, but without being able to actually specify a resolution, it doesn't work.

====-fxaa_preset====
Requires both -post_processing and -fxaa. Can be used to adjust the FXAA quality and speed, 0 is fastest, 9 is highest quality. Default setting is 6.

===Gameplay===
====-mod====
Specifies in which folders inside FreeSpace 2 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 behavior, 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/

This flag can be indirectly set, (and it is normally set), through Launcher MOD tab and [[mod.ini]] file.

Within the Launcher's MOD 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 it will be used to modify the -mod flag, too.

For further details, see '''[[mod.ini]]'''

'''Data precedence'''

As already said, within the different directories, the data precedence is set by the specified order in the -mod flag. The lowest priority goes to the Freespace2 installation directory.

Inside each directory, data precedence is the following:

#Individual files located in ''Current_dir/data/'' subdir structure. See [[FS2_Data_Structure|FS2 Data Structure topic]] for deeper info about the different folders and contents this structure has.
#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 that this ''Mission.fs2'' is also 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 enhanced ones adding them in a higher priority place.

'''Additional notes'''
# As derived from the 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.
# This flag is also used by [[Portal:FRED|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. A special build of wxLauncher is able to configure FRED so that the -mod doesn't have to be done manually see [http://www.hard-light.net/forums/index.php?topic=67950.msg1387911#msg1387911 the forum post] for more details.
{{Table3612|As of 3.6.12 FRED now loads cmdline_fso.cfg just like FS does so FRED will use the same settings as FS including the -mod settings}}
# 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.

{{Warning| '''Priority and Texture Formats'''

''Obsolete behavior - Until FS2_open v3.6.9.:''

FS2_Open can use several file formats in textures: [http://en.wikipedia.org/wiki/PCX PCX], [http://en.wikipedia.org/wiki/DirectDraw_Surface DDS], [http://en.wikipedia.org/wiki/JPG JPG] and [http://en.wikipedia.org/wiki/TGA TGA]. Make sure you keep the format when you update your texture. For example if you update the old ''TextureOfMyFighter.tga'', do not save it as ''TextureOfMyFighter.dds'' in a higher priority place, because there is a chance of the game loading the old one despite of all.

The reason to do this is that, loading process (including priorities) is applied firstly for a kind of textures (TGAs), then for another kind (JPGs), and so on. This behavior can lead to situation where your new, updated and higher priority placed texture is not read because the format of the older one.

''New behavior - From FS2_open v3.6.10. (including previous beta testing releases):''

The former issue has been fixed. Now texture format priority is only applied within the same location. In this ''strange'' situation it goes DDS -> TGA -> JPG -> PCX. Examples:
* ''/Freespace2/MyVp.vp>>>data/maps/MyTexture.dds'' is loaded instead of ''/Freespace2/MyVp.vp>>>data/maps/MyTexture.tga''.
* But your improved ''/Freespace2/data/maps/MyTexture.xxx'' will override them both despite of its format.
In this way, when you update any texture, you don't have to pay attention to its original format. Just place it in a higher priority place.

Nevertheless, global priority is kept between animated and static textures. Because of their management, animated textures (ANIs and EFFs) are looked for BEFORE static ones. In this way there's no way to update an animated texture with a static one (an obsolete ANI is always going to be loaded before the newer DDS version). The solution: use an updated EFF with just one frame.

}}

====-fov====
This flag allows the player to specify the ''vertical'' Field of View (FoV) angle, in radians, for the player eyepoint. The angle is measured across the full height of the viewing cone. The FoV angle is technically known as the Angle of View (AoV)

*Syntax: '''''float''''' Angle
*Valid Values: 0 to 2*Pi radians
*Default Value: 0.75 radians

{{Note|For peculiar reasons, the actual FoV/AoV used by the game will be the supplied value multiplied by 1.39626348.}}

The the FoV angle/AoV is what determines the relative zoom level of the main game camera. Smaller angles generally equal to higher zoom levels, while larger angles equal to lower zoom levels (down to the theoretical x0 magnification).

However, too small of an angle will have a squashed look on the edges of your screen, and too high of an angle will greatly stretch edges. It is recommended to change the AoV, as FS2's default AoV has some perspective distortion at the screen edges (the default AoV is too high).

A natural looking (as if you where physically in the cockpit) AoV depends on the distance the player's actual eyes are away from the screen: the further away from the screen, the smaller the AoV should be, and vice versa. "Ergonomic" distances generally yield a '''''diagonal''''' AoV of 0.523 radians (30 degrees), but you can easily find the natural AoV by the following formula:

AoV (radians) = 2 * atan( H / ( 2*D ))

where:

Height of screen = H

Distance between head/eye and the screen = D

Generally, gamers like to increase the AoV in order to increase their peripheral vision on the screen, so as to gain a better situational awareness around their craft. An AoV of 0.39 radians seems to be a good start, but feel free to experiment and use whatever AoV you are most comfortable with.

===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 standalone 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 standalone 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 standalone game.

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

====-connect====
{{Sectstub}}
====-timeout====
{{Sectstub}}
====-cap_object_update====
Caps the maximum object update the server will respond to regardless of what the client has set. If the client is set to request high object updates but the server is capped to low, then that's all the client will get.

Takes one argument integer (0 to 3) which corresponds to the object update cap (With 0 being low and 3 being LAN).

===Help===
====-help====
Instructs FSO to print out all supported parameters. Some launchers can use these options to automatically populate the available command line options, even if the version of FSO is far newer than the launcher itself. NOTE: This option only works in Linux builds...

====--help====
See [[Command-Line_Reference#-help|-help]]

====-h====
See [[Command-Line_Reference#-help|-help]]

====-?====
See [[Command-Line_Reference#-help|-help]]

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

Command-Line Reference

2014-01-01T23:05:10Z

Echelon9: /* Troubleshooting */ Add a reference to the commandline option -use_gldrawelements, introduced in 3.6.14

Command-Line Flags (also called Command-Line Parameters) are optional flags passed to the FSO executable, and generally enables one or more features added to the FS2 Open engine. These flags are accessed conveniently through an [[FSO Launcher]]. To have FSO list all available flags, use any one of the following: [[Command-Line_Reference#-help|-help]], [[Command-Line_Reference#-help|--help]], [[Command-Line_Reference#-help|-h]], or [[Command-Line_Reference#-help|-?]].



===Graphics===
====-spec====
'''"Enable Specular"'''

Only polygons mapped with textures for which a shinemap exists will receive 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).
{{Table3615|
*This feature is on by default, use launcher option Disable Specular or if necessary to manually disable enter the flag -nospec}}

====-env====
'''"Enable Environment maps"'''

It only works if [[Command-Line_Reference#-spec|-spec]] is also set. Environment mapping intensity will be determined from the shine map too (see [[Texturing]] for more info). [[Installing FreeSpace 2 Open#Video setup|See Video setup.]]
{{Table3615|
*This feature is on by default, use launcher option Disable Environment Maps or if necessary to manually disable enter the flag -noenv }}

====-glow====
'''"Enable Glowmaps"'''

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)
{{Table3615|
*This feature is on by default, use launcher option Disable Glow Maps or if necessary to manually disable enter the flag -noglow }}

====-nomotiondebris====
'''"Disable motion debris"'''

====-noscalevid====
"Disable scale-to-window for Movies"

Disables fullscreen scaling of video clips.

====-missile_lighting====
'''"Apply Lighting to Missiles"'''

====-normal====
'''"Enable Normal Maps"'''

Normal maps require GLSL rendering, (see [[OpenGL_Shaders_(GLSL)|OpenGL Shaders (GLSL)]] for further info). It needs auxiliary normal maps (the same name of the base map plus "-normal"). DXT5_NM DDS format is needed. (Technical note: DXT5 will work, since only the GREEN and ALPHA channels are read by the current shader system. One direction of lines goes into the GREEN channel, the other direction goes into the ALPHA channel. RED and BLUE can be either base gray (#808080) or black. Usual practice is after creating the DXT5_NM, copy the RED channel to the ALPHA channel, black out the RED and BLUE an then save as either a DXT5 or u8888 (uncompressed) DDS file.)
{{Table3615|
*This feature is on by default, use launcher option Disable Normal Maps or if necessary to manually disable enter the flag -nonormal }}

====-post_process====
'''"Enable Post Processing"'''

enables the use (if present) of post-processing effects as defined by the post_process.tbl. Bloom usage has an additional cmdline option for setting it's value, most post processing effects are achieved in mission per the mission designer or can be enabled globally in the table.

====-soft_particles====
'''"Enable soft particles"'''

====-3dshockwave====
'''"Enable 3D Shockwaves"'''

This only has any effect when both a 2d and 3d shockwave effect are present, otherwise the only available effect is used.

====-fxaa====
'''"Enable FXAA antialiasing"'''

Enables the FXAA postprocessing stage. Further information can be found here: http://www.hard-light.net/forums/index.php?topic=76145.0

====-flightshaftsoff====
'''"Force Lightshafts off"'''

Disables Lightshafts even if a mission designer enables them via SEXP in a mission.

===Game Speed===
====-img2dds====
'''"Compress non-compressed images"'''

Converts all images to DDS (compressed) format. Decreases memory usage but potentially reduces image quality.

====-no_vsync====
'''"Disable vertical sync"'''

====-cache_bitmaps====
'''"Cache bitmaps between missions"'''

Will ideally reduce the load-time from one mission to another.

===HUD===
====-dualscanlines====
'''"Another Pair of Scanning Lines"'''

Adds a second pair of scanning lines to the target window when scanning an object.

====-targetinfo====
'''"Enable Info next to Target"'''

Displays target info, such as name and class, beside the targeted object.

====-orbradar====
'''"Enables 3D radar"'''

An Orb style 3D radar will replace the standard 2D version.

====-rearm_timer====
'''"Enable Rearm/Repair Completion Timer"'''

Displays time remaining until rearm and repair from a support ship is complete.

====-ballistic_gauge====
'''"Enable the analog Ballistic Ammo gauge"'''

Adds an ammo gauge to the HUD when armed with a ballistic weapon.

===Gameplay===
====-ship_choice_3d====
'''"Use Models for Ship Selection"'''

Uses ship models in ship selection window. It completely disables the standard ANI interface in this screen. 
Some mods need a compulsory use of this flag because they don't have available animations for their ships. In this situation, and if it is not used, the game will probably crash to desktop in the ship selection window.

====-weapon_choice_3d====
'''"Use Models for Weapon Selection"'''

Uses weapon models in weapon loadout window for secondary weapons (missiles and bombs). It completely disables the standard ANI interface in this screen. 
Some mods need a compulsory use of this flag because they don't have available animations for their secondary weapons. In this situation, and if it is not used, the game will probably crash to desktop in the weapon loadout window.

====-3dwarp====
'''"Enable 3D Warp"'''

Use full geometry for the subspace warp effect.

====-warp_flash====
'''"Enable Flash upon Warp"'''

Enable a flash at warp in and warp out.

====-no_ap_interrupt====
'''"Disable Interrupting of AutoPilot"'''

Tells the game to not allow players to interrupt an autopilot already-in-progress.

===Audio===
====-snd_preload====
'''"Preload mission game sounds"'''

Useful in preventing game stuttering when sounds are played for the first time.

====-nosound====
'''"Disable Sound and Music"'''

====-nomusic====
'''"Disables Music"'''

===Multiplayer===
====-standalone====
'''"Run as Stand Alone Server"'''

Creates a standalone multi-player server.

====-startgame====
'''"Skip Mainhall and Start Hosting"'''

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====
'''"Start Hosted Server as 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====
'''"Host Confirms Join requests"'''

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 Flight Deck option"'''

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

===Troubleshooting===
====-nohtl====
'''"Software Mode (very slow)"'''
{{Warning| Enabling this will significantly reduce performance.}}
Reverts to software rendering mode.

====-no_set_gamma====
'''"Disable Setting of Gamma"'''

Disables the gamma settings in the options screen.

====-nomovies====
'''"Disable Video Playback"'''

Disables all video playback.

====-noparseerrors====
'''"Disable Parsing Errors"'''

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.
*'''Note:''' the parameter was removed as of the July 5, 2011 nightly build.

====-query_speech====
'''"Does this build have Speech?"'''

Determines if the current build includes text-to-speech.

====-novbo====
'''"Disable OpenGL VBO"'''

====-noibx====
'''"Don't use cached index buffers (IBX)"'''

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"'''

====-disable_fbo====
'''"Disable OpenGL RenderTargets"'''

====-disable_pbo====
'''"Disable OpenGL Pixel Buffer Objects"'''

Disables the use of Pixel Buffer Objects (PBO) which may cause certain OpenGL operations to perform slower. Note PBO's were only used at three places in FSO anyway so it's *probably* not going to have a noticeable effect.

May be required to workaround issues in certain versions of Linux's Mesa drivers for Intel integrated graphics cards where crashes occur in the mainhall (i.e. whenever a popup occurs). Distros that seem to have this problem presently include Ubuntu 13.10 and openSUSE 13.1.
{{Table371|
*This feature is present to work around a bug in Linux's Mesa drivers for Intel integrated graphics cards}}

====-no_glsl====
'''"Disable GLSL (shader) Support"'''

Disables the use of GLSL rendering (OpenGL shaders). The game will revert to legacy fixed render pipeline. Please note that Normal and Height map effects will be unavailable.

====-disable_glsl_model====
'''"Don't use shaders for model rendering"'''

====-ati_swap====
'''"Fix Color issues on some ATI cards"'''

====-no_3d_sound====
'''"Use only 2D/stereo for sound effects"'''

====-disable_di_mouse====
'''"Disables the DirectInput mouse code for FSO on windows."'''

'''Windows Only''' Can make mouse movement smoother on certain machines.

====-mipmap====
'''"Enable mipmapping"'''

Causes for non-mipmapped textures to have mipmaps generated within the GPU on certain kind of texture formats, (IIRC, DDS formatted textures with a power of 2 size in both width and height). 
Since the use of already mipmapped DDS textures has become common, it has become deprecated.
The quality of the generated mipmaps depends on each GPU and used driver. It is normally used with [[Command-Line_Reference#-img2dds|-img2dds]] flag.

====-use_gldrawelements====
'''"Use glDrawElements instead of glDrawRangeElements"'''

Introduced as a means of switching to the slower OpenGL call glDrawElements, instead of glDrawRangeElements.
{{Table3614|
*This feature may resolve certain rendering problems where parts of models are not drawn on Linux drivers}}

===Experimental===
====-ingame_join====
'''"Allows Ingame Joining"'''

Enables ingame joining in multiplayer. FIXME: Host option?

====-voicer====
'''"Voice Recognition"'''

Windows-only. Enables voice-recognition for wingmen commands. Must be specifically compiled into a build in order for it to be available; 3.6.10 final includes the feature. See [[Voice Recognition]] for more details.

===Development Tools===
====-fps====
'''"Show frames per second on HUD"'''

Displays current frames per second.

====-pos====
'''"Show Position of Camera"'''

Displays current position coordinates of camera.

====-window====
'''"Run in Window"'''

Runs the game in a window. No check to make sure that resolution is no higher than your desktop resolution, so be careful.

====-fullscreen_window====
'''"Run in Fullscreen Window"'''

====-timerbar====
Displays a timing bar across the top of the screen. Timerbar format varies by build. This is a relic from the Volition development days, and is unmaintained.
*'''Note:''' the parameter was removed as of the July 5, 2011 nightly build.

====-stats====
'''"Show Statistics"'''

Shows total and free physical memory, virtual memory and system pagefile.

====-coords====
'''"Show Coordinates"'''

Shows coordinates of the mouse cursor.

====-show_mem_usage====
'''"Show Memory Usage"'''

Shows detailed RAM usage based on file, handler and process usage and display on the left-center side of the screen during mission load and while in mission.

The meaning of the info displayed in the upper right corner of the HUD 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 does 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====
Reads all objects in the pof file of the selected mod, and creates an ibx cache file for each object in the data/cache folder for that mod. 
Details for each object are output to a pofspew.txt file created in the data folder. 
Otherwise, ibx files are created in game before each mission.

====-tablecrcs====
Is actually now (or should be) a typed reference rather than as a selection item. Takes 1 argument, usually a descriptive name.
Example usage: "-table_crcs MediaVPs" will create a table_crcs.csv file in the running mod (name can be separate of the mod selected) that allows for the validation of the tables used by that mod while on-line. The descriptive parameter given helps "allocate" that .csv file to the mod in question, and as such should closely or exactly match that mods name if possible.

====-missioncrcs====
Is actually now (or should be) a typed reference rather than as a selection item. Takes 1 argument, usually a descriptive name.
Example usage: "-mission_crcs MediaVPs" will create a mission_crcs.csv file in the running mod (name can be separate of the mod selected) that allows for the validation of the missions used by that mod while on-line. The descriptive parameter given helps "allocate" that .csv file to the mod in question, and as such should closely or exactly match that mods name if possible.

====-dis_collisions====
'''"Disable Collisions"'''

Disables all collisions.

====-dis_weapons====
'''"Disable Weapon Rendering"'''

Disables weapons rendering.

====-output_sexps====
This will make the FSO build spit out an html file that documents the supported SEXP's.

Just double click on sexps.html and it should open in your default web browser.

====-output_scripting====
This will make the FSO build spit out an html file that documents the supported scripting hooks and LUA libraries.

Just double click on scripting.html and it should open in your default web browser.

====-nograb====
Unix only. Disables focus grabbing in a window.

====-save_render_target====
'''"Save Render Targets to file"'''

====-debug_window====
'''"Display Debug Window"'''

Lists the fs2_open.log in (nearly)real-time generation.

====-verify_vps====
'''"Spew VP crcs to vp_crcs.txt"'''

Exports the CRC values of the VP files being loaded into a vp_crcs.txt file.

====-reparse_mainhall====
'''"Reparse mainhall.tbl when loading halls"'''

Mainhall.tbl will be reparsed every time a mainhall is loaded, as opposed to just once at game startup.

====-start_mission====
'''"Skip the mainhall in jump right into the specified mission"'''

Jump into the mission specified by the filename. Only in effect on the first run. This will skip load of the mainhall and its other related things altogether.

====-profile_frame_time====
'''"Profile engine subsystems"'''

Activates the frame profiling code. This presents a readout showing the current, minimum, maximum and average percentages of frametime a given section of code has taken up; this can be used to identify particular bottlenecks or measure the effectiveness of certain optimizations.

==Other==
The following options are not available as checkboxes in the launcher. Many require parameters, which follow the flag separated by a space. The prototype for use in this case is "-option argument"

===Lighting===
These factors can dramatically alter the atmosphere of the game. [[Sample Lighting Settings|This page]] has some sample lighting settings with screenshots.

====-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.

====-no_emissive_light====
By default, all ships in FS2 have a light generated on their own, it is more or less similar to a minimal amount of -ambient_factor. This feature was implemented to help the player seeing the ships over a black background. This flag disables this feature. Use it with a low -ambient_factor value to obtain an ultra-realistic dark looking.

====-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. This is a relative value.

====-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. This is a relative value.

====-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. This is a relative value.

====-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. This is a relative value.

====-ogl_spec====
Takes a numerical argument. This value changes the basic shininess of the specular light in OpenGL. A lower value reduces the overall intensity of the light making it broader and less powerful. A higher value makes it more focused and brighter. The default value is 80, and the usable range is 0 to 128 (clamped). The original default value was 60, but it was raised to behave more D3D like.

===Graphics===
====-bloom_intensity====
Requires -post_processing ("Enable Post Processing") command.
Default value is 75. Range is 0-200.

====-height====
Enables height maps (parallax mapping). It only works if [[Command-Line_Reference#-normal|-normal]] is also set. It also needs GLSL rendering, (see [[OpenGL_Shaders_(GLSL)|OpenGL Shaders (GLSL)]] for further info). It needs auxiliary height maps (with the same name than base map plus "-height").
{{Table3615|
*This feature is on by default. To manually disable, enter the flag -noheight}}

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

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

====-res====
Allows you to specify a resolution if the desired one cannot be set in the Launcher.
For example, -res 1920x1080 would run the game in 1920 x 1080 resolution. Since it requires an argument, it needs to be entered as a custom flag when using the Launcher. The "Run at specified resolution" option the Launcher gives is essentially this, but without being able to actually specify a resolution, it doesn't work.

====-fxaa_preset====
Requires both -post_processing and -fxaa. Can be used to adjust the FXAA quality and speed, 0 is fastest, 9 is highest quality. Default setting is 6.

===Gameplay===
====-mod====
Specifies in which folders inside FreeSpace 2 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 behavior, 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/

This flag can be indirectly set, (and it is normally set), through Launcher MOD tab and [[mod.ini]] file.

Within the Launcher's MOD 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 it will be used to modify the -mod flag, too.

For further details, see '''[[mod.ini]]'''

'''Data precedence'''

As already said, within the different directories, the data precedence is set by the specified order in the -mod flag. The lowest priority goes to the Freespace2 installation directory.

Inside each directory, data precedence is the following:

#Individual files located in ''Current_dir/data/'' subdir structure. See [[FS2_Data_Structure|FS2 Data Structure topic]] for deeper info about the different folders and contents this structure has.
#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 that this ''Mission.fs2'' is also 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 enhanced ones adding them in a higher priority place.

'''Additional notes'''
# As derived from the 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.
# This flag is also used by [[Portal:FRED|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. A special build of wxLauncher is able to configure FRED so that the -mod doesn't have to be done manually see [http://www.hard-light.net/forums/index.php?topic=67950.msg1387911#msg1387911 the forum post] for more details.
{{Table3612|As of 3.6.12 FRED now loads cmdline_fso.cfg just like FS does so FRED will use the same settings as FS including the -mod settings}}
# 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.

{{Warning| '''Priority and Texture Formats'''

''Obsolete behavior - Until FS2_open v3.6.9.:''

FS2_Open can use several file formats in textures: [http://en.wikipedia.org/wiki/PCX PCX], [http://en.wikipedia.org/wiki/DirectDraw_Surface DDS], [http://en.wikipedia.org/wiki/JPG JPG] and [http://en.wikipedia.org/wiki/TGA TGA]. Make sure you keep the format when you update your texture. For example if you update the old ''TextureOfMyFighter.tga'', do not save it as ''TextureOfMyFighter.dds'' in a higher priority place, because there is a chance of the game loading the old one despite of all.

The reason to do this is that, loading process (including priorities) is applied firstly for a kind of textures (TGAs), then for another kind (JPGs), and so on. This behavior can lead to situation where your new, updated and higher priority placed texture is not read because the format of the older one.

''New behavior - From FS2_open v3.6.10. (including previous beta testing releases):''

The former issue has been fixed. Now texture format priority is only applied within the same location. In this ''strange'' situation it goes DDS -> TGA -> JPG -> PCX. Examples:
* ''/Freespace2/MyVp.vp>>>data/maps/MyTexture.dds'' is loaded instead of ''/Freespace2/MyVp.vp>>>data/maps/MyTexture.tga''.
* But your improved ''/Freespace2/data/maps/MyTexture.xxx'' will override them both despite of its format.
In this way, when you update any texture, you don't have to pay attention to its original format. Just place it in a higher priority place.

Nevertheless, global priority is kept between animated and static textures. Because of their management, animated textures (ANIs and EFFs) are looked for BEFORE static ones. In this way there's no way to update an animated texture with a static one (an obsolete ANI is always going to be loaded before the newer DDS version). The solution: use an updated EFF with just one frame.

}}

====-fov====
This flag allows the player to specify the ''vertical'' Field of View (FoV) angle, in radians, for the player eyepoint. The angle is measured across the full height of the viewing cone. The FoV angle is technically known as the Angle of View (AoV)

*Syntax: '''''float''''' Angle
*Valid Values: 0 to 2*Pi radians
*Default Value: 0.75 radians

{{Note|For peculiar reasons, the actual FoV/AoV used by the game will be the supplied value multiplied by 1.39626348.}}

The the FoV angle/AoV is what determines the relative zoom level of the main game camera. Smaller angles generally equal to higher zoom levels, while larger angles equal to lower zoom levels (down to the theoretical x0 magnification).

However, too small of an angle will have a squashed look on the edges of your screen, and too high of an angle will greatly stretch edges. It is recommended to change the AoV, as FS2's default AoV has some perspective distortion at the screen edges (the default AoV is too high).

A natural looking (as if you where physically in the cockpit) AoV depends on the distance the player's actual eyes are away from the screen: the further away from the screen, the smaller the AoV should be, and vice versa. "Ergonomic" distances generally yield a '''''diagonal''''' AoV of 0.523 radians (30 degrees), but you can easily find the natural AoV by the following formula:

AoV (radians) = 2 * atan( H / ( 2*D ))

where:

Height of screen = H

Distance between head/eye and the screen = D

Generally, gamers like to increase the AoV in order to increase their peripheral vision on the screen, so as to gain a better situational awareness around their craft. An AoV of 0.39 radians seems to be a good start, but feel free to experiment and use whatever AoV you are most comfortable with.

===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 standalone 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 standalone 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 standalone game.

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

====-connect====
{{Sectstub}}
====-timeout====
{{Sectstub}}
====-cap_object_update====
Caps the maximum object update the server will respond to regardless of what the client has set. If the client is set to request high object updates but the server is capped to low, then that's all the client will get.

Takes one argument integer (0 to 3) which corresponds to the object update cap (With 0 being low and 3 being LAN).

===Help===
====-help====
Instructs FSO to print out all supported parameters. Some launchers can use these options to automatically populate the available command line options, even if the version of FSO is far newer than the launcher itself. NOTE: This option only works in Linux builds...

====--help====
See [[Command-Line_Reference#-help|-help]]

====-h====
See [[Command-Line_Reference#-help|-help]]

====-?====
See [[Command-Line_Reference#-help|-help]]

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

Command-Line Reference

2014-01-01T22:19:02Z

Echelon9: /* -disable_pbo */ Further explain the specific Linux drivers with the bug, and flag as a 3.7.1 feature (currently in trunk and nightly builds only)

Command-Line Flags (also called Command-Line Parameters) are optional flags passed to the FSO executable, and generally enables one or more features added to the FS2 Open engine. These flags are accessed conveniently through an [[FSO Launcher]]. To have FSO list all available flags, use any one of the following: [[Command-Line_Reference#-help|-help]], [[Command-Line_Reference#-help|--help]], [[Command-Line_Reference#-help|-h]], or [[Command-Line_Reference#-help|-?]].



===Graphics===
====-spec====
'''"Enable Specular"'''

Only polygons mapped with textures for which a shinemap exists will receive 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).
{{Table3615|
*This feature is on by default, use launcher option Disable Specular or if necessary to manually disable enter the flag -nospec}}

====-env====
'''"Enable Environment maps"'''

It only works if [[Command-Line_Reference#-spec|-spec]] is also set. Environment mapping intensity will be determined from the shine map too (see [[Texturing]] for more info). [[Installing FreeSpace 2 Open#Video setup|See Video setup.]]
{{Table3615|
*This feature is on by default, use launcher option Disable Environment Maps or if necessary to manually disable enter the flag -noenv }}

====-glow====
'''"Enable Glowmaps"'''

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)
{{Table3615|
*This feature is on by default, use launcher option Disable Glow Maps or if necessary to manually disable enter the flag -noglow }}

====-nomotiondebris====
'''"Disable motion debris"'''

====-noscalevid====
"Disable scale-to-window for Movies"

Disables fullscreen scaling of video clips.

====-missile_lighting====
'''"Apply Lighting to Missiles"'''

====-normal====
'''"Enable Normal Maps"'''

Normal maps require GLSL rendering, (see [[OpenGL_Shaders_(GLSL)|OpenGL Shaders (GLSL)]] for further info). It needs auxiliary normal maps (the same name of the base map plus "-normal"). DXT5_NM DDS format is needed. (Technical note: DXT5 will work, since only the GREEN and ALPHA channels are read by the current shader system. One direction of lines goes into the GREEN channel, the other direction goes into the ALPHA channel. RED and BLUE can be either base gray (#808080) or black. Usual practice is after creating the DXT5_NM, copy the RED channel to the ALPHA channel, black out the RED and BLUE an then save as either a DXT5 or u8888 (uncompressed) DDS file.)
{{Table3615|
*This feature is on by default, use launcher option Disable Normal Maps or if necessary to manually disable enter the flag -nonormal }}

====-post_process====
'''"Enable Post Processing"'''

enables the use (if present) of post-processing effects as defined by the post_process.tbl. Bloom usage has an additional cmdline option for setting it's value, most post processing effects are achieved in mission per the mission designer or can be enabled globally in the table.

====-soft_particles====
'''"Enable soft particles"'''

====-3dshockwave====
'''"Enable 3D Shockwaves"'''

This only has any effect when both a 2d and 3d shockwave effect are present, otherwise the only available effect is used.

====-fxaa====
'''"Enable FXAA antialiasing"'''

Enables the FXAA postprocessing stage. Further information can be found here: http://www.hard-light.net/forums/index.php?topic=76145.0

====-flightshaftsoff====
'''"Force Lightshafts off"'''

Disables Lightshafts even if a mission designer enables them via SEXP in a mission.

===Game Speed===
====-img2dds====
'''"Compress non-compressed images"'''

Converts all images to DDS (compressed) format. Decreases memory usage but potentially reduces image quality.

====-no_vsync====
'''"Disable vertical sync"'''

====-cache_bitmaps====
'''"Cache bitmaps between missions"'''

Will ideally reduce the load-time from one mission to another.

===HUD===
====-dualscanlines====
'''"Another Pair of Scanning Lines"'''

Adds a second pair of scanning lines to the target window when scanning an object.

====-targetinfo====
'''"Enable Info next to Target"'''

Displays target info, such as name and class, beside the targeted object.

====-orbradar====
'''"Enables 3D radar"'''

An Orb style 3D radar will replace the standard 2D version.

====-rearm_timer====
'''"Enable Rearm/Repair Completion Timer"'''

Displays time remaining until rearm and repair from a support ship is complete.

====-ballistic_gauge====
'''"Enable the analog Ballistic Ammo gauge"'''

Adds an ammo gauge to the HUD when armed with a ballistic weapon.

===Gameplay===
====-ship_choice_3d====
'''"Use Models for Ship Selection"'''

Uses ship models in ship selection window. It completely disables the standard ANI interface in this screen. 
Some mods need a compulsory use of this flag because they don't have available animations for their ships. In this situation, and if it is not used, the game will probably crash to desktop in the ship selection window.

====-weapon_choice_3d====
'''"Use Models for Weapon Selection"'''

Uses weapon models in weapon loadout window for secondary weapons (missiles and bombs). It completely disables the standard ANI interface in this screen. 
Some mods need a compulsory use of this flag because they don't have available animations for their secondary weapons. In this situation, and if it is not used, the game will probably crash to desktop in the weapon loadout window.

====-3dwarp====
'''"Enable 3D Warp"'''

Use full geometry for the subspace warp effect.

====-warp_flash====
'''"Enable Flash upon Warp"'''

Enable a flash at warp in and warp out.

====-no_ap_interrupt====
'''"Disable Interrupting of AutoPilot"'''

Tells the game to not allow players to interrupt an autopilot already-in-progress.

===Audio===
====-snd_preload====
'''"Preload mission game sounds"'''

Useful in preventing game stuttering when sounds are played for the first time.

====-nosound====
'''"Disable Sound and Music"'''

====-nomusic====
'''"Disables Music"'''

===Multiplayer===
====-standalone====
'''"Run as Stand Alone Server"'''

Creates a standalone multi-player server.

====-startgame====
'''"Skip Mainhall and Start Hosting"'''

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====
'''"Start Hosted Server as 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====
'''"Host Confirms Join requests"'''

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 Flight Deck option"'''

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

===Troubleshooting===
====-nohtl====
'''"Software Mode (very slow)"'''
{{Warning| Enabling this will significantly reduce performance.}}
Reverts to software rendering mode.

====-no_set_gamma====
'''"Disable Setting of Gamma"'''

Disables the gamma settings in the options screen.

====-nomovies====
'''"Disable Video Playback"'''

Disables all video playback.

====-noparseerrors====
'''"Disable Parsing Errors"'''

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.
*'''Note:''' the parameter was removed as of the July 5, 2011 nightly build.

====-query_speech====
'''"Does this build have Speech?"'''

Determines if the current build includes text-to-speech.

====-novbo====
'''"Disable OpenGL VBO"'''

====-noibx====
'''"Don't use cached index buffers (IBX)"'''

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"'''

====-disable_fbo====
'''"Disable OpenGL RenderTargets"'''

====-disable_pbo====
'''"Disable OpenGL Pixel Buffer Objects"'''

Disables the use of Pixel Buffer Objects (PBO) which may cause certain OpenGL operations to perform slower. Note PBO's were only used at three places in FSO anyway so it's *probably* not going to have a noticeable effect.

May be required to workaround issues in certain versions of Linux's Mesa drivers for Intel integrated graphics cards where crashes occur in the mainhall (i.e. whenever a popup occurs). Distros that seem to have this problem presently include Ubuntu 13.10 and openSUSE 13.1.
{{Table371|
*This feature is present to work around a bug in Linux's Mesa drivers for Intel integrated graphics cards}}

====-no_glsl====
'''"Disable GLSL (shader) Support"'''

Disables the use of GLSL rendering (OpenGL shaders). The game will revert to legacy fixed render pipeline. Please note that Normal and Height map effects will be unavailable.

====-disable_glsl_model====
'''"Don't use shaders for model rendering"'''

====-ati_swap====
'''"Fix Color issues on some ATI cards"'''

====-no_3d_sound====
'''"Use only 2D/stereo for sound effects"'''

====-disable_di_mouse====
'''"Disables the DirectInput mouse code for FSO on windows."'''

'''Windows Only''' Can make mouse movement smoother on certain machines.

====-mipmap====
'''"Enable mipmapping"'''

Causes for non-mipmapped textures to have mipmaps generated within the GPU on certain kind of texture formats, (IIRC, DDS formatted textures with a power of 2 size in both width and height). 
Since the use of already mipmapped DDS textures has become common, it has become deprecated.
The quality of the generated mipmaps depends on each GPU and used driver. It is normally used with [[Command-Line_Reference#-img2dds|-img2dds]] flag.

===Experimental===
====-ingame_join====
'''"Allows Ingame Joining"'''

Enables ingame joining in multiplayer. FIXME: Host option?

====-voicer====
'''"Voice Recognition"'''

Windows-only. Enables voice-recognition for wingmen commands. Must be specifically compiled into a build in order for it to be available; 3.6.10 final includes the feature. See [[Voice Recognition]] for more details.

===Development Tools===
====-fps====
'''"Show frames per second on HUD"'''

Displays current frames per second.

====-pos====
'''"Show Position of Camera"'''

Displays current position coordinates of camera.

====-window====
'''"Run in Window"'''

Runs the game in a window. No check to make sure that resolution is no higher than your desktop resolution, so be careful.

====-fullscreen_window====
'''"Run in Fullscreen Window"'''

====-timerbar====
Displays a timing bar across the top of the screen. Timerbar format varies by build. This is a relic from the Volition development days, and is unmaintained.
*'''Note:''' the parameter was removed as of the July 5, 2011 nightly build.

====-stats====
'''"Show Statistics"'''

Shows total and free physical memory, virtual memory and system pagefile.

====-coords====
'''"Show Coordinates"'''

Shows coordinates of the mouse cursor.

====-show_mem_usage====
'''"Show Memory Usage"'''

Shows detailed RAM usage based on file, handler and process usage and display on the left-center side of the screen during mission load and while in mission.

The meaning of the info displayed in the upper right corner of the HUD 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 does 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====
Reads all objects in the pof file of the selected mod, and creates an ibx cache file for each object in the data/cache folder for that mod. 
Details for each object are output to a pofspew.txt file created in the data folder. 
Otherwise, ibx files are created in game before each mission.

====-tablecrcs====
Is actually now (or should be) a typed reference rather than as a selection item. Takes 1 argument, usually a descriptive name.
Example usage: "-table_crcs MediaVPs" will create a table_crcs.csv file in the running mod (name can be separate of the mod selected) that allows for the validation of the tables used by that mod while on-line. The descriptive parameter given helps "allocate" that .csv file to the mod in question, and as such should closely or exactly match that mods name if possible.

====-missioncrcs====
Is actually now (or should be) a typed reference rather than as a selection item. Takes 1 argument, usually a descriptive name.
Example usage: "-mission_crcs MediaVPs" will create a mission_crcs.csv file in the running mod (name can be separate of the mod selected) that allows for the validation of the missions used by that mod while on-line. The descriptive parameter given helps "allocate" that .csv file to the mod in question, and as such should closely or exactly match that mods name if possible.

====-dis_collisions====
'''"Disable Collisions"'''

Disables all collisions.

====-dis_weapons====
'''"Disable Weapon Rendering"'''

Disables weapons rendering.

====-output_sexps====
This will make the FSO build spit out an html file that documents the supported SEXP's.

Just double click on sexps.html and it should open in your default web browser.

====-output_scripting====
This will make the FSO build spit out an html file that documents the supported scripting hooks and LUA libraries.

Just double click on scripting.html and it should open in your default web browser.

====-nograb====
Unix only. Disables focus grabbing in a window.

====-save_render_target====
'''"Save Render Targets to file"'''

====-debug_window====
'''"Display Debug Window"'''

Lists the fs2_open.log in (nearly)real-time generation.

====-verify_vps====
'''"Spew VP crcs to vp_crcs.txt"'''

Exports the CRC values of the VP files being loaded into a vp_crcs.txt file.

====-reparse_mainhall====
'''"Reparse mainhall.tbl when loading halls"'''

Mainhall.tbl will be reparsed every time a mainhall is loaded, as opposed to just once at game startup.

====-start_mission====
'''"Skip the mainhall in jump right into the specified mission"'''

Jump into the mission specified by the filename. Only in effect on the first run. This will skip load of the mainhall and its other related things altogether.

====-profile_frame_time====
'''"Profile engine subsystems"'''

Activates the frame profiling code. This presents a readout showing the current, minimum, maximum and average percentages of frametime a given section of code has taken up; this can be used to identify particular bottlenecks or measure the effectiveness of certain optimizations.

==Other==
The following options are not available as checkboxes in the launcher. Many require parameters, which follow the flag separated by a space. The prototype for use in this case is "-option argument"

===Lighting===
These factors can dramatically alter the atmosphere of the game. [[Sample Lighting Settings|This page]] has some sample lighting settings with screenshots.

====-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.

====-no_emissive_light====
By default, all ships in FS2 have a light generated on their own, it is more or less similar to a minimal amount of -ambient_factor. This feature was implemented to help the player seeing the ships over a black background. This flag disables this feature. Use it with a low -ambient_factor value to obtain an ultra-realistic dark looking.

====-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. This is a relative value.

====-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. This is a relative value.

====-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. This is a relative value.

====-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. This is a relative value.

====-ogl_spec====
Takes a numerical argument. This value changes the basic shininess of the specular light in OpenGL. A lower value reduces the overall intensity of the light making it broader and less powerful. A higher value makes it more focused and brighter. The default value is 80, and the usable range is 0 to 128 (clamped). The original default value was 60, but it was raised to behave more D3D like.

===Graphics===
====-bloom_intensity====
Requires -post_processing ("Enable Post Processing") command.
Default value is 75. Range is 0-200.

====-height====
Enables height maps (parallax mapping). It only works if [[Command-Line_Reference#-normal|-normal]] is also set. It also needs GLSL rendering, (see [[OpenGL_Shaders_(GLSL)|OpenGL Shaders (GLSL)]] for further info). It needs auxiliary height maps (with the same name than base map plus "-height").
{{Table3615|
*This feature is on by default. To manually disable, enter the flag -noheight}}

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

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

====-res====
Allows you to specify a resolution if the desired one cannot be set in the Launcher.
For example, -res 1920x1080 would run the game in 1920 x 1080 resolution. Since it requires an argument, it needs to be entered as a custom flag when using the Launcher. The "Run at specified resolution" option the Launcher gives is essentially this, but without being able to actually specify a resolution, it doesn't work.

====-fxaa_preset====
Requires both -post_processing and -fxaa. Can be used to adjust the FXAA quality and speed, 0 is fastest, 9 is highest quality. Default setting is 6.

===Gameplay===
====-mod====
Specifies in which folders inside FreeSpace 2 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 behavior, 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/

This flag can be indirectly set, (and it is normally set), through Launcher MOD tab and [[mod.ini]] file.

Within the Launcher's MOD 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 it will be used to modify the -mod flag, too.

For further details, see '''[[mod.ini]]'''

'''Data precedence'''

As already said, within the different directories, the data precedence is set by the specified order in the -mod flag. The lowest priority goes to the Freespace2 installation directory.

Inside each directory, data precedence is the following:

#Individual files located in ''Current_dir/data/'' subdir structure. See [[FS2_Data_Structure|FS2 Data Structure topic]] for deeper info about the different folders and contents this structure has.
#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 that this ''Mission.fs2'' is also 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 enhanced ones adding them in a higher priority place.

'''Additional notes'''
# As derived from the 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.
# This flag is also used by [[Portal:FRED|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. A special build of wxLauncher is able to configure FRED so that the -mod doesn't have to be done manually see [http://www.hard-light.net/forums/index.php?topic=67950.msg1387911#msg1387911 the forum post] for more details.
{{Table3612|As of 3.6.12 FRED now loads cmdline_fso.cfg just like FS does so FRED will use the same settings as FS including the -mod settings}}
# 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.

{{Warning| '''Priority and Texture Formats'''

''Obsolete behavior - Until FS2_open v3.6.9.:''

FS2_Open can use several file formats in textures: [http://en.wikipedia.org/wiki/PCX PCX], [http://en.wikipedia.org/wiki/DirectDraw_Surface DDS], [http://en.wikipedia.org/wiki/JPG JPG] and [http://en.wikipedia.org/wiki/TGA TGA]. Make sure you keep the format when you update your texture. For example if you update the old ''TextureOfMyFighter.tga'', do not save it as ''TextureOfMyFighter.dds'' in a higher priority place, because there is a chance of the game loading the old one despite of all.

The reason to do this is that, loading process (including priorities) is applied firstly for a kind of textures (TGAs), then for another kind (JPGs), and so on. This behavior can lead to situation where your new, updated and higher priority placed texture is not read because the format of the older one.

''New behavior - From FS2_open v3.6.10. (including previous beta testing releases):''

The former issue has been fixed. Now texture format priority is only applied within the same location. In this ''strange'' situation it goes DDS -> TGA -> JPG -> PCX. Examples:
* ''/Freespace2/MyVp.vp>>>data/maps/MyTexture.dds'' is loaded instead of ''/Freespace2/MyVp.vp>>>data/maps/MyTexture.tga''.
* But your improved ''/Freespace2/data/maps/MyTexture.xxx'' will override them both despite of its format.
In this way, when you update any texture, you don't have to pay attention to its original format. Just place it in a higher priority place.

Nevertheless, global priority is kept between animated and static textures. Because of their management, animated textures (ANIs and EFFs) are looked for BEFORE static ones. In this way there's no way to update an animated texture with a static one (an obsolete ANI is always going to be loaded before the newer DDS version). The solution: use an updated EFF with just one frame.

}}

====-fov====
This flag allows the player to specify the ''vertical'' Field of View (FoV) angle, in radians, for the player eyepoint. The angle is measured across the full height of the viewing cone. The FoV angle is technically known as the Angle of View (AoV)

*Syntax: '''''float''''' Angle
*Valid Values: 0 to 2*Pi radians
*Default Value: 0.75 radians

{{Note|For peculiar reasons, the actual FoV/AoV used by the game will be the supplied value multiplied by 1.39626348.}}

The the FoV angle/AoV is what determines the relative zoom level of the main game camera. Smaller angles generally equal to higher zoom levels, while larger angles equal to lower zoom levels (down to the theoretical x0 magnification).

However, too small of an angle will have a squashed look on the edges of your screen, and too high of an angle will greatly stretch edges. It is recommended to change the AoV, as FS2's default AoV has some perspective distortion at the screen edges (the default AoV is too high).

A natural looking (as if you where physically in the cockpit) AoV depends on the distance the player's actual eyes are away from the screen: the further away from the screen, the smaller the AoV should be, and vice versa. "Ergonomic" distances generally yield a '''''diagonal''''' AoV of 0.523 radians (30 degrees), but you can easily find the natural AoV by the following formula:

AoV (radians) = 2 * atan( H / ( 2*D ))

where:

Height of screen = H

Distance between head/eye and the screen = D

Generally, gamers like to increase the AoV in order to increase their peripheral vision on the screen, so as to gain a better situational awareness around their craft. An AoV of 0.39 radians seems to be a good start, but feel free to experiment and use whatever AoV you are most comfortable with.

===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 standalone 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 standalone 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 standalone game.

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

====-connect====
{{Sectstub}}
====-timeout====
{{Sectstub}}
====-cap_object_update====
Caps the maximum object update the server will respond to regardless of what the client has set. If the client is set to request high object updates but the server is capped to low, then that's all the client will get.

Takes one argument integer (0 to 3) which corresponds to the object update cap (With 0 being low and 3 being LAN).

===Help===
====-help====
Instructs FSO to print out all supported parameters. Some launchers can use these options to automatically populate the available command line options, even if the version of FSO is far newer than the launcher itself. NOTE: This option only works in Linux builds...

====--help====
See [[Command-Line_Reference#-help|-help]]

====-h====
See [[Command-Line_Reference#-help|-help]]

====-?====
See [[Command-Line_Reference#-help|-help]]

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

Portal:Multiplayer

2013-12-05T10:31:46Z

Echelon9:

{| border=0 align=center cellpadding=4 cellspacing=0 width=95% style="margin: 0 0 1em 1em; background: #202020; border: 1px #AA2020 solid; border-collapse: collapse; font-size: 95%;"
! style="color: white; height: 30px; background: #512020; 70%;"|'''The FreeSpace Multiplayer Portal'''
|}

{| border=0 align=right cellpadding=4 cellspacing=0 width=20% style="margin: 0 0 1em 1em; background: #302020; border: 1px #AA2020 solid; border-collapse: collapse; font-size: 95%;"
! style="color: white; height: 30px; background: #512020; 70%;"|'''''Technical'''''
|-
! style="color: white; height: 30px; 70%;"|[[Multiplayer Getting Started Guide|Getting Started Guide]]
|-
! style="color: white; height: 30px; 70%;"|[[List of FS2NetD-Supported Mods]]
|-
! style="color: white; height: 30px; 70%;"|[[Troubleshooting#Multiplayer|Troubleshooting]]
|-
! style="color: white; height: 30px; 70%;"|[[Multiplayer FAQ]]
|-
! style="color: white; height: 30px; 70%;"|[[FS2_WebUI_Standalone|WebUI Standalone Servers]]
|-
! style="color: white; height: 30px; background: #512020; 70%;"|'''''Gameplay'''''
|-
! style="color: white; height: 30px; 70%;"|[[Multiplayer Medals and Awards|Medals & Awards]]
|-
! style="color: white; height: 30px; background: #512020; 70%;"|'''''Community'''''
|-
! style="color: white; height: 30px; 70%;"|[[:Category:Multiplayer Squadrons|Multiplayer Squadrons]]
|-
! style="color: white; height: 30px; 70%;"|[[Playing tips (multiplayer)|Playing Tips]]
|-
! style="color: white; height: 30px; 70%;"|[[Multiplayer code of conduct|Code of Conduct]]
|-
! style="color: white; height: 30px; 70%;"|[[Multiplayer lingo]]
|-
|}

Welcome to the FreeSpace Multiplayer Portal. This section is dedicated to providing guides on how to set up, play, host, and enjoy multiplayer games, as well as useful information about the multiplayer community such as squadrons, codes of conduct, and the like.

===FreeSpace Multiplayer===
[[Image:Create_game_screen.JPG|left|300px|thumb|Create Game Screen]]
Currently, the [[FreeSpace Open]] engine supports multiplayer games with up to 12 human participants as well as any number of AI players. Play can be both cooperative and head-to-head, and can consist of anything from single mission slugfests up to full-length cooperative campaigns.

All games are currently hosted by one of their participants. The host chooses the mission (''see image to the left''), and has the power to kick players, set privileges, and the like.

The retail release of FreeSpace 2 in 1999 included a standalone server option which was later broken by various changes made by the SCP. Recently, a lot of work has been done to correct this, and on current builds the standalone server '''will work''' when run with retail data. Work is still progressing on making it compatible with the new data formats introduced by the Source Code Project.

===Connection Types===
There are two ways of playing online games using FSO. You can also play the game on LAN.:
*Connecting through [[FS2NetD]]. FS2NetD is a replacement for the Parallax Online service that has now been terminated. It acts as a lobby for multiplayer games, tracking servers and facilitating connections without users needing to worry about each other's IP addresses, and also tracks stats for games that are played using validated data and missions. It does not actually host the games that are played, acting merely as a middle man.

*Direct IP connection. It is also possible to play IP games, but doing this requires all participants to manually enter the IP of the server that hosts the game.

Details of setting up FSO to use either of these two options are explained in the getting started guide.

*LAN To play on LAN, you'll have to change a few settings. Go into your ../Freespace 2/data/multi.cfg file and remove everything (back up the old file somewhere). Then add the following line: +lan_update

Now save the file. In the FS2 Launcher (Launcher 5.5 or WxLauncher), set the multiplayer connection to LAN and leave the Force IP and Force Port fields blank. You can enable "Allow in-game joining" in the Features/Experimental tab. Run Freespace 2.

In Freespace 2, create a multiplayer pilot. Then go into Options and select the Multi tab. Enable TCP, and /Multidata. Disable PXO. Do not set any IPs. Apply the changes. Go back to lobby and click on Create Game and set up a new server. Make sure the firewall on your LAN is not blocking the connection to your LAN server.

===MODs and Custom Missions===
It is possible to use mods and play custom missions using FSO. Mods will need to be distributed to all participating players in advance, but missions will be automatically distributed if any participants are missing them.

When playing on FS2NetD, note that while mods and custom missions are allowed, stats will not be saved for games that use them. ''Only'' games using validated missions and data are counted. For IP games (where stats are not saved anyway) there are no such considerations.

===Validated Missions===
A package containing all currently validated multiplayer missions for FreeSpace 2 is available from the downloads section below. A voice pack for those missions is also available. To use them, the best way is to place them in a separate directory and select that as a mod from the launcher.

Do not place them in the [[mediaVP]]s directory if you intend to play for stats, as the current mediaVPs are not validated.
==External Links==
*[http://www.game-warden.com/forum/showthread.php?t=267 GameWarden Multiplayer FAQ & Getting started guide]
*[http://fs2netd.game-warden.com/ FS2NetD Website - Player stats & Information about current games]
*[http://www.hard-light.net/forums/index.php/board,135.0.html HLP Multiplayer Forum]
==Downloads==
*[http://www.fszmirror.com/files/multi-mission-pack.vp Validated missions package for FreeSpace 2]
*[http://www.fszmirror.com/files/multi-voice-pack.vp Voice package for the validated missions]
__NOTOC__
[[Category:Multiplayer]]

Development Reference

2013-12-05T10:21:25Z

Echelon9: Include link to Doxygen Documentation guide

* [[Getting the FreeSpace2: SCP Source Code|Getting the Source Code]]
* [[Sourcecode Reference]]
* [[Doxygen Documentation]]
* [[Scripting API]]
* [[FS2_Open Lua Scripting]]
* [[OpenGL Shaders (GLSL)]]
* [[Deprecation|List of deprecated game features (WIP)]]

===wxFRED2 WIP===

* [[wxfred2Contributions|Contributing]]

===External Links===
[http://scp.indiegames.us/ SCP Developers' Page]

[[Category:Source Code Project]]

FS2 WebUI Standalone

2013-12-05T09:52:24Z

Echelon9: /* Sample multi.cfg */

The WebUI standalone was created by SCP member Eli2 to enable *nix machines to run a standalone FS2 server.

==How to Use==

Just add the -standalone command line option to your startup script, or run the game with the Standalone option enabled from wxLauncher, etc. I highly recommend avoiding wxLauncher for the time being, as it isn't really aware of the *nix standalone and I don't think it can open a monitoring terminal window for you.

==Configuration==

The following items are specific to the *nix <fs2_local_data_folder>/data/multi.cfg file, where the local data folder is likely ~/Library/FS2_Open/ for OS X or ~/.fs2_open/ for other *nix platforms. The rest of the file should work like a normal Windows standalone. An example file can be found at the bottom of the page.

===+webui_root===
*Set this value to wherever you have placed the webui document root. You can grab it by downloading and extracting the [https://github.com/scp-fs2open/fs2open_webui/archive/master.zip master branch archive] from Github, or by cloning the [https://github.com/scp-fs2open/fs2open_webui Github Webui repository], in the directory you would like to store the WebUI pages. So if you run extract or clone the repo in your home folder, your setting might look something like:
<pre>+webui_root /home/username/fs2open_webui</pre>

===+webapi_username===
Username for accessing the WebUI administration page.

===+webapi_password===
Password for accessing the WebUI administration page.

===+webapi_server_port===
Set to change the WebUI server to be running on a different port than the default 8080.

===+use_pxo===
For FS2NetD connectivity, you will also need to define +use_pxo, as you probably don't have the ability to run the GUI and turn on the PXO checkbox in the game when running the standalone on a headless server.

==Connecting==

The WebUI currently listens on port 8080 by default, using unencrypted HTTP. The default user and pass for administration is admin:admin. It is highly recommended to change these default settings in your multi.cfg file. To secure this, the current recommendation is to run the server behind a firewall and access it via an SSH tunnel or VPN. Since most *nix machines are themselves accessible via SSH, I will describe the basics needed to set up an SSH tunnel as pertains to this standalone.

===From Windows===
[http://howto.ccs.neu.edu/howto/windows/ssh-port-tunneling-with-putty/ This page] has almost the exact directions you will need to set up a tunnel from Windows to your standalone server. The two things you need to know on the SSH tunnel tab are the ip/hostname of the computer running the standalone, that will resolve on the ssh server (if you SSH into a different machine on the network than the one running the standalone), and the port number on that machine will be 8080. You can set the Source Port to whatever you like, I will use a different port for clarity (8081). So if the SSH server computer can access your standalone server on its network via the hostname 'standalone', your destination line will be standalone:8080. If you use 8081 for your client port as well, the final entry in the forwarded ports list will look like:
<pre>L8081 standalone:8080</pre>

===From CLI SSH on Linux/OSX/etc===
You'll need to open a terminal window, and know the normal SSH command you use to access the SSH server on the network where the standalone is running. Let's say you SSH into myip.dyndns.com, on the default port 22. Your username on the ssh server is 'me'. The standalone is running on another machine on the same network as the SSH server, named standalone. The standalone runs on port 8080. You want to be able to access the WebUI in your browser on port 8081. You need to add the -L parameter to your ssh command to resemble the following:
<pre>ssh -L 8081:standalone:8080 me@myip.dyndns.com</pre>

===Connect to the WebUI===
Now that the SSH tunnel is set up in Putty or your shell, you can just open your browser and point it to [http://localhost:8081/ http://localhost:8081/]. Then you can log in with the credentials (default admin:admin unless set otherwise in multi.cfg) and access the interface.

==WebUI Interface==

Below is a description of the tabs in the WebUI interface.

===Server===
This tab displays the server's current configuration, and allows you to set various options.

===Mission===
Information about the currently running mission on the server.

===Chat===
You can send chat messages directly to participants on the standalone, and see the messages from the players to all recipients.

===Debug===
This contains debugging output information from the server. If things go wrong, please include this information as well as your fs2_standalone.log (found in same location as fs2_open.log) if using a Debug build in any bug reports.

==Known Issues==

This server is still in beta stage. So far, the current issues still exist:

*No SSL to protect your authentication password, which is why the SSH tunnel is currently recommended, as that essentially solves the issue for the time being.
*Servers (whether WebUI standalone or otherwise) do not feature NAT punchthrough, as much of the traffic is UDP traffic. This means the standalone host must be on a public facing IP address, or you must set up port forwarding using standard FreeSpace 2 Open ports. For those on cable or ADSL modem connections, the "DMZ" feature of your modem/router will achieve the equivalent outcome.

==Sample multi.cfg for WebUI standalone server==

<pre>
+name WebUI Test
+no_voice
+datarate 1000000000
+high_update
+max_players 12
+use_pxo
+pxo #Eleh
+pxo_login chief_standalone
+pxo_password [Insert Password]
+webui_root /home/chief1983/fs2open_webui
+webapi_username [Insert Username]
+webapi_password [Insert Password]
+webapi_server_port 8080
</pre>