aboutsummaryrefslogtreecommitdiffstatshomepage
path: root/README.md
diff options
context:
space:
mode:
authoronefang2019-08-23 16:28:02 +1000
committeronefang2019-08-23 16:28:02 +1000
commit7cd9e3aadf2cb58fd6274b5d89a85a3b4491ceae (patch)
tree0c4bd2156e7ec631d8cd8fd22acc91e04a1a0c2e /README.md
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.
Diffstat (limited to 'README.md')
-rw-r--r--README.md143
1 files changed, 9 insertions, 134 deletions
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