From 35b9e38c17ce04d07ea6e926a405dc7c060b6ea3 Mon Sep 17 00:00:00 2001
From: onefang
Date: Fri, 23 Aug 2019 09:48:29 +1000
Subject: Shuffle some coder level docs to it's own directory.
---
doc/README | 20 ----
doc/doxygen.conf | 290 -------------------------------------------------------
2 files changed, 310 deletions(-)
delete mode 100644 doc/README
delete mode 100644 doc/doxygen.conf
(limited to 'doc')
diff --git a/doc/README b/doc/README
deleted file mode 100644
index 9c95557..0000000
--- a/doc/README
+++ /dev/null
@@ -1,20 +0,0 @@
-README
-
-This directory does not currently contain any OpenSimulator user level documentation. Such
-documentation can be found at
-
-http://opensimulator.org
-
-instead.
-
-Rather, this directory can contain source-code documentation as generated via the doxygen package.
-
-To do this, either execute
-
-doxygen doxygen.conf
-
-on the command line or run the target
-
-nant doxygen
-
-if you have nant installed.
diff --git a/doc/doxygen.conf b/doc/doxygen.conf
deleted file mode 100644
index 148de9c..0000000
--- a/doc/doxygen.conf
+++ /dev/null
@@ -1,290 +0,0 @@
-# Doxyfile 1.8.2
-
-#---------------------------------------------------------------------------
-# Project related configuration options
-#---------------------------------------------------------------------------
-DOXYFILE_ENCODING = UTF-8
-PROJECT_NAME = OpenSim
-PROJECT_NUMBER = GIT
-PROJECT_BRIEF =
-PROJECT_LOGO =
-OUTPUT_DIRECTORY =
-CREATE_SUBDIRS = NO
-OUTPUT_LANGUAGE = English
-BRIEF_MEMBER_DESC = YES
-REPEAT_BRIEF = YES
-ABBREVIATE_BRIEF =
-ALWAYS_DETAILED_SEC = NO
-INLINE_INHERITED_MEMB = NO
-FULL_PATH_NAMES = YES
-STRIP_FROM_PATH =
-STRIP_FROM_INC_PATH =
-SHORT_NAMES = NO
-JAVADOC_AUTOBRIEF = NO
-QT_AUTOBRIEF = NO
-MULTILINE_CPP_IS_BRIEF = NO
-INHERIT_DOCS = YES
-SEPARATE_MEMBER_PAGES = NO
-TAB_SIZE = 8
-ALIASES =
-TCL_SUBST =
-OPTIMIZE_OUTPUT_FOR_C = NO
-OPTIMIZE_OUTPUT_JAVA = NO
-OPTIMIZE_FOR_FORTRAN = NO
-OPTIMIZE_OUTPUT_VHDL = NO
-EXTENSION_MAPPING =
-MARKDOWN_SUPPORT = YES
-AUTOLINK_SUPPORT = YES
-BUILTIN_STL_SUPPORT = NO
-CPP_CLI_SUPPORT = NO
-SIP_SUPPORT = NO
-IDL_PROPERTY_SUPPORT = YES
-DISTRIBUTE_GROUP_DOC = NO
-SUBGROUPING = YES
-INLINE_GROUPED_CLASSES = NO
-INLINE_SIMPLE_STRUCTS = NO
-TYPEDEF_HIDES_STRUCT = NO
-SYMBOL_CACHE_SIZE = 0
-LOOKUP_CACHE_SIZE = 0
-#---------------------------------------------------------------------------
-# Build related configuration options
-#---------------------------------------------------------------------------
-EXTRACT_ALL = YES
-EXTRACT_PRIVATE = NO
-EXTRACT_PACKAGE = NO
-EXTRACT_STATIC = NO
-EXTRACT_LOCAL_CLASSES = YES
-EXTRACT_LOCAL_METHODS = NO
-EXTRACT_ANON_NSPACES = NO
-HIDE_UNDOC_MEMBERS = NO
-HIDE_UNDOC_CLASSES = NO
-HIDE_FRIEND_COMPOUNDS = NO
-HIDE_IN_BODY_DOCS = NO
-INTERNAL_DOCS = NO
-CASE_SENSE_NAMES = YES
-HIDE_SCOPE_NAMES = NO
-SHOW_INCLUDE_FILES = YES
-FORCE_LOCAL_INCLUDES = NO
-INLINE_INFO = YES
-SORT_MEMBER_DOCS = YES
-SORT_BRIEF_DOCS = NO
-SORT_MEMBERS_CTORS_1ST = NO
-SORT_GROUP_NAMES = NO
-SORT_BY_SCOPE_NAME = NO
-STRICT_PROTO_MATCHING = NO
-GENERATE_TODOLIST = YES
-GENERATE_TESTLIST = YES
-GENERATE_BUGLIST = YES
-GENERATE_DEPRECATEDLIST= YES
-ENABLED_SECTIONS =
-MAX_INITIALIZER_LINES = 30
-SHOW_USED_FILES = YES
-SHOW_FILES = YES
-SHOW_NAMESPACES = YES
-FILE_VERSION_FILTER =
-LAYOUT_FILE =
-CITE_BIB_FILES =
-#---------------------------------------------------------------------------
-# configuration options related to warning and progress messages
-#---------------------------------------------------------------------------
-QUIET = NO
-WARNINGS = YES
-WARN_IF_UNDOCUMENTED = YES
-WARN_IF_DOC_ERROR = YES
-WARN_NO_PARAMDOC = NO
-WARN_FORMAT = "$file:$line: $text"
-WARN_LOGFILE = doxygen.error.log
-#---------------------------------------------------------------------------
-# configuration options related to the input files
-#---------------------------------------------------------------------------
-INPUT = ../OpenSim
-INPUT_ENCODING = UTF-8
-FILE_PATTERNS =
-RECURSIVE = YES
-EXCLUDE =
-EXCLUDE_SYMLINKS = NO
-EXCLUDE_PATTERNS =
-EXCLUDE_SYMBOLS =
-EXAMPLE_PATH =
-EXAMPLE_PATTERNS =
-EXAMPLE_RECURSIVE = NO
-IMAGE_PATH =
-INPUT_FILTER =
-FILTER_PATTERNS =
-FILTER_SOURCE_FILES = NO
-FILTER_SOURCE_PATTERNS =
-#---------------------------------------------------------------------------
-# configuration options related to source browsing
-#---------------------------------------------------------------------------
-SOURCE_BROWSER = NO
-INLINE_SOURCES = NO
-STRIP_CODE_COMMENTS = YES
-REFERENCED_BY_RELATION = NO
-REFERENCES_RELATION = NO
-REFERENCES_LINK_SOURCE = YES
-USE_HTAGS = NO
-VERBATIM_HEADERS = YES
-#---------------------------------------------------------------------------
-# configuration options related to the alphabetical class index
-#---------------------------------------------------------------------------
-ALPHABETICAL_INDEX = NO
-COLS_IN_ALPHA_INDEX = 5
-IGNORE_PREFIX =
-#---------------------------------------------------------------------------
-# configuration options related to the HTML output
-#---------------------------------------------------------------------------
-GENERATE_HTML = YES
-HTML_OUTPUT = html
-HTML_FILE_EXTENSION = .html
-HTML_HEADER =
-HTML_FOOTER =
-HTML_STYLESHEET =
-HTML_EXTRA_STYLESHEET =
-HTML_EXTRA_FILES =
-HTML_COLORSTYLE_HUE = 220
-HTML_COLORSTYLE_SAT = 100
-HTML_COLORSTYLE_GAMMA = 80
-HTML_TIMESTAMP = YES
-HTML_DYNAMIC_SECTIONS = NO
-HTML_INDEX_NUM_ENTRIES = 100
-GENERATE_DOCSET = NO
-DOCSET_FEEDNAME = "OpenSimulator docs"
-DOCSET_BUNDLE_ID = org.opensimulator.OpenSim
-DOCSET_PUBLISHER_ID = org.opensimulator.OpenSim
-DOCSET_PUBLISHER_NAME = OpenSim
-GENERATE_HTMLHELP = NO
-CHM_FILE =
-HHC_LOCATION =
-GENERATE_CHI = NO
-CHM_INDEX_ENCODING =
-BINARY_TOC = NO
-TOC_EXPAND = NO
-GENERATE_QHP = NO
-QCH_FILE =
-QHP_NAMESPACE = org.opensimulator.OpenSim
-QHP_VIRTUAL_FOLDER = doc
-QHP_CUST_FILTER_NAME =
-QHP_CUST_FILTER_ATTRS =
-QHP_SECT_FILTER_ATTRS =
-QHG_LOCATION =
-GENERATE_ECLIPSEHELP = NO
-ECLIPSE_DOC_ID = org.opensimulator.OpenSim
-DISABLE_INDEX = NO
-GENERATE_TREEVIEW = NO
-ENUM_VALUES_PER_LINE = 4
-TREEVIEW_WIDTH = 250
-EXT_LINKS_IN_WINDOW = NO
-FORMULA_FONTSIZE = 10
-FORMULA_TRANSPARENT = YES
-USE_MATHJAX = NO
-MATHJAX_RELPATH = http://cdn.mathjax.org/mathjax/latest
-MATHJAX_EXTENSIONS =
-SEARCHENGINE = YES
-SERVER_BASED_SEARCH = NO
-#---------------------------------------------------------------------------
-# configuration options related to the LaTeX output
-#---------------------------------------------------------------------------
-GENERATE_LATEX = NO
-LATEX_OUTPUT = latex
-LATEX_CMD_NAME = latex
-MAKEINDEX_CMD_NAME = makeindex
-COMPACT_LATEX = NO
-PAPER_TYPE = a4wide
-EXTRA_PACKAGES =
-LATEX_HEADER =
-LATEX_FOOTER =
-PDF_HYPERLINKS = YES
-USE_PDFLATEX = YES
-LATEX_BATCHMODE = NO
-LATEX_HIDE_INDICES = NO
-LATEX_SOURCE_CODE = NO
-LATEX_BIB_STYLE = plain
-#---------------------------------------------------------------------------
-# configuration options related to the RTF output
-#---------------------------------------------------------------------------
-GENERATE_RTF = NO
-RTF_OUTPUT = rtf
-COMPACT_RTF = NO
-RTF_HYPERLINKS = NO
-RTF_STYLESHEET_FILE =
-RTF_EXTENSIONS_FILE =
-#---------------------------------------------------------------------------
-# configuration options related to the man page output
-#---------------------------------------------------------------------------
-GENERATE_MAN = NO
-MAN_OUTPUT = man
-MAN_EXTENSION = .3
-MAN_LINKS = NO
-#---------------------------------------------------------------------------
-# configuration options related to the XML output
-#---------------------------------------------------------------------------
-GENERATE_XML = NO
-XML_OUTPUT = xml
-XML_SCHEMA =
-XML_DTD =
-XML_PROGRAMLISTING = YES
-#---------------------------------------------------------------------------
-# configuration options for the AutoGen Definitions output
-#---------------------------------------------------------------------------
-GENERATE_AUTOGEN_DEF = NO
-#---------------------------------------------------------------------------
-# configuration options related to the Perl module output
-#---------------------------------------------------------------------------
-GENERATE_PERLMOD = NO
-PERLMOD_LATEX = NO
-PERLMOD_PRETTY = YES
-PERLMOD_MAKEVAR_PREFIX =
-#---------------------------------------------------------------------------
-# Configuration options related to the preprocessor
-#---------------------------------------------------------------------------
-ENABLE_PREPROCESSING = YES
-MACRO_EXPANSION = NO
-EXPAND_ONLY_PREDEF = NO
-SEARCH_INCLUDES = YES
-INCLUDE_PATH =
-INCLUDE_FILE_PATTERNS =
-PREDEFINED =
-EXPAND_AS_DEFINED =
-SKIP_FUNCTION_MACROS = YES
-#---------------------------------------------------------------------------
-# Configuration::additions related to external references
-#---------------------------------------------------------------------------
-TAGFILES =
-GENERATE_TAGFILE =
-ALLEXTERNALS = NO
-EXTERNAL_GROUPS = YES
-PERL_PATH = /usr/bin/perl
-#---------------------------------------------------------------------------
-# Configuration options related to the dot tool
-#---------------------------------------------------------------------------
-CLASS_DIAGRAMS = YES
-MSCGEN_PATH =
-HIDE_UNDOC_RELATIONS = YES
-HAVE_DOT = NO
-DOT_NUM_THREADS = 0
-DOT_FONTNAME = Helvetica
-DOT_FONTSIZE = 10
-DOT_FONTPATH =
-CLASS_GRAPH = YES
-COLLABORATION_GRAPH = YES
-GROUP_GRAPHS = YES
-UML_LOOK = NO
-UML_LIMIT_NUM_FIELDS = 10
-TEMPLATE_RELATIONS = NO
-INCLUDE_GRAPH = YES
-INCLUDED_BY_GRAPH = YES
-CALL_GRAPH = NO
-CALLER_GRAPH = NO
-GRAPHICAL_HIERARCHY = YES
-DIRECTORY_GRAPH = YES
-DOT_IMAGE_FORMAT = png
-INTERACTIVE_SVG = NO
-DOT_PATH =
-DOTFILE_DIRS =
-MSCFILE_DIRS =
-DOT_GRAPH_MAX_NODES = 50
-MAX_DOT_GRAPH_DEPTH = 0
-DOT_TRANSPARENT = YES
-DOT_MULTI_TARGETS = NO
-GENERATE_LEGEND = YES
-DOT_CLEANUP = YES
--
cgit v1.1
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 @@
+
+opensim-SC configuration documentation
+
+
+
+
+
+
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 @@
+
+opensim-SC documenation
+
+
+
+What is opensim-SC?
+
+opensim-SC is a fork of OpenSim, and OpenSim
+is a clean room fork of Second Life. 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.
+
+The SC in opensim-SC stands for SledjChisl, part of the SledjHamr project.
+
+
+
+What is SledjHamr?
+
+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.
+
+SledjHamr - tearing down the garden walls.
+
+
+What is SledjChisl?
+
+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 Differences.txt
+
+SledjChisl - chipping away at OpenSim until it's all gone, and is now SledjHamr.
+
+
+Enough of the bad puns, what is it all about?
+
+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.
+
+It's not a game.
+
+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.
+
+People even do business in them.
+
+
+What do I do with opensim-SC?
+
+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.
+
+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 OpenSim and Second Life
+documentation.
+
+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.
+
+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.
+
+The scripts are documented here.
+
+The new configuration setup and options are documented here.
+
+
+
+
+
+
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 @@
+
+opensim-SC scripts documentation
+
+
+
+
+
+
--
cgit v1.1
From cd7d481dab44b58664ddae69fe9d11e2f2470b7c Mon Sep 17 00:00:00 2001
From: onefang
Date: Sun, 25 Aug 2019 14:15:52 +1000
Subject: One more empty doc page.
---
doc/web_pages.html | 8 ++++++++
1 file changed, 8 insertions(+)
create mode 100644 doc/web_pages.html
(limited to 'doc')
diff --git a/doc/web_pages.html b/doc/web_pages.html
new file mode 100644
index 0000000..ceae37f
--- /dev/null
+++ b/doc/web_pages.html
@@ -0,0 +1,8 @@
+
+opensim-SC web pages documentation
+
+
+
+
+
+
--
cgit v1.1
From 93ae7b3c229962d28b46ffc7b1890fa72f82c264 Mon Sep 17 00:00:00 2001
From: onefang
Date: Mon, 26 Aug 2019 03:45:12 +1000
Subject: Document the web pages.
---
doc/web_pages.html | 36 ++++++++++++++++++++++++++++++++++++
1 file changed, 36 insertions(+)
(limited to 'doc')
diff --git a/doc/web_pages.html b/doc/web_pages.html
index ceae37f..4ea5aa3 100644
--- a/doc/web_pages.html
+++ b/doc/web_pages.html
@@ -3,6 +3,42 @@
+
+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.
+
+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.
+
+about.html
+The web page grid managers will show as "web site".
+help.html
+The web page grid managers will show as "support URL".
+loginpage.html
+This is the web page shown in viewers when they pick your grid to log onto.
+password_help.html
+Viewers will often include this link, usually on the lower right, for helping with passwords.
+register.html
+Viewers will often include this link, usually on the lower right, for registering new accounts.
+stats.html
+This is basic stats for your grid, not for viewers. You could register this with stats collection web sites.
+SledjHamr.png
+The background image used in loginpage.html
+SledjHamrIcon.png
+A medium sized icon.
+SledjHamrIconSmall.png
+A small icon suitable for the web sites favicon.
+
+Variables.
+In each of these pages you can insert variables that will get replaced with current data using -
+
+<!--#echo var="variable_name" -->
+
+The stats.html file should contain examples and descritpions of all of these variables.