Fgfsrc: Difference between revisions

From FlightGear wiki
Jump to navigation Jump to search
No edit summary
mNo edit summary
Line 5: Line 5:
It is very likely that this file does not exist on your system yet, and therefore has to be created by the user, you. The contents of the file are handled the same way by ''fgfs'' on all operating systems, but the name and location is not:
It is very likely that this file does not exist on your system yet, and therefore has to be created by the user, you. The contents of the file are handled the same way by ''fgfs'' on all operating systems, but the name and location is not:


* on ''GNU/Linux'' and ''Mac OS X'' the file is called ''.fgfsrc'' (note the leading dot!). ''Fgfs'' is looking for it inside the user's $HOME directory. To figure out where this is on your system, open a terminal window (shell) and enter <code>cd $HOME</code>.
* on ''GNU/Linux'' the file is called ''.fgfsrc'' (note the leading dot!). ''fgfs'' is looking for it inside the user's $HOME directory. To figure out where this is on your system, open a terminal window (shell) and enter <code>cd $HOME</code>.
 
<!-- ''Mac OS X'' = POSIX? -->


* on ''Windows'' systems the file is called ''system.fgfsrc'' and lives in $FG_ROOT which, on a standard installation, is ''C:\Program Files\FlightGear\data''.
* on ''Windows'' systems the file is called ''system.fgfsrc'' and lives in $FG_ROOT which, on a standard installation, is ''C:\Program Files\FlightGear\data''.
Line 12: Line 14:
===== Some 'rules' for the content: =====
===== Some 'rules' for the content: =====
* Each line contains one option only.
* Each line contains one option only.
* If the first 'visible' character is a '#', ''fgfs'' does not read this line (comment) and totally ignores it.
* If the first 'visible' character is a '#', ''fgfs'' totally ignores the line (comment).
* Lines containing an option followed by a comment are *not* allowed! (<code>--some-option  # some comment</code>) ''Fgfs'' will not ignore this.
* Use comments following an option (<code>--some-option  # some comment</code>) with care. At least with string containing''--prop='' options this will cause ''fgfs'' to fail.





Revision as of 21:36, 8 October 2009

fgfsrc

The files fgfsrc purpose is to contain Command Line Parameters which are read by fgfs at startup. This is for users who start FlightGear from the command line, so users using a graphical user interface like fgrun don't have to bother with this at all. Anyhow, it is possible to use fgrun to create your personal set of options by copy-and-pasting them from the Show command line textbox (on the last page of FGRun) into fgfsrc.


It is very likely that this file does not exist on your system yet, and therefore has to be created by the user, you. The contents of the file are handled the same way by fgfs on all operating systems, but the name and location is not:

  • on GNU/Linux the file is called .fgfsrc (note the leading dot!). fgfs is looking for it inside the user's $HOME directory. To figure out where this is on your system, open a terminal window (shell) and enter cd $HOME.


  • on Windows systems the file is called system.fgfsrc and lives in $FG_ROOT which, on a standard installation, is C:\Program Files\FlightGear\data.


Some 'rules' for the content:
  • Each line contains one option only.
  • If the first 'visible' character is a '#', fgfs totally ignores the line (comment).
  • Use comments following an option (--some-option # some comment) with care. At least with string containing--prop= options this will cause fgfs to fail.


An example of a basic fgfsrc file:
# $HOME/.fgfsrc
 
 
### Aircraft
#
--aircraft=ec135
 ## Catalina, dhc3[A/F], p47d-30, F1-156-de, ZivkoEdge540 
 ## MPcarrier: nimitz, nimitz-ATC, nimitz_observer, foch, vinson, eisenhower
 
 
### Initial position
#
--airport=LOWI
#--runway=08L
#--parkpos=A11
#
# In air:
#--offset-distance=1.5
#--altitude=6000
#--vc=70
#--enable-freeze
#
# Coordinates:
 ## Oilrig Lennox:
#--lon=-3.17547
#--lat=53.63305
#--altitude=205
 
 
### Environment
#
--timeofday=noon
--random-wind
--enable-real-weather-fetch
 ##rain/snow:
--prop:/sim/rendering/precipitation-enable=false
--enable-horizon-effect
--enable-specular-highlight
--enable-ai-models
--enable-clouds3d
--shading-flat
--fog-nicest
--enable-random-objects
--prop:/sim/rendering/random-vegetation=true
--prop:/sim/frame-rate-throttle-hz=30
--ai-scenario=nimitz_demo
 
 
### Network
#
--callsign=I-FLY
#--prop:/sim/remote/pilot-callsign=U-FLY
--multiplay=out,10,mpserver01.flightgear.org,5000
#--multiplay=in,10,localhost,5000
--httpd=5500
 ## nice terrasync -p 5505 -S -d /opt/fgfs/scenery.terrasync :
--atlas=socket,out,1,localhost,5505,udp 
 ## fgcom -Sfgcom.flightgear.org.uk [-f910] :
--generic=socket,out,10,localhost,16661,udp,fgcom
 
 
### System
#
#--log-level=info
 ## alarm,warn,info,debug
--fg-root=/opt/fgfs/data
--fg-scenery=/opt/fgfs/data/Scenery:/opt/fgfs/scenery.1.0.1:/opt/fgfs/scenery.terrasync
--geometry=1280x1024
--bpp=24
--control=joystick
--prop:/sim/traffic-manager/enabled=0
 ## disable mouse mode 'fly':
--prop:/input/mice/mouse/mode/button[2]/binding/value=2


Some options (mostly properties) are only temporary of interest to the 'normal' user or even only for CVS users:

 ## parkpos, temporary:
--prop:/sim/traffic-manager/use-custom-scenery-data=true

(explanation missing)


Please feel free to add other useful options to the temporary and basic ones!!!