Configuring Regions

From OpenSimulator

(Difference between revisions)
Jump to: navigation, search
(→‎OpenSim 0.6.7 and later)
 
(61 intermediate revisions by 19 users not shown)
Line 1: Line 1:
−
==OpenSim 0.6.7 and later==
+
{{Quicklinks|Configuring_Regions}}
−
By default, regions in OpenSim 0.6.7 and later are configured in a file named Regions.ini in the bin/Regions directory.  If you started a completely fresh installation of OpenSim, it will ask you a series of questions to set up your first region.
+
= OpenSimulator 0.9 and later =
  
−
Here's an example of a Regions.ini
+
By default, regions are configured in a file named Regions.ini in the bin/Regions directory. If you started a completely fresh installation of OpenSim, it will ask you a series of questions to set up your first region.
 +
 
 +
Here's an example of a Regions.ini file
  
 
  [Big Fat Region]
 
  [Big Fat Region]
Line 10: Line 12:
 
  InternalPort = 9000
 
  InternalPort = 9000
 
  AllowAlternatePorts = False
 
  AllowAlternatePorts = False
−
  ExternalHostName = 192.168.1.2
+
  ExternalHostName = mymachine.something.org
−
MasterAvatarFirstName = Justin
+
  SizeX = 512
−
  MasterAvatarLastName = Clark-Casey
+
  SizeY = 512
−
  MasterAvatarSandboxPassword = yeahokay
+
  
−
Here's a line by line breakdown
+
This is a list of settings that must be present for a region to operate. When you start OpenSimulator for the first time without an existing Regions.ini file, you'll be asked for an entry for each setting in order to set up your initial region. For more details, see [[Configuration#Running OpenSimulator for the first time]].
  
−
'''[Big Fat Region]''' - The name of the region, in this case Big Fat Region.
+
{| cellspacing="0" cellpadding="5" border="1" align="center" class="sortable" width="90%"
−
 
+
|-
−
'''RegionUUID''' - The unique ID of the region. It has to be in this UUID format and must be unique with respect to any other regions that you are running
+
! Attribute
−
 
+
! Description
−
'''Location''' - The location of the region on the grid.
+
|-
−
 
+
| [Big Fat Region]  
−
'''InternalAddress''' - INSTRUCTIONS TODO.  I recommend leaving this as 0.0.0.0
+
| The name of the region.
−
 
+
|-
−
'''InternalPort''' - The port which viewers will use to log in to this region.  It must be accessible from the machine on which the viewer is running. If you're running multiple regions, each must use a unique port number.
+
| RegionUUID  
−
 
+
| The unique ID of the region.
−
'''AllowAlternatePorts''' - TODO UNKNOWN. Leave as the default False.
+
|-
−
 
+
| Location  
−
'''ExternalHostName''' - This is the address which viewers will use to log in to this region. It must be accessible from the machine on which the viewer is running.  In this case it's 192.168.1.2 because I'm running both viewer and simulator on a LAN.  If you wanted people to be able to connect to this simulator over the Internet then you would need to provide an accessible web address (e.g. mylovelysim.com).
+
| The (x, y) location of the region on the grid.
−
 
+
|-
−
'''MasterAvatarFirstName''' - The master avatar name.  TODO MORE INSTRUCTIONS.  Otherwise don't worry about this.
+
| InternalAddress  
−
 
+
| 0.0.0.0 if you have more than one NIC on the server and you don't care which IP address OpenSimulator listens on (this is the usual setting). Alternatively, you can set to a specific IP.
−
'''MasterAvatarLastName''' - The master avatar last name.  TODO MORE INSTRUCTIONS.  Otherwise don't worry about this.
+
|-
−
 
+
| InternalPort
−
'''MasterAvatarSandboxPassword''' - TODO MORE INSTRUCTIONS.  Otherwise don't worry about this.
+
| IP port for all incoming client connections.
 +
|-
 +
| AllowAlternatePorts  
 +
| Not Used. Leave it always False.
 +
|-
 +
| ExternalHostName  
 +
| External IP Address of the router or FQDN. (must be the same for all regions on file)
 +
|-
 +
| SizeX and SizeY
 +
| The region size, must be a multiple of 256, and equal. If not present will be 256m
 +
|}
  
 
If you want to add another region you can  
 
If you want to add another region you can  
  
−
* enter another section in Regions.ini
+
* enter another section in Regions.ini  
−
* create another separate .ini file in bin/Regions
+
* create another separate .ini file in bin/Regions  
−
* create an old format OpenSim xml file (these still work with OpenSim 0.6.7)
+
* create an old format OpenSimulator xml file (these still work with current OpenSim)  
−
* or use the create region command on the region console (I don't recommend this since it seems to be a bit buggy in 0.6.7).
+
* or use the create region command on the region console (I don't recommend this since it seems to be a bit buggy).
  
−
Here's an example where a second region has been added to Regions.ini
+
Here's an example where a second region has been added to Regions.ini  
  
 
  [Big Fat Region]
 
  [Big Fat Region]
Line 52: Line 63:
 
  InternalPort = 9000
 
  InternalPort = 9000
 
  AllowAlternatePorts = False
 
  AllowAlternatePorts = False
−
  ExternalHostName = 192.168.1.2
+
  ExternalHostName = mymachine.something.org
−
MasterAvatarFirstName = Justin
+
 
−
MasterAvatarLastName = Clark-Casey
+
 
−
MasterAvatarSandboxPassword = yeahokay
+
−
 
+
 
  [Greek Wedding]
 
  [Greek Wedding]
 
  RegionUUID = 5c445740-6460-43d3-ba4c-444444445555
 
  RegionUUID = 5c445740-6460-43d3-ba4c-444444445555
Line 63: Line 72:
 
  InternalPort = 9001
 
  InternalPort = 9001
 
  AllowAlternatePorts = False
 
  AllowAlternatePorts = False
−
  ExternalHostName = 192.168.1.2
+
  ExternalHostName = mymachine.something.org
−
  MasterAvatarFirstName = Justin
+
 
−
MasterAvatarLastName = Clark-Casey
+
As you can see, the Second region is named Greek Wedding and has a different UUID. It has a different location (1000,1001) and a different InternalPort (9001). Other than that, the details are the same.  
−
MasterAvatarSandboxPassword = yeahokay
+
 
 +
To create a new UUID you can either tweak an existing one by hand (e.g. by changing one character so that the new one is in the range [0-9][A-F] or a generator can be found at uuidgen webpage. On Unix, you can also use the <tt>uuidgen</tt> command.
 +
 
 +
As well as the critical entries above, there are some additional optional ones that can change the properties of a region. These are
 +
 
 +
{| cellspacing="0" cellpadding="5" border="1" align="center" class="sortable" width="90%"
 +
|-
 +
! Attribute
 +
! Description
 +
|-
 +
| MaxAgents
 +
| The maximum number of agents that can be in the in the region at any given time. The default is 100. As of 4/22/2011 this option only exists in the current git master.
 +
|-
 +
| MaxPrims
 +
| The maximum number of prims that the region will be listed as supporting. However, this limit is not currently enforced by OpenSimulator. Due to LL protocol constraints, the maximum limit that can be shown is 45000.
 +
|-
 +
| MaxPrimsPerUser
 +
| Max prims per user (per parcel).Negative values will disable the check.
 +
|-
 +
| PhysicalPrimMax
 +
| The maximum dimensions of a physical prim. This is a single number which applies to X, Y and Z co-ordinates. This will affect resizing of existing prims. Default is 10. This setting can also be used in the [Startup] section of OpenSim.ini. If the region setting exists then it will override the OpenSim.ini setting.
 +
|-
 +
| NonPhysicalPrimMax
 +
| The maximum dimensions for a non-physical prim. This is a single number which applies to X, Y and Z co-ordinates. This will affect resizing of existing prims. Default is 256. This setting can also be used in the [Startup] section of OpenSim.ini. If the region setting exists then it will override the OpenSim.ini setting.
 +
|-
 +
| ClampPrimSize
 +
| If true then if a viewer attempts to create a prim which has any dimension larger than the NonphysicalPrimMax, then that dimension is reduced to NonphysicalPrimMax. Default is false; This setting can also be used in the [Startup] section of OpenSim.ini. If the region setting exists then it will override the OpenSim.ini setting.
 +
|-
 +
| RegionType
 +
| The region type as shown in the Covenant tab of the Region/Estate dialog in a standard Second Life viewer. Can be used to specify Mainland, Estate, etc. based on type of grid.
 +
|-
 +
| MaptileStaticUUID
 +
| UUID of texture to use as a maptile for this region. Only set if you have disabled dynamic generation of the map tile from the region contents in OpenSim.ini as well:
 +
  MapImageModule = "MapImageModule"
 +
  GenerateMaptiles = false
 +
|-
 +
|MaptileStaticFile
 +
|External image files of the right size and supported formats (bmp,png,jpg in RGB 24bpp format) to use as a maptile for this region.The following things must be set in the [Map] section of OpenSim.ini:
 +
  MapImageModule = "MapImageModule"
 +
  GenerateMaptiles = true
 +
Example : MaptileStaticFile = "maptiles/UnFichier.png"
 +
|}
 +
 
 +
== Other Tasks ==
 +
 
 +
=== Configuring Multiple Regions on a Single Server Instance ===
 +
 
 +
To configure multiple regions on one server (i.e. a 4x4 server), edit the Regions.ini file to include multiples of the single entry already there. Make sure the RegionUUID and InternalPort are different on each one, or it won't work. To load individual OAR files into each region, use the 'change region [regionname]' command and then 'load oar [oar-location]'.
  
−
As you can see, the Second region is named Greek Wedding and has a different UUID.  It has a different location (1000,1001) and a different InternalPort (9001).  Other than that, the details are the same.
+
=== Loading from the web ===
  
−
To create a new UUID you can either tweak an existing one by hand (e.g. by changing one character so that the new one is in the range [0-9][A-F] or a generator can be found at [http://www.famkruithof.net/uuid/uuidgen uuidgen webpage].  On Unix, you can also use the <tt>uuidgen</tt> command.
+
OpenSim.exe can read the region definitions from the web using the following settings :
  
−
==OpenSim 0.6.6 and earlier==
+
    [Startup]
−
A powerful region generator is available at: [[RegionGenerator]]
+
        region_info_source = "web"
 +
        regionload_webserver_url = "http://example.com/regions.xml";
  
−
For running multiple regions on the same box, you simply make multiple copies of the 'default.xml' file inside the <tt>bin/Regions/</tt> directory.  You can do this by typing <tt>create region</tt> at the OpenSim command prompt, using the script <tt>make.php</tt> in <tt>share/regions</tt>, or you can generate the files by hand.
+
The following format has been reported to work with OpenSimulator 0.8.* :
  
−
If you want to create the files by hand:
+
    <Nini>
 +
    <Section Name="My region Name">
 +
      <Key Name="RegionUUID" Value="4208aa66-ce9b-4f49-a4da-06a27d95f001" />
 +
      <Key Name="Location" Value="7000,7000" />
 +
      <Key Name="InternalAddress" Value="0.0.0.0" />
 +
      <Key Name="InternalPort" Value="9016" />
 +
      <Key Name="AllowAlternatePorts" Value="False" />
 +
      <Key Name="ExternalHostName" Value="mygrid.org" />
 +
      <Key Name="MaxPrims" Value="15000" />
 +
      <Key Name="MaxAgents" Value="40" />
 +
      <Key Name="RegionType" Value="0" />
 +
      <Key Name="SizeX" Value="256" />
 +
      <Key Name="SizeY" Value="256" />
 +
      <Key Name="MaptileStaticUUID" Value="00000000-0000-0000-0000-000000000000" />
 +
    </Section>
 +
    </Nini>
  
−
:first copy the default.xml file in the <tt>bin/Regions</tt> directory, and name them anything you want (I name mine region.x.y.xml, where region is the name of the region, and x and y are the grid coords.)
+
= Tools =
−
:Open each xml file and edit the uuid (a generator can be found at [http://www.famkruithof.net/uuid/uuidgen uuidgen webpage] or on unix, use the uuidgen command), region name, x & y positions, and internal IP port.
+
  
−
'''IMPORTANT!'''  Regardless of the method you use to create your new region, the UUID, name, and grid coordinates ''must'' be unique for each region on a grid.  The port assignment must be unique for each region that is running on a particular machine. The internal IP ''address'' and external host name must be the same for all regions.
 
  
−
Note that <tt>sim_location_x</tt> and <tt>sim_location_y</tt> should be adjacent integers if you want your regions to be adjacent, so you can run back and forth between them.  '''IMPORTANT: THESE GRID COORDINATES ARE ''NOT'' IN METERS.  THEY ARE SIM POSITIONS.'''  (1000, 1000) is next to (1001,1000), (1000, 1001), and so forth.  1256, 2000, 2048 and similar values are '''not''' adjacent to 1000, they are very far away, so you would not see your sims from one another.
+
* A powerful region generator is available at: [[RegionGenerator]]
  
−
Once you have 2 or more xml files in the bin/Regions folder, running a ''single'' copy of <tt>OpenSim.exe</tt> will start up all of your sims! If you come across any errors, there is most likely an error in your xml files.
+
[[Category:Configuration]]

Latest revision as of 10:43, 28 July 2024

Languages Languages: 

En.png English   De.png Deutsch   Fr.png Français   Jp.png 日本語

Contents

[edit] OpenSimulator 0.9 and later

By default, regions are configured in a file named Regions.ini in the bin/Regions directory. If you started a completely fresh installation of OpenSim, it will ask you a series of questions to set up your first region.

Here's an example of a Regions.ini file 

[Big Fat Region]
RegionUUID = 5ce85740-6460-43d3-ba4c-29207b010072
Location = 1000,1000
InternalAddress = 0.0.0.0
InternalPort = 9000
AllowAlternatePorts = False
ExternalHostName = mymachine.something.org
SizeX = 512
SizeY = 512

This is a list of settings that must be present for a region to operate. When you start OpenSimulator for the first time without an existing Regions.ini file, you'll be asked for an entry for each setting in order to set up your initial region. For more details, see Configuration#Running OpenSimulator for the first time.

Attribute Description
[Big Fat Region] The name of the region.
RegionUUID The unique ID of the region.
Location The (x, y) location of the region on the grid.
InternalAddress 0.0.0.0 if you have more than one NIC on the server and you don't care which IP address OpenSimulator listens on (this is the usual setting). Alternatively, you can set to a specific IP.
InternalPort IP port for all incoming client connections.
AllowAlternatePorts Not Used. Leave it always False.
ExternalHostName External IP Address of the router or FQDN. (must be the same for all regions on file)
SizeX and SizeY The region size, must be a multiple of 256, and equal. If not present will be 256m

If you want to add another region you can

  • enter another section in Regions.ini
  • create another separate .ini file in bin/Regions
  • create an old format OpenSimulator xml file (these still work with current OpenSim)
  • or use the create region command on the region console (I don't recommend this since it seems to be a bit buggy).

Here's an example where a second region has been added to Regions.ini 

[Big Fat Region]
RegionUUID = 5ce85740-6460-43d3-ba4c-29207b010072
Location = 1000,1000
InternalAddress = 0.0.0.0
InternalPort = 9000
AllowAlternatePorts = False
ExternalHostName = mymachine.something.org



[Greek Wedding]
RegionUUID = 5c445740-6460-43d3-ba4c-444444445555
Location = 1000,1001
InternalAddress = 0.0.0.0
InternalPort = 9001
AllowAlternatePorts = False
ExternalHostName = mymachine.something.org

As you can see, the Second region is named Greek Wedding and has a different UUID. It has a different location (1000,1001) and a different InternalPort (9001). Other than that, the details are the same.

To create a new UUID you can either tweak an existing one by hand (e.g. by changing one character so that the new one is in the range [0-9][A-F] or a generator can be found at uuidgen webpage. On Unix, you can also use the uuidgen command.

As well as the critical entries above, there are some additional optional ones that can change the properties of a region. These are

Attribute Description
MaxAgents The maximum number of agents that can be in the in the region at any given time. The default is 100. As of 4/22/2011 this option only exists in the current git master.
MaxPrims The maximum number of prims that the region will be listed as supporting. However, this limit is not currently enforced by OpenSimulator. Due to LL protocol constraints, the maximum limit that can be shown is 45000.
MaxPrimsPerUser Max prims per user (per parcel).Negative values will disable the check.
PhysicalPrimMax The maximum dimensions of a physical prim. This is a single number which applies to X, Y and Z co-ordinates. This will affect resizing of existing prims. Default is 10. This setting can also be used in the [Startup] section of OpenSim.ini. If the region setting exists then it will override the OpenSim.ini setting.
NonPhysicalPrimMax The maximum dimensions for a non-physical prim. This is a single number which applies to X, Y and Z co-ordinates. This will affect resizing of existing prims. Default is 256. This setting can also be used in the [Startup] section of OpenSim.ini. If the region setting exists then it will override the OpenSim.ini setting.
ClampPrimSize If true then if a viewer attempts to create a prim which has any dimension larger than the NonphysicalPrimMax, then that dimension is reduced to NonphysicalPrimMax. Default is false; This setting can also be used in the [Startup] section of OpenSim.ini. If the region setting exists then it will override the OpenSim.ini setting.
RegionType The region type as shown in the Covenant tab of the Region/Estate dialog in a standard Second Life viewer. Can be used to specify Mainland, Estate, etc. based on type of grid.
MaptileStaticUUID UUID of texture to use as a maptile for this region. Only set if you have disabled dynamic generation of the map tile from the region contents in OpenSim.ini as well: 
 MapImageModule = "MapImageModule"
 GenerateMaptiles = false
MaptileStaticFile External image files of the right size and supported formats (bmp,png,jpg in RGB 24bpp format) to use as a maptile for this region.The following things must be set in the [Map] section of OpenSim.ini: 
 MapImageModule = "MapImageModule"
 GenerateMaptiles = true

Example : MaptileStaticFile = "maptiles/UnFichier.png"

[edit] Other Tasks

[edit] Configuring Multiple Regions on a Single Server Instance

To configure multiple regions on one server (i.e. a 4x4 server), edit the Regions.ini file to include multiples of the single entry already there. Make sure the RegionUUID and InternalPort are different on each one, or it won't work. To load individual OAR files into each region, use the 'change region [regionname]' command and then 'load oar [oar-location]'.

[edit] Loading from the web

OpenSim.exe can read the region definitions from the web using the following settings : 

   [Startup]
       region_info_source = "web"
       regionload_webserver_url = "http://example.com/regions.xml";

The following format has been reported to work with OpenSimulator 0.8.* : 

   <Nini>
    <Section Name="My region Name">
      <Key Name="RegionUUID" Value="4208aa66-ce9b-4f49-a4da-06a27d95f001" />
      <Key Name="Location" Value="7000,7000" />
      <Key Name="InternalAddress" Value="0.0.0.0" />
      <Key Name="InternalPort" Value="9016" />
      <Key Name="AllowAlternatePorts" Value="False" />
      <Key Name="ExternalHostName" Value="mygrid.org" />
      <Key Name="MaxPrims" Value="15000" />
      <Key Name="MaxAgents" Value="40" />
      <Key Name="RegionType" Value="0" />
      <Key Name="SizeX" Value="256" />
      <Key Name="SizeY" Value="256" />
      <Key Name="MaptileStaticUUID" Value="00000000-0000-0000-0000-000000000000" />
    </Section>
   </Nini>

[edit] Tools

Retrieved from "http://opensimulator.org/index.php?title=Configuring_Regions&oldid=54505"
Personal tools
General
About This Wiki