OAR Format 0.6

From OpenSimulator

(Difference between revisions)
Jump to: navigation, search
m (Robot: Cosmetic changes)
m (Robot: Replacing 'OpenSim' to 'OpenSimulator', which is the precise name)
 
Line 32: Line 32:
 
  OpenSim/Region/Environment/Modules/World/Archiver/ArchiveConstants.cs
 
  OpenSim/Region/Environment/Modules/World/Archiver/ArchiveConstants.cs
  
in the OpenSim distribution.
+
in the OpenSimulator distribution.
  
 
=== landdata/ ===
 
=== landdata/ ===
Line 56: Line 56:
 
This contains the region settings information for the region in XML format. The filename will be the same as the region name. For example,
 
This contains the region settings information for the region in XML format. The filename will be the same as the region name. For example,
  
  OpenSim Test.xml
+
  OpenSimulator Test.xml
  
 
Here is an [[OAR format 0.2 region settings example|example of an XML region file]] (schema to follow, sometime).
 
Here is an [[OAR format 0.2 region settings example|example of an XML region file]] (schema to follow, sometime).
Line 64: Line 64:
 
This contains the terrain file for the region, stored in RAW format. The filename must end with .r32. For example,
 
This contains the terrain file for the region, stored in RAW format. The filename must end with .r32. For example,
  
  OpenSim Test.r32
+
  OpenSimulator Test.r32
  
 
= See Also =
 
= See Also =
  
* [[OpenSim Archives|How to use OpenSim Archives (OAR)]]
+
* [[OpenSim Archives|How to use OpenSimulator Archives (OAR)]]
 
* [[OAR Format 0.1]]
 
* [[OAR Format 0.1]]
 
* [[OAR Format 0.2]]
 
* [[OAR Format 0.2]]

Latest revision as of 22:46, 3 March 2012

Contents

[edit] What is the OAR 0.6 format?

[edit] Changes

OAR format 0.6 is identical to 0.2 except that the control file (archive.xml) must come first in the archive.

[edit] Detail

At the present time, a region archive is a gzipped tar file (tar.gz) in the the original unix tar format (not USTAR). This can be extracted and created with standard tools (7-zip on Windows). The structure of the archive is as follows

archive.xml
assets/
landdata/
objects/
settings/
terrains/

[edit] archive.xml

This is the archive control file. At the moment it contains only a major and minor version number, to allow compatibility with future format changes.

[edit] assets/

This directory contains all the assets in the archive. Each filename has the following format

<uuid>_<asset type>.<asset extension>

The uuid section must always be present and form a valid uuid - it is used directly as the uuid for that asset. The asset type and asset extension are used to identify the type of asset and the asset extension allows the asset to be associated with different editors on platforms such as Windows. For instance, a script will always have the asset type and extension script.lsl. A full list of asset types and extensions can be found in the file

OpenSim/Region/Environment/Modules/World/Archiver/ArchiveConstants.cs

in the OpenSimulator distribution.

[edit] landdata/

This directory contains all the parcels in the region. Information for each parcel is stored in a separate file in XML format. Each filename has the form:

 <uuid>.xml

where uuid is the uuid of the parcel.

[edit] objects/

Each individual file in here is an object in the region (where an object [linkset] can be composed of many prims). The file format used is OpenSim's XML2 format. Each filename has the following structure by default

<Object name>_<x>-<y>-<z>__<uuid>.xml

Unlike asset filenames, any component of this name can be changed without affecting any attributes of the object itself - this information is taken from the xml instead. Indeed, this file can have any name - there is no need for any of the sections to be present. An example object file name is

Primitive_154-121-062__9be68fdd-f740-4a0f-9675-dfbbb536b946.xml

[edit] settings/

This contains the region settings information for the region in XML format. The filename will be the same as the region name. For example,

OpenSimulator Test.xml

Here is an example of an XML region file (schema to follow, sometime).

[edit] terrains/

This contains the terrain file for the region, stored in RAW format. The filename must end with .r32. For example,

OpenSimulator Test.r32

[edit] See Also

Personal tools
General
About This Wiki