aboutsummaryrefslogtreecommitdiffstatshomepage
path: root/README.txt
diff options
context:
space:
mode:
authorJustin Clark-Casey (justincc)2010-06-19 01:23:52 +0100
committerJustin Clark-Casey (justincc)2010-06-19 01:23:52 +0100
commit8fc3745e1905c9c8881eac9c09da9754e4fa8265 (patch)
tree477bcffd28dacba7e3a4a913d498b0dc46f94f73 /README.txt
parentminor: try and make the explanations for the AllowScriptCrossing and TrustBin... (diff)
downloadopensim-SC_OLD-8fc3745e1905c9c8881eac9c09da9754e4fa8265.zip
opensim-SC_OLD-8fc3745e1905c9c8881eac9c09da9754e4fa8265.tar.gz
opensim-SC_OLD-8fc3745e1905c9c8881eac9c09da9754e4fa8265.tar.bz2
opensim-SC_OLD-8fc3745e1905c9c8881eac9c09da9754e4fa8265.tar.xz
Overhaul basic README.txt for new estate setup options on first run.
Also make some minor changes for clarity.
Diffstat (limited to '')
-rw-r--r--README.txt58
1 files changed, 41 insertions, 17 deletions
diff --git a/README.txt b/README.txt
index e19e58e..190fc46 100644
--- a/README.txt
+++ b/README.txt
@@ -1,6 +1,8 @@
1Welcome to OpenSim! 1Welcome to OpenSim!
2 2
3================
3=== OVERVIEW === 4=== OVERVIEW ===
5================
4 6
5OpenSim is a BSD Licensed Open Source project to develop a functioning 7OpenSim is a BSD Licensed Open Source project to develop a functioning
6virtual worlds server platform capable of supporting multiple clients 8virtual worlds server platform capable of supporting multiple clients
@@ -10,16 +12,19 @@ C#, and can run under Mono or the Microsoft .NET runtimes.
10This is considered an alpha release. Some stuff works, a lot doesn't. 12This is considered an alpha release. Some stuff works, a lot doesn't.
11If it breaks, you get to keep *both* pieces. 13If it breaks, you get to keep *both* pieces.
12 14
15=========================
13=== Compiling OpenSim === 16=== Compiling OpenSim ===
17=========================
14 18
15Please see BUILDING.txt if you downloaded a source distribution and 19Please see BUILDING.txt if you downloaded a source distribution and
16need to build OpenSim before running it. 20need to build OpenSim before running it.
17 21
22==================================
18=== Running OpenSim on Windows === 23=== Running OpenSim on Windows ===
24==================================
19 25
20We recommend that you run OpenSim from a command prompt on Windows in order 26We recommend that you run OpenSim from a command prompt on Windows in order
21to capture any errors, though you can also run it by double-clicking 27to capture any errors.
22bin/OpenSim.exe
23 28
24To run OpenSim from a command prompt 29To run OpenSim from a command prompt
25 30
@@ -28,7 +33,9 @@ To run OpenSim from a command prompt
28 33
29Now see the "Configuring OpenSim" section 34Now see the "Configuring OpenSim" section
30 35
36================================
31=== Running OpenSim on Linux === 37=== Running OpenSim on Linux ===
38================================
32 39
33You will need Mono >= 2.4.2 to run OpenSim. On some Linux distributions you 40You will need Mono >= 2.4.2 to run OpenSim. On some Linux distributions you
34may need to install additional packages. See http://opensimulator.org/wiki/Dependencies 41may need to install additional packages. See http://opensimulator.org/wiki/Dependencies
@@ -37,48 +44,64 @@ for more information.
37To run OpenSim, from the unpacked distribution type: 44To run OpenSim, from the unpacked distribution type:
38 45
39 * cd bin 46 * cd bin
40 * mono ./OpenSim.exe 47 * mono OpenSim.exe
41 48
42Now see the "Configuring OpenSim" section 49Now see the "Configuring OpenSim" section
43 50
51===========================
44=== Configuring OpenSim === 52=== Configuring OpenSim ===
53===========================
45 54
46When OpenSim starts for the first time, you will be prompted with a 55When OpenSim starts for the first time, you will be prompted with a
47series of questions that look something like: 56series of questions that look something like:
48 57
49[09-17 03:54:40] DEFAULT REGION CONFIG: Simulator Name [OpenSim Test]: 58[09-17 03:54:40] DEFAULT REGION CONFIG: Simulator Name [OpenSim Test]:
50 59
51At each of these you must provide you own value or just hit enter to 60For all the options except simulator name, you can safely hit enter to accept
52take the default (in this case "OpenSim Test"). 61the default if you want to connect using a client on the same machine or over
62your local network.
53 63
54YOUR SIM WILL NOT BE STARTED UNTIL YOU ANSWER ALL QUESTIONS 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.
55 72
56Once you are presented with a prompt that looks like: 73Once you are presented with a prompt that looks like:
57 74
58 Region# : 75 Region (My region name) #
59 76
60You have successfully started OpenSim. 77You have successfully started OpenSim.
61 78
62Before you can log in you will need to create a user account if you didn't already create 79If you want to create another user account to login rather than the estate
63your user as the "Master Avatar" during the region configuration stage. You can do 80account, then type "craete user" on the OpenSim console and follow the prompts.
64this by running the "create user" command on the OpenSim console. This will
65ask you a series of questions such as first name, last name and password.
66 81
67Helpful resources: 82Helpful resources:
68 * http://opensimulator.org/wiki/Configuration 83 * http://opensimulator.org/wiki/Configuration
69 * http://opensimulator.org/wiki/Configuring_Regions 84 * http://opensimulator.org/wiki/Configuring_Regions
70 * http://opensimulator.org/wiki/Mysql-config 85 * http://opensimulator.org/wiki/Mysql-config
71 86
87==================================
72=== Connecting to your OpenSim === 88=== Connecting to your OpenSim ===
89==================================
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)
73 96
74By default your sim will be running on http://127.0.0.1:9000. To use 97To login, use the avatar details that you gave for your estate ownership or the
75your OpenSim add -loginuri http://127.0.0.1:9000 to your second life 98one you set up using the "create user" command.
76client (running on the same machine as your OpenSim). To login, use the
77same avatar details that you gave to the "create user" console command.
78 99
100===================
79=== Bug reports === 101=== Bug reports ===
102===================
80 103
81In the likely event of bugs biting you (err, your OpenSim) we 104In the very likely event of bugs biting you (err, your OpenSim) we
82encourage you to see whether the problem has already been reported on 105encourage you to see whether the problem has already been reported on
83the OpenSim mantis system. You can find the OpenSim mantis system at 106the OpenSim mantis system. You can find the OpenSim mantis system at
84 107
@@ -97,11 +120,12 @@ mantis"). Useful information to include:
97 120
98 mono --debug OpenSim.exe 121 mono --debug OpenSim.exe
99 122
123===================================
100=== More Information on OpenSim === 124=== More Information on OpenSim ===
125===================================
101 126
102More extensive information on building, running, and configuring 127More extensive information on building, running, and configuring
103OpenSim, as well as how to report bugs, and participate in the OpenSim 128OpenSim, as well as how to report bugs, and participate in the OpenSim
104project can always be found at http://opensimulator.org. 129project can always be found at http://opensimulator.org.
105 130
106Thanks for trying OpenSim, we hope it is a pleasant experience. 131Thanks for trying OpenSim, we hope it is a pleasant experience.
107 \ No newline at end of file