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