Console Commands
----------------

Pressing 'tab' activates the console. On the console there are several
commands that you can use to control how Crystal Space works. Several of
the commands are not directly useful for use from within the console
but they are attached to keys. There are several kinds of commands. Here
is a general explanation on how the commands work:

  - boolean commands. Boolean commands have either an 'on' or 'off' state.
    When you just type the command without arguments it will show you the
    current state of the command ('on' or 'off'). To turn the state on
    just use: 'on', 'yes', 'true', or '1' as the first argument of the
    command. To turn it off use: 'off', 'no', 'false', or '0'.
    To toggle a state use 'toggle'.
    Example:
	fps			-> show current setting for FPS display
    	fps on			-> enable FPS display
	fps 0			-> disable FPS display
	fps toggle		-> toggle FPS display

  - value commands. A value command has some value associated with it.
    Typing the command without arguments will show the current value.
    Just type the value after the command to change it. Using a '+'
    or '-' sign before the value will increase or decrease the value with
    the given amount.
    Example:
	gamma			-> show current gamma value
	gamma 1.5		-> set gamma to 1.5
	gamma +0.05		-> increase gamma with 0.05
	gamma -0.05		-> decrease gamma with 0.05

  - multi-choice commands. A multi-choice command has one or more
    possible values. Typing the command without arguments will show the
    current value. Just type the new value after the command to change it.
    Use 'next' to switch to the next value and 'prev' to switch to the
    previous value.
    Example:
	lightmap		-> show the current lightmap setting
	lightmap reasonable	-> set lightmap setting to 'reasonable'
	lightmap next		-> use the next value for lightmap setting

  - general command. How the argument is interpreted depends on the
    command.

Here is a list of all commands:

Command: quit
Type:    general command
Action:  Quit Crystal Space (what did you expect :-)

Command: help
Type:    general command
Action:  Give a short list of all commands.

Command: physics
Type:    boolean command
Action:  Enable/disable physics system (experimental).
	 Corresponds to -physics/-nophysics commandline options
	 and PHYSICS configuration option.

Command: fclear
Type:    boolean command
Action:  Enable/disable the clearing of the display every frame
	 (this is useful for debugging). Corresponds to -clear
	 command line option.

Command: debug
Type:    boolean command
Action:  Enable/disable more debug information (which is written in
         debug.txt if the program crashes provided your system can
	 catch crashes).

Command: stats
Type:    boolean command
Action:  Enable/disable statistics display. Corresponds
	 to -stats/-nostats commandline options and STATS configuration
	 option.
	 Note that enabling the statistics counter automatically
	 disables the display of the coordinates.

Command: fps
Type:    boolean command
Action:  Enable/disable FPS display (frames per second). Corresponds
	 to -fps/-nofps commandline options and FPS configuration
	 option.

Command: transp
Type:    boolean command
Action:  Enable/disable transparent/filtered/alpha drawing.

Command: portals
Type:    boolean command
Action:  Enable/disable drawing through portals. If this is off, a portal
	 will just draw as the default texture on the polygon.

Command: perfect
Type:    boolean command
Action:  Enable/disable perfect texture mapping. This is texture mapping
	 without interpolation at every 16 pixels.

Command: edges
Type:    boolean command
Action:  Enable/disable display of edges around polygons. This is
	 useful for debugging.

Command: texture
Type:    boolean command
Action:  Enable/disable texture mapping.

Command: lighting
Type:    boolean command
Action:  Enable/disable lighting.

Command: console
Type:    boolean command
Action:  Open/close console (is done automatically by 'tab' key).

Command: mipmap
Type:    multi-choice command
Action:  Select when you want mipmapping. There are three possible
	 values: 'off', 'on', and 'always' (default is 'on').
	 When mipmapping is set to 'off' there will be no mipmapping.
	 When mipmapping is set to 'always' the highest level of
	 mipmapping is always selected (results in a blurred display).

Command: lightmap
Type:    multi-choice command
Action:  Select how accurate you want the shadows to be when
	 far-away mipmap levels are selected. Default is 'accurate'
	 which is the slowest for the texture cache. You may choose
	 'reasonable' which may be considered reasonable :-) or
	 'inaccurate' which is certainly not good (but it is faster
	 for the texture cache).

Command: capture
Type:    general command
Action:  Make a screenshot in PCX format. This does not seem to work
	 correctly in all cases.

Command: cachedump
Type:    general command
Action:  Give information about the contents of the texture cache.

Command: cacheclr
Type:    general command
Action:  Clear the texture cache.

Command: turn
Type:    general command
Action:  Turn arround (so that the camera looks the other way).

Command: activate
Type:    general command
Action:  Activate the object that is right in front of you.

Command: perftest
Type:    general command
Action:  Do a performance test on the current position.

Command: coorddump
Type:    general command
Action:  Show where the camera is located (sector and position).

Command: coordsave
Type:    general command
Action:  Save the current position to the 'coord' file.

Command: coordload
Type:    general command
Action:  Restore the position from the 'coord' file.

Command: coordshow
Type:    boolean command
Action:  Enable/disable display of coordinate at runtime.
	 Note that enabling the coordinates display automatically
	 disables the statistics display.

Command: gamma
Type:    value command
Action:  Control the gamma value of the display. A gamma of 1.00
	 is neutral. 2.00 (for example) is lighter and 0.5 is
	 darker. Press 'g' or 'shf-g' to experiment with this value
	 at render time.
	 This command corresponds with the -gamma commandline option
	 and with the GAMMA configuration option.

Command: fov
Type:    value command
Action:  Control the FOV (Field Of Vision) of the display.
	 By default this is equal to the height (in pixels) of the
	 current display. Press 'f' or 'shf-f' to experiment with
	 this value at render time.
	 This command corresponds with the -fov commandline option
	 and with the FOV configuration option.

Command: dmipmap1
Type:    value command
Action:  Control the distance at which mipmapping level 1 starts to
	 get effect.
	 This command corresponds with the -dmipmap1 command option
	 and with the DMIPMAP1 configuration option.

Command: dmipmap2
Type:    value command
Action:  Control the distance at which mipmapping level 2 starts to
	 get effect.
	 This command corresponds with the -dmipmap2 command option
	 and with the DMIPMAP2 configuration option.

Command: dmipmap3
Type:    value command
Action:  Control the distance at which mipmapping level 3 starts to
	 get effect.
	 This command corresponds with the -dmipmap3 command option
	 and with the DMIPMAP3 configuration option.

Command: hi
Type:    general command
Action:  Hilight the named polygon in the current sector. If the polygon
         is not found hilighting is disabled. This command is useful
	 for debugging.

Command: exec
Type:    general command
Action:  Start a script containing console commands. Every line in this
         script is performed one line at a time at every new frame.
	 The console automatically closes after executing a succesful
	 'exec' command.

Command: coordset
Type:    general command
Action:  Set the coordinate of the camera to the given sector and
         location. Example 'coordset room,0,0,0' to restore the
	 position of the camera to the starting point.

Command: cls
Type:    general command
Action:  Clear all messages from the console window.

Command: facenorth
Type:    general command
Action:  Face the camera to the north.

Command: facesouth
Type:    general command
Action:  Face the camera to the south.

Command: facewest
Type:    general command
Action:  Face the camera to the west.

Command: faceeast
Type:    general command
Action:  Face the camera to the east.

Command: facedown
Type:    general command
Action:  Face the camera down.

Command: faceup
Type:    general command
Action:  Face the camera up.

Command: cmessage
Type:    general command
Action:  Write the specified message to the console.

Command: dmessage
Type:    general command
Action:  Write the specified message to 'debug.txt'.

Command: dnl
Type:    general command
Action:  Write a newline to 'debug.txt'.

Command: version
Type:    general command
Action:  Write the current version to the console.

Command: about
Type:    general command
Action:  Write the current version to the console in a more
         verbose format.

Command: addlight
Type:    general command
Action:  Add a dynamic floating light at a fixed position in front
         of the camera.

Command: dellight
Type:    general command
Action:  Delete the last added floating light.

Command: dellights
Type:    general command
Action:  Delete all floating lights.

Command: picklight
Type:    general command
Action:  Pickup the last added floating light so that it always
         moves in front of the camera.

Command: droplight
Type:    general command
Action:  Drop the light that has been picked up with 'picklight'.

Command: things
Type:    boolean command
Action:  Toggle the display of things on/off (default on).

Command: ilace
Type:    boolean command
Action:  Toggle interlace on/off (see config.txt for information about
         the INTERLACING option).

Command: mmx
Type:    boolean command
Action:  Toggle MMX support on/off. This command corresponds with the
         MMX configuration file option (see config.txt for more info).
	 Note that this command is only useful if you have a MMX
	 capable processor.

