5 files changed, 524 insertions, 0 deletions

diff --git a/doc/OpenSim_README.md b/doc/OpenSim_README.md
new file mode 100644
index 0000000..59b7553
--- /dev/null
+++ b/doc/OpenSim_README.md
@@ -0,0 +1,122 @@
+# OpenSim-SC
+
+OpenSim-SC is a fork of OpenSim.  See the index.html file for details. 
+The rest of this file is the OpenSim README.md, some of which may be out
+of date.
+
+
+
+Welcome to OpenSim!
+
+# Overview
+
+OpenSim is a BSD Licensed Open Source project to develop a functioning
+virtual worlds server platform capable of supporting multiple clients
+and servers in a heterogeneous grid structure. OpenSim is written in
+C#, and can run under Mono or the Microsoft .NET runtimes.
+
+This is considered an alpha release.  Some stuff works, a lot doesn't.
+If it breaks, you get to keep *both* pieces.
+
+# Compiling OpenSim
+
+Please see BUILDING.md if you downloaded a source distribution and 
+need to build OpenSim before running it.
+
+# Running OpenSim on Windows
+
+You will need .NET 4.0 installed to run OpenSimulator.
+
+We recommend that you run OpenSim from a command prompt on Windows in order
+to capture any errors.
+
+To run OpenSim from a command prompt
+
+ * cd to the bin/ directory where you unpacked OpenSim
+ * run OpenSim.exe
+
+Now see the "Configuring OpenSim" section
+
+# Running OpenSim on Linux
+
+You will need Mono >= 2.10.8.1 to run OpenSimulator.  On some Linux distributions you
+may need to install additional packages.  See http://opensimulator.org/wiki/Dependencies
+for more information.
+
+To run OpenSim, from the unpacked distribution type:
+
+ * cd bin
+ * mono OpenSim.exe
+
+Now see the "Configuring OpenSim" section
+
+# Configuring OpenSim
+
+When OpenSim starts for the first time, you will be prompted with a
+series of questions that look something like:
+
+        [09-17 03:54:40] DEFAULT REGION CONFIG: Simulator Name [OpenSim Test]:
+
+For all the options except simulator name, you can safely hit enter to accept
+the default if you want to connect using a client on the same machine or over
+your local network.
+
+You will then be asked "Do you wish to join an existing estate?".  If you're
+starting OpenSim for the first time then answer no (which is the default) and
+provide an estate name.
+
+Shortly afterwards, you will then be asked to enter an estate owner first name,
+last name, password and e-mail (which can be left blank).  Do not forget these
+details, since initially only this account will be able to manage your region
+in-world.  You can also use these details to perform your first login.
+
+Once you are presented with a prompt that looks like:
+
+        Region (My region name) #
+
+You have successfully started OpenSim.
+
+If you want to create another user account to login rather than the estate
+account, then type "create user" on the OpenSim console and follow the prompts.
+
+Helpful resources:
+ * http://opensimulator.org/wiki/Configuration
+ * http://opensimulator.org/wiki/Configuring_Regions
+
+# Connecting to your OpenSim
+
+By default your sim will be available for login on port 9000.  You can login by
+adding -loginuri http://127.0.0.1:9000 to the command that starts Second Life
+(e.g. in the Target: box of the client icon properties on Windows).  You can
+also login using the network IP address of the machine running OpenSim (e.g.
+http://192.168.1.2:9000)
+
+To login, use the avatar details that you gave for your estate ownership or the
+one you set up using the "create user" command.
+
+# Bug reports
+
+In the very likely event of bugs biting you (err, your OpenSim) we
+encourage you to see whether the problem has already been reported on
+the [OpenSim mantis system](http://opensimulator.org/mantis/main_page.php).
+
+If your bug has already been reported, you might want to add to the
+bug description and supply additional information.
+
+If your bug has not been reported yet, file a bug report ("opening a
+mantis"). Useful information to include:
+ * description of what went wrong
+ * stack trace
+ * OpenSim.log (attach as file)
+ * OpenSim.ini (attach as file)
+ * if running under mono: run OpenSim.exe with the "--debug" flag:
+
+       mono --debug OpenSim.exe
+
+# More Information on OpenSim
+
+More extensive information on building, running, and configuring
+OpenSim, as well as how to report bugs, and participate in the OpenSim
+project can always be found at http://opensimulator.org.
+
+Thanks for trying OpenSim, we hope it is a pleasant experience.
diff --git a/doc/configuration.html b/doc/configuration.html
new file mode 100644
index 0000000..0f42529
--- /dev/null
+++ b/doc/configuration.html
@@ -0,0 +1,136 @@
+<html>
+<title>opensim-SC configuration documentation</title>
+<head>
+</head>
+<body bgcolor="black" text="white" alink="red" link="blue" vlink="purple">
+
+<p>opensim-SC uses the same configurations as <a
+href="http://opensimulator.org/wiki/Main_Page">OpenSim</a>, with some
+small changes, so please refer to their <a
+href="http://opensimulator.org/wiki/Configuration">documentation</a>. 
+Only the differences will be detailed here.</p>
+
+<p>OpenSim ships with some pre-compiled executables and libraries, plus
+other files in it's own bin/ directory, and wants to write the rest of
+it's files there as well.  Some existing configuration options let you
+move some of those writable areas out of the tree, but not all. 
+opensim-SC tries to move all writable stuff and configuration out of
+tree, to make updates easier.  InstallItAll.sh builds this structure in
+/opt/opensim_SC, and copies itself to /opt/opensim_SC/opensim-SC.</p>
+
+<p>The two main configuration files are
+/opt/opensim_SC/opensim-SC/bin/Robust.ini and
+/opt/opensim_SC/opensim-SC/bin/OpenSimDefaults.ini. You should not modify
+those.  They include files from
+/opt/opensim_SC/opensim-SC/bin/config-include, which you should also not
+modify.  Instead there are various directories and config files in
+/opt/opensim_SC/config where you can over ride the configuration options
+you want to change.</p>
+
+<h1>/opt/opensim_SC/config/config.ini</h1>
+
+<p>This will start as a copy of one of the
+/opt/opensim_SC/opensim-SC/bin/config-include/config_*.ini files.  Copy
+config_localhost.ini if you want to run your own grid, or one of the
+others if you want to connect to IG or MG.  It is used by both ROBUST and
+by sims.  It must be NOT world readable, as it contains your database
+login details.</p>
+
+<p>By default this file includes two sections.  [Paths] and [Const], but
+you can add more sections in this file if you need to override those
+sections from the configuration files in the bin/ directory.</p>
+
+<p>[Paths] is the paths to the various movable directories, relative to
+the /opt/opensim_SC/opensim-SC/bin/ directory.
+
+<ul>
+<li>AssetsPath - where your assets are stored.</li>
+<li>BackupPath - where IAR and OAR backup files are created.</li>
+<li>CachePath - the directory that holds various caches.</li>
+<li>ConfigPath - this /opt/opensim_SC/config/ directory that we are describing.</li>
+<li>DbPath - a directory with some small statistics databases.</li>
+<li>LogPath - where the logs and console history are kept.</li>
+<li>WebPath - where the various web pages are served from.</li>
+</ul>
+
+<p>[Const] is various constants used in the rest of the configuration
+files, so you can define these here once.</p>
+
+<ul>
+<li>MOTD - the message that is shown to people when they log on.</li>
+<li>GridName - the name of the grid.</li>
+<li>ShortGridName - the short name of the grid, usually the initials of GridName.</li>
+<li>BaseHostName - a HTTP URL that is used as the base of all other URLs.</li>
+<li>HostName - the domain name of your grid.</li>
+<li>BaseURL - built from BaseHostName usually.</li>
+<li>GridURL - built from BaseHostName usually.</li>
+<li>SSLURL - built from HostName usually.</li>
+<li>PublicPort - public port used by ROBUST services.</li>
+<li>PrivatePort - private port used by ROBUST services.</li>
+<li>PublicSSLPort - public port used by ROBUST services in SSL mode.</li>
+<li>AssetServerPort - public port used by the ROBUST asset service.</li>
+<li>DataProvider - used to select between the various SQL backends, though opensim-SC only supports MariaDB / MySQL.</li>
+<li>ConnectionString - the details of how to connect to your SQL backend.  This contains credentials that need to be protected from others reading them.</li>
+</ul>
+
+<p>NOTE - though SSL is mentioned above, SSL is not well supported in
+OpenSims own web server.  They wrote their own, the SSL parts are not
+well tested, being rarely used.  Probably best to not use SSL now.  In
+the next major version of opensim-SC I intend to use an external web
+server, and shift things over to it.  Lighttpd is the likely choice.</p>
+
+<h1>/opt/opensim_SC/config/ROBUST/RobustExtra.ini</h1>
+
+<p>This is where you would override ROBUST specific configuration options.  By default it will be empty.</p>
+
+<h1>/opt/opensim_SC/config/simXX/ThisSim.ini</h1>
+
+<p>For each sim you need to specify certain options, and you can override
+others.  /opt/opensim_SC/config/sim_skeleton/ThisSim.ini is a template
+used by the create_sim script to create this file.  Newer versions of
+create_sim might give this file the name of the sim, My_New_Sim.ini.</p>
+
+<p>The "SIM_*" bits get replaced with actual information for each sim. 
+It has it's own [Const] section, which only contains mysim, the number of
+this sim.  The [Startup] section defines various file locations.  The
+[Network] section defines the public port for this sim.</p>
+
+<p>OpenSim had the [Region] section in different files, in two
+different formats, instead opensim-SC includes that info here so it's all
+in one place per sim.  RegionName is the name of your sim, the rest are
+described in OpenSims <a
+href="http://opensimulator.org/wiki/Configuring_Regions">Configuring
+Regions</a> page.</p>
+
+<p>The [Performance] section is new to opensim-SC.  It includes one of the
+/opt/opensim_SC/opensim-SC/bin/config-include/Sim*.ini files that give
+you a choice of performance trade offs.</p>
+
+<h1>New options.</h1>
+
+<p>There have been some additional options added to support new features.  Some have been mentioned above.</p>
+
+<ul>
+  <li>[AuthorizationService]</li>
+  <ul>
+    <li>DefaultRegionAccess - Set the default access restriction for any sim not otherwise mentioned in this section.</li>
+  </ul>
+  <li>[Groups]</li>
+  <ul>
+    <li>AddDefaultGroup - automatically add any members of your grid to this | separated list of groups.</li>
+    <li>AddHGDefaultGroup_othergrid.com - same as above, but for hypergrid visitors from a specific grid.</li>
+  </ul>
+  <li>[GodNames]</li>
+  <ul>
+    <li>FirstNames - similar to the other GodNames options, but this is a list of first names that designate gods for viewers.  Note that viewers may not support this.</li>
+  </ul>
+</ul>
+
+<h1>Removed options.</h1>
+
+<p>Some options have been removed.  Mostly limitations, or useless cruft. 
+You wont miss them.  In one instance a viewer bug that had been fixed a
+decade ago, was still being forbidden in OpenSim.</p>
+
+</body>
+</html>
diff --git a/doc/index.html b/doc/index.html
new file mode 100644
index 0000000..ad4352d
--- /dev/null
+++ b/doc/index.html
@@ -0,0 +1,101 @@
+<html>
+<title>opensim-SC documenation</title>
+<head>
+</head>
+<body bgcolor="black" text="white" alink="red" link="blue" vlink="purple">
+<h1>What is opensim-SC?</h1>
+
+<p>opensim-SC is a fork of <a
+href="http://opensimulator.org/wiki/Main_Page">OpenSim</a>, and OpenSim
+is a clean room fork of  <a
+href="http://wiki.secondlife.com/wiki/Main_Page">Second Life</a>.  They
+are all 3D virtual worlds that are open, users can create their own
+content, these are not games.  Second Life is a proprietary server, with
+open source viewer.  OpenSim is an open source server that works with
+Second Life viewers.</p>
+
+<p>The SC in opensim-SC stands for SledjChisl, part of the <a href="https://sledjhamr.org/git/docs/index.html">SledjHamr</a> project.</p>
+
+<p>&nbsp;</p>
+
+<h1>What is SledjHamr?</h1>
+
+<p>opensim-SC is part of the SledjHamr project.  SledjHamr will be a
+rewrite from scratch of Second Life (SL) / OpenSim (OS) style 3D online
+virtual world client / server.  The plan is to use OS server and SL
+clients as crutches, when a bit of SledjHamr is ready, it replaces the
+matching bit in OS/SL.</p>
+
+<h2>SledjHamr - tearing down the garden walls.</h2>
+
+<p>&nbsp;</p>
+<h1>What is SledjChisl?</h1>
+
+<p>While OpenSim is slowly morphing into SledjHamr, it needed a name, so
+I called it SledjChisl.  The main differences between opensim-SC and
+OpenSim are listed in <a
+href="../Differences.txt">Differences.txt</a></p>
+
+<h2>SledjChisl - chipping away at OpenSim until it's all gone, and is now SledjHamr.</h2>
+
+<p>&nbsp;</p>
+<h1>Enough of the bad puns, what is it all about?</h1>
+
+<p>It's a 3D open online shared virtual world that is user created.  Using a
+specialised bit of software called a viewer you log onto one of these
+worlds, either Second Life, or one of the many OpenSim based worlds.  You
+then get to wander around a 3D world that the other users have built,
+and do many things.  Including building your own bit of the world using
+the viewer itself.</p>
+
+<h3>It's not a game.</h3>
+
+<p>Many people think of it as a game, but it's missing many of the features
+of a real game, and tends to be more about the social side of things. 
+I've even had someone tell me that everything online is a game, even
+pointing out that their bank account is online didn't help.  There is no
+goal, no game play, no levelling up, no one keeps score.  You do what you
+want in these worlds (within the limits of the local rules), and that
+might include playing games that people have created in the world, but
+you don't have to.</p>
+
+<p>People even do business in them.</p>
+
+
+<h1>What do I do with opensim-SC?</h1>
+
+<p>The easiest thing to do is to just join a world that is running
+opensim-SC, but you don't need this software for doing that.  This
+software is for running such a world, or part of it.</p>
+
+<p>Virtual world software is complex software, coz you are simulating an
+entire world.  There's lots of things to take care of.  While SledjHamr
+aims to make things as simple as possible for ordinary folk, we ain't
+there yet.  opensim-SC is slightly easier to setup than OpenSim, so
+progress has been made.  opensim-SC tries to remain compatible, so for
+more details, refer to the <a
+href="http://opensimulator.org/wiki/Main_Page">OpenSim</a> and <a
+href="http://wiki.secondlife.com/wiki/Main_Page">Second Life</a>
+documentation.</p>
+
+<p>You'll need to be familiar with command lines.  Currently opensim-SC uses
+Linux shell scripts, though that'll change in the next release to be more
+portable to other operating systems.  The shell scripts are for setup and
+basic management, the virtual world software itself is written in
+portable C# that runs on .NET and MONO.</p>
+
+<p>The scripts install and manage everything based on a Debian variation
+of Linux, it's been tested under Debian, Devuan, and Ubuntu.  Refer to
+INSTALL.md for installation details.</p>
+
+<p>The <a href="scripts.html">scripts are documented here</a>.</p>
+
+<p>The <a href="configuration.html">new configuration setup and options are documented here</a>.</p>
+
+<p>The <a href="web_pages.html">example web pages are documented here</a>.</p>
+
+<p>&nbsp;</p>
+<p>&nbsp;</p>
+<p>&nbsp;</p>
+</body>
+</html>
diff --git a/doc/scripts.html b/doc/scripts.html
new file mode 100644
index 0000000..8551a79
--- /dev/null
+++ b/doc/scripts.html
@@ -0,0 +1,121 @@
+<html>
+<title>opensim-SC scripts documentation</title>
+<head>
+</head>
+<body bgcolor="black" text="white" alink="red" link="blue" vlink="purple">
+<p>There are various scripts included, mostly Bash shell scripts.</p>
+
+<h1>opensim-SC/BuildIt.sh</h1>
+<p>This script will compile, or recompile the entire system.</p>
+
+<h1>opensim-SC/InstallItAll.sh</h1>
+
+<p>Installs everything on a Debian like operating system.  You will need
+to know your root/sudo password and your MariaDB root password, though if
+MariaDB isn't installed, it will be installed.  Note that some recent
+versions of MariaDB want to be passwordless for root.</p>
+
+<h1>opensim-SC/TestIt.sh</h1>
+<p>Runs unit tests on opensim-SC.</p>
+<h1>opensim-SC/nant-color</h1>
+<p>Obsolete since Debian removed nant, but used to be part of the build system.</p>
+<h1>opensim-SC/runprebuild.bat and opensim-SC/runprebuild.sh</h1>
+<p>Parts of the build system.</p>
+<h1>opensim-SC/example/start.sh</h1>
+<p>An example script that runs a specific sim.</p>
+<h1>opensim-SC/scripts/backup-grid.sh</h1>
+<p>Backup the entire grid into gitAR archive files, which are like IAR and OAR files, only with git info in them, and compressed better.</p>
+<h1>opensim-SC/scripts/backup-inventories.sh</h1>
+<p>Backup inventories of anyone that has logged on in since the last time this was run.</p>
+<h1>opensim-SC/scripts/backup-inventory</h1>
+<p>Backup a single accounts inventory.  It's a symlink to start-sim, which figures out what to do based on the name it is called as.</p>
+<h1>opensim-SC/scripts/backup-sims.sh</h1>
+<p>Backup all currently running sims.</p>
+<h1>opensim-SC/scripts/common.sh</h1>
+<p>Common data and functions for the other scripts.</p>
+<h1>opensim-SC/scripts/fix_some_assets.pl</h1>
+<p>An old script to fix some problems caused by a bug in OpenSim.  Not sure it's needed anymore, or even if it'll work.  Probably best to not use it.</p>
+<h1>opensim-SC/scripts/gitAR.sh</h1>
+<p>Script for dealing with gitARs, though not meant to be used by users.</p>
+<h1>opensim-SC/scripts/show-console</h1>
+<p>Show the tmux consoles.</p>
+
+<h1>opensim-SC/scripts/start-sim</h1>
+
+<p>Start / stop sims, backup inventories / sims.  This script does
+different things depending on where it is called from, and the name it is
+called as.  It has afew options you can pass to it on the command line.</p>
+
+<ul>
+<li>-a - Used internally as part of the "start up everything" mentioned below.</li>
+<li>-d X - Define a delay to wait between sims when starting up everything, the default is 60 seconds.</li>
+<li>-q - Don't show the tmux console os start up.</li>
+<li>-w - Wait until the "INITIALIZATION COMPLETE FOR " line shows in the console before continuing.</li>
+</ul>
+
+<h2>Called as backup-inventory</h2>
+<p>Backs up the inventory of the user specified in the arguments to an .iar file and updates the _gitIAR.tar.xz file.</p>
+
+<pre>&nbsp; &nbsp;./backup-inventory Avatar Name</pre>
+
+<h2>Called as backup-sim from config/simXX</h2>
+<p>Backs up the sim to an .oar and updates the _gitOAR.tar.xz file.</p>
+
+<h2>Called as start-sim from config/ROBUST</h2>
+<p>Starts up ROBUST if it is called from the config directory holding the ROBUST configuration.</p>
+
+<h2>Called as start-sim from config/simXX</h2>
+<p>Starts up the sim if it is called from the config directory holding the sim configuration.</p>
+
+<h2>Called as start-sim from opensim-SC/scripts</h2>
+<p>Will start up everything.</p>
+
+<h2>Called as start-sim from opensim-SC/bin</h2>
+<p>Used internally by the "start up everything" process to start up the sims.  It assumes that ROBUST was recently started.</p>
+
+<h2>Called as stop-sim from config/ROBUST</h2>
+<p>Stops ROBUST if it is called from the config director holding the ROBUST configuration.</p>
+
+<h2>Called as stop-sim from config/simXX</h2>
+<p>Stops the sim if it is called from the config director holding the sim
+configuration.  It gives users on the sim a couple of warnings, waits a
+while, then shuts down the sim.</p>
+
+<h1>opensim-SC/scripts/install/create_sim.sh</h1>
+<p>Create a sim.  Ther are several optional arguments.  If an argument is missing or blank, a default is used.</p>
+
+<ul>
+<li>"sim name" - The name of the sime you want, the default is "No name sim XXX" where XXX is a random number.</li>
+<li>1234,1234 - The map location of the sim, the default is some random location.</li>
+<li>256 - The size of the sim, the default is 256 x 256 meters.</li>
+</ul>
+
+<pre>&nbsp; &nbsp;./create_sim "My Dobule Sized Sim", 1234,1234 512</pre>
+
+<h1>opensim-SC/scripts/install/go_live.sh</h1>
+
+<p>Installs the monit config files.  Note that a recent version of Monit
+seems to have issue with this, that I haven't tracked down yet.  Monit
+isn't needed most of the time, and I want to replace it with something
+internal in the next major release.</p>
+
+<h1>opensim-SC/scripts/install/group_migrate.sql</h1>
+<p>An obsolete SQL script for migrating to OS groups.</p>
+<h1>opensim-SC/scripts/install/opensim-monit.conf</h1>
+<p>The template monit config file.</p>
+
+<h1>opensim-SC/scripts/install/opensim.tmux.conf</h1>
+
+<p>The tmux config file.  Note that tmux has a tendency to change how
+their config files work from one version to the next.  It would be wise
+to test this before trying to use it.</p>
+
+<h1>opensim-SC/scripts/install/secure.sh</h1>
+
+<p>Script to properly set ownership and permissions for files and
+directories in opensim-SC.  Once you have a lot of assets, this wil take
+along time.  It is called from InstallItAll.sh</p>
+
+<p>&nbsp;</p>
+</body>
+</html>
diff --git a/doc/web_pages.html b/doc/web_pages.html
new file mode 100644
index 0000000..6a76b00
--- /dev/null
+++ b/doc/web_pages.html
@@ -0,0 +1,44 @@
+<html>
+<title>opensim-SC web pages documentation</title>
+<head>
+</head>
+<body bgcolor="black" text="white" alink="red" link="blue" vlink="purple">
+
+<p>In the examples/web directory there are several example web pages.  In
+the default configuration, these web pages are presented to viewers as
+the various web pages that the viewer can display, as might be listed in
+the viewers grid manager.  They will be available at
+http://example.com:8002/web/, or what ever you configured BaseHostname
+and PublicPort to be.</p>
+
+<p>These web pages are just basic, you can customise them to suit your
+grid.  There are also a few PNG images that you can replace.</p>
+
+<h1>about.html</h1>
+<p>The web page grid managers will show as "web site".  I don't think any viewers actually show or link to this.</p>
+<h1>help.html</h1>
+<p>The web page grid managers will show as "support URL".  I don't think any viewers actually show or link to this.</p>
+<h1>loginpage.html</h1>
+<p>This is the web page shown in viewers when they pick your grid to log onto.</p>
+<h1>password_help.html</h1>
+<p>Viewers will often include this link, usually on the lower right, for helping with passwords.</p>
+<h1>register.html</h1>
+<p>Viewers will often include this link, usually on the lower right, for registering new accounts.</p>
+<h1>stats.html</h1>
+<p>This is basic stats for your grid, not for viewers.  You could register this with stats collection web sites.</p>
+<p>&nbsp;</p>
+<h1>SledjHamr.png</h1>
+<p>The background image used in loginpage.html</p>
+<h1>SledjHamrIcon.png</h1>
+<p>A medium sized icon.</p>
+<h1>SledjHamrIconSmall.png</h1>
+<p>A small icon suitable for the web sites favicon.</p>
+<p>&nbsp;</p>
+<h1>Variables.</h1>
+<p>In each of these pages you can insert variables that will get replaced with current data using -</p>
+<pre>
+&lt;!--#echo var="variable_name" --&gt;
+</pre>
+<p>The stats.html file should contain examples and descritpions of all of these variables.</p>
+</body>
+</html>