Allow Region specific static maptiles to be loaded from file.

1 files changed, 35 insertions, 2 deletions

diff --git a/bin/Regions/Regions.ini.example b/bin/Regions/Regions.ini.example
index aabc4f8..57d503e 100644
--- a/bin/Regions/Regions.ini.example
+++ b/bin/Regions/Regions.ini.example
@@ -46,7 +46,40 @@ ExternalHostName = "SYSTEMIP"
 
 ; RegionType = "Mainland"
 
+; * Region Specific Static Maptiles:
+; * Important: To use any kind of texture *assets* as a static maptile, the following
+; * things must be set in the [Map] section of OpenSim.ini :
 ; *
-; * UUID of texture to use as a maptile for this region.
-; * Only set if you have disabled dynamic generation of the map tile from the region contents.
+; *  MapImageModule = "MapImageModule"
+; *  GenerateMaptiles = false
+; *
+; * Now, there is a setting in [Map] in OpenSim.ini called
+; *
+; *  MaptileStaticUUID = "00000000-0000-0000-0000-000000000000"
+; *
+; * where, given the criteria above, lets you specify the UUID of a texture asset to use
+; * as a maptile *Simulator Wide*. Here, you can override that on a per region basis for
+; * Simulators that run multiple regions:
+
 ; MaptileStaticUUID = "00000000-0000-0000-0000-000000000000"
+
+
+; * Region Specific Static Maptiles from file:
+; * It is also possible to create maptiles using external image files of the right size
+; * and supported formats (bmp,tga,png,jpg in RGB 24bpp format)
+; *
+; * Important: To use any kind of texture *files* as a static maptile, the following
+; * things must be set in the [Map] section of OpenSim.ini :
+; *
+; *  MapImageModule = "MapImageModule"
+; *  GenerateMaptiles = true
+; *
+; * The image must be the same size in pixels as the region or varregion is in meters.
+; * i.e. 256x256 pixels for single region of 256x256m, or 1280x1280 pixels for a varregion
+; * of size 1280x1280m. The image is loaded from OpenSim's bin/maptiles/ directory.
+; *
+; * If this setting is used, then the base map is generated from this file instead of being
+; * built using MapImageModule's terrain and prim renderer. Parcel 'for sale' overlays are
+; * still drawn on top of the static map by the World Map module.
+
+; MaptileStaticFile = "SomeFile.png"
\ No newline at end of file