aboutsummaryrefslogtreecommitdiffstatshomepage
path: root/README.txt
diff options
context:
space:
mode:
Diffstat (limited to 'README.txt')
-rw-r--r--README.txt131
1 files changed, 131 insertions, 0 deletions
diff --git a/README.txt b/README.txt
new file mode 100644
index 0000000..a5dec24
--- /dev/null
+++ b/README.txt
@@ -0,0 +1,131 @@
1Welcome to OpenSim!
2
3==================
4==== OVERVIEW ====
5==================
6
7OpenSim is a BSD Licensed Open Source project to develop a functioning
8virtual worlds server platform capable of supporting multiple clients
9and servers in a heterogeneous grid structure. OpenSim is written in
10C#, and can run under Mono or the Microsoft .NET runtimes.
11
12This is considered an alpha release. Some stuff works, a lot doesn't.
13If it breaks, you get to keep *both* pieces.
14
15=========================
16=== Compiling OpenSim ===
17=========================
18
19Please see BUILDING.txt if you downloaded a source distribution and
20need to build OpenSim before running it.
21
22==================================
23=== Running OpenSim on Windows ===
24==================================
25
26We recommend that you run OpenSim from a command prompt on Windows in order
27to capture any errors.
28
29To run OpenSim from a command prompt
30
31 * cd to the bin/ directory where you unpacked OpenSim
32 * run OpenSim.exe
33
34Now see the "Configuring OpenSim" section
35
36================================
37=== Running OpenSim on Linux ===
38================================
39
40You will need Mono >= 2.4.3 to run OpenSim. On some Linux distributions you
41may need to install additional packages. See http://opensimulator.org/wiki/Dependencies
42for more information.
43
44To run OpenSim, from the unpacked distribution type:
45
46 * cd bin
47 * mono OpenSim.exe
48
49Now see the "Configuring OpenSim" section
50
51===========================
52=== Configuring OpenSim ===
53===========================
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==================================
87=== Connecting to your OpenSim ===
88==================================
89
90By default your sim will be available for login on port 9000. You can login by
91adding -loginuri http://127.0.0.1:9000 to the command that starts Second Life
92(e.g. in the Target: box of the client icon properties on Windows). You can
93also login using the network IP address of the machine running OpenSim (e.g.
94http://192.168.1.2:9000)
95
96To login, use the avatar details that you gave for your estate ownership or the
97one you set up using the "create user" command.
98
99===================
100=== Bug reports ===
101===================
102
103In the very likely event of bugs biting you (err, your OpenSim) we
104encourage you to see whether the problem has already been reported on
105the OpenSim mantis system. You can find the OpenSim mantis system at
106
107 http://opensimulator.org/mantis/main_page.php
108
109If your bug has already been reported, you might want to add to the
110bug description and supply additional information.
111
112If your bug has not been reported yet, file a bug report ("opening a
113mantis"). Useful information to include:
114 * description of what went wrong
115 * stack trace
116 * OpenSim.log (attach as file)
117 * OpenSim.ini (attach as file)
118 * if running under mono: run OpenSim.exe with the "--debug" flag:
119
120 mono --debug OpenSim.exe
121
122===================================
123=== More Information on OpenSim ===
124===================================
125
126More extensive information on building, running, and configuring
127OpenSim, as well as how to report bugs, and participate in the OpenSim
128project can always be found at http://opensimulator.org.
129
130Thanks for trying OpenSim, we hope it is a pleasant experience.
131