aboutsummaryrefslogtreecommitdiffstatshomepage
path: root/README_OpenSim.txt
diff options
context:
space:
mode:
Diffstat (limited to 'README_OpenSim.txt')
-rw-r--r--README_OpenSim.txt116
1 files changed, 116 insertions, 0 deletions
diff --git a/README_OpenSim.txt b/README_OpenSim.txt
new file mode 100644
index 0000000..2aea328
--- /dev/null
+++ b/README_OpenSim.txt
@@ -0,0 +1,116 @@
1Welcome to OpenSim!
2
3# Overview
4
5OpenSim is a BSD Licensed Open Source project to develop a functioning
6virtual worlds server platform capable of supporting multiple clients
7and servers in a heterogeneous grid structure. OpenSim is written in
8C#, and can run under Mono or the Microsoft .NET runtimes.
9
10This is considered an alpha release. Some stuff works, a lot doesn't.
11If it breaks, you get to keep *both* pieces.
12
13# Compiling OpenSim
14
15Please see BUILDING.md if you downloaded a source distribution and
16need to build OpenSim before running it.
17
18# Running OpenSim on Windows
19
20You will need .NET 4.0 installed to run OpenSimulator.
21
22We recommend that you run OpenSim from a command prompt on Windows in order
23to capture any errors.
24
25To run OpenSim from a command prompt
26
27 * cd to the bin/ directory where you unpacked OpenSim
28 * run OpenSim.exe
29
30Now see the "Configuring OpenSim" section
31
32# Running OpenSim on Linux
33
34You will need Mono >= 2.10.8.1 to run OpenSimulator. On some Linux distributions you
35may need to install additional packages. See http://opensimulator.org/wiki/Dependencies
36for more information.
37
38To run OpenSim, from the unpacked distribution type:
39
40 * cd bin
41 * mono OpenSim.exe
42
43Now see the "Configuring OpenSim" section
44
45# Configuring OpenSim
46
47When OpenSim starts for the first time, you will be prompted with a
48series of questions that look something like:
49
50 [09-17 03:54:40] DEFAULT REGION CONFIG: Simulator Name [OpenSim Test]:
51
52For all the options except simulator name, you can safely hit enter to accept
53the default if you want to connect using a client on the same machine or over
54your local network.
55
56You will then be asked "Do you wish to join an existing estate?". If you're
57starting OpenSim for the first time then answer no (which is the default) and
58provide an estate name.
59
60Shortly afterwards, you will then be asked to enter an estate owner first name,
61last name, password and e-mail (which can be left blank). Do not forget these
62details, since initially only this account will be able to manage your region
63in-world. You can also use these details to perform your first login.
64
65Once you are presented with a prompt that looks like:
66
67 Region (My region name) #
68
69You have successfully started OpenSim.
70
71If you want to create another user account to login rather than the estate
72account, then type "create user" on the OpenSim console and follow the prompts.
73
74Helpful resources:
75 * http://opensimulator.org/wiki/Configuration
76 * http://opensimulator.org/wiki/Configuring_Regions
77
78# Connecting to your OpenSim
79
80By default your sim will be available for login on port 9000. You can login by
81adding -loginuri http://127.0.0.1:9000 to the command that starts Second Life
82(e.g. in the Target: box of the client icon properties on Windows). You can
83also login using the network IP address of the machine running OpenSim (e.g.
84http://192.168.1.2:9000)
85
86To login, use the avatar details that you gave for your estate ownership or the
87one you set up using the "create user" command.
88
89# Bug reports
90
91In the very likely event of bugs biting you (err, your OpenSim) we
92encourage you to see whether the problem has already been reported on
93the [OpenSim mantis system](http://opensimulator.org/mantis/main_page.php).
94
95If your bug has already been reported, you might want to add to the
96bug description and supply additional information.
97
98If your bug has not been reported yet, file a bug report ("opening a
99mantis"). Useful information to include:
100 * description of what went wrong
101 * stack trace
102 * OpenSim.log (attach as file)
103 * OpenSim.ini (attach as file)
104 * if running under mono: run OpenSim.exe with the "--debug" flag:
105
106 mono --debug OpenSim.exe
107
108# More Information on OpenSim
109
110More extensive information on building, running, and configuring
111OpenSim, as well as how to report bugs, and participate in the OpenSim
112project can always be found at http://opensimulator.org.
113
114Thanks for trying OpenSim, we hope it is a pleasant experience.
115
116