Configuring Simulator Parameters - Revision history

Ubit: /* Structure */

2020-02-04T22:17:34Z

‎Structure

Ubit: /* Changing Simulator Settings */

2020-02-04T22:16:32Z

‎Changing Simulator Settings

Ubit: /* Changing Simulator Settings */

2020-02-04T22:15:32Z

‎Changing Simulator Settings

Ubit: /* Changing Simulator Settings */

2020-02-04T22:14:50Z

‎Changing Simulator Settings

Ubit: /* Changing Simulator Settings */

2020-02-04T22:13:58Z

‎Changing Simulator Settings

Ubit: /* Structure */

2020-02-04T22:09:10Z

‎Structure

BlueWall at 16:38, 31 January 2015

2015-01-31T16:38:42Z

Justincc: /* Structure */

2014-06-03T16:57:48Z

‎Structure

Justincc: /* Aggregation and Overriding */

2013-10-28T21:20:12Z

‎Aggregation and Overriding

Justincc: /* Getting information about parameters */

2012-06-21T00:28:17Z

‎Getting information about parameters

@@ Line 18: / Line 18: @@
 OpenSimDefaults.ini (on OpenSimulator 0.7.1 and later) and OpenSim.ini are always checked for on startup. However, the other INI files are loaded as a result of include directives within the preceding INI files.
-For instance, at the bottom of the OpenSim.ini file in the [Architecture] section, there are a number of possible architectural includes. For example, a default OpenSimulator 0.7.1 standalone setup will have
+For instance, at the bottom of the OpenSim.ini file in the [Architecture] section, there are a number of possible architectural includes. For example, a default OpenSimulator (since 0.7.1) standalone setup will have
   [Architecture]

@@ Line 34: / Line 34: @@
 = Changing Simulator Settings =
 Do not forget to copy OpenSim.ini.example to OpenSim.ini on install
-*Do not change OpenSimDefaults.ini. Copy the lines into same section on OpenSim.ini (add the section if not there), and then change there.
+*Do not change OpenSimDefaults.ini. Only edit OpenSim.ini. If necessary, copy the lines from it, into same section on OpenSim.ini (add the section if not there), and then change there.
 A configuration file consists of a number of sections, each starting with the name of that section in brackets ([]). For instance, in OpenSim.ini.example you have (ignore the descriptive text)

@@ Line 34: / Line 34: @@
 = Changing Simulator Settings =
 Do not forget to copy OpenSim.ini.example to OpenSim.ini on install
-*Do not change OpenSimDefaults.ini. Copy the respective line into same section on OpenSim.ini (add the section if not there), and change there.
+*Do not change OpenSimDefaults.ini. Copy the lines into same section on OpenSim.ini (add the section if not there), and then change there.
 A configuration file consists of a number of sections, each starting with the name of that section in brackets ([]). For instance, in OpenSim.ini.example you have (ignore the descriptive text)

@@ Line 34: / Line 34: @@
 = Changing Simulator Settings =
 Do not forget to copy OpenSim.ini.example to OpenSim.ini on install
 A configuration file consists of a number of sections, each starting with the name of that section in brackets ([]). For instance, in OpenSim.ini.example you have (ignore the descriptive text)
@@ Line 53: / Line 54: @@
 To change a parameter, one would uncomment it and edit the value. For instance, if I wanted whisper distance to be 50 meters in my sim, I would change OpenSim.ini so that it had.
   [Chat]

@@ Line 33: / Line 33: @@
 = Changing Simulator Settings =
+Do not forget to copy OpenSim.ini.example to OpenSim.ini on install
 A configuration file consists of a number of sections, each starting with the name of that section in brackets ([]). For instance, in OpenSim.ini.example you have (ignore the descriptive text)
@@ Line 50: / Line 50: @@
 The config parameters follow each section. Each has the structure <parameter> = <value> (e.g. whisper_distance = 10).
-In OpenSim.ini.example, if a parameter is commented out with a preceding semicolon (;), then the value in OpenSimDefaults.ini is used instead (in OpenSimulator 0.7.1 and later) or a default value within OpenSimulator itself.
+In OpenSim.ini, if a parameter is commented out with a preceding semicolon (;), then the value in OpenSimDefaults.ini is used instead (in OpenSimulator 0.7.1 and later) or a default value within OpenSimulator code itself.
 To change a parameter, one would uncomment it and edit the value. For instance, if I wanted whisper distance to be 50 meters in my sim, I would change OpenSim.ini so that it had.
   [Chat]

@@ Line 13: / Line 13: @@
   config-include/Standalone.ini
   config-include/StandaloneCommon.ini
-  config-include/CenomeCache.ini (not found on a default setup)
+  config-include/FlotsamCache.ini
   config-include/storage/SQLiteStandalone.ini
@@ Line 25: / Line 25: @@
      ; Include-Architecture = "config-include/Grid.ini"
      ; Include-Architecture = "config-include/GridHypergrid.ini"
 Lines that start with at least one semicolon (;) are commented out and are not active in the configuration. In this case, when OpenSimulator reads OpenSim.ini it will then go on to read config-include/Standalone.ini, which in turn includes config-include/StandaloneCommon.ini and so on.

← Older revision		Revision as of 16:38, 31 January 2015
Line 72:		Line 72:

	On the simulator's console command line, you can get information about what parameters it's actually using from the all the .ini files with the "config show" command. This is handy if you want to check that the simulator has loaded the parameters that you want. The "config save <path>" command will save this aggregated config.		On the simulator's console command line, you can get information about what parameters it's actually using from the all the .ini files with the "config show" command. This is handy if you want to check that the simulator has loaded the parameters that you want. The "config save <path>" command will save this aggregated config.
		+
		+	= Using Key Expansion to simplify configuration =
		+
		+	We use the same information in many places throughout the files that configure our servers. To help simplify the configuration process, we leverage "Key Expansion". With Key Expansion we are able to define these values in one place to be used anywhere in the set of configuration files. The configuration system uses the common syntax for parameter expansion: ${VARIABLE}. But, our configuration files have many sections, so our syntax adds the ability to address keys within the various sections of the set of configuration files using the pipe "\|" to separate the two. Then, our syntax becomes: ${SECTION\|KEY}. In the set of example configuration files distributed with OpenSimulator, we are using this feature to ease the definition of ports and urls in the file set, as these keys are used in many places. We set them in a newly added section ...
		+
		+	<source lang="ini">
		+	[Const]
		+
		+	BaseURL = http://127.0.0.1
		+	PublicPort = 8002
		+	PrivatePort = 8003
		+	</source>
		+
		+	Then we are able to use them in the many places they are needed by using our Key Expansion Syntax instead of the Key = Value seen elsewhere...
		+
		+	<source lang="ini">
		+	[Startup]
		+
		+	HomeURI = ${Const\|BaseURL}:${Const\|PublicPort}
		+	</source>
		+
		+	And when OpenSimulator starts and reads the set of configuration files, the end-result will be ...
		+
		+	<source lang="ini">
		+	[Startup]
		+
		+	HomeURL = http://127.0.0.1:8002
		+	</source>
		+
		+	And while it may not be quite so useful in our case, we may use the syntax to use keys defined in the same sections by omitting the section and pipe - ${KEY}.

	= Using shell environment variables in OpenSimulator configuration =		= Using shell environment variables in OpenSimulator configuration =

← Older revision		Revision as of 16:57, 3 June 2014
Line 2:		Line 2:

	= Structure =		= Structure =
		+
		+	'''Please note that the cascading configuration file system described below does not apply to Robust instances at this time.'''

	OpenSimulator has a fairly complicated configuration structure based on Windows style INI files. This is to accomodate its many different uses and possible architectures.		OpenSimulator has a fairly complicated configuration structure based on Windows style INI files. This is to accomodate its many different uses and possible architectures.

← Older revision		Revision as of 21:20, 28 October 2013
Line 64:		Line 64:

	As we saw above, when multiple config files have the same section, the settings are aggregated. If a later setting has the same name as an earlier setting, then the later setting overrides the earlier setting.		As we saw above, when multiple config files have the same section, the settings are aggregated. If a later setting has the same name as an earlier setting, then the later setting overrides the earlier setting.
		+
		+	You cannot have multiple sections with the same name (e.g. [DatabaseService]) in the same file (e.g. bin/config-include/GridCommon.ini). The second section will completely replace the first. To merge sections with the same name they must be situated in different .ini files.

	= Getting information about parameters =		= Getting information about parameters =

@@ Line 67: / Line 67: @@
 = Getting information about parameters =
-On the simulator's console command line, you can get information about what parameters it's actually using with the "config show" command. This is handy if you want to check that the simulator has loaded the parameters that you want.
+On the simulator's console command line, you can get information about what parameters it's actually using from the all the .ini files with the "config show" command. This is handy if you want to check that the simulator has loaded the parameters that you want.  The "config save <path>" command will save this aggregated config.
 = Using shell environment variables in OpenSimulator configuration =