aboutsummaryrefslogtreecommitdiffstatshomepage
diff options
context:
space:
mode:
authoronefang2019-08-23 16:28:02 +1000
committeronefang2019-08-23 16:28:02 +1000
commit7cd9e3aadf2cb58fd6274b5d89a85a3b4491ceae (patch)
tree0c4bd2156e7ec631d8cd8fd22acc91e04a1a0c2e
parentUpdate the differences. (diff)
downloadopensim-SC_OLD-7cd9e3aadf2cb58fd6274b5d89a85a3b4491ceae.zip
opensim-SC_OLD-7cd9e3aadf2cb58fd6274b5d89a85a3b4491ceae.tar.gz
opensim-SC_OLD-7cd9e3aadf2cb58fd6274b5d89a85a3b4491ceae.tar.bz2
opensim-SC_OLD-7cd9e3aadf2cb58fd6274b5d89a85a3b4491ceae.tar.xz
Update documentation.
Write some more. Correct some spelling errors. Clean up some out of date stuff. Make it consistant. Rearrange things.
-rw-r--r--CONTRIBUTORS.txt10
-rw-r--r--Differences.txt10
-rw-r--r--INSTALL.md118
-rw-r--r--OpenSim/Framework/VersionInfo.cs2
-rw-r--r--README.md143
-rw-r--r--bin/OpenSim.ini2
-rw-r--r--bin/config-include/GridCommon.ini2
-rw-r--r--coderDocs/TODO.txt18
-rw-r--r--doc/OpenSim_README.md122
-rw-r--r--doc/configuration.html8
-rw-r--r--doc/index.html98
-rw-r--r--doc/scripts.html8
-rw-r--r--example/web/about.html2
-rw-r--r--example/web/register.html2
14 files changed, 336 insertions, 209 deletions
diff --git a/CONTRIBUTORS.txt b/CONTRIBUTORS.txt
index f6a98a2..2ff4e9d 100644
--- a/CONTRIBUTORS.txt
+++ b/CONTRIBUTORS.txt
@@ -1,14 +1,14 @@
1The following people have contributed to OpenSim (Thank you for your 1The following people have contributed to OpenSim (Thank you for your
2effort!) 2effort!)
3 3
4= Current OpenSim-SC fork developers. 4= Current opensim-SC fork developers.
5These folks represent the current core team for OpenSim-SC fork, and are 5These folks represent the current core team for opensim-SC fork, and are
6the people that make the day to day of OpenSim happen. 6the people that make the day to day of opensim-SC happen.
7 7
8* onefang rejected 8* onefang rejected
9 9
10= Additional OpenSim-SC fork contributors = 10= Additional opensim-SC fork contributors =
11These folks have contributed code patches or content to OpenSim-SC fork 11These folks have contributed code patches or content to opensim-SC fork
12to help make it what it is today. 12to help make it what it is today.
13 13
14* Taylor Temper 14* Taylor Temper
diff --git a/Differences.txt b/Differences.txt
index 9ae94d0..301cb68 100644
--- a/Differences.txt
+++ b/Differences.txt
@@ -1,19 +1,19 @@
1There are some differences between OpenSim-SC and standard OpenSim. The 1There are some differences between opensim-SC and standard OpenSim. The
2most relevant ones are listed here. 2most relevant ones are listed here.
3 3
4OpenSim-SC really only supports Debian based Linux operating systems at 4opensim-SC really only supports Debian based Linux operating systems at
5this stage. Other operating systems, including Mac OS and Windows, will 5this stage. Other operating systems, including Mac OS and Windows, will
6be added in the future. Only Debian, Devuan, and Ubuntu have been 6be added in the future. Only Debian, Devuan, and Ubuntu have been
7tested. Devuan ASCII is currently the best supported, as that's what I 7tested. Devuan ASCII is currently the best supported, as that's what I
8use. 8use.
9 9
10OpenSim-SC is generally optimised for CG, IG, and MG grids. 10opensim-SC is generally optimised for CG, IG, and MG grids.
11 11
12 12
13Directory layout. 13Directory layout.
14----------------- 14-----------------
15 15
16OpenSim-SC expects to live inside a specific directory structure. The 16opensim-SC expects to live inside a specific directory structure. The
17InstallItAll.sh script creates that directory structure. The external 17InstallItAll.sh script creates that directory structure. The external
18directory structure is in the example/ directory. This tries to move 18directory structure is in the example/ directory. This tries to move
19anything writable and configurable out of the main tree. Should make 19anything writable and configurable out of the main tree. Should make
@@ -87,7 +87,7 @@ Economy.
87-------- 87--------
88 88
89The fake economy module has been faked even further, now your current 89The fake economy module has been faked even further, now your current
90balance displayed is the OpenSim_SC version number of the sim you are in. 90balance displayed is the opensim-SC version number of the sim you are in.
91Obviously this is not a real economy, spending any of it doesn't deduct 91Obviously this is not a real economy, spending any of it doesn't deduct
92from your balance. You can still install a real economy module. 92from your balance. You can still install a real economy module.
93 93
diff --git a/INSTALL.md b/INSTALL.md
index 6b0d234..40bf35b 100644
--- a/INSTALL.md
+++ b/INSTALL.md
@@ -1,15 +1,10 @@
1NOTE - this is the OpenSim 0.9.0.1 version in the SledjChisl branch, 1Use this to create a sim that links into IG or MG grids from Linux. Or
2which isn't quite ready yet. Use 0.8.2.1 in the master branch for the 2to run your own grid.
3stable well tested version.
4
5
6Use this to create a sim that links into Infinite Grid or Misfitz Grid
7from Linux.
8 3
9It's only been tested on Ubuntu 10.04, 11.04, 12.04, 16.04, as well as 4It's only been tested on Ubuntu 10.04, 11.04, 12.04, 16.04, as well as
10Debian 8, and Devuan 9, YMMV. This is also a WIP, use it at your own 5Debian 8, Devuan 9, and Devuan 9. YMMV. This is also a WIP, use it at
11risk. It's been used to set up a few freshly installed servers though. 6your own risk. It's been used to set up a few freshly installed servers
12It should work on recent Debian based Linux distros. 7though. It should work on recent Debian based Linux distros.
13 8
14You may want to use the latest Mono, you can get it by following the 9You may want to use the latest Mono, you can get it by following the
15instructions at - 10instructions at -
@@ -28,11 +23,11 @@ terminal, run the following command -
28This will install the prerequisites (MariaDB, monit, MONO, tmux, 23This will install the prerequisites (MariaDB, monit, MONO, tmux,
29uuid-runtime); create a database in MariaDB called opensim_SC and a 24uuid-runtime); create a database in MariaDB called opensim_SC and a
30database user called opensim_SC with a random password; add a Linux user 25database user called opensim_SC with a random password; add a Linux user
31to your system called opensimsc; create the /opt/opensim_SC directory to 26and group to your system called opensimsc; create the /opt/opensim_SC
32run it all from; copy everything to /opt/opensim_SC/opensim-SC_0.9.0.1; 27directory to run it all from; copy everything to
33setup the directory structure needed to run it all; create some default 28/opt/opensim_SC/opensim-SC_0.9.0.1; setup the directory structure needed
34configuration files; build OpenSim-SC; and finally change ownership and 29to run it all; create some default configuration files; build opensim-SC;
35file permissions for everything. 30and finally change ownership and file permissions for everything.
36 31
37You will likely need to login your user again, so you get the new group 32You will likely need to login your user again, so you get the new group
38assigned to it. Otherwise the tmux stuff in start-sim might fail. 33assigned to it. Otherwise the tmux stuff in start-sim might fail.
@@ -48,21 +43,26 @@ sudo ./create_sim.sh "My new sim" "1234,5678"
48 43
49At this point /opt/opensim_SC/config/config.ini will be a symlink 44At this point /opt/opensim_SC/config/config.ini will be a symlink
50pointing to config_localhost.ini, which is for a standalone sim. If you 45pointing to config_localhost.ini, which is for a standalone sim. If you
51want your new random sim to be part of Infinite Grid (IG) or Misfitz Grid 46want your new random sim to be part of IG or MG grids then you'll have to
52(MG) then you'll have to change that syml/ink to point to config_IG.ini or 47change that syml/ink to point to config_IG.ini or config_MG.ini
53config_MG.ini respectively. 48respectively. There is no point doing that unless you are a member of
49those grids.
54 50
55/opt/opensim_SC/config/sim01 now contains the actual configuration of 51/opt/opensim_SC/config/sim01 now contains the actual configuration of
56your randomly created sim. Edit the .ini file to make that sim a little 52your randomly created sim. Edit the .ini file to make that sim a little
57less random. 53less random. You can even rename the .ini file to match your sim name.
54
55If you are running a grid run -
58 56
59Finally run - 57cd /opt/opensim_SC/config/ROBUSH
58./start-sim
59
60Then to actually startup your sim -
60 61
61cd /opt/opensim_SC/config/sim01 62cd /opt/opensim_SC/config/sim01
62./start-sim 63./start-sim
63 64
64To actually startup your sim. And if you want to see the console of your 65And if you want to see the console of your sim run -
65sim run -
66 66
67cd /opt/opensim_SC/current/scripts 67cd /opt/opensim_SC/current/scripts
68./show-console 68./show-console
@@ -75,7 +75,7 @@ The various directories are -
75 75
76.git Used by git for it's internal accounting, and the older versions. 76.git Used by git for it's internal accounting, and the older versions.
77 77
78.nant Used by the nant build tool. 78.nant Used by the obsolete nant build tool.
79 79
80OpenSim OpenSim source code. 80OpenSim OpenSim source code.
81 81
@@ -113,20 +113,13 @@ db If you are not using MySQL, your data lives here.
113 113
114logs Log files get stored here. 114logs Log files get stored here.
115 115
116web Web files go here. You can edit them to change the background image for example.
117
116 118
117Follow these steps. 119Follow these steps.
118------------------- 120-------------------
119 121
120Go to - 122First you need to have a user on your computer with sudo access.
121
122https://www.infinitegrid.org/drupal/content/How_to_link_your_OpenSim_region_to_Infinite_Grid_LinuxMySQL
123
124and follow the directions to create an admin user account. You can skip
125that bit if you already have a suitable user with sudo access.
126
127Note that these scripts pretty much follow that above wiki description,
128with some exceptions. The configuration information per sim has been
129rearranged so that there is only ONE copy of the OpenSim installation.
130 123
131Next you need to figure out what password you want to use for OpenSims 124Next you need to figure out what password you want to use for OpenSims
132access to the database. We will call this "DatabasePassword". Run the 125access to the database. We will call this "DatabasePassword". Run the
@@ -146,37 +139,45 @@ sims. You will need -
146A name for your sim, we will use "My new sim". It should be unique on 139A name for your sim, we will use "My new sim". It should be unique on
147the grid. 140the grid.
148 141
149Your host name, or it could be your IP, we will use "sims.example.net". 142A location for your sim, we will use "1234,5678". Choose an empty spot.
150
151A location for your sim, we will use "1234,5678". You can use the
152Infinite Grid web based map to poke around and find a good location.
153Choose an empty spot.
154 143
155Once you have all that information sorted out, run this script from the 144Once you have all that information sorted out, run this script from the
156scripts/install directory - 145scripts/install directory -
157 146
158./create_sim.sh "My new sim" "1234,5678" "sims.example.net" 147./create_sim.sh "My new sim" "1234,5678" "sims.example.net"
159 148
160Or this if you want to override the detected IP address - 149Also, you can create a varregion with something like -
161 150
162./create_sim.sh "My new sim" "1234,5678" "sims.example.net" "1.2.3.4" 151./create_sim.sh "My new sim" "1234,5678" 512
163 152
164Also, you can create a varregion with something like - 153Note that the size has to be a multiple of 256, so 512, 768, 1024, etc.
1548096 is the maximum size, 2048 is about the biggest that is decently
155manageable.
165 156
166./create_sim.sh "My new sim" "1234,5678" "sims.example.net" "1.2.3.4" 512
167 157
168Note that the size has to be a multiple of 256, so 512, 768, 1024, etc. 158Running ROBUST.
159---------------
160
161If you are running your own grid, you need to start up ROBUST, which is
162a bunch of common services sims use. Go to /opt/opensim_SC/config/ROBUST
163and run the following script to start it up -
164
165./start-sim
166
167You will see the tmux console. You can run the tmux console again by
168running that command once more, or running the show-console script.
169
169 170
170Running sims. 171Running sims.
171------------- 172-------------
172 173
173Now you can go to /opt/opensim/config/sim01 and run the following script 174Now you can go to /opt/opensim_SC/config/sim01 and run the following script
174to start it up - 175to start it up -
175 176
176./start-sim 177./start-sim
177 178
178You will see the screen console. You can run the screen console again by 179You will see the tmux console. You can run the tmux console again by
179running that command once more, or running the sim-console command. 180running that command once more, or running the show-console script.
180 181
181You can stop the sim with - 182You can stop the sim with -
182 183
@@ -187,12 +188,23 @@ You can backup the sim with -
187./backup-sim 188./backup-sim
188 189
189 190
191Running it all at once.
192-----------------------
193
194You don't have to run ROBUST, then each sim, you can run the lot at once.
195Go to /opt/opensim_SC/current/scripts and run -
196
197./start-sim
198
199It'll wait a minute between sims to give things time to settle down, and
200not over work your computer.
201
190 202
191Finishing up. 203Finishing up.
192------------- 204-------------
193 205
194Once it's all tested, you can use this to finish things off (back in 206Once it's all tested, you can use this to finish things off (back in
195the scripts directory) - 207the /opt/opensim_SC/current/scripts directory) -
196 208
197./go_live.sh 209./go_live.sh
198 210
@@ -201,14 +213,16 @@ it all, and you still have to do the basic configuration and enabling of
201monit yourself. This is in case you already have monit set the way you 213monit yourself. This is in case you already have monit set the way you
202like. 214like.
203 215
216This step is entirely optional, and some versions of monit might not work
217so well.
218
204 219
205NOTES - 220NOTES -
206 221
207This attempts to use only one copy of the OS install for all sims. We 222This attempts to use only one copy of the OS install for all sims. We
208are running one instance of OS for each sim though, as this prevents one 223are running one instance of OS for each sim though, as this prevents one
209sim crashing from bringing down the others. OS however really wants to 224sim crashing from bringing down the others. OS however really wants to
210write data to directories within it's own bin directory. I'm not at all 225write data to directories within it's own bin directory. The preferred
211certain if that data can be shared. For the same reason, so far I've 226way to update opensim-SC is to download a fresh copy, run BuildIt.sh,
212not been able to get to the point where we can make the OS directory 227delete the installed copy, then copy this new one to where the old one
213read only. This complicates things during upgrades. 228used to be. I'll write an update script in the next version.
214
diff --git a/OpenSim/Framework/VersionInfo.cs b/OpenSim/Framework/VersionInfo.cs
index cf0a2a3..0780446 100644
--- a/OpenSim/Framework/VersionInfo.cs
+++ b/OpenSim/Framework/VersionInfo.cs
@@ -55,7 +55,7 @@ namespace OpenSim
55 55
56 public static string GetVersionString(string versionNumber, string buildNumber, Flavour flavour) 56 public static string GetVersionString(string versionNumber, string buildNumber, Flavour flavour)
57 { 57 {
58 string versionString = "OpenSim_SC " + versionNumber + " " + flavour + " build " + buildNumber; 58 string versionString = "opensim-SC " + versionNumber + " " + flavour + " build " + buildNumber;
59 return versionString.PadRight(VERSIONINFO_VERSION_LENGTH); 59 return versionString.PadRight(VERSIONINFO_VERSION_LENGTH);
60 } 60 }
61 61
diff --git a/README.md b/README.md
index cc1a26e..c190f28 100644
--- a/README.md
+++ b/README.md
@@ -1,134 +1,9 @@
1WARNING! 1opensim-SC is a fork of OpenSim, and OpenSim is a clean room fork of
2WARNING! 2Second Life. They are all 3D virtual worlds that are open, users can
3 3create their own content, these are not games. Second Life is a
4This isn't complete yet, things are still very much in a state of flux. 4proprietary server, with open source viewer. OpenSim is an open source
5 5server that works with Second Life viewers.
6The scripts directory is still in need of major changes. 6
7 7See doc/index.html for details. INSTALL.md for installation
8You have been WARNED! 8instructions. Differences.txt for the differences between OpenSim and
9 9opensim-SC. coderDocs/ for the coder level documentation.
10WARNING!
11WARNING!
12
13
14
15Welcome to OpenSim!
16
17# Overview
18
19OpenSim is a BSD Licensed Open Source project to develop a functioning
20virtual worlds server platform capable of supporting multiple clients
21and servers in a heterogeneous grid structure. OpenSim is written in
22C#, and can run under Mono or the Microsoft .NET runtimes.
23
24This is considered an alpha release. Some stuff works, a lot doesn't.
25If it breaks, you get to keep *both* pieces.
26
27# OpenSim-SC
28
29OpenSim-SC is a fork of OpenSim. See the Differences.txt file for details.
30
31# Compiling OpenSim
32
33Please see BUILDING.md if you downloaded a source distribution and
34need to build OpenSim before running it.
35
36# Running OpenSim on Windows
37
38You will need .NET 4.0 installed to run OpenSimulator.
39
40We recommend that you run OpenSim from a command prompt on Windows in order
41to capture any errors.
42
43To run OpenSim from a command prompt
44
45 * cd to the bin/ directory where you unpacked OpenSim
46 * run OpenSim.exe
47
48Now see the "Configuring OpenSim" section
49
50# Running OpenSim on Linux
51
52You will need Mono >= 2.10.8.1 to run OpenSimulator. On some Linux distributions you
53may need to install additional packages. See http://opensimulator.org/wiki/Dependencies
54for more information.
55
56To run OpenSim, from the unpacked distribution type:
57
58 * cd bin
59 * mono OpenSim.exe
60
61Now see the "Configuring OpenSim" section
62
63# Configuring OpenSim
64
65When OpenSim starts for the first time, you will be prompted with a
66series of questions that look something like:
67
68 [09-17 03:54:40] DEFAULT REGION CONFIG: Simulator Name [OpenSim Test]:
69
70For all the options except simulator name, you can safely hit enter to accept
71the default if you want to connect using a client on the same machine or over
72your local network.
73
74You will then be asked "Do you wish to join an existing estate?". If you're
75starting OpenSim for the first time then answer no (which is the default) and
76provide an estate name.
77
78Shortly afterwards, you will then be asked to enter an estate owner first name,
79last name, password and e-mail (which can be left blank). Do not forget these
80details, since initially only this account will be able to manage your region
81in-world. You can also use these details to perform your first login.
82
83Once you are presented with a prompt that looks like:
84
85 Region (My region name) #
86
87You have successfully started OpenSim.
88
89If you want to create another user account to login rather than the estate
90account, then type "create user" on the OpenSim console and follow the prompts.
91
92Helpful resources:
93 * http://opensimulator.org/wiki/Configuration
94 * http://opensimulator.org/wiki/Configuring_Regions
95
96# Connecting to your OpenSim
97
98By default your sim will be available for login on port 9000. You can login by
99adding -loginuri http://127.0.0.1:9000 to the command that starts Second Life
100(e.g. in the Target: box of the client icon properties on Windows). You can
101also login using the network IP address of the machine running OpenSim (e.g.
102http://192.168.1.2:9000)
103
104To login, use the avatar details that you gave for your estate ownership or the
105one you set up using the "create user" command.
106
107# Bug reports
108
109In the very likely event of bugs biting you (err, your OpenSim) we
110encourage you to see whether the problem has already been reported on
111the [OpenSim mantis system](http://opensimulator.org/mantis/main_page.php).
112
113If your bug has already been reported, you might want to add to the
114bug description and supply additional information.
115
116If your bug has not been reported yet, file a bug report ("opening a
117mantis"). Useful information to include:
118 * description of what went wrong
119 * stack trace
120 * OpenSim.log (attach as file)
121 * OpenSim.ini (attach as file)
122 * if running under mono: run OpenSim.exe with the "--debug" flag:
123
124 mono --debug OpenSim.exe
125
126# More Information on OpenSim
127
128More extensive information on building, running, and configuring
129OpenSim, as well as how to report bugs, and participate in the OpenSim
130project can always be found at http://opensimulator.org.
131
132Thanks for trying OpenSim, we hope it is a pleasant experience.
133
134
diff --git a/bin/OpenSim.ini b/bin/OpenSim.ini
index bcbed2b..389b3f0 100644
--- a/bin/OpenSim.ini
+++ b/bin/OpenSim.ini
@@ -40,7 +40,7 @@
40 40
41 41
42[Includes] 42[Includes]
43 ;; Uncomment this if using this for Misfitz Grid. 43 ;; Uncomment this if using this for MG.
44; Include-Extra = "config-include/extra_MG.ini" 44; Include-Extra = "config-include/extra_MG.ini"
45 45
46 46
diff --git a/bin/config-include/GridCommon.ini b/bin/config-include/GridCommon.ini
index 394fa18..26accd9 100644
--- a/bin/config-include/GridCommon.ini
+++ b/bin/config-include/GridCommon.ini
@@ -1,5 +1,5 @@
1; This is the main configuration file for an instance of OpenSim running in grid mode 1; This is the main configuration file for an instance of OpenSim running in grid mode
2; In particular, this one is set up for connecting to Infinite Grid. 2; In particular, this one is set up for connecting to IG or MG.
3 3
4[DatabaseService] 4[DatabaseService]
5 ; 5 ;
diff --git a/coderDocs/TODO.txt b/coderDocs/TODO.txt
index 2d53a2f..bd3c02a 100644
--- a/coderDocs/TODO.txt
+++ b/coderDocs/TODO.txt
@@ -1,4 +1,14 @@
1TODO on release-
2----------------
3Update version numbers.
4git log 8f280962f019d46e0367b29246283a1e34ceb955.. --pretty=format:"%s%n%b%n----------------" > NEWS.new
5 That'll be up to and excluding that revision.
6Clean that up, merge it into NEWS.
7Tag and release.
8
9
1Still to do - 10Still to do -
11-------------
2 12
3Clean up the configs. 13Clean up the configs.
4 Why do we have Include-Common, Include-modules, Include-osslEnable, Include-Architecture, Include-Storage, Include-*Cache ?????? 14 Why do we have Include-Common, Include-modules, Include-osslEnable, Include-Architecture, Include-Storage, Include-*Cache ??????
@@ -37,14 +47,6 @@ mono OpenSim.exe -inidirectory=/opt/opensim-0.9.0.1_MG/config/sim05
37/usr/bin/mono /opt/opensim/current/bin/OpenSim.exe -logconfig=/opt/opensim/config/sim07/OpenSim.exe.config -inifile=/opt/opensim/config/OpenSim.ini -inidirectory=/opt/opensim/config/sim07 47/usr/bin/mono /opt/opensim/current/bin/OpenSim.exe -logconfig=/opt/opensim/config/sim07/OpenSim.exe.config -inifile=/opt/opensim/config/OpenSim.ini -inidirectory=/opt/opensim/config/sim07
38 48
39 49
40Name
41----
42
43UnifiedKidsGrids
44SledjChisel, the version where we chisel away at OpenSim until it's all gone and is now SledjHamr. B-)
45 SledjChisl?
46
47
48 50
49Old TODO 51Old TODO
50-------- 52--------
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 @@
1# OpenSim-SC
2
3OpenSim-SC is a fork of OpenSim. See the index.html file for details.
4The rest of this file is the OpenSim README.md, some of which may be out
5of date.
6
7
8
9Welcome to OpenSim!
10
11# Overview
12
13OpenSim is a BSD Licensed Open Source project to develop a functioning
14virtual worlds server platform capable of supporting multiple clients
15and servers in a heterogeneous grid structure. OpenSim is written in
16C#, and can run under Mono or the Microsoft .NET runtimes.
17
18This is considered an alpha release. Some stuff works, a lot doesn't.
19If it breaks, you get to keep *both* pieces.
20
21# Compiling OpenSim
22
23Please see BUILDING.md if you downloaded a source distribution and
24need to build OpenSim before running it.
25
26# Running OpenSim on Windows
27
28You will need .NET 4.0 installed to run OpenSimulator.
29
30We recommend that you run OpenSim from a command prompt on Windows in order
31to capture any errors.
32
33To run OpenSim from a command prompt
34
35 * cd to the bin/ directory where you unpacked OpenSim
36 * run OpenSim.exe
37
38Now see the "Configuring OpenSim" section
39
40# Running OpenSim on Linux
41
42You will need Mono >= 2.10.8.1 to run OpenSimulator. On some Linux distributions you
43may need to install additional packages. See http://opensimulator.org/wiki/Dependencies
44for more information.
45
46To run OpenSim, from the unpacked distribution type:
47
48 * cd bin
49 * mono OpenSim.exe
50
51Now see the "Configuring OpenSim" section
52
53# Configuring OpenSim
54
55When OpenSim starts for the first time, you will be prompted with a
56series of questions that look something like:
57
58 [09-17 03:54:40] DEFAULT REGION CONFIG: Simulator Name [OpenSim Test]:
59
60For all the options except simulator name, you can safely hit enter to accept
61the default if you want to connect using a client on the same machine or over
62your local network.
63
64You will then be asked "Do you wish to join an existing estate?". If you're
65starting OpenSim for the first time then answer no (which is the default) and
66provide an estate name.
67
68Shortly afterwards, you will then be asked to enter an estate owner first name,
69last name, password and e-mail (which can be left blank). Do not forget these
70details, since initially only this account will be able to manage your region
71in-world. You can also use these details to perform your first login.
72
73Once you are presented with a prompt that looks like:
74
75 Region (My region name) #
76
77You have successfully started OpenSim.
78
79If you want to create another user account to login rather than the estate
80account, then type "create user" on the OpenSim console and follow the prompts.
81
82Helpful resources:
83 * http://opensimulator.org/wiki/Configuration
84 * http://opensimulator.org/wiki/Configuring_Regions
85
86# Connecting to your OpenSim
87
88By default your sim will be available for login on port 9000. You can login by
89adding -loginuri http://127.0.0.1:9000 to the command that starts Second Life
90(e.g. in the Target: box of the client icon properties on Windows). You can
91also login using the network IP address of the machine running OpenSim (e.g.
92http://192.168.1.2:9000)
93
94To login, use the avatar details that you gave for your estate ownership or the
95one you set up using the "create user" command.
96
97# Bug reports
98
99In the very likely event of bugs biting you (err, your OpenSim) we
100encourage you to see whether the problem has already been reported on
101the [OpenSim mantis system](http://opensimulator.org/mantis/main_page.php).
102
103If your bug has already been reported, you might want to add to the
104bug description and supply additional information.
105
106If your bug has not been reported yet, file a bug report ("opening a
107mantis"). Useful information to include:
108 * description of what went wrong
109 * stack trace
110 * OpenSim.log (attach as file)
111 * OpenSim.ini (attach as file)
112 * if running under mono: run OpenSim.exe with the "--debug" flag:
113
114 mono --debug OpenSim.exe
115
116# More Information on OpenSim
117
118More extensive information on building, running, and configuring
119OpenSim, as well as how to report bugs, and participate in the OpenSim
120project can always be found at http://opensimulator.org.
121
122Thanks 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 @@
1<html>
2<title>opensim-SC configuration documentation</title>
3<head>
4</head>
5<body bgcolor="black" text="white" alink="red" link="blue" vlink="purple">
6<p>&nbsp;</p>
7</body>
8</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 @@
1<html>
2<title>opensim-SC documenation</title>
3<head>
4</head>
5<body bgcolor="black" text="white" alink="red" link="blue" vlink="purple">
6<h1>What is opensim-SC?</h1>
7
8<p>opensim-SC is a fork of <a
9href="http://opensimulator.org/wiki/Main_Page">OpenSim</a>, and OpenSim
10is a clean room fork of <a
11href="http://wiki.secondlife.com/wiki/Main_Page">Second Life</a>. They
12are all 3D virtual worlds that are open, users can create their own
13content, these are not games. Second Life is a proprietary server, with
14open source viewer. OpenSim is an open source server that works with
15Second Life viewers.</p>
16
17<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>
18
19<p>&nbsp;</p>
20
21<h1>What is SledjHamr?</h1>
22
23<p>opensim-SC is part of the SledjHamr project. SledjHamr is a rewrite from
24scratch of Second Life (SL) / OpenSim (OS) style 3D online virtual world
25client / server. The plan is to use OS server and SL clients as crutches,
26when a bit of SledjHamr is ready, it replaces the matching bit in OS/SL.</p>
27
28<h2>SledjHamr - tearing down the garden walls.</h2>
29
30<p>&nbsp;</p>
31<h1>What is SledjChisl?</h1>
32
33<p>While OpenSim is slowly morphing into SledjHamr, it needed a name, so
34I called it SledjChisl. The main differences between opensim-SC and
35OpenSim are listed in <a
36href="../Differences.txt">Differences.txt</a></p>
37
38<h2>SledjChisl - chipping away at OpenSim until it's all gone, and is now SledjHamr.</h2>
39
40<p>&nbsp;</p>
41<h1>Enough of the bad puns, what is it all about?</h1>
42
43<p>It's a 3D open online shared virtual world that is user created. Using a
44specialised bit of software called a viewer you log onto one of these
45worlds, either Second Life, or one of the many OpenSim based worlds. You
46then get to wander around a 3D world that the other users have built,
47and do many things. Including building your own bit of the world using
48the viewer itself.</p>
49
50<h3>It's not a game.</h3>
51
52<p>Many people think of it as a game, but it's missing many of the features
53of a real game, and tends to be more about the social side of things.
54I've even had someone tell me that everything online is a game, even
55pointing out that their bank account is online didn't help. There is no
56goal, no game play, no levelling up, no one keeps score. You do what you
57want in these worlds (within the limits of the local rules), and that
58might include playing games that people have created in the world, but
59you don't have to.</p>
60
61<p>People even do business in them.</p>
62
63
64<h1>What do I do with opensim-SC?</h1>
65
66<p>The easiest thing to do is to just join a world that is running
67opensim-SC, but you don't need this software for doing that. This
68software is for running such a world, or part of it.</p>
69
70<p>Virtual world software is complex software, coz you are simulating an
71entire world. There's lots of things to take care of. While SledjHamr
72aims to make things as simple as possible for ordinary folk, we ain't
73there yet. opensim-SC is slightly easier to setup than OpenSim, so
74progress has been made. opensim-SC tries to remain compatible, so for
75more details, refer to the <a
76href="http://opensimulator.org/wiki/Main_Page">OpenSim</a> and <a
77href="http://wiki.secondlife.com/wiki/Main_Page">Second Life</a>
78documentation.</p>
79
80<p>You'll need to be familiar with command lines. Currently opensim-SC uses
81Linux shell scripts, though that'll change in the next release to be more
82portable to other operating systems. The shell scripts are for setup and
83basic management, the virtual world software itself is written in
84portable C# that runs on .NET and MONO.</p>
85
86<p>The scripts install and manage everything based on a Debian variation
87of Linux, it's been tested under Debian, Devuan, and Ubuntu. Refer to
88INSTALL.md for installation details.</p>
89
90<p>The <a href="scripts.html">scripts are documented here</a>.</p>
91
92<p>The <a href="configuration.html">new configuration setup and options are documented here</,>.</p>
93
94<p>&nbsp;</p>
95<p>&nbsp;</p>
96<p>&nbsp;</p>
97</body>
98</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 @@
1<html>
2<title>opensim-SC scripts documentation</title>
3<head>
4</head>
5<body bgcolor="black" text="white" alink="red" link="blue" vlink="purple">
6<p>&nbsp;</p>
7</body>
8</html>
diff --git a/example/web/about.html b/example/web/about.html
index e45f00a..b558e39 100644
--- a/example/web/about.html
+++ b/example/web/about.html
@@ -3,7 +3,7 @@
3<head> 3<head>
4</head> 4</head>
5<body bgcolor="black" text="white" alink="red" link="blue" vlink="purple"> 5<body bgcolor="black" text="white" alink="red" link="blue" vlink="purple">
6This is a virtual world, usually called a grid, based on <a href="https://sledjhamr.org/cgit/opensim-SC/?h=SledjChisl">OpenSim_SC</a>. 6This is a virtual world, usually called a grid, based on <a href="https://sledjhamr.org/cgit/opensim-SC/?h=SledjChisl">opensim-SC</a>.
7<p>&nbsp;</p> 7<p>&nbsp;</p>
8</body> 8</body>
9</html> 9</html>
diff --git a/example/web/register.html b/example/web/register.html
index a34becb..da46365 100644
--- a/example/web/register.html
+++ b/example/web/register.html
@@ -7,7 +7,7 @@ Include account registration help for your grid here.
7<p>&nbsp;</p> 7<p>&nbsp;</p>
8<p>If you want to register an account on this grid, ask the person that runs it to do that for you.</p> 8<p>If you want to register an account on this grid, ask the person that runs it to do that for you.</p>
9<p>&nbsp;</p> 9<p>&nbsp;</p>
10<p>If you want to register an account on this grid, <a href="account.html"> click here</a> (when it's finished).</p> 10<p>If you want to register an account on this grid, <a href="account.html"> click here</a> (when it's written).</p>
11<p>&nbsp;</p> 11<p>&nbsp;</p>
12</body> 12</body>
13</html> 13</html>