Overhaul basic README.txt for new estate setup options on first run.

Also make some minor changes for clarity.
0.7-release
Justin Clark-Casey (justincc) 2010-06-19 01:23:52 +01:00
parent 4d828eb3c3
commit ab95239047
1 changed files with 41 additions and 17 deletions

View File

@ -1,6 +1,8 @@
Welcome to OpenSim! Welcome to OpenSim!
================
=== OVERVIEW === === OVERVIEW ===
================
OpenSim is a BSD Licensed Open Source project to develop a functioning OpenSim is a BSD Licensed Open Source project to develop a functioning
virtual worlds server platform capable of supporting multiple clients virtual worlds server platform capable of supporting multiple clients
@ -10,16 +12,19 @@ C#, and can run under Mono or the Microsoft .NET runtimes.
This is considered an alpha release. Some stuff works, a lot doesn't. This is considered an alpha release. Some stuff works, a lot doesn't.
If it breaks, you get to keep *both* pieces. If it breaks, you get to keep *both* pieces.
=========================
=== Compiling OpenSim === === Compiling OpenSim ===
=========================
Please see BUILDING.txt if you downloaded a source distribution and Please see BUILDING.txt if you downloaded a source distribution and
need to build OpenSim before running it. need to build OpenSim before running it.
==================================
=== Running OpenSim on Windows === === Running OpenSim on Windows ===
==================================
We recommend that you run OpenSim from a command prompt on Windows in order We recommend that you run OpenSim from a command prompt on Windows in order
to capture any errors, though you can also run it by double-clicking to capture any errors.
bin/OpenSim.exe
To run OpenSim from a command prompt To run OpenSim from a command prompt
@ -28,7 +33,9 @@ To run OpenSim from a command prompt
Now see the "Configuring OpenSim" section Now see the "Configuring OpenSim" section
================================
=== Running OpenSim on Linux === === Running OpenSim on Linux ===
================================
You will need Mono >= 2.4.2 to run OpenSim. On some Linux distributions you You will need Mono >= 2.4.2 to run OpenSim. On some Linux distributions you
may need to install additional packages. See http://opensimulator.org/wiki/Dependencies may need to install additional packages. See http://opensimulator.org/wiki/Dependencies
@ -37,48 +44,64 @@ for more information.
To run OpenSim, from the unpacked distribution type: To run OpenSim, from the unpacked distribution type:
* cd bin * cd bin
* mono ./OpenSim.exe * mono OpenSim.exe
Now see the "Configuring OpenSim" section Now see the "Configuring OpenSim" section
===========================
=== Configuring OpenSim === === Configuring OpenSim ===
===========================
When OpenSim starts for the first time, you will be prompted with a When OpenSim starts for the first time, you will be prompted with a
series of questions that look something like: series of questions that look something like:
[09-17 03:54:40] DEFAULT REGION CONFIG: Simulator Name [OpenSim Test]: [09-17 03:54:40] DEFAULT REGION CONFIG: Simulator Name [OpenSim Test]:
At each of these you must provide you own value or just hit enter to For all the options except simulator name, you can safely hit enter to accept
take the default (in this case "OpenSim Test"). the default if you want to connect using a client on the same machine or over
your local network.
YOUR SIM WILL NOT BE STARTED UNTIL YOU ANSWER ALL QUESTIONS You will then be asked "Do you wish to join an existing estate?". If you're
starting OpenSim for the first time then answer no (which is the default) and
provide an estate name.
Shortly afterwards, you will then be asked to enter an estate owner first name,
last name, password and e-mail (which can be left blank). Do not forget these
details, since initially only this account will be able to manage your region
in-world. You can also use these details to perform your first login.
Once you are presented with a prompt that looks like: Once you are presented with a prompt that looks like:
Region# : Region (My region name) #
You have successfully started OpenSim. You have successfully started OpenSim.
Before you can log in you will need to create a user account if you didn't already create If you want to create another user account to login rather than the estate
your user as the "Master Avatar" during the region configuration stage. You can do account, then type "craete user" on the OpenSim console and follow the prompts.
this by running the "create user" command on the OpenSim console. This will
ask you a series of questions such as first name, last name and password.
Helpful resources: Helpful resources:
* http://opensimulator.org/wiki/Configuration * http://opensimulator.org/wiki/Configuration
* http://opensimulator.org/wiki/Configuring_Regions * http://opensimulator.org/wiki/Configuring_Regions
* http://opensimulator.org/wiki/Mysql-config * http://opensimulator.org/wiki/Mysql-config
==================================
=== Connecting to your OpenSim === === Connecting to your OpenSim ===
==================================
By default your sim will be running on http://127.0.0.1:9000. To use By default your sim will be available for login on port 9000. You can login by
your OpenSim add -loginuri http://127.0.0.1:9000 to your second life adding -loginuri http://127.0.0.1:9000 to the command that starts Second Life
client (running on the same machine as your OpenSim). To login, use the (e.g. in the Target: box of the client icon properties on Windows). You can
same avatar details that you gave to the "create user" console command. also login using the network IP address of the machine running OpenSim (e.g.
http://192.168.1.2:9000)
To login, use the avatar details that you gave for your estate ownership or the
one you set up using the "create user" command.
===================
=== Bug reports === === Bug reports ===
===================
In the likely event of bugs biting you (err, your OpenSim) we In the very likely event of bugs biting you (err, your OpenSim) we
encourage you to see whether the problem has already been reported on encourage you to see whether the problem has already been reported on
the OpenSim mantis system. You can find the OpenSim mantis system at the OpenSim mantis system. You can find the OpenSim mantis system at
@ -97,11 +120,12 @@ mantis"). Useful information to include:
mono --debug OpenSim.exe mono --debug OpenSim.exe
===================================
=== More Information on OpenSim === === More Information on OpenSim ===
===================================
More extensive information on building, running, and configuring More extensive information on building, running, and configuring
OpenSim, as well as how to report bugs, and participate in the OpenSim OpenSim, as well as how to report bugs, and participate in the OpenSim
project can always be found at http://opensimulator.org. project can always be found at http://opensimulator.org.
Thanks for trying OpenSim, we hope it is a pleasant experience. Thanks for trying OpenSim, we hope it is a pleasant experience.