From 9e3735054aff52b42c1e4a9cd209ed236a237af3 Mon Sep 17 00:00:00 2001 From: Don Goyette Date: Tue, 10 Feb 2004 21:39:00 +0000 Subject: [PATCH] Added comments for each parameter that will help users modify them. --- celestia.cfg | 211 +++++++++++++++++++++++++++++++++++++++++++-------- 1 file changed, 178 insertions(+), 33 deletions(-) diff --git a/celestia.cfg b/celestia.cfg index aa0cf20a2..da23d329e 100644 --- a/celestia.cfg +++ b/celestia.cfg @@ -1,41 +1,186 @@ +#************************************************************************ +# Celestia Configuration File +# +# This file contains configuration data read by Celestia each time it +# is run. Many of the items may be changed to suit your specific needs +# or requirements. +# +# To learn more about Celestia, visit the Celestia forums at: +# http://ennui.shatters.net/forum/ +# or the Celestia web site at: http://www.shatters.net/celestia/ +#************************************************************************ + + Configuration { - StarDatabase "data/stars.dat" - StarNameDatabase "data/starnames.dat" - StarCatalogCrossReferences [ "data/hdxref.dat" ] - SolarSystemCatalogs [ "data/solarsys.ssc" "data/extrasolar.ssc" "data/solsys_locs.ssc" "data/world-capitals.ssc" ] - DeepSkyCatalog "data/deepsky.dsc" + +#------------------------------------------------------------------------ +# This section contains a list of data files that Celestia uses to load +# information about stars, constellations and locations. DO NOT change +# these file names or the order in which they are listed, unless you +# know exactly what you are doing. Most of these files can be viewed +# with a plain text editor. Discussion about their content and formats +# can be found on the Celestia forums: http://ennui.shatters.net/forum/ +#------------------------------------------------------------------------ + StarDatabase "data/stars.dat" + StarNameDatabase "data/starnames.dat" + StarCatalogCrossReferences [ "data/hdxref.dat" ] + SolarSystemCatalogs [ "data/solarsys.ssc" + "data/extrasolar.ssc" + "data/solsys_locs.ssc" + "data/world-capitals.ssc" ] + DeepSkyCatalog "data/deepsky.dsc" + AsterismsFile "data/asterisms.dat" + BoundariesFile "data/boundaries.dat" + + +#------------------------------------------------------------------------ +# User Interface files ... +# +# Despite their ".cel" file extension, these are not CEL scripts, but +# rather data files that populate controls such as menus and dialog +# boxes. +# +# FavoritesFile is where Bookmarks data are stored. The file does not +# exist until you save a Bookmark from within Celestia. You can view +# this file with a plain text editor and if you write CEL scripts, it +# contains some useful information. +# +# DestinationFile is the list of Destinations used in the Tour Guide +# dialog box, accessed via the Navigation Menu. You can edit this file +# with a plain text editor to add your own destinations to the dialog +# box. The order in which the items are listed in the file is the order +# in which they will be listed in the Tour Guide dialog. +#------------------------------------------------------------------------ + FavoritesFile "favorites.cel" + DestinationFile "guide.cel" + + +#------------------------------------------------------------------------ +# Included CEL script files. +# +# The following CEL script files are included in the basic Celestia +# distribution. These script files may be viewed and edited with a +# plain text editor. They may both be modified or replaced to suit your +# specific needs. +# +# InitScript is the CEL script that is automatically run each time +# Celestia is started. The default script (start.cel) travels to Io, one +# of Jupiter's moons. +# +# DemoScript is the CEL script that is run when you press the "d" key +# on your keyboard from within Celestia. The default script (demo.cel) +# takes you on a short tour of some interesting places in our solar +# system. +# +# To learn more about how to use and write CEL scripts and Lua scripts +# in Celestia, please visit the Celestia Scripting forum at: +# http://ennui.shatters.net/forum/viewforum.php?f=9 +#------------------------------------------------------------------------ + InitScript "start.cel" + DemoScript "demo.cel" + + +#------------------------------------------------------------------------ +# The 'extras' directory is located under the celestia root directory +# and is used for storing third-party add-ons to Celestia. To learn +# more about Add-Ons for Celestia, visit the Celestia Add-Ons forum at: +# http://ennui.shatters.net/forum/viewforum.php?f=6 +# +# You may specify additional add-on directories by adding additional +# entries, such as the following example shows: +# ExtrasDirectories [ "extras" "myextras1" "myextras2" ] +#------------------------------------------------------------------------ + ExtrasDirectories [ "extras" ] + + +#------------------------------------------------------------------------ +# Font definitions. +# +# The following entries define the fonts Celestia will use to display +# text on the display screen. To view the list of fonts available with +# your distribution of Celestia, look in the fonts directory located +# under the Celestia root directory. The default fonts are UTF-8 +# compatible in order to display non-English characters. +# +# Font: Used to display all informational text. +# Default: "sans12.txf" +# +# LabelFont: Used to display all label text (objects, locations, etc.). +# Default "sans12.txf" +# +# TitleFont: Used to display object names, messages, and script text. +# Default "sansbold20.txf" +#------------------------------------------------------------------------ + Font "sans12.txf" + LabelFont "sans12.txf" + TitleFont "sansbold20.txf" + + +#------------------------------------------------------------------------ +# LogoTexture defines the graphic file to be displayed when Celestia is +# started. The default filename is "logo.png" +#------------------------------------------------------------------------ + LogoTexture "logo.png" + + +#------------------------------------------------------------------------ +# FaintestVisibleMagnitude defines the lowest magnitude at which a star +# will be displayed in Celestia. This setting may be adjusted real-time +# via the '[' and ']' keys in Celestia. The default value is 6.0. +#------------------------------------------------------------------------ + FaintestVisibleMagnitude 6.0 + + +#------------------------------------------------------------------------ +# RotateAcceleration defines the speed at which an object will be +# rotated in Celestia, when using a keypress, such as the left and right +# arrow keys. A higher value will rotate the object quicker, while a +# lower value will cause a slower rotation. The default value is 120.0. +#------------------------------------------------------------------------ + RotateAcceleration 120.0 + + +#------------------------------------------------------------------------ +# MouseRotationSensitivity defines the speed at which an object will be +# rotated in Celestia, when using the mouse -- press both mouse-buttons +# or Ctrl+LeftMouseButton, and move the mouse left or right. A higher +# value will rotate the object quicker, while a lower value will cause +# a slower rotation. A value of 0.0 (zero) will disable this particluar +# feature. The default value is 1.0. +#------------------------------------------------------------------------ + MouseRotationSensitivity 1.0 + + +#------------------------------------------------------------------------ +# The following parameters are used in Lua (.celx) scripting. +# ScriptScreenshotCount defines the maximum number of screen shots +# to be taken. +# +# ScriptScreenshotDirectory defines the directory where the screen +# shots are to be stored. +#------------------------------------------------------------------------ + ScriptScreenshotCount 0 + ScriptScreenshotDirectory "" - AsterismsFile "data/asterisms.dat" - BoundariesFile "data/boundaries.dat" - FavoritesFile "favorites.cel" - DestinationFile "guide.cel" - InitScript "start.cel" - DemoScript "demo.cel" - ExtrasDirectories [ "extras" ] +#------------------------------------------------------------------------ +# The following line is commented out by default. +# +# Celestia enables and disables certain rendering features based on +# the set of extensions supported by the installed OpenGL driver and 3D +# graphics hardware. With IgnoreGLExtensions, you may specify a list of +# extensions that Celestia will treat as unsupported. This is useful +# primarily for the developers of Celestia.#------------------------------------------------------------------------ +# IgnoreGLExtensions [ "GL_ARB_vertex_program" ] -# Specify multiple extras directories like this: -# ExtrasDirectories [ "extras" "rassilon" ] - Font "sans12.txf" - LabelFont "sans12.txf" - TitleFont "sansbold20.txf" - - LogoTexture "logo.png" - - FaintestVisibleMagnitude 6.0 - - RotateAcceleration 120.0 - MouseRotationSensitivity 1.0 - - ScriptScreenshotCount 0 - ScriptScreenshotDirectory "" - - # IgnoreGLExtensions [ "GL_ARB_vertex_program" ] - - LabelledStars - [ +#------------------------------------------------------------------------ +# The LabelledStars section defines which stars will have text labels +# assigned to them, which are visible when this option is turned on. +#------------------------------------------------------------------------ + LabelledStars + [ "Sol" "Sirius" "Canopus" @@ -76,5 +221,5 @@ Configuration "Epsilon Car" "Beta Aur" "Polaris" - ] + ] }