diff options
author | Justin Clark-Casey (justincc) | 2010-06-19 01:23:52 +0100 |
---|---|---|
committer | Justin Clark-Casey (justincc) | 2010-06-19 01:23:52 +0100 |
commit | 8fc3745e1905c9c8881eac9c09da9754e4fa8265 (patch) | |
tree | 477bcffd28dacba7e3a4a913d498b0dc46f94f73 /README.txt | |
parent | minor: try and make the explanations for the AllowScriptCrossing and TrustBin... (diff) | |
download | opensim-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 'README.txt')
-rw-r--r-- | README.txt | 58 |
1 files changed, 41 insertions, 17 deletions
@@ -1,6 +1,8 @@ | |||
1 | Welcome to OpenSim! | 1 | Welcome to OpenSim! |
2 | 2 | ||
3 | ================ | ||
3 | === OVERVIEW === | 4 | === OVERVIEW === |
5 | ================ | ||
4 | 6 | ||
5 | OpenSim is a BSD Licensed Open Source project to develop a functioning | 7 | OpenSim is a BSD Licensed Open Source project to develop a functioning |
6 | virtual worlds server platform capable of supporting multiple clients | 8 | virtual worlds server platform capable of supporting multiple clients |
@@ -10,16 +12,19 @@ C#, and can run under Mono or the Microsoft .NET runtimes. | |||
10 | This is considered an alpha release. Some stuff works, a lot doesn't. | 12 | This is considered an alpha release. Some stuff works, a lot doesn't. |
11 | If it breaks, you get to keep *both* pieces. | 13 | If it breaks, you get to keep *both* pieces. |
12 | 14 | ||
15 | ========================= | ||
13 | === Compiling OpenSim === | 16 | === Compiling OpenSim === |
17 | ========================= | ||
14 | 18 | ||
15 | Please see BUILDING.txt if you downloaded a source distribution and | 19 | Please see BUILDING.txt if you downloaded a source distribution and |
16 | need to build OpenSim before running it. | 20 | need to build OpenSim before running it. |
17 | 21 | ||
22 | ================================== | ||
18 | === Running OpenSim on Windows === | 23 | === Running OpenSim on Windows === |
24 | ================================== | ||
19 | 25 | ||
20 | We recommend that you run OpenSim from a command prompt on Windows in order | 26 | We recommend that you run OpenSim from a command prompt on Windows in order |
21 | to capture any errors, though you can also run it by double-clicking | 27 | to capture any errors. |
22 | bin/OpenSim.exe | ||
23 | 28 | ||
24 | To run OpenSim from a command prompt | 29 | To run OpenSim from a command prompt |
25 | 30 | ||
@@ -28,7 +33,9 @@ To run OpenSim from a command prompt | |||
28 | 33 | ||
29 | Now see the "Configuring OpenSim" section | 34 | Now see the "Configuring OpenSim" section |
30 | 35 | ||
36 | ================================ | ||
31 | === Running OpenSim on Linux === | 37 | === Running OpenSim on Linux === |
38 | ================================ | ||
32 | 39 | ||
33 | You will need Mono >= 2.4.2 to run OpenSim. On some Linux distributions you | 40 | You will need Mono >= 2.4.2 to run OpenSim. On some Linux distributions you |
34 | may need to install additional packages. See http://opensimulator.org/wiki/Dependencies | 41 | may need to install additional packages. See http://opensimulator.org/wiki/Dependencies |
@@ -37,48 +44,64 @@ for more information. | |||
37 | To run OpenSim, from the unpacked distribution type: | 44 | To 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 | ||
42 | Now see the "Configuring OpenSim" section | 49 | Now see the "Configuring OpenSim" section |
43 | 50 | ||
51 | =========================== | ||
44 | === Configuring OpenSim === | 52 | === Configuring OpenSim === |
53 | =========================== | ||
45 | 54 | ||
46 | When OpenSim starts for the first time, you will be prompted with a | 55 | When OpenSim starts for the first time, you will be prompted with a |
47 | series of questions that look something like: | 56 | series 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 | ||
51 | At each of these you must provide you own value or just hit enter to | 60 | For all the options except simulator name, you can safely hit enter to accept |
52 | take the default (in this case "OpenSim Test"). | 61 | the default if you want to connect using a client on the same machine or over |
62 | your local network. | ||
53 | 63 | ||
54 | YOUR SIM WILL NOT BE STARTED UNTIL YOU ANSWER ALL QUESTIONS | 64 | You will then be asked "Do you wish to join an existing estate?". If you're |
65 | starting OpenSim for the first time then answer no (which is the default) and | ||
66 | provide an estate name. | ||
67 | |||
68 | Shortly afterwards, you will then be asked to enter an estate owner first name, | ||
69 | last name, password and e-mail (which can be left blank). Do not forget these | ||
70 | details, since initially only this account will be able to manage your region | ||
71 | in-world. You can also use these details to perform your first login. | ||
55 | 72 | ||
56 | Once you are presented with a prompt that looks like: | 73 | Once you are presented with a prompt that looks like: |
57 | 74 | ||
58 | Region# : | 75 | Region (My region name) # |
59 | 76 | ||
60 | You have successfully started OpenSim. | 77 | You have successfully started OpenSim. |
61 | 78 | ||
62 | Before you can log in you will need to create a user account if you didn't already create | 79 | If you want to create another user account to login rather than the estate |
63 | your user as the "Master Avatar" during the region configuration stage. You can do | 80 | account, then type "craete user" on the OpenSim console and follow the prompts. |
64 | this by running the "create user" command on the OpenSim console. This will | ||
65 | ask you a series of questions such as first name, last name and password. | ||
66 | 81 | ||
67 | Helpful resources: | 82 | Helpful 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 | |||
91 | By default your sim will be available for login on port 9000. You can login by | ||
92 | adding -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 | ||
94 | also login using the network IP address of the machine running OpenSim (e.g. | ||
95 | http://192.168.1.2:9000) | ||
73 | 96 | ||
74 | By default your sim will be running on http://127.0.0.1:9000. To use | 97 | To login, use the avatar details that you gave for your estate ownership or the |
75 | your OpenSim add -loginuri http://127.0.0.1:9000 to your second life | 98 | one you set up using the "create user" command. |
76 | client (running on the same machine as your OpenSim). To login, use the | ||
77 | same avatar details that you gave to the "create user" console command. | ||
78 | 99 | ||
100 | =================== | ||
79 | === Bug reports === | 101 | === Bug reports === |
102 | =================== | ||
80 | 103 | ||
81 | In the likely event of bugs biting you (err, your OpenSim) we | 104 | In the very likely event of bugs biting you (err, your OpenSim) we |
82 | encourage you to see whether the problem has already been reported on | 105 | encourage you to see whether the problem has already been reported on |
83 | the OpenSim mantis system. You can find the OpenSim mantis system at | 106 | the 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 | ||
102 | More extensive information on building, running, and configuring | 127 | More extensive information on building, running, and configuring |
103 | OpenSim, as well as how to report bugs, and participate in the OpenSim | 128 | OpenSim, as well as how to report bugs, and participate in the OpenSim |
104 | project can always be found at http://opensimulator.org. | 129 | project can always be found at http://opensimulator.org. |
105 | 130 | ||
106 | Thanks for trying OpenSim, we hope it is a pleasant experience. | 131 | Thanks for trying OpenSim, we hope it is a pleasant experience. |
107 | \ No newline at end of file | ||