Configuring Regions
From OpenSimulator
(Difference between revisions)
Tonyguards (Talk | contribs) |
|||
| (25 intermediate revisions by 8 users not shown) | |||
| Line 1: | Line 1: | ||
| − | {{ | + | {{Quicklinks|Configuring_Regions}} |
| − | = OpenSimulator 0. | + | = 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. | 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. | ||
| Line 12: | Line 12: | ||
InternalPort = 9000 | InternalPort = 9000 | ||
AllowAlternatePorts = False | AllowAlternatePorts = False | ||
| − | ExternalHostName = | + | 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]]. | 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]]. | ||
| Line 40: | Line 42: | ||
|- | |- | ||
| ExternalHostName | | ExternalHostName | ||
| − | | External IP Address of the router or FQDN. | + | | 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 | ||
|} | |} | ||
| Line 58: | Line 63: | ||
InternalPort = 9000 | InternalPort = 9000 | ||
AllowAlternatePorts = False | AllowAlternatePorts = False | ||
| − | ExternalHostName = | + | ExternalHostName = mymachine.something.org |
| − | + | ||
| + | |||
[Greek Wedding] | [Greek Wedding] | ||
RegionUUID = 5c445740-6460-43d3-ba4c-444444445555 | RegionUUID = 5c445740-6460-43d3-ba4c-444444445555 | ||
| Line 66: | Line 72: | ||
InternalPort = 9001 | InternalPort = 9001 | ||
AllowAlternatePorts = False | AllowAlternatePorts = False | ||
| − | ExternalHostName = | + | 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 | + | 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 | + | 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 | + | 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%" | {| cellspacing="0" cellpadding="5" border="1" align="center" class="sortable" width="90%" | ||
| Line 84: | Line 90: | ||
| MaxPrims | | 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. | | 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 | | 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. | | 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. | | 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. | ||
|- | |- | ||
| Line 95: | Line 104: | ||
|- | |- | ||
| RegionType | | RegionType | ||
| − | | The region type as shown in the Covenant tab of the Region/Estate dialog in a standard Second Life viewer. | + | | 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 == | == Other Tasks == | ||
| Line 108: | Line 124: | ||
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]'. | 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]'. | ||
| − | = | + | === 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> | ||
| − | + | = Tools = | |
| − | A powerful region generator is available at: [[RegionGenerator]] | + | * A powerful region generator is available at: [[RegionGenerator]] |
[[Category:Configuration]] | [[Category:Configuration]] | ||
Latest revision as of 10:43, 28 July 2024
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
- A powerful region generator is available at: RegionGenerator
