OpenSimulator - User contributions [en]

Upgrading

2015-04-20T16:05:24Z

Reibling: /* Examples */

{{Quicklinks}}
<br />

= Updating your version of OpenSimulator =

Upgrading your version of OpenSimulator involves 2 major steps

1. Updating your existing data for the new version of OpenSimulator.
2. Updating the config files for the new version of OpenSimulator.

== Updating your existing data ==

The first step is very easy. OpenSimulator has a data migration system which will automatically update your old database schema and data for use with the new version of OpenSimulator. This will be valid for many past versions of OpenSimulator (currently all the way back to OpenSimulator 0.6.9 and quite possibly before).

Naturally, we very strongly recommend that you make a backup of your old database first, but the upgrade process almost always occurs without a hitch. However, one could always suffer a power cut or other major computer failure during the ugprade.

If you're using SQLite, then you will also need to copy over the database files since these are in the OpenSimulator bin directory. These will be all the files ending with .db (e.g. Asset.db, inventory.db).

Performing this upgrade means configuring your new OpenSimulator version to access your existing database. This brings us onto the next step.

== Updating your config files ==

This step is a little more involved. We don't recommend that you simply copy over your existing config files to the new OpenSimulator installation. Although this will often work, sometimes it's quite possible to miss new configuration settings which end up causing subtle and unexplained problems.

Instead, we strongly recommend that you look through the new config files and copy over the settings that apply to both the new and old config.

This applies to both the main configuration files (e.g. OpenSim.ini and config-include/*.ini) and any region configuration files.

SEE Discussion at [[Talk:Upgrading]] for examples of How-To Back Up & Restore your system PRIOR to ANY Migration or Upgrade!

== Examples ==

'''METHOD 1: If Using SQLite in StandAlone Mode'''

1. Build the latest version from source (or download the binaries)

2. Put this new installation in a new folder

3. Copy the following files from the old \bin to the new \bin
- All *.db files
- The opensim.ini file

4. Look through the following configuration files and copy over your changed settings.
- The opensim.ini file
- The bin/config-include INI files
- The bin/Regions XML files
- The bin/estate_settings.xml (if it has been amended)

5. Launch the new opensim.exe

'''METHOD 2: If Using MySQL in StandAlone Mode'''

1. Build the latest version from source (or download the binaries)

2. Put this new installation in a new folder

3. Look through the following configuration files and copy over your changed settings.
- The opensim.ini file
- The bin/Regions XML files
- The bin/config-include INI files
- The bin/estate_settings.xml (if it has been amended)

4. Launch the new opensim.exe

TODO: Need to write example/instructions for migrating ROBUST. This is actually a lot simpler - one just needs to copy over settings in Robust.ini as appropriate.

= Changing the database used by OpenSimulator =

Since SQLite is our default database, there often comes a time when people outgrow it and want to move on to another database backend (usually MySQL). There is a script on the forge at [http://forge.opensimulator.org/gf/project/sqlite2mysql/] which should be able to do the conversion. If it's out of date then just give the author/s a nudge (or patch it!)

An alternative method is to change to each region (change-region) before backing up their contents to a separate OpenSimulator Region Archive (OAR) for each region. Then change the database backend and then reload the OARs in each region separately. The disadvantage of this is that it's a little laborious if you have many regions.

You can use the "command-script" feature of OpenSim.exe to semi-automate this. E.g., create a file in your "bin" directory, called something like "dobackup", which contains the necessary commands, for example:

change-region My Island 1
save-oar MI1
change-region My Island 2
save-oar MI2
change-region Another Region
save-oar AR
change-region root

This can be run from OpenSim.exe by typing "command-script" followed by the name you gave the script (eg "dobackup"). Note that this will overwrite the previous backup of the same name.

Note that using a save and reload via the OAR mechanism would not normally migrate your avatar inventories (you would need to rez everything out to the region, convert the data base, and then derez them again to your inventory).

Upgrading

2015-04-20T16:03:59Z

Reibling: /* Examples */

{{Quicklinks}}
<br />

= Updating your version of OpenSimulator =

Upgrading your version of OpenSimulator involves 2 major steps

1. Updating your existing data for the new version of OpenSimulator.
2. Updating the config files for the new version of OpenSimulator.

== Updating your existing data ==

The first step is very easy. OpenSimulator has a data migration system which will automatically update your old database schema and data for use with the new version of OpenSimulator. This will be valid for many past versions of OpenSimulator (currently all the way back to OpenSimulator 0.6.9 and quite possibly before).

Naturally, we very strongly recommend that you make a backup of your old database first, but the upgrade process almost always occurs without a hitch. However, one could always suffer a power cut or other major computer failure during the ugprade.

If you're using SQLite, then you will also need to copy over the database files since these are in the OpenSimulator bin directory. These will be all the files ending with .db (e.g. Asset.db, inventory.db).

Performing this upgrade means configuring your new OpenSimulator version to access your existing database. This brings us onto the next step.

== Updating your config files ==

This step is a little more involved. We don't recommend that you simply copy over your existing config files to the new OpenSimulator installation. Although this will often work, sometimes it's quite possible to miss new configuration settings which end up causing subtle and unexplained problems.

Instead, we strongly recommend that you look through the new config files and copy over the settings that apply to both the new and old config.

This applies to both the main configuration files (e.g. OpenSim.ini and config-include/*.ini) and any region configuration files.

SEE Discussion at [[Talk:Upgrading]] for examples of How-To Back Up & Restore your system PRIOR to ANY Migration or Upgrade!

== Examples ==

'''METHOD 1: If Using SQLite in StandAlone Mode'''

1. Build the latest version from source (or download the binaries)

2. Put this new installation in a new folder

3. Copy the following files from the old \bin to the new \bin
- All *.db files
- The opensim.ini file

4. Look through the following configuration files and copy over your changed settings.
- The opensim.ini file
- The bin/config-include INI files
- The bin/Regions XML files
- The bin/estate_settings.xml (if it has been amended)

5. Launch the new opensim.exe

'''METHOD 2: If Using MySQL in StandAlone Mode'''

1. Build the latest version from source (or download the binaries)

2. Put this new installation in a new folder

3. Look through the following configuration files and copy over your changed settings.
- The opensim.ini file
- The bin/regions XML files
- The bin/config-include INI files
- The bin/estate_settings.xml (if it has been amended)

4. Launch the new opensim.exe

TODO: Need to write example/instructions for migrating ROBUST. This is actually a lot simpler - one just needs to copy over settings in Robust.ini as appropriate.

= Changing the database used by OpenSimulator =

Since SQLite is our default database, there often comes a time when people outgrow it and want to move on to another database backend (usually MySQL). There is a script on the forge at [http://forge.opensimulator.org/gf/project/sqlite2mysql/] which should be able to do the conversion. If it's out of date then just give the author/s a nudge (or patch it!)

An alternative method is to change to each region (change-region) before backing up their contents to a separate OpenSimulator Region Archive (OAR) for each region. Then change the database backend and then reload the OARs in each region separately. The disadvantage of this is that it's a little laborious if you have many regions.

You can use the "command-script" feature of OpenSim.exe to semi-automate this. E.g., create a file in your "bin" directory, called something like "dobackup", which contains the necessary commands, for example:

change-region My Island 1
save-oar MI1
change-region My Island 2
save-oar MI2
change-region Another Region
save-oar AR
change-region root

This can be run from OpenSim.exe by typing "command-script" followed by the name you gave the script (eg "dobackup"). Note that this will overwrite the previous backup of the same name.

Note that using a save and reload via the OAR mechanism would not normally migrate your avatar inventories (you would need to rez everything out to the region, convert the data base, and then derez them again to your inventory).

Varregion

2014-03-07T19:14:08Z

Reibling: /* Tips on Migrating Existing Sims to VarRegions */

'''Varregion'''

__TOC__
"Varregion" is a feature of OpenSimulator that enables region sizes larger than 256x256. The region is just larger so it acts like a regular region but with borders farther apart.

The implementation uses the [http://aurora-sim.org Aurora] large region protocol extensions so the existing [http://firestormviewer.org Firestorm] and [http://singularityviewer.org Singularity] Aurora support will now work for OpenSimulator.

This is different from the older [[Megaregions]] large region feature which does not require extra viewer support (above that already implemented by Linden Lab) but which relies on a number of fragile hacks to make a viewer work in a way that Linden Lab never supported. Megaregions also contain a number of extant simulator-side bugs.

A growing list of protocol changes to implement "varregion" is at [[varregion/Protocol|Varregion Protocol]].

==Restrictions==
Some restrictions apply:
* The dimensions must be a multiple of 256 and less than or equal to 8192.
* The dimensions must be square (as of 20131104)
* Adjacent regions must be the same size. For instance, you can have multiple 512x512 regions adjacent (and see into the other region and border cross). There seems to be a viewer problem where, if regions of different size are within view distance, crashes can happen. Consider having regions of only the same size 'in view'. Remember that the region coordinates are specified in 256m region count so a group of four 512x512 regions would be specified at 8000/8000, 8000/8002, 8002/8000, and 8002/8002, for instance.
* You must use BulletSim (as of 20131104, ODE has not been modified for varregions)
** You must use BulletSim's height map terrain implementation. As of 20140128, BulletSim has been modified to force heightmap terrain implementation if region size is greater than 256 on any side. The setting can be forced by adding to your INI files:
<pre>
[BulletSim]
TerrainImplementation = 0
</pre>

==Configuration==
The size is be specified in the <tt>Region.ini</tt> file:
<pre>
[MyRegionName]
RegionUUID = 95ec77ec-58c5-4ce2-9ff3-b6d1900d78a2
Location = 1000,1000
SizeX = 1024
SizeY = 1024
InternalAddress = 0.0.0.0
InternalPort = 9200
AllowAlternatePorts = False
ExternalHostName = SYSTEMIP
</pre>
If size is not specified, it will, of course, default to the legacy size of 256.

If the given dimensions do not fit the restrictions, acceptable values are computed and warning and error messages are output into the log.

If converting from a mega-region, remember to set "<tt>CombineContiguousRegions = false</tt>".

for llRezObject to work beyond 256m set "ScriptDistanceLimitFactor = 52.0" (for 512mx512m) in the [Xengine] section of OpenSim.ini.

The terrain heightmap is stored in the database as an array of 'shorts' (two bytes) so, if you have a very large region you might need to set the database maximum size to a larger value. For instance, a 2816x2816 region (11x11 legacy regions) turns into a 56 megabyte heightmap and, for MySQL, you would need to set <tt>max_allowed_packet</tt> to something like 64M.

==Loading Terrain==
The usual terrain console commands work with varregions. If you have set up a larger region, you can load BMP/RAW/PNG heightmap files of the dimensions of the region and fill the whole region. For instance, a 1024x1024 region terrain would be completely initialized by "terrain load 1024.bmp" if '1024.bmp is a 1024x1024 bitmap.

==Varregions and OAR Files==
The objects and terrain are stored in an OAR file as if it was one region. That is, if you save a 1024x1024 region in an OAR file, you can later restore the objects and terrain into a 1024x1024 sized region. If you load an OAR file from a smaller region into a larger region, the unspecified terrain space will default to 25m.

To make conversion to varregions easier, 'load oar' now has a '--displacement "<x,y,z>"' parameter. This displaces all of the objects and the terrain from the oar file when loading them into the new region. For instance, say you have four
OAR files from four adjacent 256x256 regions (oar00.oar, oar01.oar, oar10.oar, and oar11.oar). You create a new 512x512 varregion named 'bigregion'. The following commands place the four regions of objects, terrains and parcels
into the new larger region:

<pre>
change region bigregion
load oar oar00.oar
load oar oar01.oar --displacement "<0,256,0>" --merge --forceterrain --forceparcel
load oar oar10.oar --displacement "<256,0,0>" --merge --forceterrain --forceparcel
load oar oar11.oar --displacement "<256,256,0>" --merge --forceterrain --forceparcel
</pre>

Note the new "--forceterrain" and "--forceparcel" parameters. "--merge", used by itself, is for merging together the objects from multiple OARs. Merging also suppresses the loading of terrain and parcel data which is just what you want when merging objects. But, if loading multiple OARs to create a new, larger region, the terrain and parcel information must be loaded. Thus the new parameters.

==Things Known to be Broken==
* There is some problem with teleporting in an out of larger region. It works for some configurations and not others.
* While adjacent regions are usually viewable, sometimes they are not. They appear when you cross over into the region.

==Implementation Discussion==
Since this will be a major change to OpenSimulator that touches a
lot of different parts, subsequent posts, will discuss the changes I'm making.

===TerrainData===
One major problem is passing the terrain data from the region to the
protocol stack. The existing implementation passed an array of floats
that were presumed to be a 256x256 array of region terrain heights.
The
<tt>TerrainChannel</tt>
class is an attempt to hide the terrain implementation
from
<tt>TerrainModule</tt>
.
<tt>TerrainChannel</tt>
can't be passed into the protocol
stack (LLClientView) because
<tt>TerrainChannel</tt>
is defined as part of
<tt>OpenSim.Region.Framework</tt>
which is not visible to the protocol code.

My solution is to create the
<tt>TerrainData</tt>
class in
<tt>OpenSim.Framework.</tt>
<tt>TerrainData</tt>
just wraps the data structure for the terrain and additionally has
the attributes giving X and Y size.

I didn't want to change the signature of IClientAPI since so many external modules
rely on it.
It should be changed to pass <tt>TerrainData</tt> rather than a <tt>float[]</tt>.
I decided to not change IClientAPI but rather have <tt>LLClientView</tt> ignore
the passed array and instead reach back into the associated scene and fetch the
<tt>TerrainData</tt> instance.

There is one subclass of <tt>TerrainData</tt>: <tt>HeightmapTerrainData</tt> which keeps the terrain as a compressed heightmap. The height of each point is stored as a <tt>short</tt> which is <tt>height * compressionFactor</tt> where <tt>compressionFactor</tt> is usually "100". This creates a compact storage of the terrain heights with two decimal points of resolution.

The LLLP ("Linden Lab Legacy Protocol") sends terrain height data in
compressed "patches" of 16x16 areas of the terrain
height. This is a protocol feature that is implemented in <tt>TerrainChannel</tt>.
I feel that underlying protocol optimizations shouldn't appear up the
stack so, in creating <tt>TerrainData</tt>, I tried to hide terrain patches.
I mean, someday terrain will be generalized meshes. Right?

===Terrain in the Database===
Previously, terrain height maps were saved in the database as a blob of 256x256 doubles. To have different region sizes, that format had to change. There is an existing database field <tt>revision</tt> that stored the time the terrain was saved. This revision information wasn't used for anything so this field was co-opted to contain a revision code for the height field blob.

There are three forms for the height map blob: legacy, compressed2D and regular2D. "legacy" is, of course, the previous 256x256 collections of doubles. "regular2D" contains the X, Y dimensions and enough floats for that area's heights. "compressed2D" contains the X,Y and compressionFactor followed by enough shorts for the height map.

The database readers and writers default to the legacy format and, if the region happens to have the dimensions 256x256, it is stored using the legacy format. This is an attempt to keep downward compatibility.

All of the database modules (MySQL, SQLite, MSSQL and PSQL) have been modified to store terrain this new way.

===Sensing Border Crossing===
Most of the ‘move to new region’ code is based on checking boundaries. There is much code related to computing if an object or avatar has crossed a region boundary and then computing the address of the next region from same. Introducing variable sized regions messes a lot of this computation up. That is, the code doing the arithmetic usually assumes it knows the address of the next region based on a known region size and them can compute the location of the next region based on that. With varregions those assumptions no longer hold. Varregion implementation means that the computation of region base locations and border locations moves to the GridService who is the entity who really knows the size of all the regions and what is adjacent to what.

The realization that location to region computation is really a GridService operation lead me to totally rip apart the grid boundary checking code and replace it with two functions: <tt>Scene.PositionIsInCurrentRegion(Vector3 pos)</tt> and then <tt>EntityTransferModule.GetRegionContainingWorldLocation(double X, double Y)</tt>. The former function tests to see if the object/avatar has moved out of the current region and the latter gets the region moved into. (Side note: <tt>GetRegionContainingWorldLocation</tt> should really be a function on <tt>IGridService</tt> but that exercise is left for future hacking).

These changes leave all the 'border' code in limbo -- the generation of the border lists is still there but it is not being used. This should eventually be cleaned up. Also, the computation of neighbor regions is scattered around with routines on <tt>IGridService</tt>, in <tt>EntityTransferModule</tt> and a bunch of bookkeeping in <tt>Scene</tt>. This too should be cleaned up.

==Implementation Notes==

As of January 27, 2014, varregion is a feature of the 'master' repository branch.

===Stuff to Work On===
What follows are notes I am making as things that might need work are found in OpenSimulator.

* Consolidate neighbor region computation code (Scene, EntityTransferModule and IGridService all have 'get neighbor' code)
* Clean up/eliminate border list creation and use code
* Region handles are world coords and also the base of the region
** verify that everyone who converts coords to handle (Util.RegionWorldLocToHandle) is supplying the base of the region. (mostly done)
* ITerrainLoader implementations (mostly done)
** How to handle tiles.
** How to handle large regions sizes.
** Terrain/FileLoaders/*.cs all return an ITerrainChannel
** Need to fix all the file reader/writers
** FileLoaders/LLRAW.cs has several "256"s rather than constant references
* Teleporting: should be able to teleport to anywhere in a large region
** "MyRegion/550/687/40"
* HG code needs to allow addresses anywhere into large regions
* When GridService return adjacent regions, make sure it does the right thing for large regions
* Consider moving terrain XML serialization into TerrainData
* Consider removing all instances of TerrainChannel.GetFloatsSerialized()
** Replace with passing around TerrainData
* Code in EntityTransferModule that checks distance to decide if to make new connection
** search for references to 'Constants.RegionSize'
** Consider removing the distance code and replacing with call to grid service
* WorldMapModule.cs does a lot of arithmetic depending on constants that are really Contants.RegionSize
* Util.IsOutsideView uses Constants.RegionSize. Is use in ScenePresence a problem?
** Used in ScenePresence.AdjustKnownSeeds()
** Is this another instance like EntityTransferModule that needs to goto the grid service?
* Move all the short[] heightmap representation stuff into TerrainData.cs (partially done)
** Is it possible to move all the patch stuff out of TerrainModule/TerrainChannel?
** Clean up the use of m_revert. It looks like it is not saved after terrain is modified.
* Need to look through RegionCombinerModule.cs and see what safety checks are needed
** Maybe just prevent combination if not legacy region size
* In LSL_Api.cs, llEdgeOfWorld() does some neighbor computation. Check for ok'ness.
* LandManagementModule.SendParcelOverlay sends land sale/ownership info for 4x4m areas
** Looks like it expects to send exactly one 1024 byte block (for the 256x256 legacy region
** Check viewer code for what will happen for larger regions
* The code for cloud and wind needs to be enhanced for larger regions
** New overlay types added
* LLClientView.SendMapBlockSplit() needs to have region size to send with the map info
* Region/Framework/Scenes/Tests/BorderTests.cs might need work if non-standard regions are tested
* Verify terrain tests still work (for 256m regions)
* Region coords are sometimes 'int' and sometimes 'uint' with conversions EVERYWHERE
** pass over everything and convert region coordinates it 'uint's
** consider creating structures for world and region coordinates so there can be compile time checking

====Viewer====
* LLSurface is wired to expect adjacent regions of same size
* Terrain surface image is sized with a 'static": " static S32 sTextureSize; // Size of the surface texture"
* From FreeNode:#SingularityViewer 20131125:
<pre>
<Aleric> radams1, SianaGearz, frnic : I couldn't help myself doing a profile anyway.. The reason the viewer is slow is because it's busy "drawing" the terrain. "drawing" between quotes because my guess is that it is trying to draw ALL terrain and then clip that afterwards to the frustrum...
<Aleric> So, this could be greatly improved by disregarding terrain way way earlier when it is beyond the drawing range anyway.
<SianaGearz> OK
<Aleric> I disabled all rendering, even added a 'return' in terrain render
<Aleric> but.. no improvement of FPS!
<frnic> oops
<Aleric> LLSurfacePatch::updateVisibility() is still eating a lot of cpu.
<Aleric> LLSurface::updatePatchVisibilities does 97% of the calls to LLSurfacePatch::updateVisibility
<Aleric> which then spends most of it's time calling LLCamera::AABBInFrustumNoFarClip
</pre>
* Singularity commit for varregion: https://github.com/singularity-viewer/SingularityViewer/commit/ad8ea07a

==Testing==
* Terrain/parcel operations
** Default 256 standalone region
*** Clean database. Start single standalone region. Verify 'pimple' region. Verify one parcel. Flatten region.
*** Create parcels adjacent to each edge and standalone in middle. Change names of each parcel and verify. Restart simulator and verify parcels exist and work correctly.
*** Save five parcel region as OAR. Clear database. Restart region. Load oar. Verify 5 parcels of correct location, name and features.
** Adjacent 256 standalone regions
** 768x768 standalone region
** Changing land from 256 to 768
* Teleporting
* Adjacency
* Hypergrid

==Tips on Migrating Existing Sims to VarRegions==
* When you start the sim, you have to have either no regions nearby, or identical sized regions. otherwise, it locks your movement to the size of the smallest region
* When you load your oars, it's like Aurora sim. You need to load them by displacement first, load each one in place to get the terrains.
* When you merge, you lose the terrain.
* The second round, you reload each oar, this time with merge to load the objects.
* If you don't use merge, you lose all the objects with each oar load.
* When you load your oars, in format "<0,0,0>" the first number is east/west, or x, the second number is north/south, or y, and the third number is up or down, or z.
* The location must be in increments of 256.
* Using ROBUST for xbakes takes a significant load off the server; textures load quickly

Varregion

2014-03-07T18:56:18Z

Reibling: /* Tips on Migrating Existing Sims to VarRegions */

'''Varregion'''

__TOC__
"Varregion" is a feature of OpenSimulator that enables region sizes larger than 256x256. The region is just larger so it acts like a regular region but with borders farther apart.

The implementation uses the [http://aurora-sim.org Aurora] large region protocol extensions so the existing [http://firestormviewer.org Firestorm] and [http://singularityviewer.org Singularity] Aurora support will now work for OpenSimulator.

This is different from the older [[Megaregions]] large region feature which does not require extra viewer support (above that already implemented by Linden Lab) but which relies on a number of fragile hacks to make a viewer work in a way that Linden Lab never supported. Megaregions also contain a number of extant simulator-side bugs.

A growing list of protocol changes to implement "varregion" is at [[varregion/Protocol|Varregion Protocol]].

==Restrictions==
Some restrictions apply:
* The dimensions must be a multiple of 256 and less than or equal to 8192.
* The dimensions must be square (as of 20131104)
* Adjacent regions must be the same size. For instance, you can have multiple 512x512 regions adjacent (and see into the other region and border cross). There seems to be a viewer problem where, if regions of different size are within view distance, crashes can happen. Consider having regions of only the same size 'in view'. Remember that the region coordinates are specified in 256m region count so a group of four 512x512 regions would be specified at 8000/8000, 8000/8002, 8002/8000, and 8002/8002, for instance.
* You must use BulletSim (as of 20131104, ODE has not been modified for varregions)
** You must use BulletSim's height map terrain implementation. As of 20140128, BulletSim has been modified to force heightmap terrain implementation if region size is greater than 256 on any side. The setting can be forced by adding to your INI files:
<pre>
[BulletSim]
TerrainImplementation = 0
</pre>

==Configuration==
The size is be specified in the <tt>Region.ini</tt> file:
<pre>
[MyRegionName]
RegionUUID = 95ec77ec-58c5-4ce2-9ff3-b6d1900d78a2
Location = 1000,1000
SizeX = 1024
SizeY = 1024
InternalAddress = 0.0.0.0
InternalPort = 9200
AllowAlternatePorts = False
ExternalHostName = SYSTEMIP
</pre>
If size is not specified, it will, of course, default to the legacy size of 256.

If the given dimensions do not fit the restrictions, acceptable values are computed and warning and error messages are output into the log.

If converting from a mega-region, remember to set "<tt>CombineContiguousRegions = false</tt>".

for llRezObject to work beyond 256m set "ScriptDistanceLimitFactor = 52.0" (for 512mx512m) in the [Xengine] section of OpenSim.ini.

The terrain heightmap is stored in the database as an array of 'shorts' (two bytes) so, if you have a very large region you might need to set the database maximum size to a larger value. For instance, a 2816x2816 region (11x11 legacy regions) turns into a 56 megabyte heightmap and, for MySQL, you would need to set <tt>max_allowed_packet</tt> to something like 64M.

==Loading Terrain==
The usual terrain console commands work with varregions. If you have set up a larger region, you can load BMP/RAW/PNG heightmap files of the dimensions of the region and fill the whole region. For instance, a 1024x1024 region terrain would be completely initialized by "terrain load 1024.bmp" if '1024.bmp is a 1024x1024 bitmap.

==Varregions and OAR Files==
The objects and terrain are stored in an OAR file as if it was one region. That is, if you save a 1024x1024 region in an OAR file, you can later restore the objects and terrain into a 1024x1024 sized region. If you load an OAR file from a smaller region into a larger region, the unspecified terrain space will default to 25m.

To make conversion to varregions easier, 'load oar' now has a '--displacement "<x,y,z>"' parameter. This displaces all of the objects and the terrain from the oar file when loading them into the new region. For instance, say you have four
OAR files from four adjacent 256x256 regions (oar00.oar, oar01.oar, oar10.oar, and oar11.oar). You create a new 512x512 varregion named 'bigregion'. The following commands place the four regions of objects, terrains and parcels
into the new larger region:

<pre>
change region bigregion
load oar oar00.oar
load oar oar01.oar --displacement "<0,256,0>" --merge --forceterrain --forceparcel
load oar oar10.oar --displacement "<256,0,0>" --merge --forceterrain --forceparcel
load oar oar11.oar --displacement "<256,256,0>" --merge --forceterrain --forceparcel
</pre>

Note the new "--forceterrain" and "--forceparcel" parameters. "--merge", used by itself, is for merging together the objects from multiple OARs. Merging also suppresses the loading of terrain and parcel data which is just what you want when merging objects. But, if loading multiple OARs to create a new, larger region, the terrain and parcel information must be loaded. Thus the new parameters.

==Things Known to be Broken==
* There is some problem with teleporting in an out of larger region. It works for some configurations and not others.
* While adjacent regions are usually viewable, sometimes they are not. They appear when you cross over into the region.

==Implementation Discussion==
Since this will be a major change to OpenSimulator that touches a
lot of different parts, subsequent posts, will discuss the changes I'm making.

===TerrainData===
One major problem is passing the terrain data from the region to the
protocol stack. The existing implementation passed an array of floats
that were presumed to be a 256x256 array of region terrain heights.
The
<tt>TerrainChannel</tt>
class is an attempt to hide the terrain implementation
from
<tt>TerrainModule</tt>
.
<tt>TerrainChannel</tt>
can't be passed into the protocol
stack (LLClientView) because
<tt>TerrainChannel</tt>
is defined as part of
<tt>OpenSim.Region.Framework</tt>
which is not visible to the protocol code.

My solution is to create the
<tt>TerrainData</tt>
class in
<tt>OpenSim.Framework.</tt>
<tt>TerrainData</tt>
just wraps the data structure for the terrain and additionally has
the attributes giving X and Y size.

I didn't want to change the signature of IClientAPI since so many external modules
rely on it.
It should be changed to pass <tt>TerrainData</tt> rather than a <tt>float[]</tt>.
I decided to not change IClientAPI but rather have <tt>LLClientView</tt> ignore
the passed array and instead reach back into the associated scene and fetch the
<tt>TerrainData</tt> instance.

There is one subclass of <tt>TerrainData</tt>: <tt>HeightmapTerrainData</tt> which keeps the terrain as a compressed heightmap. The height of each point is stored as a <tt>short</tt> which is <tt>height * compressionFactor</tt> where <tt>compressionFactor</tt> is usually "100". This creates a compact storage of the terrain heights with two decimal points of resolution.

The LLLP ("Linden Lab Legacy Protocol") sends terrain height data in
compressed "patches" of 16x16 areas of the terrain
height. This is a protocol feature that is implemented in <tt>TerrainChannel</tt>.
I feel that underlying protocol optimizations shouldn't appear up the
stack so, in creating <tt>TerrainData</tt>, I tried to hide terrain patches.
I mean, someday terrain will be generalized meshes. Right?

===Terrain in the Database===
Previously, terrain height maps were saved in the database as a blob of 256x256 doubles. To have different region sizes, that format had to change. There is an existing database field <tt>revision</tt> that stored the time the terrain was saved. This revision information wasn't used for anything so this field was co-opted to contain a revision code for the height field blob.

There are three forms for the height map blob: legacy, compressed2D and regular2D. "legacy" is, of course, the previous 256x256 collections of doubles. "regular2D" contains the X, Y dimensions and enough floats for that area's heights. "compressed2D" contains the X,Y and compressionFactor followed by enough shorts for the height map.

The database readers and writers default to the legacy format and, if the region happens to have the dimensions 256x256, it is stored using the legacy format. This is an attempt to keep downward compatibility.

All of the database modules (MySQL, SQLite, MSSQL and PSQL) have been modified to store terrain this new way.

===Sensing Border Crossing===
Most of the ‘move to new region’ code is based on checking boundaries. There is much code related to computing if an object or avatar has crossed a region boundary and then computing the address of the next region from same. Introducing variable sized regions messes a lot of this computation up. That is, the code doing the arithmetic usually assumes it knows the address of the next region based on a known region size and them can compute the location of the next region based on that. With varregions those assumptions no longer hold. Varregion implementation means that the computation of region base locations and border locations moves to the GridService who is the entity who really knows the size of all the regions and what is adjacent to what.

The realization that location to region computation is really a GridService operation lead me to totally rip apart the grid boundary checking code and replace it with two functions: <tt>Scene.PositionIsInCurrentRegion(Vector3 pos)</tt> and then <tt>EntityTransferModule.GetRegionContainingWorldLocation(double X, double Y)</tt>. The former function tests to see if the object/avatar has moved out of the current region and the latter gets the region moved into. (Side note: <tt>GetRegionContainingWorldLocation</tt> should really be a function on <tt>IGridService</tt> but that exercise is left for future hacking).

These changes leave all the 'border' code in limbo -- the generation of the border lists is still there but it is not being used. This should eventually be cleaned up. Also, the computation of neighbor regions is scattered around with routines on <tt>IGridService</tt>, in <tt>EntityTransferModule</tt> and a bunch of bookkeeping in <tt>Scene</tt>. This too should be cleaned up.

==Implementation Notes==

As of January 27, 2014, varregion is a feature of the 'master' repository branch.

===Stuff to Work On===
What follows are notes I am making as things that might need work are found in OpenSimulator.

* Consolidate neighbor region computation code (Scene, EntityTransferModule and IGridService all have 'get neighbor' code)
* Clean up/eliminate border list creation and use code
* Region handles are world coords and also the base of the region
** verify that everyone who converts coords to handle (Util.RegionWorldLocToHandle) is supplying the base of the region. (mostly done)
* ITerrainLoader implementations (mostly done)
** How to handle tiles.
** How to handle large regions sizes.
** Terrain/FileLoaders/*.cs all return an ITerrainChannel
** Need to fix all the file reader/writers
** FileLoaders/LLRAW.cs has several "256"s rather than constant references
* Teleporting: should be able to teleport to anywhere in a large region
** "MyRegion/550/687/40"
* HG code needs to allow addresses anywhere into large regions
* When GridService return adjacent regions, make sure it does the right thing for large regions
* Consider moving terrain XML serialization into TerrainData
* Consider removing all instances of TerrainChannel.GetFloatsSerialized()
** Replace with passing around TerrainData
* Code in EntityTransferModule that checks distance to decide if to make new connection
** search for references to 'Constants.RegionSize'
** Consider removing the distance code and replacing with call to grid service
* WorldMapModule.cs does a lot of arithmetic depending on constants that are really Contants.RegionSize
* Util.IsOutsideView uses Constants.RegionSize. Is use in ScenePresence a problem?
** Used in ScenePresence.AdjustKnownSeeds()
** Is this another instance like EntityTransferModule that needs to goto the grid service?
* Move all the short[] heightmap representation stuff into TerrainData.cs (partially done)
** Is it possible to move all the patch stuff out of TerrainModule/TerrainChannel?
** Clean up the use of m_revert. It looks like it is not saved after terrain is modified.
* Need to look through RegionCombinerModule.cs and see what safety checks are needed
** Maybe just prevent combination if not legacy region size
* In LSL_Api.cs, llEdgeOfWorld() does some neighbor computation. Check for ok'ness.
* LandManagementModule.SendParcelOverlay sends land sale/ownership info for 4x4m areas
** Looks like it expects to send exactly one 1024 byte block (for the 256x256 legacy region
** Check viewer code for what will happen for larger regions
* The code for cloud and wind needs to be enhanced for larger regions
** New overlay types added
* LLClientView.SendMapBlockSplit() needs to have region size to send with the map info
* Region/Framework/Scenes/Tests/BorderTests.cs might need work if non-standard regions are tested
* Verify terrain tests still work (for 256m regions)
* Region coords are sometimes 'int' and sometimes 'uint' with conversions EVERYWHERE
** pass over everything and convert region coordinates it 'uint's
** consider creating structures for world and region coordinates so there can be compile time checking

====Viewer====
* LLSurface is wired to expect adjacent regions of same size
* Terrain surface image is sized with a 'static": " static S32 sTextureSize; // Size of the surface texture"
* From FreeNode:#SingularityViewer 20131125:
<pre>
<Aleric> radams1, SianaGearz, frnic : I couldn't help myself doing a profile anyway.. The reason the viewer is slow is because it's busy "drawing" the terrain. "drawing" between quotes because my guess is that it is trying to draw ALL terrain and then clip that afterwards to the frustrum...
<Aleric> So, this could be greatly improved by disregarding terrain way way earlier when it is beyond the drawing range anyway.
<SianaGearz> OK
<Aleric> I disabled all rendering, even added a 'return' in terrain render
<Aleric> but.. no improvement of FPS!
<frnic> oops
<Aleric> LLSurfacePatch::updateVisibility() is still eating a lot of cpu.
<Aleric> LLSurface::updatePatchVisibilities does 97% of the calls to LLSurfacePatch::updateVisibility
<Aleric> which then spends most of it's time calling LLCamera::AABBInFrustumNoFarClip
</pre>
* Singularity commit for varregion: https://github.com/singularity-viewer/SingularityViewer/commit/ad8ea07a

==Testing==
* Terrain/parcel operations
** Default 256 standalone region
*** Clean database. Start single standalone region. Verify 'pimple' region. Verify one parcel. Flatten region.
*** Create parcels adjacent to each edge and standalone in middle. Change names of each parcel and verify. Restart simulator and verify parcels exist and work correctly.
*** Save five parcel region as OAR. Clear database. Restart region. Load oar. Verify 5 parcels of correct location, name and features.
** Adjacent 256 standalone regions
** 768x768 standalone region
** Changing land from 256 to 768
* Teleporting
* Adjacency
* Hypergrid

==Tips on Migrating Existing Sims to VarRegions==
* When you start the sim, you have to have either no regions nearby, or identical sized regions. otherwise, it locks your movement to the size of the smallest region
* When you load your oars, it's like Aurora sim. You need to load them by displacement first, load each one in place to get the terrains.
* When you merge, you lose the terrain.
* The second round, you reload each oar, this time with merge to load the objects.
* If you don't use merge, you lose all the objects with each oar load.
* When you load your oars, in format "<0,0,0>" the first number is east/west, or x.
* The second number is north/south, or y
* The third number is up or down, or z.
* The location must be in increments of 256.
* Using ROBUST for xbakes takes a significant load off the server; textures load quickly

Varregion

2014-03-07T18:53:00Z

Reibling: /* Varregions and OAR Files */ Change order of parameters - examples resulted in error expecting oar file name parameter in a different location

'''Varregion'''

__TOC__
"Varregion" is a feature of OpenSimulator that enables region sizes larger than 256x256. The region is just larger so it acts like a regular region but with borders farther apart.

The implementation uses the [http://aurora-sim.org Aurora] large region protocol extensions so the existing [http://firestormviewer.org Firestorm] and [http://singularityviewer.org Singularity] Aurora support will now work for OpenSimulator.

This is different from the older [[Megaregions]] large region feature which does not require extra viewer support (above that already implemented by Linden Lab) but which relies on a number of fragile hacks to make a viewer work in a way that Linden Lab never supported. Megaregions also contain a number of extant simulator-side bugs.

A growing list of protocol changes to implement "varregion" is at [[varregion/Protocol|Varregion Protocol]].

==Restrictions==
Some restrictions apply:
* The dimensions must be a multiple of 256 and less than or equal to 8192.
* The dimensions must be square (as of 20131104)
* Adjacent regions must be the same size. For instance, you can have multiple 512x512 regions adjacent (and see into the other region and border cross). There seems to be a viewer problem where, if regions of different size are within view distance, crashes can happen. Consider having regions of only the same size 'in view'. Remember that the region coordinates are specified in 256m region count so a group of four 512x512 regions would be specified at 8000/8000, 8000/8002, 8002/8000, and 8002/8002, for instance.
* You must use BulletSim (as of 20131104, ODE has not been modified for varregions)
** You must use BulletSim's height map terrain implementation. As of 20140128, BulletSim has been modified to force heightmap terrain implementation if region size is greater than 256 on any side. The setting can be forced by adding to your INI files:
<pre>
[BulletSim]
TerrainImplementation = 0
</pre>

==Configuration==
The size is be specified in the <tt>Region.ini</tt> file:
<pre>
[MyRegionName]
RegionUUID = 95ec77ec-58c5-4ce2-9ff3-b6d1900d78a2
Location = 1000,1000
SizeX = 1024
SizeY = 1024
InternalAddress = 0.0.0.0
InternalPort = 9200
AllowAlternatePorts = False
ExternalHostName = SYSTEMIP
</pre>
If size is not specified, it will, of course, default to the legacy size of 256.

If the given dimensions do not fit the restrictions, acceptable values are computed and warning and error messages are output into the log.

If converting from a mega-region, remember to set "<tt>CombineContiguousRegions = false</tt>".

for llRezObject to work beyond 256m set "ScriptDistanceLimitFactor = 52.0" (for 512mx512m) in the [Xengine] section of OpenSim.ini.

The terrain heightmap is stored in the database as an array of 'shorts' (two bytes) so, if you have a very large region you might need to set the database maximum size to a larger value. For instance, a 2816x2816 region (11x11 legacy regions) turns into a 56 megabyte heightmap and, for MySQL, you would need to set <tt>max_allowed_packet</tt> to something like 64M.

==Loading Terrain==
The usual terrain console commands work with varregions. If you have set up a larger region, you can load BMP/RAW/PNG heightmap files of the dimensions of the region and fill the whole region. For instance, a 1024x1024 region terrain would be completely initialized by "terrain load 1024.bmp" if '1024.bmp is a 1024x1024 bitmap.

==Varregions and OAR Files==
The objects and terrain are stored in an OAR file as if it was one region. That is, if you save a 1024x1024 region in an OAR file, you can later restore the objects and terrain into a 1024x1024 sized region. If you load an OAR file from a smaller region into a larger region, the unspecified terrain space will default to 25m.

To make conversion to varregions easier, 'load oar' now has a '--displacement "<x,y,z>"' parameter. This displaces all of the objects and the terrain from the oar file when loading them into the new region. For instance, say you have four
OAR files from four adjacent 256x256 regions (oar00.oar, oar01.oar, oar10.oar, and oar11.oar). You create a new 512x512 varregion named 'bigregion'. The following commands place the four regions of objects, terrains and parcels
into the new larger region:

<pre>
change region bigregion
load oar oar00.oar
load oar oar01.oar --displacement "<0,256,0>" --merge --forceterrain --forceparcel
load oar oar10.oar --displacement "<256,0,0>" --merge --forceterrain --forceparcel
load oar oar11.oar --displacement "<256,256,0>" --merge --forceterrain --forceparcel
</pre>

Note the new "--forceterrain" and "--forceparcel" parameters. "--merge", used by itself, is for merging together the objects from multiple OARs. Merging also suppresses the loading of terrain and parcel data which is just what you want when merging objects. But, if loading multiple OARs to create a new, larger region, the terrain and parcel information must be loaded. Thus the new parameters.

==Things Known to be Broken==
* There is some problem with teleporting in an out of larger region. It works for some configurations and not others.
* While adjacent regions are usually viewable, sometimes they are not. They appear when you cross over into the region.

==Implementation Discussion==
Since this will be a major change to OpenSimulator that touches a
lot of different parts, subsequent posts, will discuss the changes I'm making.

===TerrainData===
One major problem is passing the terrain data from the region to the
protocol stack. The existing implementation passed an array of floats
that were presumed to be a 256x256 array of region terrain heights.
The
<tt>TerrainChannel</tt>
class is an attempt to hide the terrain implementation
from
<tt>TerrainModule</tt>
.
<tt>TerrainChannel</tt>
can't be passed into the protocol
stack (LLClientView) because
<tt>TerrainChannel</tt>
is defined as part of
<tt>OpenSim.Region.Framework</tt>
which is not visible to the protocol code.

My solution is to create the
<tt>TerrainData</tt>
class in
<tt>OpenSim.Framework.</tt>
<tt>TerrainData</tt>
just wraps the data structure for the terrain and additionally has
the attributes giving X and Y size.

I didn't want to change the signature of IClientAPI since so many external modules
rely on it.
It should be changed to pass <tt>TerrainData</tt> rather than a <tt>float[]</tt>.
I decided to not change IClientAPI but rather have <tt>LLClientView</tt> ignore
the passed array and instead reach back into the associated scene and fetch the
<tt>TerrainData</tt> instance.

There is one subclass of <tt>TerrainData</tt>: <tt>HeightmapTerrainData</tt> which keeps the terrain as a compressed heightmap. The height of each point is stored as a <tt>short</tt> which is <tt>height * compressionFactor</tt> where <tt>compressionFactor</tt> is usually "100". This creates a compact storage of the terrain heights with two decimal points of resolution.

The LLLP ("Linden Lab Legacy Protocol") sends terrain height data in
compressed "patches" of 16x16 areas of the terrain
height. This is a protocol feature that is implemented in <tt>TerrainChannel</tt>.
I feel that underlying protocol optimizations shouldn't appear up the
stack so, in creating <tt>TerrainData</tt>, I tried to hide terrain patches.
I mean, someday terrain will be generalized meshes. Right?

===Terrain in the Database===
Previously, terrain height maps were saved in the database as a blob of 256x256 doubles. To have different region sizes, that format had to change. There is an existing database field <tt>revision</tt> that stored the time the terrain was saved. This revision information wasn't used for anything so this field was co-opted to contain a revision code for the height field blob.

There are three forms for the height map blob: legacy, compressed2D and regular2D. "legacy" is, of course, the previous 256x256 collections of doubles. "regular2D" contains the X, Y dimensions and enough floats for that area's heights. "compressed2D" contains the X,Y and compressionFactor followed by enough shorts for the height map.

The database readers and writers default to the legacy format and, if the region happens to have the dimensions 256x256, it is stored using the legacy format. This is an attempt to keep downward compatibility.

All of the database modules (MySQL, SQLite, MSSQL and PSQL) have been modified to store terrain this new way.

===Sensing Border Crossing===
Most of the ‘move to new region’ code is based on checking boundaries. There is much code related to computing if an object or avatar has crossed a region boundary and then computing the address of the next region from same. Introducing variable sized regions messes a lot of this computation up. That is, the code doing the arithmetic usually assumes it knows the address of the next region based on a known region size and them can compute the location of the next region based on that. With varregions those assumptions no longer hold. Varregion implementation means that the computation of region base locations and border locations moves to the GridService who is the entity who really knows the size of all the regions and what is adjacent to what.

The realization that location to region computation is really a GridService operation lead me to totally rip apart the grid boundary checking code and replace it with two functions: <tt>Scene.PositionIsInCurrentRegion(Vector3 pos)</tt> and then <tt>EntityTransferModule.GetRegionContainingWorldLocation(double X, double Y)</tt>. The former function tests to see if the object/avatar has moved out of the current region and the latter gets the region moved into. (Side note: <tt>GetRegionContainingWorldLocation</tt> should really be a function on <tt>IGridService</tt> but that exercise is left for future hacking).

These changes leave all the 'border' code in limbo -- the generation of the border lists is still there but it is not being used. This should eventually be cleaned up. Also, the computation of neighbor regions is scattered around with routines on <tt>IGridService</tt>, in <tt>EntityTransferModule</tt> and a bunch of bookkeeping in <tt>Scene</tt>. This too should be cleaned up.

==Implementation Notes==

As of January 27, 2014, varregion is a feature of the 'master' repository branch.

===Stuff to Work On===
What follows are notes I am making as things that might need work are found in OpenSimulator.

* Consolidate neighbor region computation code (Scene, EntityTransferModule and IGridService all have 'get neighbor' code)
* Clean up/eliminate border list creation and use code
* Region handles are world coords and also the base of the region
** verify that everyone who converts coords to handle (Util.RegionWorldLocToHandle) is supplying the base of the region. (mostly done)
* ITerrainLoader implementations (mostly done)
** How to handle tiles.
** How to handle large regions sizes.
** Terrain/FileLoaders/*.cs all return an ITerrainChannel
** Need to fix all the file reader/writers
** FileLoaders/LLRAW.cs has several "256"s rather than constant references
* Teleporting: should be able to teleport to anywhere in a large region
** "MyRegion/550/687/40"
* HG code needs to allow addresses anywhere into large regions
* When GridService return adjacent regions, make sure it does the right thing for large regions
* Consider moving terrain XML serialization into TerrainData
* Consider removing all instances of TerrainChannel.GetFloatsSerialized()
** Replace with passing around TerrainData
* Code in EntityTransferModule that checks distance to decide if to make new connection
** search for references to 'Constants.RegionSize'
** Consider removing the distance code and replacing with call to grid service
* WorldMapModule.cs does a lot of arithmetic depending on constants that are really Contants.RegionSize
* Util.IsOutsideView uses Constants.RegionSize. Is use in ScenePresence a problem?
** Used in ScenePresence.AdjustKnownSeeds()
** Is this another instance like EntityTransferModule that needs to goto the grid service?
* Move all the short[] heightmap representation stuff into TerrainData.cs (partially done)
** Is it possible to move all the patch stuff out of TerrainModule/TerrainChannel?
** Clean up the use of m_revert. It looks like it is not saved after terrain is modified.
* Need to look through RegionCombinerModule.cs and see what safety checks are needed
** Maybe just prevent combination if not legacy region size
* In LSL_Api.cs, llEdgeOfWorld() does some neighbor computation. Check for ok'ness.
* LandManagementModule.SendParcelOverlay sends land sale/ownership info for 4x4m areas
** Looks like it expects to send exactly one 1024 byte block (for the 256x256 legacy region
** Check viewer code for what will happen for larger regions
* The code for cloud and wind needs to be enhanced for larger regions
** New overlay types added
* LLClientView.SendMapBlockSplit() needs to have region size to send with the map info
* Region/Framework/Scenes/Tests/BorderTests.cs might need work if non-standard regions are tested
* Verify terrain tests still work (for 256m regions)
* Region coords are sometimes 'int' and sometimes 'uint' with conversions EVERYWHERE
** pass over everything and convert region coordinates it 'uint's
** consider creating structures for world and region coordinates so there can be compile time checking

====Viewer====
* LLSurface is wired to expect adjacent regions of same size
* Terrain surface image is sized with a 'static": " static S32 sTextureSize; // Size of the surface texture"
* From FreeNode:#SingularityViewer 20131125:
<pre>
<Aleric> radams1, SianaGearz, frnic : I couldn't help myself doing a profile anyway.. The reason the viewer is slow is because it's busy "drawing" the terrain. "drawing" between quotes because my guess is that it is trying to draw ALL terrain and then clip that afterwards to the frustrum...
<Aleric> So, this could be greatly improved by disregarding terrain way way earlier when it is beyond the drawing range anyway.
<SianaGearz> OK
<Aleric> I disabled all rendering, even added a 'return' in terrain render
<Aleric> but.. no improvement of FPS!
<frnic> oops
<Aleric> LLSurfacePatch::updateVisibility() is still eating a lot of cpu.
<Aleric> LLSurface::updatePatchVisibilities does 97% of the calls to LLSurfacePatch::updateVisibility
<Aleric> which then spends most of it's time calling LLCamera::AABBInFrustumNoFarClip
</pre>
* Singularity commit for varregion: https://github.com/singularity-viewer/SingularityViewer/commit/ad8ea07a

==Testing==
* Terrain/parcel operations
** Default 256 standalone region
*** Clean database. Start single standalone region. Verify 'pimple' region. Verify one parcel. Flatten region.
*** Create parcels adjacent to each edge and standalone in middle. Change names of each parcel and verify. Restart simulator and verify parcels exist and work correctly.
*** Save five parcel region as OAR. Clear database. Restart region. Load oar. Verify 5 parcels of correct location, name and features.
** Adjacent 256 standalone regions
** 768x768 standalone region
** Changing land from 256 to 768
* Teleporting
* Adjacency
* Hypergrid

==Tips on Migrating Existing Sims to VarRegions==
* When you start the sim, you have to have either no regions nearby, or identical sized regions. otherwise, it locks your movement to the size of the smallest region
* When you load your oars, it's like Aurora sim. You need to load them by displacement first, load each one in place to get the terrains.
* When you merge, you lose the terrain.
* The second round, you reload each oar, this time with merge to load the objects.
* If you don't use merge, you lose all the objects with each oar load.
* When you load your oars, in format "<0,0,0>" the first number is east/west, or x.
* The second number is north/south, or y
* The third number is up or down, or z.
* The location must be in increments of 256.