Configuring Regions

= 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.

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

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]'.

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.* :

              </Section> </Nini>

= Tools =


 * A powerful region generator is available at: RegionGenerator


 * osRegionsgenerator - Regions-Generator for PHP, PHP7 Ready(inc. var regions, position).