OAR Format 0.7
From OpenSimulator
(→assets/) |
m (Robot: Cosmetic changes) |
||
| Line 2: | Line 2: | ||
<br /> | <br /> | ||
| − | =What is the OAR 0.7 format?= | + | = What is the OAR 0.7 format? = |
== Changes == | == Changes == | ||
| − | This format is currently in the development version of OpenSim only. | + | This format is currently in the development version of OpenSim only. Please do not rely on it as the details are subject to change without notice. |
OAR format 0.7 is identical to 0.6 except that the control file (archive.xml) now includes an <assets_included> element (see below). | OAR format 0.7 is identical to 0.6 except that the control file (archive.xml) now includes an <assets_included> element (see below). | ||
| Line 12: | Line 12: | ||
== 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 23: | ||
=== archive.xml === | === archive.xml === | ||
| − | This is the archive control file. | + | This is the archive control file. It contains a major and minor version number, to allow compatibility with future format changes. |
| − | It also contains an <assets_included> element which can have the contents True or False. | + | It also contains an <assets_included> element which can have the contents True or False. If the string is True, then the OAR was saved with assets included. If the switch is False, then the OAR was saved with the --noassets option. |
=== 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 | ||
| Line 50: | Line 50: | ||
=== 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 62: | Line 62: | ||
=== 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, |
OpenSim Test.xml | OpenSim Test.xml | ||
| Line 70: | Line 70: | ||
=== 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, |
OpenSim Test.r32 | OpenSim Test.r32 | ||
| Line 76: | Line 76: | ||
= See Also = | = See Also = | ||
| − | * [[ | + | * [[OpenSim Archives|How to use OpenSim 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]] | ||
Revision as of 19:39, 3 March 2012
 |
Languages: |
|
Contents |
What is the OAR 0.7 format?
Changes
This format is currently in the development version of OpenSim only. Please do not rely on it as the details are subject to change without notice.
OAR format 0.7 is identical to 0.6 except that the control file (archive.xml) now includes an <assets_included> element (see below).
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/
archive.xml
This is the archive control file. It contains a major and minor version number, to allow compatibility with future format changes. It also contains an <assets_included> element which can have the contents True or False. If the string is True, then the OAR was saved with assets included. If the switch is False, then the OAR was saved with the --noassets option.
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 OpenSim distribution.
In the future, the format of these files will be described in Asset Formats.
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.
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
The actual format is described (currently very sketchily) in Asset Formats.
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,
OpenSim Test.xml
Here is an example of an XML region file (schema to follow, sometime).
terrains/
This contains the terrain file for the region, stored in RAW format. The filename must end with .r32. For example,
OpenSim Test.r32
