Go to file
Huaiyu (Kitty) Liu e4ab31e004 merged in Kitty's code on propogating events and handling remote events 2011-01-06 10:46:06 -08:00
.nant fix mistake in last change of local.include 2010-12-15 00:14:43 +00:00
OpenSim merged in Kitty's code on propogating events and handling remote events 2011-01-06 10:46:06 -08:00
Prebuild Removing .svn directories under Prebuild/ from source control 2010-09-11 18:26:59 -07:00
ThirdParty/SmartThreadPool * Allow SmartThreadPool to be initialized without setting max stack size (like the original implementation) 2009-10-22 01:30:12 -07:00
ThirdPartyLicenses remove broken and unmaintained subversion serialization module and it's associated libraries and licenses 2010-12-17 23:04:07 +00:00
addon-modules minor: slightly improve README for building addon-modules within the main OpenSim build 2010-01-11 15:47:01 +00:00
bin Merge branch 'danmerge_symsync' into dev 2011-01-03 15:13:04 -08:00
doc Update svn properties. 2008-06-01 03:01:33 +00:00
share in the spirit of cleanup, remove the old sql directory, as this stuff is 2009-01-26 15:42:21 +00:00
.gitignore removed from git *.VisualState.xml (automatically created by NUnit) 2010-04-28 11:41:39 +03:00
.hgignore additional patterns for .hgignore 2008-07-18 14:37:23 +00:00
BUILDING.txt typical non-effectual build trigger 2010-10-16 21:48:15 -04:00
CONTRIBUTORS.txt Add 'contributors' notice for zlib.net.dll to keep track of its origin and version. Dahlia, please correct the details if they're wrong. 2010-10-19 02:28:10 +01:00
LICENSE.txt Last time? 2010-05-03 00:11:12 +01:00
Makefile making Makefile a bit more robust: can now cope with missing ruby in a 2009-09-03 18:32:41 +02:00
OpenSim.FxCop changed to native line ending encoding 2007-07-16 15:40:11 +00:00
README.txt *typical non-effectual commit to trigger a build 2010-10-13 12:40:21 -04:00
TESTING.txt git test commit 2009-09-02 20:00:36 -07:00
nant-color in case ruby is somewhere else in the path (just used for coloring output) 2009-09-03 15:00:53 -04:00
prebuild.xml Merge branch 'master' into danmerge 2011-01-02 18:38:58 -08:00
runprebuild.bat Switch runprebuild.bat from VS2005 to VS2008. Remove runprebuild2008.bat. 2009-07-10 04:29:00 +00:00
runprebuild.sh Build system upgrade: 2010-09-04 02:12:21 +01:00
runprebuild2010.bat Added VS2010 support to Prebuild and created runprebuild2010.bat 2009-10-22 17:03:13 -07:00

README.txt

Welcome to OpenSim!

==================
==== OVERVIEW ====
==================

OpenSim is a BSD Licensed Open Source project to develop a functioning
virtual worlds server platform capable of supporting multiple clients
and servers in a heterogeneous grid structure. OpenSim is written in
C#, and can run under Mono or the Microsoft .NET runtimes.

This is considered an alpha release.  Some stuff works, a lot doesn't.
If it breaks, you get to keep *both* pieces.

=========================
=== Compiling OpenSim ===
=========================

Please see BUILDING.txt if you downloaded a source distribution and 
need to build OpenSim before running it.

==================================
=== Running OpenSim on Windows ===
==================================

We recommend that you run OpenSim from a command prompt on Windows in order
to capture any errors.

To run OpenSim from a command prompt

 * cd to the bin/ directory where you unpacked OpenSim
 * run OpenSim.exe

Now see the "Configuring OpenSim" section

================================
=== Running OpenSim on Linux ===
================================

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
for more information.

To run OpenSim, from the unpacked distribution type:

 * cd bin
 * mono OpenSim.exe

Now see the "Configuring OpenSim" section

===========================
=== Configuring OpenSim ===
===========================

When OpenSim starts for the first time, you will be prompted with a
series of questions that look something like:

[09-17 03:54:40] DEFAULT REGION CONFIG: Simulator Name [OpenSim Test]:

For all the options except simulator name, you can safely hit enter to accept
the default if you want to connect using a client on the same machine or over
your local network.

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:

  Region (My region name) #

You have successfully started OpenSim.

If you want to create another user account to login rather than the estate
account, then type "create user" on the OpenSim console and follow the prompts.

Helpful resources:
 * http://opensimulator.org/wiki/Configuration
 * http://opensimulator.org/wiki/Configuring_Regions

==================================
=== Connecting to your OpenSim ===
==================================

By default your sim will be available for login on port 9000.  You can login by
adding -loginuri http://127.0.0.1:9000 to the command that starts Second Life
(e.g. in the Target: box of the client icon properties on Windows).  You can
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 ===
===================

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
the OpenSim mantis system. You can find the OpenSim mantis system at

    http://opensimulator.org/mantis/main_page.php

If your bug has already been reported, you might want to add to the
bug description and supply additional information.

If your bug has not been reported yet, file a bug report ("opening a
mantis"). Useful information to include:
 * description of what went wrong
 * stack trace
 * OpenSim.log (attach as file)
 * OpenSim.ini (attach as file)
 * if running under mono: run OpenSim.exe with the "--debug" flag:

       mono --debug OpenSim.exe

===================================
=== More Information on OpenSim ===
===================================

More extensive information on building, running, and configuring
OpenSim, as well as how to report bugs, and participate in the OpenSim
project can always be found at http://opensimulator.org.

Thanks for trying OpenSim, we hope it is a pleasant experience.