OAR Format 0.6
From OpenSimulator
m |
m (Robot: Replacing 'OpenSim' to 'OpenSimulator', which is the precise name) |
||
| (4 intermediate revisions by 2 users not shown) | |||
| Line 1: | Line 1: | ||
| − | {{ | + | {{Quicklinks}} |
| − | + | ||
| − | + | = What is the OAR 0.6 format? = | |
| − | + | ||
| − | =What is the OAR 0.6 format?= | + | |
== Changes == | == Changes == | ||
| Line 12: | Line 9: | ||
== Detail == | == Detail == | ||
| − | At the present time, a region archive is a gzipped tar file (tar.gz) in the the original unix tar format (not USTAR). | + | 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 ([http://www.7-zip.org/ 7-zip] on Windows). The structure of the archive is as follows |
archive.xml | archive.xml | ||
| Line 23: | Line 20: | ||
=== archive.xml === | === archive.xml === | ||
| − | This is the archive control file. | + | 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. |
=== assets/ === | === assets/ === | ||
| − | This directory contains all the assets in the archive. | + | This directory contains all the assets in the archive. Each filename has the following format |
<uuid>_<asset type>.<asset extension> | <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 ''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 | OpenSim/Region/Environment/Modules/World/Archiver/ArchiveConstants.cs | ||
| − | in the | + | in the OpenSimulator distribution. |
=== landdata/ === | === landdata/ === | ||
| Line 47: | Line 44: | ||
=== objects/ === | === objects/ === | ||
| − | Each individual file in here is an object in the region (where an object [linkset] can be composed of many prims). | + | 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 | <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. | + | 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 | Primitive_154-121-062__9be68fdd-f740-4a0f-9675-dfbbb536b946.xml | ||
| Line 57: | Line 54: | ||
=== settings/ === | === settings/ === | ||
| − | This contains the region settings information for the region in XML format. | + | 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 [[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 65: | Line 62: | ||
=== terrains/ === | === terrains/ === | ||
| − | This contains the terrain file for the region, stored in RAW format. | + | This contains the terrain file for the region, stored in RAW format. The filename must end with .r32. For example, |
| − | + | OpenSimulator Test.r32 | |
= See Also = | = See Also = | ||
| − | * [[ | + | * [[OpenSim Archives|How to use OpenSimulator Archives (OAR)]] |
| − | + | * [[OAR Format 0.1]] | |
| − | + | * [[OAR Format 0.2]] | |
| − | * [[ | + | |
| − | * [[ | + | |
[[Category:Users]] | [[Category:Users]] | ||
[[Category:Support]] | [[Category:Support]] | ||
| − | [[Category:Tech Reference]] | + | [[Category:Tech Reference]] |
[[Category:Help]] | [[Category:Help]] | ||
[[Category:Configuration]] | [[Category:Configuration]] | ||
| − | [[Category: | + | [[Category:Getting Started]] |
[[Category:Development]] | [[Category:Development]] | ||
Latest revision as of 22:46, 3 March 2012
 |
Languages: |
|
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
