OpenSimulator · EN

OAR archives: backup, import and merge

Detailed commands, options checked against OpenSimulator source code and restore examples.

Understanding an OAR

An OAR holds region data (objects, terrain, parcels and optionally assets). Save it through a region console. Do not confuse it with an IAR inventory archive.

Saving a region

Normal backup including assets.

save oar /backups/MyRegion.oar

Backup omitting asset data. Referenced UUIDs still need to resolve for a full restore.

save oar --noassets /backups/MyRegion-noassets.oar

The save implementation accepts --all; check its precise implications for your version.

save oar --all /backups/MyRegion-all.oar

save oar flags

OptionMeaningCaution
--noassetsOmit asset dataRestore depends on asset availability
-h, --home=URLAttach a home service URLUse only when applicable
--publishClear ownership information while exportingChanges exported metadata
--perm=CTMPermission-based export filterCan exclude objects
--allRequest extended export per implementationVerify release-specific behavior

Restoring an archive

WARNING: a non-merge restore can replace objects, terrain or parcels in the target region. Back up first and test on a disposable region.

Basic restore to the selected region.

load oar /backups/MyRegion.oar

Merges archive content into an existing region rather than a full replacement.

load oar --merge /backups/MyRegion.oar

Merge with explicit handling of terrain and parcels.

load oar --merge --merge-terrain --merge-parcels /backups/MyRegion.oar

Skip importing assets from the archive; those assets must already be available.

load oar --skip-assets /backups/MyRegion.oar

Offsets imported objects by 256 m on X. Check bounds and placement before the final import.

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

Rotates imported content (degrees). Test on an isolated region.

load oar --merge --rotation 90 /backups/MyRegion.oar

load oar flags

OptionMeaningCaution
--merge, -mMerge rather than replaceCheck duplicates and existing objects
--mergeReplaceObjectsMerge with matching object replacementMay overwrite existing objects
--skip-assets, -sDo not import assets from the OARDifferent from --noassets during save
--force-assetsForce processing of archived assetsAssess impact before use
--merge-terrainInclude terrain during mergeMay change terrain heights
--merge-parcelsInclude parcels during mergeMay alter existing parcels
--no-objectsSkip object restorationUseful for selective restores
--displacement="<x,y,z>"Offset imported positionsValues in metres
--rotation=DEGREESApply a rotationFrom -360 to 360 degrees
--bounding-origin="<x,y,z>"Origin of import boundsAdvanced: test before production
--bounding-size="<x,y,z>"Size of import boundsAdvanced: test before production
--default-user=NAMEFallback owner during importPermission-sensitive
--debug, -dEnable debug messagesMay produce extra logs

Example: restoring into a varregion

Create a varregion with the required SizeX/SizeY first, back up the target region, then use merge and displacement only after calculating the target position. An OAR does not automatically change the target region SizeX and SizeY.

Illustrative import of a region archive into a larger varregion, within its bounds.

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

Where to find OAR archives?

The OAR Shop is a third-party website offering OpenSimulator region archives, including a free OAR library and a marketplace for paid creations. Listings may include region size, previews, creator, source and available license information. Public free OAR archives can be browsed and downloaded without an account.

Before downloading or importing: verify provenance and permitted use or redistribution. “Free” does not necessarily mean “public domain”. Check region size, compatibility and assets; test in a disposable region after backing up the destination. Do not assume third-party scripts or content are trustworthy.

Commands and sources

The flags above come from the command parser in the OpenSimulator fork’s ArchiverModule.cs. Placement examples must be validated for the target terrain.

ArchiverModule.cs · OpenSimulator Archives Wiki