Merge branch 'SledjChisl'

35 files changed, 325 insertions, 0 deletions

diff --git a/example/AssetFiles/.keep b/example/AssetFiles/.keep
new file mode 100644
index 0000000..e69de29
--- /dev/null
+++ b/example/AssetFiles/.keep
diff --git a/example/AssetFiles/data/.keep b/example/AssetFiles/data/.keep
new file mode 100644
index 0000000..e69de29
--- /dev/null
+++ b/example/AssetFiles/data/.keep
diff --git a/example/AssetFiles/tmp/.keep b/example/AssetFiles/tmp/.keep
new file mode 100644
index 0000000..e69de29
--- /dev/null
+++ b/example/AssetFiles/tmp/.keep
diff --git a/example/AssetFiles/tmp/spool/.keep b/example/AssetFiles/tmp/spool/.keep
new file mode 100644
index 0000000..e69de29
--- /dev/null
+++ b/example/AssetFiles/tmp/spool/.keep
diff --git a/example/backups/.keep b/example/backups/.keep
new file mode 100644
index 0000000..e69de29
--- /dev/null
+++ b/example/backups/.keep
diff --git a/example/caches/.keep b/example/caches/.keep
new file mode 100644
index 0000000..e69de29
--- /dev/null
+++ b/example/caches/.keep
diff --git a/example/caches/DataSnapshot/.keep b/example/caches/DataSnapshot/.keep
new file mode 100644
index 0000000..e69de29
--- /dev/null
+++ b/example/caches/DataSnapshot/.keep
diff --git a/example/caches/MapImageCache/.keep b/example/caches/MapImageCache/.keep
new file mode 100644
index 0000000..e69de29
--- /dev/null
+++ b/example/caches/MapImageCache/.keep
diff --git a/example/caches/MeshCache/.keep b/example/caches/MeshCache/.keep
new file mode 100644
index 0000000..e69de29
--- /dev/null
+++ b/example/caches/MeshCache/.keep
diff --git a/example/caches/ScriptEngines/.keep b/example/caches/ScriptEngines/.keep
new file mode 100644
index 0000000..e69de29
--- /dev/null
+++ b/example/caches/ScriptEngines/.keep
diff --git a/example/caches/addin-db-001/.keep b/example/caches/addin-db-001/.keep
new file mode 100644
index 0000000..e69de29
--- /dev/null
+++ b/example/caches/addin-db-001/.keep
diff --git a/example/caches/addin-db-002/.keep b/example/caches/addin-db-002/.keep
new file mode 100644
index 0000000..e69de29
--- /dev/null
+++ b/example/caches/addin-db-002/.keep
diff --git a/example/caches/addin-db-003/.keep b/example/caches/addin-db-003/.keep
new file mode 100644
index 0000000..e69de29
--- /dev/null
+++ b/example/caches/addin-db-003/.keep
diff --git a/example/caches/addin-db-004/.keep b/example/caches/addin-db-004/.keep
new file mode 100644
index 0000000..e69de29
--- /dev/null
+++ b/example/caches/addin-db-004/.keep
diff --git a/example/caches/assetcache/.keep b/example/caches/assetcache/.keep
new file mode 100644
index 0000000..e69de29
--- /dev/null
+++ b/example/caches/assetcache/.keep
diff --git a/example/caches/assetcache/j2k/.keep b/example/caches/assetcache/j2k/.keep
new file mode 100644
index 0000000..e69de29
--- /dev/null
+++ b/example/caches/assetcache/j2k/.keep
diff --git a/example/caches/bakes/.keep b/example/caches/bakes/.keep
new file mode 100644
index 0000000..e69de29
--- /dev/null
+++ b/example/caches/bakes/.keep
diff --git a/example/caches/j2kDecodeCache/.keep b/example/caches/j2kDecodeCache/.keep
new file mode 100644
index 0000000..e69de29
--- /dev/null
+++ b/example/caches/j2kDecodeCache/.keep
diff --git a/example/caches/maptiles/.keep b/example/caches/maptiles/.keep
new file mode 100644
index 0000000..e69de29
--- /dev/null
+++ b/example/caches/maptiles/.keep
diff --git a/example/config/ROBUST/opensim-monit.conf b/example/config/ROBUST/opensim-monit.conf
new file mode 100644
index 0000000..adce46d
--- /dev/null
+++ b/example/config/ROBUST/opensim-monit.conf
@@ -0,0 +1,36 @@
+# manage the OpenSim process for Your Sim
+#
+# usage:
+#     monit start your_sim
+#     monit stop your_sim
+#     monit restart your_sim
+#
+# see 'daemon' setting in /etc/monit/monitrc for the cycle length.
+# on ubuntu/debian, this is overridden by the CHECK_INTERVALS var in
+# /etc/default/monit .  the below assumes you've set it to 30 seconds.
+#
+# if process dies, will restart sim within 30 seconds.  if process
+# dies 5 times in as many tries, will stop trying and send email
+# alert.
+#
+# if SimFPS drops to 0 for 2 minutes, restart.
+#
+# if process CPU usage stays above 300% for 2 minutes, restart.
+#
+# see ../README for configuration instructions.
+#
+# Hmmmm, seems that monit changing to a user and running bash -l is different from sudo changing to a user and running bash -l.
+#
+check process ROBUST with pidfile OS_PATH/caches/ROBUST.pid
+    start program = "/usr/bin/sudo -Hu opensim /bin/bash -lc 'cd OS_PATH/config/ROBUST && OS_PATH/config/ROBUST/start-sim -q'"
+        as uid root and gid root
+    stop program = "/usr/bin/sudo -Hu opensim /bin/bash -lc 'cd OS_PATH/config/ROBUST && OS_PATH/config/ROBUST/stop-sim'" with timeout 600 seconds
+    if cpu usage > 50% for 4 cycles then restart
+#    if 5 restarts within 5 cycles then timeout
+#    if failed url http://127.0.0.1:9005/jsonSimStats/
+#        and content != '"SimFPS":0.0,' for 4 cycles
+#        then restart
+#    if failed url http://127.0.0.1:9008/jsonSimStats/
+#        and content == '"SimFPS":' for 4 cycles
+#        then restart
+
diff --git a/example/config/config.ini b/example/config/config.ini
new file mode 100644
index 0000000..e95b04c
--- /dev/null
+++ b/example/config/config.ini
@@ -0,0 +1,47 @@
+; The Const section allows us to define some basic information that we
+; will use throughout our configuration. We will provide examples for 
+; setting the base url of the ROBUST server and the public and private ports
+; it uses.  Changing the values of the constants will set the operating
+; parameters thoughout the configuration.  Other constants that may prove
+; to be useful may be added to the followin section.  They may be 
+; referenced anywhere in the configuration by using ${Const|Name}.  One
+; such use is providing a base path for setting locations that ROBUST
+; uses to write data.
+
+; Also put grid specific stuff here.
+
+
+[Paths]
+    AssetsPath = "../../AssetFiles"
+    BackupPath = "../../backups"
+    CachePath = "../../caches"
+    ConfigPath = "../../config"
+    DbPath = "../../db"
+    LogPath = "../../logs"
+    WebPath = "../../web"
+
+[Const]
+    MOTD = "Welcome to your local grid."
+
+    GridName = "localhost Grid"
+    ShortGridName = "lg"
+
+    ; For a grid these will usually be the externally accessible IP/DNS
+    ; name and use default public port 8002 and default private port 8003
+    ; For a standalone this will usually be the externally accessible IP/DNS
+    ; name and use default public port 9000. The private port is not used
+    ; in the configuration for a standalone.
+    BaseHostname = "127.0.0.1"
+    HostName = "localhost"
+    BaseURL = http://${Const|BaseHostname}
+    GridURL = http://${Const|BaseHostname}
+
+    PublicPort = "8002"
+    PrivatePort = "8003"
+
+    ; The public port of the ROBUST asset server, which might be different.
+    AssetServerPort = "8003"
+
+    ; Database credentials.
+    DataProvider = "OpenSim.Data.MySQL.dll"
+    ConnectionString = "Data Source=MYSQL_HOST;Database=MYSQL_DB;User ID=MYSQL_USER;Password=MYSQL_PASSWORD;Old Guids=true;"
diff --git a/example/config/sim_skeleton/ThisSim.ini b/example/config/sim_skeleton/ThisSim.ini
new file mode 100644
index 0000000..44749bb
--- /dev/null
+++ b/example/config/sim_skeleton/ThisSim.ini
@@ -0,0 +1,44 @@
+[Const]
+    mysim="SIM_NUMBER"
+
+[Startup]
+    PIDFile = "${Paths|CachePath}/sim${Const|mysim}.pid"
+    LogFile = "${Paths|LogPath}/OpenSim_sim${Const|mysim}.log"
+    StatsLogFile = "${Paths|LogPath}/OpenSimStats_sim${Const|mysim}.log"
+    ConsoleHistoryFile = "${Paths|LogPath}/OpenSimConsoleHistory_sim${Const|mysim}.txt"
+
+[Region]
+    RegionName = "SIM_NAME"
+    RegionUUID = "SIM_UUID"
+    Location = "SIM_POS"
+    InternalPort = "SIM_INT_PORT"
+    RegionType = "private sim"
+    SizeX = SIM_SIZE
+    SizeY = SIM_SIZE
+    SizeZ = 16384
+    MaxAgents = 100
+    MaxPrims = 45000
+    PhysicalPrimMax = 640
+    NonPhysicalPrimMax = 2560
+    ClampPrimSize = False
+    MaptileStaticUUID = "00000000-0000-0000-0000-000000000000"
+    ; NonPhysicalPrimMin = 0
+    ; PhysicalPrimMin = 0
+    ; MaxPrimsPerUser = -1
+    ; LinksetPrims = 0
+    ; DefaultLanding = "<128, 128, 30>"
+    ; MaptileStaticFile = ""
+    ; ScopeID = "00000000-0000-0000-0000-000000000000"
+    ; Datastore = ""
+    ; ResolveAddress = ""
+
+[Network]
+    http_listener_port = SIM_PORT
+
+[Performance]
+    ;; Select the performance characteristics of OpenSim.
+    ; Include-Performance = "config-include/SimFast.ini"
+    Include-Performance = "config-include/SimBalanced.ini"
+    ; Include-Performance = "config-include/SimDefault.ini"
+    ; Include-Performance = "config-include/SimLean.ini"
+
diff --git a/example/config/sim_skeleton/opensim-monit.conf b/example/config/sim_skeleton/opensim-monit.conf
new file mode 100644
index 0000000..fd9220f
--- /dev/null
+++ b/example/config/sim_skeleton/opensim-monit.conf
@@ -0,0 +1,29 @@
+# manage the OpenSim process for Your Sim
+#
+# usage:
+#     monit start your_sim
+#     monit stop your_sim
+#     monit restart your_sim
+#
+# see 'daemon' setting in /etc/monit/monitrc for the cycle length.
+# on ubuntu/debian, this is overridden by the CHECK_INTERVALS var in
+# /etc/default/monit .  the below assumes you've set it to 30 seconds.
+#
+# see ../README for configuration instructions.
+#
+# Hmmmm, seems that monit changing to a user and running bash -l is different from sudo changing to a user and running bash -l.
+#
+check process simSIM_NUMBER with pidfile OS_PATH/caches/simSIM_NUMBER.pid
+    start program = "/usr/bin/sudo -Hu opensim /bin/bash -lc 'cd OS_PATH/config/simSIM_NUMBER && OS_PATH/config/simSIM_NUMBER/start-sim -q'"
+        as uid root and gid root
+    stop program = "/usr/bin/sudo -Hu opensim /bin/bash -lc 'cd OS_PATH/config/simSIM_NUMBER && OS_PATH/config/simSIM_NUMBER/stop-sim'" with timeout 600 seconds
+    if cpu usage > 50% for 4 cycles then restart
+    if MEMORY usage > 10% for 4 cycles then restart
+#    if 5 restarts within 5 cycles then timeout
+#    if failed url http://127.0.0.1:9005/jsonSimStats/
+#        and content != '"SimFPS":0.0,' for 4 cycles
+#        then restart
+#    if failed url http://127.0.0.1:9008/jsonSimStats/
+#        and content == '"SimFPS":' for 4 cycles
+#        then restart
+    depends on ROBUST
diff --git a/example/db/.keep b/example/db/.keep
new file mode 100644
index 0000000..e69de29
--- /dev/null
+++ b/example/db/.keep
diff --git a/example/logs/.keep b/example/logs/.keep
new file mode 100644
index 0000000..e69de29
--- /dev/null
+++ b/example/logs/.keep
diff --git a/example/start.sh b/example/start.sh
new file mode 100755
index 0000000..d6ef48d
--- /dev/null
+++ b/example/start.sh
@@ -0,0 +1,4 @@
+#!/bin/bash
+
+cd /opt/opensim_SC/current/bin
+mono OpenSim.exe -inidirectory=../../config/simg01
diff --git a/example/web/SledjHamr.png b/example/web/SledjHamr.png
new file mode 100644
index 0000000..9089573
--- /dev/null
+++ b/example/web/SledjHamr.png
diff --git a/example/web/SledjHamrIcon.png b/example/web/SledjHamrIcon.png
new file mode 100644
index 0000000..e3b50e1
--- /dev/null
+++ b/example/web/SledjHamrIcon.png
diff --git a/example/web/SledjHamrIconSmall.png b/example/web/SledjHamrIconSmall.png
new file mode 100644
index 0000000..a1a6d72
--- /dev/null
+++ b/example/web/SledjHamrIconSmall.png
diff --git a/example/web/about.html b/example/web/about.html
new file mode 100644
index 0000000..50ee1e2
--- /dev/null
+++ b/example/web/about.html
@@ -0,0 +1,10 @@
+<html>
+<title>About this grid</title>
+<head>
+<link rel="shortcut icon" href="SledjHamrIconSmall.png">
+</head>
+<body bgcolor="black" text="white" alink="red" link="blue" vlink="purple">
+This is a virtual world, usually called a grid, based on <a href="https://sledjhamr.org/cgit/opensim-SC/?h=SledjChisl">opensim-SC</a>.
+<p>&nbsp;</p>
+</body>
+</html>
diff --git a/example/web/help.html b/example/web/help.html
new file mode 100644
index 0000000..e070b82
--- /dev/null
+++ b/example/web/help.html
@@ -0,0 +1,10 @@
+<html>
+<title>Help for this grid</title>
+<head>
+<link rel="shortcut icon" href="SledjHamrIconSmall.png">
+</head>
+<body bgcolor="black" text="white" alink="red" link="blue" vlink="purple">
+Include help for your grid here.
+<p>&nbsp;</p>
+</body>
+</html>
diff --git a/example/web/loginpage.html b/example/web/loginpage.html
new file mode 100644
index 0000000..5ca5a52
--- /dev/null
+++ b/example/web/loginpage.html
@@ -0,0 +1,97 @@
+<html>
+<title><!--#echo var="grid" --> splash page</title>
+<head>
+<link rel="shortcut icon" href="SledjHamrIconSmall.png">
+<meta http-equiv="refresh" content="120">
+<style>
+html, body
+{
+    margin: 0;
+    padding: 0;
+    color: white;
+}
+a {color: green;}
+a:link {color: green;}
+a:visited {color: purple;}
+a:hover {color: red;}
+a:active {color: blue;}
+
+.container
+{
+  position: relative;
+  text-align: left;
+}
+
+.top-left
+{
+  position: absolute;
+  top: 8px;
+  left: 16px;
+  width: 30%;
+}
+
+.top-right
+{
+  position: absolute;
+  top: 8px;
+  right: 16px;
+  width: 30%;
+}
+
+.centre
+{
+  position: absolute;
+  top: 50%;
+  left: 50%;
+  width: 30%;
+  transform: translate(-50%, -50%);
+}
+
+.bottom-left
+{
+  position: absolute;
+  bottom: 8px;
+  left: 16px;
+  width: 30%;
+}
+
+.bottom-right
+{
+  position: absolute;
+  bottom: 8px;
+  right: 16px;
+  width: 30%;
+}
+</style>
+</head>
+<body>
+<div class="container">
+  <img src="SledjHamr.png" alt="SledjHamr" style="width:100%;height:100%;">
+  <div class="top-left">
+    <h1>Add your fancy splash page for <!--#echo var="grid" --> here.</h1>
+    <p>&nbsp;</p>
+    <p>&nbsp;</p>
+    <p>&nbsp;</p>
+    <p>Perhaps describe <!--#echo var="grid" --> here.</p>
+  </div>
+  <div class="top-right">
+    <h1>Login URI - <!--#echo var="uri" --></h1>
+    <p>&nbsp;</p>
+    <p>There are <!--#echo var="members" --> members of this grid.</p>
+    <p>There are <!--#echo var="inworld" --> locals and <!--#echo var="hgers" --> hypergrid visitors in world.</p>
+    <p>There are <!--#echo var="outworld" --> locals out on the hypergrid.</p>
+    <p>There have been <!--#echo var="day30" --> locals and visitors on this grid in the last month.</p>
+    <p>There are <!--#echo var="sims" --> regions, though some might not be online right now.</p>
+  </div>
+  <div class="centre">
+    <p>Maybe add some news or events here, or something.</p>
+  </div>
+  <div class="bottom-left">
+    <p>CSS by Taylor Temper, photo by onefang rejected.</p>
+  </div>
+  <div class="bottom-right">
+    <p><!--#echo var="grid" --> is running <a href="https://sledjhamr.org/mantisbt/project_page.php?project_id=8"><!--#echo var="version" --></a>,
+    part of the <a href="https://sledjhamr.org/git/docs/index.html">SledjHamr</a> project.</p>
+</div>
+</body>
+</html>
diff --git a/example/web/password_help.html b/example/web/password_help.html
new file mode 100644
index 0000000..db03fff
--- /dev/null
+++ b/example/web/password_help.html
@@ -0,0 +1,10 @@
+<html>
+<title>Password help for this grid</title>
+<head>
+<link rel="shortcut icon" href="SledjHamrIconSmall.png">
+</head>
+<body bgcolor="black" text="white" alink="red" link="blue" vlink="purple">
+Include password help for your grid here.
+<p>&nbsp;</p>
+</body>
+</html>
diff --git a/example/web/register.html b/example/web/register.html
new file mode 100644
index 0000000..e721351
--- /dev/null
+++ b/example/web/register.html
@@ -0,0 +1,14 @@
+<html>
+<title>Account for this grid</title>
+<head>
+<link rel="shortcut icon" href="SledjHamrIconSmall.png">
+</head>
+<body bgcolor="black" text="white" alink="red" link="blue" vlink="purple">
+Include account registration help for your grid here.
+<p>&nbsp;</p>
+<p>If you want to register an account on this grid, ask the person that runs it to do that for you.</p>
+<p>&nbsp;</p>
+<p>If you want to register an account on this grid, <a href="account.html"> click here</a> (when it's written).</p>
+<p>&nbsp;</p>
+</body>
+</html>
diff --git a/example/web/stats.html b/example/web/stats.html
new file mode 100644
index 0000000..418adac
--- /dev/null
+++ b/example/web/stats.html
@@ -0,0 +1,24 @@
+<html>
+  <title><!--#echo var="grid" --> stats page</title>
+  <head>
+    <link rel="shortcut icon" href="SledjHamrIconSmall.png">
+    <meta http-equiv="refresh" content="120">
+  </head>
+  <body>
+    <h1><!--#echo var="grid" --> statistics.</h1>
+    <p>Login URI - <!--#echo var="uri" --></p>
+    <p>Login page - <a href="<!--#echo var="uri" -->web/loginpage.html"><!--#echo var="uri" -->web/loginpage.html</a></p>
+    <p>There are <!--#echo var="members" --> members of this grid.</p>
+    <p>There are <!--#echo var="inworld" --> locals and <!--#echo var="hgers" --> hypergrid visitors in world right now.</p>
+    <p>There are <!--#echo var="outworld" --> locals out on the hypergrid right now.</p>
+    <p>There have been <!--#echo var="locDay30" --> locals and <!--#echo var="HGday30" --> hypergrid visitors on this grid in the last 30 days (<!--#echo var="day30" --> total).</p>
+    <p>There have been <!--#echo var="locDay60" --> locals and <!--#echo var="HGday60" --> hypergrid visitors on this grid in the last 60 days (<!--#echo var="day60" --> total).</p>
+    <p>There are <!--#echo var="sims" --> regions, though <!--#echo var="offlineSims" --> might not be online right now.</p>
+    <p>There may be <!--#echo var="onlineSims" --> regions online, with a total area of perhaps <!--#echo var="simsSize" --> square metres.</p>
+    <p>There are <!--#echo var="varRegions" --> varregions that might be online now.</p>
+    <p>There are <!--#echo var="singleSims" --> normal regions that might be online now.</p>
+    <p><!--#echo var="grid" --> is running <a href="https://sledjhamr.org/mantisbt/project_page.php?project_id=8"><!--#echo var="version" --></a>,
+    part of the <a href="https://sledjhamr.org/git/docs/index.html">SledjHamr</a> project.</p>
+    <p>These statistics will update every two minutes.</p>
+  </body>
+</html>