OpenSimulator · EN

Regions and varregions: technical guide

Regions.ini, location, dimensions, ports, connectivity and archive imports.

Region versus simulator

A region is a virtual world area, while a simulator process can host one or more regions. Region files describe each area; OpenSim.ini governs simulator behavior.

Region file structure

A file under bin/Regions/ contains sections named after regions. Each section identifies a region, its position, networking and optional size. Values must match your network topology.

Example: adapt paths and values for your installation.

[Example Region]
RegionUUID = 00000000-0000-0000-0000-000000000001
Location = 1000,1000
InternalAddress = 0.0.0.0
InternalPort = 9000
ExternalHostName = SYSTEMIP
SizeX = 512
SizeY = 512

RegionUUID

The UUID uniquely identifies the region. Generate a new value instead of cloning an existing region ID. Duplicates may interfere with registration.

Location

Location defines the region's grid position. Avoid overlaps with other regions, especially when using large varregions.

InternalAddress and InternalPort

InternalAddress selects the local listening interface and InternalPort sets the port. Regions sharing a network namespace and interface cannot bind the same port at the same time.

ExternalHostName

This value must be reachable by relevant clients. Incorrect hostnames or DNS can break connections or teleports; verify DNS, NAT and firewall.

SizeX, SizeY and varregion size

Your fork's RegionInfo.cs reads SizeX and SizeY, validates sizes and multiples of 256, and enforces square regions in that implementation. Check the coded maximum rather than assuming all sizes are valid.

Size and server workload

Moving from 256×256 to 512×512 increases available area, but CPU consumption does not necessarily scale by the same factor. Objects, scripts, collisions and avatars still dominate workload.

Restore a 256 m OAR into a varregion

Create the target region with intended size first. Back up its existing terrain. Test a merge with an offset to place archived objects in the desired quadrant. Check terrain and parcels separately.

Example: adapt paths and values for your installation.

load oar --merge --displacement "<256,0,0>" /backups/source256.oar

Displacement and rotation

--displacement takes a 3D vector such as <256,0,0>. --rotation takes degrees. Imported objects must remain inside target region bounds after transformation.

Example: adapt paths and values for your installation.

load oar --merge --rotation 90 --displacement "<256,256,0>" /backups/source.oar

Why a restore may be incomplete

The result depends on archived content, available assets, permissions and version. Region configuration in Regions.ini is not automatically recreated by an OAR. Inspect console and logs.

Validation checklist

After creation or import, verify startup, map visibility, teleport, terrain, parcels, objects, scripts and assets. Keep a recovery OAR and operation logs.

References and source code