Add a comment and an example region config file

2 files changed, 48 insertions, 1 deletions

diff --git a/OpenSim/Framework/RegionInfo.cs b/OpenSim/Framework/RegionInfo.cs
index 2423097..6a264a6 100644
--- a/OpenSim/Framework/RegionInfo.cs
+++ b/OpenSim/Framework/RegionInfo.cs
@@ -427,7 +427,7 @@ namespace OpenSim.Framework
             m_regionLocY = Convert.ToUInt32(locationElements[1]);
 
 
-            // Datastore
+            // Datastore (is this implemented? Omitted from example!)
             //
             DataStore = config.GetString("Datastore", String.Empty);
 
diff --git a/bin/RegionConfig.ini.example b/bin/RegionConfig.ini.example
new file mode 100644
index 0000000..0404168
--- /dev/null
+++ b/bin/RegionConfig.ini.example
@@ -0,0 +1,47 @@
+; * This file must be renamed to RegionConfig.ini and moved to the Regions/
+; * subdirectory to work!
+; *
+; * You can put multiple regions into one file or make one file per region
+; * The section name is the region name
+; *
+
+[Default Region]
+
+; *
+; * You MUST change this! It will NOT be done for you!
+; *
+
+RegionUUID = "11111111-2222-3333-4444-555555555555"
+
+Location = "1000,1000"
+InternalAddress = "127.0.0.1"
+InternalPort = 9000
+AllowAlternatePorts = False
+ExternalHostName = "SYSTEMIP"
+
+; *
+; * Master avatar stuff. Set either a UUID (from OSGrid or your server)
+; * OR a first and last name. Password is only needed for sandbox mode
+; * The default assigns no master avatar
+; *
+
+MasterAvatarUUID = "00000000-0000-0000-0000-000000000000"
+; MasterAvatarFirstName = ""
+; MasterAvatarLastName = ""
+; MasterAvatarSandboxPassword = ""
+
+; *
+; * Prim data
+; * This allows limiting the sizes of prims and the region prim count
+; *
+
+; NonphysicalPrimMax = 256
+; PhysicalPrimMax = 10
+; ClampPrimSize = False
+; MaxPrims = 15000
+
+; *
+; * Multi-Tenancy. Only set if needed
+; *
+
+; ScopeID = "00000000-0000-0000-0000-000000000000"