From 7cd9e3aadf2cb58fd6274b5d89a85a3b4491ceae Mon Sep 17 00:00:00 2001
From: onefang
Date: Fri, 23 Aug 2019 16:28:02 +1000
Subject: Update documentation.

Write some more.

Correct some spelling errors.

Clean up some out of date stuff.

Make it consistant.

Rearrange things.
---
 doc/OpenSim_README.md  | 122 +++++++++++++++++++++++++++++++++++++++++++++++++
 doc/configuration.html |   8 ++++
 doc/index.html         |  98 +++++++++++++++++++++++++++++++++++++++
 doc/scripts.html       |   8 ++++
 4 files changed, 236 insertions(+)
 create mode 100644 doc/OpenSim_README.md
 create mode 100644 doc/configuration.html
 create mode 100644 doc/index.html
 create mode 100644 doc/scripts.html

(limited to 'doc')

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..9844414
--- /dev/null
+++ b/doc/configuration.html
@@ -0,0 +1,8 @@
+<html>
+<title>opensim-SC configuration documentation</title>
+<head>
+</head>
+<body bgcolor="black" text="white" alink="red" link="blue" vlink="purple">
+<p>&nbsp;</p>
+</body>
+</html>
diff --git a/doc/index.html b/doc/index.html
new file mode 100644
index 0000000..41080e1
--- /dev/null
+++ b/doc/index.html
@@ -0,0 +1,98 @@
+<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 is 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</,>.</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..55b8d26
--- /dev/null
+++ b/doc/scripts.html
@@ -0,0 +1,8 @@
+<html>
+<title>opensim-SC scripts documentation</title>
+<head>
+</head>
+<body bgcolor="black" text="white" alink="red" link="blue" vlink="purple">
+<p>&nbsp;</p>
+</body>
+</html>
-- 
cgit v1.1