aboutsummaryrefslogtreecommitdiffstatshomepage
path: root/doc
diff options
context:
space:
mode:
Diffstat (limited to 'doc')
-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
4 files changed, 236 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 @@
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>