Difference between revisions of "Command-Line Reference"

From FreeSpace Wiki
Jump to: navigation, search
(-stats)
(-show_mem_usage)
Line 172: Line 172:
 
Shows coordinates of the mouse cursor.
 
Shows coordinates of the mouse cursor.
 
====-show_mem_usage====
 
====-show_mem_usage====
Shows detailed System and Video RAM usage in HUD.
+
Shows detailed RAM usage in HUD.
 +
 
 +
The meaning of the info displayed in the upper right corner is:
 +
 
 +
'''DYN''' = dynamic memory, basically anything that's been allocated by the vm_* memory functions.  This does NOT indicate total memory usage but does account for most of it.
 +
 
 +
'''POF''' = model memory, how much memory is being used by models (does not include textures)
 +
 
 +
'''C-BMP, BMP''' = bmpman memory, how much is used by the textures/images that are loaded.  C-BMP means that you are using -cache_bitmaps and it will try to keep textures in memory between level loads and as the new level is loading it will keep what it needs and unload what it doesn't.  Can greatly increase level loading speed, but does so at the cost of memory between level loads.  This does not increase overall memory usage though, only during the loading screen.  BMP means that it is not cached and all textures are unloaded from memory at the start of level load and all needed textures are then loaded from the disk again.
 +
 
 +
'''S-RAM''' = sound memory, how much is used by the sounds loaded in memory at the time.  This counts static sounds only (from sounds.tbl, etc.) and not streaming sounds (music, voices, briefing stuff, etc).
 +
 
 +
'''V-RAM''' = approximate memory usage of video textures.  This is not mean that your card has this much memory and can report higher numbers that your card actually has memory.  For OpenGL it also includes some of the geometry data, but this number does not reflect the total memory that your video card is using.  It only reports how much data the game has purposefully loaded into API memory (meaning it could be in system memory, video card memory, or AGP memory).
 +
 
  
 
''(It only works with debug builds, not with release builds).''
 
''(It only works with debug builds, not with release builds).''

Revision as of 18:56, 28 January 2006

Contents

Launcher Flags

The following command-line options can be chosen from the launcher.

Graphics

-spec

Enables specular mapping. Only polygons mapped with textures for which a shinemap exists will recieve specular mapping; no attempt is made to generate spec maps where they do not exist. Specular maps are specified with the base map name plus "-shine" (i.e. TCov3A-shine.pcx).

-glow

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

-jpgtga

Enables the use of TGA and JPG file formats for image files. If a ship is showing up partially invisible, select this option.

-pcx32

WARNING - HIGH MEMORY USAGE

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

-cell

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

-mipmap

Enables mipmapping.

-nomotiondebris

Disables motion debris.

-2d_poof

Applies nebula poofs in 2d, effectively preventing them from forming intersections with ships.

-noscalevid

Disables scaling of video clips.

-cache_bitmaps

Caches bitmaps between missions, which will ideally reduce the load-time from one mission to another.

-missile_lighting

Applys lighting to missiles.

-rlm

Obsolete Argument

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


Game Speed

-img2dds

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

-no_vsync

Disables vertical sync.


HUD

-dualscanlines

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

-targetinfo

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

-orbradar

Enables 3D radar (the Orb). 3D radar will replace the standard 2D version.

-ballistic_gauge

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

-rearm_timer

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


Gameplay

-nobeampierce

Causes beams to hit (and damage) shields before they impact a ship's hull. This is a global flag, but this behavior can also be modified in weapons.tbl.

-smart_shields

Enables "smart" shield recharging. Shield recharge is distributed to the most damaged shield quadrant instead of being distributed equally across the entire shield and be wasted when a quadrant is full.

-ship_choice_3d

Use ship and weapon models in ship selection and weapon loadout. Completely disables the standard ANI interface on those screens.

-3dwarp

Use full geometry for the subspace warp effect.

-warp_flash

Enable a flash at warp in and warp out.

-UseNewAI

Tells the game to use new AI routines. This argument alters mission balance and is not considered a standard feature.

-tbp

Enable feature set for The Babylon Project

-wcsaga

Enable feature set for The Wing Commander Saga


Audio

-snd_preload

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

-nosound

Disables all sounds.

-nomusic

Disables music only.

Multiplayer

-standalone

Creates a standalone server.

-startgame

What does this do?

-closed

What does this do?

-restricted

What does this do?

-multilog

What does this do?

-clientdamage

What does this do?

-mpnoreturn

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


Troubleshooting

-fixbugs

Obsolete Argument - Removed in builds after 3.6.7

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

-nocrash

Obsolete Argument - Removed in builds after 3.6.7

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

-oldfire

What does this do?

-nohtl

WARNING - VERY SLOW

Reverts to software rendering mode. Does this work any more?

-no_set_gamma

Disables the gamma settings in the options screen.

-nomovies

Disables all video playback.

-noparseerrors

Disables some parsing warnings and makes other parse errors non-fatal. Do not rely on this when creating new tables, the errors are there for a reason.

-safeloading

Loads missions the old way. Typically safer, but slower.

-query_speech

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

-d3d_bad_tsys

Enable inefficient texture system.

-novbo

Disables OpenGL VBO.

-noibx

Disables IBX caching of model geometry data. This will dramatically increase load times, but will help troubleshoot a model if one is working incorrectly.

-loadallweps

Load all weapons, even those not used.


Experimental

-env

Enables environment mapping. Direct3D only. Environment mapping intensity will be determined from the intensity of specular maps.

-alpha_env

Enables alpha environment mapping. Direct3D only. Environment mapping intensity will be determined from the alpha channel of specular maps.

-decals

Enables damage decals.

-ingame_join

Enables ingame joining in multiplayer. FIXME: Host option?

-tga16

Converts all TGA images to 16-bits. Reduces memory footprint at the expense of image quality.


Development Tools

-fps

Displays current frames per second.

-pos

Displays current position coordinates of camera.

-window

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

-timerbar

Displays a timing bar across the top of the screen. Timebar format varies by build.

-stats

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

-coords

Shows coordinates of the mouse cursor.

-show_mem_usage

Shows detailed RAM usage in HUD.

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

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

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

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

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

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


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

-pofspew

What does this do?

-tablecrcs

What does this do?

-missioncrcs

What does this do?

-dis_collisions

Disables all collisions.

-dis_weapons

Disables weapons rendering.

-output_sexps

Outputs SEXPs to sexps.html.

-output_scripting

Outputs scripting to scripting.html.

-nograb

Unix only. Disables focus grabbing in a window.

Other

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

Graphics

-ambient_factor

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

-spec_exp

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

-spec_point

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

-spec_static

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

-spec_tube

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

-clipdist

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

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


Gameplay

-mod

Specifies a higher priority game directory.

Takes one argument string, the name of the directory in which the target mod is contained. Explicit use of this command line should be unnecessary as the launcher has MOD options, though multiple mods are supported and do require manual entry.

Data precedence with -mod is as follows (mod directory "moddir")

  1. moddir/data/(appropriate directory)/
  2. moddir/data/
  3. moddir/
  4. Freespace2/data/(appropriate directory)
  5. Freespace2/data/
  6. Freespace2/

-fov

Specifies the Field of View for the player eyepoint.

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

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


Multiplayer

-gamename

Specifies the name of the game to be created by a stand-alone server.

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

-password

Specifies the password for a stand-alone server.

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

-allowabove

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

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

-allowbelow

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

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

-port

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

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

-connect

What does this do?

-clientdamage

What does this do?

-timeout

What does this do?